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

Interface InvisibilityData

All Superinterfaces:

DataManipulator<InvisibilityData,ImmutableInvisibilityData>, DataSerializable, ValueContainer<InvisibilityData>

public interface InvisibilityData
extends DataManipulator<InvisibilityData,ImmutableInvisibilityData>

A DataManipulator for the "vanish" state. If the value is true, the Entity is rendered "vanish".

Method Summary

Modifier and Type	Method and Description
Value<Boolean>	ignoresCollisionDetection() Gets the Value of whether an Entity that is "vanished" will be ignored for collision detection.
Value<Boolean>	invisible() Gets the Value of the "invisible" state of an Entity.
Value<Boolean>	untargetable() Gets the Value of whether an Entity that is "vanished" will be ignored when other entities are processing possible "targets" for their AI.
Value<Boolean>	vanish() Gets the Value of the "vanish" state of an Entity.

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

invisible

Value<Boolean> invisible()

Gets the Value of the "invisible" state of an Entity.

Note that this is different from the vanish() state as when an Entity is "invisible", update packets are still sent to all clients and the server.

Returns:

The value of the invisible state

See Also:

Keys.INVISIBLE

vanish

Value<Boolean> vanish()

Gets the Value of the "vanish" state of an Entity.

The presence of a vanished entity will not be made known to a client; no packets pertaining to this entity are sent. Client-side, this entity will cease to exist. Server-side it may still be targeted by hostile entities or collide with other entities.

Vanishing an Entity ridden by other entities (see PassengerData) will cause problems.

Returns:

The value of the vanish state

See Also:

Keys.VANISH

ignoresCollisionDetection

Value<Boolean> ignoresCollisionDetection()

Gets the Value of whether an Entity that is "vanished" will be ignored for collision detection. The collision detection can affect collisions with other entities, blocks, etc.

Returns:

The value of the ignore collision detection state

See Also:

Keys.VANISH_IGNORES_COLLISION

untargetable

Value<Boolean> untargetable()

Gets the Value of whether an Entity that is "vanished" will be ignored when other entities are processing possible "targets" for their AI.

Returns:

The value of the targetable detection state

See Also:

Keys.VANISH_PREVENTS_TARGETING