Class KeyManager

constructor

• new KeyManager(config?): KeyManager

• Creates a new key manager.

  Parameters

  • Optionalconfig: KeyManagerConfig

    The configuration for the key manager.

  Returns KeyManager

addKeys

Readonlybinds

addKey

• addKey(id, key, fn?): void

• Adds or updates a key binding.

  Parameters

  • id: string

    The id of the key binding.
  • key: string

    The key associated with the binding.
  • Optionalfn: ((dt: number) => void)

    The function executed when the binding is pressed

    • • (dt): void

      • Parameters

        • dt: number

        Returns void

  Returns void

  Deprecated

  Use the other overload instead, as it is more flexible.

  Example

  addKey("Move Up", "w", () => player.velocity.y += player.acceleration.y);
  Copy

• addKey(keysToAdd): void

• Adds or updates multiple key bindings.

  Parameters

  • keysToAdd: KeyBinding | KeyBinding[]

    An array of key binding objects.

  Returns void

  Example

  const moveUpKeyBinding: KeyBinding = { name: "Move Up", key: "w", onDownContinuous: () => player.velocity.y += player.acceleration.y };
  // Use either of the following:
  addKey(moveUpKeyBinding);
  // or
  addKeys([
      moveUpKeyBinding,
      // Add more key bindings here...
  ]);
  Copy

changeFps

• changeFps(fps): void

• Changes the framerate of the key manager.

  Parameters

  • fps: number

    The new framerate to use.

  Returns void