Class Player#

Information about a specific player creating, joining, or already in a lobby.

Namespace: Unity.Services.Lobbies.Models#

Syntax#

public class Player

Constructors#

Player(String, String, Dictionary<String, PlayerDataObject>, String, DateTime, DateTime, PlayerProfile)#

Information about a specific player creating, joining, or already in a lobby.

Declaration#

public Player(string id = null, string connectionInfo = null, Dictionary<string, PlayerDataObject> data = null, string allocationId = null, DateTime joined = default(DateTime), DateTime lastUpdated = default(DateTime), PlayerProfile profile = null)

Parameters#

Properties#

AllocationId#

The allocationId from the Relay service which 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; }

Property Value#

ConnectionInfo#

Connection information for connecting to a relay with this player.

Declaration#

public string ConnectionInfo { get; }

Property Value#

Data#

Custom game-specific properties that apply to an individual player (e.g. role or skill).

Declaration#

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

Property Value#

Id#

The unique identifier for the player. If not provided for a create or join request, it will be set to the ID of the caller.

Declaration#

public string Id { get; }

Property Value#

Joined#

The time at which the player joined the lobby.

Declaration#

public DateTime Joined { get; set; }

Property Value#

LastUpdated#

The last time the metadata for this player was updated.

Declaration#

public DateTime LastUpdated { get; set; }

Property Value#

Profile#

Parameter profile of Player

Declaration#

public PlayerProfile Profile { get; set; }

Property Value#