GameEntity

Every thing (character, player, object, etc) in the game should extend this class. This class has a number of empty methods that are designed to be overridden in subclasses. For example, override onInput() to handle input event, and onUpdate() to handle updating each frame

Properties

name (string) — Constant - name of this Entity
id (dynamic) — Constant - Unique Id
game (Game)
enabled (boolean) — Is this GameEntity enabled
persistent (boolean) — Does this entity persist across room changes?
pauseable (boolean) — When the game is paused, does this entity pause too?
position (dynamic) — position of where this entity is in game world
velocity (dynamic) — Speed of this entity, in units/second (not units/frame) - added to position each frame scaled by elapsed time
rotation (dynamic) — Rotation of entity - applies to all images
scale (dynamic) — Scale of entity - applies to all images
colliders (roAssociativeArray) — The colliders for this entity by name
drawables (dynamic) — The array of drawables to draw for this entity
drawablesByName (roAssociativeArray) — Associative array of drawables by name
tagsList (dynamic) — Game Entities can be tagged with any number of tags so they can be easily identified (e.g. "enemy", "wall", etc.)
transformationMatrix (dynamic) — The Current Transformation Matrix
motionChecker (MotionChecker)

Constructor

new GameEntity(
game: Game,
gameEngine: Game,
args?: roAssociativeArray,
): GameEntity

Creates a new GameEntity

Parameters

game (Game) — The game engine that this entity is going to be assigned to
gameEngine (Game)
args (roAssociativeArray, optional, default: "{}") — Any extra properties to be added to this entity

Instance Methods

`isValid(): boolean`

Is this still a valid entity?

Returns

boolean

`invalidate(): void`

Marks this entity as invalid, so it will be cleared/destroyed at the end of the frame

Returns

void

`onCreate(args: roAssociativeArray): void`

Method to be called when this entity is added to a Game. Override in subclass

Parameters

args (roAssociativeArray)

Returns

void

`onUpdate(deltaTime: float): void`

Method for handling any updates based on time since previous frame

Parameters

deltaTime (float) — milliseconds since last frame

Returns

void

`onCollision( myCollider: Collider, otherCollider: Collider, otherEntity: GameEntity, ): void`

Method for processing all collisions

Parameters

myCollider (Collider) — the collider of this entity that collided
otherCollider (Collider) — the collider of the other entity in the collision
otherEntity (GameEntity) — the entity that owns the other collider

Returns

void

`onDrawBegin( Renderer: renderer, gameRenderer: Renderer, uiRenderer: Renderer, ): void`

Method called each frame before drawing any images of this entity

Parameters

Renderer (renderer) — the Renderer images will be drawn to
gameRenderer (Renderer)
uiRenderer (Renderer)

Returns

void

`onDrawEnd( canvas: Renderer, gameRenderer: Renderer, uiRenderer: Renderer, ): void`

Method called each frame after drawing all images of this entity

Parameters

canvas (Renderer) — the Renderer images were drawn to
gameRenderer (Renderer)
uiRenderer (Renderer)

Returns

void

`onInput(input: GameInput): void`

Method to process input per frame

Parameters

input (GameInput) — GameInput object for the last frame

Returns

void

`onECPKeyboard(char: integer): void`

Method to process an ECP keyboard event

Parameters

char (integer)

Returns

void

See:
- https://developer.roku.com/en-ca/docs/developer-program/debugging/external-control-api.md

`onECPInput(data: roInputEvent): void`

Method to process an External Control Protocol event

Parameters

data (roInputEvent)

Returns

void

See:
- https://developer.roku.com/en-ca/docs/references/brightscript/events/roinputevent.md

`onAudioEvent(msg: roAudioPlayerEvent): void`

Method to handle audio events

Parameters

msg (roAudioPlayerEvent) — roAudioPlayerEvent

Returns

void

See:
- https://developer.roku.com/en-ca/docs/references/brightscript/events/roaudioplayerevent.md

`onPause(): void`

Called when the game pauses

Returns

void

`onResume(pauseTimeMs: integer): void`

Called when the game unpauses

Parameters

pauseTimeMs (integer) — The number of milliseconds the game was paused

Returns

void

`onUrlEvent(msg: roUrlEvent): void`

Called on url event

Parameters

msg (roUrlEvent) — roUrlEvent

Returns

void

See:
- https://developer.roku.com/en-ca/docs/references/brightscript/events/rourlevent.md

`onGameEvent(eventName: string, data: roAssociativeArray): void`

General purpose event handler for in-game events.

Parameters

eventName (string) — Event name that describes the event type
data (roAssociativeArray) — Any extra data to go along with the event

Returns

void

`onChangeRoom(newRoom: Room): void`

Method called when the current room changes. This method is only called when the entity is marked as persistant, otherwise entities are destroyed on room changes.

Parameters

newRoom (Room) — The next room

Returns

void

`onDestroy(): void`

Method called when this entity is destroyed

Returns

void

`addCircleCollider( colliderName: string, radius: float, offset_x?: float, offset_y?: float, enabled?: boolean, ): CircleCollider`

Adds a circle collider to this entity

Parameters

colliderName (string) — Name of the collider (only one collider with the same name can be added)
radius (float) — radius of the circle
offset_x (float, optional, default: 0) — horizontal offset from entity position of centre of the circle
offset_y (float, optional, default: 0) — vertical offset from entity position of centre of the circle
enabled (boolean, optional, default: true) — is this collider enabled?

Returns

CircleCollider

`addRectangleCollider( colliderName: string, width: float, height: float, offset_x?: float, offset_y?: float, enabled?: boolean, ): RectangleCollider`

Adds a rectangle collider to this entity

Parameters

colliderName (string) — Name of the collider (only one collider with the same name can be added)
width (float) — Width of rectangle
height (float) — Height of rectangle
offset_x (float, optional, default: 0) — horizontal offset from entity position of left edge of rectangle
offset_y (float, optional, default: 0) — vertical offset from entity position of bottom edge of rectangle (top edge is at offset_y - height)
enabled (boolean, optional, default: true) — is this collider enabled?

Returns

RectangleCollider

`addCollider(colliderToAdd: Collider): Collider`

Adds a collider that has already been constructed

Parameters

colliderToAdd (Collider) — the collider to add (only one collider with the same name can be added)

Returns

Collider

`getCollider(colliderName: string): Collider`

Gets a collider based on its name

Parameters

colliderName (string) — The name of the collider to find

Returns

Collider

`removeCollider(colliderName: string): void`

Removes a collider by its name

Parameters

colliderName (string) — the name of the collider to remove

Returns

void

`clearAllColliders(): void`

Remove all colliders from this entity

Returns

void

`addImage( regionName?: string, imageName: string, region: roRegion, args?: roAssociativeArray, insertPosition?: integer, ): Image`

Adds a basic image (non-animated) to be drawn for this entity

Parameters

regionName (string, optional, default: "\"\"") — an optional unique name for the region, used for caching image data
imageName (string) — Name of the image
region (roRegion) — an roRegion of a bitmap to draw
args (roAssociativeArray, optional, default: "{}") — any extra properties to set (e.g. offset_x, offset_y, rotation, scale_x, scale_y, etc.)
insertPosition (integer, optional, default: -1) — the position/order in the images array where the image should be added (defaults to being added at the end)

Returns

Image

`addAnimatedImage( imageName: string, regions: Array.<roRegion>, args?: roAssociativeArray, insertPosition?: integer, ): AnimatedImage`

Adds a animated image to be drawn for this entity. Animated images cycle through regions of a bitmap (e.g. spritesheet)

Parameters

imageName (string) — Name of the image
regions (Array.<roRegion>) — an array of roRegion of a bitmap to draw
args (roAssociativeArray, optional, default: "{}") — any extra properties to set (e.g. offset_x, offset_y, rotation, scale_x, scale_y, etc.)
insertPosition (integer, optional, default: -1) — the position/order in the images array where the image should be added (defaults to being added at the end)

Returns

AnimatedImage

`addSprite( bitmap: roBitmap, imageName: string, spriteSheet: roBitmap, cellWidth: integer, cellHeight: integer, args?: roAssociativeArray, insertPosition?: integer, ): Sprite`

Adds a Sprite to be drawn for this entity. Sprites can have specific animations configured buy choosing series of cells from a sprite sheet

Parameters

bitmap (roBitmap) — the bitmap object to use for teh SpriteSheet (e.g response from game.getBitmap("bitmap_name"))
imageName (string) — Name of the image
spriteSheet (roBitmap)
cellWidth (integer) — the height in pixels of a dingle cell in the sprite
cellHeight (integer) — the height in pixels of a dingle cell in the sprite
args (roAssociativeArray, optional, default: "{}") — any extra properties to set (e.g. offset_x, offset_y, rotation, scale_x, scale_y, etc.)
insertPosition (integer, optional, default: -1) — the position/order in the images array where the image should be added (defaults to being added at the end)

Returns

Sprite

`addRectangle( rectangleName: string, width: float, height: float, args?: roAssociativeArray, insertPosition?: integer, ): DrawableRectangle`

Adds a rectangle to be drawn for this entity. The rectangle's top left corner sits at the entity's position (plus the drawable's own offset), and it extends width to the right and height downwards in world space.

Parameters

rectangleName (string) — Name of the rectangle
width (float) — width of the rectangle in world units
height (float) — height of the rectangle in world units
args (roAssociativeArray, optional, default: "{}") — any extra properties to set (e.g. color, outlineRGBA, outlineWidth, filled, offset, rotation, scale, drawMode)
insertPosition (integer, optional, default: -1) — the position/order in the drawables array where the rectangle should be added (defaults to being added at the end)

Returns

DrawableRectangle

`addDrawable( imageName: string, drawableObject: Drawable, insertPosition?: integer, ): Drawable`

Adds any Drawable/Image object to this entity

Parameters

imageName (string) — Name of the image
drawableObject (Drawable) — The image to be added
insertPosition (integer, optional, default: -1) — the position/order in the images array where the image should be added (defaults to being added at the end)

Returns

Drawable

`getDrawable(imageName: string, drawableName: string): Drawable`

Gets a drawable by its name from the lookup table

Parameters

imageName (string) — Name of drawable to get
drawableName (string)

Returns

Drawable

`removeDrawable(drawableName: string): void`

Removes a drawable from the entity

Parameters

drawableName (string) — Name of drawable to remove

Returns

void

`updateTransformationMatrix(): void`

Returns

void

`movedLastFrame(): boolean`

Returns

boolean

`getStaticVariable(staticVariableName: string): dynamic`

TODO: work on statics

Parameters

staticVariableName (string)

Returns

dynamic

`setStaticVariable( staticVariableName: string, staticVariableValue: dynamic, ): void`

TODO: work on statics

Parameters

staticVariableName (string)
staticVariableValue (dynamic)

Returns

void

`addInterface(interfaceName: string): void`

TODO: work on Interfaces

Parameters

interfaceName (string)

Returns

void

`hasInterface(interfaceName: string): boolean`

TODO: work on Interfaces

Parameters

interfaceName (string)

Returns

boolean

`debugDraw( renderObj: Renderer, drawAxes?: boolean, drawName?: boolean, ): void`

Draws the entity's axes and/or its name

Parameters

renderObj (Renderer)
drawAxes (boolean, optional, default: false)
drawName (boolean, optional, default: false)

Returns

void