PokéRogue
    Preparing search index...

    Interface Flip

    Provides methods used for visually flipping a Game Object along its horizontal and/or vertical axes.

    Flipping mirrors the rendered texture without altering the Game Object's scale, position, or physics body. The flip always pivots from the centre of the texture. This component is intended to be mixed in to Game Object classes and should not be used directly.

    interface Flip {
        flipX: boolean;
        flipY: boolean;
        resetFlip(): this;
        setFlip(x: boolean, y: boolean): this;
        setFlipX(value: boolean): this;
        setFlipY(value: boolean): this;
        toggleFlipX(): this;
        toggleFlipY(): this;
    }

    Implemented by

    Index
    flipX flipY
    resetFlip setFlip setFlipX setFlipY toggleFlipX toggleFlipY
    flipX: boolean

    The horizontally flipped state of the Game Object.

    A Game Object that is flipped horizontally will render inverted on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

    flipY: boolean

    The vertically flipped state of the Game Object.

    A Game Object that is flipped vertically will render inverted on the vertical axis (i.e. upside down). Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

    • Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.undefined

      Returns this

      This Game Object instance.

    • Sets the horizontal and vertical flipped state of this Game Object.

      A Game Object that is flipped will render inverted on the flipped axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

      Parameters

      • x: boolean

        The horizontal flipped state. false for no flip, or true to be flipped.

      • y: boolean

        The vertical flipped state. false for no flip, or true to be flipped.

      Returns this

      This Game Object instance.

    • Sets the horizontal flipped state of this Game Object.

      A Game Object that is flipped horizontally will render inverted on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

      Parameters

      • value: boolean

        The flipped state. false for no flip, or true to be flipped.

      Returns this

      This Game Object instance.

    • Sets the vertical flipped state of this Game Object.

      A Game Object that is flipped vertically will render inverted on the vertical axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

      Parameters

      • value: boolean

        The flipped state. false for no flip, or true to be flipped.

      Returns this

      This Game Object instance.

    • Toggles the horizontal flipped state of this Game Object.

      A Game Object that is flipped horizontally will render inverted on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.undefined

      Returns this

      This Game Object instance.

    • Toggles the vertical flipped state of this Game Object.

      A Game Object that is flipped vertically will render inverted on the vertical axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.undefined

      Returns this

      This Game Object instance.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods