NarraLeaf

useGame

GameProviders の内部にネストされたコンポーネント向けに、GameContextType インスタンスを返す useGame フック

このフックを使うと、game オブジェクトにアクセスできます。

注意:このフックは GameProvider の子孫にあたるコンポーネントの内部でのみ使用できます。

function useGame(): GameContextType;
  • GameContextType については GameContextType を参照してください。

使い方

import {useGame} from "narraleaf-react";
function myComponent() {
    const game = useGame();

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

このページの目次