Documentation / @debuffjp/core / Plugin

Interface: Plugin

Defined in: plugin.ts:20

A runtime plugin extends a Game through its public API (hooks, params, inspect, scenes).

export function debugGrid(options: { size?: number } = {}): Plugin {
  return {
    name: "debug-grid",
    install(game) {
      const params = game.params.define("debug-grid", { size: { type: "number", default: options.size ?? 16, min: 4, max: 128 } });
      return game.hooks.afterRender((ctx) => drawGrid(ctx, params.values.size));
    },
  };
}

game.use(debugGrid());

Properties

name

readonly name: string

Defined in: plugin.ts:22

Unique kebab-case id. Also the conventional namespace for the plugin's params and inspect data.

Methods

install()

install(game): (() => void) | undefined

Defined in: plugin.ts:24

Called once by game.use(). Return a cleanup function to run on game.dispose().

Parameters

game

Game

Returns

(() => void) | undefined