Interface EngineConfig<GameEvents, Action, Sequence>

Information for the engine to utilize

interface EngineConfig<
    GameEvents extends EventsMap = NonNullable<unknown>,
    Action = string,
    Sequence = string,
> {
    actions?: Action[] | readonly Action[];
    events?: GameEvents;
    sequences?: Sequence[] | readonly Sequence[];
    TPS: number;
    render(delta?: number): void;
    update(delta?: number): void;
}

Type Parameters

GameEvents extends EventsMap = NonNullable<unknown>
Action = string
Sequence = string

Index

Properties

actions? events? sequences? TPS

Methods

Properties

`Optional`actions

actions?: Action[] | readonly Action[]

TODO: JSDocs

`Optional`events

events?: GameEvents

TODO: JSDocs

`Optional`sequences

sequences?: Sequence[] | readonly Sequence[]

TODO: JSDocs

TPS

TPS: number

Target ticks per second for logic updates

Methods

render

render(delta?: number): void
Rendering function for the engine to execute
Parameters
- Optionaldelta: number
  Fraction of a full game tick that occurred before this frame
Returns void

update

update(delta?: number): void
Logic updating function for the engine to execute
Parameters
- Optionaldelta: number
  The portion of a second elapsed representing one tick of the engine. Equal to 1_000 / TPS
Returns void