org.spongepowered.api.entity.weather

Interface WeatherEffect

All Superinterfaces:

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

All Known Subinterfaces:

Lightning

public interface WeatherEffect
extends Entity

Represents weather, such as Lightning.

Method Summary

Modifier and Type	Method and Description
default MutableBoundedValue<Integer>	expireTicks() Gets the MutableBoundedValue for the amount of "ticks" remaining before the "expiration" occurs.
default ExpirableData	getExpiringData() Gets a copy of the ExpirableData for this weather entity.
boolean	isEffect() Returns whether this weather effect is an effect and doesn't deal damage.
void	setEffect(boolean effect) Sets whether this weather effect is an effect and doesn't deal damage.

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

addPassenger, canSee, clearPassengers, createArchetype, createSnapshot, damage, getBaseVehicle, getBoundingBox, getCreator, getNearbyEntities, getNearbyEntities, getNotifier, getPassengers, getRandom, getRotation, getScale, getTransform, getType, getVehicle, getVelocity, gravity, hasPassenger, isLoaded, isOnGround, isRemoved, remove, removePassenger, 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

isEffect

boolean isEffect()

Returns whether this weather effect is an effect and doesn't deal damage.

Returns:

Whether this weather effect is an effect

setEffect

void setEffect(boolean effect)

Sets whether this weather effect is an effect and doesn't deal damage.

Parameters:

effect - Whether this weather effect is an effect

getExpiringData

default ExpirableData getExpiringData()

Gets a copy of the ExpirableData for this weather entity.

Returns:

A copy of the expirable data

expireTicks

default MutableBoundedValue<Integer> expireTicks()

Gets the MutableBoundedValue for the amount of "ticks" remaining before the "expiration" occurs.

Returns:

The immutable bounded value for the amount of ticks remaining