Skip to content
This repository was archived by the owner on Jun 30, 2025. It is now read-only.

Commit 5551d23

Browse files
SmileYikSmileYik
committed
docs: 添加部分类的方法文档至docs文件夹
1 parent 1b95280 commit 5551d23

File tree

12 files changed

+908
-1
lines changed

12 files changed

+908
-1
lines changed

‎docs/CommandRegister.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
### luaBukkit.command:registerCommand
3+
+ **Description**: 注册一个指令.
4+
+ **Return Type**: **void**
5+
+ **Return Desc**:
6+
+ **Usage**: `luaBukkit.command:registerCommand(command:String, id:String)`
7+
8+
|Name|Type|Description|
9+
|-|-|-|
10+
|command|**String**|要注册的指令.|
11+
|id|**String**|闭包id.|
12+
### luaBukkit.command:dispatch
13+
+ **Description**: 指令分发.
14+
+ **Return Type**: **void**
15+
+ **Return Desc**:
16+
+ **Usage**: `luaBukkit.command:dispatch(sender:CommandSender, command:Command, label:String, args:String[])`
17+
18+
|Name|Type|Description|
19+
|-|-|-|
20+
|sender|**CommandSender**|指令发送者.|
21+
|command|**Command**|指令.|
22+
|label|**String**|指令.|
23+
|args|**String[]**|指令.|

‎docs/EventRegister.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
2+
### luaBukkit.event:registerEvent
3+
+ **Description**: 注册事件.
4+
+ **Return Type**: **void**
5+
+ **Return Desc**:
6+
+ **Usage**: `luaBukkit.event:registerEvent(listener:LuaEvent<?extendsEvent>, priority:int)`
7+
8+
|Name|Type|Description|
9+
|-|-|-|
10+
|listener|**LuaEvent<?extendsEvent>**|监听器|
11+
|priority|**int**|优先级,范围为[0,5],不再此区间内则为正常默认等级.|
12+
### luaBukkit.event:registerListener
13+
+ **Description**: 注册监听事件.
14+
+ **Return Type**: **void**
15+
+ **Return Desc**:
16+
+ **Usage**: `luaBukkit.event:registerListener(event:String, id:String, priority:int)`
17+
18+
|Name|Type|Description|
19+
|-|-|-|
20+
|event|**String**|要注册的事件.|
21+
|id|**String**|闭包id|
22+
|priority|**int**|优先级,范围为[0,5],不再此区间内则为正常默认等级.|
23+
### luaBukkit.event:register
24+
+ **Description**: 注册监听事件.
25+
+ **Return Type**: **void**
26+
+ **Return Desc**:
27+
+ **Usage**: `luaBukkit.event:register(event:String, id:String, priority:int)`
28+
29+
|Name|Type|Description|
30+
|-|-|-|
31+
|event|**String**|要注册的事件名.|
32+
|id|**String**|闭包id|
33+
|priority|**int**|优先级,范围为[0,5],不再此区间内则为正常默认等级.|
34+
### luaBukkit.event:register
35+
+ **Description**: 创建一个事件监听器.
36+
+ **Return Type**: **String**
37+
+ **Return Desc**:
38+
+ **Usage**: `luaBukkit.event:register(plugin:LuaPlugin, closure:Object, event:String, priority:int)`
39+
40+
|Name|Type|Description|
41+
|-|-|-|
42+
|plugin|**LuaPlugin**|脚本插件实例.|
43+
|closure|**Object**|脚本函数|
44+
|event|**String**|事件名|
45+
|priority|**int**|优先级,范围为[0,5],不再此区间内则为正常默认等级.|
46+
### luaBukkit.event:unregisterEvent
47+
+ **Description**: 移除插件脚本用指定id注册的事件.
48+
+ **Return Type**: **void**
49+
+ **Return Desc**:
50+
+ **Usage**: `luaBukkit.event:unregisterEvent(id:String)`
51+
52+
|Name|Type|Description|
53+
|-|-|-|
54+
|id|**String**|注册事件所用的id.|
55+
### luaBukkit.event:unregisterAll
56+
+ **Description**: 移除插件脚本所有注册的事件.
57+
+ **Return Type**: **void**
58+
+ **Return Desc**:
59+
+ **Usage**: `luaBukkit.event:unregisterAll(pluginId:String)`
60+
61+
|Name|Type|Description|
62+
|-|-|-|
63+
|pluginId|**String**|插件脚本id|

‎docs/LuaLogger.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
### :info
3+
+ **Description**: 在控制台显示一条消息.
4+
+ **Return Type**: **void**
5+
+ **Return Desc**:
6+
+ **Usage**: `:info(obj:Object)`
7+
8+
|Name|Type|Description|
9+
|-|-|-|
10+
|obj|**Object**|要显示的内容.|
11+
### :warning
12+
+ **Description**: 在控制台显示一条警告.
13+
+ **Return Type**: **void**
14+
+ **Return Desc**:
15+
+ **Usage**: `:warning(obj:Object)`
16+
17+
|Name|Type|Description|
18+
|-|-|-|
19+
|obj|**Object**|要显示的内容.|
20+
### :severe
21+
+ **Description**: 在控制台显示一条错误.
22+
+ **Return Type**: **void**
23+
+ **Return Desc**:
24+
+ **Usage**: `:severe(obj:Object)`
25+
26+
|Name|Type|Description|
27+
|-|-|-|
28+
|obj|**Object**|要显示的内容.|

‎docs/LuaPlugin.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
2+
### self:getId
3+
+ **Description**: 获取脚本插件ID.
4+
+ **Return Type**: **String**
5+
+ **Return Desc**: 插件的id.
6+
+ **Usage**: `self:getId()`
7+
8+
|Name|Type|Description|
9+
|-|-|-|
10+
11+
### self:getDisplayName
12+
+ **Description**: 获取脚本插件的显示名称.
13+
+ **Return Type**: **String**
14+
+ **Return Desc**: 脚本插件的显示名称
15+
+ **Usage**: `self:getDisplayName()`
16+
17+
|Name|Type|Description|
18+
|-|-|-|
19+
20+
### self:getAuthor
21+
+ **Description**: 获取脚本插件的作者.
22+
+ **Return Type**: **String**
23+
+ **Return Desc**: 脚本插件的作者
24+
+ **Usage**: `self:getAuthor()`
25+
26+
|Name|Type|Description|
27+
|-|-|-|
28+
29+
### self:getVersion
30+
+ **Description**: 获取脚本插件的版本.
31+
+ **Return Type**: **String**
32+
+ **Return Desc**: 脚本插件版本.
33+
+ **Usage**: `self:getVersion()`
34+
35+
|Name|Type|Description|
36+
|-|-|-|
37+
38+
### self:getSoftDependents
39+
+ **Description**: 获取脚本插件的非必要依赖脚本插件id.
40+
+ **Return Type**: **List<String>**
41+
+ **Return Desc**: 非必要依赖脚本插件id.
42+
+ **Usage**: `self:getSoftDependents()`
43+
44+
|Name|Type|Description|
45+
|-|-|-|
46+
47+
### self:getDependents
48+
+ **Description**: 获取脚本插件的必要依赖脚本插件id.
49+
+ **Return Type**: **List<String>**
50+
+ **Return Desc**: 必要依赖脚本插件id.
51+
+ **Usage**: `self:getDependents()`
52+
53+
|Name|Type|Description|
54+
|-|-|-|
55+
56+
### self:getConfigPath
57+
+ **Description**: 获取脚本插件的配置目录.
58+
+ **Return Type**: **File**
59+
+ **Return Desc**: 配置目录File对象.
60+
+ **Usage**: `self:getConfigPath()`
61+
62+
|Name|Type|Description|
63+
|-|-|-|
64+
65+
### self:getPluginPath
66+
+ **Description**: 获取脚本插件所在的目录.
67+
+ **Return Type**: **File**
68+
+ **Return Desc**: 脚本插件所在的目录.
69+
+ **Usage**: `self:getPluginPath()`
70+
71+
|Name|Type|Description|
72+
|-|-|-|
73+
74+
### self:getRequirePath
75+
+ **Description**: 方便require方法获取脚本插件的模块路径.
76+
+ **Return Type**: **String**
77+
+ **Return Desc**: 返回脚本插件require所认可的模块路径.
78+
+ **Usage**: `self:getRequirePath(module:String)`
79+
80+
|Name|Type|Description|
81+
|-|-|-|
82+
|module|**String**|模块名称|
83+
### self:getLogger
84+
+ **Description**: 获取Logger.
85+
+ **Return Type**: **Logger**
86+
+ **Return Desc**: 返回Logger.
87+
+ **Usage**: `self:getLogger()`
88+
89+
|Name|Type|Description|
90+
|-|-|-|
91+
92+
### self:getRunType
93+
+ **Description**: 获取运行模式.
94+
+ **Return Type**: **RunType**
95+
+ **Return Desc**: 当前插件的运行模式.
96+
+ **Usage**: `self:getRunType()`
97+
98+
|Name|Type|Description|
99+
|-|-|-|

‎docs/LuaPluginHelper.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
2+
### luaBukkit.helper:isLoadPlugin
3+
+ **Description**: 指定脚本插件是否加载.
4+
+ **Return Type**: **boolean**
5+
+ **Return Desc**: 如果已经加载则返回true.
6+
+ **Usage**: `luaBukkit.helper:isLoadPlugin(id:String)`
7+
8+
|Name|Type|Description|
9+
|-|-|-|
10+
|id|**String**|脚本插件id|
11+
### luaBukkit.helper:newLuaRunnable
12+
+ **Description**: 以指定id对应的函数为run方法主体创建一个Runnable子类实例
13+
+ **Return Type**: **LuaRunnable**
14+
+ **Return Desc**: LuaRunnable实例
15+
+ **Usage**: `luaBukkit.helper:newLuaRunnable(id:String)`
16+
17+
|Name|Type|Description|
18+
|-|-|-|
19+
|id|**String**|函数路径|
20+
### luaBukkit.helper:newLuaRunnable
21+
+ **Description**: 以指定id对应的函数为run方法主体创建一个Runnable子类实例
22+
+ **Return Type**: **LuaRunnable**
23+
+ **Return Desc**: LuaRunnable实例
24+
+ **Usage**: `luaBukkit.helper:newLuaRunnable(id:String, obj:Object)`
25+
26+
|Name|Type|Description|
27+
|-|-|-|
28+
|id|**String**|函数路径|
29+
|obj|**Object**|带入的参数.|
30+
### luaBukkit.helper:getPlugin
31+
+ **Description**: 获取本插件实例对象.
32+
+ **Return Type**: **Plugin**
33+
+ **Return Desc**: 本插件的实例对象.
34+
+ **Usage**: `luaBukkit.helper:getPlugin()`
35+
36+
|Name|Type|Description|
37+
|-|-|-|
38+
39+
### luaBukkit.helper:getClass
40+
+ **Description**: 通过全类名去获取java类类型.
41+
+ **Return Type**: **Class<?>**
42+
+ **Return Desc**: 如果类存在则返回对应的类
43+
+ **Usage**: `luaBukkit.helper:getClass(name:String)`
44+
45+
|Name|Type|Description|
46+
|-|-|-|
47+
|name|**String**|全类名|
48+
### luaBukkit.helper:isNativeMode
49+
+ **Description**: 插件是否在Native模式下运行.
50+
+ **Return Type**: **boolean**
51+
+ **Return Desc**: 如果是在Native模式下运行则返回true.
52+
+ **Usage**: `luaBukkit.helper:isNativeMode()`
53+
54+
|Name|Type|Description|
55+
|-|-|-|

0 commit comments

Comments
 (0)