WoW:API EditMacro - Revision history

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

2023-08-15T04:45:28Z

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

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>HighFive: mostly clarification

2009-04-16T09:56:55Z

mostly clarification

← Older revision		Revision as of 09:56, 16 April 2009
Line 2:		Line 2:
	Edit macro command/button.		Edit macro command/button.

	EditMacro(index, name, icon, body, local, perCharacter)		EditMacro(index or macroName, name, icon, body, local, perCharacter)

	This function may only be called when out of combat.		This function may only be called when out of combat.

	== Arguments ==		== Arguments ==
	:(index, name, icon, body, local, perCharacter)		:(index or macroName, name, icon, body, local, perCharacter)

	; index : ~~Numeric~~ - ~~Macro~~ index ~~number~~. ~~Provided by [[API GetMacroIndexByName\|GetMacroIndexByName()]]~~.		; index or macroName : Number or string - the index or name of the macro to be edited. Index ranges from 1 to 36 for account wide macros and 37 to 54 for character specific.

	; 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. The name remains unchanged if nil.

	; 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 of icon textures available by calling [[API GetNumMacroIcons\|GetNumMacroIcons()]]. The icon remains unchanged if nil.

	; 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.
Line 22:		Line 22:

	== Returns ==		== Returns ==
	; macroId : Numeric - The ~~1-based~~ index of the macro, as displayed in the "Create Macros" UI. Same as argument "index".		; macroId : Numeric - The new index of the macro, as displayed in the "Create Macros" UI. Same as argument "index" unless the macro name is changed, as they are sorted alphabetically.

	== Example ==		== Example ==
Line 29:		Line 29:

	== Notes ==		== Notes ==
			*If this function is called from within the macro that is edited, the rest of the macro (from the final character's position of the /run command onward) will run the new version.

WoWWiki>Hypehuman: /* Arguments */ updated info on perCharacter

2008-08-11T19:43:11Z

Arguments: updated info on perCharacter

← Older revision		Revision as of 19:43, 11 August 2008
Line 19:		Line 19:
	; local : Numeric - Purpose unknown, always 1.		; local : Numeric - Purpose unknown, always 1.

	; perCharacter : ~~Numeric - 0 "per account" macro~~, ~~1 "per~~ character"		; perCharacter : Archaic. Now purposeless, since character and account macros are given unique IDs.

	== Returns ==		== Returns ==

WoWWiki>ThePooBurner at 14:32, 28 April 2008

2008-04-28T14:32:41Z

← Older revision		Revision as of 14:32, 28 April 2008
Line 3:		Line 3:

	EditMacro(index, name, icon, body, local, perCharacter)		EditMacro(index, name, icon, body, local, perCharacter)

			This function may only be called when out of combat.

	== Arguments ==		== Arguments ==

WoWWiki>Alestane at 22:30, 14 July 2007

2007-07-14T22:30:56Z

← Older revision		Revision as of 22:30, 14 July 2007
Line 13:		Line 13:
	; 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.

WoWWiki>Rickerecke: /* Returns */

2007-03-22T16:00:07Z

Returns

New page

{{wowapi}}
Edit macro command/button.

EditMacro(index, name, icon, body, local, perCharacter)

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

; index : Numeric - Macro index number. Provided by [[API GetMacroIndexByName|GetMacroIndexByName()]].

; 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()]].

; body : String - The macro commands to be executed.

; local : Numeric - Purpose unknown, always 1.

; perCharacter : Numeric - 0 "per account" macro, 1 "per character"

== Returns ==
; macroId : Numeric - The 1-based index of the macro, as displayed in the "Create Macros" UI. Same as argument "index".

== Example ==

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

== Notes ==