if: Difference between revisions
mNo edit summary |
No edit summary |
||
| Line 64: | Line 64: | ||
|how this code works in layman's terms= | |how this code works in layman's terms= | ||
This code asks a states something about a variable depending on what that variable is. It feeds back what you want it to, depending on the situation. A few simple examples using the d20 system of critical hits would be such: | This code asks a states something about a variable depending on what that variable is. It feeds back what you want it to, depending on the situation. A few simple examples using the d20 system of critical hits would be such: | ||
'''Layman Example 1: If it is''' | '''Layman Example 1: If it is''' | ||
This asks for the value of {{code|roll}}, and if that value turns out to be 20 it puts in the chat box {{code|Critical threat}}, and if not, it does nothing. | This asks for the value of {{code|roll}}, and if that value turns out to be 20 it puts in the chat box {{code|Critical threat}}, and if not, it does nothing. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: roll=d20] | [h: roll=d20] | ||
[r,if(roll==20): "Critical threat"] | [r,if(roll==20): "Critical threat"] | ||
</source> | </source> | ||
'''Layman Example 2: if it is not''' | '''Layman Example 2: if it is not''' | ||
This asks for the value of {{code|roll}}, and if that value turns out to be anything but 20 it puts in the chat box {{code|no crit}}, and if it is 20, it does nothing. | This asks for the value of {{code|roll}}, and if that value turns out to be anything but 20 it puts in the chat box {{code|no crit}}, and if it is 20, it does nothing. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: roll=d20] | [h: roll=d20] | ||
[r,if(roll==20): "";"no crit"] | [r,if(roll==20): "";"no crit"] | ||
</source> | </source> | ||
'''Layman Example 3: if it is, if it is not''' | '''Layman Example 3: if it is, if it is not''' | ||
This asks for the value of {{code|roll}}, and if that value turns out to be 20, then in the chat box it puts {{code|Critical Threat}}, and if it is not 20, it puts in the chat box {{code|no crit}} | This asks for the value of {{code|roll}}, and if that value turns out to be 20, then in the chat box it puts {{code|Critical Threat}}, and if it is not 20, it puts in the chat box {{code|no crit}} | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: roll=d20] | [h: roll=d20] | ||
Revision as of 05:53, 18 January 2012
if() Function
true, the first expression of code is executed, otherwise the second expression of code is executed.
Important note:
Both trueExpr and falseExpr are evaluated regardless of what condition returns. This means that updates, macro calling, etc. in both branches will be executed regardless of the test result.
So this function should only be used in limited cases where branches stick to returning a value.
However, the function doesn't have the parenthesis limit 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 thetrueExprorfalseExprwill 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 executed ifconditionreturns astrue.falseExpr- A section of code that is executed ifconditiondoes not return astrue.
Examples
a is 10 and b is 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: If number is 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: If variable is "Foobar":
[r: if(variable == "Text", 1, 0)]Returns: 0
Example 4: If variable is 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 its pretty handy to use this version - the function-version - since you can easily embed it in loops and expressions.
Lets say you want to check if one of a players tokens has Initiative you could do this like this.
[h: tokensOfPlayer = getOwned(getPlayerName(), "json")]
[h: hasIni = 0]
[h: iniToken = getInitiativeToken()]
[h, foreach(id, tokensOfPlayer): hasIni = if(id!=iniToken,hasIni,1)]