PokéRogue
    Preparing search index...

    Interface GuideObject

    Interface representing an object that can be passed to setPositionRelative.

    interface GuideObject {
        height: number;
        originX: number;
        originY: number;
        width: number;
        x: number;
        y: number;
    }
    Index

    Properties

    height originX originY width x y

    Properties

    height: number

    The native (un-scaled) height of this Game Object.

    Changing this value will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or use the displayHeight property.

    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().

    width: number

    The native (un-scaled) width of this Game Object.

    Changing this value will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or use the displayWidth property.

    x: number

    The x position of this Game Object.

    y: number

    The y position of this Game Object.

    Settings

    Member Visibility

    On This Page

    Properties