Component:VRIKAvatar: Difference between revisions

Latest revision as of 21:19, 6 November 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Component image

**VRIKAvatar** component as seen in the Scene Inspector

Fields

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.
`IK`	VRIK
`HeightCompensation`	Float
`AvatarHeight`	Float
`UserResizeThreshold`	Float
`FeetIgnoreOtherPlayers`	Bool
`FeetCollisionListMode`	ListFilterMode
`FeetCollisionList`	list of Slot
`HeadMaxFixDistance`	Float
`ForceUseFeetProxies`	Bool
`ForceUsePelvisProxy`	Bool
`ForceUseChestProxy`	Bool
`ForceUseElbowProxies`	Bool
`ForceUseKneeProxies`	Bool
`FeetCalibrated`	Bool
`PelvisCalibrated`	Bool
`GroundCheckHeightRatio`	Float
`FeetHoverHeight`	Float
`FeetHoverSmoothSpeed`	Float
`MinFeetTransitionSpeed`	Float
`MaxFeetTransitionSpeed`	Float
`GaitFeetTransitionSpeedMultiplier`	Float
`FeetHoverTilt`	Float
`LeftFootFloatOffset`	Float3
`RightFootFloatOffset`	Float3
`LeftFootRootHeight`	Float
`RightFootRootHeight`	Float
`FootFloatSpeed`	Float
`FootFloatAngleMagnitude`	Float
`FootFloatOffsetMagnitude`	Float
`FeetFloatVelocityForce`	Float
`FeetFloatVelocityDampeningSpeed`	Float
`MaxFeetVelocityOffset`	Float
`VelocityAverageRate`	Float
`HoverVelocityThreshold`	Float
`HorizontalBodyAngle`	Float
`SupressWalkAnimationWhenHorizontal`	Bool
`AlwaysUseTrackersWhenHorizontal`	Bool
`Gaits`	list of Gait
`GaitTransitionSpeed`	Float
`GaitMovementDirectionSmoothSpeed`	Float
`RigCollidersRadiusRatio`	Float
`LeftHandRotationOffset`	FloatQ
`RightHandRotationOffset`	FloatQ
`CurrentAverageVelocity`	raw output of Float
`CurrentOnGround`	raw output of Bool
`CurrentGaitIndex`	raw output of Int
`_locomotionController`	LocomotionController
`_leftHandNode`	AvatarPoseNode
`_rightHandNode`	AvatarPoseNode
`_leftElbowNode`	AvatarPoseNode
`_rightElbowNode`	AvatarPoseNode
`_leftFootNode`	AvatarPoseNode
`_rightFootNode`	AvatarPoseNode
`_leftKneeNode`	AvatarPoseNode
`_rightKneeNode`	AvatarPoseNode
`_headNode`	AvatarPoseNode
`_pelvisNode`	AvatarPoseNode
`_chestNode`	AvatarPoseNode
`_headProxy`	Slot
`_pelvisProxy`	Slot
`_chestProxy`	Slot
`_leftHandProxy`	Slot
`_rightHandProxy`	Slot
`_leftElbowProxy`	Slot
`_rightElbowProxy`	Slot
`_leftFootProxy`	Slot
`_rightFootProxy`	Slot
`_leftKneeProxy`	Slot
`_rightKneeProxy`	Slot
`_leftKneeDefaultProxy`	Slot
`_rightKneeDefaultProxy`	Slot
`_headTargetPos`	field drive of Float3
`_headTargetRot`	field drive of FloatQ
`_pelvisTargetPos`	field drive of Float3
`_pelvisTargetRot`	field drive of FloatQ
`_chestTargetPos`	field drive of Float3
`_leftHandTargetPos`	field drive of Float3
`_leftHandTargetRot`	field drive of FloatQ
`_rightHandTargetPos`	field drive of Float3
`_rightHandTargetRot`	field drive of FloatQ
`_leftElbowTargetPos`	field drive of Float3
`_rightElbowTargetPos`	field drive of Float3
`_leftFootTargetPos`	field drive of Float3
`_leftFootTargetRot`	field drive of FloatQ
`_rightFootTargetPos`	field drive of Float3
`_rightFootTargetRot`	field drive of FloatQ
`_leftKneeTargetPos`	field drive of Float3
`_rightKneeTargetPos`	field drive of Float3
`_pelvisPositionWeight`	field drive of Float
`_pelvisRotationWeight`	field drive of Float
`_chestWeight`	field drive of Float
`_locomotionWeight`	field drive of Float
`_leftLegPositionWeight`	field drive of Float
`_leftLegRotationWeight`	field drive of Float
`_rightLegPositionWeight`	field drive of Float
`_rightLegRotationWeight`	field drive of Float
`_leftKneeBendWeight`	field drive of Float
`_rightKneeBendWeight`	field drive of Float
`_leftElbowBendWeight`	field drive of Float
`_rightElbowBendWeight`	field drive of Float
`_leftFootOffset`	field drive of Float3
`_rightFootOffset`	field drive of Float3
`_leftFootRelativeToRoot`	FloatQ
`_rightFootRelativeToRoot`	FloatQ
`_locomotionOffset`	field drive of Float3
`_simplifiedColliderEnabled`	field drive of Bool
`_rigCollidersEnabledStates`	list of FieldDrive`1<Bool>
`_horizontalTrackingLocked`	Bool

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Description
`FilterAvatarHeadPose()`	AvatarHeadPoseFilter<Float3&: position, FloatQ&: rotation>

Behavior

Examples

Related Components

@@ Line 9: / Line 9: @@
 == Fields ==
 {{Table ComponentFields
-|IK|[[Component:VRIK|VRIK]]|TypeAdv0=true|
+|IK|'''[[Component:VRIK|VRIK]]'''|TypeAdv0=true|
 |HeightCompensation|Float|
 |AvatarHeight|Float|
@@ Line 46: / Line 46: @@
 |SupressWalkAnimationWhenHorizontal|Bool|
 |AlwaysUseTrackersWhenHorizontal|Bool|
-|Gaits|{{RootFieldType|SyncList`1|[[Type:Gait|Gait]]}}|TypeAdv37=true|
+|Gaits|{{RootFieldType|SyncList`1|[[#Gait|Gait]]}}|TypeAdv37=true|
 |GaitTransitionSpeed|Float|
 |GaitMovementDirectionSmoothSpeed|Float|
@@ Line 55: / Line 55: @@
 |CurrentOnGround|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv44=true|
 |CurrentGaitIndex|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv45=true|
-|_locomotionController|[[Component:LocomotionController|LocomotionController]]|TypeAdv46=true|
+|_locomotionController|'''[[Component:LocomotionController|LocomotionController]]'''|TypeAdv46=true|
-|_leftHandNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv47=true|
+|_leftHandNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv47=true|
-|_rightHandNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv48=true|
+|_rightHandNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv48=true|
-|_leftElbowNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv49=true|
+|_leftElbowNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv49=true|
-|_rightElbowNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv50=true|
+|_rightElbowNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv50=true|
-|_leftFootNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv51=true|
+|_leftFootNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv51=true|
-|_rightFootNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv52=true|
+|_rightFootNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv52=true|
-|_leftKneeNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv53=true|
+|_leftKneeNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv53=true|
-|_rightKneeNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv54=true|
+|_rightKneeNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv54=true|
-|_headNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv55=true|
+|_headNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv55=true|
-|_pelvisNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv56=true|
+|_pelvisNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv56=true|
-|_chestNode|[[Component:AvatarPoseNode|AvatarPoseNode]]|TypeAdv57=true|
+|_chestNode|'''[[Component:AvatarPoseNode|AvatarPoseNode]]'''|TypeAdv57=true|
 |_headProxy|Slot|
 |_pelvisProxy|Slot|
@@ Line 117: / Line 117: @@
 |_rigCollidersEnabledStates|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]&lt;[[Type:Bool|Bool]]&gt;}}|TypeAdv106=true|
 |_horizontalTrackingLocked|Bool|
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|FilterAvatarHeadPose()|[[Type:AvatarHeadPoseFilter|AvatarHeadPoseFilter]]&lt;[[Type:Float3&|Float3&]]: position, [[Type:FloatQ&|FloatQ&]]: rotation&gt;|
 }}
 == Behavior ==
@@ Line 124: / Line 129: @@
 == Related Components ==
 </translate>
+[[Category:Components{{#translation:}}|VRIKAvatar]]
+[[Category:Components With Nested Types{{#translation:}}|VRIKAvatar]]
 [[Category:ComponentStubs]]
-[[Category:Components{{#translation:}}]]
+[[Category:Components:Uncategorized{{#translation:}}|VRIKAvatar]]
-[[Category:Components:Uncategorized{{#translation:}}]]