Package org.bukkit.inventory.meta
Interface CompassMeta
- All Superinterfaces:
Cloneable
,ConfigurationSerializable
,ItemMeta
,PersistentDataHolder
,PersistentDataViewHolder
Represents a compass that can track a specific location.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Reset this compass to a normal compass, removing any tracked location.clone()
Gets the location that this compass will point to.boolean
Checks if this compass has been paired to a lodestone.boolean
Checks if this compass is considered a lodestone compass.boolean
Gets if this compass is tracking a specific lodestone.void
setLodestone
(@Nullable Location lodestone) Sets the location this lodestone compass will point to.void
setLodestoneTracked
(boolean tracked) Sets if this compass is tracking a specific lodestone.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
-
hasLodestone
boolean hasLodestone()Checks if this compass has been paired to a lodestone.- Returns:
- paired status
-
getLodestone
Gets the location that this compass will point to. CheckhasLodestone()
first!- Returns:
- lodestone location
-
setLodestone
Sets the location this lodestone compass will point to.- Parameters:
lodestone
- new location or null to clear the targeted location- See Also:
-
isLodestoneTracked
boolean isLodestoneTracked()Gets if this compass is tracking a specific lodestone. If true the compass will only work if there is a lodestone at the tracked location.- Returns:
- lodestone tracked
-
setLodestoneTracked
void setLodestoneTracked(boolean tracked) Sets if this compass is tracking a specific lodestone. If true the compass will only work if there is a lodestone at the tracked location.- Parameters:
tracked
- new tracked status- See Also:
-
isLodestoneCompass
boolean isLodestoneCompass()Checks if this compass is considered a lodestone compass.- See Also:
-
clearLodestone
void clearLodestone()Reset this compass to a normal compass, removing any tracked location. -
clone
CompassMeta clone()
-