Class ARParticipantManager

A manager for ARParticipants. Creates, updates, and removes GameObjects in response to other users in a multi-user collaborative session.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>
ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>
ARParticipantManager
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.useGUILayout
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectOfType<T>()
Object.ToString()
Object.name
Object.hideFlags
Namespace: UnityEngine.XR.ARFoundation
Assembly: Unity.XR.ARFoundation.dll
Syntax
[DefaultExecutionOrder(-2147483647)]
[DisallowMultipleComponent]
[RequireComponent(typeof(XROrigin))]
public sealed class ARParticipantManager : ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>

Properties

gameObjectName

The name to be used for the GameObject whenever a new participant is detected.

Declaration
protected override string gameObjectName { get; }
Property Value
Type Description
string
Overrides

participantPrefab

(Optional) Instantiates this Prefab for each participant. If null, an empty GameObject with a ARParticipant component is instantiated instead.

Declaration
public GameObject participantPrefab { get; set; }
Property Value
Type Description
GameObject

Methods

GetParticipant(TrackableId)

Attempt to retrieve an existing ARParticipant by trackableId.

Declaration
public ARParticipant GetParticipant(TrackableId trackableId)
Parameters
Type Name Description
TrackableId trackableId

The TrackableId of the participant to retrieve.
Returns
Type Description
ARParticipant

The ARParticipant with trackableId, or null if it does not exist.

GetPrefab()

The Prefab which will be instantiated for each ARParticipant. Can be null.

Declaration
protected override GameObject GetPrefab()
Returns
Type Description
GameObject

A Prefab to instantiate for each ARParticipant.
Overrides

OnTrackablesChanged(List<ARParticipant>, List<ARParticipant>, List<ARParticipant>)

Invoked when the base class detects trackable changes.

Declaration
protected override void OnTrackablesChanged(List<ARParticipant> added, List<ARParticipant> updated, List<ARParticipant> removed)
Parameters
Type Name Description
List<ARParticipant> added

The list of added ARParticipants.
List<ARParticipant> updated

The list of updated ARParticipants.
List<ARParticipant> removed

The list of removed ARParticipants.
Overrides

Events

participantsChanged

Invoked when participants have changed (been added, updated, or removed).

Declaration
public event Action<ARParticipantsChangedEventArgs> participantsChanged
Event Type
Type Description
Action<ARParticipantsChangedEventArgs>