Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Physics2D

class in UnityEngine

Other Versions
Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Description

Global settings and helpers for 2D physics.

Static Variables

AllLayersLayer mask constant that includes all layers.
alwaysShowCollidersShould the collider gizmos always be shown even when they are not selected?
angularSleepToleranceA rigid-body cannot sleep if its angular velocity is above this tolerance.
baumgarteScaleThe scale factor that controls how fast overlaps are resolved.
baumgarteTOIScaleThe scale factor that controls how fast TOI overlaps are resolved.
changeStopsCallbacksWhether or not to stop reporting collision callbacks immediately if any of the objects involved in the collision are deleted/moved.
colliderAABBColorThe color used by the gizmos to show all collider AABBs.
colliderAsleepColorThe color used by the gizmos to show all asleep colliders (collider is asleep when the body is asleep).
colliderAwakeColorThe color used by the gizmos to show all awake colliders (collider is awake when the body is awake).
colliderContactColorThe color used by the gizmos to show all collider contacts.
contactArrowScaleThe scale of the contact arrow used by the collider gizmos.
DefaultRaycastLayersLayer mask constant that includes all layers participating in raycasts by default.
gravityAcceleration due to gravity.
IgnoreRaycastLayerLayer mask constant for the default layer that ignores raycasts.
linearSleepToleranceA rigid-body cannot sleep if its linear velocity is above this tolerance.
maxAngularCorrectionThe maximum angular position correction used when solving constraints. This helps to prevent overshoot.
maxLinearCorrectionThe maximum linear position correction used when solving constraints. This helps to prevent overshoot.
maxRotationSpeedThe maximum angular speed of a rigid-body per physics update. Increasing this can cause numerical problems.
maxTranslationSpeedThe maximum linear speed of a rigid-body per physics update. Increasing this can cause numerical problems.
minPenetrationForPenaltyThe minimum contact penetration radius allowed before any separation impulse force is applied. Extreme caution should be used when modifying this value as making this smaller means that polygons will have an insufficient buffer for continuous collision and making it larger may create artefacts for vertex collision.
positionIterationsThe number of iterations of the physics solver when considering objects' positions.
queriesHitTriggersDo raycasts detect Colliders configured as triggers?
queriesStartInCollidersDo ray/line casts that start inside a collider(s) detect those collider(s)?
showColliderAABBShould the collider gizmos show the AABBs for each collider?
showColliderContactsShould the collider gizmos show current contacts for each collider?
showColliderSleepShould the collider gizmos show the sleep-state for each collider?
timeToSleepThe time in seconds that a rigid-body must be still before it will go to sleep.
velocityIterationsThe number of iterations of the physics solver when considering objects' velocities.
velocityThresholdAny collisions with a relative linear velocity below this threshold will be treated as inelastic.

Static Functions

BoxCastCasts a box against colliders in the scene, returning the first collider to contact with it.
BoxCastAllCasts a box against colliders in the scene, returning all colliders that contact with it.
BoxCastNonAllocCasts a box into the scene, returning colliders that contact with it into the provided results array.
CapsuleCastCasts a capsule against colliders in the scene, returning the first collider to contact with it.
CapsuleCastAllCasts a capsule against colliders in the scene, returning all colliders that contact with it.
CapsuleCastNonAllocCasts a capsule into the scene, returning colliders that contact with it into the provided results array.
CircleCastCasts a circle against colliders in the scene, returning the first collider to contact with it.
CircleCastAllCasts a circle against colliders in the scene, returning all colliders that contact with it.
CircleCastNonAllocCasts a circle into the scene, returning colliders that contact with it into the provided results array.
GetIgnoreCollisionChecks whether the collision detection system will ignore all collisions/triggers between collider1 and collider2 or not.
GetIgnoreLayerCollisionShould collisions between the specified layers be ignored?
GetLayerCollisionMaskGet the collision layer mask that indicates which layer(s) the specified layer can collide with.
GetRayIntersectionCast a 3D ray against the colliders in the scene returning the first collider along the ray.
GetRayIntersectionAllCast a 3D ray against the colliders in the scene returning all the colliders along the ray.
GetRayIntersectionNonAllocCast a 3D ray against the colliders in the scene returning the colliders along the ray.
IgnoreCollisionMakes the collision detection system ignore all collisions/triggers between collider1 and collider2.
IgnoreLayerCollisionChoose whether to detect or ignore collisions between a specified pair of layers.
IsTouchingCheck whether collider1 is touching collider2 or not.
IsTouchingLayersChecks whether the collider is touching any colliders on the specified layerMask or not.
LinecastCasts a line against colliders in the scene.
LinecastAllCasts a line against colliders in the scene.
LinecastNonAllocCasts a line against colliders in the scene.
OverlapAreaCheck if a collider falls within a rectangular area.
OverlapAreaAllGet a list of all colliders that fall within a rectangular area.
OverlapAreaNonAllocGet a list of all colliders that fall within a specified area.
OverlapBoxCheck if a collider falls within a box area.
OverlapBoxAllGet a list of all colliders that fall within a box area.
OverlapBoxNonAllocGet a list of all colliders that fall within a box area.
OverlapCapsuleCheck if a collider falls within a capsule area.
OverlapCapsuleAllGet a list of all colliders that fall within a capsule area.
OverlapCapsuleNonAllocGet a list of all colliders that fall within a capsule area.
OverlapCircleCheck if a collider falls within a circular area.
OverlapCircleAllGet a list of all colliders that fall within a circular area.
OverlapCircleNonAllocGet a list of all colliders that fall within a circular area.
OverlapPointCheck if a collider overlaps a point in space.
OverlapPointAllGet a list of all colliders that overlap a point in space.
OverlapPointNonAllocGet a list of all colliders that overlap a point in space.
RaycastCasts a ray against colliders in the scene.
RaycastAllCasts a ray against colliders in the scene, returning all colliders that contact with it.
RaycastNonAllocCasts a ray into the scene.
SetLayerCollisionMaskSet the collision layer mask that indicates which layer(s) the specified layer can collide with.
Copyright ?? 2017 Unity Technologies. Publication 5.5-001G 2017-03-29
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information