WoW:API Frame SetUserPlaced: Difference between revisions

Latest revision as of 04:45, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Sets whether a frame has been moved by the user (and will thus be saved in the layout cache).

frame:SetUserPlaced(isUserPlaced);

isUserPlaced: Boolean - true if the frame has been moved by the user, false if not

There is usually no need to explicitly call this function; the flag is automatically set by 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.
Only frames created prior to the completion of the initial loading process will have their position restored.

@@ Line 1: / Line 1: @@
 {{widgetmethod}}
+Sets whether a frame has been moved by the user (and will thus be saved in the layout cache).
+ frame:SetUserPlaced(isUserPlaced);
-Sets whether a frame has been moved by the user.
+== Arguments ==
- Frame:SetUserPlaced(isUserPlaced)
-== Parameters ==
-=== Arguments ===
 ;isUserPlaced : Boolean - true if the frame has been moved by the user, false if not
-==Details==
+==Notes==
-Does '''not''' work on anonymous frames.
+* '''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.
-Named frames created by [[API_CreateFrame|CreateFrame]] must be created when the UI finish loading, for their position to be restored.
+* Only frames created prior to the completion of the initial loading process will have their position restored.
 ==Also See==
-* [[API_Frame_IsUserPlaced|Frame:IsUserPlaced()]]
+* {{api|t=w|Frame:IsUserPlaced}}()