Class Plugin<T>

Type Parameters

T extends EventKeys = EventKeys

Indexable

[k: string]: any

Index

Constructors

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>
- Defined in plugin.d.ts:192

Properties

dsc

dsc: string | undefined

插件描述

e

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

消息事件

event

event: T | undefined

监听事件

Default

"message"

`Optional`handler

handler?: Record<string, any> | HandlerConfig

handler 配置

name

name: string | undefined

插件名称

`Optional`namespace

namespace?: string

handler 命名空间

priority

priority: number | undefined

优先级

数字越小优先级越高

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[] | undefined

命令规则数组

task

task: PluginTask | PluginTask[] | undefined

定时任务

可以定时任务对象数组

Methods

awaitContext

awaitContext(
    ...args: [isGroup?: boolean, time?: number, timeout?: string],
): Promise<
    [T] extends [EventKeys]
        ? [EventKeys] extends [T]
            ? MessageEvent
            : [T] extends ["message"] ? MessageEvent : Event<T>
        : MessageEvent,
>
等待上下文
Parameters
- ...args: [isGroup?: boolean, time?: number, timeout?: string]
Returns Promise<
    [T] extends [EventKeys]
        ? [EventKeys] extends [T]
            ? MessageEvent
            : [T] extends ["message"] ? MessageEvent : Event<T>
        : MessageEvent,
>
- Defined in plugin.d.ts:268

conKey

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

finish

finish(type?: string, isGroup?: boolean): void
结束上下文
Parameters
- Optionaltype: string
- OptionalisGroup: boolean
Returns void
- Defined in plugin.d.ts:263

getContext

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

不传 type 则返回整个 key 的对象
Parameters
- type: undefined
- OptionalisGroup: boolean
Returns
    | {}
    | Record<
        string,
        [T] extends [EventKeys]
            ? [EventKeys] extends [T]
                ? MessageEvent
                : [T] extends ["message"] ? MessageEvent : Event<T>
            : MessageEvent,
    >
    | undefined
- Defined in plugin.d.ts:257
getContext(
    type?: string,
    isGroup?: boolean,
): [T] extends [EventKeys]
    ? [EventKeys] extends [T]
        ? MessageEvent
        : [T] extends ["message"] ? MessageEvent : Event<T>
    : MessageEvent
获取上下文

不传 type 则返回整个 key 的对象
Parameters
- Optionaltype: string
- OptionalisGroup: boolean
Returns [T] extends [EventKeys]
    ? [EventKeys] extends [T]
        ? MessageEvent
        : [T] extends ["message"] ? MessageEvent : Event<T>
    : MessageEvent
- Defined in plugin.d.ts:258

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:282

resolveContext

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

setContext

setContext(
    type: string,
    isGroup?: boolean,
    time?: number,
    timeout?: string,
): [T] extends [EventKeys]
    ? [EventKeys] extends [T]
        ? MessageEvent
        : [T] extends ["message"] ? MessageEvent : Event<T>
    : MessageEvent
设置上下文
Parameters
- type: string
  执行方法
- OptionalisGroup: boolean
  是否群聊
- Optionaltime: number
  过期时间（秒）
- Optionaltimeout: string
  超时提示文本
Returns [T] extends [EventKeys]
    ? [EventKeys] extends [T]
        ? MessageEvent
        : [T] extends ["message"] ? MessageEvent : Event<T>
    : MessageEvent
- Defined in plugin.d.ts:250

Class Plugin<T>

Type Parameters

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Plugin<T>

Properties

dsc

e

event

Default

Optionalhandler

name

Optionalnamespace

priority

reply

Type Declaration

Parameters

Optionalat?: boolean

OptionalrecallMsg?: number

Returns Promise<MessageRet>

rule

task

Methods

awaitContext

Parameters

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

conKey

Parameters

Returns string

finish

Parameters

Returns void

getContext

Parameters

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

Parameters

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

renderImg

Parameters

Returns Promise<any>

resolveContext

Parameters

Returns void

setContext

Parameters

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

Settings

On This Page

`Optional`handler

`Optional`namespace

`Optional`at?: boolean

`Optional`recallMsg?: number

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

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

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

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