Class TileLighting

Tile-based flood-fill lighting system. Computes a light map grid that can be used as alpha overlay.

Usage:

const lighting = new TileLighting(mapWidth, mapHeight);
lighting.setAmbient(0.1); // base darkness
lighting.addLight({ x: 5, y: 5, radius: 8, intensity: 1 });
lighting.compute();
const brightness = lighting.get(3, 3); // 0-1

Index

Constructors

constructor

new TileLighting(width: number, height: number): TileLighting
Parameters
- width: number
- height: number
Returns TileLighting
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:33

Accessors

lightCount

get lightCount(): number
Returns number
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:125

Methods

addLight

addLight(light: LightSource): this
Add a dynamic light source
Parameters
- light: LightSource
Returns this
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:58

clear

clear(): void
Reset everything

Returns void
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:130

clearLights

clearLights(): this
Clear all lights (keeps opaque/ambient settings)

Returns this
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:64

compute

compute(): void
Recompute the light map. Call after adding/moving lights.

Returns void
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:76

get

get(x: number, y: number): number
Get brightness at a tile (0 = dark, 1 = fully lit)
Parameters
- x: number
- y: number
Returns number
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:111

getLightMap

getLightMap(): Grid2D<number>
Get the raw light map grid

Returns Grid2D<number>
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:116

getLights

getLights(): readonly LightSource[]
Get all light sources

Returns readonly LightSource[]
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:121

isOpaque

isOpaque(x: number, y: number): boolean
Check if a tile is opaque
Parameters
- x: number
- y: number
Returns boolean
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:53

setAmbient

setAmbient(level: number): this
Set ambient light level (0 = total darkness, 1 = fully lit)
Parameters
- level: number
Returns this
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:40

setLights

setLights(lights: LightSource[]): this
Set lights from a list (replaces existing)
Parameters
- lights: LightSource[]
Returns this
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:70

setOpaque

setOpaque(x: number, y: number, opaque?: boolean): this
Mark a tile as opaque (blocks light)
Parameters
- x: number
- y: number
- opaque: boolean = true
Returns this
- Defined in packages/clik-engine/src/tilemap/TileLighting.ts:46

Class TileLighting

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TileLighting

Accessors

lightCount

Returns number

Methods

addLight

Parameters

Returns this

clear

Returns void

clearLights

Returns this

compute

Returns void

get

Parameters

Returns number

getLightMap

Returns Grid2D<number>

getLights

Returns readonly LightSource[]

isOpaque

Parameters

Returns boolean

setAmbient

Parameters

Returns this

setLights

Parameters

Returns this

setOpaque

Parameters

Returns this

Settings

On This Page