WoW:API Frame SetScript: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Move page script moved page API Frame SetScript to API Frame SetScript without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
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, [[XML_User_Interface#Event_Handler_reference|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, event, arg1, arg2, ...)</tt>
 
== Example ==
  for i = 1, 4 do
  for i = 1, 4 do
     local frame = getglobal("PartyMemberFrame"..i)
     local frame = _G["PartyMemberFrame"..i]
     frame:SetScript("OnShow", function() this:Hide() end)
     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}}
* {{api|Frame:HookScript|t=w}}
* [[Widget_handlers]]

Latest revision as of 04:45, 15 August 2023

← Widget API ← Frame < SetScript

Sets an event handler for a specific event type for this frame. 

frame:SetScript("handler", func)

Parameters[edit]

Arguments[edit]

handler
string - the name of the handler type, like 'OnShow', 'OnClick'. See Widget_handlers.
func
function - the Lua function to call or 'nil' to remove the handler

Examples[edit]

for i = 1, 4 do
    local frame = _G["PartyMemberFrame"..i]
    frame:SetScript("OnShow", frame.Hide)
end

Adds an 'OnShow' event handler to all party frames to be called whenever they're shown. 

PartyMemberFrame1:SetScript("OnShow", nil)

Removes whatever 'OnShow' handler was set from 'PartyMemberFrame1'.

See also[edit]

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_Frame_SetScript&oldid=18838"