Difference between revisions of "Script:Example"
From Roll20 Wiki
m (→Changelog) |
Andreas J. (Talk | contribs) m |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{revdate}} | ||
| + | {{page template}} | ||
| + | This is an example of an API script listing to demonstrate the format we'd like contributors to mimic. Keeping a unified look will lower the barrier to entry for mentors just learning how to use API scripts in their games. In this space we're looking for a general description of the script and it's use. If there a specific installation instructions you should make a note of it here but detail them in the Help.txt and optionally below in it's own section. | ||
{{script overview | {{script overview | ||
|name=Example | |name=Example | ||
| Line 7: | Line 10: | ||
|dependencies={{api repository link|Bloodied and Dead Status Markers}}, {{api repository link|Raise Count}} | |dependencies={{api repository link|Bloodied and Dead Status Markers}}, {{api repository link|Raise Count}} | ||
|conflicts={{api repository link|Blood-and-Honor}}}} | |conflicts={{api repository link|Blood-and-Honor}}}} | ||
| − | |||
| − | |||
Please do not add a Code section to the wiki. Code listed here would become deprecated very easily and GitHub is the official source for that data. Please only link to the data from the menu to the right. | Please do not add a Code section to the wiki. Code listed here would become deprecated very easily and GitHub is the official source for that data. Please only link to the data from the menu to the right. | ||
| + | |||
| + | API Scripts with great documentation: [[TokenMod]], [[Scriptcards]], [[Roll20 Audio Master]], [[ChatSetAttr]] | ||
== Syntax == | == Syntax == | ||
Latest revision as of 13:48, 24 November 2021
 | Page Updated: 2021-11-24 |
 | This is a wiki page template, to have an easier starting point for creating some types of pages. See Category:Page Template for other templates. |
This is an example of an API script listing to demonstrate the format we'd like contributors to mimic. Keeping a unified look will lower the barrier to entry for mentors just learning how to use API scripts in their games. In this space we're looking for a general description of the script and it's use. If there a specific installation instructions you should make a note of it here but detail them in the Help.txt and optionally below in it's own section.
Version: 1.0
Last Modified: 2015-01-06
Code: The Darkness is Closing In
Dependencies: Bloodied and Dead Status Markers, Raise Count
Conflicts: Blood-and-Honor
Please do not add a Code section to the wiki. Code listed here would become deprecated very easily and GitHub is the official source for that data. Please only link to the data from the menu to the right.
API Scripts with great documentation: TokenMod, Scriptcards, Roll20 Audio Master, ChatSetAttr
Contents |
[edit] Syntax
!example
!example 3
!example off
[edit] Installation and Configuration
Copy the script's code, available from the menu on the right and stored at Roll20's API GitHub Repository. Paste the code into a new script in your campaign's API Script Editor. Save the new script and it will be available inside your campaign.
[edit] Script Use
Start the script with the "!example" command and turn it off with "!example off". If you wish for the script to execute multiple times when called add a positive number after the on command, "!example 3".
[edit] Changelog
v1.1 (2015-01-07)
- Included better documentation
- Fixed formatting issues
v1.0 (2015-01-06)
- Release
