Class Entity<T, TUpdateArgs>`Abstract`

Abstract base class for a single gameplay entity.

Ownership/lifecycle:

Constructed with a backing sprite and immediately started via play.
The host calls update on each tick/frame.

Invariants:

update is safe to call repeatedly (typical: every frame).
The entity may mutate anim.

Type Parameters

T extends AnimatedSprite
TUpdateArgs extends unknown[] = unknown[]

Index

Constructors

Properties

anim gap hitBoxAdjust

Methods

Constructors

constructor

new Entity<T extends AnimatedSprite, TUpdateArgs extends unknown[] = unknown[]>(
anim: T,
): Entity<T, TUpdateArgs>
Type Parameters
- T extends AnimatedSprite
- TUpdateArgs extends unknown[] = unknown[]
Parameters
- anim: T
  Backing PIXI animated sprite for this entity. The entity may mutate this sprite.
Returns Entity<T, TUpdateArgs>
- Defined in frontend/ts/games/helpers/Entity.ts:34

Properties

anim

anim: T

Backing PIXI animated sprite for this entity. The entity may mutate this sprite.

`Static`gap

gap: number = 10

Default spacing hint in pixels used for layout/collision heuristics.

`Static`hitBoxAdjust

hitBoxAdjust: number = .8

Hitbox scale factor (dimensionless), typically in $[0, 1]$.

Methods

play

play(anim: T): void
Starts playback of the provided animation sprite.

Side effects: sets animationSpeed and calls play().
Parameters
- anim: T
Returns void
- Defined in frontend/ts/games/helpers/Entity.ts:59

`Abstract`update

update(...args: TUpdateArgs): void
Advances this entity by one tick/frame.

Call order/cadence: owned by the host (typically once per render tick).
Parameters
- ...args: TUpdateArgs
  Implementation-defined update context (e.g. delta time, input snapshot). The base contract does not prescribe units.
Returns void
- Defined in frontend/ts/games/helpers/Entity.ts:46