class in UnityEngine
/
Inherits from:AnchoredJoint2D
/
Implemented in:UnityEngine.Physics2DModule
Applies both force and torque to reduce both the linear and angular velocities to zero.
The joint constantly tries to reduce both the ::Rigidbody2D::velocity and ::Rigidbody2D::angularVelocity to zero. Unlike contact friction which requires two colliders to be in contact, force and torque here are applied continuously.
You can control both the maximum force using maxForce and maximum torque using maxTorque. Because you can use very high force or torque limits, you can essentially reduce an objects movement to almost zero.
A typical usage for this joint might be to simulate top-down surface friction or to simulate stiff rotation of an object.
| maxForce | The maximum force that can be generated when trying to maintain the friction joint constraint. |
| maxTorque | The maximum torque that can be generated when trying to maintain the friction joint constraint. |
| anchor | The joint's anchor point on the object that has the joint component. |
| autoConfigureConnectedAnchor | Should the connectedAnchor be calculated automatically? |
| connectedAnchor | The joint's anchor point on the second object (ie, the one which doesn't have the joint component). |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| isActiveAndEnabled | Reports whether a GameObject and its associated Behaviour is active and enabled. |
| gameObject | The game object this component is attached to. A component is always attached to a game object. |
| tag | The tag of this game object. |
| transform | The Transform attached to this GameObject. |
| attachedRigidbody | The Rigidbody2D attached to the Joint2D. |
| breakAction | The action to take when the joint breaks the breakForce or breakTorque. |
| breakForce | The force that needs to be applied for this joint to break. |
| breakTorque | The torque that needs to be applied for this joint to break. |
| connectedBody | The Rigidbody2D object to which the other end of the joint is attached (ie, the object without the joint component). |
| enableCollision | Should the two Rigidbody2D connected with this joint collide with each other? |
| reactionForce | Gets the reaction force of the joint. |
| reactionTorque | Gets the reaction torque of the joint. |
| hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
| name | The name of the object. |
| BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| CompareTag | Checks the GameObject's tag against the defined tag. |
| GetComponent | Gets a reference to a component of type T on the same GameObject as the component specified. |
| GetComponentInChildren | Gets a reference to a component of type T on the same GameObject as the component specified, or any child of the GameObject. |
| GetComponentIndex | Gets the index of the component on its parent GameObject. |
| GetComponentInParent | Gets a reference to a component of type T on the same GameObject as the component specified, or any parent of the GameObject. |
| GetComponents | Gets references to all components of type T on the same GameObject as the component specified. |
| GetComponentsInChildren | Gets references to all components of type T on the same GameObject as the component specified, and any child of the GameObject. |
| GetComponentsInParent | Gets references to all components of type T on the same GameObject as the component specified, and any parent of the GameObject. |
| SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| TryGetComponent | Gets the component of the specified type, if it exists. |
| GetReactionForce | Gets the reaction force of the joint given the specified timeStep. |
| GetReactionTorque | Gets the reaction torque of the joint given the specified timeStep. |
| GetInstanceID | Gets the instance ID of the object. |
| ToString | Returns the name of the object. |
| Destroy | Removes a GameObject, component or asset. |
| DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
| DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
| FindAnyObjectByType | Retrieves any active loaded object of Type type. |
| FindFirstObjectByType | Retrieves the first active loaded object of Type type. |
| FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| InstantiateAsync | Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. |
| bool | Does the object exist? |
| operator != | Compares if two objects refer to a different object. |
| operator == | Compares two object references to see if they refer to the same object. |
| OnJointBreak2D | Called when a Joint2D attached to the same game object breaks. |