org.spongepowered.api.data.manipulator.mutable.entity

Interface AreaEffectCloudData

All Superinterfaces:

DataManipulator<AreaEffectCloudData,ImmutableAreaEffectCloudData>, DataSerializable, ValueContainer<AreaEffectCloudData>

public interface AreaEffectCloudData
extends DataManipulator<AreaEffectCloudData,ImmutableAreaEffectCloudData>

Method Summary

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

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

asImmutable, copy, fill, fill, from, set, set, set, set, transform

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

Value<Color> color()

Gets the Color of this cloud, can be changed.

Returns:

The color of this cloud

See Also:

Keys.AREA_EFFECT_CLOUD_COLOR

radius

MutableBoundedValue<Double> radius()

Gets the radius value of this cloud.

Returns:

The radius value of this cloud

See Also:

Keys.AREA_EFFECT_CLOUD_RADIUS

particleType

Value<ParticleType> particleType()

Gets the ParticleType of this cloud.

Returns:

The particle type of this cloud

See Also:

Keys.AREA_EFFECT_CLOUD_PARTICLE_TYPE

duration

MutableBoundedValue<Integer> duration()

Gets the bounded duration value of this cloud.

Returns:

The bounded duration value

See Also:

Keys.AREA_EFFECT_CLOUD_DURATION

waitTime

MutableBoundedValue<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

See Also:

Keys.AREA_EFFECT_CLOUD_WAIT_TIME

radiusOnUse

MutableBoundedValue<Double> radiusOnUse()

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

A positive radiusOnUse value will make the cloud grow, a negative one will make it shrink.

Returns:

The bounded radius reduced on use value

See Also:

Keys.AREA_EFFECT_CLOUD_RADIUS_ON_USE

radiusPerTick

MutableBoundedValue<Double> radiusPerTick()

Gets the bounded radiusPerTick value of this cloud.

The radius is increased every tick. A radiusPerTick of 0 will cause the cloud to stay at its original size until its duration runs out, a positive number will make it grow, and a negative number will make it shrink whenever it applies its effect.

Returns:

The bounded radius reduction per tick value

See Also:

Keys.AREA_EFFECT_CLOUD_RADIUS_PER_TICK

durationOnUse

MutableBoundedValue<Integer> durationOnUse()

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

If the duration on use is negative, every application of an effect to an entity will decrease the cloud's duration

Returns:

The bounded duration on use value

See Also:

Keys.AREA_EFFECT_CLOUD_DURATION_ON_USE

applicationDelay

MutableBoundedValue<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

See Also:

Keys.AREA_EFFECT_CLOUD_REAPPLICATION_DELAY

effects

ListValue<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

See Also:

Keys.POTION_EFFECTS

age

MutableBoundedValue<Integer> age()

Gets the bounded age value of this cloud.

Returns:

The bounded age value

See Also:

Keys.AREA_EFFECT_CLOUD_AGE