mirror of
https://github.com/wassname/GarageServer.IO.git
synced 2026-06-27 16:10:34 +08:00
Documentation...
This commit is contained in:
+16
-16
@@ -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) {
|
||||
|
||||
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user