Roll20 Wiki

{{script overview
|name=ExtendedExpressions
|author={{user profile|503018|manveti}}
|version=0.5
|lastmodified=2015-06-11}}

'''ExtendedExpressions''' extends the built-in expression syntax to allow multiple references to a single roll within an expression, advanced bitwise, logical, and arithmetic operations, and more.  Expressions are evaluated internally where necessary, but care is taken to pass as much of each expression as possible along to the builtin expression evaluator in order to make [[Inline Roll|inline roll]] tooltips as complete as possible.

It is recommended that this script be used in conjunction with the [[Script:CommandShell|CommandShell]] module, which will improve output formatting and command discovery, as well as enabling the execution of '''CommandShell'''-aware commands.


=== Syntax ===
{{syntaxbox top|cron|formal=true}}
{{API command|exroll}} {{API parameter|name=command}}<br>
{{API command|extend}} {{API parameter|name=command}}<br>
{{Formal API command|
{{token|S}} {{rarr}} exroll {{string|-}}
{{token|S}} {{rarr}} extend {{string|-}}
}}
{{syntaxbox end}}

=== Operators ===

The following operators are supported, in decreasing precedence order:
{|
|-
|<nowiki>x ** y</nowiki>||Exponentiation
|-
|
|-
|<nowiki>!x</nowiki>||Logical NOT
|-
|<nowiki>~x</nowiki>||Bitwise NOT
|-
|<nowiki>-x</nowiki>||Negation
|-
|
|-
|<nowiki>x * y</nowiki>||Multiplication
|-
|<nowiki>x / y</nowiki>||Division
|-
|<nowiki>x % y</nowiki>||Modulus
|-
|
|-
|<nowiki>x + y</nowiki>||Addition
|-
|<nowiki>x - y</nowiki>||Subtraction
|-
|
|-
|<nowiki>x << y</nowiki>||Left shift
|-
|<nowiki>x >> y</nowiki>||Right shift
|-
|
|-
|<nowiki>x >= y</nowiki>||Comparison (greater than or equal)
|-
|<nowiki>x > y</nowiki>||Comparison (strictly greater than)
|-
|<nowiki>x < y</nowiki>||Comparison (strictly less than)
|-
|<nowiki>x <= y</nowiki>||Comparison (less than or equal)
|-
|
|-
|<nowiki>x = y</nowiki>||Equality
|-
|<nowiki>x == y</nowiki>||Equality (synonym for =)
|-
|<nowiki>x != y</nowiki>||Inequality
|-
|
|-
|<nowiki>x & y</nowiki>||Bitwise AND
|-
|
|-
|<nowiki>x ^ y</nowiki>||Bitwise XOR
|-
|
|-
|<nowiki>x | y</nowiki>||Bitwise OR
|-
|
|-
|<nowiki>x && y</nowiki>||Logical AND
|-
|
|-
|<nowiki>x || y</nowiki>||Logical OR
|-
|
|-
|<nowiki>x ? y : z</nowiki>||Conditional evaluation
|}

=== Functions ===
{|
|-
|<nowiki>abs(x)</nowiki>||Absolute value
|-
|<nowiki>ceil(x)</nowiki>||Round up to integer value
|-
|<nowiki>floor(x)</nowiki>||Round down to integer value
|-
|<nowiki>round(x)</nowiki>||Round to nearest integer value
|-
|<nowiki>max(x, y, ...)</nowiki>||Greatest of x, y, ...
|-
|<nowiki>min(x, y, ...)</nowiki>||Least of x, y, ...
|}

=== Additional Syntax ===
{|
|- valign="top"
|<nowiki>"string"</nowiki>||String literal.  Expressions which evaluate to strings will be placed inline directly rather than as inline rolls.
|- valign="top"
|<nowiki>exp[label]</nowiki>||Apply label to the preceeding expression for later reference.  Precedence is higher than every operator except "d" (the dice operator).  Use parentheses to label the size of a die rather than the result of the roll (e.g. "1d(4[diesize])").
|- valign="top"
|<nowiki>${label}</nowiki>||Substitute in the value of the referenced expression.  Label can be either an identifier or a string expression.
|}

=== Examples ===

:<nowiki>!exroll 1t["table-number-" + 1d6] weather</nowiki>
::Internally rolls 1d6, concatenates it with the string "table-number-", and submits a command of the form <nowiki>"/roll 1t[table-number-3] weather"</nowiki>.
:<nowiki>!extend Attack: `(1d20+7)[tohit]`, `(${tohit}>=15 ? "hit for [[1d6]]" : "miss")`</nowiki>
::Internally rolls 1d20+7, compares the result against 15, and submits a command like <nowiki>"Attack: [[12]], miss"</nowiki> or <nowiki>"Attack: [[19]], hit for [[1d6]]"</nowiki>.
:<nowiki>!extend `1d6[foo]+1d6[bar]+${(1d2-1 ? "foo" : "bar")}`</nowiki>
::Internally rolls 1d2-1, then submits a command like <nowiki>"[[3+1d6[bar]+3]]"</nowiki> or <nowiki>"[[1d6[foo]+2+2]]"</nowiki>.
:<nowiki>!extend `max(1d2[foo], 1d3[bar], 1d4[baz])`: `${foo}`, `${bar}`, `${baz}`</nowiki>
::Internally rolls three dice of different sizes, then displays the largest of the three rolls along with the values of all three.

=== Changelog ===
{{changelog version|0.5|2015-06-11|* Add support for executing CommandShell-aware API commands}}
{{changelog version|0.4|2015-06-03|* Add <nowiki>==</nowiki> operator and several functions.  Improve error reporting.}}
{{changelog version|0.3|2015-05-26|* Fix error reporting, non-dice !exroll commands, and a bug using variables in particularly complicated expressions}}
{{changelog version|0.2|2015-05-26|* Add handling of roll templates}}
{{changelog version|0.1|2015-05-24|* Initial release}}
[[Category:Discontinued API Scripts]]