Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Physics

Global physics properties and helper methods.
Read time 4 minutesLast updated 4 days ago

Definition

  • Type: Class
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule
public class Physics

Static Fields

Value

Description

AllLayersLayer mask constant to select all layers.
DefaultRaycastLayersLayer mask constant to select default raycast layers.
IgnoreRaycastLayerLayer mask constant to select ignore raycast layer.

Static Properties

Property

Description

bounceThresholdTwo colliding objects with a relative velocity below this will not bounce (default 2). Must be positive.
clothGravityCloth Gravity setting. Set gravity for all cloth components.
defaultContactOffsetThe default contact offset of the newly created colliders.
defaultMaxAngularSpeedDefault maximum angular speed of the dynamic Rigidbody, in radians (default 50).
defaultMaxDepenetrationVelocityThe maximum default velocity needed to move a Rigidbody's collider out of another collider's surface penetration. Must be positive.
defaultPhysicsSceneThe PhysicsScene automatically created when Unity starts.
defaultSolverIterationsThe defaultSolverIterations determines how accurately Rigidbody joints and collision contacts are resolved. (default 6). Must be positive.
defaultSolverVelocityIterationsThe defaultSolverVelocityIterations affects how accurately the Rigidbody joints and collision contacts are resolved. (default 1). Must be positive.
generateOnTriggerStayEventsWhether the physics system sends 
OnTriggerStay
events.
gravityThe gravity applied to all rigid bodies in the Scene.
improvedPatchFrictionEnables an improved patch friction mode that guarantees static and dynamic friction do not exceed analytical results.
interCollisionDistanceSets the minimum separation distance for cloth inter-collision.
interCollisionStiffnessSets the cloth inter-collision stiffness.
invokeCollisionCallbacksWhether or not MonoBehaviour collision messages will be sent by the physics system.
queriesHitBackfacesWhether physics queries should hit back-face triangles.
queriesHitTriggersSpecifies whether queries (raycasts, spherecasts, overlap tests, etc.) hit Triggers by default.
reuseCollisionCallbacksDetermines whether the garbage collector should reuse only a single instance of a Collision type for all collision callbacks.
simulationModeControls when Unity executes the physics simulation.
sleepThresholdThe mass-normalized energy threshold, below which objects start going to sleep.

Static Methods

Method

Description

BakeMeshPrepares the mesh for use with a MeshCollider and uses default cooking options.
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.
ClosestPointReturns a point on the given collider that is closest to the specified location.
ComputePenetrationCompute the minimal translation required to separate the given colliders apart at specified poses.
GetIgnoreCollisionChecks whether the collision detection system will ignore all collisions/triggers between 
collider1
and 
collider2
or not.
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.
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.
OverlapSphereComputes and stores colliders touching or inside the sphere.
OverlapSphereNonAllocComputes and stores colliders touching or inside the sphere into the provided buffer.
RaycastSame as above using /ray.origin/ and /ray.direction/ instead of 
origin
and 
direction
.
RaycastAllCasts a ray through the Scene and returns all hits. Note that order of the results is undefined.
RaycastNonAllocCast a ray through the Scene and store the hits into the buffer.
RebuildBroadphaseRegionsRebuild the broadphase interest regions as well as set the world boundaries.
SimulateSimulate physics in the Scene.
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.
SyncTransformsApply Transform changes to the physics engine.

Static Events

Member

Description

ContactEventSubscribe to this event to read all collisions that occurred during the physics simulation step.
ContactModifyEventSubscribe to this event to be able to customize the collision response for contact pairs.
ContactModifyEventCCDSubscribe to this event to be able to customize the collision response of CCD generated contact pairs.