endstone.map

Classes relating to plugin handling of map displays.

Classes

Name	Description
`MapCanvas`	Represents a canvas for drawing to a map. Each canvas is associated with a specific MapRenderer and represents that renderer's layer on the map.
`MapCursor`	Represents a cursor on a map.
`MapRenderer`	Represents a renderer for a map.
`MapView`	Represents a map item.

`class`MapCanvas

MapCanvas()

Represents a canvas for drawing to a map. Each canvas is associated with a specific MapRenderer and represents that renderer's layer on the map.

Methods

Name	Description
`draw_image`	Draw an image to the map. The image will be clipped if necessary.
`get_pixel`	Get a pixel from the canvas.
`get_pixel_color`	Get a pixel from the canvas.
`set_pixel`	Draw a pixel to the canvas.
`set_pixel_color`	Draw a pixel to the canvas.

Attributes

Name	Type	Description
`cursors`	`list[MapCursor]`	Get the cursorS associated with this canvas.
`map_view`	`MapView`	Get the map this canvas is attached to.

`attr`cursorsproperty

cursors: list[MapCursor]

Get the cursorS associated with this canvas.

`attr`map_viewproperty

map_view: MapView

Get the map this canvas is attached to.

`meth`draw_image

draw_image(x: int, y: int, image: ndarray[uint8]) -> None

Draw an image to the map. The image will be clipped if necessary.

`meth`get_pixel

get_pixel(x: int, y: int) -> int

Get a pixel from the canvas.

`meth`get_pixel_color

get_pixel_color(x: int, y: int) -> tuple[int, ...]

Get a pixel from the canvas.

`meth`set_pixel

set_pixel(x: int, y: int, color: int) -> None

Draw a pixel to the canvas.

`meth`set_pixel_color

set_pixel_color(x: int, y: int, color: tuple[int, ...]) -> None

Draw a pixel to the canvas.

`class`MapCursor

MapCursor(x: int, y: int, direction: int, type: Type, visible: bool, caption: str = '')

Represents a cursor on a map.

Classes

Name	Description
`Type`	Represents the standard types of map cursors.

Attributes

Name	Type	Description
`caption`	`str`	Get or set the caption on this cursor.
`direction`	`int`	Get or set the direction of this cursor
`is_visible`	`bool`	Get or set the visibility statis of this cursor.
`type`	`Type`	Get or set the type of this cursor.
`x`	`int`	Get or set the X position of this cursor.
`y`	`int`	Get or set the Y position of this cursor.

`attr`captionproperty

caption: str

Get or set the caption on this cursor.

`attr`directionproperty

direction: int

Get or set the direction of this cursor

`attr`is_visibleproperty

is_visible: bool

Get or set the visibility statis of this cursor.

`attr`typeproperty

type: Type

Get or set the type of this cursor.

`attr`xproperty

x: int

Get or set the X position of this cursor.

`attr`yproperty

y: int

Get or set the Y position of this cursor.

`class`Type

Bases: Enum

Type()

Represents the standard types of map cursors.

Attributes

Name	Type	Description
`BLUE_MARKER`
`CYAN_MARKER`
`FRAME`
`GREEN_POINT`
`JUNGLE_TEMPLE`
`MANSION`
`MONUMENT`
`ORANGE_MARKER`
`PINK_MARKER`
`PLAYER`
`PLAYER_OFF_LIMITS`
`PLAYER_OFF_MAP`
`RED_MARKER`
`SIGN_MARKER`
`SWAMP_HUT`
`TARGET_POINT`
`TARGET_X`
`TRIAL_CHAMBERS`
`VILLAGE_DESERT`
`VILLAGE_PLAINS`
`VILLAGE_SAVANNA`
`VILLAGE_SNOWY`
`VILLAGE_TAIGA`
`YELLOW_MARKER`

`attr`BLUE_MARKER

BLUE_MARKER = 3

`attr`CYAN_MARKER

CYAN_MARKER = 11

`attr`FRAME

FRAME = 1

`attr`GREEN_POINT

GREEN_POINT = 12

`attr`JUNGLE_TEMPLE

JUNGLE_TEMPLE = 22

`attr`MANSION

MANSION = 14

`attr`MONUMENT

MONUMENT = 15

`attr`ORANGE_MARKER

ORANGE_MARKER = 9

`attr`PINK_MARKER

PINK_MARKER = 8

`attr`PLAYER

PLAYER = 0

`attr`PLAYER_OFF_LIMITS

PLAYER_OFF_LIMITS = 13

`attr`PLAYER_OFF_MAP

PLAYER_OFF_MAP = 6

`attr`RED_MARKER

RED_MARKER = 2

`attr`SIGN_MARKER

SIGN_MARKER = 7

`attr`SWAMP_HUT

SWAMP_HUT = 23

`attr`TARGET_POINT

TARGET_POINT = 5

`attr`TARGET_X

TARGET_X = 4

`attr`TRIAL_CHAMBERS

TRIAL_CHAMBERS = 24

`attr`VILLAGE_DESERT

VILLAGE_DESERT = 17

`attr`VILLAGE_PLAINS

VILLAGE_PLAINS = 18

`attr`VILLAGE_SAVANNA

VILLAGE_SAVANNA = 19

`attr`VILLAGE_SNOWY

VILLAGE_SNOWY = 20

`attr`VILLAGE_TAIGA

VILLAGE_TAIGA = 21

`attr`YELLOW_MARKER

YELLOW_MARKER = 10

`class`MapRenderer

MapRenderer(is_contextual: bool = False)

Represents a renderer for a map.

Methods

Name	Description
`initialize`	Initialize this MapRenderer for the given map.
`render`	Render to the given map.

`meth`initialize

initialize(view: MapView) -> None

Initialize this MapRenderer for the given map.

`meth`render

render(view: MapView, canvas: MapCanvas, player: Player) -> None

Render to the given map.

`class`MapView

MapView()

Represents a map item.

Classes

Name	Description
`Scale`	An enum representing all possible scales a map can be set to.

Methods

Name	Description
`add_renderer`	Add a renderer to this map.
`remove_renderer`	Remove a renderer from this map.

Attributes

Name	Type	Description
`CLOSE`
`CLOSEST`
`FAR`
`FARTHEST`
`NORMAL`
`center_x`	`int`	Get or set the center X position of this map.
`center_z`	`int`	Get or set the center Z position of this map.
`dimension`	`Dimension`	Get or set the dimension that this map is associated with.
`id`	`int`	Get the ID of this map item for use with MapMeta.
`is_unlimited_tracking`	`bool`	Whether the map will show a smaller position cursor (true), or no position cursor (false) when cursor is outside of map's range.
`is_virtual`	`bool`	Check whether this map is virtual.
`locked`	`bool`	Whether the map is locked or not. A locked map may not be explored further.
`renderers`	`list[MapRenderer]`	Get a copied list of MapRenderers currently in effect.
`scale`	`Scale`	Get or set the scale of this map.

`attr`CLOSE

CLOSE

`attr`CLOSEST

CLOSEST

`attr`FAR

FAR

`attr`FARTHEST

FARTHEST

`attr`NORMAL

NORMAL

`attr`center_xproperty

center_x: int

Get or set the center X position of this map.

`attr`center_zproperty

center_z: int

Get or set the center Z position of this map.

`attr`dimensionproperty

dimension: Dimension

Get or set the dimension that this map is associated with.

`attr`idproperty

id: int

Get the ID of this map item for use with MapMeta.

`attr`is_unlimited_trackingproperty

is_unlimited_tracking: bool

Whether the map will show a smaller position cursor (true), or no position cursor (false) when cursor is outside of map's range.

`attr`is_virtualproperty

is_virtual: bool

Check whether this map is virtual.

`attr`lockedproperty

locked: bool

Whether the map is locked or not. A locked map may not be explored further.

`attr`renderersproperty

renderers: list[MapRenderer]

Get a copied list of MapRenderers currently in effect.

`attr`scaleproperty

scale: Scale

Get or set the scale of this map.

`class`Scale

Bases: IntEnum

Scale()

An enum representing all possible scales a map can be set to.

Attributes

Name	Type	Description
`CLOSE`
`CLOSEST`
`FAR`
`FARTHEST`
`NORMAL`

`attr`CLOSE

CLOSE = 1

`attr`CLOSEST

CLOSEST = 0

`attr`FAR

FAR = 3

`attr`FARTHEST

FARTHEST = 4

`attr`NORMAL

NORMAL = 2

`meth`add_renderer

add_renderer(renderer: MapRenderer) -> None

Add a renderer to this map.

`meth`remove_renderer

remove_renderer(renderer: MapRenderer) -> bool

Remove a renderer from this map.

classMapCanvas

attrcursorsproperty

attrmap_viewproperty

methdraw_image

methget_pixel

methget_pixel_color

methset_pixel

methset_pixel_color

classMapCursor

attrcaptionproperty

attrdirectionproperty

attris_visibleproperty

attrtypeproperty

attrxproperty

attryproperty

classType

attrBLUE_MARKER

attrCYAN_MARKER

attrFRAME

attrGREEN_POINT

attrJUNGLE_TEMPLE

attrMANSION

attrMONUMENT

attrORANGE_MARKER

attrPINK_MARKER

attrPLAYER

attrPLAYER_OFF_LIMITS

attrPLAYER_OFF_MAP

attrRED_MARKER

attrSIGN_MARKER

attrSWAMP_HUT

attrTARGET_POINT

attrTARGET_X

attrTRIAL_CHAMBERS

attrVILLAGE_DESERT

attrVILLAGE_PLAINS

attrVILLAGE_SAVANNA

attrVILLAGE_SNOWY

attrVILLAGE_TAIGA

attrYELLOW_MARKER

classMapRenderer

methinitialize

methrender

classMapView

attrCLOSE

attrCLOSEST

attrFAR

attrFARTHEST

attrNORMAL

attrcenter_xproperty

attrcenter_zproperty

attrdimensionproperty

attridproperty

attris_unlimited_trackingproperty

attris_virtualproperty

attrlockedproperty

attrrenderersproperty

attrscaleproperty

classScale

attrCLOSE

attrCLOSEST

attrFAR

attrFARTHEST

attrNORMAL

methadd_renderer

methremove_renderer

On this page

`class`MapCanvas

`attr`cursorsproperty

`attr`map_viewproperty

`meth`draw_image

`meth`get_pixel

`meth`get_pixel_color

`meth`set_pixel

`meth`set_pixel_color

`class`MapCursor

`attr`captionproperty

`attr`directionproperty

`attr`is_visibleproperty

`attr`typeproperty

`attr`xproperty

`attr`yproperty

`class`Type

`attr`BLUE_MARKER

`attr`CYAN_MARKER

`attr`FRAME

`attr`GREEN_POINT

`attr`JUNGLE_TEMPLE

`attr`MANSION

`attr`MONUMENT

`attr`ORANGE_MARKER

`attr`PINK_MARKER

`attr`PLAYER

`attr`PLAYER_OFF_LIMITS

`attr`PLAYER_OFF_MAP

`attr`RED_MARKER

`attr`SIGN_MARKER

`attr`SWAMP_HUT

`attr`TARGET_POINT

`attr`TARGET_X

`attr`TRIAL_CHAMBERS

`attr`VILLAGE_DESERT

`attr`VILLAGE_PLAINS

`attr`VILLAGE_SAVANNA

`attr`VILLAGE_SNOWY

`attr`VILLAGE_TAIGA

`attr`YELLOW_MARKER

`class`MapRenderer

`meth`initialize

`meth`render

`class`MapView

`attr`CLOSE

`attr`CLOSEST

`attr`FAR

`attr`FARTHEST

`attr`NORMAL

`attr`center_xproperty

`attr`center_zproperty

`attr`dimensionproperty

`attr`idproperty

`attr`is_unlimited_trackingproperty

`attr`is_virtualproperty

`attr`lockedproperty

`attr`renderersproperty

`attr`scaleproperty

`class`Scale

`attr`CLOSE

`attr`CLOSEST

`attr`FAR

`attr`FARTHEST

`attr`NORMAL

`meth`add_renderer

`meth`remove_renderer