io.github.bananapuncher714.cartographer.core.api.map

Interface MapCursorProvider

All Superinterfaces:

MapProvider

All Known Implementing Classes:

DefaultPointerCursorProvider

public interface MapCursorProvider
extends MapProvider

Provides a Minimap with cursors that will appear on the canvas, may be called extremely frequently(Several times per tick).

Author:

BananaPuncher714

Method Summary

Modifier and Type	Method and Description
java.util.Collection<org.bukkit.map.MapCursor>	getCursors(org.bukkit.entity.Player player, Minimap map, PlayerSetting setting) Get a collection of cursors that can be placed on the map.

Method Detail

getCursors

java.util.Collection<org.bukkit.map.MapCursor> getCursors(org.bukkit.entity.Player player,
                                                          Minimap map,
                                                          PlayerSetting setting)

Get a collection of cursors that can be placed on the map. To place cursors relative to the Minecraft world, use a WorldCursorProvider.

Parameters:

player - The player for who this is rendering. Do not use the location of this player, may not be accurate.

map - The Minimap which is requesting the cursors.

setting - The PlayerSetting of the player, including the location of the player that will be used to render the canvas.

Returns:

A collection of MapPixel. Can return null.