From e506aef5f680ccf01cf83a5e535429a8dce6819a Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Thu, 25 Jul 2013 21:51:06 -0400 Subject: [PATCH] Progress: Documentation... --- README.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 987c08a..6ed051e 100644 --- a/README.md +++ b/README.md @@ -101,42 +101,41 @@ options = { } */ ``` -**path** - +**path** Type: string -**options** +**options** Type: object literal ```js GarageServerIO.addInput(input) ``` -**input** +**input** Type: object literal ```js GarageServerIO.getStates(callback([, playerState], [, entityState])) ``` -**playerState** +**playerState** Type: array of object literals -**entityState** +**entityState** Type: array of object literals ```js GarageServerIO.getId() : playerid ``` -**playerid** +**playerid** Type: number ```js GarageServerIO.sendServerEvent(data) ``` -**data** +**data** Type: object literal ### Server @@ -183,46 +182,46 @@ GarageServerIO.getEntities() : [,{ id, state, [,{ state, executionTime }] }] ```js GarageServerIO.updatePlayerState(id, state) ``` -**id** +**id** Type: string -**state** +**state** Type: object literal ```js GarageServerIO.updateEntityState(id, state) ``` -**id** +**id** Type: string -**state** +**state** Type: object literal ```js GarageServerIO.addEntity(id) ``` -**id** +**id** Type: string ```js GarageServerIO.removeEntity(id) ``` -**id** +**id** Type: string ```js GarageServerIO.sendPlayerEvent(id, data) ``` -**id** +**id** Type: string -**data** +**data** Type: object literal ```js GarageServerIO.sendPlayersEvent(data) ``` -**data** +**data** Type: object literal