if: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
 
(18 intermediate revisions by 9 users not shown)
Line 1: Line 1:
==Function if==
{{MacroFunction
If ''testCondition'' evaluates to 0 then the result of ''falseExpr'' is returned, otherwise the result of ''trueExpr'' is returned. Note: '''both''' ''trueExpr'' and ''falseExpr'' are evaluated no matter what the result of ''testCondition'' is. You may want to consider using the [[Macros:Branching_and_Looping#IF_Option| [IF():]]] roll option instead.
|name=if
|version=1.3b38
|description=
Is used to check whether a certain code ''expression'' should be executed or not. If the ''condition'' to be evaluated with this function is {{true}}, the first ''expression'' of code is the result, otherwise the second ''expression'' of code is the result.


Test condition notation:
{{note|Note that both ''expressions'', the true and the false, are evaluated!
This means that updates, macro calling, etc. in '''both''' ''expressions'' will be executed regardless of the test result.<br />
Therefore, this function should only be used in limited cases where the ''expressions'' are simply returning a value.}}


* > for greater than
This function doesn't have the parentheses limit that the roll option has:
* < for less than
<syntaxhighlight lang="mtmacro">
* >= for greater than or equal to
[if(((1))): 1;0]    <!-- in this case if() roll option fails -->
* <= for less than or equal to
[if(((1)),1,0)]      <!-- in this case if() function    works -->
* == for equal to - yes, you must use TWO equal signs to evaluate "is equal to"
</syntaxhighlight>
|usage=
<syntaxhighlight lang="mtmacro" line>
if(condition, trueExpr, falseExpr)
</syntaxhighlight>
'''Parameters'''
* {{code|condition}} - What is tested to determine is the {{code|trueExpr}} or {{code|falseExpr}} will be executed. This follows the standard rules for ''conditions'' that can be found in the [[Macros:Branching and Looping|Branching and Looping]] article.
* {{code|trueExpr}} - A section of code that is returned if {{code|condition}} is {{true}}.
* {{code|falseExpr}} - A section of code that is returned if {{code|condition}} is {{false}}.
&nbsp;
<!-- The 'nbsp' is needed to force the DIV to close. -->
|examples=
'''Example 1:'''
<syntaxhighlight lang="mtmacro" line>
[h: a = 10] [h: b = 20]
[r: if(a > b, "A is larger than B", "A is not larger than B")]
</syntaxhighlight>
:'''Returns:''' {{code|A is not larger than B}}


If you are checking for a text string, place quotes around the text.


===Usage===
'''Example 2:'''
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: result = if(testCondition, trueExpr, falseCondition)]
[h: number = 1]
</source>
[r: if(number >= 1, 20, "")]
</syntaxhighlight>
:'''Returns:''' A ''blank string'', please note that a ''blank string'' is not an ''empty variable'' if you were to assign the ''output'' of this function.


===Examples===
<source lang="mtmacro" line>
[r: if(a>b, "A is larger than B", "A is not larger than B")]
[someProperty = if(variable>=1,20,"")]
</source>


Sets ''someProperty'' to 20 if variable is greater than or equal to 1, or makes it blank (but not empty) otherwise.
'''Example 3:'''
<syntaxhighlight lang="mtmacro" line>
[h: variable = "Foobar"]
[r: if(variable == "Text", 1, 0)]
</syntaxhighlight>
:'''Returns:''' {{code|0}}


<source lang="mtmacro" line>
[someProperty = if(variable=="Text",1,0)]</source>


Sets ''someProperty'' to 1 if variable contains the text string Text, 0 otherwise.
'''Example 4:'''
<syntaxhighlight lang="mtmacro" line>
[h: variable = 20]
[property = if(variable > 0 && variable < 20, 1, 0)]
</syntaxhighlight>
:'''Returns:''' {{code|property}} set to {{code|0}}
 
 
'''Example 5:''' Usually its better to use the roll option version {{roll|if}}. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.
 
Let's say you want to check if one of a player's tokens has Initiative, you could do it this like this:
<syntaxhighlight lang="mtmacro" line>
[h: tokensOfPlayer = getOwned(getPlayerName(), "json")]
[h: hasIni = 0]
[h: iniToken = getInitiativeToken()]
[h, foreach(id, tokensOfPlayer): hasIni = if(id!=iniToken,hasIni,1)]
</syntaxhighlight>
 
|also=
[[Macros:Branching and Looping|Branching and Looping]], [[if (roll option)|if (roll option)]]
}}
[[Category:Miscellaneous Function]]

Latest revision as of 23:59, 15 March 2023

if() Function

• Introduced in version 1.3b38
Is used to check whether a certain code expression should be executed or not. If the condition to be evaluated with this function is true(1), the first expression of code is the result, otherwise the second expression of code is the result.


Note that both expressions, the true and the false, are evaluated!

This means that updates, macro calling, etc. in both expressions will be executed regardless of the test result.

Therefore, this function should only be used in limited cases where the expressions are simply returning a value.


This function doesn't have the parentheses limit that the roll option has: 

[if(((1))): 1;0]     <!-- in this case if() roll option fails -->
[if(((1)),1,0)]      <!-- in this case if() function    works -->

Usage

if(condition, trueExpr, falseExpr)

Parameters

  • condition - What is tested to determine is the trueExpr or falseExpr will be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article.
  • trueExpr - A section of code that is returned if condition is true(1).
  • falseExpr - A section of code that is returned if condition is false(0).

 

Examples

Example 1: 
[h: a = 10] [h: b = 20]
[r: if(a > b, "A is larger than B", "A is not larger than B")]
Returns: A is not larger than B


Example 2: 

[h: number = 1]
[r: if(number >= 1, 20, "")]
Returns: A blank string, please note that a blank string is not an empty variable if you were to assign the output of this function.


Example 3: 

[h: variable = "Foobar"]
[r: if(variable == "Text", 1, 0)]
Returns: 0


Example 4: 

[h: variable = 20]
[property = if(variable > 0 && variable < 20, 1, 0)]
Returns: property set to 0


Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.

Let's say you want to check if one of a player's tokens has Initiative, you could do it this like this: 

[h: tokensOfPlayer = getOwned(getPlayerName(), "json")]
[h: hasIni = 0]
[h: iniToken = getInitiativeToken()]
[h, foreach(id, tokensOfPlayer): hasIni = if(id!=iniToken,hasIni,1)]

See Also

Branching and Looping, if (roll option)
Retrieved from "https://rptools.hyperbooks.com/index.php?title=if&oldid=35151"