Class Player

An object representing a single player.

Inheritance

object

Player

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Matchmaker.Models

Assembly: Unity.Services.Multiplayer.dll

Syntax

[Preserve]
[DataContract(Name = "Player")]
public class Player

Constructors

Player(string, object, List<QosResult>)

An object representing a single player.

Declaration

[Preserve]
public Player(string id, object customData = null, List<QosResult> qosResults = null)

Parameters

Type	Name	Description
string	id	The unique ID of the player. Usually, the ID received as a result of authenticating a player.
object	customData	A custom data object. Contains a dictionary of custom data to be used by the rules defined in a Match Definition.
List<QosResult>	qosResults	A list of QosResult.

Properties

CustomData

A custom data object. Contains a dictionary of custom data to be used by the rules defined in a Match Definition.

Declaration

[Preserve]
[JsonConverter(typeof(JsonObjectConverter))]
[DataMember(Name = "customData", EmitDefaultValue = false)]
public IDeserializable CustomData { get; }

Property Value

Type	Description
IDeserializable

Id

The unique ID of the player. Usually, the ID received as a result of authenticating a player.

Declaration

[Preserve]
[DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)]
public string Id { get; }

Property Value

Type	Description
string

QosResults

A list of QosResult.

Declaration

[Preserve]
[DataMember(Name = "qosResults", EmitDefaultValue = false)]
public List<QosResult> QosResults { get; }

Property Value

Type	Description
List<QosResult>