From 90f76bc5c09a9ad86716ee46f19df669d20dc5cb Mon Sep 17 00:00:00 2001
From: Jeremiah Billmann <jcbillmann@yahoo.com>
Date: Mon, 22 Jul 2013 20:02:20 -0400
Subject: [PATCH] Documentation...

---
 client/garageserver.io.js     | 32 ++++++++++++++++----------------
 src/server/garageserver.io.js | 14 +++++++-------
 2 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/client/garageserver.io.js b/client/garageserver.io.js
index 4c75ad4..1839f7b 100644
--- a/client/garageserver.io.js
+++ b/client/garageserver.io.js
@@ -1,25 +1,25 @@
 /*
 options = {
-    onPlayerConnect: function()
-    onPlayerDisconnect: function (),
-    onPlayerReconnect: function (),
-    onPlayerUpdate: function (state),
-    onEntityUpdate: function (state),
-    onPlayerRemove: function (id),
-    onEntityRemove: function (id),
-    onEvent: function (data),
-    onWorldState: function (state),
-    onPing: function (pingDelay),
-    onUpdatePlayerPhysics: function (state, inputs, deltaTime),
-    onInterpolation: function(previousState, targetState, amount)
-    onReady: function (),
+    onPlayerConnect(callback),
+    onPlayerDisconnect(callback),
+    onPlayerReconnect(callback),
+    onPlayerUpdate(callback(state)),
+    onEntityUpdate(callback(state)),
+    onPlayerRemove(callback(id)),
+    onEntityRemove(callback(id)),
+    onEvent(callback(data)),
+    onWorldState(callback(state)),
+    onPing(callback(pingDelay)),
+    onUpdatePlayerPhysics(callback(state, inputs, deltaTime)),
+    onInterpolation(callback(previousState, targetState, amount)),
+    onReady(callback,
     logging: true
 }
 api methods
     initializeGarageServer(path, options)
-    addInput({})
-    getStates(function (playerStates: [{state}], entityStates: [{state})])
-    getId() : 'playerid'
+    addInput(input)
+    getStates(callback([player1State, player2State, ...], [entity1State, entity2State, ...]))
+    getId() : playerid
     sendServerEvent(data)
 */
 var GarageServerIO = (function (socketio) {
diff --git a/src/server/garageserver.io.js b/src/server/garageserver.io.js
index dd44f8e..a37fbdc 100644
--- a/src/server/garageserver.io.js
+++ b/src/server/garageserver.io.js
@@ -12,18 +12,18 @@ options = {
     maxUpdateBuffer: 120,
     maxHistorySecondBuffer: 1000,
     worldState: {},
-    onPlayerConnect: function (socket),
-    onPlayerInput: function (socket, input),
-    onPlayerDisconnect: function (socket),
-    onPing: function (socket, data),
-    onEvent: function (data)
+    onPlayerConnect(callback(socket)),
+    onPlayerInput(callback(socket, input)),
+    onPlayerDisconnect(callback(socket)),
+    onPing(callback(socket, data)),
+    onEvent(callback(data))
 }
 api methods
     createGarageServer(io, options)
     start()
     stop()
-    getPlayers() : [{ id: '', state: {}, inputs: [{}], stateHistory: [{ state, executionTime }] }]
-    getEntities() : [{ id: '', state: {}, stateHistory: [{ state, executionTime }] }]
+    getPlayers() : [{ id, state, [input1, input2,...], [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
+    getEntities() : [{ id, state, [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
     updatePlayerState(id, state)
     updateEntityState(id, state)
     addEntity(id)