WoW API: GetChatWindowChannels

From AddOn Studio
Jump to navigation Jump to search
Reference 

WoW API < GetChatWindowChannels

Get the channels received by a chat window.

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

Parameters[edit]

Arguments[edit]

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

Returns[edit]

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[edit]

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