Difference between revisions of "Script:Store Commands"
From Roll20 Wiki
m |
Andreas J. (Talk | contribs) (redirect to Script Index, API no longer available) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | #Redirect[[API:Script Index]] | |
| + | <!-- Don't delete redirect, help center links to this page even though API have been removed | ||
| + | [[Category:Discontinued API Scripts]] --> | ||
| + | |||
| + | script overview | ||
|name=Store Commands | |name=Store Commands | ||
|author={{user profile|235259|Brian}} | |author={{user profile|235259|Brian}} | ||
| − | |version=2. | + | |version=2.3 |
| − | |lastmodified= | + | |lastmodified=2016-03-09 |
|dependencies={{api repository link|splitArgs}} | |dependencies={{api repository link|splitArgs}} | ||
| − | |conflicts={{api repository link|Dynamic Lighting Animation | + | |conflicts={{api repository link|Dynamic Lighting Animation}} |
'''Store Commands''' creates the API commands <code>!delay</code>, <code>!store</code>, <code>!clearstore</code>, <code>!echostore</code>, and <code>!run</code>. Together, these commands allow a user to store a series of commands, and then run these commands in order, with a delay between them. | '''Store Commands''' creates the API commands <code>!delay</code>, <code>!store</code>, <code>!clearstore</code>, <code>!echostore</code>, and <code>!run</code>. Together, these commands allow a user to store a series of commands, and then run these commands in order, with a delay between them. | ||
| Line 11: | Line 15: | ||
=== Syntax === | === Syntax === | ||
| + | <!-- suppress category | ||
{{syntaxbox top|Store Commands|formal=true}} | {{syntaxbox top|Store Commands|formal=true}} | ||
{{API command|delay}} {{API parameter|name=time}}<br> | {{API command|delay}} {{API parameter|name=time}}<br> | ||
| Line 31: | Line 36: | ||
{{param description|name=command|value=A command to store for later use. This can be anything you could normally enter in chat, as well as the [[API:Chat#Chat Functions|/direct]] command.}} | {{param description|name=command|value=A command to store for later use. This can be anything you could normally enter in chat, as well as the [[API:Chat#Chat Functions|/direct]] command.}} | ||
{{param description bottom}} | {{param description bottom}} | ||
| − | + | --> | |
==== Using the commands ==== | ==== Using the commands ==== | ||
| Line 45: | Line 50: | ||
=== Changelog === | === Changelog === | ||
| + | {{changelog version|2.3|2016-03-09|* Update for one-click install}} | ||
| + | {{changelog version|2.2|2015-01-24|* [bugfix] no-arg crash}} | ||
{{changelog version|2.1|2015-01-22|* Fixed transcription error}} | {{changelog version|2.1|2015-01-22|* Fixed transcription error}} | ||
{{changelog version|2.0|2015-01-08|* Release}} | {{changelog version|2.0|2015-01-08|* Release}} | ||
Latest revision as of 19:56, 20 September 2021
- RedirectAPI:Script Index
script overview |name=Store Commands |author=Brian |version=2.3 |lastmodified=2016-03-09 |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.
[edit] Syntax
[edit] 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.
[edit] Changelog
v2.3 (2016-03-09)
- Update for one-click install
v2.2 (2015-01-24)
- [bugfix] no-arg crash
v2.1 (2015-01-22)
- Fixed transcription error
v2.0 (2015-01-08)
- Release
