Class UpdateLobbyOptions#

Parameters to update on a given UpdateLobby request.

Namespace: Unity.Services.Lobbies#

Syntax#

public class UpdateLobbyOptions

Properties#

Data#

Custom game-specific properties to add, update, or remove from the lobby (e.g. mapName or gameType). To remove an existing property, include it in data but set the property object to null. To update the value to null, set the value property of the object to null.

Declaration#

public Dictionary<string, DataObject> Data { get; set; }

Property Value#

HostId#

The ID of the player to make the host of the lobby. As soon as this is updated the current host will no longer have permission to modify the lobby.

Declaration#

public string HostId { get; set; }

Property Value#

IsLocked#

Indicates whether or not the lobby is locked.

Declaration#

public bool? IsLocked { get; set; }

Property Value#

IsPrivate#

Indicates whether or not the lobby is publicly visible and will show up in query results. 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#

public bool? IsPrivate { get; set; }

Property Value#

MaxPlayers#

The maximum number of players allowed in the lobby. Must be greater than or equal to the current number of players in the lobby. Minimum: 1. Maximum: 100.

Declaration#

public int? MaxPlayers { get; set; }

Property Value#

Name#

The name of the lobby that should be displayed to users. All whitespace will be trimmed from the name. Minimum length: 1. Maximum length: 256.

Declaration#

public string Name { get; set; }

Property Value#

Password#

The new password for the target lobby. Updating to empty string "" will remove password protection from the lobby and set HasPassword to false.

Declaration#

public string Password { get; set; }

Property Value#