Class Entity

Base class for game entities with transform and rendering capabilities.

Hierarchy (View Summary)

Entity

Index

Constructors

Properties

children game globalZindex localZindex parent position rapid rotation scale tags transform

Accessors

x y

Methods

addChild dispose findDescendant findDescendantByTag getParentTransform onRender onUpdate postDispose removeChild update updateTransform

Constructors

constructor

new Entity(game: Game, options?: IEntityTransformOptions): Entity
Creates an entity with optional transform properties.
Parameters
- game: Game
  The game instance this entity belongs to.
- options: IEntityTransformOptions = {}
  Configuration options for position, scale, rotation, and tags.
Returns Entity
- Defined in game.ts:51

Properties

`Readonly`children

children: Entity[] = []

`Protected`game

game: Game

globalZindex

globalZindex: number = 0

localZindex

localZindex: number = 0

parent

parent: null | Entity = null

position

position: Vec2

`Protected`rapid

rapid: Rapid

rotation

rotation: number

scale

scale: Vec2

tags

tags: string[]

transform

transform: MatrixStack = ...

Accessors

x

get x(): number
Returns number
- Defined in game.ts:30
set x(nx: number): void
Parameters
- nx: number
Returns void
- Defined in game.ts:38

y

get y(): number
Returns number
- Defined in game.ts:34
set y(ny: number): void
Parameters
- ny: number
Returns void
- Defined in game.ts:42

Methods

addChild

addChild(child: Entity): void
Adds a child entity to this entity.
Parameters
- child: Entity
  The entity to add as a child.
Returns void
- Defined in game.ts:152

dispose

dispose(): void
Disposes of the entity and its children.

Returns void
- Defined in game.ts:216

findDescendant

findDescendant(
predicate: (entity: Entity) => boolean,
onlyFirst?: boolean,
): null | Entity | Entity[]
Finds descendant entities matching a predicate.
Parameters
- predicate: (entity: Entity) => boolean
  Function to test each entity.
- onlyFirst: boolean = true
  If true, returns only the first match; otherwise, returns all matches.
Returns null | Entity | Entity[]
A single entity, an array of entities, or null if no matches are found.
- Defined in game.ts:178

findDescendantByTag

findDescendantByTag(
tags: string[],
onlyFirst?: boolean,
): null | Entity | Entity[]
Finds descendant entities with all specified tags.
Parameters
- tags: string[]
  Array of tags to match.
- onlyFirst: boolean = false
  If true, returns only the first match; otherwise, returns all matches.
Returns null | Entity | Entity[]
A single entity, an array of entities, or null if no matches are found.
- Defined in game.ts:205

getParentTransform

getParentTransform(): MatrixStack
Gets the parent transform or the renderer's matrix stack if no parent exists.

Returns MatrixStack
The transform matrix stack.
- Defined in game.ts:81

onRender

onRender(render: Rapid): void
Hook for custom rendering logic.
Parameters
- render: Rapid
  The rendering engine instance.
Returns void
- Defined in game.ts:129

`Protected`onUpdate

onUpdate(deltaTime: number): void
Hook for custom update logic.
Parameters
- deltaTime: number
  Time elapsed since the last update in seconds.
Returns void
- Defined in game.ts:100

`Protected`postDispose

postDispose(): void
Hook for custom cleanup logic before disposal.

Returns void
- Defined in game.ts:226

removeChild

removeChild(child: Entity): void
Removes a child entity from this entity.
Parameters
- child: Entity
  The entity to remove.
Returns void
- Defined in game.ts:164

update

update(deltaTime: number): void
Updates the entity and its children.
Parameters
- deltaTime: number
  Time elapsed since the last update in seconds.
Returns void
- Defined in game.ts:89

updateTransform

updateTransform(deep?: boolean): void
Updates the entity's transform, optionally updating parent transforms.
Parameters
- deep: boolean = false
  If true, recursively updates parent transforms.
Returns void
- Defined in game.ts:135