mooball
    Preparing search index...

    Class LibConfig

    Custom configuration for backend/proxy server.

    Index

    Constructors

    constructor

    Properties

    backend? identityToken? noVariableValueChangeEvent? proxy? proxyAgent? stunServer? version?

    Constructors

    Properties

    backend?: { hostname?: string; hostnameWs?: string; secure?: boolean }

    Custom backend configuration.

    Type Declaration

    • Optionalhostname?: string

      Backend's main domain url address. Defaults to: moo-hoo.com/mooball.

    • OptionalhostnameWs?: string

      Backend's url address for websocket connections. Defaults to: moo-hoo.com/mooball.

    • Optionalsecure?: boolean

      Determines whether the url is using secure protocol(true) or not(false). Defaults to: true.

    identityToken?: string

    A token that represents a user data in a database of a custom proxy/backend server.

    noVariableValueChangeEvent?: boolean

    If true, disables the mechanism that enables variable value change event which in turn improves performance while reaching a variable's value that was defined by any Addon.defineVariable function. (Variable will have a directly accessable, actual value; instead of a property that points to the actual variable.) Defaults to: false.

    proxy?: {
        HttpUrl?: string;
        WebSocketChangeOriginAllowed?: boolean;
        WebSocketUrl?: string;
    }

    Proxy server configuration.

    Type Declaration

    • OptionalHttpUrl?: string

      Proxy http url address to use when trying to create or join a room. should end with a /. Is appended host or client at the end while being used. Defaults to: https://moo-hoo.com/mooball/rs/.

    • OptionalWebSocketChangeOriginAllowed?: boolean

      Browsers' websocket libraries do not allow origin change for security reasons, so we need a proxy server to change the websocket request's origin for us. If true, we do not need a proxy server. (we can do that in NW.js, for example)

    • OptionalWebSocketUrl?: string

      Proxy websocket url address to use when trying to create or join a room. should end with a /. Is appended host or client at the end while being used. Defaults to: wss://moo-hoo.com/mooball/.

    proxyAgent?: any

    A custom proxy agent to use for the room's connection. This method does not work in browsers. Defaults to null.

    stunServer?: string

    The url address of an external stun server that is required for the communication via WebRTC to work correctly. Defaults to: stun:stun.l.google.com:19302.

    version?: number

    Mooball's expected version number. Defaults to: 9.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties