From 53db67944f95a629d5aa6f013c33e468b2368da8 Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Sun, 28 Jul 2013 21:15:32 -0400 Subject: [PATCH] Progress: Documentation --- README.md | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 396db37..3fd3176 100644 --- a/README.md +++ b/README.md @@ -111,24 +111,6 @@ var playerStates = GarageServerIO.getPlayerStates(), --- ```js GarageServerIO.initializeGarageServer(path, options) -/* -options = { - 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)), - onUpdatePlayerPrediction(callback(state, inputs, deltaTime) : newState), - onInterpolation(callback(previousState, targetState, amount) : newState), - onReady(callback), - logging: true -} -*/ ``` **path** Type: string @@ -136,6 +118,21 @@ Type: string **options** Type: object literal +**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))** +**onUpdatePlayerPrediction(callback(state, inputs, deltaTime) : newState)** +**onInterpolation(callback(previousState, targetState, amount) : newState)** +**onReady(callback)** +**logging: true** + #### addInput --- ```js