WoW:API GetChatWindowInfo - Revision history

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

2023-08-15T04:45:48Z

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

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>Fyrye at 04:27, 13 November 2009

2009-11-13T04:27:51Z

← Older revision		Revision as of 04:27, 13 November 2009
Line 3:		Line 3:
	Retrieves configuration information about a chat window.		Retrieves configuration information about a chat window.

	name, fontSize, r, g, b, alpha, shown, locked, docked = GetChatWindowInfo(frameIndex)		name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(frameIndex);
	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
Line 10:		Line 10:
	:;frameIndex : Number - The index of the chat window to get information for (starts at 1).		:;frameIndex : Number - The index of the chat window to get information for (starts at 1).
	=== Returns ===		=== Returns ===
	:name, fontSize, r, g, b, alpha, shown, locked, docked		:name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable

	:;name : String - The name of the chat window, or an empty string for its default name.		:;name : String - The name of the chat window, or an empty string for its default name.
Line 20:		Line 20:
	:;shown : Number - 1 if the window is shown, 0 if it is hidden.		:;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.		:;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~~.		:;docked : Number - 1 to NUM_CHAT_WINDOWS; Index Order of docked tab EG: General = 1, Combat Log = 2. nil if floating.
	== Example ==		== Example ==
	<!-- begin code -->		<!-- begin code -->
	local name, fontSize, r, g, b, alpha, shown, locked = GetChatWindowInfo(i);		local name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(i);
	<!-- end code -->		<!-- end code -->

WoWWiki>Jbcc: replaced the {{WoW API}} template

2006-06-22T18:30:18Z

replaced the {{WoW API}} template

← Older revision		Revision as of 18:30, 22 June 2006
Line 1:		Line 1:
	~~<center>'''GetChatWindowInfo''' - ''Documentation by Elbereth''</center>~~		{{wowapi}} __NOTOC__

	Retrieves configuration information about a chat window.		Retrieves configuration information about a chat window.
Line 29:		Line 29:
	* 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.		* 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.		* 'frameIndex' can be any chat window index between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.



	~~----~~
	~~{{WoW API}}~~

WoWWiki>Mikk at 15:28, 15 May 2006

2006-05-15T15:28:45Z

← Older revision		Revision as of 15:28, 15 May 2006
Line 1:		Line 1:
	<center>'''GetChatWindowInfo''' - ''Documentation by Elbereth''</center>		<center>'''GetChatWindowInfo''' - ''Documentation by Elbereth''</center>

	Retrieves information about a chat window.		Retrieves configuration information about a chat window.

	name, fontSize, r, g, b, alpha, shown, locked, docked = GetChatWindowInfo(~~frameId~~)		name, fontSize, r, g, b, alpha, shown, locked, docked = GetChatWindowInfo(frameIndex)
	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:(~~frameId~~)		:(frameIndex)

	:;~~frameId~~ : - The id of the chat window to get information ~~from~~ (starts at 1).		:;frameIndex : Number - The index of the chat window to get information for (starts at 1).
	=== Returns ===		=== Returns ===
	:name, fontSize, r, g, b, alpha, shown, locked, docked		:name, fontSize, r, g, b, alpha, shown, locked, docked
Line 14:		Line 14:
	:;name : String - The name of the chat window, or an empty string for its default name.		:;name : String - The name of the chat window, or an empty string for its default name.
	:;fontSize : Number - The font size for the window.		:;fontSize : Number - The font size for the window.
	:;r : Number - The red component of the window's color (0.0 - 1.0);		:;r : Number - The red component of the window's background color (0.0 - 1.0);
	:;g : Number - The green component of the window's 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 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 (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.		:;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.		:;locked : Number - 1 if the window is locked in place, 0 if it is movable.
Line 27:		Line 27:

	== Details ==		== Details ==
	: Retrieves Chat Window information. '~~frameId~~' can be any chat window id between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.		* 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.



	----		----
	{{WoW API}}		{{WoW API}}

WoWWiki>Muert at 04:54, 4 January 2006

2006-01-04T04:54:42Z

← Older revision		Revision as of 04:54, 4 January 2006
Line 28:		Line 28:
	== Details ==		== Details ==
	: Retrieves Chat Window information. 'frameId' can be any chat window id between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.		: Retrieves Chat Window information. 'frameId' can be any chat window id between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.


	----		----
	~~__NOTOC__~~		{{WoW API}}
	{{~~Template:~~WoW API}}
	~~[[Category:API Functions\|GetChatWindowInfo]]~~
	~~[[Category:API Chat Functions\|GetChatWindowInfo]]~~

WoWWiki>Inglais at 19:01, 27 August 2005

2005-08-27T19:01:55Z

← Older revision		Revision as of 19:01, 27 August 2005
Line 32:		Line 32:
	__NOTOC__		__NOTOC__
	{{Template:WoW API}}		{{Template:WoW API}}
			[[Category:API Functions\|GetChatWindowInfo]]
	[[Category:API Chat Functions\|GetChatWindowInfo]]		[[Category:API Chat Functions\|GetChatWindowInfo]]

WoWWiki>Flickering: /* Details */

2005-04-01T04:52:09Z

Details

← Older revision		Revision as of 04:52, 1 April 2005
Line 1:		Line 1:
	<center>'''GetChatWindowInfo''' ''-Documentation by Elbereth-''</center>		<center>'''GetChatWindowInfo''' - ''Documentation by Elbereth''</center>

	Retrieves information about a chat window.		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);		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}}		{{Template:WoW API}}
			[[Category:API Chat Functions\|GetChatWindowInfo]]

WoWWiki>WoWWiki-Elbereth at 20:02, 15 February 2005

2005-02-15T20:02:32Z

New page

<center>'''GetChatWindowInfo''' ''-Documentation by Elbereth-''</center>

Retrieves information about a chat window.

GetChatWindowInfo(index);

----
;''Arguments''

:(Number index)

:;index: The id of the chat window to get information from.

----
;''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}}