PokéRogue
    Preparing search index...

    Interface Lighting

    Provides methods for enabling WebGL-based per-pixel lighting effects on a Game Object, using normal maps to simulate surface depth under dynamic light sources.

    When lighting is enabled, the Game Object will respond to lights added to the scene via the Lights plugin. This component also supports self-shadowing, which creates contact shadows on the surface based on the object's normal map.

    This component should only be applied to Game Objects that have RenderNodes, and requires the WebGL renderer. It has no effect in Canvas rendering mode.

    interface Lighting {
        lighting: boolean;
        selfShadow: Object;
        setLighting(enable: boolean): this;
        setSelfShadow(
            enabled?: boolean,
            penumbra?: number,
            diffuseFlatThreshold?: number,
        ): this;
    }

    Implemented by

    Index
    lighting selfShadow
    setLighting setSelfShadow
    lighting: boolean

    Controls whether this Game Object participates in the WebGL lighting system. When true, the object will respond to dynamic lights added via the Lights plugin, using normal maps to calculate per-pixel diffuse lighting.

    This flag is used to select the appropriate WebGL shader at render time.

    selfShadow: Object

    Configuration object controlling self-shadowing for this Game Object. Self-shadowing causes surfaces to cast contact shadows on themselves based on the normal map, giving the appearance of depth. It is only active when lighting is also enabled.

    If enabled is null, the value from the game config option render.selfShadow is used instead.

    This object is used to select and configure the appropriate WebGL shader at render time.

    • Enables or disables WebGL-based per-pixel lighting for this Game Object. When enabled, the object will respond to dynamic lights added to the scene via the Lights plugin, using a normal map for lighting calculations. Disabling lighting restores the standard unlit rendering path.

      Parameters

      • enable: boolean

        true to use lighting, or false to disable it.

      Returns this

      This GameObject instance.

    • Configures the self-shadowing properties of this Game Object. Self-shadowing uses the normal map to cast contact shadows on the surface itself, giving the impression of depth and raised detail. It is only active when lighting is also enabled on this Game Object.

      Parameters that are undefined are left unchanged, allowing partial updates.

      Parameters

      • Optionalenabled: boolean

        true to use self-shadowing, false to disable it, null to use the game default from config.render.selfShadow, or undefined to keep the setting.

      • Optionalpenumbra: number

        The penumbra value for the shadow. Lower is sharper but more jagged. Default is 0.5.

      • OptionaldiffuseFlatThreshold: number

        The texture brightness threshold at which the diffuse lighting will be considered flat. Range is 0-1. Default is 1/3.

      Returns this

      This GameObject instance.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods