getMacroName: Difference between revisions

Latest revision as of 23:59, 14 March 2023

• Introduced in version 1.3b48

Returns the label/name of the macro being executed. If this macro function is run directly from chat, then this function will return "chat".

getMacroName()

[h: macroName = getMacroName()]
[if(macroName == "chat", "You are running from chat", "You are running the macro called " + macroName)]

@@ Line 1: / Line 1: @@
-==Function getMacroName==
+{{MacroFunction
+|name=getMacroName
+|version=1.3b48
+|description=
+Returns the label/name of the macro being executed. If this macro function is run directly from chat, then this function will return "chat".
-Returns the name 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".
+|usage=
+<syntaxhighlight lang="mtmacro" line>
-===Usage===
+getMacroName()
-<source lang="mtmacro" line>
+</syntaxhighlight>
-[h: macroName = getMacroName()]
+|examples=
-</source>
+<syntaxhighlight lang="mtmacro" line>
-===Examples===
-<source lang="mtmacro" line>
 [h: macroName = getMacroName()]
 [if(macroName == "chat", "You are running from chat", "You are running the macro called " + macroName)]
-</source>
+</syntaxhighlight>
+}}
+[[Category:Metamacro Function]]