Interface Game

Readonlyaudio

Readonlyplayer

call

• call<T = unknown>(method: string, params?: Record<string, unknown>): Promise<T>

  Calls a bridge method by name. The typed calls such as Player.position are built on it.

  Type Parameters

  • T = unknown

    The result type.

  Parameters

  • method: string

    For example "player.position".

  • Optionalparams: Record<string, unknown>

    The method's parameters, if any.

  Returns Promise<T>

  Example

  const info = await game.call<{ frame: number }>("game.info");
  Copy

on

• on<T = GameEvent>(name: string, handler: EventHandler<T>): Unsubscribe

  Subscribes to a game event.

  Events are named by the game class and method that raise them. Today the plugin sends "PlayerPuppet.OnGameAttached", at the main menu and on every save load. Events from any hooked game function arrive with phase P2.

  Type Parameters

  • T = GameEvent

    The event payload.

  Parameters

  • name: string

    Event name, for example "PlayerPuppet.OnGameAttached".

  • handler: EventHandler<T>

    Called for every occurrence. The game does not wait for it.

  Returns Unsubscribe

  A function that stops the subscription.

  Example

  const stop = game.on("PlayerPuppet.OnGameAttached", async () => {
    console.log("A save was loaded");
  });
  Copy

onState

• onState(handler: EventHandler<GameState>): Unsubscribe

  Calls a handler whenever the game state changes, and once at the start with the current state.

  Parameters

  • handler: EventHandler<GameState>

  Returns Unsubscribe

  Example

  game.onState((s) => console.log(s.menu ? "menu open" : "menu closed"));
  Copy

state

• state(): Promise<GameState>

  Reads what the game is showing: menus, photo mode, scenes, the main menu.

  Returns Promise<GameState>

  Example

  const s = await game.state();
  if (s.connected && !s.mainMenu) console.log("In a loaded save");
  Copy