From fa8b41281710b8282ed537744cc38225f0168012 Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Fri, 26 Jul 2013 09:57:49 -0400 Subject: [PATCH] Progress: Documentation --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index be9a5be..6d14ff6 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,8 @@ Type: string **options** Type: object literal +--- + ```js GarageServerIO.addInput(input) ``` @@ -114,6 +116,8 @@ GarageServerIO.addInput(input) **input** Type: object literal +--- + ```js GarageServerIO.getStates(callback([, playerState], [, entityState])) ``` @@ -127,6 +131,8 @@ Type: array of object literals **entityStates** Type: array of object literals +--- + ```js GarageServerIO.getId() : playerid ``` @@ -134,6 +140,8 @@ GarageServerIO.getId() : playerid **playerid** Type: number +--- + ```js GarageServerIO.sendServerEvent(data) ``` @@ -166,14 +174,26 @@ options = { */ ``` +**io** +Type: Socket.IO instance + +**options** +Type: object literal + +--- + ```js GarageServerIO.start() ``` +--- + ```js GarageServerIO.stop() ``` +--- + ```js GarageServerIO.getPlayers() : [,{ id, state, [,inputs], [,{ states, executionTimes }] }] ``` @@ -190,6 +210,8 @@ Type: array of object literals **states** Type: array of object literals +--- + ```js GarageServerIO.getEntities() : [,{ id, state, [,{ state, executionTime }] }] ``` @@ -203,6 +225,8 @@ Type: object literal **states** Type: array of object literals +--- + ```js GarageServerIO.updatePlayerState(id, state) ``` @@ -212,6 +236,8 @@ Type: string **state** Type: object literal +--- + ```js GarageServerIO.updateEntityState(id, state) ``` @@ -221,18 +247,24 @@ Type: string **state** Type: object literal +--- + ```js GarageServerIO.addEntity(id) ``` **id** Type: string +--- + ```js GarageServerIO.removeEntity(id) ``` **id** Type: string +--- + ```js GarageServerIO.sendPlayerEvent(id, data) ``` @@ -242,6 +274,8 @@ Type: string **data** Type: object literal +--- + ```js GarageServerIO.sendPlayersEvent(data) ```