WoW:API Frame SetScript - Revision history

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

2023-08-15T04:45:36Z

Move page script moved page API Frame SetScript to API Frame SetScript without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>CavaX at 21:45, 2 June 2018

2018-06-02T21:45:58Z

← Older revision		Revision as of 21:45, 2 June 2018
Line 22:		Line 22:
	== See also ==		== See also ==
	* {{api\|Frame:GetScript\|t=w}}		* {{api\|Frame:GetScript\|t=w}}
	* {{api\|Frame:HookScript\|t = w}}		* {{api\|Frame:HookScript\|t=w}}
	* [[Widget_handlers]]		* [[Widget_handlers]]

2.5.2.152: /* See also */

2018-06-01T22:05:06Z

Bear at 19:01, 16 February 2015

2015-02-16T19:01:14Z

← Older revision		Revision as of 19:01, 16 February 2015
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}

	Sets ~~the action~~ handler for this frame.		Sets an event handler for a specific event type for this frame.

	frame:SetScript("handler", ~~function~~)		frame:SetScript("handler", func)

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	<!-~~- List each argument~~, ~~together with its type -->~~		:;handler : string - the name of the handler type, like 'OnShow', 'OnClick'. See [[Widget_handlers]].
	:("handler~~", func)~~		:;func : function - the Lua function to call or 'nil' to remove the handler

	~~:;handler : String - The handler to attach func to (OnShow, OnEvent, [[Widget_handlers\|et al]])~~		== Examples ==
	:;func : Function - The function to call. <tt>nil</tt> to remove the handler. <tt>func</tt> is called with arguments <tt>(frame, arg1, arg2, ...)</tt> (<tt>event</tt> being <tt>arg1</tt> for OnEvent handlers)

	== ~~Example~~ ==
	for i = 1, 4 do		for i = 1, 4 do
	local frame = ~~getglobal(~~"PartyMemberFrame"..i)		local frame = _G["PartyMemberFrame"..i]
	frame:SetScript("OnShow", frame.Hide)		frame:SetScript("OnShow", frame.Hide)
	end		end
			Adds an 'OnShow' event handler to all party frames to be called whenever they're shown.
	~~====Result====~~
	~~All~~ party frames ~~will~~ be ~~hidden~~ whenever they're shown.

	PartyMemberFrame1:SetScript("OnShow", nil)		PartyMemberFrame1:SetScript("OnShow", nil)
	~~====Result====~~		Removes whatever 'OnShow' handler was set from 'PartyMemberFrame1'.
	Removes ~~the~~ OnShow handler from PartyMemberFrame1.

	~~__NOTOC__~~		== See also ==
			* {{api\|Frame:GetScript\|t=w}}
			* [[Widget_handlers]]

WoWWiki>NefariousN: Factual correction

2008-10-19T17:50:38Z

Factual correction

← Older revision		Revision as of 17:50, 19 October 2008
Line 11:		Line 11:

	:;handler : String - The handler to attach func to (OnShow, OnEvent, [[Widget_handlers\|et al]])		:;handler : String - The handler to attach func to (OnShow, OnEvent, [[Widget_handlers\|et al]])
	:;func : Function - The function to call. <tt>nil</tt> to remove the handler. <tt>func</tt> is called with arguments <tt>(frame~~, event~~, arg1, arg2, ...)</tt>		:;func : Function - The function to call. <tt>nil</tt> to remove the handler. <tt>func</tt> is called with arguments <tt>(frame, arg1, arg2, ...)</tt> (<tt>event</tt> being <tt>arg1</tt> for OnEvent handlers)

	== Example ==		== Example ==
	for i = 1, 4 do		for i = 1, 4 do
	local frame = getglobal("PartyMemberFrame"..i)		local frame = getglobal("PartyMemberFrame"..i)
	frame:SetScript("OnShow", ~~function(self) self:~~Hide~~() end~~)		frame:SetScript("OnShow", frame.Hide)
	end		end

WoWWiki>Arrowmaster: Update link to additional widget handlers

2007-12-29T02:28:29Z

Update link to additional widget handlers

← Older revision		Revision as of 02:28, 29 December 2007
Line 10:		Line 10:
	:("handler", func)		:("handler", func)

	:;handler : String - The handler to attach func to (OnShow, OnEvent, [[~~XML_User_Interface#Event_Handler_reference~~\|et al]])		:;handler : String - The handler to attach func to (OnShow, OnEvent, [[Widget_handlers\|et al]])
	:;func : Function - The function to call. <tt>nil</tt> to remove the handler. <tt>func</tt> is called with arguments <tt>(frame, event, arg1, arg2, ...)</tt>		:;func : Function - The function to call. <tt>nil</tt> to remove the handler. <tt>func</tt> is called with arguments <tt>(frame, event, arg1, arg2, ...)</tt>

Line 16:		Line 16:
	for i = 1, 4 do		for i = 1, 4 do
	local frame = getglobal("PartyMemberFrame"..i)		local frame = getglobal("PartyMemberFrame"..i)
	frame:SetScript("OnShow", function() ~~this~~:Hide() end)		frame:SetScript("OnShow", function(self) self:Hide() end)
	end		end

WoWWiki>Casull: /* Arguments */

2007-07-16T16:36:28Z

Arguments

← Older revision		Revision as of 16:36, 16 July 2007
Line 11:		Line 11:

	:;handler : String - The handler to attach func to (OnShow, OnEvent, [[XML_User_Interface#Event_Handler_reference\|et al]])		:;handler : String - The handler to attach func to (OnShow, OnEvent, [[XML_User_Interface#Event_Handler_reference\|et al]])
	:;func : Function - The function to call. <tt>nil</tt> to remove the handler.		:;func : Function - The function to call. <tt>nil</tt> to remove the handler. <tt>func</tt> is called with arguments <tt>(frame, event, arg1, arg2, ...)</tt>

	== Example ==		== Example ==

WoWWiki>Mikk: Nuke author line

2007-06-30T20:52:16Z

Nuke author line

← Older revision		Revision as of 20:52, 30 June 2007
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}

	~~<center>'''Frame:SetScript''' ''-Documentation by [[user:Author\|Author]]-''</center>~~

	Sets the action handler for this frame.		Sets the action handler for this frame.

WoWWiki>Godefroi: Minor typo

2006-12-26T16:47:10Z

Minor typo

← Older revision		Revision as of 16:47, 26 December 2006
Line 22:		Line 22:

	====Result====		====Result====
	All party frames will be hidden whenever they're ~~show~~.		All party frames will be hidden whenever they're shown.

	PartyMemberFrame1:SetScript("OnShow", nil)		PartyMemberFrame1:SetScript("OnShow", nil)

WoWWiki>Mikk: {{widgetmethod}}

2006-06-10T12:00:08Z

← Older revision		Revision as of 12:00, 10 June 2006
Line 1:		Line 1:
			{{widgetmethod}}

	<center>'''Frame:SetScript''' ''-Documentation by [[user:Author\|Author]]-''</center>		<center>'''Frame:SetScript''' ''-Documentation by [[user:Author\|Author]]-''</center>

Line 27:		Line 29:

	__NOTOC__		__NOTOC__
	~~{{template:WoW API}}~~

← Older revision		Revision as of 22:05, 1 June 2018
Line 22:		Line 22:
	== See also ==		== See also ==
	* {{api\|Frame:GetScript\|t=w}}		* {{api\|Frame:GetScript\|t=w}}
			* {{api\|Frame:HookScript\|t = w}}
	* [[Widget_handlers]]		* [[Widget_handlers]]