Struct ARParticipantsChangedEventArgs

Event arguments for the participantsChanged event.

Namespace: UnityEngine.XR.ARFoundation

Syntax

public struct ARParticipantsChangedEventArgs : IEquatable<ARParticipantsChangedEventArgs>

Constructors

ARParticipantsChangedEventArgs(List<ARParticipant>, List<ARParticipant>, List<ARParticipant>)

Constructs an ARParticipantsChangedEventArgs.

Declaration

public ARParticipantsChangedEventArgs(List<ARParticipant> added, List<ARParticipant> updated, List<ARParticipant> removed)

Parameters

Type	Name	Description
List<ARParticipant>	added	The list of ARParticipants added since the last event.
List<ARParticipant>	updated	The list of ARParticipants updated since the last event.
List<ARParticipant>	removed	The list of ARParticipants removed since the last event.

Properties

added

The list of ARParticipants added since the last event.

Declaration

public List<ARParticipant> added { readonly get; }

Property Value

Type	Description
List<ARParticipant>

removed

The list of ARParticipants removed since the last event.

Declaration

public List<ARParticipant> removed { readonly get; }

Property Value

Type	Description
List<ARParticipant>

updated

The list of ARParticipants udpated since the last event.

Declaration

public List<ARParticipant> updated { readonly get; }

Property Value

Type	Description
List<ARParticipant>

Methods

Equals(Object)

Tests for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare against.

Returns

Type	Description
Boolean	True if obj is of type ARParticipantsChangedEventArgs and Equals(ARParticipantsChangedEventArgs) also returns true; otherwise false.

Overrides

ValueType.Equals(Object)

Equals(ARParticipantsChangedEventArgs)

Tests for equality.

Declaration

public bool Equals(ARParticipantsChangedEventArgs other)

Parameters

Type	Name	Description
ARParticipantsChangedEventArgs	other	The other ARParticipantsChangedEventArgs to compare against.

Returns

Type	Description
Boolean	true if other is equal to this ARParticipantsChangedEventArgs.

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

ToString()

Generates a string suitable for debugging. The string contains the number of added, updated, and removed participants.

Declaration

public override string ToString()

Returns

Type	Description
String	A string suitable for debug logging.

Overrides

ValueType.ToString()

Operators

Equality(ARParticipantsChangedEventArgs, ARParticipantsChangedEventArgs)

Tests for equality. Same as Equals(ARParticipantsChangedEventArgs).

Declaration

public static bool operator ==(ARParticipantsChangedEventArgs lhs, ARParticipantsChangedEventArgs rhs)

Parameters

Type	Name	Description
ARParticipantsChangedEventArgs	lhs	The left-hand side of the comparison.
ARParticipantsChangedEventArgs	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	true if lhs is equal to rhs.

Inequality(ARParticipantsChangedEventArgs, ARParticipantsChangedEventArgs)

Tests for inequality. Same as !Equals(ARParticipantsChangedEventArgs).

Declaration

public static bool operator !=(ARParticipantsChangedEventArgs lhs, ARParticipantsChangedEventArgs rhs)

Parameters

Type	Name	Description
ARParticipantsChangedEventArgs	lhs	The left-hand side of the comparison.
ARParticipantsChangedEventArgs	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	true if lhs is not equal to rhs.