if (roll option): Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added references to the code roll option, and added a note about nested parenthesis in the condition.)
No edit summary
Line 45: Line 45:
|also=
|also=
{{func|if}},  
{{func|if}},  
{{roll|code}}
{{roll|code}},
 
[[Introduction to Macro Branching]]
}}
}}
[[Category:Branching Roll Option]]
[[Category:Branching Roll Option]]

Revision as of 23:36, 14 July 2009

[if():] Roll Option

* Introduced in version 1.3b46

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 or false_body) is executed, if any. The condition/s can only contain one level of nested parenthesis.
  • true_body - The roll that is executed if the condition evaluates to true(1). To use complex rolls in the true_body, you must use the [code():] roll option in conjunction with this roll option.
  • false_body - The roll that is executed if the condition evaluates to false(0). If no false_body is given, there is no output if the condition evaluates to false(0). To use complex rolls in the false_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
  • != or ne - Not equal

Logical Operators:

  • && - And
  • || - Or

Boolean Operators:

  • true
  • false

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.

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

See Also

if(), [code():], Introduction to Macro Branching