control

type Control struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

type EnableMark bool

type Engine interface {
	// Delete 移除该 Engine 注册的所有 Matchers
	Delete()
	// On 添加新的指定消息类型的匹配器
	On(typ string, rules ...zero.Rule) Matcher
	// OnMessage 消息触发器
	OnMessage(rules ...zero.Rule) Matcher
	// OnNotice 系统提示触发器
	OnNotice(rules ...zero.Rule) Matcher
	// OnRequest 请求消息触发器
	OnRequest(rules ...zero.Rule) Matcher
	// OnMetaEvent 元事件触发器
	OnMetaEvent(rules ...zero.Rule) Matcher
	// OnPrefix 前缀触发器
	OnPrefix(prefix string, rules ...zero.Rule) Matcher
	// OnSuffix 后缀触发器
	OnSuffix(suffix string, rules ...zero.Rule) Matcher
	// OnCommand 命令触发器
	OnCommand(commands string, rules ...zero.Rule) Matcher
	// OnRegex 正则触发器
	OnRegex(regexPattern string, rules ...zero.Rule) Matcher
	// OnKeyword 关键词触发器
	OnKeyword(keyword string, rules ...zero.Rule) Matcher
	// OnFullMatch 完全匹配触发器
	OnFullMatch(src string, rules ...zero.Rule) Matcher
	// OnFullMatchGroup 完全匹配触发器组
	OnFullMatchGroup(src []string, rules ...zero.Rule) Matcher
	// OnKeywordGroup 关键词触发器组
	OnKeywordGroup(keywords []string, rules ...zero.Rule) Matcher
	// OnCommandGroup 命令触发器组
	OnCommandGroup(commands []string, rules ...zero.Rule) Matcher
	// OnPrefixGroup 前缀触发器组
	OnPrefixGroup(prefix []string, rules ...zero.Rule) Matcher
	// OnSuffixGroup 后缀触发器组
	OnSuffixGroup(suffix []string, rules ...zero.Rule) Matcher
	// OnShell shell命令触发器
	OnShell(command string, model any, rules ...zero.Rule) Matcher
	// ApplySingle 应用反并发
	ApplySingle(*single.Single[int64]) Engine
	// DataFolder 本插件数据目录, 默认 data/zbp/
	DataFolder() string
	// IsEnabledIn 自己是否在 id (正群负个人零全局) 启用
	IsEnabledIn(id int64) bool
	// 下载并获取本 engine 文件夹下的懒加载数据
	GetLazyData(filename string, isDataMustEqual bool) ([]byte, error)
}

type Matcher interface {
	// SetBlock 设置是否阻断后面的 Matcher 触发
	SetBlock(block bool) Matcher
	// Handle 直接处理事件
	Handle(handler zero.Handler)
	// Limit 限速器
	//    postfn 当请求被拒绝时的操作
	Limit(limiterfn func(*zero.Ctx) *rate.Limiter, postfn ...func(*zero.Ctx)) Matcher
}

type Options struct {
	DisableOnDefault  bool
	Help              string              // 帮助文本信息
	PrivateDataFolder string              // 全部小写的数据文件夹名, 不出现在 zbpdata
	PublicDataFolder  string              // 驼峰的数据文件夹名, 出现在 zbpdata
	OnEnable          func(ctx *zero.Ctx) // 启用插件后执行的命令, 为空则打印 “已启用服务: xxx”
	OnDisable         func(ctx *zero.Ctx) // 禁用插件后执行的命令, 为空则打印 “已禁用服务: xxx”
}