Gravwell-Online/docs/events.md
2022-03-07 00:51:30 -06:00

1.2 KiB

Events

Every event in this document has two forms, a request and a response, the event type can be differentiated by the event prefix, req is an event going to the server, and res is a response coming from the server to the client. Some events may only have one of these types, if this is the case, it will be denoted in the relevant section.

Important: Events with the Broadcasted event type, must be listened to even if you don't send any Request events of that type. This is because other clients connected to the server may trigger the server in such a way that the event response gets sent to multiple clients. Broadcasted events will use the res event type prefix.


server.info

Retrieves information about the server that the client is currently connected to.

Supported Event Types

Request Response Broadcasted
Yes Yes No

Payloads

Request Payload: N/A

Response Payload: IServerInfo


event name

event description

Supported Event Types

Request Response Broadcasted
Yes Yes No

Payloads

Request Payload: Itype name

Response Payload: Itype name