class Entity

read only bottom : Float

The bottommost position of the Entity's hitbox.

camera : Null<Camera>

read only centerX : Float

The center x position of the Entity's hitbox.

read only centerY : Float

The center y position of the Entity's hitbox.

collidable : Bool

If the Entity should respond to collision checks.

enabled : Bool

followCamera : Null<Camera>

Set to the camera the entity should follow. If null it won't follow any camera.

graphic : Graphic

Graphical component to render to the screen.

read only halfHeight : Float

Half the Entity's height.

read only halfWidth : Float

Half the Entity's width.

height : Int

Height of the Entity's hitbox.

layer : Int

The rendering layer of this Entity. Layers are drawn in descending order. Backgrounds will have large (positive) numbers, foregrounds will have small (negative) numbers.

read only left : Float

The leftmost position of the Entity's hitbox.

localX : Float

Local X position. If this entity has a parent, this value is relative to the parent's position.

localY : Float

Local Y position. If this entity has a parent, this value is relative to the parent's position.

mask : Mask

An optional Mask component, used for specialized collision. If this is not assigned, collision checks will use the Entity's hitbox by default.

name : String

An optional name for the entity.

originX : Int

X origin of the Entity's hitbox.

originY : Int

Y origin of the Entity's hitbox.

parent : Null<Entity>

The entity's parent, if any. This entity's position will be offset by the parent's position.

postUpdate : Signal0

preUpdate : Signal0

read only right : Float

The rightmost position of the Entity's hitbox.

read only scene : Scene

The Scene object this Entity has been added to.

skipFrames : Int

If set, skip every N update frames.

read only top : Float

The topmost position of the Entity's hitbox.

type : String

The collision type, used for collision checking.

visible : Bool

If the Entity should render.

width : Int

Width of the Entity's hitbox.

x : Float

X position of the Entity in the Scene.

y : Float

Y position of the Entity in the Scene.

addGraphic (g : Graphic) : Graphic

Adds the graphic to the Entity via a Graphiclist.

added () : Void

Override this, called when the Entity is added to a Scene.

centerGraphicInRect () : Void

Center graphic inside bounding rect.

centerOrigin () : Void

Center's the Entity's origin (half width & height).

clampHorizontal (left : Float, right : Float, padding : Float = 0) : Void

Clamps the Entity's hitbox on the x-axis.

clampVertical (top : Float, bottom : Float, padding : Float = 0) : Void

Clamps the Entity's hitbox on the y axis.

collide (type : String, x : Float, y : Float) : Entity

Checks for a collision against an Entity type.

collideInto<E> (type : String, x : Float, y : Float, array : Array<E>) : Void

Populates an array with all collided Entities of a type. This function does not empty the array, that responsibility is left to the user.

collidePoint (x : Float, y : Float, pX : Float, pY : Float) : Bool

Checks if this Entity overlaps the specified position.

collideRect (x : Float, y : Float, rX : Float, rY : Float, rWidth : Float, rHeight : Float) : Bool

Checks if this Entity overlaps the specified rectangle.

collideTypes (types : SolidType, x : Float, y : Float) : Entity

Checks for collision against multiple Entity types.

collideTypesInto<E> (types : Array<String>, x : Float, y : Float, array : Array<E>) : Void

Populates an array with all collided Entities of multiple types. This function does not empty the array, that responsibility is left to the user.

collideWith<E> (e : E, x : Float, y : Float) : E

Checks if this Entity collides with a specific Entity.

debugDraw (camera : Camera, selected : Bool = false) : Void

distanceFrom (e : Entity, useHitboxes : Bool = false) : Float

Calculates the distance from another Entity.

distanceToPoint (px : Float, py : Float, useHitbox : Bool = false) : Float

Calculates the distance from this Entity to the point.

distanceToRect (rx : Float, ry : Float, rwidth : Float, rheight : Float) : Float

Calculates the distance from this Entity to the rectangle.

moveAtAngle (angle : Float, amount : Float, solidType : SolidType, sweep : Bool = false) : Void

Moves at an angle by a certain amount, retaining integer values for its x and y.

moveBy (x : Float, y : Float, solidType : SolidType, sweep : Bool = false) : Void

Moves the Entity by the amount, retaining integer values for its x and y.

moveCollideX (e : Entity) : Bool

When you collide with an Entity on the x-axis with moveTo() or moveBy() the engine call this function. Override it to detect and change the behaviour of collisions.

moveCollideY (e : Entity) : Bool

When you collide with an Entity on the y-axis with moveTo() or moveBy() the engine call this function. Override it to detect and change the behaviour of collisions.

moveTo (x : Float, y : Float, solidType : SolidType, sweep : Bool = false) : Void

Moves the Entity to the position, retaining integer values for its x and y.

moveTowards (x : Float, y : Float, amount : Float, solidType : SolidType, sweep : Bool = false) : Void

Moves towards the target position, retaining integer values for its x and y.

removed () : Void

Override this, called when the Entity is removed from a Scene.

render (camera : Camera) : Void

Renders the Entity. If you override this for special behaviour, remember to call super.render() to render the Entity's graphic.

resized () : Void

Override this, called when the Scene is resized.

setHitbox (width : Int = 0, height : Int = 0, originX : Int = 0, originY : Int = 0) : Void

Sets the Entity's hitbox properties.

setHitboxTo (o : Dynamic) : Void

Sets the Entity's hitbox to match that of the provided object.

setOrigin (x : Int = 0, y : Int = 0) : Void

Sets the origin of the Entity.

shouldUpdate () : Bool

toString () : String

Gets the class name as a string.

update () : Void

Updates the Entity.