phaser - v4.0.0-rc.4
    Preparing search index...
    • Checks for the closest point of intersection between a line segment and an array of polygons.

      If no intersection is found, this function returns null.

      If intersection was found, a Vector4 is returned with the following properties:

      The x and y components contain the point of the intersection. The z component contains the closest distance. The w component contains the index of the polygon, in the given array, that triggered the intersection.

      Parameters

      • line: Geom.Line

        The line segment, or ray, to check. If a ray, set the isRay parameter to true.

      • polygons: Geom.Polygon | Geom.Polygon[]

        A single polygon, or array of polygons, to check.

      • OptionalisRay: boolean

        Is line a ray or a line segment? Default false.

      • Optionalout: Vector4

        A Vector4 to store the intersection results in.

      Returns Vector4