ms/packages/plugin/src/interfaces.ts
MiaoWoo 143c960da5 feat: new mjs scanner
Signed-off-by: MiaoWoo <admin@yumc.pw>
2022-04-01 17:18:32 +08:00

142 lines
3.4 KiB
TypeScript

import { server, MiaoScriptConsole, event, plugin } from "@ccms/api"
import { injectable, inject, postConstruct } from "@ccms/container"
import { getPluginMetadata } from "./utils"
const File = Java.type('java.io.File')
export namespace interfaces {
@injectable()
export abstract class Plugin implements plugin.Plugin {
public description: plugin.PluginMetadata
public logger: Console
@inject(server.Console)
private Console: MiaoScriptConsole
constructor() {
this.description = getPluginMetadata(this)
}
@postConstruct()
private initialize() {
// @ts-ignore
this.logger = new this.Console(this.description.prefix || this.description.name)
}
public getDataFolder() {
let parent = new File(this.description.source).parent
let dataFolder = new File(parent, this.description.name)
return dataFolder.getAbsolutePath()
}
public load() { }
public enable() { }
public disable() { }
}
export interface ExecMetadata extends plugin.BaseMetadata {
/**
* 执行器所在对象 用于绑定this
*/
target?: any
/**
* 执行器
*/
executor?: string
}
export interface CommandMetadata extends ExecMetadata {
/**
* 命令别名
*/
alias?: string[]
/**
* 命令描述
*/
description?: string
/**
* 参数列表
*/
paramtypes?: string[]
/**
* 自动化主命令
*/
autoMain?: boolean
/**
* 子命令权限效验
*/
permission?: boolean | string
}
export interface ListenerMetadata extends ExecMetadata {
/**
* 监听优先级
*/
priority?: event.EventPriority
/**
* 是否忽略已取消的事件
*/
ignoreCancel?: boolean
}
export interface ConfigMetadata extends plugin.BaseMetadata {
/**
* 配置文件版本号
*/
version?: number
/**
* 默认配置
*/
default?: any
/**
* 实体变量名称
*/
variable?: string
/**
* 配置文件格式 默认 yml
*/
format?: string
/**
* 自动保存 默认为 false
*/
autosave?: boolean
/**
* 配置文件名称
*/
filename?: string
/**
* 配置文件全路径
*/
file?: any
}
export interface PlayerDataMetadata extends plugin.BaseMetadata {
/**
* 配置文件版本号
*/
version?: number
/**
* 默认配置
*/
default?: any
/**
* 实体变量名称
*/
variable?: string
/**
* 配置文件格式 默认 yml
*/
format?: string
/**
* 自动保存 默认为 false
*/
autosave?: boolean
/**
* 配置文件名称 默认玩家名称
*/
filename?: "username" | "uuid"
/**
* 配置文件目录 默认 playerdata
*/
dir?: string
/**
* 配置文件子目录 默认为空
*/
subdir?: string
}
}