WoW:API CreateMacro: Difference between revisions

← Older edit

WoW:API CreateMacro (source)

Revision as of 04:45, 15 August 2023

185 bytes added , 15 August 2023

m

Move page script moved page API CreateMacro to WoW:API CreateMacro without leaving a redirect

Anonymous user

Move page script

@@ Line 2: / Line 2: @@
 Creates a new macro command/button.
- CreateMacro(name, icon, body, local, perCharacter)
+  CreateMacro(name, iconFileName, body, perCharacter)
 == Arguments ==
-:(name, icon, body, local, perCharacter)
+:(name, iconFileName, body, perCharacter)
 ; name : String - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit.
-; icon : Numeric - A 1-based iconTextureId (index of icon textures as displayed in "Change Name/Icon" UI). Check the current number if icon textures available by calling [[API GetNumMacroIcons|GetNumMacroIcons()]].
+; iconFileName : String , The icon name.
-; body : String - The macro commands to be executed.
+; body : String - The macro commands to be executed. If this string is longer than 255 characters, only the first 255 will be saved.
-; local : Numeric - Purpose unknown, always 1.
+; perCharcter : Numeric - nil will create a "General" saved macro, 1 will save it as "Per Character"
-; perCharcter : Numeric - 0 will create a "per account" saved macro, 1 will save it as "per character"
 == Returns ==
@@ Line 22: / Line 20: @@
 == Example ==
+; General (All Character) Macros :
+ local macroId = CreateMacro("MyMacro", "INV_MISC_QUESTIONMARK", "/script CastSpellById(1);", nil);
-  local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1, 1);
+; perChar (Per Character) Macros :
+  local macroId = CreateMacro("MyMacro", "INV_MISC_QUESTIONMARK", "/script CastSpellById(1);", 1);
 == Notes ==
+* As of [[Patch 4.3]] this is working as shown - the unused parameter has been removed.
-It is possible to do some WrongThings(tm) here:
+* This function will generate an error if the maximum macros of the specified kind already exist (36 for per acount and 18 for per character).
+* It is possible to create macros with duplicate names. You should enumerate the current macros using [[API GetNumMacros|GetNumMacros()]] and [[API GetMacroIconInfo|GetMacroIconInfo(macroId)]] to ensure that your new macro name doesn't already exist. Macros with duplicate names can be used in most situations, but the behavior of macro functions that retrieve a macro by name is undefined when multiple macros of that name exist.
-* It is possible to create more macros than the UI can display. Call [[API GetNumMacros|GetNumMacros()]] to ensure there are no more than 17 macros (18 is the current UI limit per account/per character) before calling CreateMacro().
+* This function may not be called in combat anymore, as of [[Patch 2.0]].
-* It is possible to create macros with duplicate names. You should enumerate the current macros using [[API GetNumMacros|GetNumMacros()]] and [[API GetMacroIconInfo|GetMacroIconInfo(macroId)]] to ensure that your new macro name doesn't already exist.
-This function may not be called in combat anymore, as of 2.0.