获取世界书

提示

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

点击查看对应类型定义文件（可发给AI或IDE使用，酒馆助手设置中提供了打包下载）

getWorldbook

获取 worldbook_name 世界书的内容。

function getWorldbook(worldbook_name: string): Promise<WorldbookEntry[]>;

参数

worldbook_name

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

返回值

• 世界书内容: WorldbookEntry[]

getWorldbookNames

获取世界书列表。

function getWorldbookNames(): string[];

返回值

• 世界书名称列表: string[]

getGlobalWorldbookNames

获取当前全局开启的世界书列表。

function getGlobalWorldbookNames(): string[];

返回值

• 全局开启的世界书名称列表: string[]

getCharWorldbookNames

获取角色卡绑定的世界书。

getCharWorldbookNames

function getCharWorldbookNames(character_name: LiteralUnion<'current' | string>): CharWorldbooks;

CharWorldbooks

type CharWorldbooks = {
  primary: string | null;
  additional: string[];
}

参数

character_name

• 类型: 'current' | string
• 描述: 角色卡名称, 'current' 表示当前打开的角色卡

返回值

• CharWorldbooks 对象: 角色卡绑定的世界书

getChatWorldbookName

获取聊天文件绑定的世界书。

function getChatWorldbookName(chat_name: 'current'): string | null;

参数

chat_name

• 类型: 'current' | string
• 描述: 聊天文件名称, 'current' 表示当前打开的聊天文件

返回值

• 聊天文件绑定的世界书: string | null

getOrCreateChatWorldbook

获取或新建聊天文件世界书。

function getOrCreateChatWorldbook(chat_name: 'current', worldbook_name?: string): Promise<string>;

参数

chat_name

• 类型: 'current' | string
• 描述: 聊天文件名称, 'current' 表示当前打开的聊天文件

worldbook_name

• 类型: string
• 描述: 世界书名称; 不填则根据当前时间创建

返回值

• 聊天文件绑定的世界书: string