获取角色卡

提示

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

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

getCharacterNames

获取角色卡名称列表

function getCharacterNames(): string[];

返回值

• 角色卡名称列表: string[]

getCharacter

获取 character_name 角色卡的内容

getCharacter

async function getCharacter(character_name: LiteralUnion<'current', string>): Promise<Character | null>;

Character

ttype Character = {
  name: string;
  version: string;
  creator: string;
  creator_notes: string;

  worldbook: string | null;
  description: string;
  first_messages: string[];

  extensions: {
    regex_scripts: TavernRegex[];
    tavern_helper: {
      scripts: Record<string, any>[];
      variables: Record<string, any>;
    };
    [other: string]: any;
  };
};

参数

character_name

• 类型: string
• 描述: 角色卡名称

返回值

• 角色卡内容: Character

异常

• 如果角色卡不存在, 将会抛出错误