endstone/map

Classes

Name	Description
`MapCanvas`	Represents a canvas for drawing to a map.
`MapCursor`	Represents a cursor on a map.
`MapRenderer`	Represents a renderer for a map.
`MapView`	Represents a map item.

`class`MapCanvas

Defined in <endstone/map/map_canvas.h>

Represents a canvas for drawing to a map.

Note

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

Methods

Name	Description
`~MapCanvas`
`getMapView`	Get the map this canvas is attached to.
`getCursors`	Get the cursors associated with this canvas.
`setCursors`	Set the cursors associated with this canvas.
`setPixelColor`	Draw a pixel to the canvas.
`getPixelColor`	Get a pixel from the canvas.
`getBasePixelColor`	Get a pixel from the layers below this canvas.
`setPixel`	Draw a pixel to the canvas.
`getPixel`	Get a pixel from the canvas.
`getBasePixel`	Get a pixel from the layers below this canvas.
`drawImage`	Draw an image to the map. The image will be clipped if necessary.

`meth`~MapCanvasvirtual

~MapCanvas() =default

`meth`getMapViewabstractconst

MapView& getMapView() const =0

Get the map this canvas is attached to.

Returns

Type	Description
`MapView&`	The MapView this canvas is attached to.

`meth`getCursorsabstractconst

std::vector<MapCursor> getCursors() const =0

Get the cursors associated with this canvas.

Returns

Type	Description
`std::vector<MapCursor>`	The MapCursorCollection associated with this canvas.

`meth`setCursorsabstract

void setCursors(const std::vector<MapCursor>& cursors) =0

Set the cursors associated with this canvas.

Parameters

Name	Type	Description
`cursors`	`const std::vector<MapCursor>&`	The MapCursorCollection to associate with this canvas.

`meth`setPixelColorabstract

void setPixelColor(int x, int y, Color color) =0

Draw a pixel to the canvas.

Parameters

Name	Type	Description
`x`	`int`	The x coordinate, from 0 to 127.
`y`	`int`	The y coordinate, from 0 to 127.
`color`	`Color`	The color

`meth`getPixelColorabstractconst

Color getPixelColor(int x, int y) const =0

Get a pixel from the canvas.

Parameters

Name	Type	Description
`x`	`int`	The x coordinate, from 0 to 127.
`y`	`int`	The y coordinate, from 0 to 127.

Returns

Type	Description
`Color`	The color

`meth`getBasePixelColorabstractconst

Color getBasePixelColor(int x, int y) const =0

Get a pixel from the layers below this canvas.

Parameters

Name	Type	Description
`x`	`int`	The x coordinate, from 0 to 127.
`y`	`int`	The y coordinate, from 0 to 127.

Returns

Type	Description
`Color`	The color

`meth`setPixelabstract

void setPixel(int x, int y, std::uint32_t color) =0

Draw a pixel to the canvas.

Parameters

Name	Type	Description
`x`	`int`	The x coordinate, from 0 to 127.
`y`	`int`	The y coordinate, from 0 to 127.
`color`	`std::uint32_t`	The color.

`meth`getPixelabstractconst

std::uint32_t getPixel(int x, int y) const =0

Get a pixel from the canvas.

Parameters

Name	Type	Description
`x`	`int`	The x coordinate, from 0 to 127.
`y`	`int`	The y coordinate, from 0 to 127.

Returns

Type	Description
`std::uint32_t`	The color.

`meth`getBasePixelabstractconst

std::uint32_t getBasePixel(int x, int y) const =0

Get a pixel from the layers below this canvas.

Parameters

Name	Type	Description
`x`	`int`	The x coordinate, from 0 to 127.
`y`	`int`	The y coordinate, from 0 to 127.

Returns

Type	Description
`std::uint32_t`	The color.

`meth`drawImageabstract

void drawImage(int x, int y, const Image& image) =0

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

Parameters

Name	Type	Description
`x`	`int`	The x coordinate of the image.
`y`	`int`	The y coordinate of the image.
`image`	`const Image&`	The Image to draw.

`class`MapCursor

Defined in <endstone/map/map_cursor.h>

Represents a cursor on a map.

Enums

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

Methods

Name	Description
`MapCursor`	Initialize the map cursor.
`getX`	Get the X position of this cursor.
`getY`	Get the Y position of this cursor.
`getDirection`	Get the direction of this cursor.
`getType`	Get the type of this cursor.
`isVisible`	Get the visibility status of this cursor.
`setX`	Set the X position of this cursor.
`setY`	Set the Y position of this cursor.
`setDirection`	Set the direction of this cursor.
`setType`	Set the type of this cursor.
`setVisible`
`getCaption`	Gets the caption on this cursor.
`setCaption`	Sets the caption on this cursor.

`enum`Type

Type

Represents the standard types of map cursors.

Values

Name	Value	Description
`Player`	`0`
`Frame`	`1`
`RedMarker`	`2`
`BlueMarker`	`3`
`TargetX`	`4`
`TargetPoint`	`5`
`PlayerOffMap`	`6`
`SignMarker`	`7`
`PinkMarker`	`8`
`OrangeMarker`	`9`
`YellowMarker`	`10`
`CyanMarker`	`11`
`GreenPoint`	`12`
`PlayerOffLimits`	`13`
`Mansion`	`14`
`Monument`	`15`
`VillageDesert`	`17`
`VillagePlains`	`18`
`VillageSavanna`	`19`
`VillageSnowy`	`20`
`VillageTaiga`	`21`
`JungleTemple`	`22`
`SwampHut`	`23`
`TrialChambers`	`24`

`meth`MapCursor

MapCursor(std::int8_t x, std::int8_t y, std::int8_t direction, Type type, bool visible, std::string caption = "")

Initialize the map cursor.

Parameters

Name	Type	Description
`x`	`std::int8_t`	The x coordinate, from -128 to 127.
`y`	`std::int8_t`	The y coordinate, from -128 to 127.
`direction`	`std::int8_t`	The facing of the cursor, from 0 to 15.
`type`	`Type`	The type (color/style) of the map cursor.
`visible`	`bool`	Whether the cursor is visible by default.
`caption`	`std::string`	cursor caption

`meth`getXconst

std::int8_t getX() const

Get the X position of this cursor.

Returns

Type	Description
`std::int8_t`	The X coordinate.

`meth`getYconst

std::int8_t getY() const

Get the Y position of this cursor.

Returns

Type	Description
`std::int8_t`	The Y coordinate.

`meth`getDirectionconst

std::int8_t getDirection() const

Get the direction of this cursor.

Returns

Type	Description
`std::int8_t`	The facing of the cursor, from 0 to 15.

`meth`getTypeconst

Type getType() const

Get the type of this cursor.

Returns

Type	Description
`Type`	The type (color/style) of the map cursor.

`meth`isVisibleconst

bool isVisible() const

Get the visibility status of this cursor.

Returns

Type	Description
`bool`	True if visible, false otherwise.

`meth`setX

void setX(const std::int8_t x)

Set the X position of this cursor.

Parameters

Name	Type	Description
`x`	`const std::int8_t`	The X coordinate.

`meth`setY

void setY(const std::int8_t y)

Set the Y position of this cursor.

Parameters

Name	Type	Description
`y`	`const std::int8_t`	The Y coordinate.

`meth`setDirection

void setDirection(std::int8_t direction)

Set the direction of this cursor.

Parameters

Name	Type	Description
`direction`	`std::int8_t`	The facing of the cursor, from 0 to 15.

`meth`setType

void setType(Type type)

Set the type of this cursor.

Parameters

Name	Type	Description
`type`	`Type`	The type (color/style) of the map cursor.

`meth`setVisible

void setVisible(bool visible)

Set the visibility status of this cursor.

Parameters

Name	Type	Description
`visible`	`bool`	True if visible.

`meth`getCaptionconst

std::string getCaption() const

Gets the caption on this cursor.

Returns

Type	Description
`std::string`	caption

`meth`setCaption

void setCaption(std::string caption)

Sets the caption on this cursor.

Parameters

Name	Type	Description
`caption`	`std::string`	new caption

`class`MapRenderer

Defined in <endstone/map/map_renderer.h>

Represents a renderer for a map.

Methods

Name	Description
`MapRenderer`	Initialize the map renderer base with the given contextual status.
`~MapRenderer`
`isContextual`	Get whether the renderer is contextual, i.e. has different canvases for different players.
`initialize`	Initialize this MapRenderer for the given map.
`render`	Render to the given map.

`meth`MapRendererexplicit

MapRenderer(const bool is_contextual = false)

Initialize the map renderer base with the given contextual status.

Parameters

Name	Type	Description
`is_contextual`	`const bool`	Whether the renderer is contextual. See isContextual().

`meth`~MapRenderervirtual

~MapRenderer() =default

`meth`isContextualconst

bool isContextual() const

Get whether the renderer is contextual, i.e. has different canvases for different players.

Returns

Type	Description
`bool`	true if contextual, false otherwise.

`meth`initializevirtual

void initialize(MapView& map)

Initialize this MapRenderer for the given map.

Parameters

Name	Type	Description
`map`	`MapView&`	The MapView being initialized.

`meth`renderabstract

void render(MapView& map, MapCanvas& canvas, Player& player) =0

Render to the given map.

Parameters

Name	Type	Description
`map`	`MapView&`	The MapView being rendered to.
`canvas`	`MapCanvas&`	The canvas to use for rendering.
`player`	`Player&`	The player who triggered the rendering.

`class`MapView

Defined in <endstone/map/map_view.h>

Represents a map item.

Enums

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

Methods

Name	Description
`~MapView`
`getId`	Get the ID of this map item for use with MapMeta.
`isVirtual`	Check whether this map is virtual.
`getScale`	Get the scale of this map.
`setScale`	Set the scale of this map.
`getCenterX`	Get the center X position of this map.
`getCenterZ`	Get the center Z position of this map.
`setCenterX`	Set the center X position of this map.
`setCenterZ`	Set the center Z position of this map.
`getDimension`	Get the dimension that this map is associated with.
`setDimension`	Set the dimension that this map is associated with.
`getRenderers`	Get a list of MapRenderers currently in effect.
`addRenderer`	Add a renderer to this map.
`removeRenderer`	Remove a renderer from this map.
`isUnlimitedTracking`	Whether the map will show a smaller position cursor (true), or no position cursor (false) when cursor is outside of map's range.
`setUnlimitedTracking`	Whether the map will show a smaller position cursor (true), or no position cursor (false) when cursor is outside of map's range.
`isLocked`	Gets whether the map is locked or not. A locked map may not be explored further.
`setLocked`	Sets whether the map is locked or not. A locked map may not be explored further.

`enum`Scale

uint8_t Scale

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

Values

Name	Value	Description
`Closest`	`0`
`Close`	`1`
`Normal`	`2`
`Far`	`3`
`Farthest`	`4`

`meth`~MapViewvirtual

~MapView() =default

`meth`getIdabstractconst

std::int64_t getId() const =0

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

Returns

Type	Description
`std::int64_t`	The unique ID of the map.

`meth`isVirtualabstractconst

bool isVirtual() const =0

Check whether this map is virtual.

A map is virtual if its lowermost MapRenderer is plugin-provided.

Returns

Type	Description
`bool`	True if the map is virtual.

`meth`getScaleabstractconst

Scale getScale() const =0

Get the scale of this map.

Returns

Type	Description
`Scale`	The scale of the map.

`meth`setScaleabstract

void setScale(Scale scale) =0

Set the scale of this map.

Parameters

Name	Type	Description
`scale`	`Scale`	The scale to set.

`meth`getCenterXabstractconst

int getCenterX() const =0

Get the center X position of this map.

Returns

Type	Description
`int`	The center X position.

`meth`getCenterZabstractconst

int getCenterZ() const =0

Get the center Z position of this map.

Returns

Type	Description
`int`	The center Z position.

`meth`setCenterXabstract

void setCenterX(int x) =0

Set the center X position of this map.

Parameters

Name	Type	Description
`x`	`int`	The center X position.

`meth`setCenterZabstract

void setCenterZ(int z) =0

Set the center Z position of this map.

Parameters

Name	Type	Description
`z`	`int`	The center Z position.

`meth`getDimensionabstractconst

Dimension* getDimension() const =0

Get the dimension that this map is associated with.

Returns

Type	Description
`Dimension*`	Pointer to the World this map is associated with, or nullptr.

`meth`setDimensionabstract

void setDimension(const Dimension& dimension) =0

Set the dimension that this map is associated with.

Parameters

Name	Type	Description
`dimension`	`const Dimension&`	The Dimension to associate this map with.

`meth`getRenderersabstractconst

std::vector<std::shared_ptr<MapRenderer>> getRenderers() const =0

Get a list of MapRenderers currently in effect.

Returns

Type	Description
`std::vector<std::shared_ptr<MapRenderer>>`	A list of references to each MapRenderer.

`meth`addRendererabstract

void addRenderer(std::shared_ptr<MapRenderer> renderer) =0

Add a renderer to this map.

Parameters

Name	Type	Description
`renderer`	`std::shared_ptr<MapRenderer>`	The MapRenderer to add.

`meth`removeRendererabstract

bool removeRenderer(const std::shared_ptr<MapRenderer>& renderer) =0

Remove a renderer from this map.

Parameters

Name	Type	Description
`renderer`	`const std::shared_ptr<MapRenderer>&`	The MapRenderer to remove.

Returns

Type	Description
`bool`	True if the renderer was successfully removed.

`meth`isUnlimitedTrackingabstractconst

bool isUnlimitedTracking() const =0

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

Returns

Type	Description
`bool`	True if unlimited tracking is enabled.

`meth`setUnlimitedTrackingabstract

void setUnlimitedTracking(bool unlimited) =0

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

Parameters

Name	Type	Description
`unlimited`	`bool`	True to enable unlimited tracking.

`meth`isLockedabstractconst

bool isLocked() const =0

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

Returns

Type	Description
`bool`	True if the map is locked.

`meth`setLockedabstract

void setLocked(bool locked) =0

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

Parameters

Name	Type	Description
`locked`	`bool`	True to lock the map.

classMapCanvas

meth~MapCanvasvirtual

methgetMapViewabstractconst

methgetCursorsabstractconst

methsetCursorsabstract

methsetPixelColorabstract

methgetPixelColorabstractconst

methgetBasePixelColorabstractconst

methsetPixelabstract

methgetPixelabstractconst

methgetBasePixelabstractconst

methdrawImageabstract

classMapCursor

enumType

methMapCursor

methgetXconst

methgetYconst

methgetDirectionconst

methgetTypeconst

methisVisibleconst

methsetX

methsetY

methsetDirection

methsetType

methsetVisible

methgetCaptionconst

methsetCaption

classMapRenderer

methMapRendererexplicit

meth~MapRenderervirtual

methisContextualconst

methinitializevirtual

methrenderabstract

classMapView

enumScale

meth~MapViewvirtual

methgetIdabstractconst

methisVirtualabstractconst

methgetScaleabstractconst

methsetScaleabstract

methgetCenterXabstractconst

methgetCenterZabstractconst

methsetCenterXabstract

methsetCenterZabstract

methgetDimensionabstractconst

methsetDimensionabstract

methgetRenderersabstractconst

methaddRendererabstract

methremoveRendererabstract

methisUnlimitedTrackingabstractconst

methsetUnlimitedTrackingabstract

methisLockedabstractconst

methsetLockedabstract

On this page

`class`MapCanvas

`meth`~MapCanvasvirtual

`meth`getMapViewabstractconst

`meth`getCursorsabstractconst

`meth`setCursorsabstract

`meth`setPixelColorabstract

`meth`getPixelColorabstractconst

`meth`getBasePixelColorabstractconst

`meth`setPixelabstract

`meth`getPixelabstractconst

`meth`getBasePixelabstractconst

`meth`drawImageabstract

`class`MapCursor

`enum`Type

`meth`MapCursor

`meth`getXconst

`meth`getYconst

`meth`getDirectionconst

`meth`getTypeconst

`meth`isVisibleconst

`meth`setX

`meth`setY

`meth`setDirection

`meth`setType

`meth`setVisible

`meth`getCaptionconst

`meth`setCaption

`class`MapRenderer

`meth`MapRendererexplicit

`meth`~MapRenderervirtual

`meth`isContextualconst

`meth`initializevirtual

`meth`renderabstract

`class`MapView

`enum`Scale

`meth`~MapViewvirtual

`meth`getIdabstractconst

`meth`isVirtualabstractconst

`meth`getScaleabstractconst

`meth`setScaleabstract

`meth`getCenterXabstractconst

`meth`getCenterZabstractconst

`meth`setCenterXabstract

`meth`setCenterZabstract

`meth`getDimensionabstractconst

`meth`setDimensionabstract

`meth`getRenderersabstractconst

`meth`addRendererabstract

`meth`removeRendererabstract

`meth`isUnlimitedTrackingabstractconst

`meth`setUnlimitedTrackingabstract

`meth`isLockedabstractconst

`meth`setLockedabstract