删除消息

提示

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

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

deleteChatMessages

删除聊天消息, 这比酒馆自带的 /del 更为高效.

deleteChatMessages

function deleteChatMessages(
  message_ids: number[],
  option: SetChatMessagesOption = {}
): Promise<void>;

参数

message_ids

• 类型: number[]
• 描述: 要删除的消息楼层号数组

option?

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

refresh?

• 类型: 'none' | 'affected' | 'all'
• 描述: 是否更新楼层在页面上的显示, 只会更新已经被加载在网页上的楼层, 并触发被更新楼层的 "仅格式显示" 正则; 默认为 'affected'
  • 'none': 不更新页面的显示
  • 'affected': 仅更新被影响楼层的显示, 更新显示时会发送 tavern_events.USER_MESSAGE_RENDERED 或 tavern_events.CHARACTER_MESSAGE_RENDERED 事件从而重新渲染前端
  • 'all': 重新载入整个聊天消息, 将会触发 tavern_events.CHAT_CHANGED 事件

示例

删除特定楼层

// 删除第 10 楼、第 15 楼、倒数第二楼和最新楼层
await deleteChatMessages([10, 15, -2, getLastMessageId()]);

删除所有楼层

// 删除所有楼层
await deleteChatMessages(_.range(getLastMessageId() + 1));