Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Slider Joint 2D

Explore the properties of the Slider Joint 2D.
Read time 2 minutesLast updated 21 days ago

This joint allows a GameObject controlled by Rigidbody physics to slide along a line in space. The object can freely move anywhere along the line in response to collisions or forces. Alternatively, it can be also be moved along by a motor force, with limits applied to keep its position within a certain section of the line.

Properties

Property

Function

Enable CollisionEnable this property to enable collisions between the two connected GameObjects.
Connected RigidbodySpecify the other object this joint connects to. Leave this as None to have the other end of the joint fixed at a point in space defined by the Connected Anchor property. Select the circle icon to the right to view a list of GameObjects to connect to.
Auto Configure Connected AnchorEnable this property to automatically set the anchor location for the other object this joint connects to. You do not need to enter coordinates for the Connected Anchor property if you enable this property.
AnchorDefine where (in terms of x, y-coordinates on the Rigidbody 2D) the end point of the joint connects to this GameObject.
Connected AnchorDefine where (in terms of x, y-coordinates on the Rigidbody 2D) the end point of the joint connects to the other GameObject.
Auto Configure AngleEnable this property to automatically detect between the two GameObjects. The joint then keeps the same angle between the two GameObjects. You do not need to manually specify the angle when you enable this property.
AngleEnter the angle that the joint keeps between the two objects.
Use MotorUse the sliding motor? Check the box for yes.
MotorExpand for motor-related property settings.
    Motor SpeedSet the target motor speed (meters/sec).
    Maximum Motor ForceSet the maximum force the motor can apply while attempting to reach the target speed.
Use LimitsEnable this property to set limits to the linear force.
Translation LimitsExpand to set the limited distance that the translation can travel.
    Lower TranslationSet the minimum distance the GameObject can be from the connected anchor point.
    Upper TranslationSet the maximum distance the GameObject can be from the connected anchor point.
Break ActionSet the action taken when either the force or torque threshold is exceeded.
Break ForceSet the force threshold which if exceeded, will cause the joint to perform the selected Break Action. The default value is set to Infinity, which can never be exceeded and therefore the Break Action can never be taken while the threshold remains at this value.
Break TorqueSet the torque threshold which if exceeded, will cause the joint to perform the selected Break Action. The default value is set to Infinity, which can never be exceeded and therefore the Break Action can never be taken while the threshold remains at this value.