Component image 
VRIKAvatar component as seen in the Scene Inspector
The VRIKAvatar component is used to drive and control the VRIK component on an Avatar.
Fields
| Name | Type | Description |
|---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't. |
IK
|
VRIK | The VRIK to control. |
HeightCompensation
|
Float | How much to scale up or down the user's avatar compared to the tracking points. Think a multiplier to avatar scale vs user root. |
AvatarHeight
|
Float | The height of the avatar from floor to eyes in meters. |
UserResizeThreshold
|
Float | How much the user has to be different from original scale in percentage before prompting to reset scale. |
FeetIgnoreOtherPlayers
|
Bool | Whether feet raycasts ignore other users. |
FeetCollisionListMode
|
ListFilterMode | The mode to use for feet raycasting whitelist/blacklist. |
FeetCollisionList
|
list of Slot | The list of items to filter to/from raycasting according to FeetCollisionListMode
|
HeadMaxFixDistance
|
Float | The maximum distance to allow fixing head position due to bad IK. |
ForceUseFeetProxies
|
Bool | Whether to force the use of Feet proxy/tracker objects. |
ForceUsePelvisProxy
|
Bool | Whether to force the use of Pelvis proxy/tracker objects. |
ForceUseChestProxy
|
Bool | Whether to force the use of Chest proxy/tracker objects. |
ForceUseElbowProxies
|
Bool | Whether to force the use of Elbow proxy/tracker objects. |
ForceUseKneeProxies
|
Bool | Whether to force the use of Knee proxy/tracker objects. |
FeetCalibrated
|
Bool | Whether or not the feet are calibrated. |
PelvisCalibrated
|
Bool | Whether or not the pelvis is calibrated. |
GroundCheckHeightRatio
|
Float | How far to check compared to user height for the floor (unused) |
FeetHoverHeight
|
Float | The height at which feet should hover in either up or down from rest position when off the floor. |
FeetHoverSmoothSpeed
|
Float | How much to smooth the feet movement when hovering. |
MinFeetTransitionSpeed
|
Float | The minimum speed at random to transition to different modes. |
MaxFeetTransitionSpeed
|
Float | The maximum speed at random to transition to different modes. |
GaitFeetTransitionSpeedMultiplier
|
Float | How much to multiply the user's speed to determine the gait speed. |
FeetHoverTilt
|
Float | How much to tilt the feet when hovering. |
LeftFootFloatOffset
|
Float3 | How much to offset the left foot when starting hovering. |
RightFootFloatOffset
|
Float3 | How much to offset the right foot when starting hovering. |
LeftFootRootHeight
|
Float | How much to move up the left foot when starting hovering. |
RightFootRootHeight
|
Float | How much to move up the right foot when starting hovering. |
FootFloatSpeed
|
Float | How fast the feet should move when hovering. |
FootFloatAngleMagnitude
|
Float | How much the feet angle should change when hovering. |
FootFloatOffsetMagnitude
|
Float | How much the feet should wander from avatar center when hovering. |
FeetFloatVelocityForce
|
Float | How much velocity to apply to the feet hovering simulation when moving. |
FeetFloatVelocityDampeningSpeed
|
Float | How much to dampen velocity over time for the feet hovering simulation. |
MaxFeetVelocityOffset
|
Float | The maximum amount that the feet can wander from avatar center. |
VelocityAverageRate
|
Float | The average amount of velocity the user has while moving in user transform space. |
HoverVelocityThreshold
|
Float | The threshold for velocity the user needs to be to be hovering. |
HorizontalBodyAngle
|
Float | The angle required for the user to be considered horizontal for their hips. |
SupressWalkAnimationWhenHorizontal
|
Bool | Whether or not to suppress the walking animation when the user is horizontal. |
AlwaysUseTrackersWhenHorizontal
|
Bool | Whether or not to always override and use trackers when the user is horizontal. |
Gaits
|
list of Gait | A list of gaits to use when moving (Now is unused). |
GaitTransitionSpeed
|
Float | How fast to transition between different gaits (Now is unused). |
GaitMovementDirectionSmoothSpeed
|
Float | How much to smooth the gait feet movement direction (Now is unused). |
RigCollidersRadiusRatio
|
Float | The ratio between the avatar limb length and collider radius sizes. |
LeftHandRotationOffset
|
FloatQ | The offset for the left hand rotation versus controller rotation. |
RightHandRotationOffset
|
FloatQ | The offset for the right hand rotation versus controller rotation. |
CurrentAverageVelocity
|
raw output of Float | The average amount of velocity the user has while moving in user transform space. |
CurrentOnGround
|
raw output of Bool | Whether or not the user is currently is on the ground. |
CurrentGaitIndex
|
raw output of Int | The current walk animation the user is using (Now is unused). |
_locomotionController
|
LocomotionController | The current locomotion module the user is using. |
_leftHandNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the left hand. |
_rightHandNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the right hand. |
_leftElbowNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the left elbow. |
_rightElbowNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the right elbow. |
_leftFootNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the left foot. |
_rightFootNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the right foot. |
_leftKneeNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the left knee. |
_rightKneeNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the right knee. |
_headNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the head. |
_pelvisNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the pelvis. |
_chestNode
|
AvatarPoseNode | The avatar pose node for posing/IK for the chest. |
_headProxy
|
Slot | The proxy slot for the head. |
_pelvisProxy
|
Slot | The proxy slot for the pelvis. |
_chestProxy
|
Slot | The proxy slot for the chest. |
_leftHandProxy
|
Slot | The proxy slot for the left hand. |
_rightHandProxy
|
Slot | The proxy slot for the right hand. |
_leftElbowProxy
|
Slot | The proxy slot for the left elbow. |
_rightElbowProxy
|
Slot | The proxy slot for the right elbow. |
_leftFootProxy
|
Slot | The proxy slot for the left foot. |
_rightFootProxy
|
Slot | The proxy slot for the right foot. |
_leftKneeProxy
|
Slot | The proxy slot for the left knee. |
_rightKneeProxy
|
Slot | The proxy slot for the right knee. |
_leftKneeDefaultProxy
|
Slot | The default proxy slot for the left knee. |
_rightKneeDefaultProxy
|
Slot | The default proxy slot for the right knee. |
_headTargetPos
|
field drive of Float3 | The field to drive for the head position. |
_headTargetRot
|
field drive of FloatQ | The field to drive for the head rotation. |
_pelvisTargetPos
|
field drive of Float3 | The field to drive for the pelvis position. |
_pelvisTargetRot
|
field drive of FloatQ | The field to drive for the pelvis rotation. |
_chestTargetPos
|
field drive of Float3 | The field to drive for the chest position. |
_leftHandTargetPos
|
field drive of Float3 | The field to drive for the left hand position. |
_leftHandTargetRot
|
field drive of FloatQ | The field to drive for the left hand rotation. |
_rightHandTargetPos
|
field drive of Float3 | The field to drive for the right hand position. |
_rightHandTargetRot
|
field drive of FloatQ | The field to drive for the right hand rotation. |
_leftElbowTargetPos
|
field drive of Float3 | The field to drive for the left elbow position. |
_rightElbowTargetPos
|
field drive of Float3 | The field to drive for the left elbow position. |
_leftFootTargetPos
|
field drive of Float3 | The field to drive for the left foot position. |
_leftFootTargetRot
|
field drive of FloatQ | The field to drive for the left foot rotation. |
_rightFootTargetPos
|
field drive of Float3 | The field to drive for the right foot position. |
_rightFootTargetRot
|
field drive of FloatQ | The field to drive for the right foot position. |
_leftKneeTargetPos
|
field drive of Float3 | The field to drive for the left knee position. |
_rightKneeTargetPos
|
field drive of Float3 | The field to drive for the right knee position. |
_pelvisPositionWeight
|
field drive of Float | The field to drive for the pelvis position weight. |
_pelvisRotationWeight
|
field drive of Float | The field to drive for the pelvis rotation weight. |
_chestWeight
|
field drive of Float | The field to drive for the chest weight. |
_locomotionWeight
|
field drive of Float | The field to drive for the locomotion weight. |
_leftLegPositionWeight
|
field drive of Float | The field to drive for the left leg position weight. |
_leftLegRotationWeight
|
field drive of Float | The field to drive for the left leg rotation weight. |
_rightLegPositionWeight
|
field drive of Float | The field to drive for the right leg position weight. |
_rightLegRotationWeight
|
field drive of Float | The field to drive for the right leg rotation weight. |
_leftKneeBendWeight
|
field drive of Float | The field to drive for the left knee bend weight. |
_rightKneeBendWeight
|
field drive of Float | The field to drive for the right knee bend weight. |
_leftElbowBendWeight
|
field drive of Float | The field to drive for the left elbow bend weight. |
_rightElbowBendWeight
|
field drive of Float | The field to drive for the right elbow bend weight. |
_leftFootOffset
|
field drive of Float3 | The field to drive for the left foot bend weight. |
_rightFootOffset
|
field drive of Float3 | The field to drive for the right foot bend weight. |
_leftFootRelativeToRoot
|
FloatQ | The rotation of the left foot relative to the character root. |
_rightFootRelativeToRoot
|
FloatQ | The rotation of the right foot to the character root. |
_locomotionOffset
|
field drive of Float3 | The field to drive with the locomotion offset. |
_simplifiedColliderEnabled
|
field drive of Bool | The field to drive with the simplified collider hit box. |
_rigCollidersEnabledStates
|
list of FieldDrive`1<Bool> | The field list to drive with all the complex rig collider enabled states. |
_horizontalTrackingLocked
|
Bool | Whether or not the horizontal rig tracking is locked. |
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
FilterAvatarHeadPose()
|
AvatarHeadPoseFilter | ✓ | Used in a transform override component on the user's head to prevent the view from rotating when it's being simulated by the locomotion system |
Gait
This part of the system is no longer used, so documentation may be inaccurate, but there is no longer a way to test this system anymore.
| Name | Type | Description |
|---|---|---|
MinimumVelocity
|
float | The minimum velocity required for this gait to take effect. |
FeetRange
|
float2 | The range in which the feet will attempt steps. |
CycleHeightBias
|
float | The amount the feet will be biased to step upwards for step height. |
CycleFeetSeparation
|
float | How much to separate the feet from each other during the cycle. |
CycleGroundRatio
|
float | The amount the feet will take into account the ground for the step height. |
FootRaiseBeginHeight
|
float | What point the feet should start at for raising for a step. |
FootRaiseEndHeight
|
float | What point the feet should end at for raising for a step. |
FootRestAngle
|
float | The angle the feet should be at for rest. |
FootRaiseAngle
|
float | The angle a foot should be at when making a step. |
FeetAlignmentOffset
|
float | How much to offset for feet alignment. |
SpeedRatio
|
float | How much to speed up the foot at the peak of the step. |
FeetSlipRatio
|
float | How much the feet will slip before taking a step. |
ForwardOffset
|
float | The offset of the feet forwards or backwards. |
Usage
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Examples
Used in avatars.