Package org.bukkit.block

Interface Vault

All Superinterfaces:

BlockState, Metadatable, PersistentDataHolder, TileState

@Experimental
public interface Vault
extends TileState

Represents a captured state of a vault.

Method Summary

Modifier and Type	Method	Description
double	getActivationRange()	Gets the distance at which a player must enter for this vault to activate.
double	getDeactivationRange()	Gets the distance at which a player must exit for the vault to deactivate.
LootTable	getDisplayLootTable()	Gets the LootTable this vault will display items from.
ItemStack	getKeyItem()	Gets the ItemStack players must use to unlock this vault.
LootTable	getLootTable()	Gets the LootTable this vault will pick rewards from.
Set<UUID>	getRewardedPlayers()	Gets the players who have already received rewards from this vault.
void	setActivationRange(double range)	Sets the distance at which a player must enter for this vault to activate.
void	setDeactivationRange(double range)	Sets the distance at which a player must exit for this vault to deactivate.
void	setDisplayLootTable(LootTable table)	Sets the LootTable this vault will display items from.
void	setKeyItem(ItemStack keyItem)	Sets the ItemStack players must use to unlock this vault.
void	setLootTable(LootTable table)	Sets the LootTable this vault will pick rewards from.

Methods inherited from interface org.bukkit.block.BlockState

copy, copy, getBlock, getBlockData, getChunk, getData, getLightLevel, getLocation, getLocation, getRawData, getType, getWorld, getX, getY, getZ, isPlaced, setBlockData, setData, setRawData, setType, update, update, update

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.block.TileState

getPersistentDataContainer

Method Details

getActivationRange

double getActivationRange()

Gets the distance at which a player must enter for this vault to activate.

Returns:

the distance at which a player must enter for this vault to activate.

setActivationRange

void setActivationRange(double range)

Sets the distance at which a player must enter for this vault to activate.

Parameters:

range - the distance at which a player must enter for this vault to activate.

getDeactivationRange

double getDeactivationRange()

Gets the distance at which a player must exit for the vault to deactivate.

Returns:

the distance at which a player must exit for the vault to deactivate.

setDeactivationRange

void setDeactivationRange(double range)

Sets the distance at which a player must exit for this vault to deactivate.

Parameters:

range - the distance at which a player must exit for this vault to deactivate.

getLootTable

@NotNull
LootTable getLootTable()

Gets the LootTable this vault will pick rewards from.

Returns:

the loot table

setLootTable

void setLootTable(@NotNull
 LootTable table)

Sets the LootTable this vault will pick rewards from.

Parameters:

table - the loot table

getDisplayLootTable

@Nullable
LootTable getDisplayLootTable()

Gets the LootTable this vault will display items from.
If this value is null the regular loot table will be used to display items.

Returns:

the loot table to display items from

setDisplayLootTable

void setDisplayLootTable(@Nullable
 LootTable table)

Sets the LootTable this vault will display items from.
If this value is set to null the regular loot table will be used to display items.

Parameters:

table - the loot table to display items from

getKeyItem

@NotNull
ItemStack getKeyItem()

Gets the ItemStack players must use to unlock this vault.

Returns:

the key item

setKeyItem

void setKeyItem(@NotNull
 ItemStack keyItem)

Sets the ItemStack players must use to unlock this vault.

Parameters:

keyItem - the key item

getRewardedPlayers

@NotNull
Set<UUID> getRewardedPlayers()

Gets the players who have already received rewards from this vault.

Returns:

unmodifiable set of player UUIDs

Throws:

IllegalStateException - if this block state is not placed