WoW:API Region IsVisible: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API Region IsVisible to API Region IsVisible without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<center>'''IsVisible''' ''-Documentation by [[Kisk]]-''</center>
{{widgetmethod}}


Gets the visible state of an object.
Return whether or not an object would actually be visible on-screen, ignoring the possibility that the object could be dragged off the edge of the screen.


  obj:IsVisible();
  visible = MyObject:IsVisible();


----
== Returns ==
;''Arguments''


:;nil
:;visible: [[boolean]] - true if the object is visible


----
== Example ==
;''Returns''


: Boolean
  if MyFrame:IsVisible() then
 
  MyAddon_UpdateSomeText(MyFrame)
----
;''Example''
  if (MyFrame:IsVisible()) then
    -- Frame is visible
elseif (not MyFrame:IsVisible()) then
    -- Frame is not visible
  end
  end


;''Result''
== Details ==
: The if function fires the corresponding statements based on the boolean value returned by MyFrame:IsVisible()
Gets the visible state of an object, meaning if it's shown and all it's parents are shown aswell.


----
If {{api|Region:Hide|t=w}}() is called on a frame, then all of it's children are hidden also. In this case, its children are shown if they were prior to the Hide() call, but not visible.
;''Description''


: Gets the visible state of an object, meaning if it's shown and all it's parents are shown aswell.
[[FrameXML]] uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is false while shown is true)


:If a frame calls Hide(), then all of it's children are hidden. In this case, its children are "shown" (if they were prior to the Hide() call), but not "visible".
== See also ==
:The default UI uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is false while shown is true)
* {{api|Region:IsShown|t=w}}
----
{{Template:WoW API}}

Latest revision as of 04:47, 15 August 2023

Widget API ← Region < IsVisible

Return whether or not an object would actually be visible on-screen, ignoring the possibility that the object could be dragged off the edge of the screen.

visible = MyObject:IsVisible();

Returns[edit]

visible
boolean - true if the object is visible

Example[edit]

if MyFrame:IsVisible() then
  MyAddon_UpdateSomeText(MyFrame)
end

Details[edit]

Gets the visible state of an object, meaning if it's shown and all it's parents are shown aswell.

If Region:Hide() is called on a frame, then all of it's children are hidden also. In this case, its children are shown if they were prior to the Hide() call, but not visible.

FrameXML uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is false while shown is true)

See also[edit]