Miao-Yunzai/lib/plugins/plugin.js

129 lines
3.3 KiB
JavaScript
Raw Normal View History

import { Common } from '#miao'
2023-03-04 14:30:13 +08:00
let stateArr = {}
export default class plugin {
/**
* @param name 插件名称
* @param dsc 插件描述
2023-10-15 05:35:17 +08:00
* @param handler handler配置
* @param handler.key handler支持的事件key
* @param handler.fn handler的处理func
* @param namespace namespace设置handler时建议设置
2023-03-04 14:30:13 +08:00
* @param event 执行事件默认message
* @param priority 优先级数字越小优先级越高
2023-10-15 05:35:17 +08:00
* @param rule
2023-03-04 14:30:13 +08:00
* @param rule.reg 命令正则
* @param rule.fnc 命令执行方法
* @param rule.event 执行事件默认message
* @param rule.log false时不显示执行日志
* @param rule.permission 权限 master,owner,admin,all
2023-10-15 05:35:17 +08:00
* @param task
2023-03-04 14:30:13 +08:00
* @param task.name 定时任务名称
* @param task.cron 定时任务cron表达式
* @param task.fnc 定时任务方法名
* @param task.log false时不显示执行日志
*/
2023-10-15 05:35:17 +08:00
constructor ({
name = 'your-plugin',
dsc = '无',
handler,
namespace,
event = 'message',
priority = 5000,
task = { fnc: '', cron: '' },
rule = []
}) {
2023-03-04 14:30:13 +08:00
/** 插件名称 */
this.name = name
2023-03-04 14:30:13 +08:00
/** 插件描述 */
this.dsc = dsc
2023-03-04 14:30:13 +08:00
/** 监听事件默认message https://oicqjs.github.io/oicq/#events */
this.event = event
2023-03-04 14:30:13 +08:00
/** 优先级 */
this.priority = priority
2023-03-04 14:30:13 +08:00
/** 定时任务,可以是数组 */
this.task = {
/** 任务名 */
name: '',
/** 任务方法名 */
fnc: task.fnc || '',
2023-03-04 14:30:13 +08:00
/** 任务cron表达式 */
cron: task.cron || ''
2023-03-04 14:30:13 +08:00
}
/** 命令规则 */
this.rule = rule
2023-10-15 05:35:17 +08:00
if (handler) {
this.handler = handler
this.namespace = namespace || ''
}
2023-03-04 14:30:13 +08:00
}
/**
2023-10-15 05:35:17 +08:00
* @param msg 发送的消息
* @param quote 是否引用回复
* @param data.recallMsg 群聊是否撤回消息0-1200不撤回
* @param data.at 是否at用户
*/
2023-03-04 14:30:13 +08:00
reply (msg = '', quote = false, data = {}) {
if (!this.e.reply || !msg) return false
return this.e.reply(msg, quote, data)
}
conKey (isGroup = false) {
if (isGroup) {
return `${this.name}.${this.e.group_id}`
} else {
return `${this.name}.${this.userId || this.e.user_id}`
}
}
/**
* @param type 执行方法
* @param isGroup 是否群聊
* @param time 操作时间默认120秒
*/
setContext (type, isGroup = false, time = 120) {
let key = this.conKey(isGroup)
if (!stateArr[key]) stateArr[key] = {}
stateArr[key][type] = this.e
if (time) {
/** 操作时间 */
setTimeout(() => {
if (stateArr[key][type]) {
delete stateArr[key][type]
this.e.reply('操作超时已取消', true)
}
}, time * 1000)
}
}
getContext () {
let key = this.conKey()
return stateArr[key]
}
getContextGroup () {
let key = this.conKey(true)
return stateArr[key]
}
/**
* @param type 执行方法
* @param isGroup 是否群聊
*/
finish (type, isGroup = false) {
if (stateArr[this.conKey(isGroup)] && stateArr[this.conKey(isGroup)][type]) {
delete stateArr[this.conKey(isGroup)][type]
}
}
async renderImg (plugin, tpl, data, cfg) {
return Common.render(plugin, tpl, data, {
...cfg,
e: this.e
})
}
2023-03-04 14:30:13 +08:00
}