Difference between revisions of "Script:Savage Worlds - Raise Count"
From Roll20 Wiki
m (235259 moved page User:235259/Raise Count to Script:Raise Count) |
|||
| Line 1: | Line 1: | ||
| − | + | {{script overview | |
| + | |name=Raise Count | ||
| + | |author={{user profile|235259|Brian}} | ||
| + | |version=2.0 | ||
| + | |lastmodified=2015-01-08}} | ||
| − | + | '''Raise Count''' creates the API command <code>!rc</code>, which rolls dice and counts the number of raises for the [[Savage Worlds]] game system. | |
| − | + | <br clear="all"> | |
| − | {| | + | === Syntax === |
| − | | | + | {{syntaxbox top|Raise Count|formal=true}} |
| − | + | {{API command|rc}} {{API parameter|name=roll}} {{API parameter|name=target}} | |
| − | + | {{Formal API command| | |
| − | | | + | {{token|S}} {{rarr}} {{API command|rc}} {{token|dice expression}} {{integer|-}} |
| − | | | + | {{dice expression}} |
| − | | | + | }} |
| − | |- | + | {{syntaxbox end}} |
| − | + | ||
| − | + | ||
| − | + | ||
| − | == | + | {{param description top}} |
| − | < | + | {{param description|name=roll|value=A dice roll, using Roll20's normal syntax. Do '''not''' include the <code>/r</code> command or inline brackets (<nowiki>[[ and ]]</nowiki>).}} |
| − | + | {{param description|name=target|value=The target number for the roll. The number of raises will be calculated against this target.}} | |
| + | {{param description bottom}} | ||
| − | + | === Installation === | |
| − | + | The format of the output can be customized by altering <code>config.outputFormat</code>, found near the top of the script. You may use the placeholders <code>{0}</code>, <code>{1}</code>, and <code>{2}</code> in the <code>outputFormat</code> string, which will become an inline roll, the value of ''target'', and the number of raises, respectively. | |
| − | // | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | You can change the size of a raise use to calculate the number of raises by altering the value of <code>config.raiseSize</code>. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Revision as of 18:01, 14 January 2015
API ScriptAuthor: Brian
Version: 2.0
Last Modified: 2015-01-08
Code: Raise Count
Dependencies: None
Conflicts: None
Version: 2.0
Last Modified: 2015-01-08
Code: Raise Count
Dependencies: None
Conflicts: None
Raise Count creates the API command !rc, which rolls dice and counts the number of raises for the Savage Worlds game system.
Syntax
!rc <roll> <target>Formally:
S→ !rcdice expressioninteger
dice expression→roll
dice expression→dice expression
modifier
dice expression→ {expression list}
group modifier
dice expression→dice expressionoperatordice expression
dice expression→function(
dice expression)
roll→math expressiondf
roll→math expressiond
math expression
math expression→ integer
math expression→ (math expressionoperatormath expression)
operator→ +
operator→ -
operator→ *
operator→ /
function→ floor
function→ ceil
function→ round
function→ abs
modifier→compare
modifier→ fcompare
modifier→ !compare
modifier→ !!compare
modifier→ !pcompare
modifier→ rcompare
modifier→ rocompare
modifier→keep-drop
modifier→ s
modifier→ sd
compare→ ε
compare→ integer
compare→ >integer
compare→ <integer
keep-drop→keep
keep-drop→keepinteger
keep-drop→drop
keep-drop→dropinteger
keep→ k
keep→ kh
keep→ kl
drop→ d
drop→ dh
drop→ dl
expression list→dice expression,
rest expression list
rest expression list→dice expression
rest expression list→expression list
group modifier→keep-drop
group modifier→compare
group modifier→ fcompare
| Parameter | Values |
|---|---|
| roll | A dice roll, using Roll20's normal syntax. Do not include the /r command or inline brackets ([[ and ]]).
|
| target | The target number for the roll. The number of raises will be calculated against this target. |
Installation
The format of the output can be customized by altering config.outputFormat, found near the top of the script. You may use the placeholders {0}, {1}, and {2} in the outputFormat string, which will become an inline roll, the value of target, and the number of raises, respectively.
You can change the size of a raise use to calculate the number of raises by altering the value of config.raiseSize.
