Class Light

A 2D Light.

These are created by the Phaser.GameObjects.LightsManager, available from within a scene via this.lights.

Any Game Objects with the Lighting Component, and setLighting(true), will then be affected by these Lights. If they have a normal map, it will be used. If they don't, the Lights will use the default normal map, a flat surface.

They can also simply be used to represent a point light for your own purposes.

Lights cannot be added to Containers. They are designed to exist in the root of a Scene.

Hierarchy (View Summary)

Circle
- Light

Implements

Constructors

constructor

new Light(
    x: number,
    y: number,
    radius: number,
    r: number,
    g: number,
    b: number,
    intensity: number,
    z?: number,
): Light
Parameters
- x: number
  The horizontal position of the light.
- y: number
  The vertical position of the light.
- radius: number
  The radius of the light.
- r: number
  The red color of the light. A value between 0 and 1.
- g: number
  The green color of the light. A value between 0 and 1.
- b: number
  The blue color of the light. A value between 0 and 1.
- intensity: number
  The intensity of the light.
- Optionalz: number
  The z position of the light. If not given, it will be set to radius * 0.1.
Returns Light
Overrides Circle.constructor
- Defined in types/phaser.d.ts:27264

Properties

bottom

bottom: number

The bottom position of the Circle.

cameraFilter

cameraFilter: number

A bitmask that controls if this Game Object is drawn by a Camera or not. Not usually set directly, instead call Camera.ignore, however you can set this property directly using the Camera.id property:

color

color: RGB

The color of the light.

diameter

diameter: number

The diameter of the Circle.

displayHeight

displayHeight: number

The height of this Light Game Object. This is the same as Light.diameter.

displayOriginX

displayOriginX: number

The horizontal display origin of this Game Object. The origin is a normalized value between 0 and 1. The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.

displayOriginY

displayOriginY: number

The vertical display origin of this Game Object. The origin is a normalized value between 0 and 1. The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.

displayWidth

displayWidth: number

The width of this Light Game Object. This is the same as Light.diameter.

height

height: number

The height of this Light Game Object. This is the same as Light.diameter.

intensity

intensity: number

The intensity of the light.

left

left: number

The left position of the Circle.

`Readonly`originX

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

`Readonly`originY

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

radius

radius: number

The radius of the Circle.

renderFlags

renderFlags: number

The flags that are compared against RENDER_MASK to determine if this Game Object will render or not. The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively. If those components are not used by your custom class then you can use this bitmask as you wish.

right

right: number

The right position of the Circle.

scrollFactorX

scrollFactorX: number

The horizontal scroll factor of this Game Object.

The scroll factor controls the influence of the movement of a Camera upon this Game Object.

When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.

A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.

Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.

scrollFactorY

scrollFactorY: number

The vertical scroll factor of this Game Object.

The scroll factor controls the influence of the movement of a Camera upon this Game Object.

When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.

top

top: number

The top position of the Circle.

`Readonly`type

type: number

The geometry constant type of this object: GEOM_CONST.CIRCLE. Used for fast type comparisons.

visible

visible: boolean

The visible state of the Game Object.

An invisible Game Object will skip rendering, but will still process update logic.

width

width: number

The width of this Light Game Object. This is the same as Light.diameter.

x

x: number

The x position of the center of the circle.

y

y: number

The y position of the center of the circle.

z

z: number

The z position of the light. This affects the relief effect created by the light. A higher value will make the light appear more raised.

Lit game objects are considered to be at z=0. Thus, if z is larger than the radius of the light, the light will not affect them. Strong values are in the range of 0 to radius/2.

This is not a true position, and won't be affected by perspective or camera position. It won't be set by setTo. Use setZ to set it, or setZNormal to set it to a fraction of the radius.

zNormal

zNormal: number

The z position of the light, as a fraction of the radius. This affects the relief effect created by the light. A higher value will make the light appear more raised. Strong values are in the range of 0 to 0.5.

`Static` `Readonly`RENDER_MASK

RENDER_MASK: number

The bitmask that GameObject.renderFlags is compared against to determine if the Game Object will render or not.

Methods

contains

contains(x: number, y: number): boolean
Check to see if the Circle contains the given x / y coordinates.
Parameters
- x: number
  The x coordinate to check within the circle.
- y: number
  The y coordinate to check within the circle.
Returns boolean
Inherited from Circle.contains
- Defined in types/phaser.d.ts:60187

getPoint

getPoint<O extends Math.Vector2>(position: number, out?: O): O
Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point at 180 degrees around the circle.
Type Parameters
- O extends Math.Vector2
Parameters
- position: number
  A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.
- Optionalout: O
  A Vector2 to store the return values in. If not given a Vector2 object will be created.
Returns O
Inherited from Circle.getPoint
- Defined in types/phaser.d.ts:60196

getPoints

getPoints<O extends Math.Vector2[]>(
    quantity: number,
    stepRate?: number,
    output?: O,
): O
Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle, based on the given quantity or stepRate values.
Type Parameters
- O extends Math.Vector2[]
Parameters
- quantity: number
  The amount of points to return. If a falsey value the quantity will be derived from the stepRate instead.
- OptionalstepRate: number
  Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.
- Optionaloutput: O
  An array to insert the Vector2s in to. If not provided a new array will be created.
Returns O
Inherited from Circle.getPoints
- Defined in types/phaser.d.ts:60205

getRandomPoint

getRandomPoint<O extends Math.Vector2>(vec?: Math.Vector2): O
Returns a uniformly distributed random point from anywhere within the Circle.
Type Parameters
- O extends Math.Vector2
Parameters
- Optionalvec: Math.Vector2
  A Vector2 object to set the random x and y values in.
Returns O
Inherited from Circle.getRandomPoint
- Defined in types/phaser.d.ts:60211

isEmpty

isEmpty(): boolean
Checks to see if the Circle is empty: has a radius of zero.

Returns boolean
Inherited from Circle.isEmpty
- Defined in types/phaser.d.ts:60237

setColor

setColor(rgb: number): this
Set the color of the light from a single integer RGB value.
Parameters
- rgb: number
  The integer RGB color of the light.
Returns this
- Defined in types/phaser.d.ts:27346

setDisplayOrigin

setDisplayOrigin(x?: number, y?: number): this
Sets the display origin of this Game Object. The difference between this and setting the origin is that you can use pixel values for setting the display origin.
Parameters
- Optionalx: number
  The horizontal display origin value. Default 0.
- Optionaly: number
  The vertical display origin value. If not defined it will be set to the value of x. Default x.
Returns this
Implementation of Origin.setDisplayOrigin
- Defined in types/phaser.d.ts:27432

setEmpty

setEmpty(): this
Sets this Circle to be empty with a radius of zero. Does not change its position.

Returns this
Inherited from Circle.setEmpty
- Defined in types/phaser.d.ts:60225

setIntensity

setIntensity(intensity: number): this
Set the intensity of the light.
Parameters
- intensity: number
  The intensity of the light.
Returns this
- Defined in types/phaser.d.ts:27352

setOrigin

setOrigin(x?: number, y?: number): this
Sets the origin of this Game Object.

The values are given in the range 0 to 1.
Parameters
- Optionalx: number
  The horizontal origin value. Default 0.5.
- Optionaly: number
  The vertical origin value. If not defined it will be set to the value of x. Default x.
Returns this
Implementation of Origin.setOrigin
- Defined in types/phaser.d.ts:27419

setOriginFromFrame

setOriginFromFrame(): this
Sets the origin of this Game Object based on the Pivot values in its Frame.

Returns this
Implementation of Origin.setOriginFromFrame
- Defined in types/phaser.d.ts:27424

setPosition

setPosition(x?: number, y?: number): this
Sets the position of this Circle.
Parameters
- Optionalx: number
  The x position of the center of the circle. Default 0.
- Optionaly: number
  The y position of the center of the circle. Default 0.
Returns this
Inherited from Circle.setPosition
- Defined in types/phaser.d.ts:60232

setRadius

setRadius(radius: number): this
Set the radius of the light.
Parameters
- radius: number
  The radius of the light.
Returns this
- Defined in types/phaser.d.ts:27358

setScrollFactor

setScrollFactor(x: number, y?: number): this
Sets the scroll factor of this Game Object.

The scroll factor controls the influence of the movement of a Camera upon this Game Object.

When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.

A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.

Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.
Parameters
- x: number
  The horizontal scroll factor of this Game Object.
- Optionaly: number
  The vertical scroll factor of this Game Object. If not set it will use the x value. Default x.
Returns this
Implementation of ScrollFactor.setScrollFactor
- Defined in types/phaser.d.ts:27497

setTo

setTo(x?: number, y?: number, radius?: number): this
Sets the x, y and radius of this circle.
Parameters
- Optionalx: number
  The x position of the center of the circle. Default 0.
- Optionaly: number
  The y position of the center of the circle. Default 0.
- Optionalradius: number
  The radius of the circle. Default 0.
Returns this
Inherited from Circle.setTo
- Defined in types/phaser.d.ts:60219

setVisible

setVisible(value: boolean): this
Sets the visibility of this Game Object.

An invisible Game Object will skip rendering, but will still process update logic.
Parameters
- value: boolean
  The visible state of the Game Object.
Returns this
Implementation of Visible.setVisible
- Defined in types/phaser.d.ts:27512

setZ

setZ(z: number): this
Set the z position of the light.
Parameters
- z: number
  The z position of the light.
Returns this
- Defined in types/phaser.d.ts:27364

setZNormal

setZNormal(z: number): this
Set the z position of the light as a fraction of the radius. This affects the relief effect created by the light. A higher value will make the light appear more raised. Strong values are in the range of 0 to 0.5.
Parameters
- z: number
  The normalized z position of the light.
Returns this
- Defined in types/phaser.d.ts:27373

updateDisplayOrigin

updateDisplayOrigin(): this
Updates the Display Origin cached values internally stored on this Game Object. You don't usually call this directly, but it is exposed for edge-cases where you may.

Returns this
Implementation of Origin.updateDisplayOrigin
- Defined in types/phaser.d.ts:27438

willRender

willRender(camera: Cameras.Scene2D.Camera): boolean
Compares the renderMask with the renderFlags to see if this Game Object will render or not. Also checks the Game Object against the given Cameras exclusion list.
Parameters
- camera: Cameras.Scene2D.Camera
  The Camera to check against this Game Object.
Returns boolean
- Defined in types/phaser.d.ts:27340

`Static`Area

Area(circle: Circle): number
Calculates the area of the circle.
Parameters
- circle: Circle
  The Circle to get the area of.
Returns number
Inherited from Circle.Area
- Defined in types/phaser.d.ts:60164

`Static`Circumference

Circumference(circle: Circle): number
Returns the circumference of the given Circle.
Parameters
- circle: Circle
  The Circle to get the circumference of.
Returns number
Inherited from Circle.Circumference
- Defined in types/phaser.d.ts:60273

`Static`CircumferencePoint

CircumferencePoint<O extends Math.Vector2>(
    circle: Circle,
    angle: number,
    out?: O,
): O
Returns a Vector2 object containing the coordinates of a point on the circumference of the Circle based on the given angle.
Type Parameters
- O extends Math.Vector2
Parameters
- circle: Circle
  The Circle to get the circumference point on.
- angle: number
  The angle from the center of the Circle to the circumference to return the point from. Given in radians.
- Optionalout: O
  A Vector2 to store the results in. If not given a Point will be created.
Returns O
Inherited from Circle.CircumferencePoint
- Defined in types/phaser.d.ts:60281

`Static`Clone

Clone(source: object | Circle): Circle
Creates a new Circle instance based on the values contained in the given source.
Parameters
- source: object | Circle
  The Circle to be cloned. Can be an instance of a Circle or a circle-like object, with x, y and radius properties.
Returns Circle
Inherited from Circle.Clone
- Defined in types/phaser.d.ts:60287

`Static`Contains

Contains(circle: Circle, x: number, y: number): boolean
Check to see if the Circle contains the given x / y coordinates.
Parameters
- circle: Circle
  The Circle to check.
- x: number
  The x coordinate to check within the circle.
- y: number
  The y coordinate to check within the circle.
Returns boolean
Inherited from Circle.Contains
- Defined in types/phaser.d.ts:60295

`Static`ContainsPoint

ContainsPoint(circle: Circle, vec: Math.Vector2): boolean
Check to see if the Circle contains the given x and y coordinates as stored in the Vector2.
Parameters
- circle: Circle
  The Circle to check.
- vec: Math.Vector2
  The Vector2 object to check if its coordinates are within the Circle or not.
Returns boolean
Inherited from Circle.ContainsPoint
- Defined in types/phaser.d.ts:60302

`Static`ContainsRect

ContainsRect(circle: Circle, rect: object | Geom.Rectangle): boolean
Check to see if the Circle contains all four points of the given Rectangle object.
Parameters
- circle: Circle
  The Circle to check.
- rect: object | Geom.Rectangle
  The Rectangle object to check if it's within the Circle or not.
Returns boolean
Inherited from Circle.ContainsRect
- Defined in types/phaser.d.ts:60309

`Static`CopyFrom

CopyFrom<O extends Circle>(source: Circle, dest: O): O
Copies the x, y and radius properties from the source Circle into the given dest Circle, then returns the dest Circle.
Type Parameters
- O extends Circle
Parameters
- source: Circle
  The source Circle to copy the values from.
- dest: O
  The destination Circle to copy the values to.
Returns O
Inherited from Circle.CopyFrom
- Defined in types/phaser.d.ts:60317

`Static`Equals

Equals(circle: Circle, toCompare: Circle): boolean
Compares the x, y and radius properties of the two given Circles. Returns true if they all match, otherwise returns false.
Parameters
- circle: Circle
  The first Circle to compare.
- toCompare: Circle
  The second Circle to compare.
Returns boolean
Inherited from Circle.Equals
- Defined in types/phaser.d.ts:60325

`Static`GetBounds

GetBounds<O extends Geom.Rectangle>(circle: Circle, out?: O): O
Returns the bounds of the Circle object.
Type Parameters
- O extends Geom.Rectangle
Parameters
- circle: Circle
  The Circle to get the bounds from.
- Optionalout: O
  A Rectangle, or rectangle-like object, to store the circle bounds in. If not given a new Rectangle will be created.
Returns O
Inherited from Circle.GetBounds
- Defined in types/phaser.d.ts:60332

`Static`GetPoint

GetPoint<O extends Math.Vector2>(circle: Circle, position: number, out?: O): O
Returns a Vector2 object containing the coordinates of a point on the circumference of the Circle based on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point at 180 degrees around the circle.
Type Parameters
- O extends Math.Vector2
Parameters
- circle: Circle
  The Circle to get the circumference point on.
- position: number
  A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.
- Optionalout: O
  A Vector2 instance to store the return values in. If not given a new Vector2 object will be created.
Returns O
Inherited from Circle.GetPoint
- Defined in types/phaser.d.ts:60342

`Static`GetPoints

GetPoints(
    circle: Circle,
    quantity: number,
    stepRate?: number,
    output?: any[],
): Math.Vector2[]
Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Circle, based on the given quantity or stepRate values.
Parameters
- circle: Circle
  The Circle to get the points from.
- quantity: number
  The amount of points to return. If a falsey value the quantity will be derived from the stepRate instead.
- OptionalstepRate: number
  Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.
- Optionaloutput: any[]
  An array to insert the points in to. If not provided a new array will be created.
Returns Math.Vector2[]
Inherited from Circle.GetPoints
- Defined in types/phaser.d.ts:60352

`Static`Offset

Offset<O extends Circle>(circle: O, x: number, y: number): O
Offsets the Circle by the values given.
Type Parameters
- O extends Circle
Parameters
- circle: O
  The Circle to be offset (translated.)
- x: number
  The amount to horizontally offset the Circle by.
- y: number
  The amount to vertically offset the Circle by.
Returns O
Inherited from Circle.Offset
- Defined in types/phaser.d.ts:60360

`Static`OffsetPoint

OffsetPoint<O extends Circle>(circle: O, vec: Math.Vector2): O
Offsets the Circle by the values given in the x and y properties of the Vector2 object.
Type Parameters
- O extends Circle
Parameters
- circle: O
  The Circle to be offset (translated.)
- vec: Math.Vector2
  The Vector2 object containing the values to offset the Circle by.
Returns O
Inherited from Circle.OffsetPoint
- Defined in types/phaser.d.ts:60367

`Static`Random

Random<O extends Math.Vector2>(circle: Circle, out?: O): O
Returns a uniformly distributed random point from anywhere within the given Circle.
Type Parameters
- O extends Math.Vector2
Parameters
- circle: Circle
  The Circle to get a random point from.
- Optionalout: O
  A Vector2 object to set the random x and y values in.
Returns O
Inherited from Circle.Random
- Defined in types/phaser.d.ts:60374

Class Light

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Light

Properties

bottom

cameraFilter

color

diameter

displayHeight

displayOriginX

displayOriginY

displayWidth

height

intensity

left

ReadonlyoriginX

ReadonlyoriginY

radius

renderFlags

right

scrollFactorX

scrollFactorY

top

Readonlytype

visible

width

x

y

z

zNormal

Static ReadonlyRENDER_MASK

Methods

contains

Parameters

Returns boolean

getPoint

Type Parameters

Parameters

Returns O

getPoints

Type Parameters

Parameters

Returns O

getRandomPoint

Type Parameters

Parameters

Returns O

isEmpty

Returns boolean

setColor

Parameters

Returns this

setDisplayOrigin

Parameters

Returns this

setEmpty

Returns this

setIntensity

Parameters

Returns this

setOrigin

Parameters

Returns this

setOriginFromFrame

Returns this

setPosition

Parameters

Returns this

setRadius

Parameters

Returns this

setScrollFactor

`Readonly`originX

`Readonly`originY

`Readonly`type

`Static` `Readonly`RENDER_MASK

`Static`Area

`Static`Circumference

`Static`CircumferencePoint

`Static`Clone

`Static`Contains

`Static`ContainsPoint

`Static`ContainsRect

`Static`CopyFrom

`Static`Equals

`Static`GetBounds

`Static`GetPoint

`Static`GetPoints

`Static`Offset

`Static`OffsetPoint

`Static`Random