mirror of
https://github.com/tribufu/node-gamedig
synced 2026-05-18 09:35:50 +00:00
Massive revamp for standardization of output
This commit is contained in:
parent
397d09d9d3
commit
007f1ffb8b
15 changed files with 153 additions and 119 deletions
35
README.md
35
README.md
|
|
@ -22,25 +22,34 @@ Gamedig.query(
|
|||
);
|
||||
```
|
||||
|
||||
State Object
|
||||
Callback Function
|
||||
---
|
||||
The callback function is "guaranteed" to be called exactly once, indicating either a query error or timeout
|
||||
(in the state's error key), or with a state object containg the successful results.
|
||||
The callback function is "guaranteed" to be called exactly once.
|
||||
|
||||
The returned state object may contain some or all of the following keys:
|
||||
If an error occurs, the returned object will contain an "error" key, indicating the issue.
|
||||
If the error key exists, it should be assumed that the game server is offline or unreachable.
|
||||
|
||||
Otherwise, the returned object will contain the following keys:
|
||||
|
||||
Guaranteed:
|
||||
|
||||
* error
|
||||
* name
|
||||
* numplayers
|
||||
* maxplayers
|
||||
* players
|
||||
* name
|
||||
* ping
|
||||
* score
|
||||
* map
|
||||
* gametype
|
||||
* password (boolean)
|
||||
* maxplayers
|
||||
* players (may contain name, ping, score, team, address)
|
||||
* bots (same as players)
|
||||
* raw (contains special keys depending on the type of server queried - UNSTABLE)
|
||||
* notes (passed through from the input)
|
||||
* query (details about the query performed)
|
||||
* host
|
||||
* address
|
||||
* port
|
||||
* type
|
||||
* pretty (a "pretty" string describing the game)
|
||||
|
||||
Many other keys will also be available will be available on a game by game basis.
|
||||
It can usually be assumed that the number of players online is equal to the length of the players array.
|
||||
Some servers may return an additional player count number, which may be present in the unstable raw object.
|
||||
|
||||
Supported Games
|
||||
---
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue