Class Plugin<T>

constructor

• new Plugin<T extends EventKeys = EventKeys>(
      options?: PluginOptions<T>,
  ): Plugin<T>

  Type Parameters

  • T extends EventKeys = EventKeys

  Parameters

  • Optionaloptions: PluginOptions<T>

  Returns Plugin<T>

dsc

e

event

"message"
Copy

Optionalhandler

name

Optionalnamespace

priority

reply

rule

task

awaitContext

• awaitContext(
      ...args: [isGroup?: boolean, time?: number, timeout?: string],
  ): Promise<
      [T] extends [EventKeys]
          ? [EventKeys] extends [T<T>]
              ? MessageEvent
              : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
          : MessageEvent,
  >

  等待上下文

  Parameters

  • ...args: [isGroup?: boolean, time?: number, timeout?: string]

  Returns Promise<
      [T] extends [EventKeys]
          ? [EventKeys] extends [T<T>]
              ? MessageEvent
              : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
          : MessageEvent,
  >

conKey

• conKey(isGroup?: boolean): string

  构造用于存储上下文的 key

  Parameters

  • OptionalisGroup: boolean

    是否群聊

  Returns string

finish

• finish(type?: string, isGroup?: boolean): void

  结束上下文

  Parameters

  • Optionaltype: string
  • OptionalisGroup: boolean

  Returns void

getContext

• getContext(
      type: undefined,
      isGroup?: boolean,
  ):
      | {}
      | Record<
          string,
          [T] extends [EventKeys]
              ? [EventKeys] extends [T<T>]
                  ? MessageEvent
                  : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
              : MessageEvent,
      >

  获取上下文

  不传 type 则返回整个 key 的对象

  Parameters

  • type: undefined
  • OptionalisGroup: boolean

  Returns
      | {}
      | Record<
          string,
          [T] extends [EventKeys]
              ? [EventKeys] extends [T<T>]
                  ? MessageEvent
                  : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
              : MessageEvent,
      >

• getContext(
      type?: string,
      isGroup?: boolean,
  ): [T] extends [EventKeys]
      ? [EventKeys] extends [T<T>]
          ? MessageEvent
          : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
      : MessageEvent

  获取上下文

  不传 type 则返回整个 key 的对象

  Parameters

  • Optionaltype: string
  • OptionalisGroup: boolean

  Returns [T] extends [EventKeys]
      ? [EventKeys] extends [T<T>]
          ? MessageEvent
          : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
      : MessageEvent

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>

resolveContext

• resolveContext(context: MessageEvent): void

  触发 resolve 并结束上下文

  Parameters

  • context: MessageEvent

  Returns void

setContext

• setContext(
      type: string,
      isGroup?: boolean,
      time?: number,
      timeout?: string,
  ): [T] extends [EventKeys]
      ? [EventKeys] extends [T<T>]
          ? MessageEvent
          : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
      : MessageEvent

  设置上下文

  Parameters

  • type: string

    执行方法

  • OptionalisGroup: boolean

    是否群聊

  • Optionaltime: number

    过期时间（秒）

  • Optionaltimeout: string

    超时提示文本

  Returns [T] extends [EventKeys]
      ? [EventKeys] extends [T<T>]
          ? MessageEvent
          : [T<T>] extends ["message"] ? MessageEvent : Event<T<T>>
      : MessageEvent