aboutsummaryrefslogtreecommitdiff
path: root/draughts/public/javascripts/messages.js
diff options
context:
space:
mode:
Diffstat (limited to 'draughts/public/javascripts/messages.js')
-rw-r--r--draughts/public/javascripts/messages.js9
1 files changed, 8 insertions, 1 deletions
diff --git a/draughts/public/javascripts/messages.js b/draughts/public/javascripts/messages.js
index 04a96e9..2ae34da 100644
--- a/draughts/public/javascripts/messages.js
+++ b/draughts/public/javascripts/messages.js
@@ -1,9 +1,16 @@
+/* A basic enumeration of different messages that can be sent via websockets between the client(s)
+ * and the server. Each message has a comment explaining what it represents.
+ *
+ * S --> C :: The server sends the message to the client
+ * C <-- S :: The client sends the message to the server
+ * S <-> C :: The server sends the message to the client and vise versa
+ */
(function (exports) {
exports.COMMENCE = 0 // S --> C :: Inform the client that they may commence their turn
exports.RESIGN = 1 // S <-> C :: Inform the server/opponent that the client resigned
exports.DISCONNECT = 2 // S --> C :: Inform the client that the opponent disconnected
exports.MOVED = 3 // S <-> C :: Inform the server/opponent that the client has moved a piece
exports.WELCOME = 4 // S --> C :: Inform the client of their color when they join the game
- exports.START = 5 // s --> C :: Inform the blue player that they can make the first move
+ exports.START = 5 // S --> C :: Inform the blue player that they can make the first move
exports.GAMEOVER = 6 // S --> C :: Inform the clients that the game is over
})(typeof(exports) == "undefined" ? (this.Messages = {}) : exports)