Version: 5.4 (switch to 5.5b)
LanguageEnglish
  • C#
  • JS

Script language

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

Physics

class in UnityEngine

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Global physics properties and helper methods.

Static Variables

AllLayersLayer mask constant to select all layers.
bounceThresholdTwo colliding objects with a relative velocity below this will not bounce (default 2). Must be positive.
defaultContactOffsetThe default contact offset of the newly created colliders.
DefaultRaycastLayersLayer mask constant to select default raycast layers.
defaultSolverIterationsThe defaultSolverIterations determines how accurately Rigidbody joints and collision contacts are resolved. (default 6). Must be positive.
defaultSolverVelocityIterationsThe defaultSolverVelocityIterations affects how how accurately Rigidbody joints and collision contacts are resolved. (default 1). Must be positive.
gravityThe gravity applied to all rigid bodies in the scene.
IgnoreRaycastLayerLayer mask constant to select ignore raycast layer.
queriesHitTriggersSpecifies whether queries (raycasts, spherecasts, overlap tests, etc.) hit Triggers by default.
sleepThresholdThe mass-normalized energy threshold, below which objects start going to sleep.

Static Functions

BoxCastCasts the box along a ray and returns detailed information on what was hit.
BoxCastAllLike Physics.BoxCast, but returns all hits.
BoxCastNonAllocCast the box along the direction, and store hits in the provided buffer.
CapsuleCastCasts a capsule against all colliders in the scene and returns detailed information on what was hit.
CapsuleCastAllLike Physics.CapsuleCast, but this function will return all hits the capsule sweep intersects.
CapsuleCastNonAllocCasts a capsule against all colliders in the scene and returns detailed information on what was hit into the buffer.
CheckBoxCheck whether the given box overlaps with other colliders or not.
CheckCapsuleChecks if any colliders overlap a capsule-shaped volume in world space.
CheckSphereReturns true if there are any colliders overlapping the sphere defined by position and radius in world coordinates.
GetIgnoreLayerCollisionAre collisions between layer1 and layer2 being ignored?
IgnoreCollisionMakes the collision detection system ignore all collisions between collider1 and collider2.
IgnoreLayerCollisionMakes the collision detection system ignore all collisions between any collider in layer1 and any collider in layer2.Note that IgnoreLayerCollision will reset the trigger state of affected colliders, so you might receive OnTriggerExit and OnTriggerEnter messages in response to calling this.
LinecastReturns true if there is any collider intersecting the line between start and end.
OverlapBoxFind all colliders touching or inside of the given box.
OverlapBoxNonAllocFind all colliders touching or inside of the given box, and store them into the buffer.
OverlapCapsuleCheck the given capsule against the physics world and return all overlapping colliders.
OverlapCapsuleNonAllocCheck the given capsule against the physics world and return all overlapping colliders in the user-provided buffer.
OverlapSphereReturns an array with all colliders touching or inside the sphere.
OverlapSphereNonAllocComputes and stores colliders touching or inside the sphere into the provided buffer.
RaycastCasts a ray, from point origin, in direction direction, of length maxDistance, against all colliders in the scene.
RaycastAllCasts a ray through the scene and returns all hits. Note that order is not guaranteed.
RaycastNonAllocCast a ray through the scene and store the hits into the buffer.
SphereCastCasts a sphere along a ray and returns detailed information on what was hit.
SphereCastAllLike Physics.SphereCast, but this function will return all hits the sphere sweep intersects.
SphereCastNonAllocCast sphere along the direction and store the results into buffer.