class in UnityEngine
/
Implemented in:UnityEngine.Physics2DModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseGlobal settings and helpers for 2D physics.
AllLayers | Layer mask constant that includes all layers. |
angularSleepTolerance | A Rigidbody cannot sleep if its angular velocity is above this tolerance threshold. |
autoSyncTransforms | Set whether to automatically sync changes to the Transform component with the physics engine. |
baumgarteScale | The scale factor that controls how fast overlaps are resolved. |
baumgarteTOIScale | The scale factor that controls how fast TOI overlaps are resolved. |
bounceThreshold | Any collisions with a relative linear velocity below this threshold will be treated as inelastic so no bounce will occur. |
callbacksOnDisable | Use this to control whether or not the appropriate OnCollisionExit2D or OnTriggerExit2D callbacks should be called when a Collider2D is disabled. |
contactThreshold | A threshold below which a contact is automatically disabled. |
defaultContactOffset | The default contact offset of the newly created Colliders. |
defaultPhysicsScene | The PhysicsScene2D automatically created when Unity starts. |
DefaultRaycastLayers | Layer mask constant that includes all layers participating in raycasts by default. |
gravity | Acceleration due to gravity. |
IgnoreRaycastLayer | Layer mask constant for the default layer that ignores raycasts. |
jobOptions | A set of options that control how physics operates when using the job system to multithread the physics simulation. |
linearSleepTolerance | A rigid-body cannot sleep if its linear velocity is above this tolerance. |
maxAngularCorrection | The maximum angular position correction used when solving constraints. This helps to prevent overshoot. |
maxLinearCorrection | The maximum linear position correction used when solving constraints. This helps to prevent overshoot. |
MaxPolygonShapeVertices | The maximum number of vertices allowed per primitive polygon shape type (PhysicsShapeType2D.Polygon). (Read Only) |
maxRotationSpeed | The maximum angular speed of a rigid-body per physics update. Increasing this can cause numerical problems. |
maxSubStepCount | The maximum number of simulation sub-steps allowed per-frame when simulation sub-stepping is enabled. |
maxTranslationSpeed | The maximum linear speed of a rigid-body per physics update. Increasing this can cause numerical problems. |
minSubStepFPS | The minimum FPS allowed for a simulation step before sub-stepping will be used. |
positionIterations | The number of iterations of the physics solver when considering objects' positions. |
queriesHitTriggers | Do raycasts detect Colliders configured as triggers? |
queriesStartInColliders | Set the raycasts or linecasts that start inside Colliders to detect or not detect those Colliders. |
reuseCollisionCallbacks | Determines whether the garbage collector should reuse only a single instance of a Collision2D type for all collision callbacks. |
simulationLayers | The Rigidbody2D and Collider2D layers to simulate. |
simulationMode | Controls when Unity executes the 2D physics simulation. |
timeToSleep | The time in seconds that a rigid-body must be still before it will go to sleep. |
useSubStepContacts | Whether to calculate contacts for all simulation sub-steps or only the first sub-step. |
useSubStepping | Whether to use simulation sub-stepping during a simulation step. |
velocityIterations | The number of iterations of the physics solver when considering objects' velocities. |
BoxCast | Casts a box against Colliders in the Scene, returning the first Collider to contact with it. |
BoxCastAll | Casts a box against Colliders in the Scene, returning all Colliders that contact with it. |
CapsuleCast | Casts a capsule against Colliders in the Scene, returning the first Collider to contact with it. |
CapsuleCastAll | Casts a capsule against Colliders in the Scene, returning all Colliders that contact with it. |
CircleCast | Casts a circle against Colliders in the Scene, returning the first Collider to contact with it. |
CircleCastAll | Casts a circle against Colliders in the Scene, returning all Colliders that contact with it. |
ClosestPoint | Returns a point on the perimeter of the Collider that is closest to the specified position. |
Distance | Calculates the minimum distance between two Colliders. |
GetContacts | Retrieves all Colliders in contact with the Collider. |
GetIgnoreCollision | Checks whether the collision detection system will ignore all collisions/triggers between collider1 and collider2 or not. |
GetIgnoreLayerCollision | Checks whether collisions between the specified layers be ignored or not. |
GetLayerCollisionMask | Get the collision layer mask that indicates which layer(s) the specified layer can collide with. |
GetRayIntersection | Cast a 3D ray against the 2D Colliders in the Scene. |
GetRayIntersectionAll | Cast a 3D ray against the 2D Colliders in the Scene. |
GetRayIntersectionNonAlloc | Cast a 3D ray against the 2D Colliders in the Scene. |
IgnoreCollision | Makes the collision detection system ignore all collisions/triggers between collider1 and collider2. |
IgnoreLayerCollision | Choose whether to detect or ignore collisions between a specified pair of layers. |
IsTouching | Checks whether the passed Colliders are in contact or not. |
IsTouchingLayers | Checks whether the Collider is touching any Colliders on the specified layerMask or not. |
Linecast | Casts a line segment against Colliders in the Scene. |
LinecastAll | Casts a line against Colliders in the Scene. |
OverlapArea | Checks if a Collider falls within a rectangular area. |
OverlapAreaAll | Get a list of all Colliders that fall within a rectangular area. |
OverlapBox | Checks if a Collider falls within a box area. |
OverlapBoxAll | Get a list of all Colliders that fall within a box area. |
OverlapCapsule | Checks if a Collider falls within a capsule area. |
OverlapCapsuleAll | Get a list of all Colliders that fall within a capsule area. |
OverlapCircle | Checks if a Collider falls within a circular area. |
OverlapCircleAll | Get a list of all Colliders that fall within a circular area. |
OverlapCollider | Gets a list of all Colliders that overlap the given Collider. |
OverlapPoint | Checks if a Collider overlaps a point in space. |
OverlapPointAll | Get a list of all Colliders that overlap a point in space. |
Raycast | Casts a ray against Colliders in the Scene. |
RaycastAll | Casts a ray against Colliders in the Scene, returning all Colliders that contact with it. |
SetLayerCollisionMask | Set the collision layer mask that indicates which layer(s) the specified layer can collide with. |
Simulate | Simulate physics in the default physics scene. |
SyncTransforms | Synchronizes. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.