Package org.bukkit.inventory.meta
Interface MapMeta
- All Superinterfaces:
Cloneable
,ConfigurationSerializable
,ItemMeta
,PersistentDataHolder
,PersistentDataViewHolder
Represents a map that can be scalable.
-
Method Summary
Modifier and TypeMethodDescriptionclone()
getColor()
Gets the map color that is set.Deprecated.int
getMapId()
Gets the map ID that is set.Gets the map view that is associated with this map item.boolean
hasColor()
Checks for existence of a map color.boolean
Deprecated.This method does not have the expected effect and is actually an alias forItemMeta.hasLocalizedName()
.boolean
hasMapId()
Checks for existence of a map ID number.boolean
Checks for existence of an associated map.boolean
Checks to see if this map is scaling.void
Sets the map color.void
setLocationName
(@Nullable String name) Deprecated.This method does not have the expected effect and is actually an alias forItemMeta.setLocalizedName(String)
.void
setMapId
(int id) Deprecated.These methods are poor API: They rely on the caller to pass in an only an integer property, and have poorly defined implementation behavior if that integer is not a valid map (the current implementation for example will generate a new map with a different ID).void
setMapView
(MapView map) Sets the associated map.void
setScaling
(boolean value) Sets if this map is scaling or not.Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable
serialize
Methods inherited from interface org.bukkit.inventory.meta.ItemMeta
addAttributeModifier, addEnchant, addItemFlags, displayName, displayName, getAsComponentString, getAsString, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getCanDestroy, getCanPlaceOn, getCustomModelData, getCustomTagContainer, getDamageResistant, getDestroyableKeys, getDisplayName, getDisplayNameComponent, getEnchantable, getEnchantLevel, getEnchantmentGlintOverride, getEnchants, getEquippable, getFood, getItemFlags, getItemModel, getItemName, getJukeboxPlayable, getLocalizedName, getLore, getLoreComponents, getMaxStackSize, getPlaceableKeys, getRarity, getTool, getTooltipStyle, getUseCooldown, getUseRemainder, hasAttributeModifiers, hasConflictingEnchant, hasCustomModelData, hasDamageResistant, hasDestroyableKeys, hasDisplayName, hasEnchant, hasEnchantable, hasEnchantmentGlintOverride, hasEnchants, hasEquippable, hasFood, hasItemFlag, hasItemModel, hasItemName, hasJukeboxPlayable, hasLocalizedName, hasLore, hasMaxStackSize, hasPlaceableKeys, hasRarity, hasTool, hasTooltipStyle, hasUseCooldown, hasUseRemainder, isFireResistant, isGlider, isHideTooltip, isUnbreakable, itemName, itemName, lore, lore, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeEnchantments, removeItemFlags, setAttributeModifiers, setCanDestroy, setCanPlaceOn, setCustomModelData, setDamageResistant, setDestroyableKeys, setDisplayName, setDisplayNameComponent, setEnchantable, setEnchantmentGlintOverride, setEquippable, setFireResistant, setFood, setGlider, setHideTooltip, setItemModel, setItemName, setJukeboxPlayable, setLocalizedName, setLore, setLoreComponents, setMaxStackSize, setPlaceableKeys, setRarity, setTool, setTooltipStyle, setUnbreakable, setUseCooldown, setUseRemainder, setVersion
Methods inherited from interface org.bukkit.persistence.PersistentDataHolder
getPersistentDataContainer
-
Method Details
-
hasMapId
boolean hasMapId()Checks for existence of a map ID number.- Returns:
- true if this has a map ID number.
- See Also:
-
getMapId
int getMapId()Gets the map ID that is set. This is used to determine what map is displayed.Plugins should check that hasMapId() returns
true
before calling this method.- Returns:
- the map ID that is set
- See Also:
-
setMapId
Deprecated.These methods are poor API: They rely on the caller to pass in an only an integer property, and have poorly defined implementation behavior if that integer is not a valid map (the current implementation for example will generate a new map with a different ID). The xxxMapView family of methods should be used instead.Sets the map ID. This is used to determine what map is displayed.- Parameters:
id
- the map id to set- See Also:
-
hasMapView
boolean hasMapView()Checks for existence of an associated map.- Returns:
- true if this item has an associated map
-
getMapView
Gets the map view that is associated with this map item.Plugins should check that hasMapView() returns
true
before calling this method.- Returns:
- the map view, or null if the item hasMapView(), but this map does not exist on the server
-
setMapView
Sets the associated map. This is used to determine what map is displayed.The implementation may allow null to clear the associated map, but this is not required and is liable to generate a new (undefined) map when the item is first used.
- Parameters:
map
- the map to set
-
isScaling
boolean isScaling()Checks to see if this map is scaling.- Returns:
- true if this map is scaling
-
setScaling
void setScaling(boolean value) Sets if this map is scaling or not.- Parameters:
value
- true to scale
-
hasLocationName
Deprecated.This method does not have the expected effect and is actually an alias forItemMeta.hasLocalizedName()
.Checks for existence of a location name.- Returns:
- true if this has a location name
-
getLocationName
Deprecated.This method does not have the expected effect and is actually an alias forItemMeta.getLocalizedName()
.Gets the location name that is set.Plugins should check that hasLocationName() returns
true
before calling this method.- Returns:
- the location name that is set
-
setLocationName
Deprecated.This method does not have the expected effect and is actually an alias forItemMeta.setLocalizedName(String)
.Sets the location name.- Parameters:
name
- the name to set
-
hasColor
boolean hasColor()Checks for existence of a map color.- Returns:
- true if this has a custom map color
-
getColor
Gets the map color that is set. A custom map color will alter the display of the map in an inventory slot.Plugins should check that hasColor() returns
true
before calling this method.- Returns:
- the map color that is set
-
setColor
Sets the map color. A custom map color will alter the display of the map in an inventory slot.- Parameters:
color
- the color to set
-
clone
-
ItemMeta.getLocalizedName()
.