Skip to content

Latest commit

 

History

History
108 lines (79 loc) · 4.84 KB

README.md

File metadata and controls

108 lines (79 loc) · 4.84 KB
Raw

License Latest Version Foundry Version

Latest Downloads Total Downloads

Token Light Condition

A module for FoundryVTT that modifies token effects based on lighting conditions.


Normal light placement
effect-transitions
Light placement with rotation and angle defined
effect-angle-transitions
Token light with rotation and angle.
effect-token-angle

Purpose

Determine the light condition of a token, and generate effects on the token to indicate light condtions.

This is to allow players, or modules to use these effects to help rules determination around those conditions.

Systems Suported

  • dnd5e
  • pf2e

Features

  • Adds a token Hud element to selected token (right-click the token):
  • Hud indicator - ( DRK, DIM, BRT )
  • Adds an Effect when token is in Dim or Dark conditions.
  • Removes Dim/Dark effects while in Bright conditions.
  • Updates tokens on scene Darkness Level changes.
  • Tokens will be updated on drop in scene.
  • Token is only processed if of type (character, npc) and have hp > 0
  • TokenHud light box indicator is only shown if token hp > 0
  • Lighting Control that can enable/disable Token Light Condition use.
  • Option to factor in Scene Global Illumination.
  • Option to delay calculations to increase perf or to delay until after token movement
  • Option to support lights with Negative luminance

Lighting Controls

Look for this Icon on the Lighting Controls

toggle-tlc-icon

When Enabled (default) the module will process the tokens and add/remove Dim/Dark effects as needed.

If you are switching TO enabled, give the module a moment to process all the viable tokens on the scene. enabled-processing

When Disabled, the module will process the tokens and Remove any Dim/Dark effects currently in use. disabled-removing disabled-done

Note

Tokens must be type Characters/NPC, and have an HP > 0 in order to be processed. Otherwise they will be skipped.

Support

Efforts are being made for tokens to respect tile overrides, and other methods. These may work with some degree of success/failure.

  • lights with elevations (Levels)
    • lights are treated as cyclinders, with a top and bottom, that act as ceiling and floors.
    • Testing results around this have been varied based on other mods in use.

Options

Console logging level

Sets the level of console used for logging:

  • No Logging - Use this for no output
  • Debug
  • Log

Show TokenHud

Enables or Disables the display of the light condition on the TokenHud.

  • Adds a token Hud element to selected token (right-click the token):
  • Hud indicator - ( DRK, DIM, BRT )

Source for lighting effect

Choose which source or application the effects are generated from.

  • Disable token effect (None)
  • Token Light Condition (Active Effects)
  • Convienent Effects (CE)

None means there no effects placed on tokens, but the token Hud will still work.

Convienent Effects entries are added on module load if they don't exist.

Global Illumination

Use Scene Global Illumination settings in determination of token light conditions.

Delay Calculations

Delays the light condition calculation by the configured miliseconds. Value of 0, disables the delay feature.

Negative Lights Support

Negative luminance will provide dim or dark conditions instead of removing them.

Suggested Modules