酒馆助手

Appearance

创建角色卡 ​

提示

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

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

createCharacter ​

新建 character_name_or_id 角色卡, 内容为 character

ts
function createCharacter(character_name_or_id: Exclude<string | `${string}.png`, 'current'>, character?: PartialDeep<Character>): Promise<boolean>;

参数 ​

character_name_or_id ​

  • 类型: string | `${string}.png`
  • 描述: 角色卡显示名称 (如 '少女歌剧') 或头像 id (角色卡文件名, 如 '少女歌剧.png')

character ​

返回值 ​

  • 是否成功创建, 如果已经存在同名角色卡或尝试创建名为 'current' 的角色卡会失败: boolean

异常 ​

  • 如果访问后端失败, 将会抛出异常

createOrReplaceCharacter ​

创建或替换名为 character_name_or_id 的角色卡, 内容为 character

ts
function createOrReplaceCharacter(
  character_name_or_id: Exclude<string | `${string}.png`, 'current'>,
  character?: PartialDeep<Character>,
  { render }?: ReplaceCharacterOptions,
): Promise<boolean>;

参数 ​

character_name_or_id ​

  • 类型: 'current' | string | `${string}.png`
  • 描述: 角色卡显示名称 (如 '少女歌剧') 或头像 id (角色卡文件名, 如 '少女歌剧.png')

character ​

option? ​

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

  • render: debounced|immediate|none
    • 酒馆网页应该防抖渲染 (debounced)、立即渲染 (immediate) 还是不刷新前端显示 (none)? 默认为性能更好的防抖渲染

返回值 ​

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

异常 ​

  • 如果访问后端失败, 将会抛出异常