Docs: specify that deathlink cause should contain the player name #2557
Conversation
ScipioWright
added
the
is: enhancement
alwaysintreble
added
is: documentation
alwaysintreble
changed the title
|
This surprises me, this wasn't a requirement before, and i know several games that don't include it Infact it used to be the opposite, not to include your player name in the case so you could do |
|
And I know several games that do include it, and so doing it the way you're doing it would show up strangely there. I guess there's the idea of, like in your example, specifically stating that you received a DeathLink. I don't really agree with the idea, though, since you need to explicitly enable death link in the first place, and that reduces creativity in death link messages. |
|
when i implemented deathlink i asked how cause messages were supposed to be displayed, and what this change is doing is what i was told at the time and how clients are expected to handle it. |
|
hmm well if different games do it differently, then i guess it would be good to explicitly specify it and i guess Timespinner for now willl stop supporting the standard |
docs/network protocol.md
Outdated
| | Name | Type | Notes | | ||
| | ---- | ---- |--------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | 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." | |
There was a problem hiding this comment.
I would suggest removing the 'or checked' here as to me i have no idea what this is meant to mean
There was a problem hiding this comment.
when your client checks the death link packet to see what it should display.
| | 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 | | ||
| |--------|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------| |
There was a problem hiding this comment.
| |--------|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------| | |
| | ------ | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | |
There was a problem hiding this comment.
Nvmd this suggestion. the other tables follow your style. I think we should keep consistency for now.
…chipelagoMW#2557) * Docs: specify that the cause should contain the player name * accidental whitespace moment * fix table formatting
yes