GetChannelDisplayInfo
functionimplementedavailable in: camelot
Returns info for chat channels and headers in the Chat Pane.
The client has this function, but Blizzard's documentation leaves it out, so its parameters and results aren't known.
Parameters
| name | type | description |
|---|---|---|
index | number | an integer between 1 and GetNumDisplayChannels() (ChannelFrame can display a combined maximum of 20 channels and headers; see MAX_CHANNEL_BUTTONS and use API GetNumDisplayChannels) |
Returns
| # | name | type | description |
|---|---|---|---|
| 1 | name | string | (*for channels*) channel name; (*for headers*) name of the header |
| 2 | header | boolean | true if this item is a header (e.g. for category "CHANNEL_CATEGORY_WORLD") |
| 3 | collapsed | boolean? | (*for headers*) true if subchannels are hidden (header is collapsed), otherwise false or nil |
| 4 | channelNumber | number? | (*for channels*) channel number, nil otherwise |
| 5 | count | number? | (*for channels*) number of players in this channel; (*for headers*) number of subchannels beneath this header, nil otherwise |
| 6 | active | boolean? | (*for channels*) true if channel is active (if you leave a city where you were in Trade Channel the channel will remain as inactive), nil otherwise |
| 7 | category | string | (*for channels*) "CHANNEL_CATEGORY_WORLD", "CHANNEL_CATEGORY_GROUP" or "CHANNEL_CATEGORY_CUSTOM" |
| 8 | channelType | number |
In wowlua's emulated client
implementedwowlua models the system behind it. what the statuses mean
sources
Description: warcraft.wiki.gg's API pages ↗, by its contributors, CC BY-SA 4.0 ↗.