Difference between revisions of "Script:InitiativeTracker"
From Roll20 Wiki
(major formatting changes) |
Andreas J. (Talk | contribs) (Api discontinued, link to closest replacement) |
||
| Line 1: | Line 1: | ||
| − | + | #redirect[[Script:InitiativeTrackerPlus]] | |
| + | |||
| + | don't delete page, redirect is for legacy links | ||
| + | |||
| + | script overview | ||
|name=InitiativeTracker | |name=InitiativeTracker | ||
|author={{user profile|503018|manveti}} | |author={{user profile|503018|manveti}} | ||
|version=1.0 | |version=1.0 | ||
| − | |lastmodified=2015-01-07 | + | |lastmodified=2015-01-07 |
'''InitiativeTracker''' tracks initiative, rounds, and status conditions. The start of each round, as well as the start of each character's turn, can be announced in the chat. Status icons are automatically managed (counting down the last 9 rounds of the status duration), and status expiration can be announced in the chat as well. | '''InitiativeTracker''' tracks initiative, rounds, and status conditions. The start of each round, as well as the start of each character's turn, can be announced in the chat. Status icons are automatically managed (counting down the last 9 rounds of the status duration), and status expiration can be announced in the chat as well. | ||
| Line 14: | Line 18: | ||
=== Syntax === | === Syntax === | ||
| + | <!-- suppress category | ||
{{syntaxbox top|InitiativeTracker|formal=true}} | {{syntaxbox top|InitiativeTracker|formal=true}} | ||
{{API command|tracker}} {{API parameter|name=tracker action}} {{API parameter|name=tracker parameters|optional=true}}<br> | {{API command|tracker}} {{API parameter|name=tracker action}} {{API parameter|name=tracker parameters|optional=true}}<br> | ||
| Line 84: | Line 89: | ||
* '''remove''': If a status id is provided, the status will be removed. Otherwise, all statuses will be removed. Use <code>!status list</code> to discover the appropriate values for ''id''.}} | * '''remove''': If a status id is provided, the status will be removed. Otherwise, all statuses will be removed. Use <code>!status list</code> to discover the appropriate values for ''id''.}} | ||
{{param description bottom}} | {{param description bottom}} | ||
| − | + | --> | |
=== Installation === | === Installation === | ||
Status icon names can be somewhat cryptic. You can create your own aliases for frequently-used icons by adding entries in <code>Tracker.STATUS_ALIASES</code>, defined near the top of the script. Each new alias should be a key, and the associated value should be an icon name from <code>Tracker.ALL_STATUSES</code> (defined just above <code>Tracker.STATUS_ALIASES</code>). This is optional, but it may assist in the usage of <code>!status add</code>. | Status icon names can be somewhat cryptic. You can create your own aliases for frequently-used icons by adding entries in <code>Tracker.STATUS_ALIASES</code>, defined near the top of the script. Each new alias should be a key, and the associated value should be an icon name from <code>Tracker.ALL_STATUSES</code> (defined just above <code>Tracker.STATUS_ALIASES</code>). This is optional, but it may assist in the usage of <code>!status add</code>. | ||
Latest revision as of 22:00, 20 September 2021
- redirectScript:InitiativeTrackerPlus
don't delete page, redirect is for legacy links
script overview |name=InitiativeTracker |author=manveti |version=1.0 |lastmodified=2015-01-07
InitiativeTracker tracks initiative, rounds, and status conditions. The start of each round, as well as the start of each character's turn, can be announced in the chat. Status icons are automatically managed (counting down the last 9 rounds of the status duration), and status expiration can be announced in the chat as well.
The initiative tracker is triggered automatically when you sort the entries in the turn tracker. Under the default settings, this will generate a message announcing the start of round 1, followed by a message announcing the start of the turn for the character at the top of the initiative order. These announcements can be disabled using the !tracker command described below.
Each time the turn tracker advances, any status effects operating on any initiative count between the previous count and the current count will have their durations decremented. Any status whose new duration is zero or less will be removed; any status whose new duration is 9 or less will have its icon counter updated to reflect the number of rounds remaining. If the initiative count has wrapped around, the round counter will be incremented, and the start of the new round will be announced (if enabled). Finally, the start of the next character's turn will be announced (if enabled).
It is recommended that this script be used in conjunction with the CommandShell module, which will improve output formatting and command discovery.
[edit] Syntax
[edit] Installation
Status icon names can be somewhat cryptic. You can create your own aliases for frequently-used icons by adding entries in Tracker.STATUS_ALIASES, defined near the top of the script. Each new alias should be a key, and the associated value should be an icon name from Tracker.ALL_STATUSES (defined just above Tracker.STATUS_ALIASES). This is optional, but it may assist in the usage of !status add.
[edit] Changelog
v1.0 (2015-01-07)
- Release
