Class Plugin<T>

Type Parameters

T extends keyof icqq.EventMap = keyof icqq.EventMap

Indexable

[k: string]: any

Index

Constructors

Properties

dsc e event handler? name namespace? priority reply rule task

Methods

awaitContext conKey finish getContext renderImg resolveContext setContext

Constructors

constructor

new Plugin<T extends keyof icqq.EventMap = keyof icqq.EventMap>(
options?: PluginOptions<T>,
): Plugin<T>
Type Parameters
- T extends keyof icqq.EventMap = keyof icqq.EventMap
Parameters
- Optionaloptions: PluginOptions<T>
Returns Plugin<T>
- Defined in plugin.d.ts:151

Properties

dsc

dsc: string

插件描述

e

e: [T] extends [keyof icqq.EventMap]
    ? [keyof icqq.EventMap] extends [T<T>]
        ? MessageEvent
        : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
    : MessageEvent

消息事件

event

event: T

监听事件（默认 message）

`Optional`handler

handler?: Record<string, any> | HandlerConfig

可选的 handler 配置（如果有）

name

name: string

插件名称

`Optional`namespace

namespace?: string

handler 命名空间

priority

priority: number

优先级（数字越小越高）

reply

reply: (
    msg: Sendable,
    quote?: boolean,
    data?: { at?: boolean; recallMsg?: number },
) => Promise<MessageRet>

Type Declaration

- (
      msg: Sendable,
      quote?: boolean,
      data?: { at?: boolean; recallMsg?: number },
  ): Promise<MessageRet>
- 回复消息
  Parameters
  - msg: Sendable
    支持字符串或 segment
  - Optionalquote: boolean
    是否引用回复
  - Optionaldata: { at?: boolean; recallMsg?: number }
    额外配置
    - Optionalat?: boolean
      是否提及用户
    - OptionalrecallMsg?: number
      多久之后撤回消息，0-120秒，0不撤回
  Returns Promise<MessageRet>

rule

rule: PluginRule[]

命令规则数组

task

task: PluginTask | PluginTask[]

定时任务（或数组）

Methods

awaitContext

awaitContext(...args: any[]): Promise<any>
awaitContext：等待上下文
Parameters
- ...args: any[]
Returns Promise<any>
- Defined in plugin.d.ts:210

conKey

conKey(isGroup?: boolean): string
构造用于存储上下文的 key
Parameters
- OptionalisGroup: boolean
  是否群聊
Returns string
- Defined in plugin.d.ts:186

finish

finish(type?: string, isGroup?: boolean): void
finish：结束上下文并清理（会 clearTimeout）
Parameters
- Optionaltype: string
- OptionalisGroup: boolean
Returns void
- Defined in plugin.d.ts:205

getContext

getContext(type?: string, isGroup?: boolean): any
getContext：获取上下文（不传 type 则返回整个 key 的对象）
Parameters
- Optionaltype: string
- OptionalisGroup: boolean
Returns any
- Defined in plugin.d.ts:200

renderImg

renderImg(
    plugin: string,
    tpl: string,
    data?: any,
    cfg?: Record<string, any>,
): Promise<any>
renderImg：调用 Common.render 生成/渲染图片（import "#miao" 的 Common）
Parameters
- plugin: string
  渲染器所属 plugin 名
- tpl: string
  模板名
- Optionaldata: any
  模板数据
- Optionalcfg: Record<string, any>
  额外配置，会把 e 注入到 cfg
Returns Promise<any>
- Defined in plugin.d.ts:224

resolveContext

resolveContext(context: any): void
resolveContext：触发 resolve 并结束上下文
Parameters
- context: any
Returns void
- Defined in plugin.d.ts:215

setContext

setContext(
    type: string,
    isGroup?: boolean,
    time?: number,
    timeout?: string,
): any
setContext：设置上下文
Parameters
- type: string
  自定义类型字符串
- OptionalisGroup: boolean
  是否群聊
- Optionaltime: number
  过期时间（秒）
- Optionaltimeout: string
  超时提示文本
Returns any
- Defined in plugin.d.ts:195