プラグインシステム

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

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

プラグインシステムは、高い拡張性を目指して設計されたフレームワークにとって欠かせない構成要素です。プラグインは、開発者が特定のニーズに応じてフレームワークの機能を拡張できるように、ゲームロジックへの注入、変更、監視の能力を提供します。

さらに、プラグインシステムはコードの再利用も促進します。開発者はコミュニティが開発したツールを活用したり、さまざまなプロジェクト間で共有・統合できるカスタムスクリプトを作成したりできます。

プラグインを定義する

NarraLeaf-React では、プラグインは IGamePluginRegistry インターフェースを実装したオブジェクトとして定義されます。

interface IGamePluginRegistry {
    name: string;
    register(game: Game): void;
    unregister(game: Game): void;
}

name プロパティはプラグインを一意に識別します。
register メソッドはゲームの初期化時に呼び出されます。
unregister メソッドはゲームが破棄されるときに呼び出され、副作用を片付ける機会を与えます。

init イベントを監視するプラグインの例です。

import { Game, IGamePluginRegistry, LiveGameEventToken } from "narraleaf-react";

let listenerToken: LiveGameEventToken;

const plugin: IGamePluginRegistry = {
    name: "test_plugin",

    register: (game: Game) => {
        // このロジックはゲームが初期化されたとき、
        // かつプレイヤーコンポーネントが描画される前に実行される
        listenerToken = game.hooks.hook("init", () => {
            console.log("Game initialized");
        });
    },

    unregister: (game: Game) => {
        // このロジックはゲームが破棄されるとき、
        // かつプレイヤーコンポーネントがアンマウントされる前に実行される
        listenerToken.cancel();
    }
};

フックについての詳しい情報は、フックのドキュメントを参照してください。

プラグインを登録する

プラグインを登録するには、プラグインのレジストリを Game インスタンスへ渡す必要があります。やり方は次のとおりです。

import { useEffect } from "react";
import { Game, useGame } from "narraleaf-react";

function App() {
    // このフックはコンポーネント内で呼び出す
    const game = useGame();

    useEffect(() => {
        game.use(YOUR_PLUGIN_REGISTRY);
    }, [game]);

    return /* ... */;
}

組み込みプラグイン

このセクションは作成中です。

プラグインシステム

プラグインを定義する

プラグインを登録する

組み込みプラグイン

このページの目次