
AddCustomTurn provides an easy way to add (and remove) custom turns which increment or decrement, and have auto delete features.
Commands
Add a custom turn to the Turn Order, with options for adjusting it each turn, and removing it when it has a specified value.
Positional Arguments- <formula> -- The formula for changing the turn.
+
or-
prepended to the number specify the direction. (Default:+1
) - <initial> -- The initial value for the custom turn. (Default:
0
)
- --<custom turn name> -- The name of the custom turn to add.
- --delete-on-zero -- deletes the custom turn when its value is less than or equal to 0. Shorthand for
--delete-le 0
. - --delete-lt <number> -- deletes the custom turn when its value is less than
<number>
. - --delete-le <number> -- deletes the custom turn when its value is less than or equal to
<number>
. - --delete-eq <number> -- deletes the custom turn when its value is equal to
<number>
. - --delete-ge <number> -- deletes the custom turn when its value is greater than or equal to
<number>
. - --delete-gt <number> -- deletes the custom turn when its value is greater than
<number>
. - --after -- adds the custom turn after the current turn. Shorthand for
--index 1
. - --index <number> -- adds the custom turn after the entry at index
<number>
. - --help -- Shows the Help screen.
Remove a custom turn from the turn order by name. When used by the GM, removes the first custom turn with the given name. When used by a player, removes the first custom turn they created with the given name.
Positional Arguments- <custom turn name> -- The name of the custom turn to remove.
- --help -- Shows the Help screen.
Examples
Add a turn that just counts up. Custom turn names can contain spaces:
Add a turn that counts down from 10:
Add a turn that counts down from 10 and is after the first item in the turn order (All examples are the same):
Add a turn that counts down from 10 and removes itself when it reaches 0 (All examples are the same):
Supports multi-line syntax by wrapping with {{
and }}
:
--Bless [Bob the Slayer]
--delete-on-zero
--after
}}
Removing a turn named Bless
:
Removing a turn named Bless [Bob the Slayer]
:
Github link: https://github.com/shdwjk/Roll20API/blob/master/AddCustomTurn/AddCustomTurn.js