Class Light

Classdesc

Light class, used for creating lights in the scene

Example

// light at position [0, 0], diffuse 100, strength 0.8, color [255, 255, 255] (white)
const light = new Light([0, 0], 100, 0.8, [255, 255, 255]);

Example

// light at position [0, 0], diffuse 150, defualt strength (0.8), defualt color (white)
const light = new Light([0, 0], 150);

Hierarchy (view full)

Constructors

constructor

Properties

color diffuse pinnedTo point strength type

Methods

brighten dim move moveToObject pin update

Constructors

constructor

  • new Light(position, diffuse, strength?, color?): Light

  • Parameters

    • position: Vec2

      The position of the light in wolrd space [x,y]

    • diffuse: number

      How far the light diffuses, in pixels

    • strength: number = 0.8

      The strength of the light. Default is 0.8

    • color: number[] = ...

      The color of the light, [r,g,b]. By defualt is [255, 255, 255] (white)

    Returns Light

Properties

color

color: number[]

Color of the light. Format is [r,g,b]. White by default

diffuse

diffuse: number

How much the light diffuses (measured in pixels)

pinnedTo

pinnedTo: null | GameObject

Object to pin the light's position to. Null by default.

point

point: Vec2

Coordinates of the light

strength

strength: number

Strength of the light. No matter how strong it is, it will never go past the bounds defined by diffuse

type

type: string

Type of the light, either "light" or "directional"

Methods

brighten

  • brighten(factor): void

  • Brightens the light by the specified factor

    Parameters

    • factor: number

      The factor to brighten the light by

    Returns void

dim

  • dim(factor): void

  • Dims the light by the specified factor

    Parameters

    • factor: number

      The factor to dim the light by

    Returns void

move

  • move(vector): void

  • Moves the light by the specified vector

    Parameters

    • vector: Vec2

      The vector to move the light by

    Returns void

    Example

    const light = new Light([0, 0], 0.5);
    light.move([10, 10]); // moves the light ten pixels to the right and ten pixels down

moveToObject

  • moveToObject(object): void

  • Moves the light to the center of the specified GameObject (Good for things like lanterns, etc.)

    Parameters

    • object: GameObject

      GameObject to move the light's position to

    Returns void

pin

  • pin(object): void

  • Pins the light's position to a certain GameObject

    Parameters

    • object: GameObject

      The GameObject to pin the light to

    Returns void

update

  • update(canvas): void

  • Updates the light's position if pinned to an object, otherwise does nothing

    Parameters

    • canvas: HTMLCanvasElement

      The canvas to draw the light on (Optional).

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc