Package com.yottabyte.crates.api.crate
Interface Crate
-
public interface Crate
Represents a crate.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AnimationStyle
getAnimationStyle()
Gets theAnimationType
style.AnimationType
getAnimationType()
Gets the crate'sAnimationType
.String
getDisplayName()
Gets the crate's display name.List<String>
getHologramLines()
Get the hologram lines for the crate.String
getId()
Gets the crate's identifier.org.bukkit.inventory.ItemStack
getKeyItem()
Gets the item stack for the crate's key.KeyType
getKeyType()
Gets the crate'sKeyType
.Set<Reward>
getRewards()
Gets theSet
of registered rewards for the crate.boolean
isHologramEnabled()
Checks whether the hologram for the crate is enabled.
-
-
-
Method Detail
-
getId
String getId()
Gets the crate's identifier.Specified in the crate's configuration file, path: "id".
- Returns:
- the crate identifier
-
isHologramEnabled
boolean isHologramEnabled()
Checks whether the hologram for the crate is enabled.Specified in the crate's configuration file, path: "hologram.enabled".
- Returns:
- true if the hologram is enabled, false otherwise
-
getHologramLines
List<String> getHologramLines()
Get the hologram lines for the crate.Specified in the crate's configuration file, path: "hologram.lines".
- Returns:
- the
List
of lines for the hologram
-
getDisplayName
String getDisplayName()
Gets the crate's display name.Specified in the crate's configuration file, path: "display-name".
- Returns:
- the display name for the crate
-
getAnimationType
AnimationType getAnimationType()
Gets the crate'sAnimationType
.Specified in the crate's configuration file, path: "animation".
- Returns:
- the
AnimationType
for the crate
-
getAnimationStyle
AnimationStyle getAnimationStyle()
Gets theAnimationType
style.Specified in the crate's configuration file, path: "animation-style".
- Returns:
- the style of the
AnimationType
-
getKeyType
KeyType getKeyType()
Gets the crate'sKeyType
.Specified in the crate's configuration file, path: "key-type".
- Returns:
- the
KeyType
for the crate
-
getKeyItem
org.bukkit.inventory.ItemStack getKeyItem()
Gets the item stack for the crate's key.Specified in the crate's configuration file, path: "key-item".
- Returns:
- the item stack for the crate's key or null if the key type is set to
KeyType.VIRTUAL
-
-