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

Core: embed custom datapackage into .archipelago (#1288)

Browse Source 
Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
This commit is contained in:
Fabian Dill
2022-12-08 21:23:31 +01:00
committed by GitHub
parent bedc78d335
commit 79bb43b77c
3 changed files with 29 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/network protocol.md
View File

@@ -367,16 +367,19 @@ Used to request a single or multiple values from the server's data storage, see
| keys | list\[str\] | Keys to retrieve the values for. |
Additional arguments sent in this package will also be added to the [Retrieved](#Retrieved) package it triggers.
Some special keys exist with specific return data:
| Name | Type | Notes |
|----------------------------|-----------------------|----------------------------------------------|
| \_read_hints_{team}_{slot} | list\[[Hint](#Hint)\] | All Hints belonging to the requested Player. |
| \_read_slot_data_{slot} | any | slot_data belonging to the requested slot. |
Some special keys exist with specific return data, all of them have the prefix `_read_`, so `hints_{team}_{slot}` is `_read_hints_{team}_{slot}`.
| Name | Type | Notes |
|-------------------------------|------------------------|---------------------------------------------------|
| hints_{team}_{slot} | list\[[Hint](#Hint)\] | All Hints belonging to the requested Player. |
| slot_data_{slot} | any | slot_data belonging to the requested slot. |
| item_name_groups_{game_name} | dict\[str, list\[str]] | item_name_groups belonging to the requested game. |
### Set
Used to write data to the server's data storage, that data can then be shared across worlds or just saved for later. Values for keys in the data storage can be retrieved with a [Get](#Get) package, or monitored with a [SetNotify](#SetNotify) package.
Keys that start with `_read_` cannot be set.
#### Arguments
| Name | Type | Notes |
|------------|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|