Oliver/Gravwell-Online
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation for the generic error event

Browse source
This commit is contained in:
Oliver Akins 2022-03-08 13:23:59 -06:00
parent 02dece1af0
commit 1b01ef971d
No known key found for this signature in database
GPG key ID: 3C2014AF9457AF99
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/events.md
View file

@ -16,6 +16,22 @@ payloads inherit from the `ServerResponse` type.
---
## `error`
The event that is sent to clients when they cause a significant error to happen
in the server. When this is sent, the status property will never be set to a
value in the success range.
### Supported Event Types
| Request | Response | Broadcasted
| ------- | -------- | -----------
| No | Yes | No
### Payloads
Request Payload: N/A
Response Payload: `ServerResponse`
---
## `server.info`
Retrieves information about the server that the client is currently connected
to.