WoW:API CreateMacro: Difference between revisions

WoW:API CreateMacro (source)

Revision as of 07:48, 27 May 2012

482 bytes removed , 27 May 2012

no edit summary

Anonymous user

WoWWiki>Rjwilson01

@@ Line 2: / Line 2: @@
 Creates a new macro command/button.
- CreateMacro("name", iconIndex, "body", perCharacter, local)
+  CreateMacro(name, iconFileName, body, perCharacter)
 == Arguments ==
-:(name, icon, body, perCharacter, local)
+:(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. If this string is longer than 255 characters, only the first 255 will be saved.
 ; perCharcter : Numeric - nil will create a "General" saved macro, 1 will save it as "Per Character"
-; local : 1 if the macro is to be saved on the server, nil if saved locally in the user's WTF folder
 == Returns ==
@@ Line 23: / Line 21: @@
 == Example ==
 ; General (All Character) Macros :
-  local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", nil, 1);
+  local macroId = CreateMacro("MyMacro", "INV_MISC_QUESTIONMARK", "/script CastSpellById(1);", nil);
- local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", nil, nil);
 ; perChar (Per Character) Macros :
-  local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1, 1);
+  local macroId = CreateMacro("MyMacro", "INV_MISC_QUESTIONMARK", "/script CastSpellById(1);", 1);
- local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1, nil);
 == Notes ==
-* As of 3.0 with Macros saving serverside (default) the API has changed. perCharacter, and local have switched spots. Pre-3.0 local was always nil.
+* As of 4.3 this is working as shown - the unused parameter has been removed
 * 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).