From 0b2b9fd15b62094cb200ce674ec0998a8659ac82 Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Tue, 30 Jul 2013 21:26:30 -0400 Subject: [PATCH] Progress: Documentation --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 301fd3c..2b7dcb5 100644 --- a/README.md +++ b/README.md @@ -340,30 +340,35 @@ options.stateInterval ``` **number** The amount, in milliseconds, that state is broadcasted to clients. + --- ```js options.logging ``` **boolean** Enable console logging of all the events occuring within the GarageServer.IO server. + --- ```js options.clientSidePrediction ``` **boolean** Enables client side prediction and callback on the client. + --- ```js options.interpolation ``` **boolean** Enables interpolation and callback on the client. + --- ```js options.interpolationDelay ``` **number** The amount, in milliseconds, that state is rendered to the client behind actual server time. + --- ```js options.smoothingFactor @@ -376,18 +381,21 @@ options.pingInterval ``` **number** The amount, in milliseconds, that a ping is made to the server to test for latency. + --- ```js options.maxUpdateBuffer ``` **number** The maximum amount of broadcasted state updates to store on the client for each player and entity. + --- ```js options.maxHistorySecondBuffer ``` **number** The amount, in milliseconds, that a ping is made to the server to test for latency. + --- ```js options.worldState