创建世界书

提示

请务必先阅读如何正确使用酒馆助手

点击查看对应类型定义文件 (可发给 AI 或 IDE 使用, 酒馆助手界面中提供了打包下载)

createWorldbook

创建新的世界书

createWorldbook

function createWorldbook(worldbook_name: string, worldbook?: WorldbookEntry[]): Promise<boolean>;

参数

worldbook_name

• 类型: string
• 描述: 世界书名称

worldbook

• 类型: WorldbookEntry[]
• 描述: 世界书内容; 不填则没有任何条目

返回值

• 是否成功创建: boolean - 如果已经存在同名世界书会失败

createOrReplaceWorldbook

创建或替换名为 worldbook_name 的世界书, 内容为 worldbook

function createOrReplaceWorldbook(
  worldbook_name: string,
  worldbook?: PartialDeep<WorldbookEntry>[],
  { render }?: ReplaceWorldbookOptions,
): Promise<boolean>;

参数

worldbook_name

• 类型: string
• 描述: 世界书名称

worldbook

• 类型: WorldbookEntry[]
• 描述: 世界书内容; 不填则没有任何条目

option?

一个可选的配置对象, 包含以下属性:

• render: debounced|immediate
  • 对于对世界书的更改, 世界书编辑器应该防抖渲染 (debounced) 还是立即渲染 (immediate)? 默认为性能更好的防抖渲染

返回值

• 是否成功创建或替换: boolean - 如果发生创建, 则返回 true; 如果发生替换, 则返回 false