Fork/Velocitab
2
0
Fork 0
forked from Upstream/Velocitab
Code Pull Requests Actions Releases Activity

docs: correct Plugin Message API docs (#169)

Browse Source
This commit is contained in:
AlexDev_ 2024-02-27 23:04:49 +01:00 committed by GitHub
parent 39aaae2f30
commit 3064aad4f3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Plugin-Message-API-Examples.md
View File

@ -3,7 +3,7 @@ Velocitab provides a plugin message API.
## API Requests from Backend Plugins ## API Requests from Backend Plugins
### 1 Changing player's username in the TAB List ### 1 Changing player's username in the TAB List
To change a player's username in the tablist, you can send a plugin message with the channel `velocitab:main` and as data `UPDATE_CUSTOM_NAME:::customName`. To change a player's username in the tablist, you can send a plugin message with the channel `velocitab:update_custom_name` and as data `customName`.
Remember to replace `customName` with the desired name. Remember to replace `customName` with the desired name.
<details> <details>
<summary>Example &mdash; Changing player's username in the TAB List</summary> <summary>Example &mdash; Changing player's username in the TAB List</summary>
@ -14,7 +14,7 @@ player.sendPluginMessage(plugin, "velocitab:update_custom_name", "Steve".getByte
</details> </details>
### 2 Update team color ### 2 Update team color
To change a player's team color in the TAB List, you can send a plugin message with the channel `velocitab:main` and as data `UPDATE_TEAM_COLOR:::teamColor`. To change a player's team color in the TAB List, you can send a plugin message with the channel `velocitab:update_team_color` and as data `teamColor`.
You can only use legacy color codes, for example `a` for green, `b` for aqua, etc. You can only use legacy color codes, for example `a` for green, `b` for aqua, etc.
This option overrides the glow effect if set This option overrides the glow effect if set