melonJS
    Preparing search index...

    Class Stage

    a default "Stage" object. every "stage" object (title screen, credits, ingame, etc...) to be managed through the state manager must inherit from this base class.

    state

    Index

    Constructors

    constructor

    Properties

    ambientLight ambientLightingColor cameras lights settings

    Methods

    drawLighting onDestroyEvent onResetEvent

    Constructors

    • Parameters

      • Optionalsettings: Partial<StageSettings>

        The stage parameters

        • cameras

          a list of cameras (experimental)

        • onResetEvent

          called by the state manager when reseting the object

        • onDestroyEvent

          called by the state manager before switching to another state

      Returns Stage

    Properties

    ambientLight: Color

    an ambient light that will be added to the stage rendering

    "#000000"

    Light2d

    ambientLightingColor: Color

    Base light level applied to every normal-mapped sprite in the lit rendering path. Unlike Stage#ambientLight (which is the dark overlay punched by each light's cutout), this color is added to every lit pixel so unlit areas don't render pure black. Defaults to black (0, 0, 0) — sprites without a normalMap ignore it entirely.

    "#000000"
    cameras: Map<string, Camera2d>

    The list of active cameras in this stage. Cameras will be rendered based on this order defined in this list. Only the "default" camera will be resized when the window or canvas is resized.

    lights: Map<string, Light2d>

    The list of active lights in this stage.

    Since 19.3.0, Light2d is a first-class world Renderable — the recommended pattern is to add lights directly to app.world (or any container, including a sprite, so the light follows it via parent transforms). The lights Map remains for backward compatibility: any entry added via this.lights.set(name, light) in onResetEvent() is automatically adopted into the world tree at stage reset time so it renders normally.

    • Light2d
    • Stage.ambientLight
    // recommended:
    const whiteLight = new Light2d(100, 100, 140, 140, "#fff", 0.7);
    app.world.addChild(whiteLight);

    // legacy (still works, auto-adopted into world):
    this.lights.set("whiteLight", whiteLight);

    this.ambientLight.parseCSS("#1117");
    settings: StageSettings

    The given constructor options

    Methods

    • Draw the stage's ambient-light overlay with cutouts for each active light. Called from each Camera2d inside its post-effect FBO bracket — lights themselves render via the world tree (they're standard Renderables); this pass only paints the dark fill that the lights cut holes through.

      Subclasses can override this method to implement custom lighting (e.g. per-pixel normal-mapped lighting via a custom shader). Called once per camera per frame.

      Parameters

      • renderer: Renderer

        the active renderer

      • camera: Camera2d

        the camera currently rendering this stage

      • translateX: number = ...

        the same world-to-screen X translate that Camera2d.draw() applies to the world container (i.e. camera.pos.x + camera.offset.x for the default camera, plus the container's own offset for non-default cameras)

      • translateY: number = ...

        the world-to-screen Y translate (see translateX)

      Returns void

    • onResetEvent function
      called by the state manager when resetting the object this is typically where you will load a level, add renderables, etc...

      Parameters

      • app: Application

        the current application instance

      • ...args: unknown[]

        optional arguments passed when switching state

      Returns void

      state#change

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods