Scripting

Methods

ScaleAvatarToTracking() resizes the avatar to match the player size.
SetPlayerHeight(float height) manually sets the height of the player.
ScaleTrackingToAvatar() scales the tracking input to match the size of the avatar.
SetTrackingHeightToAvatar() changes the tracking height to match the size of the avatar. Tracking is not scaled. The Y values are adjusted instead. This is useful for changing from standing to sitting position.
MoveTrackingHeightToAvatar() changes the tracking height in the same way as SetTrackingHeightToAvatar() but also moves the tracking origin to the location of the avatar instead of moving the avatar to the location of the player.
Calibrate() resets the avatar according to the Scaling setting and tracking information
Avatar
ChangeAvatar(GameObject avatarPrefab) Changes the avatar including remote avatars to the given avatarPrefab.
ChangeAvatar(GameObject fpAvatarPrefab, GameObject tpAvatarPrefab) Changes the avatar. The local avatar will be set to the fpAvatarPrefab remote avatars will be set to the tpAvatarPrefab.
LocalChangeAvatar(GameObject avatarPrefab) Changes only the local avatar to the given avatarPrefab.
Animator GetAvatar() returns the avatar Animator of the local avatar.
Movement
MoveForward(float z) moves the avatar forward or backward with velocity z.
MoveSideward(float x) moves the avatar sidewards (strafing) with velocity x.
Move(Vector3 v) moves the avatar according to the velocity vector v.
Rotate(float angularSpeed) rotates the avatar with angular velocity angularSpeed
Dash(Vector3 targetPosition) quickly moves the avatar from its current position to the targetPosition.
Teleport(Vector3 targetPosition) instantly changes the position to the targetPosition.
TeleportForward(float distance = 1) teleports the avatar in the forward direction of the body with a default distance of 1.
MoveTo(Vector3 position, MovementType movementType = MovementType.Teleport) either teleports or dashes to the position based on the movementType.