Skip to content
everloot

Lore archive · Warcraft Wiki, 2023 dump

API GetChannelDisplayInfo

Last wiki revision 2022-07-21

Returns info for chat channels and headers in the Chat Pane. name, header, collapsed, channelNumber, count, active, category, voiceEnabled, voiceActive = GetChannelDisplayInfo(i)

  • id:item id, 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)
  • name: (for channels) channel name (for headers) name of the header
  • header:true if this item is a header (e.g. for category "CHANNEL_CATEGORY_WORLD")
  • collapsed: (for headers) true if subchannels are hidden (header is collapsed)
  • channelNumber: (for channels) channel number
  • count: (for channels) number of players in this channel (for headers) number of subchannels beneath this header
  • active: (for channels) true if channel is active (if you leave a city where you were in Trade Channel the channel will remain as inactive)
  • category: (for channels) "CHANNEL_CATEGORY_WORLD", "CHANNEL_CATEGORY_GROUP" or "CHANNEL_CATEGORY_CUSTOM"
  • voiceEnabled:true if voice is enabled for this channel
  • voiceActive:true if voice is currently active (someone is speaking)
  • Note

I didn't test this function in detail. But it looks very powerful and could help keeping an eye on joined channels. Just look into ChannelFrame.lua for more information.

  • GetNumDisplayChannels
  • GetChannelList
  • SendChatMessage

Source

https://warcraft.wiki.gg/wiki/API_GetChannelDisplayInfo · retrieved 2023-11-13 · CC BY-SA 4.0

Converted from wikitext with templates, tables and images removed, so some sentences may be missing values.

This archive predates WoW: Forever. For collected gameplay facts see the Forever database. Search the archive.