getMacroLocation: Difference between revisions

Latest revision as of 23:59, 14 March 2023

getMacroLocation() Function

• Introduced in version 1.3b48

Returns the location of the macro being executed, the return value will be "chat", "global", "campaign" or the label of the token the macro resides on (e.g. "Lib:Utilities" or "Token:Orc".) Standard PC and NPC tokens will have their label prefixed with Token:.

Usage

getMacroLocation()

Example

[h: MacroLocation = getMacroLocation()]
[if(MacroLocation == "chat", "You are running from chat", "You are running from "+MacroLocation]

Version Changes

1.3b51 - Now accurately reports where the macro button resides.

@@ Line 1: / Line 1: @@
-==Function getMacroLocation==
+{{MacroFunction
-{{ProposedChange}}
+|name=getMacroLocation
-Returns the location of the macro being executed via [[Macro:Roll:macro | [macro():] ]]. If the macro typed into chat, run by clicking on a [[macro button]], or run via the [[Token:popup menu| token popup menu]] then this function will return "chat".
+|version=1.3b48
+|description=
+Returns the location of the macro being executed, the return value will be {{code|"chat"}}, {{code|"global"}}, {{code|"campaign"}} or the label of the token the macro resides on (e.g. {{code|"Lib:Utilities"}} or {{code|"Token:Orc"}}.) Standard PC and NPC tokens will have their label prefixed with {{code|Token:}}.
-===Usage===
+|usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: libToken = getMacroLocation()]
+getMacroLocation()
-</source>
+</syntaxhighlight>
-===Examples===
-<source lang="mtmacro" line>
+|example=
-[h: libToken = getMacroLocation()]
+<syntaxhighlight lang="mtmacro" line>
-[if(libToken == "chat", "You are running from chat", "You are running from library token " + libToken)]
+[h: MacroLocation = getMacroLocation()]
-</source>
+[if(MacroLocation == "chat", "You are running from chat", "You are running from "+MacroLocation]
+</syntaxhighlight>
+|changes=
+{{change|1.3b51|Now accurately reports where the macro button resides.}}
+}}
+[[Category:Metamacro Function]]