WoW:API GetChatWindowInfo: Difference between revisions

← Older edit

WoW:API GetChatWindowInfo (source)

Revision as of 04:45, 15 August 2023

1,140 bytes added , 15 August 2023

m

Move page script moved page API GetChatWindowInfo to WoW:API GetChatWindowInfo without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
- <center>'''GetChatWindowInfo''' ''-Documentation by Elbereth-''</center>
+{{wowapi}} __NOTOC__
-Retrieves information about a chat window.
+Retrieves configuration information about a chat window.
-  GetChatWindowInfo(index);
+  name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(frameIndex);
+== Parameters ==
+=== Arguments ===
+:(frameIndex)
-----
+:;frameIndex : Number - The index of the chat window to get information for (starts at 1).
-;''Arguments''
+=== Returns ===
+:name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable
-:(Number index)
+:;name : String - The name of the chat window, or an empty string for its default name.
+:;fontSize : Number - The font size for the window.
+:;r : Number - The red component of the window's background color (0.0 - 1.0);
+:;g : Number - The green component of the window's background color (0.0 - 1.0);
+:;b : Number - The blue component of the window's background color (0.0 - 1.0);
+:;alpha : Number - The alpha level (opacity) of the window background (0.0 - 1.0);
+:;shown : Number - 1 if the window is shown, 0 if it is hidden.
+:;locked : Number - 1 if the window is locked in place, 0 if it is movable.
+:;docked : Number - 1 to NUM_CHAT_WINDOWS; Index Order of docked tab EG: General = 1, Combat Log = 2. nil if floating.
+== Example ==
+<!-- begin code -->
+ local name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(i);
+<!-- end code -->
-:;index: The id of the chat window to get information from.
+== Details ==
+* Retrieves Chat Window configuration information. This is what FrameXML uses to know how to display the actual windows. This configuration information is set via the SetChatWindow...() family of functions which causes the "UPDATE_CHAT_WINDOWS" event to fire. FrameXML calls GetChatWindowInfo() when it receives this event.
-----
+* 'frameIndex' can be any chat window index between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.
-;''Returns''
-:;name, fontSize, r, g, b, alpha, shown, locked
-----
-;''Example''
- local name, fontSize, r, g, b, alpha, shown, locked = GetChatWindowInfo(i);
-----
-;''Description''
-: Retrieves Chat Window information. 'index' can be any chat window id between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.
-----
-{{Template:WoW API}}