mooball
    Preparing search index...

    Interface SetRoomPropertiesParams

    interface SetRoomPropertiesParams {
        fakePassword?: boolean | null;
        geo?: GeoLocation;
        maxPlayerCount?: number;
        name?: string;
        password?: string | null;
        playerCount?: number | null;
        showInRoomList?: boolean;
        unlimitedPlayerCount?: boolean;
    }
    Index

    Properties

    fakePassword? geo? maxPlayerCount? name? password? playerCount? showInRoomList? unlimitedPlayerCount?

    Properties

    fakePassword?: boolean | null

    If set to a boolean, this will be sent as the room's current password status, and shown in the room list. false means your room in fact might have a password, but it shows in the room list like it does not have a password; and vice versa. Set to null to disable this behavior.

    geo?: GeoLocation

    The new GeoLocation of the room. This value will be shown in the room list.

    maxPlayerCount?: number

    The new maximum number of players in the room. This value will be shown in the room list.

    name?: string

    The new name of the room. This will also update the room's name in the room list.

    password?: string | null

    The new password of the room. If null, clears the password. This will also update the room's password status in the room list.

    playerCount?: number | null

    The number of players in the room. This value will be shown in the room list, and be fixed, i.e. it will not change when new players join or leave the room. Set to null to disable this behavior.

    showInRoomList?: boolean

    Changes whether to send room info to the room list backend server or not.

    unlimitedPlayerCount?: boolean

    If set, disables the player count check while players are joining your room.

    Settings

    Member Visibility

    On This Page

    Properties