monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: specify that deathlink cause should contain the player name (#2557) 

* Docs: specify that the cause should contain the player name

* accidental whitespace moment

* fix table formatting
This commit is contained in:
Aaron Wagener 2024-01-13 12:23:14 -06:00 committed by GitHub
parent 0c0adb0745
commit 2725c0258f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/network protocol.md
View File

@ -676,7 +676,7 @@ Tags are represented as a list of strings, the common Client tags follow:
A special kind of Bounce packet that can be supported by any AP game. It targets the tag "DeathLink" and carries the following data: A special kind of Bounce packet that can be supported by any AP game. It targets the tag "DeathLink" and carries the following data:
| Name | Type | Notes | | Name | Type | Notes |
| ---- | ---- | ---- | |--------|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| time | float | Unix Time Stamp of time of death. | | time | float | Unix Time Stamp of time of death. |
| cause | str | Optional. Text to explain the cause of death, ex. "Berserker was run over by a train." | | cause | str | Optional. Text to explain the cause of death. When provided, or checked, this should contain the player name, ex. "Berserker was run over by a train." |
| source | str | Name of the player who first died. Can be a slot name, but can also be a name from within a multiplayer game. | | source | str | Name of the player who first died. Can be a slot name, but can also be a name from within a multiplayer game. |