Class UpdatePlayerOptions#

PlayerDataObject to update on a given PlayerUpdateRequest.

Used in conjunction with UpdatePlayerAsync(String, String, UpdatePlayerOptions).

Namespace: Unity.Services.Lobbies#

Syntax#

public class UpdatePlayerOptions

Properties#

AllocationId#

An ID that associates this player in this lobby with a persistent connection. When a disconnect notification is received, this value is used to identify the associated player in a lobby to mark them as disconnected.

Declaration#

public string AllocationId { get; set; }

Property Value#

ConnectionInfo#

Connection information for connecting to a relay with this player.

Declaration#

public string ConnectionInfo { get; set; }

Property Value#

Data#

Custom game-specific properties to add, update or remove from the player (for example, role or skill).

Declaration#

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

Property Value#

Remarks#

To remove an existing player data, include it in Data but set property object to null.
To update the value to null, set the Value of the player data object to null.

Examples#

To add a colour player data

var redColourPlayerData = new PlayerDataObject(VisibilityOptions.Public, "red")
var data = new Dictionary<string, PlayerDataObject> { ["colour"] = redColourPlayerData };
LobbyService.Instance.UpdatePlayerAsync("lobbyId", "playerId", data);

To update the colour player data to null

var nullPlayerDataObject = new PlayerDataObject(VisibilityOptions.Public, null)
var data = new Dictionary<string, PlayerDataObject> { ["colour"] = nullPlayerDataObject };
LobbyService.Instance.UpdatePlayerAsync("lobbyId", "playerId", data);

To remove the colour player data

var data = new Dictionary<string, PlayerDataObject> { ["colour"] = null };
LobbyService.Instance.UpdatePlayerAsync("lobbyId", "playerId", data);

See Also#