Skip to content

ARC User (Script Reference)

Giorgio edited this page Jul 7, 2021 · 5 revisions

SWITCH TO MANUAL

Description

Represents a single user in the current session. Controls user movement (both position and rotation) in the session.

Properties

public string username Friendly string for the current user's name.
public Vector3 localCameraPosition If the user is the local client, use this to get the AR Camera position expressed in ARCSession.origin's local space.
public Vector3 localCameraRotation If the user is the local client, use this to get the AR Camera rotation expressed in ARCSession.origin's local space.
public Vector3 localCameraForward If the user is the local client, use this to get the AR Camera forward direction expressed in ARCSession.origin's local space.
public ARCEntity interactingEntity The ARC Entity the current user is interacting with, null otherwise.

Events

For a detailed explanation of events and their usage, see the CaptainsMess dedicated page.

public UnityEvent clientEnterLobby UnityEvent invoked when entering a network lobby.
public UnityEvent clientExitLobby UnityEvent invoked when exiting a network lobby.
public ARCBoolEvent clientReady UnityEvent invoked when the current user's ready status changes.
public UnityEvent gameStarted UnityEvent invoked when the countdown is over and the session starts.
public UnityEvent grabEvent UnityEvent invoked when grabbing an ARC Entity.
public UnityEvent releaseEvent UnityEvent invoked when releasing an ARC Entity.

Public Methods

public void CmdSetUsername(string name) Command. Set the value of variable username.

Clone this wiki locally