From b2c4bf209ba74572040a4824da8eeeaaba88fc6b Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Mon, 29 Jul 2013 15:12:54 -0400 Subject: [PATCH] Progress: Documentation --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2daa93b..554b7dd 100644 --- a/README.md +++ b/README.md @@ -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