evalMacro

From RPTools Wiki
Revision as of 08:45, 24 December 2008 by Craig (talk | contribs)
Jump to navigation Jump to search

Function evalMacro, execMacro

This function can only be called from a trusted macro


Introduced in MapTool 1.3b49


Evaluates and "executes" the macro in a string and returns the result. The string contains the same type of macro commands that you would put in a token macro with the exception that it can not contain slash commands.

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() crates a new variable scope (i.e. the executed macro can neither read nor alter varaibles from the current macro).

Usage

[h: result = evalMacro(macroString)]
[h: result = execMacro(macroString)]


Examples

To set the notes of a token to the output generated by a macro.

[h: setNotes(evalMacro('[r,macro("CreateNotes@Lib:Notes"): ""]'))

or

[h: setNotes(execMacro('[r,macro("CreateNotes@Lib:Notes"): ""]'))