ReadonlyapiGeneric object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.
If disabled, the Component will stop enacting its behavior.
ReadonlysceneThe scene object this component is on.
ReadonlyuniqueGet how far the SceneObject will be from the user.
Set how far the SceneObject will be from the user.
Get if the SceneObject will follow when the user moves their head along the pitch-axis (looking up/down)
Set if the SceneObject will follow when the user moves their head along the pitch-axis (looking up/down)
Get if the SceneObject will follow when the user moves their head along the yaw-axis (looking left/right)
Set if the SceneObject will follow when the user moves their head along the yaw-axis (looking left/right)
Get how many degrees of leeway along each direction (up/down) before change starts to occur.
Set how many degrees of leeway along each direction (up/down) before change starts to occur.
Get how fast the SceneObject will follow along the pitch-axis, 0.1 for delayed follow, 1 for instant follow.
Set how fast the SceneObject will follow along the pitch-axis, 0.1 for delayed follow, 1 for instant follow.
Get how many degrees of offset from the center point should the target sit. Positive values place the element below the center.
Set how many degrees of offset from the center point should the target sit. Positive values place the element below the center.
Get the magnitude of change (in centimeters) needed to activate a translation for the target to follow the user's head translation.
Set the magnitude of change (in centimeters) needed to activate a translation for the target to follow the user's head translation. To keep the SceneObject from 'wobbling' when the user has an unstable head, a small buffer is recommended rather than 0.
Get how fast the SceneObject will follow along the XZ-plane, 0.1 for delayed follow, 1 for instant follow.
Set how fast the SceneObject will follow along the XZ-plane, 0.1 for delayed follow, 1 for instant follow.
Get if the SceneObject will follow when the user moves their head along XZ-plane. For most cases, this should stay enabled.
Sets if the SceneObject will follow when the user moves their head along XZ-plane. For most cases, this should stay enabled.
Get how many degrees of leeway along each direction (left/right) before change starts to occur.
Set how many degrees of leeway along each direction (left/right) before change starts to occur.
Get how fast the SceneObject will follow along the yaw-axis, 0.1 for delayed follow, 1 for instant follow.
Set how fast the SceneObject will follow along the yaw-axis, 0.1 for delayed follow, 1 for instant follow.
Get how many degrees of offset from the center point should the target sit. Positive values place the element to the left.
Set how many degrees of offset from the center point should the target sit. Positive values place the element to the left.
Get how fast the SceneObject will follow along the Y-axis, 0.1 for delayed follow, 1 for instant follow.
Set how fast the SceneObject will follow along the Y-axis, 0.1 for delayed follow, 1 for instant follow.
Get if the SceneObject will follow when the user moves their head along Y-axis. For most cases, this should stay enabled.
Set if the SceneObject will follow when the user moves their head along Y-axis. For most cases, this should stay enabled.
Adds a new SceneEvent, triggered by eventType events, to the ScriptComponent.
Destroys the component.
Returns the SceneObject the component is attached to.
Returns the Transform this component is attached to.
StaticgetReturns the name of this object's type.
Returns true if the object matches or derives from the passed in type.
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Removes a previously added SceneEvent from the ScriptComponent.
Snaps the object to its exact desired position, regardless of easing, unlocks, buffers, etc. Should be used after modifying values that affect the desired position (such as offset, distance) to snap the object into place without having a strange path.
This class provides functionality to position a SceneObject relative to the user's head movements. It allows configuration of distance, translation, and rotation settings to control how the SceneObject follows or stays fixed as the user moves their head. This creates a balanced experience between head-locked objects (which move with the head) and world-space objects (which stay fixed in the environment).