org.spongepowered.api.data.manipulator.immutable.entity

Interface ImmutableAreaEffectCloudData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableAreaEffectCloudData,AreaEffectCloudData>, ValueContainer<ImmutableAreaEffectCloudData>

public interface ImmutableAreaEffectCloudData
extends ImmutableDataManipulator<ImmutableAreaEffectCloudData,AreaEffectCloudData>

Method Summary

Modifier and Type	Method and Description
ImmutableBoundedValue<Integer>	age() Gets the bounded age value of this cloud.
ImmutableBoundedValue<Integer>	applicationDelay() Gets the bounded applicationDelay value of this cloud.
ImmutableValue<Color>	color() Gets the Color of this cloud, can be changed.
ImmutableBoundedValue<Integer>	duration() Gets the bounded duration value of this cloud.
ImmutableBoundedValue<Integer>	durationOnUse() Gets the bounded durationOnUse value of this cloud.
ImmutableListValue<PotionEffect>	effects() Gets the ListValue of PotionEffects of this cloud.
ImmutableValue<ParticleType>	particleType() Gets the ParticleType of this cloud.
ImmutableBoundedValue<Double>	radius() Gets the radius value of this cloud.
ImmutableBoundedValue<Double>	radiusOnUse() Gets the bounded radiusOnUse value of this cloud.
ImmutableBoundedValue<Double>	radiusPerTick() Gets the bounded radiusPerTick value of this cloud.
ImmutableBoundedValue<Integer>	waitTime() Gets the bounded waitTime value of this cloud.

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

color

ImmutableValue<Color> color()

Gets the Color of this cloud, can be changed.

Returns:

The color of this cloud

radius

ImmutableBoundedValue<Double> radius()

Gets the radius value of this cloud.

Returns:

The radius value of this cloud

particleType

ImmutableValue<ParticleType> particleType()

Gets the ParticleType of this cloud.

Returns:

The particle type of this cloud

duration

ImmutableBoundedValue<Integer> duration()

Gets the bounded duration value of this cloud.

Returns:

The bounded duration value

waitTime

ImmutableBoundedValue<Integer> waitTime()

Gets the bounded waitTime value of this cloud. The wait time dictates how long until this cloud will affect Entity instances with PotionEffects.

Returns:

The bounded wait time value

radiusOnUse

ImmutableBoundedValue<Double> radiusOnUse()

Gets the bounded radiusOnUse value of this cloud. The radius is reduced per Entity affected. Once the radius is 0, the cloud dissipates.

Returns:

The bounded radius reduced on use value

radiusPerTick

ImmutableBoundedValue<Double> radiusPerTick()

Gets the bounded radiusPerTick value of this cloud. The radius is reduced per tick (so technically can be set to 0 to have it remain permanent until it's effects have been used up.

Returns:

The bounded radius reduction per tick value

durationOnUse

ImmutableBoundedValue<Integer> durationOnUse()

Gets the bounded durationOnUse value of this cloud. The duration on use is reduced for every time that this cloud applies it's PotionEffects on an Entity.

Returns:

The bounded duration on use value

applicationDelay

ImmutableBoundedValue<Integer> applicationDelay()

Gets the bounded applicationDelay value of this cloud. What this means is the application delay between times of application on an Entity.

Returns:

The bounded re-application delay value

effects

ImmutableListValue<PotionEffect> effects()

Gets the ListValue of PotionEffects of this cloud. The potion effects will affect any Entity according to the various delays and ticks remaining of this cloud.

Returns:

The list of potion effects

age

ImmutableBoundedValue<Integer> age()

Gets the bounded age value of this cloud.

Returns:

The bounded age value