SysCreateLobbyWithConfigAndPingData

Creates an instance of a lobby with a per-instance configuration override and the given ping data. Currently supports overriding the standard lobby type's team definitions. Will return the newly created lobby id in the event of a successful creation.

Service	Operation
lobby	SYS_CREATE_LOBBY_WITH_CONFIG_AND_PING_DATA

Method Parameters

Parameter	Description
ownerCxId	The cx of the lobby instance owner.
lobbyType	The type of lobby to look for. Lobby types are defined in the portal.
rating	The skill rating to use for finding the lobby. Provided as a separate parameter because it may not exactly match the user's rating (especially in cases where parties are involved).
otherUserCxIds	Array of other users (i.e. party members) to add to the lobby as well. Will constrain things so that only lobbies with room for all players will be considered.
settings	Owner settings for this lobby.
isReady	Initial ready-status of this user.
extraJson	Initial extra-data about this user.
teamCode	Preferred team for this user, if applicable. Send "" or null for automatic assignment.
configOverrides	Per-instance configuration overrides applied on top of the standard lobby type. Currently supports teams (a complete replacement list of team definitions: code, minUsers, maxUsers, autoAssign).
pingData	Ping times for each region available for this lobby type. Can use GET_REGIONS_FOR_LOBBIES to retrieve the list of regions for a given lobby type.

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Obj-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

// Cloud Code only. To view example, switch to the Cloud Code tab

GDScript

N/A

Cloud Code

var ownerCxId = "55555:aaa-bbb-ccc-ddd:asdfasdfa";
var lobbyType = "4v4";
var rating = 76;
var otherUserCxIds = [
    "55555:aaa-bbb-ccc-eee:asdfjkl"
];
var settings = {};
var isReady = False;
var extraJson = {};
var teamCode = "reserved";
var configOverrides = {
    "teams": [
        {
            "code": "reserved",
            "minUsers": 0,
            "maxUsers": 1,
            "autoAssign": false
        },
        {
            "code": "all",
            "minUsers": 6,
            "maxUsers": 6,
            "autoAssign": true
        }
    ]
};
var pingData = {
    "ca-central-1": 98,
    "us-west-1": 123
};
var lobbyProxy = bridge.getLobbyServiceProxy();

var postResult = lobbyProxy.sysCreateLobbyWithConfigAndPingData(ownerCxId, lobbyType, rating, otherUserCxIds, settings, isReady, extraJson, teamCode, configOverrides, pingData);

Raw

{
    "service":"lobby",
    "operation":"SYS_CREATE_LOBBY_WITH_CONFIG_AND_PING_DATA",
    "data":{
        "ownerCxId":"55555:aaa-bbb-ccc-ddd:asdfasdfa",
        "lobbyType":"4v4",
        "rating":76,
        "otherUserCxIds":[
            "55555:aaa-bbb-ccc-eee:asdfjkl"
        ],
        "settings":{},
        "isReady":false,
        "extraJson":{},
        "teamCode":"reserved",
        "configOverrides":{
            "teams":[
                {
                    "code":"reserved",
                    "minUsers":0,
                    "maxUsers":1,
                    "autoAssign":false
                },
                {
                    "code":"all",
                    "minUsers":6,
                    "maxUsers":6,
                    "autoAssign":true
                }
            ]
        },
        "pingData":{
            "ca-central-1":98,
            "us-west-1":123
        }
    }
}

JSON Response

{
  "data": {
    "lobbyId": "23782:Relay_lobbyT_v2:1"
  },
  "status": 200
}