WoW:API ChatFrame AddChannel: Difference between revisions

Latest revision as of 04:45, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < ChatFrame:AddChannel

This 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[edit]

Arguments[edit]

(chatFrame, 'channelName')

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

Returns[edit]

nil

Example[edit]

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

chatFrame[edit]

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.

@@ Line 1: / Line 1: @@
-This method is activating a previously join chatchannel.
+{{framexmlfunc|FrameXML/ChatFrame.lua}}
+ ChatFrame_AddChannel(chatFrame, 'channelName')
+Order a chat frame to display a previously-joined chat channel.
-<!-- begin code -->
- ChatFrame_AddChannel(chatFrame, 'channelName');
-<!-- end code -->
 == Parameters ==
@@ Line 9: / Line 10: @@
 :(chatFrame, 'channelName')
-:;chatFrame : The name of the chat frame
+:;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 ===
-:retCode
+:nil
-:;retCode : Number - ?
+== Example ==
-== Example ==
+ ChatFrame_AddChannel(DEFAULT_CHAT_FRAME, "test");
-<!-- begin code -->
+ ChatFrame_AddChannel(SELECTED_CHAT_FRAME, "ErrorInfo");
- ChatFrame_AddChannel(DEFAULT_CHAT_FRAME,'test');
+ ChatFrame_AddChannel(ChatFrame1, "AnotherChannel");
-<!-- end code -->
+====chatFrame====
+<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>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 />

Navigation menu

Search