Wheel joint definition reference for the LowLevelPhysics2D API
Explore the properties you can use to configure a wheel joint in the Editor.
Read time 3 minutesLast updated 12 days ago
Note
This documentation is about writing C# scripts using the API. To use 2D physics in the Unity Editor using components like the Rigidbody 2D component, refer to 2D physics instead.
LowLevelPhysics2DExplore the properties you can use to configure a API wheel joint in the Unity Editor.
LowLevelPhysics2DA wheel joint pins two bodies together, for example a suspension object and a wheel. You can then rotate the second object with a motor so it moves along ground.
Property | Sub-property | Description |
|---|---|---|
| Local Anchor A | N/A | Sets where one end of the joint connects to the first body. |
| N/A | Position | Sets the position where the end of the joint connects, relative to the position of the first body. |
| N/A | Rotation | Sets the rotation of the anchor in degrees. |
| Local Anchor B | N/A | Sets where the other end of the joint connects to the second body. |
| N/A | Position | Sets the position where the end of the joint connects, relative to the position of the second body. |
| N/A | Rotation | Sets the rotation of the anchor in degrees. |
| Enable Spring | N/A | Enables Spring Frequency, Spring Damping, Spring Lower Force, and Spring Upper Force. The spring connects the two bodies, and stretches and compresses to try to bring the bodies together. The strength of the pull is proportional to the current distance between the bodies. |
| Spring Frequency | N/A | Sets the stiffness of the spring. A higher value makes the spring less stiff. The default is 0. |
| Spring Damping | N/A | Sets how quickly the spring stops pulling or pushing. A higher value makes the spring settle more quickly. The default is 0. |
| Enable Motor | N/A | Enables Motor Speed and Max Motor Torque, which make the joint act as a motor to rotate the second body. |
| Motor Speed | N/A | Sets the target rotation speed of the second body, in degrees per second. |
| Max Motor Torque | N/A | Sets the maximum force that the motor applies to reach the target rotation speed, in newtons. |
| Enable Limit | N/A | Enables Upper Translation Limit and Lower Translation Limit, which restrict the position of the bodies. |
| Lower Translation Limit | N/A | Sets the minimum position in meters. |
| Upper Translation Limit | N/A | Sets the maximum position in meters. |
| Force Threshold | N/A | Sets the amount of linear force that creates an |
| Torque Threshold | N/A | Sets the amount of rotational force that creates an |
| Tuning Frequency | N/A | Sets the overall stiffness of the joint in Hertz (cycles per second). A higher value makes the joint less stiff. |
| Tuning Damping | N/A | Sets how quickly overall the joint stops pulling or pushing. A higher value makes the joint settle more quickly. |
| Draw Scale | N/A | Scales the joint Unity draws as a debug visualization. For more information, refer to Draw a debug visualization of objects. |
| Collide Connected | N/A | Enables the shapes creating collision or trigger events when they come into contact with each other. For more information, refer to Collisions and interactions in the LowLevelPhysics2D API. |