• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    Plane

    Represents a plane in 3D space defined by a normal vector and a distance from the origin. Used for geometric calculations like intersection points, containment tests, and distance measurements. Unity's Plane Documentation

    Properties

    distance

    number
    ClientOnly

    The shortest distance between the plane and the origin along its normal. Unity's Plane.distance Documentation

    flipped

    ClientOnly
    ReadOnly

    Returns a new plane with the normal vector flipped. Unity's Plane.flipped Documentation

    normal

    ClientOnly

    The normal vector of the plane, perpendicular to its surface. Unity's Plane.normal Documentation

    Methods

    Finds the point on the plane closest to a given point. Unity's Plane.ClosestPointOnPlane Documentation

    Parameters

    point

    The point in 3D space.

    Returns

    Returns the closest point on the plane.

    Flip

    ClientOnly

    Flips the plane's normal vector. Unity's Plane.Flip Documentation

    Returns

    void

    Calculates the shortest distance from a point to the plane. Unity's Plane.GetDistanceToPoint Documentation

    Parameters

    point

    The point to calculate the distance from.

    Returns

    number

    GetSide

    ClientOnly

    Determines which side of the plane a point lies on. Unity's Plane.GetSide Documentation

    Parameters

    point

    The point to test.

    Returns

    boolean

    Returns true if the point is on the same side as the plane's normal.

    Raycast

    ClientOnly

    Determines if a ray intersects the plane and returns the intersection point distance.

    Parameters

    ray

    Returns

    boolean
    number

    SameSide

    ClientOnly

    Checks if two points are on the same side of the plane. Unity's Plane.SameSide Documentation

    Parameters

    inPt0

    The first point.

    inPt1

    The second point.

    Returns

    boolean

    Returns true if the points are on the same side of the plane.

    Set3Points

    ClientOnly

    Recalculates the plane to contain three specified points. Unity's Plane.Set3Points Documentation

    Parameters

    The first point.

    The second point.

    The third point.

    Returns

    void

    Sets the normal vector and a point on the plane to redefine its position. Unity's Plane.SetNormalAndPosition Documentation

    Parameters

    inNormal

    The new normal vector of the plane.

    inPoint

    A new point on the plane.

    Returns

    void

    Translate

    ClientOnly

    Moves the plane by a specified offset in 3D space. Unity's Plane.Translate Documentation

    Parameters

    plane

    The plane to translate.

    translation

    The translation offset.

    Returns

    Returns a copy of the original plane, translated by the specified offset.

    Translate

    ClientOnly

    Moves the plane by a specified offset in 3D space. Unity's Plane.Translate Documentation

    Parameters

    translation

    The translation offset.

    Returns

    void

    Updated 1 day ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.