NarraLeaf
NarraLeaf DesktopRenderer

Renderer

渲染器运行时、应用 hooks、存档 API、主进程事件和文件路由

Renderer 模块是 NarraLeaf 桌面应用的 React 侧。它挂载生成的应用入口,提供应用壳,嵌入 NarraLeaf-React Player,并暴露用于存档、播放状态和 renderer-to-main 通信的 hooks

import {
    render,
    useApp,
    useGamePlayback,
    useSaveAction,
    invokeMainEvent,
} from "narraleaf/renderer";

指南

公共导出

  • render
  • useApp
  • useAppState
  • useGamePlayback
  • useCurrentSaved
  • useCurrentSavedRef
  • useSaveAction
  • useSavedGames
  • readGame
  • requestMain
  • invokeMainEvent
  • SaveType

渲染入口还导出 RendererAppRendererAppRootPropsGameMetadata、路由模块类型、存档结果类型、MainProcessEventMapMainProcessEventEntry 等公共类型

与 NarraLeaf-React 的关系

NarraLeaf 使用 NarraLeaf-React 播放故事。故事、场景、角色、菜单和 displayables 请使用 NarraLeaf-React 创建,然后通过 NarraLeaf 渲染应用的 metadata.story 导出

本页目录