imported>Xekri No edit summary |
Added a link for Edit Mode. |
||
(4 intermediate revisions by 4 users not shown) | |||
Line 6: | Line 6: | ||
|Name=Joint | |Name=Joint | ||
}} | }} | ||
The Joint component allows for a slot or object to rotate around a single point, in any direction, or around an axis. Common uses are doors, helmet tops, and dials. | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|EditModeOnly|Bool| User can only interact with the joint in Edit Mode | |EditModeOnly|Bool| User can only interact with the joint in [[Edit Mode]] | ||
|AllowSteal|Bool| Controls whether other users can steal the grabbable joint from other players | |AllowSteal|Bool| Controls whether other users can steal the grabbable joint from other players | ||
|DropOnDisable|Bool| Controls whether the user drops the joint if the object has been disabled | |DropOnDisable|Bool| Controls whether the user drops the joint if the object has been disabled | ||
|DontDrive|Bool| | |DontDrive|Bool| | ||
|AllowOnlyPhysicalGrab|Bool| Only allow grabbing the joint with a physical interaction - remote grabs are not allowed | |AllowOnlyPhysicalGrab|Bool| Only allow grabbing the joint with a physical interaction - remote grabs are not allowed | ||
|ActiveUserFilter|ActiveUserHandling| | |ActiveUserFilter|ActiveUserHandling| | ||
|CustomGrabCheck|GrabCheck| | |CustomGrabCheck|{{RootFieldType|SyncDelegate`1|[[Type:GrabCheck|GrabCheck]]}}|TypeAdv6=true| | ||
|_grabber|Grabber| | |_grabber|'''[[Component:Grabber|Grabber]]'''|TypeAdv7=true| | ||
|_holdSlot|Slot| | |_holdSlot|Slot| | ||
|_pos|Sync`1| | |_pos|{{RootFieldType|DriveRef`1|[[Type:Sync`1|Sync`1]]<[[Type:Float3|Float3]]>}}|TypeAdv9=true| | ||
|_rot|Sync`1| | |_rot|{{RootFieldType|DriveRef`1|[[Type:Sync`1|Sync`1]]<[[Type:FloatQ|FloatQ]]>}}|TypeAdv10=true| | ||
|_scl|Sync`1| | |_scl|{{RootFieldType|DriveRef`1|[[Type:Sync`1|Sync`1]]<[[Type:Float3|Float3]]>}}|TypeAdv11=true| | ||
|__legacyActiveUserRootOnly|Bool| | |__legacyActiveUserRootOnly|Bool| | ||
|GrabPriority|Int| | |GrabPriority|Int| {{Template:Grab Priority}} | ||
|MaxSwing|Float| | |MaxSwing|Float| | ||
|MaxTwist|Float| Maximum amount the joint will rotate in the given axis | |MaxTwist|Float| Maximum amount the joint will rotate in the given axis | ||
|Axis|Float3| Determines which axis the joint rotates on. Use 1 to define the axis, 0 to ignore it | |Axis|Float3| Determines which axis the joint rotates on. Use 1 to define the axis, 0 to ignore it | ||
|TwistReferenceAxis|Float3| | |TwistReferenceAxis|Float3| | ||
|PositionTwistThresholdAngle|Float| | |PositionTwistThresholdAngle|Float| | ||
|VibrationAngle|Float| | |VibrationAngle|Float| | ||
|VibrationPreset|VibratePreset| | |VibrationPreset|VibratePreset| | ||
|SnapIncrement|Float| | |SnapIncrement|Float| | ||
|SnapTime|Float| The time it takes for the joint to lerp towards given SnapOrientations. Higher the value the slower it takes | |SnapTime|Float| The time it takes for the joint to lerp towards given SnapOrientations. Higher the value the slower it takes | ||
|SnapOnRelease|Bool| Controls whether the join snaps to given SnapOrientations | |SnapOnRelease|Bool| Controls whether the join snaps to given SnapOrientations | ||
|SnapOrientations|SnapOrientation| | |SnapOrientations|{{RootFieldType|SyncList`1|[[#SnapOrientation|SnapOrientation]]}}|TypeAdv24=true| | ||
|origRotation|FloatQ| | |origRotation|FloatQ| | ||
|rotReference|FloatQ| | |rotReference|FloatQ| | ||
|dirReference|Float3| | |dirReference|Float3| | ||
|twistReference|Float3| | |twistReference|Float3| | ||
|usePositionTwist|Bool| | |usePositionTwist|Bool| | ||
}} | }} | ||
Line 50: | Line 50: | ||
[[:Category:Draggable]] | [[:Category:Draggable]] | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Joint | [[Category:Components{{#translation:}}|Joint]] | ||
[[Category:Transform:Interaction{{#translation:}}|Joint (Component){{#translation:}}]] | [[Category:Transform:Interaction{{#translation:}}|Joint (Component){{#translation:}}]] | ||
[[Category:Components:Transform:Interaction{{#translation:}}|Joint]] | |||
[[Category:Components With Nested Types{{#translation:}}|Joint]] | |||
[[Category:Draggable]] | [[Category:Draggable]] |
Latest revision as of 16:26, 16 April 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
The Joint component allows for a slot or object to rotate around a single point, in any direction, or around an axis. Common uses are doors, helmet tops, and dials.
Usage
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. |
EditModeOnly
|
Bool | User can only interact with the joint in Edit Mode |
AllowSteal
|
Bool | Controls whether other users can steal the grabbable joint from other players |
DropOnDisable
|
Bool | Controls whether the user drops the joint if the object has been disabled |
DontDrive
|
Bool | |
AllowOnlyPhysicalGrab
|
Bool | Only allow grabbing the joint with a physical interaction - remote grabs are not allowed |
ActiveUserFilter
|
ActiveUserHandling | |
CustomGrabCheck
|
GrabCheck | |
_grabber
|
Grabber | |
_holdSlot
|
Slot | |
_pos
|
direct DriveRef`1<Sync`1<Float3>> | |
_rot
|
direct DriveRef`1<Sync`1<FloatQ>> | |
_scl
|
direct DriveRef`1<Sync`1<Float3>> | |
__legacyActiveUserRootOnly
|
Bool | |
GrabPriority
|
Int | Determines what gets grabbed if several grabbable objects are touching someone's grab sphere. The IGrabbable with the highest priority will be grabbed first. If the highest priority ties with another IGrabbable, it will grab both of those and ignore any lower priority IGrabbables. |
MaxSwing
|
Float | |
MaxTwist
|
Float | Maximum amount the joint will rotate in the given axis |
Axis
|
Float3 | Determines which axis the joint rotates on. Use 1 to define the axis, 0 to ignore it |
TwistReferenceAxis
|
Float3 | |
PositionTwistThresholdAngle
|
Float | |
VibrationAngle
|
Float | |
VibrationPreset
|
VibratePreset | |
SnapIncrement
|
Float | |
SnapTime
|
Float | The time it takes for the joint to lerp towards given SnapOrientations. Higher the value the slower it takes |
SnapOnRelease
|
Bool | Controls whether the join snaps to given SnapOrientations |
SnapOrientations
|
list of SnapOrientation | |
origRotation
|
FloatQ | |
rotReference
|
FloatQ | |
dirReference
|
Float3 | |
twistReference
|
Float3 | |
usePositionTwist
|
Bool |