getMacroCommand: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Function getMacroCommand==
{{stub|Examples of usage.}}
{{MacroFunction
|name=getMacroCommand
|version=1.3b48
|description=Returns the command that would be executed for a [[Macro_Button|macro button]] on the [[Current Token]]. The [[getMacroIndexes{{!}} getMacroIndexes()]] function can be used to get the index of a [[Macro_Button|macro button]].


Returns the command that would be executed for a [[macro button]] on the current [[Token:token|token]]. The [[Macros:Functions:getMacroIndexes| getMacroIndexes()]] function can be used to get the index of a [[macro button]].
|usage=
<syntaxhighlight  lang="mtmacro" line>
getMacroCommand(index)
getMacroCommand(index, tokenRef)
getMacroCommand(index, tokenRef, mapRef)
</syntaxhighlight>
'''Parameters'''
{{param|index|The index of the macro button which will have the command returned.}}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token that the function is executed on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.{{TrustedParameter}} }}
{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}


===Usage===
|also=
<source lang="mtmacro" line>
[[getMacroIndexes|getMacroIndexes()]]
[h: command = getMacroCommand(index)]
 
</source>
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
{{change|1.5.11|Added {{code|mapname}} parameter option.}}
{{change|1.15|Addition of "gm" and "campaign" options for id}}
}}
[[Category:Metamacro Function]]

Latest revision as of 23:59, 13 May 2024

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Examples of usage.

getMacroCommand() Function

• Introduced in version 1.3b48
Returns the command that would be executed for a macro button on the Current Token. The getMacroIndexes() function can be used to get the index of a macro button.

Usage

getMacroCommand(index)
getMacroCommand(index, tokenRef)
getMacroCommand(index, tokenRef, mapRef)

Parameters

  • index - The index of the macro button which will have the command returned.
  • tokenRef - Either the token id or Token Name of the token that the function is executed on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.

     Note: This parameter can only be used in a Trusted Macro. 

  • mapRef - The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.


See Also

getMacroIndexes()

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.11 - Added mapname parameter option.
  • 1.15 - Addition of "gm" and "campaign" options for id
Retrieved from "https://wiki.rptools.info/index.php?title=getMacroCommand&oldid=35003"