Interface Engine<GameEvents, Action, Sequence>

ReadonlyFPS

ReadonlykeyboardHandler

Readonlypaused

Readonlyrunning

ReadonlyTPS

emit

• emit(
      event: RemoveIndexSignature<
          {
              [Key in string
              | number
              | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
          },
          string,
      >[keyof RemoveIndexSignature<
          {
              [Key in string
              | number
              | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
          },
          string,
      >],
  ): this

  Emits a new event through the engine

  Parameters

  • event: RemoveIndexSignature<
        {
            [Key in string
            | number
            | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
        },
        string,
    >[keyof RemoveIndexSignature<
        {
            [Key in string
            | number
            | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
        },
        string,
    >]

  Returns this

off

• off<
      Events extends
          RemoveIndexSignature<
              {
                  [Key in string
                  | number
                  | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
              },
              string,
          >,
      const Type extends string
      | number
      | symbol,
  >(
      type: Type,
      handler: (event: Events[Type]) => void,
  ): this

  Remove an event listener from the engine

  Type Parameters

  • Events extends RemoveIndexSignature<
        {
            [Key in string
            | number
            | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
        },
        string,
    >
  • const Type extends string | number | symbol

  Parameters

  • type: Type
  • handler: (event: Events[Type]) => void

  Returns this

on

• on<
      Events extends
          RemoveIndexSignature<
              {
                  [Key in string
                  | number
                  | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
              },
              string,
          >,
      const Type extends string
      | number
      | symbol,
  >(
      type: Type,
      handler: (event: Events[Type]) => void,
  ): this

  Add a new event listener to the engine

  Type Parameters

  • Events extends RemoveIndexSignature<
        {
            [Key in string
            | number
            | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
        },
        string,
    >
  • const Type extends string | number | symbol

  Parameters

  • type: Type
  • handler: (event: Events[Type]) => void

  Returns this

once

• once<
      Events extends
          RemoveIndexSignature<
              {
                  [Key in string
                  | number
                  | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
              },
              string,
          >,
      const Type extends string
      | number
      | symbol,
  >(
      type: Type,
      handler: (event: Events[Type]) => void,
  ): this

  Add a new event listener to the engine that only executes once

  Type Parameters

  • Events extends RemoveIndexSignature<
        {
            [Key in string
            | number
            | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
        },
        string,
    >
  • const Type extends string | number | symbol

  Parameters

  • type: Type
  • handler: (event: Events[Type]) => void

  Returns this

pause

• pause(): this

  Pause or unpause the engine

  Returns this

set

• set<
      Events extends
          RemoveIndexSignature<
              {
                  [Key in string
                  | number
                  | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
              },
              string,
          >,
  >(
      handlers: Partial<
          {
              [Key in string
              | number
              | symbol]: (event: Events[Key]) => void | Promise<void>
          },
      >,
  ): this

  Set multiple event listeners to the engine at once through a single object

  Type Parameters

  • Events extends RemoveIndexSignature<
        {
            [Key in string
            | number
            | symbol]: (GameEvents & EngineEvents & InputEvents<Action, Sequence>)[Key]
        },
        string,
    >

  Parameters

  • handlers: Partial<
        {
            [Key in string
            | number
            | symbol]: (event: Events[Key]) => void | Promise<void>
        },
    >

  Returns this

start

• start(): this

  Start the engine (if it is not running)

  Returns this

stop

• stop(): this

  Stop the engine (if it is running)

  Returns this