Progress: Documentation

This commit is contained in:
Jeremiah Billmann
2013-07-28 21:15:32 -04:00
parent 3b4836a6ba
commit 53db67944f
+15 -18
View File
@@ -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