@game-vir/multiplayer - v15.1.1
    Preparing search index...

    Type Alias MultiplayerParams

    Multiplayer mode parameters for MultiplayerController.

    type MultiplayerParams = {
        backendOrigin: string;
        portScanOptions?: Parameters<typeof mapServiceDevPort>[1] | boolean;
        roomUpdateInterval?: AnyDuration;
        stunServerUrls?: ReadonlyArray<string>;
    }
    Index

    Properties

    backendOrigin portScanOptions? roomUpdateInterval? stunServerUrls?

    Properties

    backendOrigin: string

    The origin of the server running the multiplayer connection service.

    'http://localhost:3000'
    portScanOptions?: Parameters<typeof mapServiceDevPort>[1] | boolean

    Set to undefined or false to disable port scanning. Set to true to enable port scanning. Set to an options object to configure port scanning.

    It is useful to enable this so that clients can find the port that your multiplayer server is running on in case it must change. Note that port scanning will not be active if your serviceOrigin does not contain a port.

    undefined
    roomUpdateInterval?: AnyDuration

    How long to wait before fetching the list of rooms again.

    {seconds: 10}
    stunServerUrls?: ReadonlyArray<string>

    Optional stun server URLs to help with routing WebRTC connections. This is entirely optional, but might help with clients attempting to establish connections to each other.

    Settings

    Member Visibility

    On This Page

    Properties