hasMacro: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Fixing wikilink)
No edit summary
Line 8: Line 8:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
hasMacro(label)
hasMacro(label)
</source>
<source lang="mtmacro" line>
hasMacro(label, id)
hasMacro(label, id)
hasMacro(label, id, mapname)
</source>
</source>
'''Parameters'''
'''Parameters'''
{{param|label|The label of the macro to check for.}}
{{param|label|The label of the macro to check for.}}
{{param|id|The token {{code|id}} of the token that the function is executed on. {{TrustedParameter}} }}
{{param|id|The token {{code|id}} of the token that the function is executed on. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}


|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.}}
}}
}}
[[Category:Metamacro Function]]
[[Category:Metamacro Function]]

Revision as of 23:50, 14 January 2020

hasMacro() Function

Introduced in version 1.3b48
Returns true(1) if a macro button with the specified label exists on the Current Token.

Usage

hasMacro(label)
hasMacro(label, id)
hasMacro(label, id, mapname)

Parameters

  • label - The label of the macro to check for.
  • id - The token id of the token that the function is executed on.

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

  • mapname - The name of the map to find the token. Defaults to the current map.


Version Changes

  • 1.3b51 - Added optional token id parameter.
  • 1.5.11 - Added mapname parameter option.