@scml/sc2-verlnir

SugarCube 2 API 的 TypeScript 类型定义（基于 verlnir）。此包直接使用仓库中 src/ 的类型声明，无需 download 或 build。

安装

npm

yarn

pnpm

bun

deno

npm install -D @scml/sc2-verlnir

/// <reference types="@scml/sc2-verlnir" />

SugarCube 2 通过 declare global 将 API 暴露到全局，如 Story、Config、State、Passage 等。

主入口 ./src/global.d.ts 声明 SugarCube 2 的全局 API，通过 declare global 扩展。 global 以下为常见全局 API：

API	类型	说明
`Story`	`StoryAPI`	故事与段落访问
`Config`	`ConfigAPI`	引擎配置
`State`	`StateAPI`	游戏状态、历史、临时变量
`Passage`	`PassageConstructor`	当前段落
`Save`	`SaveAPI`	保存/加载
`Dialog`	`DialogAPI`	对话框系统
`Engine`	`EngineAPI`	引擎控制
`Macro`	`MacroAPI`	宏定义
`Scripting`	`ScriptingAPI`	脚本求值
`Template`	`TemplateAPI`	模板引擎
`UI` / `UIBar`	`UIAPI` / `UIBarAPI`	UI 组件
`version`	`VersionInfo`	版本信息
`session` / `storage`	`SimpleStoreInstanceAPI \| null`	会话与存储
`settings` / `setup`	`Record<string, unknown>`	设置与初始化
`window.SugarCube`	对象	包含上述所有 API，用于检测与调试

主入口

/// <reference types="@scml/sc2-verlnir" />

子路径	描述
`.`	主入口，SugarCube 2 全局类型

INFO