The joint attempts to move a Rigidbody2D to a specific target position.
This joint is the only joint that doesn't connect two Rigidbody2D together. Instead, it only operates on the single body it is connected to.
When connected, it will attempt to move the body to a specified target position. When setting a target you can also set the anchor position which is a point relative to the Rigidbody2D where forces will be applied.
The joint moves the body using a configurable spring that has a force limit.
An example usage for this joint might be to enable Collider2D to be dragged, selecting an anchor point and moving the body to the position under the mouse.
| anchor | The local-space anchor on the rigid-body the joint is attached to. |
| autoConfigureTarget | Should the target be calculated automatically? |
| dampingRatio | The amount by which the target spring force is reduced in proportion to the movement speed. |
| frequency | The frequency at which the target spring oscillates around the target position. |
| maxForce | The maximum force that can be generated when trying to maintain the target joint constraint. |
| target | The world-space position that the joint will attempt to move the body to. |
| 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. |
| 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. |
| 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. |