Progress: Documentation

This commit is contained in:
Jeremiah Billmann
2013-07-29 15:12:54 -04:00
parent 3c6129cde9
commit b2c4bf209b
+5 -1
View File
@@ -122,23 +122,26 @@ options.onPlayerConnect(callback)
```
Once the client has made a connection to the server, this event will fire.
`callback` function
Function to be invoked upon event firing.
```js
options.onPlayerDisconnect(callback)
```
If client has has disconnected from the server, this event will fire.
`callback` function
Function to be invoked upon event firing.
```js
options.onPlayerReconnect(callback)
```
If client has has disconnects and reconnects to the server, this event will fire.
`callback` function
Function to be invoked upon event firing.
```js
options.onPlayerUpdate(callback(state))
```
**callback**
Type: function
Function to be invoked upon event firing.
**state**
Type: object literal
@@ -148,6 +151,7 @@ options.onEntityUpdate(callback(state))
**callback**
Type: function
Function to be invoked upon event firing.
**state**
Type: object literal