WoW:Making Draggable Frames - Revision history

Move page script: Move page script moved page Making Draggable Frames to WoW:Making Draggable Frames without leaving a redirect

2023-08-15T04:48:52Z

Move page script moved page Making Draggable Frames to Making Draggable Frames without leaving a redirect

← Older revision

Revision as of 04:48, 15 August 2023

Bear at 09:15, 21 May 2020

2020-05-21T09:15:22Z

← Older revision		Revision as of 09:15, 21 May 2020
Line 1:		Line 1:
	{{~~UIHowTo~~}}		{{wow/uihowto}}
	Draggable frames can be moved by having the user hold down a mouse button over the frame, then move the mouse to reposition the frame. This HOWTO describes how to make a frame draggable.		Draggable frames can be moved by having the user hold down a mouse button over the frame, then move the mouse to reposition the frame. This HOWTO describes how to make a frame draggable.

Line 19:		Line 19:
	<nowiki><!-- Tags below add a visual element to the frame. --></nowiki>		<nowiki><!-- Tags below add a visual element to the frame. --></nowiki>
	<Layers>		<Layers>
	<Layer level="ARTWORK">		<Layer level="ARTWORK">
	<Texture setAllPoints="true">		<nowiki> </nowiki> <Texture setAllPoints="true">
	<Color r="1.0" g="0.5" b="0.0" a="0.5" />		<nowiki> </nowiki> <Color r="1.0" g="0.5" b="0.0" a="0.5" />
	</Texture>		<nowiki> </Texture>
	</Layer>		</Layer>
	</Layers>		</Layers>
	<Size x="64" y="64" />		</nowiki><Size x="64" y="64" />
	<Anchors><Anchor point="CENTER" relativeTo="UIParent"/></Anchors>		<nowiki> </nowiki><Anchors><Anchor point="CENTER" relativeTo="UIParent"/></Anchors>
	</Frame>		</Frame>
	</Ui>		</Ui>
Line 72:		Line 72:
	<nowiki><!-- Tags below add a visual element to the frame. --></nowiki>		<nowiki><!-- Tags below add a visual element to the frame. --></nowiki>
	<Layers>		<Layers>
	<Layer level="ARTWORK">		<Layer level="ARTWORK">
	<Texture setAllPoints="true">		<nowiki> </nowiki> <Texture setAllPoints="true">
	<Color r="1.0" g="0.5" b="0.0" a="0.5" />		<nowiki> </nowiki> <Color r="1.0" g="0.5" b="0.0" a="0.5" />
	</Texture>		<nowiki> </Texture>
	</Layer>		</Layer>
	</Layers>		</Layers>
	<Anchors><Anchor point="CENTER" relativeTo="UIParent"/></Anchors>		</nowiki><Anchors><Anchor point="CENTER" relativeTo="UIParent"/></Anchors>
	</Frame>		</Frame>

98.201.3.67: /* Using OnDragStart OnDragStop */

2015-09-12T20:04:06Z

Using OnDragStart OnDragStop

← Older revision		Revision as of 20:04, 12 September 2015
Line 95:		Line 95:
	tex:SetAllPoints();		tex:SetAllPoints();
	tex:SetTexture(1.0, 0.5, 0); tex:SetAlpha(0.5);		tex:SetTexture(1.0, 0.5, 0); tex:SetAlpha(0.5);



	=== Using OnMouseDown / OnMouseUp ===		=== Using OnMouseDown / OnMouseUp ===

WoWWiki>Xerra at 22:53, 24 January 2013

2013-01-24T22:53:23Z

← Older revision		Revision as of 22:53, 24 January 2013
Line 10:		Line 10:
	=== Using OnDragStart / OnDragStop ===		=== Using OnDragStart / OnDragStop ===
	The code below creates a draggable Frame widget and uses the OnDrag widget handlers to initiate dragging. Note the use of movable and enableMouse attributes:		The code below creates a draggable Frame widget and uses the OnDrag widget handlers to initiate dragging. Note the use of movable and enableMouse attributes:
	<Frame name="DragFrame1" enableMouse="true" movable="true">		<Ui>
			<Frame name="DragFrame1" enableMouse="true" movable="true">
	<Scripts>		<Scripts>
	<OnLoad>self:RegisterForDrag("LeftButton");</OnLoad>		<OnLoad>self:RegisterForDrag("LeftButton");</OnLoad>
Line 27:		Line 28:
	<Anchors><Anchor point="CENTER" relativeTo="UIParent"/></Anchors>		<Anchors><Anchor point="CENTER" relativeTo="UIParent"/></Anchors>
	</Frame>		</Frame>
			</Ui>

	Note the use of the OnLoad Script, In order to drag a frame it must register for drag via {{api\|Frame RegisterForDrag\|Frame:RegisterForDrag("button")}}.		Note the use of the OnLoad Script, In order to drag a frame it must register for drag via {{api\|Frame RegisterForDrag\|Frame:RegisterForDrag("button")}}. Above code edited to include the <Ui> </Ui> tags as it
			is .xml and won't work without this.

	=== Using OnMouseUp/OnMouseDown ===		=== Using OnMouseUp/OnMouseDown ===

WoWWiki>CaptainFlan: /* Using OnMouseDown / OnMouseUp */ Code correction; see talk page

2011-03-04T04:12:49Z

Using OnMouseDown / OnMouseUp: Code correction; see talk page

← Older revision		Revision as of 04:12, 4 March 2011
Line 100:		Line 100:
	frame:SetMovable(true)		frame:SetMovable(true)
	frame:EnableMouse(true)		frame:EnableMouse(true)
	frame:SetScript("OnMouseDown", function(self)		frame:SetScript("OnMouseDown", function(self, button)
	if button == "LeftButton" and not self.isMoving then		if button == "LeftButton" and not self.isMoving then
	self:StartMoving();		self:StartMoving();
Line 106:		Line 106:
	end		end
	end)		end)
	frame:SetScript("OnMouseUp", function(self)		frame:SetScript("OnMouseUp", function(self, button)
	if button == "LeftButton" and self.isMoving then		if button == "LeftButton" and self.isMoving then
	self:StopMovingOrSizing();		self:StopMovingOrSizing();
Line 123:		Line 123:
	tex:SetAllPoints();		tex:SetAllPoints();
	tex:SetTexture(1.0, 0.5, 0); tex:SetAlpha(0.5);		tex:SetTexture(1.0, 0.5, 0); tex:SetAlpha(0.5);


	==General Notes==		==General Notes==

WoWWiki>Delock: /* Using TitleRegion */ Invalid XML

2010-09-18T11:46:43Z

Using TitleRegion: Invalid XML

← Older revision		Revision as of 11:46, 18 September 2010
Line 65:		Line 65:
	<TitleRegion>		<TitleRegion>
	<Size x="100" y="20"/>		<Size x="100" y="20"/>
	<Anchors><Anchor point="TOP"></Anchors>		<Anchors><Anchor point="TOP"/></Anchors>
	<TitleRegion>		</TitleRegion>
	<nowiki><!-- Tags below add a visual element to the frame. --></nowiki>		<nowiki><!-- Tags below add a visual element to the frame. --></nowiki>
	<Layers>		<Layers>

WoWWiki>Orionshock: fill out both options for moving a frame in both lua and xml

2010-08-25T07:42:24Z

fill out both options for moving a frame in both lua and xml

@@ Line 5: / Line 5: @@
 To initiate dragging of a frame, call {{api|Frame StartMoving|Frame:StartMoving()}}; to stop, call {{api|Frame StopMovingOrSizing|Frame:StopMovingOrSizing()}}. The frame must be flagged as movable (either through the movable attribute in its XML declaration or using {{api|Frame SetMovable|Frame:SetMovable}}(isMovable).
-While those functions can theoretically be called from anywhere, {{api|Frame RegisterForDrag|Frame:RegisterForDrag}}("button1", ...) allows the use of OnDragStart/OnDragStop widget handlers. Note that to receive mouse events (including dragging), the frame must be mouse enabled (either through the enableMouse attribute in its XML declaration or using {{api|Frame EnableMouse|Frame:EnableMouse}}(isEnabled)); buttons are mouse-enabled by default.
+There are generally 2 methods that are used for moving a frame, by Dragging the frame (OnDragStart & OnDragStop Handlers) or Clicking the frame (OnMouseDown & OnMouseUp Handlers). Note: that to receive mouse events (including dragging), the frame must be mouse enabled (either through the enableMouse attribute in its XML declaration or using {{api|Frame EnableMouse|Frame:EnableMouse}}(isEnabled)); buttons are mouse-enabled by default.
 == Using XML ==
-The code below creates a draggable Frame widget and uses the Drag widget handlers to initiate dragging. Note the use of movable and enableMouse attributes:
+=== Using OnDragStart / OnDragStop ===
   <Frame name="DragFrame1" enableMouse="true" movable="true">
    <Scripts>
@@ Line 26: / Line 27: @@
    <Anchors><Anchor point="CENTER" relativeTo="UIParent"/></Anchors>
   </Frame>
 === Using OnMouseUp/OnMouseDown ===
-The OnDrag* handlers typically require the mouse button to be held down for a small amount of time prior to enabling the mouse behavior, making them well suited for dragging widgets that normally respond to clicks. However, if the frame you wish to make draggable is not normally a button, you can use OnMouseUp/OnMouseDown to provide a more responsive experience.
+While OnDrag* handlers typically require the mouse button to be held down for a small amount of time prior to enabling the mouse behavior, making them well suited for dragging widgets that normally respond to clicks. However, if the frame you wish to make draggable is not normally a button, you can use OnMouseUp/OnMouseDown to provide a more responsive experience.
 The following snippet illustrates this concept, and should replace the <Scripts> block above:
   <Scripts>
    <OnMouseDown>
-    if button == "LeftButton" and not self.isLocked then
+    if button == "LeftButton" and not self.isMoving then
      self:StartMoving();
      self.isMoving = true;
@@ Line 76: / Line 79: @@
 == Using Lua ==
 The code sample below illustrates the use of the [[Widget API]] to achieve the same results as the XML above:
   local frame = CreateFrame("Frame", "DragFrame2", UIParent)
   frame:SetMovable(true)
   frame:EnableMouse(true)
-  frame:SetScript("OnMouseDown", frame.StartMoving)
+ frame:RegisterForDrag("LeftButton")
-  frame:SetScript("OnMouseUp", frame.StopMovingOrSizing)
+  frame:SetScript("OnDragStart", frame.StartMoving)
   -- The code below makes the frame visible, and is not necessary to enable dragging.
   frame:SetPoint("CENTER"); frame:SetWidth(64); frame:SetHeight(64);
@@ Line 87: / Line 92: @@
   tex:SetAllPoints();
   tex:SetTexture(1.0, 0.5, 0); tex:SetAlpha(0.5);

WoWWiki>Starlightblunder: nowiki in XML comments.

2009-12-28T18:11:49Z

nowiki in XML comments.

Show changes

WoWWiki>Peeka at 23:22, 13 June 2008

2008-06-13T23:22:49Z

← Older revision		Revision as of 23:22, 13 June 2008
Line 85:		Line 85:

	This way, your <Frame> can still receive mouse events, and you can only drag it by clicking within its <TitleRegion>.		This way, your <Frame> can still receive mouse events, and you can only drag it by clicking within its <TitleRegion>.

			== Lua Only Approach ==

			If your frame is called MyFrame -

			MyFrame:SetMovable(true)
			MyFrame:EnableMouse(true)
			MyFrame:SetScript("OnMouseDown",function()
			MyFrame:StartMoving()
			end)
			MyFrame:SetScript("OnMouseUp",function()
			MyFrame:StopMovingOrSizing()
			end)


	[[Category: HOWTOs\|Make a Frame Draggable]]		[[Category: HOWTOs\|Make a Frame Draggable]]

WoWWiki>Quezacolt: /* Parent Dragging */ Updated - We now have the SetMovable widget function

2008-05-22T09:02:33Z

Parent Dragging: Updated - We now have the SetMovable widget function

← Older revision		Revision as of 09:02, 22 May 2008
Line 54:		Line 54:
	== Parent Dragging ==		== Parent Dragging ==

	Some advanced dragging addons use overlays that make default ~~blizzard~~ frames draggable. This is possible by using GetParent when starting and stopping drag. ~~Unfortunetly~~ this ~~means that~~ the parent frame ~~must already~~		Some advanced dragging addons use overlays that make default Blizzard frames draggable. This is possible by using GetParent when starting and stopping drag. To do this, one must make the parent frame movable through the use of the SetMovable widget function, i.e. <tt>''frame'':SetMovable(true)</tt>. One drawback with overlay frames that are mouse enabled is that they will prevent the parent frame's click script tags from being called so you often have to simulate their click events.
	be movable~~="true". (In~~ the ~~upcomming patch you will be able to~~ use SetMovable(1) ~~to modify a frames' movable tag~~.) ~~Another~~ drawback with overlay frames that are mouse enabled is that they will prevent the parent frame's click script tags from being called so you often have to simulate their click events.

	== Quick Dragging Code ==		== Quick Dragging Code ==