Difference between revisions of "Script:Move Lighting"
From Roll20 Wiki
Kastion S. (Talk | contribs) |
Andreas J. (Talk | contribs) m |
||
| Line 1: | Line 1: | ||
| + | {{revdate}} | ||
{{script overview | {{script overview | ||
|name=Move Lighting | |name=Move Lighting | ||
| Line 6: | Line 7: | ||
|code=moveLighting}} | |code=moveLighting}} | ||
| − | + | This script lets you quickly move a [[Dynamic Lighting]] line(polygon path object) from one [[Layers|game layer]] to another layer. | |
| − | + | ||
| − | This script lets you quickly move a | + | |
== Syntax == | == Syntax == | ||
| Line 17: | Line 16: | ||
== Installation and Configuration == | == Installation and Configuration == | ||
| − | ' | + | It's in the API install menu |
You can copy the script's code, available from the menu on the right and stored at Roll20's [https://github.com/Roll20/roll20-api-scripts API GitHub Repository]. Paste the code into a new script in your campaign's [[API:Use_Guide#The_Script_Editor|API Script Editor]]. Save the new script and it will be available inside your campaign. | You can copy the script's code, available from the menu on the right and stored at Roll20's [https://github.com/Roll20/roll20-api-scripts API GitHub Repository]. Paste the code into a new script in your campaign's [[API:Use_Guide#The_Script_Editor|API Script Editor]]. Save the new script and it will be available inside your campaign. | ||
== Script Use == | == Script Use == | ||
| − | To use simply type !movelight [layer] [object ID] into the chat. <br /> | + | To use simply type {{c|!movelight [layer] [object ID]}} into the chat. <br /> |
<br /> | <br /> | ||
'''Valid Layers:'''<br /> | '''Valid Layers:'''<br /> | ||
| Line 31: | Line 30: | ||
<br /> | <br /> | ||
'''Example of running the command:'''<br /> | '''Example of running the command:'''<br /> | ||
| − | Move dynamic lighting polygon object from lighting layer to GM Layer:< | + | Move dynamic lighting polygon object from lighting layer to GM Layer: |
| − | !movelight gmlayer -L9XSOq-voBH6SR73hpH< | + | <pre>!movelight gmlayer -L9XSOq-voBH6SR73hpH</pre> |
| − | + | ||
Move dynamic lighting polygon object from GM layer back to lighting layer (this will restore path obstruction and line of sight etc. etc.)<br/> | Move dynamic lighting polygon object from GM layer back to lighting layer (this will restore path obstruction and line of sight etc. etc.)<br/> | ||
| − | !movelight walls -L9XSOq-voBH6SR73hpH< | + | <pre>!movelight walls -L9XSOq-voBH6SR73hpH</pre> |
| − | + | ||
This script was built for its synergy with the script [[Script:Token Mod|Token Mod]] due to the fact that [[Script:Token Mod|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.<br /> | This script was built for its synergy with the script [[Script:Token Mod|Token Mod]] due to the fact that [[Script:Token Mod|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.<br /> | ||
| − | 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 | + | Get the ID of the dynamic lighting polygon object obstructing path and line of sight through the door and store it in {{c|bar1}} of the door [[token]]. |
| − | '''Open Door'''< | + | |
| − | !movelight gmlayer @{selected|bar1} | + | Then you can create the following two macros:<br /><br /> |
| − | !token-mod --set layer|gmlayer --ids @{selected|token_id}< | + | '''Open Door''' |
| − | + | <pre>!movelight gmlayer @{selected|bar1} | |
| + | !token-mod --set layer|gmlayer --ids @{selected|token_id}</pre> | ||
| + | |||
'''Close Door'''<br /> | '''Close Door'''<br /> | ||
| − | !movelight walls @{selected|bar1} | + | <pre>!movelight walls @{selected|bar1} |
| − | !token-mod --set layer|objects --ids @{selected|token_id}< | + | !token-mod --set layer|objects --ids @{selected|token_id}</pre> |
| − | + | ||
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. | 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 == | == Changelog == | ||
{{changelog version|0.1.4|2018-05-02|* Initial release}} | {{changelog version|0.1.4|2018-05-02|* Initial release}} | ||
| + | |||
| + | [[Category:Dynamic Lighting]] | ||
Revision as of 10:24, 9 March 2022
 | Page Updated: 2022-03-09 |
Version: 0.1.4
Last Modified: 2018-05-02
Code: moveLighting
Dependencies: None
Conflicts: None
This script lets you quickly move a Dynamic Lighting line(polygon path object) from one game layer to another layer.
Contents |
Syntax
!movelight
!movelight <map,objects,gmlayer,walls> <id>
Installation and Configuration
It's in the API install menu
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.
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
