Class CreateRequest
The body of a Create Lobby request.
Inherited Members
Namespace: Unity.Services.Lobbies.Models
Syntax
[Preserve]
public class CreateRequest
Constructors
CreateRequest(String, Int32, Nullable<Boolean>, Nullable<Boolean>, Player, Dictionary<String, DataObject>, String)
The body of a Create Lobby request.
Declaration
[Preserve]
public CreateRequest(string name, int maxPlayers, bool? isPrivate = false, bool? isLocked = false, Player player = null, Dictionary<string, DataObject> data = null, string password = null)
Parameters
| Type | Name | Description |
|---|---|---|
| String | name | The name of the lobby that should be displayed to users. All whitespace will be trimmed from the name. |
| Int32 | maxPlayers | The maximum number of players that can be members of the lobby. |
| Nullable<Boolean> | isPrivate | Whether or not the lobby is private. Private lobbies do not appear in query results and cannot be fetched by non-members using the GetLobby API. If the lobby is not publicly visible, the creator can share the |
| Nullable<Boolean> | isLocked | Whether or not the lobby is locked. If true, new players will not be able to join. |
| Player | player | player param |
| Dictionary<String, DataObject> | data | Custom game-specific properties that apply to the lobby (e.g. |
| String | password | The password for this lobby. If specified, the lobby will be created with HasPassword set to true. All joins will be rejected unless provided password matches. |
Properties
Data
Custom game-specific properties that apply to the lobby (e.g. mapName or gameType).
Declaration
[Preserve]
public Dictionary<string, DataObject> Data { get; }
Property Value
| Type | Description |
|---|---|
| Dictionary<String, DataObject> |
IsLocked
Whether or not the lobby is locked. If true, new players will not be able to join.
Declaration
[Preserve]
public bool? IsLocked { get; }
Property Value
| Type | Description |
|---|---|
| Nullable<Boolean> |
IsPrivate
Whether or not the lobby is private. Private lobbies do not appear in query results and cannot be fetched by non-members using the GetLobby API. If the lobby is not publicly visible, the creator can share the lobbyCode with other users who can use it to join this lobby.
Declaration
[Preserve]
public bool? IsPrivate { get; }
Property Value
| Type | Description |
|---|---|
| Nullable<Boolean> |
MaxPlayers
The maximum number of players that can be members of the lobby.
Declaration
[Preserve]
public int MaxPlayers { get; }
Property Value
| Type | Description |
|---|---|
| Int32 |
Name
The name of the lobby that should be displayed to users. All whitespace will be trimmed from the name.
Declaration
[Preserve]
public string Name { get; }
Property Value
| Type | Description |
|---|---|
| String |
Password
The password for this lobby. If specified, the lobby will be created with HasPassword set to true. All joins will be rejected unless provided password matches.
Declaration
[Preserve]
public string Password { get; }
Property Value
| Type | Description |
|---|---|
| String |
Player
Parameter player of CreateRequest
Declaration
[Preserve]
public Player Player { get; }
Property Value
| Type | Description |
|---|---|
| Player |