Skip to content

Commit 2b0943e

Browse files
committed
add docs for hint_status JSONMessagePart
1 parent 83548cf commit 2b0943e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/network protocol.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -554,6 +554,7 @@ class JSONMessagePart(TypedDict):
554554
color: Optional[str] # only available if type is a color
555555
flags: Optional[int] # only available if type is an item_id or item_name
556556
player: Optional[int] # only available if type is either item or location
557+
hint_status: Optional[int] # only available if type is hint_status
557558
```
558559

559560
`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.
@@ -569,6 +570,7 @@ Possible values for `type` include:
569570
| location_id | Location ID, should be resolved to Location Name |
570571
| location_name | Location Name, not currently used over network, but supported by reference Clients. |
571572
| entrance_name | Entrance Name. No ID mapping exists. |
573+
| hint_status | The status of the hint (i.e. found, priority). See (HintStatus)[#HintStatus] for details. Both `text` and `hint_status` are given. |
572574
| color | Regular text that should be colored. Only `type` that will contain `color` data. |
573575

574576

0 commit comments

Comments
 (0)