From fc1e6b42706d90d07aecf609044a73680df5de7c Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Tue, 30 Jul 2013 21:24:01 -0400 Subject: [PATCH] Progress: Documentation --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2dcac1e..21c674a 100644 --- a/README.md +++ b/README.md @@ -407,8 +407,9 @@ Object containing all of the properties pertaining to world state for your game ```js options.onPlayerConnect(callback(socket)) ``` +Event fired when a player connects to the server. `callback` **function** - +Function to be invoked upon event firing. `socket` **Socket** --- @@ -416,7 +417,7 @@ options.onPlayerConnect(callback(socket)) options.onPlayerInput(callback(socket, input)) ``` `callback` **function** - +Function to be invoked upon event firing. `socket` **Socket** `input` **object literal** @@ -426,7 +427,7 @@ options.onPlayerInput(callback(socket, input)) options.onPlayerDisconnect(callback(socket)) ``` `callback` **function** - +Function to be invoked upon event firing. `socket` **Socket** --- @@ -434,31 +435,31 @@ options.onPlayerDisconnect(callback(socket)) options.onPing(callback(socket, data)) ``` `callback` **function** - +Function to be invoked upon event firing. `socket` **Socket** -`data` **object literal** - +`data` **number** +The client start time when the ping was initiated. --- ```js options.onEvent(callback(data)) ``` `callback` **function** - +Function to be invoked upon event firing. `data` **object literal** - +Object containing all properties pertaining to the custom event. #### start --- ```js GarageServerIO.start() ``` - +Starts the server time and broadcast loop. #### stop --- ```js GarageServerIO.stop() ``` - +Stops the server time and broadcast loop. #### getPlayers --- ```js