WoW:API GetChatWindowChannels: Difference between revisions

mNo edit summary
 
m (Move page script moved page API GetChatWindowChannels to API GetChatWindowChannels without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<center>'''GetChatWindowChannels''' - ''Documentation by [[User:Flickering|Flickering]]''</center>
{{wowapi}}


Get the channels received by a chat window.
Get the channels received by a chat window.
Line 23: Line 23:
----
----
__NOTOC__
__NOTOC__
{{Template:WoW API}}
[[Category:API Chat Functions|GetChatWindowChannels]]

Latest revision as of 04:45, 15 August 2023

WoW API < GetChatWindowChannels

Get the channels received by a chat window.

name1, zone1, name2, zone2, ... = GetChatWindowChannels(frameId)

Parameters

Arguments

(frameId)
frameId
Number - The frame number of the chat frame to be queried (starts at 1).

Returns

name1, zone1, name2, zone2, ...
name1
String - The name to display for the first channel.
zone1
Number - The 'zone channel' number for the first channel. Has a value of 0 for non-zone channels, and a non-zero value for zone channels (such as Trade, General)
name2
String - The name to display for the second channel.
zone2
Number - The 'zone channel' number for the second channel. Has a value of 0 for non-zone channels, and a non-zero value for zone channels (such as Trade, General)

Example

This function is best called within a table constructor:
local DefaultChannels = { GetChatWindowChannels(DEFAULT_CHAT_FRAME:GetID()) };