Skip to content

Commit

Permalink
Merge pull request #7 from ACaiCat/caitest
Browse files Browse the repository at this point in the history
文档:删除下划线
  • Loading branch information
ACaiCat authored May 3, 2024
2 parents 4469396 + 982bcea commit fbe38ec
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 23 deletions.
11 changes: 3 additions & 8 deletions .github/workflows/document.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,9 @@ jobs:
- name: Temporary Upload Doc
uses: actions/upload-artifact@v4
with:
name: Doc
name: TShock插件编写从入门到跑路
path: TShock插件编写从入门到跑路.pdf

- name: Prepare Release Files
uses: actions/upload-artifact@v4
with:
name: Doc
path: TShock插件编写从入门到跑路.pdf

LatestRelease:
name: Latest Release
Expand Down Expand Up @@ -80,7 +75,7 @@ jobs:
- name: Download Artifacts
uses: actions/download-artifact@v4
with:
name: Doc
name: TShock插件编写从入门到跑路
path: ./
- name: Update Latest Release
uses: ncipollo/release-action@v1
Expand All @@ -89,7 +84,7 @@ jobs:
name: "Latest Version"
body: "🥳这里是文档的PDF发布,你可以在这里下载整份教程。\n${{steps.external_changelog_second.outputs.changelog}}"
artifacts: |
TShock插件编写从入门到跑路.pdf
TShock插件编写从入门到跑路
allowUpdates: true
removeArtifacts: true

Expand Down
2 changes: 1 addition & 1 deletion Document/Part0.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ VisualStudio一般会出现在开始菜单下,你可以使用如下方法创

![1692967698634.png](Resourse/6476_9620982f91a831420e1f690259f1bb40.png "1692967698634.png")

初次启动可能会要求登录,登录完成后可以选择自定义主题\(~~反正我喜欢黑色主题~~\),按照自己的偏好选择即可
初次启动可能会要求登录,登录完成后可以选择自定义主题,按照自己的偏好选择即可
至此,VisualStudio安装教程结束
4 changes: 2 additions & 2 deletions Document/Part2.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

### 插件模板​

以下是一个常用的TShock插件模板~~其实似乎也就是Part 1把HelloWorld删掉的样子~~
以下是一个常用的TShock插件模板



Expand Down Expand Up @@ -185,7 +185,7 @@ public override void Initialize()

### 插件的卸载函数​

相较于初始化函数,卸载函数显得~~没什么存在感\(你甚至可以不写卸载函数\)~~
相较于初始化函数,卸载函数显得
但是为了代码规范,还是建议你把注册过的钩子卸载,删除添加的命令


Expand Down
7 changes: 3 additions & 4 deletions Document/Part3.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- 如何在TShock插件中添加新命令
- 学会处理CommandArgs参数
- 学会卸载插件添加的命令~~\(养成好习惯\)~~
- 学会卸载插件添加的命令

### 1.添加新的命令​

Expand Down Expand Up @@ -305,11 +305,10 @@ args.Player.Teleport(1, 1); //传送玩家到坐标(X,Y)
args.Player.Disconnect("这是一个断开信息"); //断开玩家的连接(断开理由)(也算是踢出玩家的一种)
```

~~将会在未来的几个Part更详细地讲解TSplayer\(画大饼\)~~

#### TPlayer​

Player对象,即Terraria原版玩家对象,~~过于硬核~~此处不讲解
Player对象,即Terraria原版玩家对象,此处不讲解

#### Silent​

Expand All @@ -321,7 +320,7 @@ Player对象,即Terraria原版玩家对象,~~过于硬核~~,此处不讲
#### Message​

原消息,例如:你执行了/kick Cai 傻逼,那么Message的值就是"kick Cai 傻逼"
由于Parameters的存在~~这个东西就基本上没啥卵用~~
由于Parameters的存在


### 5.卸载你添加的命令​
Expand Down
2 changes: 1 addition & 1 deletion Document/Part4.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

### 举个例子:

假如你需要实现当玩家说脏话时把他踢出去,那么你就可以注册一个ServerChat钩子,并且调用OnChat函数。你需要在OnChat函数中编写代码,识别玩家是不是真的说了脏话。最后别忘了卸载你的钩子~~\(好习惯\)~~
假如你需要实现当玩家说脏话时把他踢出去,那么你就可以注册一个ServerChat钩子,并且调用OnChat函数。你需要在OnChat函数中编写代码,识别玩家是不是真的说了脏话。最后别忘了卸载你的钩子



Expand Down
6 changes: 3 additions & 3 deletions Document/Part5.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ else
| AcceptingWhispers | bool | 玩家是否接受耳语\(私聊\) \(/w\) |
| ActiveChest | int | 玩家当前打开的箱子ID \(玩家没有开箱子则未-1\) |
| AwaitingResponse | Dictionary\<string, Action\<object>> | 玩家等待特定命令的响应的列表\(\?\) |
| ~~Confused~~ | bool | 玩家是否处于控制左右颠倒\(已失效\) |
| Confused | bool | 玩家是否处于控制左右颠倒\(已失效\) |
| Country | string | 玩家的国家代码\(需要在Config开启EnableGeoIP\)\(无数据N/A, 代理A1\) |
| CurrentRegion | Region | 玩家当前所处的区域 |
| Dead | bool | 玩家是否处于死亡状态 |
Expand Down Expand Up @@ -208,7 +208,7 @@ else
| SilentKickInProgress | bool | 玩家是否静默踢出服务器\(不发送玩家踢出服务器的提示\) |
| sX | int | 玩家出生点的X坐标 |
| sY | int | 玩家出生点的Y坐标 |
| ~~TeleportCoords~~ | Vector2 | 不明,在TShock已弃用 |
| TeleportCoords | Vector2 | 不明,在TShock已弃用 |
| tempGroup | Group | 玩家当前的临时组\(会覆盖原来的组\) |
| tempGroupTimer | Timer | 玩家临时组有效期的计时器 |
| TempPoints | Point\[2\] | 玩家设置的区域临时点 |
Expand Down Expand Up @@ -246,6 +246,6 @@ else
| Spawn | int tilex, int tiley, PlayerSpawnContext context, int\? respawnTimer = null, short\? numberOfDeathsPVE = null, short\? numberOfDeathsPVP = null | void | 复活玩家,大部分参数无效,不做解释 |
| Teleport | float x\(X坐标\), float y\(Y坐标\), byte style = 1\(TP类型\[不做解释\]\) | void | 将玩家传送到某一位置 |
| Whoopie | object time\(其实是个int,单位:秒\) | void | 发出烦人的声音 需要另开线程使用,否则会卡死主线程 |
| ~~TempGroupTimerElapsed~~ | 不做解释 | 不做解释 | 不应该被Pubic的内部方法 |
| TempGroupTimerElapsed | 不做解释 | 不做解释 | 不应该被Pubic的内部方法 |

*部分方法例如:SendDate另做介绍
6 changes: 3 additions & 3 deletions Document/Part6.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ else
| AcceptingWhispers | bool | 玩家是否接受耳语\(私聊\) \(/w\) |
| ActiveChest | int | 玩家当前打开的箱子ID \(玩家没有开箱子则未-1\) |
| AwaitingResponse | Dictionary\<string, Action\<object>> | 玩家等待特定命令的响应的列表\(\?\) |
| ~~Confused~~ | bool | 玩家是否处于控制左右颠倒\(已失效\) |
| Confused | bool | 玩家是否处于控制左右颠倒\(已失效\) |
| Country | string | 玩家的国家代码\(需要在Config开启EnableGeoIP\)\(无数据N/A, 代理A1\) |
| CurrentRegion | Region | 玩家当前所处的区域 |
| Dead | bool | 玩家是否处于死亡状态 |
Expand Down Expand Up @@ -208,7 +208,7 @@ else
| SilentKickInProgress | bool | 玩家是否静默踢出服务器\(不发送玩家踢出服务器的提示\) |
| sX | int | 玩家出生点的X坐标 |
| sY | int | 玩家出生点的Y坐标 |
| ~~TeleportCoords~~ | Vector2 | 不明,在TShock已弃用 |
| TeleportCoords | Vector2 | 不明,在TShock已弃用 |
| tempGroup | Group | 玩家当前的临时组\(会覆盖原来的组\) |
| tempGroupTimer | Timer | 玩家临时组有效期的计时器 |
| TempPoints | Point\[2\] | 玩家设置的区域临时点 |
Expand Down Expand Up @@ -246,7 +246,7 @@ else
| Spawn | int tilex, int tiley, PlayerSpawnContext context, int\? respawnTimer = null, short\? numberOfDeathsPVE = null, short\? numberOfDeathsPVP = null | void | 复活玩家,大部分参数无效,不做解释 |
| Teleport | float x\(X坐标\), float y\(Y坐标\), byte style = 1\(TP类型\[不做解释\]\) | void | 将玩家传送到某一位置 |
| Whoopie | object time\(其实是个int,单位:秒\) | void | 发出烦人的声音 需要另开线程使用,否则会卡死主线程 |
| ~~TempGroupTimerElapsed~~ | 不做解释 | 不做解释 | 不应该被Pubic的内部方法 |
| TempGroupTimerElapsed | 不做解释 | 不做解释 | 不应该被Pubic的内部方法 |

*部分方法例如:SendDate另做介绍

Expand Down
2 changes: 1 addition & 1 deletion Document/Part7.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ WTF\?

### 发送数据包\(SendData\)的参数:​

这里有一个~~奇怪的误区~~,SendData的参数并不一定是写进数据包的值\(上面例子中:参数1是player.Index而不是TPlayer.statLifeMax\),对于不同的数据包SendData的参数也会有所不同。想要知道具体参数作用,我们需要反编译NetMessage.orig\_SendData,方法就是直接在可以执行语句的地方打一个NetMessage.orig\_SendData,然后右键orig\_SendData,点击转到定义,等待一下反编译我们就能看到NetMessage.orig\_SendData的代码了
这里有一个奇怪的误区,SendData的参数并不一定是写进数据包的值\(上面例子中:参数1是player.Index而不是TPlayer.statLifeMax\),对于不同的数据包SendData的参数也会有所不同。想要知道具体参数作用,我们需要反编译NetMessage.orig\_SendData,方法就是直接在可以执行语句的地方打一个NetMessage.orig\_SendData,然后右键orig\_SendData,点击转到定义,等待一下反编译我们就能看到NetMessage.orig\_SendData的代码了

![1708706875142.png](Resourse/6704_13e87dfe295685f2e0fe714dd4892f00.png "1708706875142.png")

Expand Down

0 comments on commit fbe38ec

Please sign in to comment.