• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    Physics

    The Physics class is essential for managing global physical simulations in scenes, such as gravity, collisions, and interactions between GameObjects. It also allows control over settings like gravity and layer collisions. Unity's Physics Documentation

    Properties

    bounceThreshold

    number
    ClientOnly

    Specify the minimum collision velocity for an object to bounce. Unity's Physics.bounceThreshold Documentation

    defaultContactOffset

    number
    ClientOnly

    Define the minimum distance between colliders for them to be considered in contact. Unity's Physics.defaultContactOffset Documentation

    gravity

    ClientOnly

    Control the global gravity in the physics simulation, defaulting to Earth's gravity. Unity's Physics.gravity Documentation

    queriesHitBackfaces

    boolean
    ClientOnly

    Decide if physics queries should detect hits on collider backfaces. Unity's Physics.queriesHitBackfaces Documentation

    queriesHitTriggers

    boolean
    ClientOnly

    Determine whether physics queries interact with trigger colliders. Unity's Physics.queriesHitTriggers Documentation

    sleepThreshold

    number
    ClientOnly

    Set the velocity threshold below which GameObjects are considered static or immobile. Unity's Physics.sleepThreshold Documentation

    Methods

    Parameters

    meshID
    number
    convex
    boolean

    Returns

    void

    Parameters

    center
    halfExtents
    direction

    Returns

    boolean

    Parameters

    center
    halfExtents
    direction
    orientation

    Returns

    boolean

    Parameters

    center
    halfExtents
    direction
    orientation
    maxDistance
    number

    Returns

    boolean

    Parameters

    center
    halfExtents
    direction
    orientation
    maxDistance
    number
    layerMask
    number

    Returns

    boolean

    Parameters

    center
    halfExtents
    direction
    orientation

    Parameters

    center
    halfExtents
    direction
    orientation
    maxDistance
    number

    Parameters

    center
    halfExtents
    direction
    orientation
    maxDistance
    number
    layerMask
    number

    Parameters

    point1
    point2
    radius
    number
    direction

    Returns

    boolean

    Parameters

    point1
    point2
    radius
    number
    direction
    maxDistance
    number

    Returns

    boolean

    Parameters

    point1
    point2
    radius
    number
    direction
    maxDistance
    number
    layerMask
    number

    Returns

    boolean

    Parameters

    point1
    point2
    radius
    number
    direction
    maxDistance
    number

    Parameters

    point1
    point2
    radius
    number
    direction
    maxDistance
    number
    layerMask
    number

    Parameters

    center
    halfExtents

    Returns

    boolean

    Parameters

    center
    halfExtents
    orientation

    Returns

    boolean

    Parameters

    center
    halfExtents
    orientation
    layerMask
    number

    Returns

    boolean

    Parameters

    start
    radius
    number

    Returns

    boolean

    Parameters

    start
    radius
    number
    layerMask
    number

    Returns

    boolean

    Parameters

    position
    radius
    number

    Returns

    boolean

    Parameters

    position
    radius
    number
    layerMask
    number

    Returns

    boolean

    ClosestPoint

    ClientOnly

    Calculate the closest point to a given position on a collider's surface. Unity's Physics.ClosestPoint Documentation

    Parameters

    point

    Position to check against.

    collider

    Collider to check.

    position

    Collider's position.

    rotation

    Collider's rotation.

    Returns

    Closest point on the collider.

    Parameters

    colliderA
    positionA
    rotationA
    colliderB
    positionB
    rotationB

    Returns

    boolean
    number

    Check if collisions between two specific colliders are ignored. Unity's Physics.GetIgnoreCollision Documentation

    Parameters

    collider1

    First collider.

    collider2

    Second collider.

    Returns

    boolean

    True if collisions are ignored, false otherwise.

    Check if collisions between any colliders in two layers are ignored. Unity's Physics.GetIgnoreLayerCollision Documentation

    Parameters

    layer1
    number

    First layer ID.

    layer2
    number

    Second layer ID.

    Returns

    boolean

    True if collisions are ignored, false otherwise.

    IgnoreCollision

    ClientOnly

    Prevent physics engine from processing collisions between two specified colliders. Unity's Physics.IgnoreCollision Documentation

    Parameters

    collider1

    First collider.

    collider2

    Second collider.

    Returns

    void

    IgnoreCollision

    ClientOnly

    Prevent physics engine from processing collisions between two specified colliders. Unity's Physics.IgnoreCollision Documentation

    Parameters

    collider1

    First collider.

    collider2

    Second collider.

    ignore
    boolean

    Whether to ignore collisions.

    Returns

    void

    Make physics engine ignore all collisions between colliders in two specified layers. Unity's Physics.IgnoreLayerCollision Documentation

    Parameters

    layer1
    number

    First layer ID.

    layer2
    number

    Second layer ID.

    Returns

    void

    Make physics engine ignore all collisions between colliders in two specified layers. Unity's Physics.IgnoreLayerCollision Documentation

    Parameters

    layer1
    number

    First layer ID.

    layer2
    number

    Second layer ID.

    ignore
    boolean

    Whether to ignore collisions.

    Returns

    void

    Parameters

    start
    layerMask
    number

    Returns

    boolean

    Parameters

    center
    halfExtents
    orientation
    layerMask
    number

    Returns

    Parameters

    point0
    point1
    radius
    number
    layerMask
    number

    Returns

    OverlapSphere

    ClientOnly

    Find all colliders touching or inside an imaginary sphere, useful for area damage or proximity checks. Unity's Physics.OverlapSphere Documentation

    Parameters

    position

    Sphere center.

    radius
    number

    Sphere radius.

    Returns

    Array of colliders within the sphere.

    OverlapSphere

    ClientOnly

    Find all colliders touching or inside an imaginary sphere, useful for area damage or proximity checks. Unity's Physics.OverlapSphere Documentation

    Parameters

    position

    Sphere center.

    radius
    number

    Sphere radius.

    layerMask
    number

    LayerMask to selectively ignore colliders.

    Returns

    Array of colliders within the sphere.

    Raycast

    ClientOnly

    Trace a path in 3D space to detect colliders, useful for implementing bullet paths or line-of-sight features. Unity's Physics.Raycast Documentation

    Parameters

    ray

    Defines the origin and direction of the ray.

    Returns

    boolean

    Returns true if any collider is hit, with collision details.

    Raycast

    ClientOnly

    Trace a path in 3D space to detect colliders, useful for implementing bullet paths or line-of-sight features. Unity's Physics.Raycast Documentation

    Parameters

    ray

    Defines the origin and direction of the ray.

    maxDistance
    number

    The maximum distance to check for collisions.

    Returns

    boolean

    Returns true if any collider is hit, with collision details.

    Raycast

    ClientOnly

    Trace a path in 3D space to detect colliders, useful for implementing bullet paths or line-of-sight features. Unity's Physics.Raycast Documentation

    Parameters

    ray

    Defines the origin and direction of the ray.

    maxDistance
    number

    The maximum distance to check for collisions.

    layerMask
    number

    LayerMask to selectively ignore colliders.

    Returns

    boolean

    Returns true if any collider is hit, with collision details.

    Raycast

    ClientOnly

    Trace a path in 3D space to detect colliders, useful for implementing bullet paths or line-of-sight features. Unity's Physics.Raycast Documentation

    Parameters

    origin
    direction

    Returns

    boolean

    Returns true if any collider is hit, with collision details.

    Raycast

    ClientOnly

    Trace a path in 3D space to detect colliders, useful for implementing bullet paths or line-of-sight features. Unity's Physics.Raycast Documentation

    Parameters

    origin
    direction
    maxDistance
    number

    The maximum distance to check for collisions.

    Returns

    boolean

    Returns true if any collider is hit, with collision details.

    Raycast

    ClientOnly

    Trace a path in 3D space to detect colliders, useful for implementing bullet paths or line-of-sight features. Unity's Physics.Raycast Documentation

    Parameters

    origin
    direction
    maxDistance
    number

    The maximum distance to check for collisions.

    layerMask
    number

    LayerMask to selectively ignore colliders.

    Returns

    boolean

    Returns true if any collider is hit, with collision details.

    Parameters

    ray
    maxDistance
    number

    Parameters

    ray
    maxDistance
    number
    layerMask
    number

    Parameters

    origin
    direction
    maxDistance
    number

    Parameters

    origin
    direction
    maxDistance
    number
    layerMask
    number

    Simulate

    ClientOnly

    Advance physics simulation by a specified time, useful for 'fast-forwarding' physics. Unity's Physics.Simulate Documentation

    Parameters

    step
    number

    Time to advance simulation by, in seconds.

    Returns

    void

    Parameters

    ray
    radius
    number

    Returns

    boolean

    Parameters

    ray
    radius
    number
    maxDistance
    number

    Returns

    boolean

    Parameters

    ray
    radius
    number
    maxDistance
    number
    layerMask
    number

    Returns

    boolean

    Parameters

    origin
    radius
    number
    direction

    Returns

    boolean

    Parameters

    origin
    radius
    number
    direction
    maxDistance
    number

    Returns

    boolean

    Parameters

    origin
    radius
    number
    direction
    maxDistance
    number
    layerMask
    number

    Returns

    boolean

    Parameters

    ray
    radius
    number
    maxDistance
    number

    Parameters

    ray
    radius
    number
    maxDistance
    number
    layerMask
    number

    Parameters

    origin
    radius
    number
    direction
    maxDistance
    number

    Parameters

    origin
    radius
    number
    direction
    maxDistance
    number
    layerMask
    number

    SyncTransforms

    ClientOnly

    Synchronize transform data used in physics simulation with GameObjects' actual transform data. Unity's Physics.SyncTransforms Documentation

    Returns

    void

    Updated about 15 hours ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.