WoW:API ChatFrame AddChannel: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (catfix, Replaced: {{framexml → <br>{{framexml)
mNo edit summary
Line 1: Line 1:
<br>{{framexmlfunc|FrameXML/ChatFrame.lua}} __NOTOC__
{{framexmlfunc|FrameXML/ChatFrame.lua}}


  ChatFrame_AddChannel(chatFrame, 'channelName');
  ChatFrame_AddChannel(chatFrame, 'channelName')


Order a chat frame to display a previously-joined chat channel
Order a chat frame to display a previously-joined chat channel




Line 10: Line 10:
:(chatFrame, 'channelName')
:(chatFrame, 'channelName')


:;chatFrame : Object - The chat frame to display the channel in. Some ex
:;chatFrame
:;channelName : String - The name of the chatchannel to activate.
:: Object - The chat frame to display the channel in. Some ex
:;channelName
:: String - The name of the chatchannel to activate.


=== Returns ===
=== Returns ===
Line 23: Line 25:


====chatFrame====
====chatFrame====
<code>DEFAULT_CHAT_FRAME</code> - Adds the channel to the default chat window.<BR>
<code>DEFAULT_CHAT_FRAME</code> - Adds the channel to the default chat window.<br />
<code>SELECTED_CHAT_FRAME</code> - Adds the channel in the chat window with focus ( the front window ).<BR>
<code>SELECTED_CHAT_FRAME</code> - Adds the channel in the chat window with focus ( the front window ).<br />
<code>ChatFrameX</code> - Where X is an int from 1 to 10. Seems to add the channel to any chat window, where X=1 is the left-most window.<BR>
<code>ChatFrameX</code> - Where X is an int from 1 to 10. Seems to add the channel to any chat window, where X=1 is the left-most window.<br />

Revision as of 16:57, 22 September 2013

WoW API < ChatFrame:AddChannel

"I" iconThis function is implemented in Lua here FrameXML/ChatFrame.lua.
ChatFrame_AddChannel(chatFrame, 'channelName')

Order a chat frame to display a previously-joined chat channel. 


Parameters

Arguments

(chatFrame, 'channelName')
chatFrame
Object - The chat frame to display the channel in. Some ex
channelName
String - The name of the chatchannel to activate.

Returns

nil

Example

ChatFrame_AddChannel(DEFAULT_CHAT_FRAME, "test");
ChatFrame_AddChannel(SELECTED_CHAT_FRAME, "ErrorInfo");
ChatFrame_AddChannel(ChatFrame1, "AnotherChannel");

chatFrame

DEFAULT_CHAT_FRAME - Adds the channel to the default chat window.
SELECTED_CHAT_FRAME - Adds the channel in the chat window with focus ( the front window ).
ChatFrameX - Where X is an int from 1 to 10. Seems to add the channel to any chat window, where X=1 is the left-most window.