setMacroCommand: Difference between revisions

Revision as of 23:52, 14 January 2020

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 token id of the token that the command is set on.
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.

@@ Line 9: / Line 9: @@
 <source lang="mtmacro" line>
 setMacroCommand(index, command)
-</source>
-<source lang="mtmacro" line>
 setMacroCommand(index, command, id)
+setMacroCommand(index, command, id, mapname)
 </source>
 '''Parameters'''
@@ Line 17: / Line 16: @@
 {{param|command|A string containing the command to set on the macro button.}}
 {{param|id|The token {{code|id}} of the token that the command is set on.}}
+{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 |examples=
@@ Line 26: / Line 26: @@
 {{change|1.3b49|Changed to a trusted function.}}
 {{change|1.3b51|Added {{code|id}} parameter option.}}
+{{change|1.5.11|Added {{code|mapname}} parameter option.}}
 }}
 [[Category:Metamacro Function]]