GetChatWindowChannels

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Wowprogramming  GitHub Search
Info
Added in 1.0.0 / 1.13.2

Returns subscribed channels for 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()) };

---