PokéRogue
    Preparing search index...

    Interface Origin

    Provides methods used for getting and setting the origin of a Game Object. Values are normalized, given in the range 0 to 1. Display values contain the calculated pixel values. Should be applied as a mixin and not used directly.

    interface Origin {
        displayOriginX: number;
        displayOriginY: number;
        originX: number;
        originY: number;
        setDisplayOrigin(x?: number, y?: number): this;
        setOrigin(x?: number, y?: number): this;
        setOriginFromFrame(): this;
        updateDisplayOrigin(): this;
    }

    Implemented by

    Index
    displayOriginX displayOriginY originX originY
    setDisplayOrigin setOrigin setOriginFromFrame updateDisplayOrigin
    displayOriginX: number

    The horizontal display origin of this Game Object, expressed in pixels. Unlike originX, which is a normalized value between 0 and 1, the display origin is the calculated pixel offset derived from the Game Object's width multiplied by its originX value. Setting this property updates originX accordingly.

    displayOriginY: number

    The vertical display origin of this Game Object, expressed in pixels. Unlike originY, which is a normalized value between 0 and 1, the display origin is the calculated pixel offset derived from the Game Object's height multiplied by its originY value. Setting this property updates originY accordingly.

    originX: number

    The horizontal origin of this Game Object. The origin maps the relationship between the size and position of the Game Object. The default value is 0.5, meaning all Game Objects are positioned based on their center. Setting the value to 0 means the position now relates to the left of the Game Object. Set this value with setOrigin().

    originY: number

    The vertical origin of this Game Object. The origin maps the relationship between the size and position of the Game Object. The default value is 0.5, meaning all Game Objects are positioned based on their center. Setting the value to 0 means the position now relates to the top of the Game Object. Set this value with setOrigin().

    • Sets the display origin of this Game Object. The difference between this and setting the origin is that you can use pixel values for setting the display origin.

      Parameters

      • Optionalx: number

        The horizontal display origin value. Default 0.

      • Optionaly: number

        The vertical display origin value. If not defined it will be set to the value of x. Default x.

      Returns this

      This Game Object instance.

    • Sets the origin of this Game Object.

      The values are given in the range 0 to 1.

      Parameters

      • Optionalx: number

        The horizontal origin value. Default 0.5.

      • Optionaly: number

        The vertical origin value. If not defined it will be set to the value of x. Default x.

      Returns this

      This Game Object instance.

    • Sets the origin of this Game Object based on the Pivot values in its Frame. If the Frame has a custom pivot point defined, the origin is set to match it. If the Frame does not have a custom pivot, this method falls back to setOrigin(), resetting the origin to the default value of 0.5 for both axes.undefined

      Returns this

      This Game Object instance.

    • Updates the Display Origin cached values internally stored on this Game Object. You don't usually call this directly, but it is exposed for edge-cases where you may.undefined

      Returns this

      This Game Object instance.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods