Skip to content

删除角色卡 ​

提示

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

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

deleteCharacter ​

删除 character_name_or_id 角色卡

ts
function deleteCharacter(character_name_or_id: LiteralUnion<'current', string | `${string}.png`>, options?: { delete_chats?: boolean }): Promise<boolean>;

参数 ​

character_name_or_id ​

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

option? ​

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

  • delete_chats: boolean
    • 是否要同时删除角色卡的聊天文件

返回值 ​

  • 是否成功删除, 可能因角色卡不存在等原因而失败: boolean