morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 20:21:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

MultiServer: add JSONMessagePart["player"]

Browse Source
This commit is contained in:
Fabian Dill
2021-11-07 14:42:05 +01:00
parent 2b124aaff4
commit 666e3b5333
4 changed files with 18 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/network protocol.md
View File

@@ -333,6 +333,7 @@ class JSONMessagePart(TypedDict):
type: Optional[str]
color: Optional[str]
text: Optional[str]
player: Optional[int] # marks owning player id for location/item
```
`type` is used to denote the intent of the message part. This can be used to indicate special information which may be rendered differently depending on client. How these types are displayed in Archipelago's ALttP client is not the end-all be-all. Other clients may choose to interpret and display these messages differently.
@@ -340,6 +341,7 @@ Possible values for `type` include:
* player_id
* item_id
* location_id
* entrance_name
`color` is used to denote a console color to display the message part with. This is limited to console colors due to backwards compatibility needs with games such as ALttP. Although background colors as well as foreground colors are listed, only one may be applied to a [JSONMessagePart](#JSONMessagePart) at a time.