fix |
Add info |
||
| Line 4: | Line 4: | ||
{{Infobox Component | {{Infobox Component | ||
|Image=AvatarPoseBoxConstraintComponent.png | |Image=AvatarPoseBoxConstraintComponent.png | ||
|Name= | |Name=Avatar Pose Box Constraint | ||
}} | }} | ||
The '''AvatarPoseBoxConstraint''' component is a BodyPoseFilter that can be used in the construction of tool tips, anchors, grabbable items, and more. This pose filter is used to force the slot corresponding to a body node (In the case of a hand for example, it will constrict the position of the hand bone position, rather than the whole hand) to stay within a rotatable box specified. | |||
{{Template:PoseFilters}} | |||
<!--T:3--> | <!--T:3--> | ||
| Line 15: | Line 15: | ||
|BoxSize|Float3| the size of the box that a user's body node should be constrained within. (0,0,0) is valid for this field. | |BoxSize|Float3| the size of the box that a user's body node should be constrained within. (0,0,0) is valid for this field. | ||
|DefaultPoseReference|Slot| the slot which the box will be positioned, rotated, and scaled by. If null, this is the slot this component is on. | |DefaultPoseReference|Slot| the slot which the box will be positioned, rotated, and scaled by. If null, this is the slot this component is on. | ||
|ProcessSimulatedPoses|Bool| | |ProcessSimulatedPoses|Bool| Whether to affect simulated poses like from the animation system. | ||
}} | }} | ||
| Line 24: | Line 24: | ||
<!--T:5--> | <!--T:5--> | ||
== Examples == | == Examples == | ||
{{stub}} | |||
<!--T:6--> | <!--T:6--> | ||
== See Also == | == See Also == | ||
{{Template:SeeAlsoPoseConstraint}} | |||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Avatar Pose Box Constraint]] | [[Category:Components{{#translation:}}|Avatar Pose Box Constraint]] | ||
[[Category:Components:Users:Common Avatar System:Pose Filters{{#translation:}}|Avatar Pose Box Constraint]] | [[Category:Components:Users:Common Avatar System:Pose Filters{{#translation:}}|Avatar Pose Box Constraint]] | ||
Latest revision as of 20:45, 20 December 2024
The AvatarPoseBoxConstraint component is a BodyPoseFilter that can be used in the construction of tool tips, anchors, grabbable items, and more. This pose filter is used to force the slot corresponding to a body node (In the case of a hand for example, it will constrict the position of the hand bone position, rather than the whole hand) to stay within a rotatable box specified.
Pose filters are used with components such as the Component:GrabbableAvatarPoseFilter or Component:AvatarAnchor in order to restrict movement of any Type:BodyNode. These components do so by telling the game to apply these pose filters when they interact with said objects. In the case of an Avatar Anchor, this happens while seated. With the grabbable pose filter, this happens when any Type:IGrabbable with the component on the same Slot is grabbed. This component when used with such components can be used to control placement of a user's hand on an item.
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. |
BoxSize
|
Float3 | the size of the box that a user's body node should be constrained within. (0,0,0) is valid for this field. |
DefaultPoseReference
|
Slot | the slot which the box will be positioned, rotated, and scaled by. If null, this is the slot this component is on. |
ProcessSimulatedPoses
|
Bool | Whether to affect simulated poses like from the animation system. |
Usage
This is widely used in seats where the user's legs and hips are posed in a sitting position, like when sitting in a car.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.