Difference between revisions of "Script:Triggered Cleanup"
From Roll20 Wiki
Jeffrey S. (Talk | contribs) |
Andreas J. (Talk | contribs) m |
||
| Line 1: | Line 1: | ||
{{revdate}} | {{revdate}} | ||
| − | |||
The Triggered Cleanup API was generated as a Utility Mod to help improve optimization. During play in a Living Community/West Marches style campaign, where sessions are a series of one-offs with varying participation of players and rotating Game Masters, it was found that manual cleanup was necessary to improve reactions of APIs and overall experience of the VTT. This API applies two features to help with the cleanup. The first is an API command that removes all tokens on all maps, to include archived maps and excluding any maps with the term 'bullpen' (not case-sensitive) in the title. | The Triggered Cleanup API was generated as a Utility Mod to help improve optimization. During play in a Living Community/West Marches style campaign, where sessions are a series of one-offs with varying participation of players and rotating Game Masters, it was found that manual cleanup was necessary to improve reactions of APIs and overall experience of the VTT. This API applies two features to help with the cleanup. The first is an API command that removes all tokens on all maps, to include archived maps and excluding any maps with the term 'bullpen' (not case-sensitive) in the title. | ||
{{script overview | {{script overview | ||
Latest revision as of 14:48, 2 August 2023
 | Page Updated: 2023-08-02 |
The Triggered Cleanup API was generated as a Utility Mod to help improve optimization. During play in a Living Community/West Marches style campaign, where sessions are a series of one-offs with varying participation of players and rotating Game Masters, it was found that manual cleanup was necessary to improve reactions of APIs and overall experience of the VTT. This API applies two features to help with the cleanup. The first is an API command that removes all tokens on all maps, to include archived maps and excluding any maps with the term 'bullpen' (not case-sensitive) in the title.
Version: 1.0
Last Modified: 2023-06-26
Code: Triggered Cleanup
Dependencies: None
Conflicts: None
[edit] Installation and Configuration
Triggered Cleanup can be added to a table using the Mod Scripts option in the Settings of the main page for a given table. It can be added from the Roll20 Mods Library. There are no configuration requirements.
[edit] Script Use
The script only requires the use of a single command: [!cleanup]. This command is not case-sensitive. It will delete every token on every layer on every map, archives included and with the exception of any maps with the term 'bullpen' in the name.
Additionally, whenever a character sheet is deleted, any tokens that represent that character sheet will also be removed from every layer on every map, archives included and with the exception of any maps with the term 'bullpen' in the name. The expected time it takes to perform this action has been seen between 3 and 9 seconds on smaller tables (roughly 2 and 20 maps), and can be expected to take longer on larger tables.
