Class UpdatePlayerOptions

Paramters to update on a given UpdatePlayer request.

Inheritance

Object

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

Type	Description
String

ConnectionInfo

Connection information for connecting to a relay with this player.

Declaration

public string ConnectionInfo { get; set; }

Property Value

Type	Description
String

Data

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

Declaration

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

Property Value

Type	Description
Dictionary<String, PlayerDataObject>