Package org.bukkit.inventory.view

Interface BeaconView

All Superinterfaces:

InventoryView

public interface BeaconView
extends InventoryView

An instance of InventoryView which provides extra methods related to beacon view data.

Nested Class Summary

Nested classes/interfaces inherited from interface org.bukkit.inventory.InventoryView

InventoryView.Property

Field Summary

Fields inherited from interface org.bukkit.inventory.InventoryView

OUTSIDE

Method Summary

Modifier and Type	Method	Description
@Nullable PotionEffectType	getPrimaryEffect()	Gets the primary effect of the beacon.
@Nullable PotionEffectType	getSecondaryEffect()	Gets the secondary effect of the beacon.
int	getTier()	Gets the tier of the beacon
@NotNull BeaconInventory	getTopInventory()	Get the upper inventory involved in this transaction.
void	setPrimaryEffect(@Nullable PotionEffectType effect)	Sets the primary effect of the beacon, or null to clear
void	setSecondaryEffect(@Nullable PotionEffectType effect)	Sets the secondary effect on this beacon, or null to clear.

Methods inherited from interface org.bukkit.inventory.InventoryView

close, convertSlot, countSlots, getBottomInventory, getCursor, getInventory, getItem, getOriginalTitle, getPlayer, getSlotType, getTitle, getType, open, setCursor, setItem, setProperty, setTitle, title

Method Details

getTopInventory

@NotNull
@NotNull BeaconInventory getTopInventory()

Description copied from interface: InventoryView

Get the upper inventory involved in this transaction.

Specified by:

getTopInventory in interface InventoryView

Returns:

the inventory

getTier

int getTier()

Gets the tier of the beacon

Beacon tier is deduced by the height of the pyramid the beacon is standing on. The level of the beacon is 0 unless the beacon is activated.

Returns:

The tier of the beacon

getPrimaryEffect

@Nullable
@Nullable PotionEffectType getPrimaryEffect()

Gets the primary effect of the beacon.

If the beacon level is high enough where the primary effect can be upgraded to level two, e.g. Speed 2. Instead of getSecondaryEffect() being null it getSecondaryEffect() returns the same PotionEffectType as this method.

Returns:

The primary effect enabled on the beacon

getSecondaryEffect

@Nullable
@Nullable PotionEffectType getSecondaryEffect()

Gets the secondary effect of the beacon.

If the beacon level is high enough where the primary effect can be upgraded to level two, e.g. Speed 2. The secondary effect will return the same effect as getPrimaryEffect().

Returns:

The secondary effect enabled on the beacon

setPrimaryEffect

void setPrimaryEffect(@Nullable
 @Nullable PotionEffectType effect)

Sets the primary effect of the beacon, or null to clear

The PotionEffectType provided must be one that is already within the beacon as a valid option.

1. PotionEffectType.SPEED
2. PotionEffectType.HASTE
3. PotionEffectType.RESISTANCE
4. PotionEffectType.JUMP_BOOST
5. PotionEffectType.STRENGTH
6. PotionEffectType.REGENERATION

Parameters:

effect - desired primary effect

setSecondaryEffect

void setSecondaryEffect(@Nullable
 @Nullable PotionEffectType effect)

Sets the secondary effect on this beacon, or null to clear. Note that tier must be >= 4 and a primary effect must be set in order for this effect to be active.

The PotionEffectType provided must be one that is already within the beacon as a valid option.

1. PotionEffectType.SPEED
2. PotionEffectType.HASTE
3. PotionEffectType.RESISTANCE
4. PotionEffectType.JUMP_BOOST
5. PotionEffectType.STRENGTH
6. PotionEffectType.REGENERATION

Parameters:

effect - the desired secondary effect