Package org.bukkit.map

Enum Class MapCursor.Type

java.lang.Object

java.lang.Enum<MapCursor.Type>

org.bukkit.map.MapCursor.Type

All Implemented Interfaces:

Serializable, Comparable<MapCursor.Type>, Constable, net.kyori.adventure.key.Keyed, Keyed

Enclosing class:

MapCursor

public static enum MapCursor.Type
extends Enum<MapCursor.Type>
implements Keyed

Represents the standard types of map cursors. More may be made available by resource packs - the value is used by the client as an index in the file './assets/minecraft/textures/map/map_icons.png' from minecraft.jar or from a resource pack.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BANNER_BLACK
BANNER_BLUE
BANNER_BROWN
BANNER_CYAN
BANNER_GRAY
BANNER_GREEN
BANNER_LIGHT_BLUE
BANNER_LIGHT_GRAY
BANNER_LIME
BANNER_MAGENTA
BANNER_ORANGE
BANNER_PINK
BANNER_PURPLE
BANNER_RED
BANNER_WHITE
BANNER_YELLOW
BLUE_MARKER
FRAME
JUNGLE_TEMPLE
MANSION
MONUMENT
PLAYER
PLAYER_OFF_LIMITS
PLAYER_OFF_MAP
RED_MARKER
RED_X
SWAMP_HUT
TARGET_POINT
TARGET_X
TRIAL_CHAMBERS
VILLAGE_DESERT
VILLAGE_PLAINS
VILLAGE_SAVANNA
VILLAGE_SNOWY
VILLAGE_TAIGA

Method Summary

Modifier and Type	Method	Description
static @Nullable MapCursor.Type	byValue(byte value)	Get a cursor by its internal value.
@NotNull NamespacedKey	getKey()	Return the namespaced identifier for this object.
byte	getValue()	Gets the internal value of the cursor.
static MapCursor.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MapCursor.Type[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bukkit.Keyed

key

Enum Constant Details

PLAYER

public static final MapCursor.Type PLAYER

FRAME

public static final MapCursor.Type FRAME

RED_MARKER

public static final MapCursor.Type RED_MARKER

BLUE_MARKER

public static final MapCursor.Type BLUE_MARKER

TARGET_X

public static final MapCursor.Type TARGET_X

TARGET_POINT

public static final MapCursor.Type TARGET_POINT

PLAYER_OFF_MAP

public static final MapCursor.Type PLAYER_OFF_MAP

PLAYER_OFF_LIMITS

public static final MapCursor.Type PLAYER_OFF_LIMITS

MANSION

public static final MapCursor.Type MANSION

MONUMENT

public static final MapCursor.Type MONUMENT

BANNER_WHITE

public static final MapCursor.Type BANNER_WHITE

BANNER_ORANGE

public static final MapCursor.Type BANNER_ORANGE

BANNER_MAGENTA

public static final MapCursor.Type BANNER_MAGENTA

BANNER_LIGHT_BLUE

public static final MapCursor.Type BANNER_LIGHT_BLUE

BANNER_YELLOW

public static final MapCursor.Type BANNER_YELLOW

BANNER_LIME

public static final MapCursor.Type BANNER_LIME

BANNER_PINK

public static final MapCursor.Type BANNER_PINK

BANNER_GRAY

public static final MapCursor.Type BANNER_GRAY

BANNER_LIGHT_GRAY

public static final MapCursor.Type BANNER_LIGHT_GRAY

BANNER_CYAN

public static final MapCursor.Type BANNER_CYAN

BANNER_PURPLE

public static final MapCursor.Type BANNER_PURPLE

BANNER_BLUE

public static final MapCursor.Type BANNER_BLUE

BANNER_BROWN

public static final MapCursor.Type BANNER_BROWN

BANNER_GREEN

public static final MapCursor.Type BANNER_GREEN

BANNER_RED

public static final MapCursor.Type BANNER_RED

BANNER_BLACK

public static final MapCursor.Type BANNER_BLACK

RED_X

public static final MapCursor.Type RED_X

VILLAGE_DESERT

@MinecraftExperimental(TRADE_REBALANCE)
@Experimental
public static final MapCursor.Type VILLAGE_DESERT

VILLAGE_PLAINS

@MinecraftExperimental(TRADE_REBALANCE)
@Experimental
public static final MapCursor.Type VILLAGE_PLAINS

VILLAGE_SAVANNA

@MinecraftExperimental(TRADE_REBALANCE)
@Experimental
public static final MapCursor.Type VILLAGE_SAVANNA

VILLAGE_SNOWY

@MinecraftExperimental(TRADE_REBALANCE)
@Experimental
public static final MapCursor.Type VILLAGE_SNOWY

VILLAGE_TAIGA

@MinecraftExperimental(TRADE_REBALANCE)
@Experimental
public static final MapCursor.Type VILLAGE_TAIGA

JUNGLE_TEMPLE

@MinecraftExperimental(TRADE_REBALANCE)
@Experimental
public static final MapCursor.Type JUNGLE_TEMPLE

SWAMP_HUT

@MinecraftExperimental(TRADE_REBALANCE)
@Experimental
public static final MapCursor.Type SWAMP_HUT

TRIAL_CHAMBERS

@MinecraftExperimental(UPDATE_1_21)
@Experimental
public static final MapCursor.Type TRIAL_CHAMBERS

Method Details

values

public static MapCursor.Type[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MapCursor.Type valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getKey

@NotNull
public @NotNull NamespacedKey getKey()

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

getValue

@Internal
public byte getValue()

Gets the internal value of the cursor.

Returns:

the value

API Note:

Internal Use Only

byValue

@Internal
@Nullable
public static @Nullable MapCursor.Type byValue(byte value)

Get a cursor by its internal value.

Parameters:

value - the value

Returns:

the matching type

API Note:

Internal Use Only