WoW:API Frame SetUserPlaced: Difference between revisions

← Older edit

WoW:API Frame SetUserPlaced (source)

Revision as of 04:45, 15 August 2023

120 bytes removed , 15 August 2023

m

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

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-{{widgetmethod}} __NOTOC__
+{{widgetmethod}}
+Sets whether a frame has been moved by the user (and will thus be saved in the layout cache).
+ frame:SetUserPlaced(isUserPlaced);
+== Arguments ==
+;isUserPlaced : Boolean - true if the frame has been moved by the user, false if not
-<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
+==Notes==
-Sets whether a frame has been moved by the user.
+* '''There is usually no need to explicitly call this function'''; the flag is automatically set by {{api|t=w|Frame:StartMoving}}(), and when the frame's position is restored from the layout cache.
+* Positions of anonymous frames (frames without a name) will not be restored.
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+* Only frames created prior to the completion of the initial loading process will have their position restored.
-Frame:SetUserPlaced(isUserPlaced)
-== Parameters ==
-=== Arguments ===
-<!-- List each argument, together with its type -->
-:(isUserPlaced)
-:;isUserPlaced : Boolean - true if the frame has been moved by the user, false if not
-==Details==
-<!-- Details not appropriate for the main description can go here.
-     REMOVE the section if you're just going to restate the intro line! -->
-: Does '''not''' work on frames that have been created by [[API_CreateFrame]].
 ==Also See==
+* {{api|t=w|Frame:IsUserPlaced}}()
-* [[API_Frame_IsUserPlaced|Frame:IsUserPlaced()]]