WoW:API Frame GetFrameStrata: 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 the strata of the frame.

strata = MyFrame:GetFrameStrata();

none

strata: FrameStrata - The strata name. Note: value "PARENT" will not be returned, instead it will be substituted with inherited strata level. Also, be aware of the special case return "UNKNOWN" returned for the WorldFrame object.

@@ Line 1: / Line 1: @@
 {{widgetmethod}}
-<center>'''GetFrameStrata''' ''-Documentation by [[user:Ruinna|Ruinna]]-''</center>
+Returns the ''[[FrameStrata|strata]]'' of the frame.
-== Synopsis ==
+ strata = MyFrame:GetFrameStrata();
-string frameStrata = Frame:GetFrameStrata();
+== Arguments ==
+: ''none''
-== Description ==
+== Returns ==
+:;strata : [[UITYPE FrameStrata|FrameStrata]] - The strata name. Note: value "PARENT" will not be returned, instead it will be substituted with inherited strata level.  Also, be aware of the special case return "UNKNOWN" returned for the WorldFrame object.
-Returns the ''frame strata'' of the frame. For more information see [[FrameStrata]].
-== Return values ==
-:;frameStrata : String - The strata name (e.g. "BACKGROUND"), or "UNKNOWN" if the frame's strata is not known. See [[FrameStrata]] for a list of valid strata names.