WoW:API Frame SetUserPlaced: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API Frame SetUserPlaced to API Frame SetUserPlaced without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{widgetmethod}}
{{widgetmethod}}
Sets whether a frame has been moved by the user (and will thus be saved in the layout cache).
Sets whether a frame has been moved by the user (and will thus be saved in the layout cache).
frame:SetUserPlaced(isUserPlaced);


Frame:SetUserPlaced(isUserPlaced)
== Arguments ==
 
== Parameters ==
=== Arguments ===
;isUserPlaced : Boolean - true if the frame has been moved by the user, false if not
;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==
==Also See==
* [[API_Frame_IsUserPlaced|Frame:IsUserPlaced()]]
* {{api|t=w|Frame:IsUserPlaced}}()

Latest revision as of 04:45, 15 August 2023

Widget API ← Frame < SetUserPlaced

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

frame:SetUserPlaced(isUserPlaced);

Arguments[edit]

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

Notes[edit]

  • 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.

Also See[edit]