Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

文档：优化Part2 #14

Merged
merged 1 commit into from
May 3, 2024
Merged

文档：优化Part2 #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 40 additions & 51 deletions Document/Part2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## Part 2.初步了解TShock插件模板​
# Part 2.初步了解TShock插件模板​

本章你将学到：

* TShock插件模板各部分的作用
* TShock插件的初始化顺序

### 插件模板​
## 插件模板​

以下是一个常用的TShock插件模板
> 以下是一个常用的TShock插件模板



Expand Down Expand Up @@ -64,14 +64,8 @@ namespace Plugin
```





### 插件基本信息​
以下代码可以设置插件的一些基本信息，插件名建议按照功能命名，不要起奇怪名字\(例如"炸裂"\)



## 插件基本信息​
> 以下代码可以设置插件的一些基本信息，插件名建议按照功能命名，不要起奇怪名字\(例如"炸裂"\)
```csharp
//定义插件的作者名称
public override string Author => "插件的作者";
Expand All @@ -86,42 +80,39 @@ public override string Name => "插件的名字";
public override Version Version => Assembly.GetExecutingAssembly().GetName().Version;
```

Author\(插件作者\)、Name\(插件名字\)、Version\(插件版本\)将会在插件初始化完成时显示
- Author\(插件作者\)、Name\(插件名字\)、Version\(插件版本\)将会在插件初始化完成时显示

![1693020601153.png](Resourse/6526_0d62fb22e43fa3980efba17731fe70e6.png "1693020601153.png")


其中，Version可以通过new Version修改，如下:


- 其中，Version可以通过new Version修改，如下:

```csharp
//插件的版本
public override Version Version => new Version(1, 0, 0, 0);
//public override Version Version => Assembly.GetExecutingAssembly().GetName().Version;
```

使用new Version\(\)将会显示此方法参数为版本号\(例如本例子中的"1.0.0.0"\)
而使用Assembly.GetExecutingAssembly\(\).GetName\(\).Version获取的是程序集的版本号, 程序集版本号需要在项目属性中修改
- 使用new Version\(\)将会显示此方法参数为版本号\(例如本例子中的"1.0.0.0"\)
- 而使用Assembly.GetExecutingAssembly\(\).GetName\(\).Version获取的是程序集的版本号, 程序集版本号需要在项目属性中修改

> 注: 如果你使用new Version\(\)作为版本号，将会以你Version\(\)的参数作为版本号，而不是程序集版本

<details>
<summary>修改程序集版本</summary>
1.右键解决方案资源管理器中的项目\(这里是HelloWorld\),然后点击属性
1. 右键解决方案资源管理器中的项目\(这里是HelloWorld\),然后点击属性
<img src="Resourse/6521_17b2fe13121894c2606b5672953c284f.png" alt="图片描述">
<img src="Resourse/6522_163749ccba0554c69e60e62fa4e3d10f.png" alt="图片描述">
2.在属性选项卡中依次找到包—常规—程序集版本
2. 在属性选项卡中依次找到包—常规—程序集版本
<img src="Resourse/6524_2ef29be4606e5e50751e678d992fb50d.png" alt="图片描述">
3.修改程序集版本即可
3. 修改程序集版本即可
</details>



### 插件的构造器​
## 插件的构造器​

插件的构造器，也叫构造函数，构造函数中的代码会比Initialize\(初始化\)函数更先执行
服务端会先按照读取到插件的顺序\(取决于插件的文件名\)执行所有插件的构造函数，再按照Order\(等下会讲\)由小到大执行Initialize\(初始化\)函数
- 插件的构造器，也叫构造函数，构造函数中的代码会比Initialize\(初始化\)函数更先执行.
- 服务端会先按照读取到插件的顺序\(取决于插件的文件名\)执行所有插件的构造函数，再按照Order\(等下会讲\)由小到大执行Initialize\(初始化\)函数



Expand All @@ -133,39 +124,37 @@ public Plugin(Main game) : base(game)
}
```

通常情况下，构造函数的执行会在TShock初始化之前，如果在构造函数中编写代码\(例如建表\)，可能会导致十分玄学的问题，
所以没有特殊需要下一般插件的构造函数都会直接放空。
- 通常情况下，构造函数的执行会在TShock初始化之前，如果在构造函数中编写代码\(例如建表\)，可能会导致十分玄学的问题， 所以没有特殊需要下一般插件的构造函数都会直接放空。

#### 在构建函数中修改Order\(听不懂没事\)
### 在构建函数中修改Order\(听不懂没事\)

构造函数常常会用来修改插件的初始化顺序—Order
Order是一个int类型的整数，Order可以在取int类型范围内的任何数，当然也可以是负数
Order越小插件的初始化就越优先，Order为1的插件会比Order为2的插件先初始化, TShock的Order为0，
插件的Order在默认情况下\(不修改\)为1，而TShock的Order为0，所以TShock会比其他插件更先初始化
- 构造函数常常会用来修改插件的初始化顺序—Order
- Order是一个int类型的整数，Order可以在取int类型范围内的任何数，当然也可以是负数
- Order越小插件的初始化就越优先，Order为1的插件会比Order为2的插件先初始化, TShock的Order为0
- 插件的Order在默认情况下\(不修改\)为1，而TShock的Order为0，所以TShock会比其他插件更先初始化

<details>
<summary>Order小实验</summary>
1.编写两个插件，在执行构造函数和初始化函数执行时打印文本
<img src="Resourse/6530_f7178dea684e463a3906bc89a05dba11.png" alt="图片描述">
2.重命名并安装插件
当Order为1的插件在文件夹中更靠前时\(以文件名排序\)，Order为1的插件的构造函数将会先被执行
<img src="Resourse/6533_cc0bdd48046b7012e10c0228eef0ef06.png" alt="图片描述">
![1693022440424.png]( "1693022440424.png")
<img src="Resourse/6534_783aedca561256565fae29db0fba1976.png" alt="图片描述">
相反，当Order为2的插件在文件夹中更靠前时\(以文件名排序\)，Order为2的插件的构造函数将会先被执行
<img src="Resourse/6531_0dc2b5f224e085f63b4aeafb500d8242.png" alt="图片描述">
<img src="Resourse/6532_81e71b3644e9c1ecc16d404da47c02c3.png" alt="图片描述">
所以，插件构造函数的执行顺序取决于插件的文件名，与Order无关
但是无论文件名如何修改，Order为1的插件总会先初始化，如下图:
<img src="Resourse/6535_644e3b83b2095ffdd4efb6fb7cd0a8a1.png" alt="图片描述">
所以，插件初始化函数的执行顺序取决于Order，与插件的文件名无关
<summary>Order例子</summary>
1. 编写两个插件，在执行构造函数和初始化函数执行时打印文本<br>
<img src="Resourse/6530_f7178dea684e463a3906bc89a05dba11.png" alt="图片描述"><br>
2. 重命名并安装插件<br>
<li>当Order为1的插件在文件夹中更靠前时\(以文件名排序\)，Order为1的插件的构造函数将会先被执行<br>
<img src="Resourse/6533_cc0bdd48046b7012e10c0228eef0ef06.png" alt="图片描述"><br>
<img src="Resourse/6534_783aedca561256565fae29db0fba1976.png" alt="图片描述"><br>
<li>相反，当Order为2的插件在文件夹中更靠前时\(以文件名排序\)，Order为2的插件的构造函数将会先被执行 <br>
<img src="Resourse/6531_0dc2b5f224e085f63b4aeafb500d8242.png" alt="图片描述"><br>
<img src="Resourse/6532_81e71b3644e9c1ecc16d404da47c02c3.png" alt="图片描述"><br>
<li>所以，插件构造函数的执行顺序取决于插件的文件名，与Order无关 <br>
<li>但是无论文件名如何修改，Order为1的插件总会先初始化，如下图: <br>
<img src="Resourse/6535_644e3b83b2095ffdd4efb6fb7cd0a8a1.png" alt="图片描述"><br>
<li>所以，插件初始化函数的执行顺序取决于Order，与插件的文件名无关
</details>



### 插件的初始化函数​
## 插件的初始化函数​

初始化函数是TShock插件中非常重要的部分，这个函数主要负责插件的初始化，可以用来注册钩子、添加命令、注册REST API命令、初始化配置文件、初始化数据库等
> 初始化函数是TShock插件中非常重要的部分，这个函数主要负责插件的初始化，可以用来注册钩子、添加命令、注册REST API命令、初始化配置文件、初始化数据库等



Expand All @@ -183,10 +172,10 @@ public override void Initialize()



### 插件的卸载函数​
## 插件的卸载函数​

相较于初始化函数，卸载函数显得
但是为了代码规范，还是建议你把注册过的钩子卸载，删除添加的命令
> 相较于初始化函数，卸载函数显得
> 但是为了代码规范，还是建议你把注册过的钩子卸载，删除添加的命令



Expand Down