evalMacro: Difference between revisions
Verisimilar (talk | contribs) (Expanded the examples. The variable scope difference is large enough that I'm considering splitting execMacro into it's own article.) |
No edit summary |
||
| Line 9: | Line 9: | ||
The {{func|evalMacro}} function executes the macro in the same variable scope (i.e. the executed macro can read and alter variables from the current macro), where as {{func|execMacro}} creates a new variable scope (i.e. the executed macro can neither read nor alter varaibles from the current macro). | The {{func|evalMacro}} function executes the macro in the same variable scope (i.e. the executed macro can read and alter variables from the current macro), where as {{func|execMacro}} creates a new variable scope (i.e. the executed macro can neither read nor alter varaibles from the current macro). | ||
The advantage of this function over {{func|eval}} is that with {{func|eval}} you can only give a string as parameter that can be evaluated (e.g. "3+5"), while with {{func|evalMacro}} you can give anything as parameter but only the parts between [brackets] will be evaluated. (e.g. "Your resulting roll is [r:1d10]") | |||
|usage= | |usage= | ||
| Line 66: | Line 68: | ||
</source> | </source> | ||
Returns {{code|0}} | Returns {{code|0}} | ||
<source lang="mtmacro" line> | |||
[r: evalMacro("[h:roll=1d20]You [r:if(roll<10, 'hit', 'miss')] your target.")] | |||
</source> | |||
Returns {{code|30}} | |||
|also= | |also= | ||
Revision as of 10:29, 31 January 2014
evalMacro() Function
Note: This function can only be used in a Trusted Macro
If you are performing rolls in the macro that create tool tips or use [e: ] then you will have to use either { } or [r: ] to display the output otherwise you will get incorrect formatting.
The evalMacro() function executes the macro in the same variable scope (i.e. the executed macro can read and alter variables from the current macro), where as execMacro() creates a new variable scope (i.e. the executed macro can neither read nor alter varaibles from the current macro).
The advantage of this function over eval() is that with eval() you can only give a string as parameter that can be evaluated (e.g. "3+5"), while with evalMacro() you can give anything as parameter but only the parts between [brackets] will be evaluated. (e.g. "Your resulting roll is [r:1d10]")Usage
evalMacro(macroString)execMacro(macroString)Parameter
macroString- The string containing the macro script that is evaluated/executed.
Examples
[h: setNotes(evalMacro('[r,macro("CreateNotes@Lib:Notes"): ""]'))]Sets the Notes of a Token to the output of the CreateNotes macro located on the Lib:Notes Library Token.
[r: evalMacro("[h: TestVar1 = 5][h: TestVar2 = 10][TestVar1+TestVar2]")]Returns 15
[h: TestVar3 = 10]
[h: TestVar4 = 20]
[r: evalMacro("[TestVar3+TestVar4]")]Returns 30
[h: TestVar3 = 15]
[h: TestVar4 = 30]
[h: evalMacro("[TestVar5 = TestVar3+TestVar4]")]
[TestVar5]Returns 45
[h: TestVar6 = 20]
[h: TestVar7 = 40]
[r: execMacro("[TestVar6+TestVar7]")]Prompts for the values of TestVar6 and TestVar7, then it returns the sum of those two values.
[h: TestVar8 = 50]
[h: TestVar9 = 100]
[h: TestVar10 = 0]
[h: execMacro("[TestVar10 = TestVar8+TestVar9]")]
[TestVar10]Returns 0
[r: evalMacro("[h:roll=1d20]You [r:if(roll<10, 'hit', 'miss')] your target.")]30