Skip to content

Commit 766873a

Browse files
committed
docs: remove everything about registerPlugin()
1 parent 34d1fe4 commit 766873a

File tree

4 files changed

+1
-78
lines changed

4 files changed

+1
-78
lines changed

docs/apis/ScriptAPI/ScriptHelp.md

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,6 @@
44
55
They make it easier and more natural for you to develop scripts and avoid a lot of unnecessary details.
66

7-
## 🎯 Plugin Registration API
8-
9-
Before you start writing code for your plugin, you first need to provide the loader with some plugin-related information.
10-
11-
`ll.registerPlugin(name, introduction, version, otherInformation)`
12-
13-
- Parameters:
14-
15-
- name : `String`
16-
Plugin Name
17-
18-
- introduction : `String`
19-
A short description of the plugin.
20-
21-
- version : `Array<Integer,Integer,Integer[,VersionStatus]>`
22-
Plugin version information.
23-
24-
For `VersionStatus`, the following enumeration can be used
25-
| Enum | Description |
26-
| --------- | ---------------------------------- |
27-
| `Release` | Official release version (default) |
28-
| `Beta` | Test version |
29-
| `Dev` | Development Version |
30-
31-
- other : `Object<string,string>`
32-
Other additional information you are willing to provide (such as license, open source address, etc.)
33-
34-
Among them, version version information is an array of version number numbers, such as `[2,0,1]` indicates that the version number is 2.0.1
35-
If you do not pass in valid version information, the version number of the plugin will be set to the default value `1.0.0`
36-
37-
For plugin additional information, you can pass in any information you need to inform the user in the same format as `Object` key-value pair. The specific data of the key-value pair needs to be `String` format.
38-
39-
<br>
40-
417
## 💼 Script Assist API
428

439
The following APIs add necessary auxiliary interfaces to scripts.
@@ -164,4 +130,4 @@ The bottom layer has lock protection, different `fastLog` There will be no strin
164130
- Return value type: `Boolean`
165131
- If it returns `Null`, the cancellation of the task failed.
166132

167-
<br>
133+
<br>

docs/apis/ScriptAPI/ScriptHelp.zh.md

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,6 @@
44
55
他们让你开发脚本变得更加容易而自然,避免了很多无谓的细节问题的纠缠。
66

7-
## 🎯 插件注册 API
8-
9-
在开始为你的插件编写代码之前,你首先需要向加载器提供一些插件相关的信息
10-
11-
`ll.registerPlugin(name, introduction, version, otherInformation)`
12-
13-
- 参数:
14-
15-
- name : `String`
16-
插件名字
17-
18-
- introduction : `String`
19-
对插件的简短介绍
20-
21-
- version : `Array<Integer,Integer,Integer[, VersionStatus]>`
22-
插件的版本信息
23-
24-
对于 `VersionStatus`,可以使用以下枚举
25-
26-
| Enum | Description |
27-
| ----------------- | ---------------------- |
28-
| `Version.Release` | 正式发布版本(默认值) |
29-
| `Version.Beta` | 测试版本 |
30-
| `Version.Dev` | 开发版本 |
31-
32-
- other : `Object<string,string>`
33-
其他你愿意提供的的附加信息(如许可证、开源地址等)
34-
35-
其中,version 版本信息为版本号数字构成的数组,如`[2,0,1]`表示版本号为2.0.1
36-
如果你没有传入有效的版本信息,插件的版本号将被设置为默认值`1.0.0`
37-
38-
对于插件附加信息,你可以传入任意你需要告知用户的信息,格式同样为`Object`键值对。键值对的具体数据需要为`String`格式
39-
40-
<br>
41-
427
## 💼 脚本辅助 API
438

449
下面这些API为脚本增加了必要的辅助接口

docs/tutorials/create_your_first_plugin.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@ With your IDE in hand, and the server installation complete, you are ready to be
1414

1515
Developing a LLSE Plugin begins with creating your plugin's file. This file should be named "LLMyPlugin.js", replacing "MyPlugin" with what you would like to call your plugin. It should be placed in the plugins folder of your server installation. Some IDEs will allow you to create a new file and choose a location, while others will allow you to choose only after hitting "Save As".
1616

17-
The first line you will need in that file is the one below. For information on parameters for this method, and information on the Script Assist API, you can go [here](https://lse.liteldev.com/apis/ScriptAPI/ScriptHelp/).
18-
19-
`ll.registerPlugin(name, introduction, version, otherInformation)`
20-
2117
This might confuse some developers, as `ll` should be undefined. However, this file is going to be utilized by the LeviLamina ScriptX Engine. `ll` will be automatically included during the script's runtime. This is the same with any other variables/classes you see referenced without a definition.
2218

2319
Now that we have created our .js file, and registered the plugin, all we have to do from here is create an event listener. We do that by utilizing `mc`.

docs/tutorials/create_your_first_plugin.zh.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@
1919

2020
开发一个脚本插件,首先要创建你的插件文件。这个文件应该命名为 "LLMyPlugin.js",将 "MyPlugin" 替换为你想要的插件名称。它应该被放在你的服务器安装的插件文件夹中。有些开发环境会允许你创建一个新文件并选择一个位置,而其他开发环境则允许你在点击 "另存为" 后才选择。
2121

22-
你在该文件中需要的第一行是下面这行。关于这个方法的参数信息,以及关于Script Assist API的信息,你可以去[这里](https://lse.liteldev.com/zh/apis/ScriptAPI/ScriptHelp/)
23-
24-
`ll.registerPlugin(name, introduction, version, otherInformation)`
25-
2622
这可能会使一些开发者感到困惑,因为`ll`应该是未定义的。然而,这个文件将被LeviLamina ScriptX引擎所利用。`ll`将在脚本运行时自动包含。这与你看到的任何其他没有定义的变量/类的引用是一样的。
2723

2824
现在我们已经创建了我们的.js文件,并注册了插件,我们要做的就是创建一个事件监听器。我们通过使用`mc`来实现。

0 commit comments

Comments
 (0)