Interface Metadatable
- All Known Subinterfaces:
Actor
,MapMetadatable
,Player
- All Known Implementing Classes:
AbstractCommandBlockActor
,AbstractNonPlayerActor
,AbstractPlayerActor
,AsyncPlayer
,LocationMaskedPlayerWrapper
,PlayerProxy
,SilentPlayerWrapper
public interface Metadatable
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescription<V> V
deleteMeta
(String key) Deletes the given metadata key from object.<T> T
getAndSetMeta
(String key, T value) <V> V
Gets the metadata value to which the specified key is mapped, ornull
if the key is not set.default <V> V
Gets the metadata value to which the specified key is mapped, or the default value if no metadata exists for the key.boolean
hasMeta()
Checks if the object contains any metadata.void
Set some session only metadata for the player
-
Method Details
-
setMeta
Set some session only metadata for the player- Parameters:
key
-value
-
-
getAndSetMeta
-
hasMeta
boolean hasMeta()Checks if the object contains any metadata.- Returns:
true
if there is metadata set for the object
-
getMeta
Gets the metadata value to which the specified key is mapped, ornull
if the key is not set.- Parameters:
key
- the key of the metadata value to retrieve- Returns:
- the value of the metadata or
null
if none exists
-
getMeta
Gets the metadata value to which the specified key is mapped, or the default value if no metadata exists for the key.- Parameters:
key
- the key of the metadata value to retrievedefaultValue
- the value to return if there is no metadata for the given key- Returns:
- the metadata value for the key, if present; else the default value
-
deleteMeta
Deletes the given metadata key from object. Do not delete metadata set by another plugin unless you know what you are doing.- Parameters:
key
- the key identifying the metadata to remove.- Returns:
- the previous value associated with they given key
-