Read the game's state
diagGet a parsed snapshot of the current game state from a client or server, returning integer counters and record details to distinguish real zeros from missing data.
Instructions
Ask one side of the session what it currently sees, parsed.
Args: server: Read the dedicated server's view instead of the client's. target: Address a specific client by name. timeout: Seconds for the WHOLE call — the reply and then the dump it promises, out of one budget rather than one each. A large world takes longer.
Returns counters as integers and the mod's absence markers as null, so a reading of 0 — a real measurement — cannot be confused with "no data". Asking both sides at the same moment is the only way to answer "the client reports no NPC", which one side alone cannot.
records carries the indented list bodies the scalars only summarise:
fields["npcs"] says active=6 mutated=1, and records["npcs"] says which
six. Those lines were parsed and discarded until now, so a caller could see
that something was there and never what it was.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| server | No | ||
| target | No | ||
| timeout | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| side | Yes | ||
| fields | Yes | ||
| records | Yes |