Skip to content
everloot

Lore archive · Warcraft Wiki, 2023 dump

API GetChatWindowInfo

Last wiki revision 2022-07-22

Returns info for a chat window. name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(frameIndex)

  • (frameIndex)
  • frameIndex: - The index of the chat window to get information for (starts at 1).
  • name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable
  • name: - The name of the chat window, or an empty string for its default name.
  • fontSize: - The font size for the window.
  • r: - The red component of the window's background color (0.0 - 1.0);
  • g: - The green component of the window's background color (0.0 - 1.0);
  • b: - The blue component of the window's background color (0.0 - 1.0);
  • alpha: - The alpha level (opacity) of the window background (0.0 - 1.0);
  • shown: - 1 if the window is shown, 0 if it is hidden.
  • locked: - 1 if the window is locked in place, 0 if it is movable.
  • docked: - 1 to NUM_CHAT_WINDOWS; Index Order of docked tab EG: General = 1, Combat Log = 2. nil if floating.

local name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(i);

  • Retrieves Chat Window configuration information. This is what FrameXML uses to know how to display the actual windows. This configuration information is set via the SetChatWindow... family of functions which causes the "UPDATE_CHAT_WINDOWS" event to fire. FrameXML calls GetChatWindowInfo when it receives this event.
  • 'frameIndex' can be any chat window index between 1 and NUM_CHAT_WINDOWS. '1' is the main chat window.

Source

https://warcraft.wiki.gg/wiki/API_GetChatWindowInfo · 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.