Documentation...

This commit is contained in:
Jeremiah Billmann
2013-07-22 20:02:20 -04:00
parent bd58ae5d4a
commit 90f76bc5c0
2 changed files with 23 additions and 23 deletions
+16 -16
View File
@@ -1,25 +1,25 @@
/*
options = {
onPlayerConnect: function()
onPlayerDisconnect: function (),
onPlayerReconnect: function (),
onPlayerUpdate: function (state),
onEntityUpdate: function (state),
onPlayerRemove: function (id),
onEntityRemove: function (id),
onEvent: function (data),
onWorldState: function (state),
onPing: function (pingDelay),
onUpdatePlayerPhysics: function (state, inputs, deltaTime),
onInterpolation: function(previousState, targetState, amount)
onReady: function (),
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)),
onUpdatePlayerPhysics(callback(state, inputs, deltaTime)),
onInterpolation(callback(previousState, targetState, amount)),
onReady(callback,
logging: true
}
api methods
initializeGarageServer(path, options)
addInput({})
getStates(function (playerStates: [{state}], entityStates: [{state})])
getId() : 'playerid'
addInput(input)
getStates(callback([player1State, player2State, ...], [entity1State, entity2State, ...]))
getId() : playerid
sendServerEvent(data)
*/
var GarageServerIO = (function (socketio) {
+7 -7
View File
@@ -12,18 +12,18 @@ options = {
maxUpdateBuffer: 120,
maxHistorySecondBuffer: 1000,
worldState: {},
onPlayerConnect: function (socket),
onPlayerInput: function (socket, input),
onPlayerDisconnect: function (socket),
onPing: function (socket, data),
onEvent: function (data)
onPlayerConnect(callback(socket)),
onPlayerInput(callback(socket, input)),
onPlayerDisconnect(callback(socket)),
onPing(callback(socket, data)),
onEvent(callback(data))
}
api methods
createGarageServer(io, options)
start()
stop()
getPlayers() : [{ id: '', state: {}, inputs: [{}], stateHistory: [{ state, executionTime }] }]
getEntities() : [{ id: '', state: {}, stateHistory: [{ state, executionTime }] }]
getPlayers() : [{ id, state, [input1, input2,...], [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
getEntities() : [{ id, state, [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
updatePlayerState(id, state)
updateEntityState(id, state)
addEntity(id)