com.sk89q.worldedit.entity

Interface Entity

All Superinterfaces:

Faceted

All Known Subinterfaces:

Player

All Known Implementing Classes:

AbstractPlayerActor, BukkitPlayer, LocalPlayer

public interface Entity
extends Faceted

A reference to an instance of an entity that exists in an Extent and thus would have position and similar details.

This object cannot be directly cloned because it represents a particular instance of an entity, but a BaseEntity can be created from this entity by calling getState().

Method Summary

Modifier and Type	Method and Description
Extent	getExtent() Get the extent that this entity is on.
Location	getLocation() Get the location of this entity.
BaseEntity	getState() Get a copy of the entity's state.
boolean	remove() Remove this entity from it container.

Methods inherited from interface com.sk89q.worldedit.util.Faceted

getFacet

Method Detail

getState

@Nullable
BaseEntity getState()

Get a copy of the entity's state.

In some cases, this method may return null if a snapshot of the entity can't be created. It may not be possible, for example, to get a snapshot of a player.

Returns:

the entity's state or null if one cannot be created

getLocation

Location getLocation()

Get the location of this entity.

Returns:

the location of the entity

getExtent

Extent getExtent()

Get the extent that this entity is on.

Returns:

the extent

remove

boolean remove()

Remove this entity from it container.

Returns:

true if removal was successful