org.spongepowered.api.data.manipulator.immutable.tileentity

Interface ImmutableBeaconData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableBeaconData,BeaconData>, ValueContainer<ImmutableBeaconData>

public interface ImmutableBeaconData
extends ImmutableDataManipulator<ImmutableBeaconData,BeaconData>

An ImmutableDataManipulator handling the data for a Beacon, usually applicable to the PotionEffectTypes being applied to Entity instances in the region around the Beacon.

Method Summary

Modifier and Type	Method and Description
ImmutableBeaconData	clearEffects() Creates a new ImmutableBeaconData with Optional.empty() values for the primary and secondary PotionEffectTypes.
ImmutableOptionalValue<PotionEffectType>	primaryEffect() Gets the ImmutableOptionalValue for the primary PotionEffectType.
ImmutableOptionalValue<PotionEffectType>	secondaryEffect() Gets the ImmutableOptionalValue for the secondary PotionEffectType.

Methods inherited from interface org.spongepowered.api.data.manipulator.ImmutableDataManipulator

asMutable, copy, with, with

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

getContentVersion, toContainer

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

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

Method Detail

primaryEffect

ImmutableOptionalValue<PotionEffectType> primaryEffect()

Gets the ImmutableOptionalValue for the primary PotionEffectType.

Returns:

The immutable optional value for the primary potion effect

secondaryEffect

ImmutableOptionalValue<PotionEffectType> secondaryEffect()

Gets the ImmutableOptionalValue for the secondary PotionEffectType.

Returns:

The immutable optional value for the secondary potion effect

clearEffects

ImmutableBeaconData clearEffects()

Creates a new ImmutableBeaconData with Optional.empty() values for the primary and secondary PotionEffectTypes.

Returns:

The new beacon data instance