Cron allows a user to schedule commands to run at some point in the future. Jobs can be scheduled based on the turn tracker or clock time (relative to now or at some specific time in the future), and can optionally recur at a specified interval. Each job is given a unique ID, which can be used to remove it at a later time.

It is recommended that this script be used in conjunction with the CommandShell module, which will improve output formatting and command discovery.

Syntax

!cron [options] <command>
!cron -l
!cron -R <job ID>

Formally:

S

→ cron options

string

S

→ cron -l

S

→ cron -R job ids

options

→ option

options

options

→ ε

option

→ -string

option

→ --string

option

→ -string string

option

→ --string string

job ids

→ string

job ids

→ job ids

string

Examples

!cron -r 10 The bomb's timer reaches zero! It explodes for [[10d10]] damage.

Called on the initiative count in which the bomb's timer is set, it will explode in 10 rounds.

!cron -c 12 -i 1 -f "Hey, eejit!" /w gm Don't forget the spider's turn

A forgetful GM might use this subtle reminder that the party's mage summoned a spider which acts on the mage's initiative count (12, in this example).

!cron -f "Acid Rain" -i 1 The acid burns for [[2d6]] damage.

Inline roll results are stripped from the command and replaced with the original roll expression. Long story short: the above gives a new damage roll each round.

!cron -f Nanny -t 23:00 Bedtime for sleepy-head. Time to wrap things up.

Be aware that the time zone is GMT, not local time of the client who runs the command.

!cron -a 30 Hey! It's 30 seconds later than when I typed this.

Probably more useful with larger delay amounts.

!cron -t 0:00:00 -i 1:00:00 /desc The clock chimes.

This will fire every hour, on the hour. (Can also just do "-t 0").

!cron -r 10 "!cron -R 42"

This will remove job 42 after 10 rounds. Note that the quotes are required around commands which contain tokens which are valid !cron arguments (e.g. "-R"). Without the quotes, this will immediately remove job 42.

Changelog

v0.6 (2015-06-11)

• Add support for executing CommandShell-aware API commands

v0.5 (2015-05-26)

• Add seamless roll template handling

v0.4 (2015-05-11)

• Use GMT instead of API server timezone

v0.3 (2015-05-11)

• Fix broken firing of count-based jobs

v0.2 (2015-05-08)

• Add workaround for roll templates

v0.1 (2015-04-28)

• Initial release