フック

初期化、画像プリロード、セーブ復元の各時点でカスタムロジックを差し込むためのゲームフック

このページは作成中です。

ベータ機能であり、変更される可能性があります。

フックは、ゲームにカスタムロジックを差し込むための仕組みです。プラグインの作成に役立ちます。

game.hooks.hook("init", () => {
    console.log("Game initialized");
});

公開メソッド

hook

ゲームにフックを追加します。

const token = game.hooks.hook("init", () => {
    console.log("Game initialized");
});

return function cleanup() {
    token.cancel();
}

key: Hooks - フックのキー。キーの一覧はフック一覧セクションを参照してください。
hook: (...value: T[K]) => VoidFunction | void - クリーンアップ関数を返すコールバック関数
返り値: LiveGameEventToken - 参照: LiveGameEventToken

unhook

ゲームからフックを取り除きます。

const listener = function () { /* ... */ };

game.hooks.hook("init", listener); // フックを追加する

game.hooks.unhook("init", listener); // フックを取り除く

key: Hooks - フックのキー。キーの一覧はフック一覧セクションを参照してください。
listener: (...value: T[K]) => VoidFunction | void - フックに追加されていたリスナー関数

フック一覧

init

このフックは、ゲームが初期化されたとき、かつプレイヤーが描画される前に呼び出されます。

game.hooks.hook("init", () => {
    console.log("let's do something cool here");
});

preloadImage

このフックは画像のプリロード時に呼び出されます。画像に対するプロキシロジックを作るのに便利です。

src: string - 画像のソース
set: (src: string, options?: RequestInit) => void - 画像のソースを設定する関数

game.hooks.hook("preloadImage", (src, set) => {
    const newSrc = `https://example.com/proxy?url=${src}`;
    set(newSrc, {
        credentials: "include",
    });
});

beforeRestore

このフックは、ゲームの状態をデシリアライズする前に呼び出されます。

game.hooks.hook("beforeRestore", () => {
    console.log("Preparing to restore game state");
});

afterRestore

このフックは、ゲームの状態をデシリアライズした後に呼び出されます。

game.hooks.hook("afterRestore", () => {
    console.log("Game state restored successfully");
});

このページの目次