Package org.bukkit.map
Class MapCursor
java.lang.Object
org.bukkit.map.MapCursor
Represents a cursor on a map.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Represents the standard types of map cursors. -
Constructor Summary
ConstructorDescriptionMapCursor
(byte x, byte y, byte direction, byte type, boolean visible) Deprecated.Magic valueDeprecated.Magic value.Deprecated.Magic valueMapCursor
(byte x, byte y, byte direction, @NotNull MapCursor.Type type, boolean visible) Initialize the map cursor.MapCursor
(byte x, byte y, byte direction, @NotNull MapCursor.Type type, boolean visible, @Nullable String caption) Initialize the map cursor.MapCursor
(byte x, byte y, byte direction, @NotNull MapCursor.Type type, boolean visible, @Nullable Component caption) Initialize the map cursor. -
Method Summary
Modifier and TypeMethodDescriptioncaption()
Gets the caption on this cursor.void
Sets the caption on this cursor.Deprecated.in favour ofcaption()
byte
Get the direction of this cursor.byte
Get the type of this cursor.getType()
Get the type of this cursor.byte
getX()
Get the X position of this cursor.byte
getY()
Get the Y position of this cursor.boolean
Get the visibility status of this cursor.void
setCaption
(@Nullable String caption) Deprecated.in favour ofcaption(net.kyori.adventure.text.Component)
void
setDirection
(byte direction) Set the direction of this cursor.void
setRawType
(byte type) Deprecated, for removal: This API element is subject to removal in a future version.usesetType(Type)
void
setType
(@NotNull MapCursor.Type type) Set the type of this cursor.void
setVisible
(boolean visible) Set the visibility status of this cursor.void
setX
(byte x) Set the X position of this cursor.void
setY
(byte y) Set the Y position of this cursor.
-
Constructor Details
-
MapCursor
Deprecated.Magic valueInitialize the map cursor.- Parameters:
x
- The x coordinate, from -128 to 127.y
- The y coordinate, from -128 to 127.direction
- The facing of the cursor, from 0 to 15.type
- The type (color/style) of the map cursor.visible
- Whether the cursor is visible by default.
-
MapCursor
public MapCursor(byte x, byte y, byte direction, @NotNull @NotNull MapCursor.Type type, boolean visible) Initialize the map cursor.- Parameters:
x
- The x coordinate, from -128 to 127.y
- The y coordinate, from -128 to 127.direction
- The facing of the cursor, from 0 to 15.type
- The type (color/style) of the map cursor.visible
- Whether the cursor is visible by default.
-
MapCursor
@Deprecated public MapCursor(byte x, byte y, byte direction, byte type, boolean visible, @Nullable @Nullable String caption) Deprecated.Initialize the map cursor.- Parameters:
x
- The x coordinate, from -128 to 127.y
- The y coordinate, from -128 to 127.direction
- The facing of the cursor, from 0 to 15.type
- The type (color/style) of the map cursor.visible
- Whether the cursor is visible by default.caption
- cursor caption
-
MapCursor
@Deprecated public MapCursor(byte x, byte y, byte direction, byte type, boolean visible, @Nullable Component caption) Deprecated.Magic valueInitialize the map cursor.- Parameters:
x
- The x coordinate, from -128 to 127.y
- The y coordinate, from -128 to 127.direction
- The facing of the cursor, from 0 to 15.type
- The type (color/style) of the map cursor.visible
- Whether the cursor is visible by default.caption
- cursor caption
-
MapCursor
public MapCursor(byte x, byte y, byte direction, @NotNull @NotNull MapCursor.Type type, boolean visible, @Nullable Component caption) Initialize the map cursor.- Parameters:
x
- The x coordinate, from -128 to 127.y
- The y coordinate, from -128 to 127.direction
- The facing of the cursor, from 0 to 15.type
- The type (color/style) of the map cursor.visible
- Whether the cursor is visible by default.caption
- cursor caption
-
MapCursor
public MapCursor(byte x, byte y, byte direction, @NotNull @NotNull MapCursor.Type type, boolean visible, @Nullable @Nullable String caption) Initialize the map cursor.- Parameters:
x
- The x coordinate, from -128 to 127.y
- The y coordinate, from -128 to 127.direction
- The facing of the cursor, from 0 to 15.type
- The type (color/style) of the map cursor.visible
- Whether the cursor is visible by default.caption
- cursor caption
-
-
Method Details
-
getX
public byte getX()Get the X position of this cursor.- Returns:
- The X coordinate.
-
getY
public byte getY()Get the Y position of this cursor.- Returns:
- The Y coordinate.
-
getDirection
public byte getDirection()Get the direction of this cursor.- Returns:
- The facing of the cursor, from 0 to 15.
-
getType
Get the type of this cursor.- Returns:
- The type (color/style) of the map cursor.
-
getRawType
Get the type of this cursor.- Returns:
- The type (color/style) of the map cursor.
- API Note:
- Internal Use Only
-
isVisible
public boolean isVisible()Get the visibility status of this cursor.- Returns:
- True if visible, false otherwise.
-
setX
public void setX(byte x) Set the X position of this cursor.- Parameters:
x
- The X coordinate.
-
setY
public void setY(byte y) Set the Y position of this cursor.- Parameters:
y
- The Y coordinate.
-
setDirection
public void setDirection(byte direction) Set the direction of this cursor.- Parameters:
direction
- The facing of the cursor, from 0 to 15.
-
setType
Set the type of this cursor.- Parameters:
type
- The type (color/style) of the map cursor.
-
setRawType
Deprecated, for removal: This API element is subject to removal in a future version.usesetType(Type)
Set the type of this cursor.- Parameters:
type
- The type (color/style) of the map cursor.
-
setVisible
public void setVisible(boolean visible) Set the visibility status of this cursor.- Parameters:
visible
- True if visible.
-
getCaption
Deprecated.in favour ofcaption()
Gets the caption on this cursor.- Returns:
- caption
-
setCaption
Deprecated.in favour ofcaption(net.kyori.adventure.text.Component)
Sets the caption on this cursor.- Parameters:
caption
- new caption
-