if (roll option): Difference between revisions
No edit summary |
No edit summary |
||
Line 6: | Line 6: | ||
|usage= | |usage= | ||
<source lang=" | <source lang="python"> | ||
[if(condition): true_body] | [if(condition): true_body] | ||
[if(condition): true_body; false_body] | [if(condition): true_body; false_body] | ||
Line 33: | Line 33: | ||
It is important to note that the ''Equal to'' condition operator must be two equal signs ({{code|{{=}}{{=}}}}). If you are checking for a text string, place quotes around the text. | It is important to note that the ''Equal to'' condition operator must be two equal signs ({{code|{{=}}{{=}}}}). If you are checking for a text string, place quotes around the text. | ||
==== | ====Known Limitations==== | ||
* '''Number of () levels''' | * '''Number of () levels''' | ||
The {{code|[if():]}} doesn't allow more than | The {{code|[if():]}} doesn't allow more than two levels of nested parenthesis {{code|()}}. Adding a third or more will produce a bad option parameters error. | ||
< | <syntaxhighlight lang="python" line> | ||
[R, if(((1))): | [R, if(((1))),code:{True};{False}] | ||
</ | </syntaxhighlight> | ||
Produces | |||
<syntaxhighlight lang="python"> | |||
Roll option "if": bad option parameters 1. | |||
Statement options (if any): r,if(((1))),code | |||
Statement Body : {True};{False} | |||
Error trace : (new)@campaign | |||
</syntaxhighlight> | |||
|example= | |example= | ||
Sets the variable {{code|newVal}} to {{code|12*12}} if the variable {{code|val}} equals {{code|12}}. | Sets the variable {{code|newVal}} to {{code|12*12}} if the variable {{code|val}} equals {{code|12}}. | ||
< | <syntaxhighlight lang="python" line> | ||
[h:val=12] | [h:val=12] | ||
[h,if(val == 12): newVal=12*12] | [h,if(val == 12): newVal=12*12] | ||
New Value = [r: newVal] | New Value = [r: newVal] | ||
</ | </syntaxhighlight> | ||
Returns {{code|New Value {{=}} 144}} | Returns {{code|New Value {{=}} 144}} | ||
Example with logical operators: | Example with logical operators: | ||
< | <syntaxhighlight lang="python" line> | ||
[h,if((val > 12 && val < 24) || val == 5): val=1 ; val=0] | [h,if((val > 12 && val < 24) || val == 5): val=1 ; val=0] | ||
</ | </syntaxhighlight> | ||
These examples perform the same function. If {{code|val}} is not a number, make {{code|val}} equal {{code|0}}. | These examples perform the same function. If {{code|val}} is not a number, make {{code|val}} equal {{code|0}}. | ||
< | <syntaxhighlight lang="python" line> | ||
[h, if (! isNumber(val)): val = 0)] | [h, if (! isNumber(val)): val = 0)] | ||
</ | </syntaxhighlight> | ||
<syntaxhighlight lang="python" line> | |||
[h, if (isNumber(val) == 0): val = 0)] | [h, if (isNumber(val) == 0): val = 0)] | ||
</ | </syntaxhighlight> | ||
<syntaxhighlight lang="python" line> | |||
[h, if (isNumber(val) == false): val = 0)] | [h, if (isNumber(val) == false): val = 0)] | ||
</ | </syntaxhighlight> | ||
Using {{code|code}} block: | Using {{code|code}} block: | ||
< | <syntaxhighlight lang="python" line> | ||
[if(condition),code:{ | [if(condition),code:{ | ||
[...] | [...] | ||
Line 82: | Line 83: | ||
[...] | [...] | ||
}] | }] | ||
</ | </syntaxhighlight> | ||
The following will generate an error: | The following will generate an error: | ||
< | <syntaxhighlight lang="python" line> | ||
[h,if(getName(getSelected()) == "Giant Rat"): val=1] --- ERROR, too many parenthesis on condition! | [h,if(getName(getSelected()) == "Giant Rat"): val=1] --- ERROR, too many parenthesis on condition! | ||
[h,if(getName() == "Giant Rat")): val=1] --- This is OK. | [h,if(getName() == "Giant Rat")): val=1] --- This is OK. | ||
</ | </syntaxhighlight> | ||
|also= | |also= |
Revision as of 16:35, 18 June 2021
[if():] Roll Option
Branches the flow of the roll as determined by the condition.
Usage
[if(condition): true_body]
[if(condition): true_body; false_body]
Parameters
condition
- The condition/s to check to determine which roll (true_body
orfalse_body
) is executed, if any. The condition/s can only contain one level of nested parenthesis.true_body
- The roll that is executed if thecondition
evaluates totrue
(1
). To use compound statements in thetrue_body
, you must use the [code():] roll option in conjunction with this roll option.false_body
- The roll that is executed if thecondition
evaluates tofalse
(0
). If nofalse_body
is given, there is no output if thecondition
evaluates tofalse
(0
). To use complex rolls in thefalse_body
, you must use the [code():] roll option in conjunction with this roll option.
Operators
Operators are used to compare two variables, strings, literal numbers, expressions, or function outputs within a condition
.
Conditional Operators:
>
- Greater than<
- Less than>=
- Greater than or equal to<=
- Less than or equal to==
- Equal to!=
orne
- Not equal
Logical Operators:
&&
- And||
- Or
Boolean Operators:
true
false
!
- Not
It is important to note that the Equal to condition operator must be two equal signs (==
). If you are checking for a text string, place quotes around the text.
Known Limitations
- Number of () levels
The [if():]
doesn't allow more than two levels of nested parenthesis ()
. Adding a third or more will produce a bad option parameters error.
[R, if(((1))),code:{True};{False}]
Produces
Roll option "if": bad option parameters 1.
Statement options (if any): r,if(((1))),code
Statement Body : {True};{False}
Error trace : (new)@campaign
Example
Sets the variable newVal
to 12*12
if the variable val
equals 12
.
[h:val=12]
[h,if(val == 12): newVal=12*12]
New Value = [r: newVal]
Returns New Value = 144
Example with logical operators:
[h,if((val > 12 && val < 24) || val == 5): val=1 ; val=0]
These examples perform the same function. If val
is not a number, make val
equal 0
.
[h, if (! isNumber(val)): val = 0)]
[h, if (isNumber(val) == 0): val = 0)]
[h, if (isNumber(val) == false): val = 0)]
Using code
block:
[if(condition),code:{
[...]
[...]
};{
[...]
[...]
}]
The following will generate an error:
[h,if(getName(getSelected()) == "Giant Rat"): val=1] --- ERROR, too many parenthesis on condition!
[h,if(getName() == "Giant Rat")): val=1] --- This is OK.
See Also
if(), isNumber(), [code():], Introduction to Macro Branching