org.spongepowered.api.entity

Interface AreaEffectCloud

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, Entity, Identifiable, Locatable, PropertyHolder, Translatable, ValueContainer<DataHolder>

public interface AreaEffectCloud
extends Entity

Represents an AreaEffectCloud. The cloud will apply PotionEffects to Entity instances within it's bounding box.

Method Summary

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

Methods inherited from interface org.spongepowered.api.entity.Entity

addPassenger, addTag, canSee, clearPassengers, createArchetype, createSnapshot, damage, getBaseVehicle, getBoundingBox, getCreator, getNearbyEntities, getNearbyEntities, getNotifier, getPassengers, getRandom, getRotation, getScale, getTags, getTransform, getType, getVehicle, getVelocity, gravity, hasPassenger, hasTag, isLoaded, isOnGround, isRemoved, remove, removePassenger, removeTag, setCreator, setLocation, setLocationAndRotation, setLocationAndRotation, setLocationAndRotationSafely, setLocationAndRotationSafely, setLocationSafely, setNotifier, setRotation, setScale, setTransform, setTransformSafely, setVehicle, setVelocity, transferToWorld, transferToWorld, transferToWorld, transferToWorld

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

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

getLocation, getWorld

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.text.translation.Translatable

getTranslation

Method Detail

getAreaEffectCloudData

default AreaEffectCloudData getAreaEffectCloudData()

Gets the AreaEffectCloudData for this cloud.

Returns:

The area effect cloud data

color

default Value<Color> color()

Gets the Color of this cloud, can be changed.

Returns:

The color of this cloud

radius

default MutableBoundedValue<Double> radius()

Gets the radius value of this cloud.

Returns:

The radius value of this cloud

particleType

default Value<ParticleType> particleType()

Gets the ParticleType of this cloud.

Returns:

The particle type of this cloud

duration

default MutableBoundedValue<Integer> duration()

Gets the bounded duration value of this cloud.

Returns:

The bounded duration value

waitTime

default 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

radiusOnUse

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

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

default MutableBoundedValue<Integer> durationOnUse()

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

Returns:

The bounded duration on use value

applicationDelay

default 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

effects

default 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

age

default MutableBoundedValue<Integer> age()

Gets the bounded age value of this cloud.

Returns:

The bounded age value