PokéRogue
    Preparing search index...

    Interface AlphaSingle

    Provides methods used for setting the alpha property of a Game Object. Unlike the full Alpha component, which supports individual alpha values for each corner of a Game Object, this component applies a single uniform alpha across the whole object. Should be applied as a mixin and not used directly.

    interface AlphaSingle {
        alpha: number;
        clearAlpha(): this;
        setAlpha(value?: number): this;
    }

    Implemented by

    Index
    alpha: number

    The alpha value of the Game Object.

    This is a global value, impacting the entire Game Object, not just a region of it. The value is clamped to the range [0, 1]. Setting alpha to 0 also clears the render flag, preventing the Game Object from being drawn until the alpha is raised above 0 again.

    • Clears the alpha value associated with this Game Object.

      Immediately sets the alpha back to 1 (fully opaque).undefined

      Returns this

      This Game Object instance.

    • Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.

      Parameters

      • Optionalvalue: number

        The alpha value applied across the whole Game Object. Default 1.

      Returns this

      This Game Object instance.