org.spongepowered.api.block.tileentity.carrier

Interface Beacon

All Superinterfaces:

BlockCarrier, Carrier, CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, Locatable, PropertyHolder, TileEntity, TileEntityCarrier, ValueContainer<DataHolder>

public interface Beacon
extends TileEntityCarrier

Represents a Beacon.

Beacons apply prescribed effects according to the BeaconData. Depending on the completed levels of the beacon, the effects may be applied at a further range or shorter range.

Method Summary

Modifier and Type	Method and Description
default BeaconData	getBeaconData() Gets the current BeaconData for this beacon.
int	getCompletedLevels() Gets the number of completed levels of valid beacon structure blocks beneath this beacon.
default OptionalValue<PotionEffectType>	primaryEffect() Gets the OptionalValue for the primary PotionEffectType.
default OptionalValue<PotionEffectType>	secondaryEffect() Gets the OptionalValue for the secondary PotionEffectType.

Methods inherited from interface org.spongepowered.api.block.tileentity.carrier.TileEntityCarrier

getInventory

Methods inherited from interface org.spongepowered.api.block.tileentity.TileEntity

createArchetype, getBlock, getLocatableBlock, getType, isValid, setValid

Methods inherited from interface org.spongepowered.api.data.DataHolder

setRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Methods inherited from interface org.spongepowered.api.item.inventory.BlockCarrier

getInventory, getLocation

Methods inherited from interface org.spongepowered.api.world.Locatable

getWorld

Method Detail

getCompletedLevels

int getCompletedLevels()

Gets the number of completed levels of valid beacon structure blocks beneath this beacon.

Returns:

The number of levels

getBeaconData

default BeaconData getBeaconData()

Gets the current BeaconData for this beacon.

Returns:

The current beacon data for this beacon

primaryEffect

default OptionalValue<PotionEffectType> primaryEffect()

Gets the OptionalValue for the primary PotionEffectType.

Returns:

The optional value for the primary potion effect

secondaryEffect

default OptionalValue<PotionEffectType> secondaryEffect()

Gets the OptionalValue for the secondary PotionEffectType.

Returns:

The optional value for the secondary potion effect