WoW:API CreateFrame - Revision history

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

2023-08-15T04:45:23Z

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

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

92.78.186.40 at 22:04, 15 August 2019

2019-08-15T22:04:24Z

← Older revision		Revision as of 22:04, 15 August 2019
Line 8:		Line 8:
	=== Arguments ===		=== Arguments ===

	:;frameType : String - Type of the frame to be created (XML tag name): "Frame", "Button", etc. See [[UIOBJECT_Frame]]		:;frameType
	:;frameName : String - Name of the newly created frame. If nil, no frame name is assigned. The function will also set a global variable of this name to point to the newly created frame.		:: String - Type of the frame to be created (XML tag name): "Frame", "Button", etc. See [[UIOBJECT_Frame]]
	:;parentFrame : Frame - The frame object that will be used as the created Frame's parent (cannot be a string!) Does not default to UIParent if given nil.		:;frameName
	:;inheritsFrame : String - a comma-delimited list of names of virtual frames to inherit from (the same as in XML). If nil, no frames will be inherited. These frames cannot be frames that were created using this function, they must be created using XML with '''virtual="true"''' in the tag.		:: String - Name of the newly created frame. If nil, no frame name is assigned. The function will also set a global variable of this name to point to the newly created frame.
			:;parentFrame
			:: Frame - The frame object that will be used as the created Frame's parent (cannot be a string!) Does not default to UIParent if given nil.
			:;inheritsFrame
			:: String - a comma-delimited list of names of virtual frames to inherit from (the same as in XML). If nil, no frames will be inherited. These frames cannot be frames that were created using this function, they must be created using XML with '''virtual="true"''' in the tag.

	=== Returns ===		=== Returns ===

	:;newFrame : Frame - ~~Pointer~~ to the newly created frame.		:;newFrame
			:: Frame - Reference to the newly created frame.

	== Example ==		== Example ==
	Result: displays the horde and alliance insignias in the middle of the screen.		Result: displays the horde and alliance insignias in the middle of the screen.
	local f = CreateFrame("Frame",nil,UIParent)		local f = CreateFrame("Frame",nil,UIParent)
Line 37:		Line 42:
	* Frames CANNOT be deleted. Reuse them.		* Frames CANNOT be deleted. Reuse them.
	* The frame's [[UIHANDLER_OnLoad\|OnLoad handler]], which will only exist if inherited, will be executed during the CreateFrame call. Any OnLoad script handlers set after CreateFrame() will not execute; consider adding any non-inherited OnLoad code directly after a CreateFrame call or use XML frames instead.		* The frame's [[UIHANDLER_OnLoad\|OnLoad handler]], which will only exist if inherited, will be executed during the CreateFrame call. Any OnLoad script handlers set after CreateFrame() will not execute; consider adding any non-inherited OnLoad code directly after a CreateFrame call or use XML frames instead.
	* The returned ~~pointer~~ is not ~~necessary~~ if you ~~pass a frame name~~, however ~~it is~~ advised ~~you~~ store ~~the pointer~~ in a local ~~instead~~ of ~~using the~~ global name ~~whenever possible for performance reasons~~.		* The returned frame reference is not strictly necessary because you can access frames by their global name if you give them one. For performance reasons, however, it is advised to store frame references in local variables and use those instead of getting frames by their global name.
	* See also [[API_Frame_SetScript]] to handle OnFunction scripts when not using a template.		* See also [[API_Frame_SetScript]] to handle OnFunction scripts when not using a template.
	* The most common uses for this function are:		* The most common uses for this function are:

WoWWiki>Peeka: /* Arguments */

2010-10-21T01:47:53Z

Arguments

← Older revision		Revision as of 01:47, 21 October 2010
Line 8:		Line 8:
	=== Arguments ===		=== Arguments ===

	:;frameType : String - Type of the frame to be created (XML tag name): "Frame", "Button", etc.		:;frameType : String - Type of the frame to be created (XML tag name): "Frame", "Button", etc. See [[UIOBJECT_Frame]]
	:;frameName : String - Name of the newly created frame. If nil, no frame name is assigned. The function will also set a global variable of this name to point to the newly created frame.		:;frameName : String - Name of the newly created frame. If nil, no frame name is assigned. The function will also set a global variable of this name to point to the newly created frame.
	:;parentFrame : Frame - The frame object that will be used as the created Frame's parent (cannot be a string!) Does not default to UIParent if given nil.		:;parentFrame : Frame - The frame object that will be used as the created Frame's parent (cannot be a string!) Does not default to UIParent if given nil.

WoWWiki>Kaydeethree: /* Notes */ +cannot delete warning

2010-07-20T01:14:53Z

Notes: +cannot delete warning

← Older revision		Revision as of 01:14, 20 July 2010
Line 35:		Line 35:
	* CreateFrame() was added in 1.10		* CreateFrame() was added in 1.10
	* The fourth argument, inheritFrame, was added in 1.11		* The fourth argument, inheritFrame, was added in 1.11
			* Frames CANNOT be deleted. Reuse them.
	* The frame's [[UIHANDLER_OnLoad\|OnLoad handler]], which will only exist if inherited, will be executed during the CreateFrame call. Any OnLoad script handlers set after CreateFrame() will not execute; consider adding any non-inherited OnLoad code directly after a CreateFrame call or use XML frames instead.		* The frame's [[UIHANDLER_OnLoad\|OnLoad handler]], which will only exist if inherited, will be executed during the CreateFrame call. Any OnLoad script handlers set after CreateFrame() will not execute; consider adding any non-inherited OnLoad code directly after a CreateFrame call or use XML frames instead.
	* The returned pointer is not necessary if you pass a frame name, however it is advised you store the pointer in a local instead of using the global name whenever possible for performance reasons.		* The returned pointer is not necessary if you pass a frame name, however it is advised you store the pointer in a local instead of using the global name whenever possible for performance reasons.

WoWWiki>CalaveraDeluxe: /* Arguments */

2010-05-07T17:28:21Z

Arguments

← Older revision		Revision as of 17:28, 7 May 2010
Line 9:		Line 9:

	:;frameType : String - Type of the frame to be created (XML tag name): "Frame", "Button", etc.		:;frameType : String - Type of the frame to be created (XML tag name): "Frame", "Button", etc.
	:;frameName : String - Name of the newly created frame. If nil, no frame name is assigned. The function will also set a global variable of this name to point to newly created frame.		:;frameName : String - Name of the newly created frame. If nil, no frame name is assigned. The function will also set a global variable of this name to point to the newly created frame.
	:;parentFrame : Frame - The frame object that will be used as the created Frame's parent (cannot be a string!) Does not default to UIParent if given nil.		:;parentFrame : Frame - The frame object that will be used as the created Frame's parent (cannot be a string!) Does not default to UIParent if given nil.
	:;inheritsFrame : String - a comma-delimited list of names of virtual frames to inherit from (the same as in XML). If nil, no frames will be inherited. These frames cannot be frames that were created using this function, they must be created using XML with '''virtual="true"''' in the tag.		:;inheritsFrame : String - a comma-delimited list of names of virtual frames to inherit from (the same as in XML). If nil, no frames will be inherited. These frames cannot be frames that were created using this function, they must be created using XML with '''virtual="true"''' in the tag.

WoWWiki>Egingell: /* Notes */

2009-12-15T00:13:34Z

Notes

← Older revision		Revision as of 00:13, 15 December 2009
Line 35:		Line 35:
	* CreateFrame() was added in 1.10		* CreateFrame() was added in 1.10
	* The fourth argument, inheritFrame, was added in 1.11		* The fourth argument, inheritFrame, was added in 1.11
	* The frame's OnLoad handler, which will only exist if inherited, will be executed during the CreateFrame call. Any OnLoad script handlers set after CreateFrame() will not execute; consider adding any non-inherited OnLoad code directly after a CreateFrame call or use XML frames instead.		* The frame's [[UIHANDLER_OnLoad\|OnLoad handler]], which will only exist if inherited, will be executed during the CreateFrame call. Any OnLoad script handlers set after CreateFrame() will not execute; consider adding any non-inherited OnLoad code directly after a CreateFrame call or use XML frames instead.
	* The returned pointer is not necessary if you pass a frame name, however it is advised you store the pointer in a local instead of using the global name whenever possible for performance reasons.		* The returned pointer is not necessary if you pass a frame name, however it is advised you store the pointer in a local instead of using the global name whenever possible for performance reasons.
	* See also [[API_Frame_SetScript]] to handle OnFunction scripts when not using a template.		* See also [[API_Frame_SetScript]] to handle OnFunction scripts when not using a template.
Line 43:		Line 43:
	** Creating frames on the fly for occasions when you don't know how many frames will be needed.		** Creating frames on the fly for occasions when you don't know how many frames will be needed.
	** Creating infrequently used frames "on demand", for example: config dialogs, raid frames.		** Creating infrequently used frames "on demand", for example: config dialogs, raid frames.
	* Never forget to unset the frames parent, if you want to get rid of a frame. I would suggest to hide the frame via frame:[[API_Region_Hide\|Hide]]() and to use frame:[[API_Region_SetParent\|SetParent]](nil) ~~afterwards~~ (this will remove the frame from its parents child list). If you just hide the frame without this additional step, frames created ~~afterwards~~ will get a higher [[FrameLevel\|framelevel]] ~~then~~ the hidden one. After a while you will get frames at maximum [[FrameLevel\|framelevel]] which are likely to be drawn in a distorted way (false order caused by equal [[FrameLevel\|framelevel]]).		* Never forget to unset the frames parent, if you want to get rid of a frame. I would suggest to hide the frame via frame:[[API_Region_Hide\|Hide]]() and to use frame:[[API_Region_SetParent\|SetParent]](nil) afterward (this will remove the frame from its parents child list). If you just hide the frame without this additional step, frames created afterward will get a higher [[FrameLevel\|framelevel]] than the hidden one. After a while, you will get frames at maximum [[FrameLevel\|framelevel]] which are likely to be drawn in a distorted way (false order caused by equal [[FrameLevel\|framelevel]]).

WoWWiki>Starlightblunder: /* Notes */ stray comma

2009-12-14T23:00:04Z

Notes: stray comma

← Older revision		Revision as of 23:00, 14 December 2009
Line 20:		Line 20:
	Result: displays the horde and alliance insignias in the middle of the screen.		Result: displays the horde and alliance insignias in the middle of the screen.
	local f = CreateFrame("Frame",nil,UIParent)		local f = CreateFrame("Frame",nil,UIParent)
	~~[[API Frame SetFrameStrata\|~~f:SetFrameStrata]]("BACKGROUND")		f:SetFrameStrata("BACKGROUND")
	~~[[API Region SetWidth\|~~f:SetWidth]](128) -- Set these to whatever height/width is needed		f:SetWidth(128) -- Set these to whatever height/width is needed
	~~[[API Region SetHeight\|~~f:SetHeight]](64) -- for your Texture		f:SetHeight(64) -- for your Texture

	local t = ~~[[API Frame CreateTexture\|~~f:CreateTexture]](nil,"BACKGROUND")		local t = f:CreateTexture(nil,"BACKGROUND")
	~~[[API Texture SetTexture\|~~t:SetTexture]]("Interface\\Glues\\CharacterCreate\\UI-CharacterCreate-Factions.blp")		t:SetTexture("Interface\\Glues\\CharacterCreate\\UI-CharacterCreate-Factions.blp")
	~~[[API Region SetAllPoints\|~~t:SetAllPoints]](f)		t:SetAllPoints(f)
	f.texture = t		f.texture = t

	~~[[API Region SetPoint\|~~f:SetPoint]]("CENTER",0,0)		f:SetPoint("CENTER",0,0)
	~~[[API Region Show\|~~f:Show]]()		f:Show()

	== Notes ==		== Notes ==
Line 43:		Line 43:
	** Creating frames on the fly for occasions when you don't know how many frames will be needed.		** Creating frames on the fly for occasions when you don't know how many frames will be needed.
	** Creating infrequently used frames "on demand", for example: config dialogs, raid frames.		** Creating infrequently used frames "on demand", for example: config dialogs, raid frames.
	* Never forget to unset the frames parent, if you want to get rid of a frame. I would suggest to hide the frame via frame:[[API_Region_Hide\|Hide]]() and to use frame:[[API_Region_SetParent\|SetParent]](nil) afterwards (this will remove the frame from its parents child list). If you just hide the frame without this additional step, ~~the frame will keep alive. If you add a new frame, it~~ will get a higher [[FrameLevel\|framelevel]] then the hidden one. After a while you will get frames at maximum [[FrameLevel\|framelevel]] which are likely to be drawn in a distorted way (false order caused by equal [[FrameLevel\|framelevel]]).		* Never forget to unset the frames parent, if you want to get rid of a frame. I would suggest to hide the frame via frame:[[API_Region_Hide\|Hide]]() and to use frame:[[API_Region_SetParent\|SetParent]](nil) afterwards (this will remove the frame from its parents child list). If you just hide the frame without this additional step, frames created afterwards will get a higher [[FrameLevel\|framelevel]] then the hidden one. After a while you will get frames at maximum [[FrameLevel\|framelevel]] which are likely to be drawn in a distorted way (false order caused by equal [[FrameLevel\|framelevel]]).

WoWWiki>Ohklus at 16:17, 14 December 2009

2009-12-14T16:17:19Z

← Older revision		Revision as of 16:17, 14 December 2009
Line 43:		Line 43:
	** Creating frames on the fly for occasions when you don't know how many frames will be needed.		** Creating frames on the fly for occasions when you don't know how many frames will be needed.
	** Creating infrequently used frames "on demand", for example: config dialogs, raid frames.		** Creating infrequently used frames "on demand", for example: config dialogs, raid frames.
			* Never forget to unset the frames parent, if you want to get rid of a frame. I would suggest to hide the frame via frame:[[API_Region_Hide\|Hide]]() and to use frame:[[API_Region_SetParent\|SetParent]](nil) afterwards (this will remove the frame from its parents child list). If you just hide the frame without this additional step, the frame will keep alive. If you add a new frame, it will get a higher [[FrameLevel\|framelevel]] then the hidden one. After a while you will get frames at maximum [[FrameLevel\|framelevel]] which are likely to be drawn in a distorted way (false order caused by equal [[FrameLevel\|framelevel]]).

WoWWiki>Egingell: /* Example */

2009-12-13T05:20:24Z

Example

← Older revision		Revision as of 05:20, 13 December 2009
Line 20:		Line 20:
	Result: displays the horde and alliance insignias in the middle of the screen.		Result: displays the horde and alliance insignias in the middle of the screen.
	local f = CreateFrame("Frame",nil,UIParent)		local f = CreateFrame("Frame",nil,UIParent)
	f:SetFrameStrata("BACKGROUND")		[[API Frame SetFrameStrata\|f:SetFrameStrata]]("BACKGROUND")
	f:SetWidth(128) -- Set these to whatever height/width is needed		[[API Region SetWidth\|f:SetWidth]](128) -- Set these to whatever height/width is needed
	f:SetHeight(64) -- for your Texture		[[API Region SetHeight\|f:SetHeight]](64) -- for your Texture

	local t = f:CreateTexture(nil,"BACKGROUND")		local t = [[API Frame CreateTexture\|f:CreateTexture]](nil,"BACKGROUND")
	t:SetTexture("Interface\\Glues\\CharacterCreate\\UI-CharacterCreate-Factions.blp")		[[API Texture SetTexture\|t:SetTexture]]("Interface\\Glues\\CharacterCreate\\UI-CharacterCreate-Factions.blp")
	t:SetAllPoints(f)		[[API Region SetAllPoints\|t:SetAllPoints]](f)
	f.texture = t		f.texture = t

	f:SetPoint("CENTER",0,0)		[[API Region SetPoint\|f:SetPoint]]("CENTER",0,0)
	f:Show()		[[API Region Show\|f:Show]]()

	== Notes ==		== Notes ==
	* The game will not find image files that did not exist when it was started you may need to restart the game for this code to work.
	* CreateFrame() was added in 1.10		* CreateFrame() was added in 1.10
	* The fourth argument, inheritFrame, was added in 1.11		* The fourth argument, inheritFrame, was added in 1.11

WoWWiki>Eadthem: The game will not find image files that did not exist when it was started you may need to restart the game for this code to work.

2009-12-13T02:33:12Z

The game will not find image files that did not exist when it was started you may need to restart the game for this code to work.

← Older revision		Revision as of 02:33, 13 December 2009
Line 33:		Line 33:

	== Notes ==		== Notes ==
			* The game will not find image files that did not exist when it was started you may need to restart the game for this code to work.
	* CreateFrame() was added in 1.10		* CreateFrame() was added in 1.10
	* The fourth argument, inheritFrame, was added in 1.11		* The fourth argument, inheritFrame, was added in 1.11