m
Move page script moved page API GetChatWindowInfo to WoW:API GetChatWindowInfo without leaving a redirect
m (replaced the {{WoW API}} template) |
m (Move page script moved page API GetChatWindowInfo to WoW:API GetChatWindowInfo without leaving a redirect) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
Retrieves configuration information about a chat window. | Retrieves configuration information about a chat window. | ||
name, fontSize, r, g, b, alpha, shown, locked, docked = GetChatWindowInfo(frameIndex) | name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(frameIndex); | ||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
| Line 10: | Line 10: | ||
:;frameIndex : Number - The index of the chat window to get information for (starts at 1). | :;frameIndex : Number - The index of the chat window to get information for (starts at 1). | ||
=== Returns === | === Returns === | ||
:name, fontSize, r, g, b, alpha, shown, locked, docked | :name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable | ||
:;name : String - The name of the chat window, or an empty string for its default name. | :;name : String - The name of the chat window, or an empty string for its default name. | ||
| Line 20: | Line 20: | ||
:;shown : Number - 1 if the window is shown, 0 if it is hidden. | :;shown : Number - 1 if the window is shown, 0 if it is hidden. | ||
:;locked : Number - 1 if the window is locked in place, 0 if it is movable. | :;locked : Number - 1 if the window is locked in place, 0 if it is movable. | ||
:;docked : Number - 1 | :;docked : Number - 1 to NUM_CHAT_WINDOWS; Index Order of docked tab EG: General = 1, Combat Log = 2. nil if floating. | ||
== Example == | == Example == | ||
<!-- begin code --> | <!-- begin code --> | ||
local name, fontSize, r, g, b, alpha, shown, locked = GetChatWindowInfo(i); | local name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(i); | ||
<!-- end code --> | <!-- end code --> | ||