hasMacro: Difference between revisions
Jump to navigation
Jump to search
Bubblobill (talk | contribs) m (From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.) |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 8: | Line 8: | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
hasMacro(label) | hasMacro(label) | ||
hasMacro(label, | hasMacro(label, tokenRef) | ||
hasMacro(label, | hasMacro(label, tokenRef, mapRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|label|The label of the macro to check for.}} | {{param|label|The label of the macro to check for.}} | ||
{{param| | {{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| | {{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.}} | |||
|changes= | |changes= | ||
{{change|1.3b51|Added optional token {{code|id}} parameter.}} | {{change|1.3b51|Added optional token {{code|id}} parameter.}} | ||
{{change|1.5.11|Added {{code|mapname}} 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]] | [[Category:Metamacro Function]] | ||
Latest revision as of 23:59, 16 May 2024
hasMacro() Function
• Introduced in version 1.3b48
Usage
hasMacro(label)
hasMacro(label, tokenRef)
hasMacro(label, tokenRef, mapRef)Parameters
label- The label of the macro to check for.tokenRef- Either the tokenidor 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.
Version Changes
- 1.3b51 - Added optional token
idparameter. - 1.5.11 - Added
mapnameparameter option. - 1.15 - Addition of "gm" and "campaign" options for id