Component:AvatarObjectSlot: Difference between revisions

From Resonite Wiki
fix
add info and see also
 
Line 7: Line 7:
|Name=AvatarObjectSlot
|Name=AvatarObjectSlot
}}
}}
For detailed information on how this functions for mix and match body parts. Please also see [[Equipping Multiple Avatars]].
Avatar Object slot is a component that is used to move and drive certain parts of the avatar like the head and hand body parts.
Avatar Object slot is a component that is used to move and drive certain parts of the avatar like the head and hand body parts.


<!--T:3-->
<!--T:3-->
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Priority|Int|
|Priority|Int| Whether to do the equip checking on this AvatarObjectSlot before other AvatarObjectSlots
|Equipped|{{RootFieldType|LinkRef`1|[[Type:IAvatarObject|IAvatarObject]]}}|TypeAdv1=true| Usually an [[Component:AvatarPoseNode|Avatar Pose Node]] that is on one of the proxies on an avatar.
|Equipped|{{RootFieldType|LinkRef`1|[[Type:IAvatarObject|IAvatarObject]]}}|TypeAdv1=true| Usually an [[Component:AvatarPoseNode|Avatar Pose Node]] that is on one of the proxies on an avatar.
|Node|BodyNode| the body node of the avatar this component's slot is. Unless already specified by a [[Component:BipedRig|Biped Rig Component]] higher up in the hierarchy.
|Node|BodyNode| the body node of the avatar this component's slot is. Unless already specified by a [[Component:BipedRig|Biped Rig Component]] higher up in the hierarchy.
|IsTracking|Bool| Whether this component is currently being simulated by the procedural animation system.
|IsTracking|Bool| Whether this component is currently being simulated by the procedural animation system.
|IsActive|Bool| Whether this component is currently active and controlling an avatar.
|IsActive|Bool| Whether this component is currently active and controlling an avatar.
|IsSimulated|Bool|
|IsSimulated|Bool| Whether this object slot is being controlled by the procedural animation system.
|DriveActive|Bool| Whether to drive the active of this slot when hooked into by an [[Component:AvatarPoseNode|Avatar Pose Node]].
|DriveActive|Bool| Whether to drive the active of this slot when hooked into by an [[Component:AvatarPoseNode|Avatar Pose Node]].
|DriveScale|Bool| Whether to drive the scale of this slot when hooked into by an [[Component:AvatarPoseNode|Avatar Pose Node]].
|DriveScale|Bool| Whether to drive the scale of this slot when hooked into by an [[Component:AvatarPoseNode|Avatar Pose Node]].
|DoNotSimulate|Bool|
|DoNotSimulate|Bool| Whether to not control this with the procedural locomotion system
|Filters|{{RootFieldType|PrioritySyncRefList`1|[[Type:IAvatarPoseFilter|IAvatarPoseFilter]]}}|TypeAdv9=true| Filters that are currently effecting this and their priorities. See [[:Category:Components:Users:Common Avatar System:Pose Filters|Avatar Pose Filters]]
|Filters|{{RootFieldType|PrioritySyncRefList`1|[[Type:IAvatarPoseFilter|IAvatarPoseFilter]]}}|TypeAdv9=true| Filters that are currently effecting this and their priorities. See [[:Category:Components:Users:Common Avatar System:Pose Filters|Avatar Pose Filters]]
|_autoSmoothing|'''[[Component:AvatarPoseSmoothLerp|AvatarPoseSmoothLerp]]'''|TypeAdv10=true| The Component currently smoothing the transform changes of this Avatar Object slot.
|_autoSmoothing|'''[[Component:AvatarPoseSmoothLerp|AvatarPoseSmoothLerp]]'''|TypeAdv10=true| The Component currently smoothing the transform changes of this Avatar Object slot.
Line 26: Line 28:


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==


<!--T:5-->
<!--T:5-->
Line 32: Line 34:


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
* [[Equipping Multiple Avatars]]
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar Object Slot]]
[[Category:Components{{#translation:}}|Avatar Object Slot]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Object Slot]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Object Slot]]

Latest revision as of 22:30, 31 December 2024


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


Component image 
AvatarObjectSlot component as seen in the Scene Inspector

For detailed information on how this functions for mix and match body parts. Please also see Equipping Multiple Avatars.

Avatar Object slot is a component that is used to move and drive certain parts of the avatar like the head and hand body parts.

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.
Priority Int Whether to do the equip checking on this AvatarObjectSlot before other AvatarObjectSlots
Equipped direct LinkRef`1<IAvatarObject> Usually an Avatar Pose Node that is on one of the proxies on an avatar.
Node BodyNode the body node of the avatar this component's slot is. Unless already specified by a Biped Rig Component higher up in the hierarchy.
IsTracking Bool Whether this component is currently being simulated by the procedural animation system.
IsActive Bool Whether this component is currently active and controlling an avatar.
IsSimulated Bool Whether this object slot is being controlled by the procedural animation system.
DriveActive Bool Whether to drive the active of this slot when hooked into by an Avatar Pose Node.
DriveScale Bool Whether to drive the scale of this slot when hooked into by an Avatar Pose Node.
DoNotSimulate Bool Whether to not control this with the procedural locomotion system
Filters direct PrioritySyncRefList`1<IAvatarPoseFilter> Filters that are currently effecting this and their priorities. See Avatar Pose Filters
_autoSmoothing AvatarPoseSmoothLerp The Component currently smoothing the transform changes of this Avatar Object slot.

Usage

Examples

See Also