WoW:API CreateMacro - Revision history

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

2023-08-15T04:45:23Z

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

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

WoWWiki>Fandyllic: /* Notes */

2012-05-29T15:41:23Z

Notes

← Older revision		Revision as of 15:41, 29 May 2012
Line 27:		Line 27:

	== Notes ==		== Notes ==
	* As of 4.3 this is working as shown - the unused parameter has been removed		* As of [[Patch 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).		* 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 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.
			* This function may not be called in combat anymore, as of [[Patch 2.0]].
	This function may not be called in combat anymore, as of 2.0.

WoWWiki>Rjwilson01 at 07:48, 27 May 2012

2012-05-27T07:48:44Z

← Older revision		Revision as of 07:48, 27 May 2012
Line 2:		Line 2:
	Creates a new macro command/button.		Creates a new macro command/button.

	CreateMacro("name", ~~iconIndex~~, "body", perCharacter~~, local~~)		CreateMacro(name, iconFileName, body, perCharacter)

	== Arguments ==		== 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.		; 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.		; 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"		; 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 ==		== Returns ==
Line 23:		Line 21:
	== Example ==		== Example ==
	; General (All Character) Macros :		; 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 :		; 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 ==		== 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).		* 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).

WoWWiki>SagivSaffi: /* Arguments */

2008-12-09T10:03:31Z

Arguments

← Older revision		Revision as of 10:03, 9 December 2008
Line 2:		Line 2:
	Creates a new macro command/button.		Creates a new macro command/button.

	CreateMacro(name, ~~icon~~, body, perCharacter)		CreateMacro("name", iconIndex, "body", perCharacter, local)

	== Arguments ==		== Arguments ==
	:(name, icon, body, perCharacter)		:(name, icon, body, perCharacter, local)

	; name : String - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit.		; name : String - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit.
Line 13:		Line 13:
	; body : String - The macro commands to be executed. If this string is longer than 255 characters, only the first 255 will be saved.		; 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 - 0 will create a "~~per account~~" saved macro, 1 will save it as "~~per character~~"		; 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 ==		== Returns ==
Line 20:		Line 22:

	== Example ==		== Example ==
			; General (All Character) Macros :
			local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", nil, 1);
			local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", nil, nil);

	local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1);		; perChar (Per Character) Macros :
			local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1, 1);
			local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1, nil);

	== Notes ==		== 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.

	* 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).		* 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).

WoWWiki>Archarodim: Removed 4th parameter (local), it's been removed in WoW 3.0

2008-10-16T22:54:11Z

Removed 4th parameter (local), it's been removed in WoW 3.0

← Older revision		Revision as of 22:54, 16 October 2008
Line 2:		Line 2:
	Creates a new macro command/button.		Creates a new macro command/button.

	CreateMacro(name, icon, body~~, local~~, perCharacter)		CreateMacro(name, icon, body, perCharacter)

	== Arguments ==		== Arguments ==
	:(name, icon, body~~, local~~, perCharacter)		:(name, icon, body, perCharacter)

	; name : String - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit.		; name : String - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit.
Line 12:		Line 12:

	; body : String - The macro commands to be executed. If this string is longer than 255 characters, only the first 255 will be saved.		; 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 - 0 will create a "per account" 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"
Line 23:		Line 21:
	== Example ==		== Example ==

	local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);"~~, 1~~, 1);		local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1);

	== Notes ==		== Notes ==

	* This function will generate an error if 18 macros of the specified kind already exist.		* 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 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.

	This function may not be called in combat anymore, as of 2.0.		This function may not be called in combat anymore, as of 2.0.

WoWWiki>Alestane at 22:26, 14 July 2007

2007-07-14T22:26:29Z

← Older revision		Revision as of 22:26, 14 July 2007
Line 11:		Line 11:
	; 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()]].		; 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()]].

	; 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.		; local : Numeric - Purpose unknown, always 1.
Line 27:		Line 27:
	== Notes ==		== Notes ==

	~~It is possible to do some WrongThings(tm) here:~~		* This function will generate an error if 18 macros of the specified kind already 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().		* 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 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.		This function may not be called in combat anymore, as of 2.0.

WoWWiki>N3rf at 00:27, 4 January 2007

2007-01-04T00:27:49Z

← Older revision		Revision as of 00:27, 4 January 2007
Line 32:		Line 32:

	* 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.		* 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.

WoWWiki>Nimbal: replaced "Template:WoW API" with "wowapi"

2006-07-09T09:01:32Z

replaced "Template:WoW API" with "wowapi"

@@ Line 1: / Line 1: @@
 Creates a new macro command/button.
   CreateMacro(name, icon, body, local, perCharacter)
@@ Line 30: / Line 32: @@
 * 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.

WoWWiki>Dmg at 06:50, 4 February 2006

2006-02-04T06:50:06Z

← Older revision		Revision as of 06:50, 4 February 2006
Line 1:		Line 1:
	Creates a new macro command/button.		Creates a new macro command/button.
	CreateMacro(name, icon, body, local)		CreateMacro(name, icon, body, local, perCharacter)

	== Arguments ==		== Arguments ==
	:(name, icon, body, local)		:(name, icon, body, local, perCharacter)

	; name : String - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit.		; name : String - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit.
Line 12:		Line 12:

	; local : Numeric - Purpose unknown, always 1.		; local : Numeric - Purpose unknown, always 1.

			; perCharcter : Numeric - 0 will create a "per account" saved macro, 1 will save it as "per character"

	== Returns ==		== Returns ==
Line 19:		Line 21:
	== Example ==		== Example ==

	local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1);		local macroId = CreateMacro("MyMacro", 12, "/script CastSpellById(1);", 1, 1);

	== Notes ==		== Notes ==
Line 25:		Line 27:
	It is possible to do some WrongThings(tm) here:		It is possible to do some WrongThings(tm) here:

	* 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) before calling CreateMacro().		* 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().

	* 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.		* 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.

WoWWiki>Anticrash at 14:51, 4 January 2006

2006-01-04T14:51:08Z

← Older revision		Revision as of 14:51, 4 January 2006
Line 1:		Line 1:
	~~[[Category:API Functions\|CreateMacro]]~~
	~~[[Category:API Macro Functions\|CreateMacro]]~~

	Creates a new macro command/button.		Creates a new macro command/button.
	CreateMacro(name, icon, body, local)		CreateMacro(name, icon, body, local)