WoW:API GetChatWindowInfo: Difference between revisions

Revision as of 04:52, 1 April 2005

GetChatWindowInfo - Documentation by Elbereth

Retrieves information about a chat window.

name, fontSize, r, g, b, alpha, shown, locked, docked = GetChatWindowInfo(frameId)

Parameters

Arguments

(frameId)

frameId: - The id of the chat window to get information from (starts at 1).

Returns

name, fontSize, r, g, b, alpha, shown, locked, docked

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 color (0.0 - 1.0);
g: Number - The green component of the window's color (0.0 - 1.0);
b: Number - The blue component of the window's color (0.0 - 1.0);
alpha: Number - The alpha level (opacity) of the window (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 if the window is docked, 0 if it roams freely.

Example

local name, fontSize, r, g, b, alpha, shown, locked = GetChatWindowInfo(i);

Details

Retrieves Chat Window information. 'frameId' can be any chat window id between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.

Template:WoW API

@@ Line 1: / Line 1: @@
- <center>'''GetChatWindowInfo''' ''-Documentation by Elbereth-''</center>
+<center>'''GetChatWindowInfo''' - ''Documentation by Elbereth''</center>
 Retrieves information about a chat window.
-  GetChatWindowInfo(index);
+  name, fontSize, r, g, b, alpha, shown, locked, docked = GetChatWindowInfo(frameId)
+== Parameters ==
+=== Arguments ===
+:(frameId)
-----
+:;frameId :  - The id of the chat window to get information from (starts at 1).
-;''Arguments''
+=== Returns ===
+:name, fontSize, r, g, b, alpha, shown, locked, docked
-:(Number index)
-:;index: The id of the chat window to get information from.
-----
-;''Returns''
-:;name, fontSize, r, g, b, alpha, shown, locked
-----
+:;name : String - The name of the chat window, or an empty string for its default name.
-;''Example''
+:;fontSize : Number - The font size for the window.
+:;r : Number - The red component of the window's color (0.0 - 1.0);
+:;g : Number - The green component of the window's color (0.0 - 1.0);
+:;b : Number - The blue component of the window's color (0.0 - 1.0);
+:;alpha : Number - The alpha level (opacity) of the window (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 if the window is docked, 0 if it roams freely.
+== Example ==
+<!-- begin code -->
   local name, fontSize, r, g, b, alpha, shown, locked = GetChatWindowInfo(i);
-----
+<!-- end code -->
-;''Description''
-: Retrieves Chat Window information. 'index' can be any chat window id between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.
+== Details ==
+: Retrieves Chat Window information. 'frameId' can be any chat window id between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.
 ----
+__NOTOC__
 {{Template:WoW API}}
+[[Category:API Chat Functions|GetChatWindowInfo]]

Navigation menu

Search