Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Script:Move Lighting

From Roll20 Wiki

Jump to: navigation, search
API ScriptAuthor: Kastion
Version: 0.1.4
Last Modified: 2018-05-02
Code: moveLighting
Dependencies: None
Conflicts: None

NOTE: THIS SCRIPT IS NOT YET AVAILABLE AND IS AWAITING PULL REQUEST AUTHENTICATION ON GITHUB - ETA TO AVAILABILITY = 1 to 2 WEEKS

This script lets you quickly move a dynamic lighting polygon path object from one game layer to another game layer.

Contents

Syntax

!movelight
!movelight <map,objects,gmlayer,walls> <id>

Installation and Configuration

MoveLighting currently isn't available as a one click install option and must be installed manually.

You can copy the script's code, available from the menu on the right and stored at Roll20's API GitHub Repository. Paste the code into a new script in your campaign's API Script Editor. Save the new script and it will be available inside your campaign.

Script Use

To use simply type !movelight [layer] [object ID] into the chat.

Valid Layers:
map
objects
gmlayer
walls

Example of running the command:
Move dynamic lighting polygon object from lighting layer to GM Layer:
!movelight gmlayer -L9XSOq-voBH6SR73hpH

Move dynamic lighting polygon object from GM layer back to lighting layer (this will restore path obstruction and line of sight etc. etc.)
!movelight walls -L9XSOq-voBH6SR73hpH

This script was built for its synergy with the script Token Mod due to the fact that Token Mod does not support moving dynamic lighting polygon path objects. Here is an example of using the two scripts together to open / close doors on a map.
Get the ID of the dynamic lighting polygon object obstructing path and line of sight through the door and store it in bar1 of the door token graphic. Then you can create the following two macros:

Open Door
!movelight gmlayer @{selected|bar1}
!token-mod --set layer|gmlayer --ids @{selected|token_id}

Close Door
!movelight walls @{selected|bar1}
!token-mod --set layer|objects --ids @{selected|token_id}

Then to use these macros, have the door on the object layer, select the door, and run the Open Door macro. Then move to the GM Layer, select the door, and run the Close Door macro.

Changelog

v0.1.4 (2018-05-02)

  • Initial release