Joint

Parent Userdata
Library physics.*
Revision Release 2024.3703
Keywords physics, joints
See also Physics Joints (guide)
physics.newJoint()

Overview

Joints can be used to assemble complex physical objects from multiple rigid bodies. For example, joints can be used to join the limbs of a ragdoll figure, attach the wheels of a vehicle to its body, create a moving elevator platform, and more. All joints are created using the physics.newJoint() constructor.

Please refer to the Physics Joints guide for details on the setup and configuration of each joint type.

Properties

Shared

joint.isActive

joint.isCollideConnected

joint.reactionTorque

Distance Joint

distanceJoint.dampingRatio

distanceJoint.frequency

distanceJoint.length

Friction Joint

frictionJoint.maxForce

frictionJoint.maxTorque

Gear Joint

gearJoint.joint1

gearJoint.joint2

gearJoint.ratio

Piston Joint

pistonJoint.isLimitEnabled

pistonJoint.isMotorEnabled

pistonJoint.jointSpeed

pistonJoint.jointTranslation

pistonJoint.maxMotorForce

pistonJoint.motorSpeed

pistonJoint.motorForce

pistonJoint.referenceAngle

Pivot Joint

pivotJoint.isLimitEnabled

pivotJoint.isMotorEnabled

pivotJoint.jointAngle

pivotJoint.jointSpeed

pivotJoint.maxMotorTorque

pivotJoint.motorSpeed

pivotJoint.motorTorque

pivotJoint.referenceAngle

Pulley Joint

pulleyJoint.length1

pulleyJoint.length2

pulleyJoint.ratio

Touch Joint

touchJoint.dampingRatio

touchJoint.frequency

touchJoint.maxForce

Wheel Joint

wheelJoint.jointSpeed

wheelJoint.jointTranslation

wheelJoint.springDampingRatio

wheelJoint.springFrequency

Weld Joint

weldJoint.dampingRatio

weldJoint.frequency

weldJoint.referenceAngle

Rope Joint

ropeJoint.limitState

ropeJoint.maxLength

Methods

(Inherits methods from Userdata)

Shared

joint:getAnchorA()

joint:getAnchorB()

joint:getLocalAnchorA()

joint:getLocalAnchorB()

joint:getReactionForce()

joint:removeSelf()

Touch Joint

touchJoint:getTarget()

touchJoint:setTarget()

Piston Joint

pistonJoint:getLimits()

pistonJoint:getLocalAxisA()

pistonJoint:setLimits()

Pivot Joint

pivotJoint:getRotationLimits()

pivotJoint:setRotationLimits()

Pulley Joint

pulleyJoint:getGroundAnchorA()

pulleyJoint:getGroundAnchorB()

Wheel Joint

wheelJoint:getLocalAxisA()