TridentEntity (TridentSDK 0.4-SNAPSHOT API)

java.lang.Object
- net.tridentsdk.server.entity.TridentEntity

All Implemented Interfaces:

Entity

Direct Known Subclasses:

TridentBoat, TridentDroppedItem, TridentExpOrb, TridentFallingBlock, TridentFirework, TridentItemFrame, TridentLivingEntity, TridentMinecart, TridentPainting, TridentProjectile, TridentSpawnerMinecart
```
@PossiblyThreadSafe
public class TridentEntity
extends Object
implements Entity
```
Entity abstraction base

Author:

The TridentSDK Team

Field Summary

Fields
Modifier and Type	Field and Description
`protected AtomicLong`	`airTicks` How many ticks of air the entity has left
`protected BoundingBox`	`boundingBox` TODO
`protected static AtomicInteger`	`counter`
`protected String`	`displayName` The name of the entity appearing above the head
`protected SelectableThreadPool`	`executor` Entity task executor
`protected com.google.common.util.concurrent.AtomicDouble`	`fallDistance` The distance the entity has fallen
`protected AtomicInteger`	`fireTicks` How long the entity has been on fire
`protected boolean`	`godMode` `true` to indicate the entity cannot be damaged
`static EntityHandler`	`HANDLER` Internal entity tracker, used to spawn the entity and track movement, etc.
`protected float`	`height` TODO
`protected int`	`id` The entity ID for the entity
`protected Position`	`loc` The entity location
`protected boolean`	`nameVisible` Whether or not the name of the entity is visible
`protected boolean`	`onGround` Whether or not the entity is touching the ground
`protected Entity`	`passenger` The entity's passenger, if there are any
`protected AtomicInteger`	`portalCooldown` Length of time the entity must wait to enter a portal.
`protected boolean`	`silent` TODO
`protected AtomicLong`	`ticksExisted` The ticks that have passed since the entity was spawned, and alive
`protected UUID`	`uniqueId` The identifier UUID for the entity
`protected Vector`	`velocity` The movement vector for the entity
`protected float`	`width` TODO

Constructor Summary

Constructors
Modifier Constructor and Description

protected TridentEntity()
Deprecated.

TridentEntity(UUID uniqueId, Position spawnLocation)
Creates a new entity

Constructors
Modifier	Constructor and Description
`protected`	`TridentEntity()` Deprecated.
	`TridentEntity(UUID uniqueId, Position spawnLocation)` Creates a new entity

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyProperties(EntityProperties properties)` Sets the properties of this entity to the specified properties
`CompoundTag`	`asNbt()`
`BoundingBox`	`boundingBox()` Returns the bounding box of the entity
`String`	`displayName()` Gets the display name for the entity, used on inventories and deaths
`protected void`	`doEncodeMeta(ProtocolMetadata protocolMeta)`
`protected void`	`doLoad(CompoundTag tag)`
`protected void`	`doRemove()`
`protected void`	`doTick()`
`void`	`eject()` Removes the mounted entity, if there are any
`protected void`	`encodeMetadata(ProtocolMetadata protocolMeta)`
`int`	`entityId()` The identifier for this entity for runtime, see uniqueId for a set id of the entity
`boolean`	`isNameVisible()` Gets if the entity's display name visible
`boolean`	`isSilent()` Gets if the entity is silent (sounds)
`void`	`load(CompoundTag tag)`
`boolean`	`onGround()` Checks if the entity is currently on the ground, or at least touching the ground
`Entity`	`passenger()` Gets the entity that is riding this entity, if there is any
`Position`	`position()` The position of the entity with respect to the coordinate grid
`void`	`remove()` Removes the entity from the world and destroys it, freeing all memory associated with it
`void`	`setDisplayName(String name)` Sets the entity's display name, effects inventories (if applicable) and death messages
`void`	`setOnGround(boolean onGround)`
`void`	`setPassenger(Entity entity)` Mounts the specified entity on this entity
`void`	`setPosition(Position loc)`
`void`	`setSize(float width, float height)` Set the width and height of the entity
`void`	`setVelocity(Vector vector)` Sets the entity's movement direction and speed to the magnitude of the vector
`TridentEntity`	`spawn()` Begin entity management
`void`	`teleport(double x, double y, double z)` Moves the entity to the specified position
`void`	`teleport(Entity entity)` Moves the current entity to the provided entity's position
`void`	`teleport(Position location)` Moves the entity to the coordinates specified by the position object passed in
`void`	`tick()`
`EntityType`	`type()` Gets the type of entity
`UUID`	`uniqueId()` The unique id for the entity to the server
`Vector`	`velocity()` The direction and movement magnitude of the entity
`Set<Entity>`	`withinRange(double radius)` Gets the entities that are within proximity to this entity
`World`	`world()` The world which the entity resides in

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - counter
```
@InternalUseOnly
protected static final AtomicInteger counter
```
  - HANDLER
```
public static final EntityHandler HANDLER
```
    Internal entity tracker, used to spawn the entity and track movement, etc.
  - fallDistance
```
protected final com.google.common.util.concurrent.AtomicDouble fallDistance
```
    The distance the entity has fallen
  - ticksExisted
```
protected final AtomicLong ticksExisted
```
    The ticks that have passed since the entity was spawned, and alive
  - fireTicks
```
protected final AtomicInteger fireTicks
```
    How long the entity has been on fire
  - airTicks
```
protected final AtomicLong airTicks
```
    How many ticks of air the entity has left
  - portalCooldown
```
protected final AtomicInteger portalCooldown
```
    Length of time the entity must wait to enter a portal. Unknown unit. TODO
  - id
```
protected volatile int id
```
    The entity ID for the entity
  - uniqueId
```
protected volatile UUID uniqueId
```
    The identifier UUID for the entity
  - executor
```
protected volatile SelectableThreadPool executor
```
    Entity task executor
  - velocity
```
protected volatile Vector velocity
```
    The movement vector for the entity
  - loc
```
protected volatile Position loc
```
    The entity location
  - onGround
```
protected volatile boolean onGround
```
    Whether or not the entity is touching the ground
  - passenger
```
protected volatile Entity passenger
```
    The entity's passenger, if there are any
  - displayName
```
protected volatile String displayName
```
    The name of the entity appearing above the head
  - nameVisible
```
protected volatile boolean nameVisible
```
    Whether or not the name of the entity is visible
  - silent
```
protected volatile boolean silent
```
    TODO
  - godMode
```
protected volatile boolean godMode
```
    true to indicate the entity cannot be damaged
  - boundingBox
```
protected volatile BoundingBox boundingBox
```
    TODO
  - width
```
protected volatile float width
```
    TODO
  - height
```
protected volatile float height
```
    TODO
- Constructor Detail
  - TridentEntity
```
public TridentEntity(UUID uniqueId,
                     Position spawnLocation)
```
    Creates a new entity
    
    Parameters:
    
    uniqueId - the UUID of the entity
    
    spawnLocation - the location which the entity is to be spawned
  - TridentEntity
```
@Deprecated
protected TridentEntity()
```
    Deprecated.
- Method Detail
  - doTick
```
protected void doTick()
```
  - doRemove
```
protected void doRemove()
```
  - doEncodeMeta
```
protected void doEncodeMeta(ProtocolMetadata protocolMeta)
```
  - doLoad
```
protected void doLoad(CompoundTag tag)
```
  - spawn
```
public TridentEntity spawn()
```
    Begin entity management
    
    Returns:
    
    the current entity
  - encodeMetadata
```
protected void encodeMetadata(ProtocolMetadata protocolMeta)
```
  - teleport
```
public void teleport(double x,
                     double y,
                     double z)
```
    Description copied from interface: Entity
    
    Moves the entity to the specified position
    
    Specified by:
    
    teleport in interface Entity
    
    Parameters:
    
    x - the x coordinate of the position
    
    y - the y coordinate of the position
    
    z - the z coordinate of the position
  - teleport
```
public void teleport(Entity entity)
```
    Description copied from interface: Entity
    
    Moves the current entity to the provided entity's position
    
    Specified by:
    
    teleport in interface Entity
    
    Parameters:
    
    entity - the entity to move the current entity to
  - teleport
```
public void teleport(Position location)
```
    Description copied from interface: Entity
    
    Moves the entity to the coordinates specified by the position object passed in
    
    Specified by:
    
    teleport in interface Entity
    
    Parameters:
    
    location - the position to move the entity to
  - world
```
public World world()
```
    Description copied from interface: Entity
    
    The world which the entity resides in
    
    Specified by:
    
    world in interface Entity
    
    Returns:
    
    the world that contains the entity
  - position
```
public Position position()
```
    Description copied from interface: Entity
    
    The position of the entity with respect to the coordinate grid
    
    Specified by:
    
    position in interface Entity
    
    Returns:
    
    the entity's position
  - setPosition
```
public void setPosition(Position loc)
```
  - velocity
```
public Vector velocity()
```
    Description copied from interface: Entity
    
    The direction and movement magnitude of the entity
    
    Specified by:
    
    velocity in interface Entity
    
    Returns:
    
    the vector representing the entity's velocity
  - setVelocity
```
public void setVelocity(Vector vector)
```
    Description copied from interface: Entity
    
    Sets the entity's movement direction and speed to the magnitude of the vector
    
    Specified by:
    
    setVelocity in interface Entity
    
    Parameters:
    
    vector - the vector to set the entity velocity to
  - displayName
```
public String displayName()
```
    Description copied from interface: Entity
    
    Gets the display name for the entity, used on inventories and deaths
    
    Specified by:
    
    displayName in interface Entity
    
    Returns:
    
    Display name
  - setDisplayName
```
public void setDisplayName(String name)
```
    Description copied from interface: Entity
    
    Sets the entity's display name, effects inventories (if applicable) and death messages
    
    Specified by:
    
    setDisplayName in interface Entity
    
    Parameters:
    
    name - Entity name
  - isSilent
```
public boolean isSilent()
```
    Description copied from interface: Entity
    
    Gets if the entity is silent (sounds)
    
    Specified by:
    
    isSilent in interface Entity
    
    Returns:
    
    if the entity is silent
  - uniqueId
```
public UUID uniqueId()
```
    Description copied from interface: Entity
    
    The unique id for the entity to the server
    
    Specified by:
    
    uniqueId in interface Entity
    
    Returns:
    
    The unique id for the entity
  - tick
```
public void tick()
```
  - onGround
```
public boolean onGround()
```
    Description copied from interface: Entity
    
    Checks if the entity is currently on the ground, or at least touching the ground
    
    Specified by:
    
    onGround in interface Entity
    
    Returns:
    
    true if the entity touches the ground, false if it is in the air (such as if it was falling)
  - setOnGround
```
public void setOnGround(boolean onGround)
```
  - withinRange
```
public Set<Entity> withinRange(double radius)
```
    Description copied from interface: Entity
    
    Gets the entities that are within proximity to this entity
    
    Specified by:
    
    withinRange in interface Entity
    
    Parameters:
    
    radius - the spherical radius to look for entities around
    
    Returns:
    
    the collection of entities within the radius around the entity
  - entityId
```
public int entityId()
```
    Description copied from interface: Entity
    
    The identifier for this entity for runtime, see uniqueId for a set id of the entity
    
    Specified by:
    
    entityId in interface Entity
    
    Returns:
    
    the id to all entities on the server at runtime
    
    See Also:
    
    Entity.uniqueId()
  - remove
```
public void remove()
```
    Description copied from interface: Entity
    
    Removes the entity from the world and destroys it, freeing all memory associated with it
    
    Specified by:
    
    remove in interface Entity
  - passenger
```
public Entity passenger()
```
    Description copied from interface: Entity
    
    Gets the entity that is riding this entity, if there is any
    
    Specified by:
    
    passenger in interface Entity
    
    Returns:
    
    the entity that is riding, null if there are none
  - setPassenger
```
public void setPassenger(Entity entity)
```
    Description copied from interface: Entity
    
    Mounts the specified entity on this entity
    
    Specified by:
    
    setPassenger in interface Entity
    
    Parameters:
    
    entity - the entity to set passenger to this entity
  - eject
```
public void eject()
```
    Description copied from interface: Entity
    
    Removes the mounted entity, if there are any
    
    Specified by:
    
    eject in interface Entity
  - type
```
public EntityType type()
```
    Description copied from interface: Entity
    
    Gets the type of entity
    
    Specified by:
    
    type in interface Entity
    
    Returns:
    
    the entity type that is represented
  - isNameVisible
```
public boolean isNameVisible()
```
    Description copied from interface: Entity
    
    Gets if the entity's display name visible
    
    Specified by:
    
    isNameVisible in interface Entity
    
    Returns:
    
    if the entity's display name visible
  - applyProperties
```
public void applyProperties(EntityProperties properties)
```
    Description copied from interface: Entity
    
    Sets the properties of this entity to the specified properties
    
    Specified by:
    
    applyProperties in interface Entity
    
    Parameters:
    
    properties - the properties to set
  - load
```
public void load(CompoundTag tag)
```
  - asNbt
```
public CompoundTag asNbt()
```
  - setSize
```
public void setSize(float width,
                    float height)
```
    Description copied from interface: Entity
    
    Set the width and height of the entity
    
    Specified by:
    
    setSize in interface Entity
    
    Parameters:
    
    width - Width of entity
    
    height - Height of entity
  - boundingBox
```
public BoundingBox boundingBox()
```
    Description copied from interface: Entity
    
    Returns the bounding box of the entity
    
    Specified by:
    
    boundingBox in interface Entity
    
    Returns:
    
    The bounding box of the entity

Class TridentEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

counter

HANDLER

fallDistance

ticksExisted

fireTicks

airTicks

portalCooldown

id

uniqueId

executor

velocity

loc

onGround

passenger

displayName

nameVisible

silent

godMode

boundingBox

width

height

Constructor Detail

TridentEntity

TridentEntity

Method Detail

doTick

doRemove

doEncodeMeta

doLoad

spawn

encodeMetadata

teleport

teleport

teleport

world

position

setPosition

velocity

setVelocity

displayName

setDisplayName

isSilent

uniqueId

tick

onGround

setOnGround

withinRange

entityId

remove

passenger

setPassenger

eject

type

isNameVisible

applyProperties

load

asNbt

setSize

boundingBox