PokéRogue
    Preparing search index...

    Interface GetBounds

    Provides methods used for obtaining the bounds of a Game Object, including its corners, edge midpoints, center point, and overall axis-aligned bounding rectangle. All methods account for the Game Object's rotation and display size, and can optionally factor in any parent Container transforms. Should be applied as a mixin and not used directly.

    interface GetBounds {
        getBottomCenter<O extends Vector2Like>(
            output?: O,
            includeParent?: boolean,
        ): O;
        getBottomLeft<O extends Vector2Like>(
            output?: O,
            includeParent?: boolean,
        ): O;
        getBottomRight<O extends Vector2Like>(
            output?: O,
            includeParent?: boolean,
        ): O;
        getBounds<O extends Rectangle>(output?: O): O;
        getCenter<O extends Vector2Like>(output?: O, includeParent?: boolean): O;
        getLeftCenter<O extends Vector2Like>(
            output?: O,
            includeParent?: boolean,
        ): O;
        getRightCenter<O extends Vector2Like>(
            output?: O,
            includeParent?: boolean,
        ): O;
        getTopCenter<O extends Vector2Like>(output?: O, includeParent?: boolean): O;
        getTopLeft<O extends Vector2Like>(output?: O, includeParent?: boolean): O;
        getTopRight<O extends Vector2Like>(output?: O, includeParent?: boolean): O;
    }

    Implemented by

    Index
    getBottomCenter getBottomLeft getBottomRight getBounds getCenter getLeftCenter getRightCenter getTopCenter getTopLeft getTopRight

    • Gets the bottom-center coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    • Gets the bottom-left corner coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    • Gets the bottom-right corner coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    • Gets the axis-aligned bounding rectangle of this Game Object, regardless of origin.

      The bounding rectangle is computed by retrieving all four corner positions of the Game Object (top-left, top-right, bottom-left, bottom-right), applying any rotation and parent Container transforms, and then calculating the smallest axis-aligned rectangle that fully encloses all four points.

      The values are stored and returned in a Rectangle, or Rectangle-like, object.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Rectangle will be created.

      Returns O

      The values stored in the output object.

    • Gets the center coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    • Gets the left-center coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    • Gets the right-center coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    • Gets the top-center coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    • Gets the top-left corner coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    • Gets the top-right corner coordinate of this Game Object, regardless of origin.

      The returned point is calculated in local space and does not factor in any parent Containers, unless the includeParent argument is set to true.

      Type Parameters

      Parameters

      • Optionaloutput: O

        An object to store the values in. If not provided a new Vector2 will be created.

      • OptionalincludeParent: boolean

        If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector? Default false.

      Returns O

      The values stored in the output object.

    Settings
    Member Visibility

    On This Page
    Methods