Player

The AFX system uses standard Unity gaming terminology in referring to users as players. You can use the AFX player nodes to access information about the local user.

Player Body Info

Provides access to information about the local user's virtual body.

Outputs:

Name	Type	Description
Player Game Object Out	Game Object	Game object that's created in ENGAGE for the local user.
Player Transform Out	Transform	Transform for the local user's game object.
Player Collider Out	Collider	Collider that's created in ENGAGE for the local user.

Player Camera Info

Provides access to the local user's camera. Each user has a single camera that defines their view in the session.

Outputs:

Name	Type	Description
Player Camera Out	Camera	Reference to the camera object that determines the local user's view in the environment.
Transform Out	Transform	Transform for the local user's camera.

Player Device Info

Provides access to information about the local user's device.

Outputs:

Name	Type	Description
Is VR Out	Boolean	True if the local user's device is a VR headset. False otherwise.
Is Android Out	Boolean	True if the local user's device has an Android operating system. False otherwise.
Is Desktop Out	Boolean	True if the local user's device is laptop or desktop computer. False otherwise.
Is Headset 6dof Out	Boolean	True if the local user's device tracks 6 degrees of freedom - position and orientation. False otherwise.
Is IOS Out	Boolean	True if the local user's device is an iPhone or iPad. False otherwise.
Is Mac Out	Boolean	True if the local user's device is laptop or desktop computer with a macOS operating system. False otherwise.
Is Phone Out	Boolean	True if the local user's device is a phone or tablet. False otherwise.
Is Windows Out	Boolean	True if the local user's device is laptop or desktop computer with a Microsoft Windows operating system. False otherwise.
Device Name Out	String	The name of the device.

Player Hands Info

Provides access to information about the local user's VR hand controllers, if in use.

Outputs:

Name	Type	Description
Primary Hand Transform Out	Transform	A transform object for the local user's right VR hand controller.
Secondary Hand Transform Out	Transform	A transform object for the local user's left VR hand controller.
Gripped Primary Out	Boolean	True if the grip button on the right hand controller is being held down. False otherwise.
Gripped Secondary Out	Boolean	True if the grip button on the left hand controller is being held down. False otherwise.
Trigger Primary Out	Boolean	True if the trigger button on the right hand controller is being held down. False otherwise.
Trigger Secondary Out	Boolean	True if the trigger button on the left hand controller is being held down. False otherwise.

Player Info

Provides access to information about the local user.

Outputs:

Name	Type	Description
Player Game Object Out	Game Object	Reference to the Unity game object that's created for the local user.
Display Name Out	String	The local user's display name.
Player Height	Integer	The height value set in the local user's profile.
Is Session Host	Boolean	True if the local user is designated as a session host. False otherwise. Multiple users can be assigned as a session host. This value does not indicate whether the user created the current session.
Id	Integer	The local user's player ID.