Component:Joint: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
m removed spelling error and updated formatting
Line 6: Line 6:
|Name=Joint
|Name=Joint
}}
}}
== Intoduction ==
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.
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 ==

Revision as of 02:22, 1 April 2024


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


Component image 
Joint component as seen in the Scene Inspector

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

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.
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

Behavior

Examples

Related Components

Category:Draggable