setMacroCommand
Jump to navigation
Jump to search
setMacroCommand() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.
Usage
setMacroCommand(index, command)
setMacroCommand(index, command, id)
setMacroCommand(index, command, id, mapname)
Parameters
index
- The index of the macro button.command
- A string containing the command to set on the macro button.id
- The tokenid
of the token that the command is set on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.mapname
- The name of the map to find the token. Defaults to the current map.
Examples
[h: setMacroCommand(1, "[macro('Test@Lib:Test'): '']")]
Version Changes
- 1.3b49 - Changed to a trusted function.
- 1.3b51 - Added
id
parameter option. - 1.5.11 - Added
mapname
parameter option. - 1.15 - Addition of "gm" and "campaign" options for id