WoW:API Frame IsUserPlaced: 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

Returns whether the frame has been moved by the user.

userPlaced = Frame:IsUserPlaced()

userPlaced: Boolean - true if the user moved the frame (i.e. Frame:SetUserPlaced(true) was called earlier)

Does not work on frames that were created by CreateFrame.

@@ Line 1: / Line 1: @@
-{{widgetmethod}} __NOTOC__
+{{widgetmethod}}
-<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
 Returns whether the frame has been moved by the user.
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+  userPlaced = Frame:IsUserPlaced()
-  userPlaced = [[API_Frame_IsUserPlaced|Frame:IsUserPlaced()]]
 == Parameters ==
-=== Arguments ===
-<!-- List each argument, together with its type -->
-''none''
 === Returns ===
-<!-- List each return value, together with its type -->
+;userPlaced : Boolean - true if the user moved the frame (i.e. [[API_Frame_SetUserPlaced|Frame:SetUserPlaced]](true) was called earlier)
-:;userPlaced : Boolean - true if the user moved the frame (i.e. [[API_Frame_SetUserPlaced|Frame:SetUserPlaced]](true) was called earlier)
 ==Details==
-<!-- Details not appropriate for the main description can go here.
+Does '''not''' work on frames that were created by [[API_CreateFrame|CreateFrame]].
-     REMOVE the section if you're just going to restate the intro line! -->
-: Does '''not''' work on frames that were created by [[API_CreateFrame|CreateFrame]].