Maze2: mark out of date

2024-07-05T09:33:09Z

mark out of date

imported>Maze: creat

2019-11-15T18:11:57Z

creat

New page

AAGRINDER uses the [https://socket.io socket.io] library for most of the communication between the AAGRINDER server and the AAGRINDER clients.
This page describes all the different messages that can be sent between the server and the client over socket.io.

== Endpoints on the server ==

This section describes all the messages that can be sent from the AAGRINDER client to the AAGRINDER server.

The items under ''Data'' need to be present in the message, otherwise the message is ignored.
The examples are written as code you would run on the client.

=== Login ===
Attempts to log in a player
==== Endpoint ====
<pre>'login'</pre>
==== Data ====
<pre>
{ username:[string], password:[string] }
</pre>
==== Sample code ====
<pre>socket.emit('login', {username:'original', password:'hihi'});</pre>

=== Chat message ===
Sends a chat message to all other clients, or runs a server-side command.
Only works if player is logged in.
==== Endpoint ====
<pre>'chat'</pre>
==== Data ====
<pre>
{ message:[string] }
</pre>
==== Sample code ====
<pre>socket.emit('chat', {message:'hi!'});</pre>

=== Change player color ===
==== Endpoint ====
<pre>'changecolor'</pre>

=== Game tick ===
==== Endpoint ====
<pre>'t'</pre>

=== Submit debug logs ===
==== Endpoint ====
<pre>'debuglog'</pre>

== Endpoints on the client ==

This section describes all the messages that can be received on the AAGRINDER client from the AAGRINDER server.

The items under ''Data'' are always present in the message received from the server, unless they are marked with ''?'', in which case they are optional.
The examples are written as code you would run on the client.

=== Login success ===
==== Endpoint ====
<pre>'loginsuccess'</pre>
==== Sample code ====
<pre>socket.on('loginsuccess', data => console.log(data));</pre>

=== Login error ===
==== Endpoint ====
<pre>'loginerror'</pre>
==== Sample code ====
<pre>socket.on('loginerror', data => console.log(data));</pre>

=== Force reload ===
==== Endpoint ====
<pre>'FORCERELOAD'</pre>
==== Sample code ====
<pre>socket.on('FORCERELOAD', data => console.log(data));</pre>

=== Chat message ===
==== Endpoint ====
<pre>'chat'</pre>
==== Sample code ====
<pre>socket.on('chat', data => console.log(data));</pre>

=== Terrain update ===
==== Endpoint ====
<pre>'t'</pre>
==== Sample code ====
<pre>socket.on('t', data => console.log(data));</pre>

@@ Line 1: / Line 1: @@
 AAGRINDER uses the [https://socket.io socket.io] library for most of the communication between the AAGRINDER server and the AAGRINDER clients.
 This page describes all the different messages that can be sent between the server and the client over socket.io.
 == Endpoints on the server ==

AAGRINDER socket.io api - Revision history

Maze2: mark out of date

imported>Maze: creat