WoW:API Frame SetUserPlaced: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Docs analogous to API_Frame_IsUserPlaced)
 
m (Move page script moved page API Frame SetUserPlaced to API Frame SetUserPlaced without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
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==
==Also See==
 
* {{api|t=w|Frame:IsUserPlaced}}()
* [[API_Frame_IsUserPlaced|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]

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