删除消息
提示
请务必先阅读如何正确使用酒馆助手
点击查看对应类型定义文件(可发给AI或IDE使用,酒馆助手设置中提供了打包下载)
deleteChatMessages
删除聊天消息。
typescript
function deleteChatMessages(
message_ids: number[],
option: DeleteChatMessagesOption = {}
): Promise<void>;
typescript
type DeleteChatMessagesOption = {
refresh?: 'none' | 'all';
}
参数
message_ids
- 类型:
number[]
- 描述: 要删除的消息楼层号数组
refresh?
- 类型:
'none' | 'all'
- 描述: 是否更新楼层在页面上的显示,只会更新已经被加载在网页上的楼层,并触发被更新楼层的 "仅格式显示" 正则; 默认为
'all'
'none'
: 不更新页面的显示'all'
: 重新载入整个聊天消息,将会触发tavern_events.CHAT_CHANGED
事件
示例
typescript
// 删除第 10 楼、第 15 楼、倒数第二楼和最新楼层
await deleteChatMessages([10, 15, -2, getLastMessageId()]);
typescript
// 删除所有楼层
await deleteChatMessages(_.range(getLastMessageId() + 1));