java.lang.Object
- net.egartley.beyondorigins.core.abstracts.Renderable
- - net.egartley.beyondorigins.core.abstracts.Entity

All Implemented Interfaces:

Tickable

Direct Known Subclasses:

AnimatedEntity, StaticEntity
```
public abstract class Entity
extends Renderable
implements Tickable
```
Anything that is rendered with a Sprite at a specified location

See Also:

AnimatedEntity, StaticEntity

Field Summary

Fields
Modifier and Type	Field	Description
`java.util.ArrayList<EntityBoundary>`	`boundaries`	Collection of the entity's boundaries
`boolean`	`canCollide`	Whether or not the entity is "allowed" to collide with others
`private static org.newdawn.slick.Font`	`debugFont`
`EntityBoundary`	`defaultBoundary`	The boundary to use if not specified
`double`	`deltaX`	Less-than-one change in the x-coordinate, used for non-integer speeds
`double`	`deltaY`	Less-than-one change in the y-coordinate, used for non-integer speeds
`static byte`	`DIRECTION_DOWN`
`static byte`	`DIRECTION_LEFT`
`static byte`	`DIRECTION_RIGHT`
`static byte`	`DIRECTION_UP`
`protected org.newdawn.slick.Image`	`firstLayer`	If `isDualRendered` is true, render this before the player ("below")
`int`	`health`	Amount of damage the entity can take before dying
`private static org.newdawn.slick.Color`	`healthBarColor`
`private int`	`healthBarWidth`
`protected org.newdawn.slick.Image`	`image`	The buffered image to use when rendering (default)
`java.util.ArrayList<EntityEntityInteraction>`	`interactions`	Collection of the entity's interactions
`EntityInventory`	`inventory`
`boolean`	`isAllowedToMoveDownwards`	Whether or not the entity is allowed to move downwards
`boolean`	`isAllowedToMoveLeftwards`	Whether or not the entity is allowed to move leftwards
`boolean`	`isAllowedToMoveRightwards`	Whether or not the entity is allowed to move rightwards
`boolean`	`isAllowedToMoveUpwards`	Whether or not the entity is allowed to move upwards
`boolean`	`isAnimated`	Whether or not the entity is animated
`boolean`	`isCollided`	Whether or not the entity is currently collided with another entity
`boolean`	`isDualRendered`	Whether or not the entity has two different "layers" that are rendered before and after the player
`protected boolean`	`isMovingDownwards`	Whether or not the entity is currently moving downwards
`protected boolean`	`isMovingLeftwards`	Whether or not the entity is currently moving leftwards
`protected boolean`	`isMovingRightwards`	Whether or not the entity is currently moving rightwards
`protected boolean`	`isMovingUpwards`	Whether or not the entity is currently moving upwards
`boolean`	`isSectorSpecific`	Whether or not the entity is "bound" to, or only exists in, a specific map sector
`boolean`	`isTraversable`	Whether or not other entities, mainly the player, can walk over it or not
`EntityEntityCollision`	`lastCollision`	The most recent collision that has occurred for the entity.
`EntityEntityCollisionEvent`	`lastCollisionEvent`	The most recent collision event to have occurred.
`int`	`maximumHealth`	Maximum amount of health the entity can have
`java.lang.String`	`name`	Human-readable identifier for the entity (not unique)
`private static org.newdawn.slick.Color`	`nameTagBackgroundColor`
`private int`	`nameTagWidth`
`protected org.newdawn.slick.Image`	`secondLayer`	If `isDualRendered` is true, render this after the player ("above")
`private boolean`	`setFontMetrics`	Whether or not font metrics have been initialized.
`protected java.util.ArrayList<SpriteSheet>`	`sheets`	The entity's sprite sheets
`double`	`speed`	The entity's speed (magnitude of its location change when moving)
`Sprite`	`sprite`	The sprite to use while rendering
`protected java.util.ArrayList<Sprite>`	`sprites`	The entity's sprites
`int`	`uuid`	The entity's unique identification number.

Constructor Summary

Constructors
Constructor	Description
`Entity(java.lang.String name)`
`Entity(java.lang.String name, Sprite sprite)`
`Entity(java.lang.String name, SpriteSheet sheet)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`allowAllMovement()`	Allows the entity to move in all directions
`private void`	`drawBoundaries(org.newdawn.slick.Graphics graphics)`	Draws all of the entity's boundaries
`void`	`drawDebug(org.newdawn.slick.Graphics graphics)`	Renders debug information, such as the entity's boundaries and "name tag"
`void`	`drawFirstLayer(org.newdawn.slick.Graphics graphics)`	Draws the first "layer", assuming `isDualRendered` is true (below the player)
`private void`	`drawHealthBar(org.newdawn.slick.Graphics graphics)`	Shows the entity's health above them
`private void`	`drawNameTag(org.newdawn.slick.Graphics graphics)`	Draws the entity's "name tag", which is `toString()`
`void`	`drawSecondLayer(org.newdawn.slick.Graphics graphics)`	Draws the second "layer", assuming `isDualRendered` is true (above the player)
`private boolean`	`isAbove(Entity e)`	Returns whether or not the entity is "above" the other entity
`private boolean`	`isBelow(Entity e)`	Returns whether or not the entity is "below" the other entity
`private boolean`	`isLeftOf(Entity e)`	Returns whether or not the entity is to the "left" of the other entity
`private boolean`	`isRightOf(Entity e)`	Returns whether or not the entity is to the "right" of the other entity
`protected void`	`move(byte direction)`	Changes the entity's location (`Renderable.x()` and `Renderable.y()`) at a rate of `speed` per call.
`private void`	`move(byte direction, EntityBoundary boundary)`	Updates the entity's location by `speed`, unless the specified boundary is outside of the game's window
`protected void`	`onMove(byte direction)`	Called whenever the entity moves
`void`	`onSectorEnter(MapSector entering)`
`void`	`onSectorLeave(MapSector leaving)`
`private void`	`onSpriteChanged()`
`void`	`render(org.newdawn.slick.Graphics graphics)`	Renders the entity, using `image`, at (`Renderable.x()`, `Renderable.y()`)
`protected abstract void`	`setBoundaries()`	Sets the entity's boundaries
`abstract void`	`setCollisions()`	Sets the entity's collisions
`protected abstract void`	`setInteractions()`	Sets the entity's interactions
`void`	`setPosition(int x, int y)`	Sets the entity's x and y coordinates, as well as updating the coordinate deltas
`void`	`setSprite(int index, boolean update)`	Sets the current sprite
`void`	`setSprite(Sprite sprite)`
`void`	`setSprites(int index)`	Sets `sprites` to `SpriteSheet.sprites` from `sheets` at the given index
`void`	`tick()`	Ticks boundaries and interactions
`java.lang.String`	`toString()`
`void`	`x(int x)`
`void`	`x(int x, boolean setDelta)`
`void`	`y(int y)`
`void`	`y(int y, boolean setDelta)`

Methods inherited from class net.egartley.beyondorigins.core.abstracts.Renderable
x, y

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

- Field Detail
  - DIRECTION_UP
```
public static final byte DIRECTION_UP
```
    See Also:
    
    Constant Field Values
  - DIRECTION_DOWN
```
public static final byte DIRECTION_DOWN
```
    See Also:
    
    Constant Field Values
  - DIRECTION_LEFT
```
public static final byte DIRECTION_LEFT
```
    See Also:
    
    Constant Field Values
  - DIRECTION_RIGHT
```
public static final byte DIRECTION_RIGHT
```
    See Also:
    
    Constant Field Values
  - sprites
```
protected java.util.ArrayList<Sprite> sprites
```
    The entity's sprites
  - sheets
```
protected java.util.ArrayList<SpriteSheet> sheets
```
    The entity's sprite sheets
  - boundaries
```
public java.util.ArrayList<EntityBoundary> boundaries
```
    Collection of the entity's boundaries
  - interactions
```
public java.util.ArrayList<EntityEntityInteraction> interactions
```
    Collection of the entity's interactions
  - inventory
```
public EntityInventory inventory
```
  - sprite
```
public Sprite sprite
```
    The sprite to use while rendering
  - image
```
protected org.newdawn.slick.Image image
```
    The buffered image to use when rendering (default)
  - firstLayer
```
protected org.newdawn.slick.Image firstLayer
```
    If isDualRendered is true, render this before the player ("below")
  - secondLayer
```
protected org.newdawn.slick.Image secondLayer
```
    If isDualRendered is true, render this after the player ("above")
  - lastCollision
```
public EntityEntityCollision lastCollision
```
    The most recent collision that has occurred for the entity. If no collisions have occurred within the entity's lifetime, this will be null
  - lastCollisionEvent
```
public EntityEntityCollisionEvent lastCollisionEvent
```
    The most recent collision event to have occurred. This will be null if no collision event has yet to take place
  - defaultBoundary
```
public EntityBoundary defaultBoundary
```
    The boundary to use if not specified
  - deltaX
```
public double deltaX
```
    Less-than-one change in the x-coordinate, used for non-integer speeds
  - deltaY
```
public double deltaY
```
    Less-than-one change in the y-coordinate, used for non-integer speeds
  - speed
```
public double speed
```
    The entity's speed (magnitude of its location change when moving)
  - uuid
```
public int uuid
```
    The entity's unique identification number. Use name for user-friendly identification
  - health
```
public int health
```
    Amount of damage the entity can take before dying
  - maximumHealth
```
public int maximumHealth
```
    Maximum amount of health the entity can have
  - isAnimated
```
public boolean isAnimated
```
    Whether or not the entity is animated
  - isTraversable
```
public boolean isTraversable
```
    Whether or not other entities, mainly the player, can walk over it or not
  - isCollided
```
public boolean isCollided
```
    Whether or not the entity is currently collided with another entity
  - canCollide
```
public boolean canCollide
```
    Whether or not the entity is "allowed" to collide with others
  - isMovingUpwards
```
protected boolean isMovingUpwards
```
    Whether or not the entity is currently moving upwards
  - isMovingDownwards
```
protected boolean isMovingDownwards
```
    Whether or not the entity is currently moving downwards
  - isMovingLeftwards
```
protected boolean isMovingLeftwards
```
    Whether or not the entity is currently moving leftwards
  - isMovingRightwards
```
protected boolean isMovingRightwards
```
    Whether or not the entity is currently moving rightwards
  - isAllowedToMoveUpwards
```
public boolean isAllowedToMoveUpwards
```
    Whether or not the entity is allowed to move upwards
  - isAllowedToMoveDownwards
```
public boolean isAllowedToMoveDownwards
```
    Whether or not the entity is allowed to move downwards
  - isAllowedToMoveLeftwards
```
public boolean isAllowedToMoveLeftwards
```
    Whether or not the entity is allowed to move leftwards
  - isAllowedToMoveRightwards
```
public boolean isAllowedToMoveRightwards
```
    Whether or not the entity is allowed to move rightwards
  - isDualRendered
```
public boolean isDualRendered
```
    Whether or not the entity has two different "layers" that are rendered before and after the player
    
    See Also:
    
    drawFirstLayer(Graphics), drawSecondLayer(Graphics)
  - isSectorSpecific
```
public boolean isSectorSpecific
```
    Whether or not the entity is "bound" to, or only exists in, a specific map sector
  - name
```
public java.lang.String name
```
    Human-readable identifier for the entity (not unique)
  - debugFont
```
private static final org.newdawn.slick.Font debugFont
```
  - nameTagBackgroundColor
```
private static final org.newdawn.slick.Color nameTagBackgroundColor
```
  - healthBarColor
```
private static final org.newdawn.slick.Color healthBarColor
```
  - healthBarWidth
```
private final int healthBarWidth
```
    See Also:
    
    Constant Field Values
  - nameTagWidth
```
private int nameTagWidth
```
  - setFontMetrics
```
private boolean setFontMetrics
```
    Whether or not font metrics have been initialized. Since render(Graphics) is called about 60 times a second, and the resulting font metrics object will always be the same, there is no need to keep re-computing it each time render(Graphics) is called
- Constructor Detail
  - Entity
```
Entity(java.lang.String name)
```
  - Entity
```
Entity(java.lang.String name,
       Sprite sprite)
```
  - Entity
```
Entity(java.lang.String name,
       SpriteSheet sheet)
```
- Method Detail
  - render
```
public void render(org.newdawn.slick.Graphics graphics)
```
    Renders the entity, using image, at (Renderable.x(), Renderable.y())
    
    Specified by:
    
    render in class Renderable
  - drawFirstLayer
```
public void drawFirstLayer(org.newdawn.slick.Graphics graphics)
```
    Draws the first "layer", assuming isDualRendered is true (below the player)
  - drawSecondLayer
```
public void drawSecondLayer(org.newdawn.slick.Graphics graphics)
```
    Draws the second "layer", assuming isDualRendered is true (above the player)
  - drawDebug
```
public void drawDebug(org.newdawn.slick.Graphics graphics)
```
    Renders debug information, such as the entity's boundaries and "name tag"
  - drawNameTag
```
private void drawNameTag(org.newdawn.slick.Graphics graphics)
```
    Draws the entity's "name tag", which is toString()
  - drawHealthBar
```
private void drawHealthBar(org.newdawn.slick.Graphics graphics)
```
    Shows the entity's health above them
  - drawBoundaries
```
private void drawBoundaries(org.newdawn.slick.Graphics graphics)
```
    Draws all of the entity's boundaries
  - tick
```
public void tick()
```
    Ticks boundaries and interactions
    
    Specified by:
    
    tick in interface Tickable
    
    See Also:
    
    boundaries
  - setPosition
```
public void setPosition(int x,
                        int y)
```
    Sets the entity's x and y coordinates, as well as updating the coordinate deltas
    
    Overrides:
    
    setPosition in class Renderable
    
    Parameters:
    
    x - The new x-coordinate
    
    y - The new y-coordinate
    
    See Also:
    
    deltaX, deltaY
  - x
```
public void x(int x)
```
    Overrides:
    
    x in class Renderable
  - y
```
public void y(int y)
```
    Overrides:
    
    y in class Renderable
  - x
```
public void x(int x,
              boolean setDelta)
```
  - y
```
public void y(int y,
              boolean setDelta)
```
  - onSectorEnter
```
public void onSectorEnter(MapSector entering)
```
  - onSectorLeave
```
public void onSectorLeave(MapSector leaving)
```
  - move
```
private void move(byte direction,
                  EntityBoundary boundary)
```
    Updates the entity's location by speed, unless the specified boundary is outside of the game's window
  - allowAllMovement
```
protected void allowAllMovement()
```
    Allows the entity to move in all directions
    
    See Also:
    
    isAllowedToMoveUpwards, isAllowedToMoveDownwards, isAllowedToMoveLeftwards, isAllowedToMoveRightwards
  - onMove
```
protected void onMove(byte direction)
```
    Called whenever the entity moves
    
    Parameters:
    
    direction - Which direction the entity moved in
    
    See Also:
    
    DIRECTION_UP, DIRECTION_DOWN, DIRECTION_LEFT, DIRECTION_RIGHT, move(byte)
  - move
```
protected void move(byte direction)
```
    Changes the entity's location (Renderable.x() and Renderable.y()) at a rate of speed per call. Since there is no boundary parameter, the entity's defaultBoundary will be used
  - isRightOf
```
private boolean isRightOf(Entity e)
```
    Returns whether or not the entity is to the "right" of the other entity
  - isLeftOf
```
private boolean isLeftOf(Entity e)
```
    Returns whether or not the entity is to the "left" of the other entity
  - isAbove
```
private boolean isAbove(Entity e)
```
    Returns whether or not the entity is "above" the other entity
  - isBelow
```
private boolean isBelow(Entity e)
```
    Returns whether or not the entity is "below" the other entity
  - setBoundaries
```
protected abstract void setBoundaries()
```
    Sets the entity's boundaries
    
    See Also:
    
    boundaries
  - setCollisions
```
public abstract void setCollisions()
```
    Sets the entity's collisions
    
    See Also:
    
    boundaries
  - setInteractions
```
protected abstract void setInteractions()
```
    Sets the entity's interactions
    
    See Also:
    
    interactions
  - onSpriteChanged
```
private void onSpriteChanged()
```
  - setSprite
```
public void setSprite(int index,
                      boolean update)
```
    Sets the current sprite
    
    Parameters:
    
    index - The index in sprites
    
    See Also:
    
    sprite
  - setSprite
```
public void setSprite(Sprite sprite)
```
  - setSprites
```
public void setSprites(int index)
```
    Sets sprites to SpriteSheet.sprites from sheets at the given index
    
    Parameters:
    
    index - The index in sheets
    
    See Also:
    
    sheets, sprites
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Entity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.egartley.beyondorigins.core.abstracts.Renderable

Methods inherited from class java.lang.Object

Field Detail

DIRECTION_UP

DIRECTION_DOWN

DIRECTION_LEFT

DIRECTION_RIGHT

sprites

sheets

boundaries

interactions

inventory

sprite

image

firstLayer

secondLayer

lastCollision

lastCollisionEvent

defaultBoundary

deltaX

deltaY

speed

uuid

health

maximumHealth

isAnimated

isTraversable

isCollided

canCollide

isMovingUpwards

isMovingDownwards

isMovingLeftwards

isMovingRightwards

isAllowedToMoveUpwards

isAllowedToMoveDownwards

isAllowedToMoveLeftwards

isAllowedToMoveRightwards

isDualRendered

isSectorSpecific

name

debugFont

nameTagBackgroundColor

healthBarColor

healthBarWidth

nameTagWidth

setFontMetrics

Constructor Detail

Entity

Entity

Entity

Method Detail

render

drawFirstLayer

drawSecondLayer

drawDebug

drawNameTag

drawHealthBar

drawBoundaries

tick

setPosition

x

y

x

y

onSectorEnter

onSectorLeave

move

allowAllMovement

onMove

move

isRightOf

isLeftOf

isAbove

isBelow

setBoundaries

setCollisions