org.bukkit.block

Interface Beacon

All Superinterfaces:

BlockState, Lockable, Metadatable, Nameable, PersistentDataHolder, TileState

public interface Beacon
extends TileState, Lockable, Nameable

Represents a captured state of a beacon.

Method Summary

Modifier and Type	Method and Description
Collection<LivingEntity>	getEntitiesInRange() Returns the list of players within the beacon's range of effect.
PotionEffect	getPrimaryEffect() Returns the primary effect set on the beacon
PotionEffect	getSecondaryEffect() Returns the secondary effect set on the beacon.
int	getTier() Returns the tier of the beacon pyramid (0-4).
void	setPrimaryEffect(PotionEffectType effect) Set the primary effect on this beacon, or null to clear.
void	setSecondaryEffect(PotionEffectType effect) Set the secondary effect on this beacon, or null to clear.

Methods inherited from interface org.bukkit.block.TileState

getPersistentDataContainer

Methods inherited from interface org.bukkit.block.BlockState

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.Lockable

getLock, isLocked, setLock

Methods inherited from interface org.bukkit.Nameable

getCustomName, setCustomName

Method Detail

getEntitiesInRange

@NotNull
Collection<LivingEntity> getEntitiesInRange()

Returns the list of players within the beacon's range of effect.

This will return an empty list if the block represented by this state is no longer a beacon.

Returns:

the players in range

Throws:

IllegalStateException - if this block state is not placed

getTier

int getTier()

Returns the tier of the beacon pyramid (0-4). The tier refers to the beacon's power level, based on how many layers of blocks are in the pyramid. Tier 1 refers to a beacon with one layer of 9 blocks under it.

Returns:

the beacon tier

getPrimaryEffect

@Nullable
PotionEffect getPrimaryEffect()

Returns the primary effect set on the beacon

Returns:

the primary effect or null if not set

setPrimaryEffect

void setPrimaryEffect(@Nullable
                      PotionEffectType effect)

Set the primary effect on this beacon, or null to clear.

Parameters:

effect - new primary effect

getSecondaryEffect

@Nullable
PotionEffect getSecondaryEffect()

Returns the secondary effect set on the beacon.

Returns:

the secondary effect or null if no secondary effect

setSecondaryEffect

void setSecondaryEffect(@Nullable
                        PotionEffectType effect)

Set the secondary effect on this beacon, or null to clear. Note that tier must be >= 4 for this effect to be active.

Parameters:

effect - desired secondary effect