Roll20 Wiki

API ScriptAuthor: Brian
Version: 2.0
Last Modified: 2015-01-08
Code: Store Commands
Dependencies: splitArgs
Conflicts: Dynamic Lighting Animation

Store Commands creates the API commands !delay, !store, !clearstore, !echostore, and !run. Together, these commands allow a user to store a series of commands, and then run these commands in order, with a delay between them.

Syntax

!delay <time>
!store [-time] <command>
!clearstore
!echostore
!run
Formally:
S
→ !delay integer
S
→ !store -integer string
S
→ !store string
S
→ !clearstore
S
→ !echostore
S
→ !run

Parameter	Values
time	A time delay in milliseconds. The `!delay` command will set the default delay for the `!store` command. A delay set using the `!store` command will override that default, but only for that command. Using `!delay` will not change the delays of already stored commands. 500ms will be used if no delay is ever specified.
command	A command to store for later use. This can be anything you could normally enter in chat, as well as the /direct command.

Using the commands

Use !delay to set a default delay between commands. Alternatively, the optional argument of !store can be used to set the delay for one command. If no delay is set, 500ms will be used.

Use !store to store commands to be executed later. Any command can be stored, from regular chat to whispers to API commands to the /direct command that is normally accessible only from the API.

!clearstore will clear your current store of commands. !echostore will tell you exactly what you have stored at the moment, and what the delay values are.

When you call !run, all of the stored commands will be used in order, with their delay between each one. Any messages to the chat will be sent as though you (the player) sent the message. The !run command does not clear your store, so you can run it again several times in a row.

Stores are not maintained between sessions, and each player has his or her own store.