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

Jump to bottom

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

Merged
merged 4 commits into from
Jan 13, 2024
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c067780
Docs: specify that the cause should contain the player name
alwaysintreble Dec 3, 2023
ce0e697
accidental whitespace moment
alwaysintreble Dec 3, 2023
cda7027
fix table formatting
alwaysintreble Jan 12, 2024
96fdf52
Merge branch 'main' into death_link_cause_docs
black-sliver Jan 13, 2024
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
10 changes: 5 additions & 5 deletions docs/network protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,8 +675,8 @@ Tags are represented as a list of strings, the common Client tags follow:
### DeathLink
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 |
| ---- | ---- | ---- |
| 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." |
| 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. |
| Name | Type | Notes |
|--------|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|--------|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| ------ | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nvmd this suggestion. the other tables follow your style. I think we should keep consistency for now.

| time | float | Unix Time Stamp of time of death. |
| 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. |