phaser - v4.0.0-rc.4
    Preparing search index...

    Class LightsPlugin

    A Scene plugin that provides a Phaser.GameObjects.LightsManager for rendering objects with dynamic lighting.

    Available from within a Scene via this.lights.

    Add Lights using the Phaser.GameObjects.LightsManager#addLight method:

    // Enable the Lights Manager because it is disabled by default
    this.lights.enable();

    // Create a Light at [400, 300] with a radius of 200
    this.lights.addLight(400, 300, 200);

    For Game Objects to be affected by the Lights when rendered, you will need to set them to use lighting like so:

    sprite.setLighting(true);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active ambientColor lights maxLights scene systems visibleLights

    Methods

    addLight addPointLight boot destroy disable enable getLightCount getLights getMaxVisibleLights removeLight setAmbientColor shutdown

    Constructors

    Properties

    active: boolean

    Whether the Lights Manager is enabled.

    ambientColor: RGB

    The ambient color.

    lights: Light[]

    The Lights in the Scene.

    maxLights: number

    The maximum number of lights that a single Camera and the lights shader can process. Change this via the maxLights property in your game config, as it cannot be changed at runtime.

    scene: Scene

    A reference to the Scene that this Lights Plugin belongs to.

    systems: Systems

    A reference to the Scene's systems.

    visibleLights: number

    The number of lights processed in the previous frame.

    Methods

    • Add a Light.

      Parameters

      • Optionalx: number

        The horizontal position of the Light. Default 0.

      • Optionaly: number

        The vertical position of the Light. Default 0.

      • Optionalradius: number

        The radius of the Light. Default 128.

      • Optionalrgb: number

        The integer RGB color of the light. Default 0xffffff.

      • Optionalintensity: number

        The intensity of the Light. Default 1.

      • Optionalz: number

        The z position of the light. If omitted, it will be set to radius * 0.1.

      Returns Light

    • Creates a new Point Light Game Object and adds it to the Scene.

      Note: This method will only be available if the Point Light Game Object has been built into Phaser.

      The Point Light Game Object provides a way to add a point light effect into your game, without the expensive shader processing requirements of the traditional Light Game Object.

      The difference is that the Point Light renders using a custom shader, designed to give the impression of a point light source, of variable radius, intensity and color, in your game. However, unlike the Light Game Object, it does not impact any other Game Objects, or use their normal maps for calcuations. This makes them extremely fast to render compared to Lights and perfect for special effects, such as flickering torches or muzzle flashes.

      For maximum performance you should batch Point Light Game Objects together. This means ensuring they follow each other consecutively on the display list. Ideally, use a Layer Game Object and then add just Point Lights to it, so that it can batch together the rendering of the lights. You don't have to do this, and if you've only a handful of Point Lights in your game then it's perfectly safe to mix them into the display list as normal. However, if you're using a large number of them, please consider how they are mixed into the display list.

      The renderer will automatically cull Point Lights. Those with a radius that does not intersect with the Camera will be skipped in the rendering list. This happens automatically and the culled state is refreshed every frame, for every camera.

      The origin of a Point Light is always 0.5 and it cannot be changed.

      Point Lights are a WebGL only feature and do not have a Canvas counterpart.

      Parameters

      • x: number

        The horizontal position of this Point Light in the world.

      • y: number

        The vertical position of this Point Light in the world.

      • Optionalcolor: number

        The color of the Point Light, given as a hex value. Default 0xffffff.

      • Optionalradius: number

        The radius of the Point Light. Default 128.

      • Optionalintensity: number

        The intensity, or color blend, of the Point Light. Default 1.

      • Optionalattenuation: number

        The attenuation of the Point Light. This is the reduction of light from the center point. Default 0.1.

      Returns PointLight

    • Get all lights that can be seen by the given Camera.

      It will automatically cull lights that are outside the world view of the Camera.

      If more lights are returned than supported by the renderer, the lights are then culled based on the distance from the center of the camera. Only those closest are rendered.

      Parameters

      Returns Light[]

    • Shut down the Lights Manager.

      Recycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and culled Lights.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods