public final class MapCursor extends Object
Modifier and Type | Class | Description |
---|---|---|
static class |
MapCursor.Type |
Represents the standard types of map cursors.
|
Constructor | Description |
---|---|
MapCursor(byte x,
byte y,
byte direction,
byte type,
boolean visible) |
Deprecated.
Magic value
|
MapCursor(byte x,
byte y,
byte direction,
byte type,
boolean visible,
String caption) |
Deprecated.
Magic value
|
MapCursor(byte x,
byte y,
byte direction,
MapCursor.Type type,
boolean visible) |
Initialize the map cursor.
|
MapCursor(byte x,
byte y,
byte direction,
MapCursor.Type type,
boolean visible,
String caption) |
Initialize the map cursor.
|
Modifier and Type | Method | Description |
---|---|---|
String |
getCaption() |
Gets the caption on this cursor.
|
byte |
getDirection() |
Get the direction of this cursor.
|
byte |
getRawType() |
Deprecated.
Magic value
|
MapCursor.Type |
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 |
isVisible() |
Get the visibility status of this cursor.
|
void |
setCaption(String caption) |
Sets the caption on this cursor.
|
void |
setDirection(byte direction) |
Set the direction of this cursor.
|
void |
setRawType(byte type) |
Deprecated.
Magic value
|
void |
setType(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.
|
@Deprecated public MapCursor(byte x, byte y, byte direction, byte type, boolean visible)
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.public MapCursor(byte x, byte y, byte direction, @NotNull MapCursor.Type type, boolean visible)
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.@Deprecated public MapCursor(byte x, byte y, byte direction, byte type, boolean visible, @Nullable String caption)
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 captionpublic MapCursor(byte x, byte y, byte direction, @NotNull MapCursor.Type type, boolean visible, @Nullable String caption)
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 captionpublic byte getX()
public byte getY()
public byte getDirection()
@NotNull public MapCursor.Type getType()
@Deprecated public byte getRawType()
public boolean isVisible()
public void setX(byte x)
x
- The X coordinate.public void setY(byte y)
y
- The Y coordinate.public void setDirection(byte direction)
direction
- The facing of the cursor, from 0 to 15.public void setType(@NotNull MapCursor.Type type)
type
- The type (color/style) of the map cursor.@Deprecated public void setRawType(byte type)
type
- The type (color/style) of the map cursor.public void setVisible(boolean visible)
visible
- True if visible.@Nullable public String getCaption()
public void setCaption(@Nullable String caption)
caption
- new captionCopyright © 2020. All rights reserved.