API Docs for:
Show:

LightingROT Class

Defined in: src/lighting-rot.js:4

Represents lighting in the game map. requires ROT.js Manages position of lights. Calculates illumination of map tiles.

Constructor

LightingROT

(
  • game
  • [settings]
)

Defined in src/lighting-rot.js:4

Parameters:

  • game Game
    • Game instance this obj is attached to.
  • [settings] Object optional
    • LightingROT settings object.
    • [range] Number optional
      • Maximum range for the most powerful light source.
    • [passes] Number optional
      • Number of computation passes (1: no reflectivity used, 2: reflectivity used)
    • [emissionThreshold] Number optional
      • Minimal amount of light at a cell to be re-emited (only for passes>1).

Methods

checkVisible

(
  • x
  • y
)

Defined in src/lighting-rot.js:215

Checks if a tile blocks line of sight

Parameters:

  • x Number
    • Map tile x coord.
  • y Number
    • Map tile y coord.

get

(
  • x
  • y
)

Defined in src/lighting-rot.js:157

Retrieves the visibility of the tile at given coords

Parameters:

  • x Number
    • The map coordinate position to get Lighting visibility from on the x axis.
  • y Number
    • The map coordinate position to get Lighting visibility from on the y axis.

getTileReflectivity

(
  • x
  • y
)

Defined in src/lighting-rot.js:191

Returns the reflectivity value of a tile

Parameters:

  • x Number
    • Map tile x coord.
  • y Number
    • Map tile y coord.

remove

(
  • x
  • y
)

Defined in src/lighting-rot.js:181

Parameters:

  • x Number
    • Map tile x coord.
  • y Number
    • Map tile y coord.

set

(
  • x
  • y
  • r
  • g
  • b
)

Defined in src/lighting-rot.js:167

Set a light position and color

Parameters:

  • x Number
    • The map coordinate position to set lightin on the x axis.
  • y Number
    • The map coordinate position to set lightin on the y axis.
  • r Number
    • Red.
  • g Number
    • Green.
  • b Number
    • Blue.

setSize

(
  • width
  • height
)

Defined in src/lighting-rot.js:226

Sets the size of the map to mange Lighting within.

Parameters:

  • width Number
    • Width of current map in tiles.
  • height Number
    • Height of current map in tiles.

shadeTile

(
  • x
  • y
  • tileData
)
TileData

Defined in src/lighting-rot.js:113

Shades tileData using lighting.

Parameters:

  • x Number
    • The x map coordinate to shade.
  • y Number
    • The y map coordinate to shade.
  • tileData TileData
    • The TileData object to shade.

Returns:

TileData:

update

()

Defined in src/lighting-rot.js:101

Calculates the Lighting data relative to given coords;

Properties

_dirty

Bool private

Defined in src/lighting-rot.js:93

If lighting data has changed and needs to be recalculated.

_fov

ROT.FOV private

Defined in src/lighting-rot.js:77

ROT.FOV instance

_lighting

ROT.Lighting private

Defined in src/lighting-rot.js:85

ROT.Lighting instance

ambientLight

Array

Defined in src/lighting-rot.js:70

Ambient light

defaultFloorReflectivity

Number

Defined in src/lighting-rot.js:63

Reflectivity of floor tiles.

defaultWallReflectivity

Number

Defined in src/lighting-rot.js:56

Reflectivity of wall tiles.

game

Game

Defined in src/lighting-rot.js:42

Game instance this obj is attached to.

lightingMap

Array2d

Defined in src/lighting-rot.js:49

Array2d storing Lighting data.