hasMacro

From RPTools Wiki
Revision as of 23:59, 16 May 2024 by Taustin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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, tokenRef)
hasMacro(label, tokenRef, mapRef)

Parameters

  • label - The label of the macro to check for.
  • 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.


Version Changes

  • 1.3b51 - Added optional token id parameter.
  • 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=hasMacro&oldid=35121"