Interface MultiPlayerServerOptions

Options to configure a MultiPlayerServer

MultiPlayerServerOptions

interface MultiPlayerServerOptions {
    httpServer: any;
    inputHandler?: MultiPlayerInputHandler;
    newPlayerObject: GameObjectBuilder;
    onDisconnect: Function;
    onNewConnection: ((socket) => string);
    onNewPlayer: ((socket, id, data) => [GameObject, string] | Promise<[GameObject, string]>);
    port: number;
    sceneManager: MultiPlayerSceneManager;
    serverLive?: Function;
    tickSpeed?: number;
}

Properties

httpServer inputHandler? newPlayerObject onDisconnect onNewConnection onNewPlayer port sceneManager serverLive? tickSpeed?

Properties

httpServer

httpServer: any

HTTP server to run the server on

Optional inputHandler

inputHandler?: MultiPlayerInputHandler

MultiPlayerInputHandler to use

newPlayerObject

newPlayerObject: GameObjectBuilder

GameObject to use for new players

onDisconnect

onDisconnect: Function

Function to run when a connection is lost

onNewConnection

onNewConnection: ((socket) => string)

Function to run when a new connection is made. Should return a label to assign to the connection. If no lable is returned, one is automatically generated

Type declaration

    • (socket): string

    • Function to run when a new connection is made. Should return a label to assign to the connection. If no lable is returned, one is automatically generated

      Parameters

      • socket: any

      Returns string

onNewPlayer

onNewPlayer: ((socket, id, data) => [GameObject, string] | Promise<[GameObject, string]>)

Function to run when a new player joins

Type declaration

    • (socket, id, data): [GameObject, string] | Promise<[GameObject, string]>

    • Function to run when a new player joins

      Parameters

      • socket: any
      • id: string
      • data: object

      Returns [GameObject, string] | Promise<[GameObject, string]>

port

port: number

Port to run the server on

sceneManager

sceneManager: MultiPlayerSceneManager

MultiPlayerSceneManager to use

Optional serverLive

serverLive?: Function

Function to run when the server is live

Optional tickSpeed

tickSpeed?: number

How often to update the scene (in milliseconds)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc