WoW:API JoinChannelByName: Difference between revisions

Latest revision as of 04:46, 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 < JoinChannelByName

Joins the channel with the specified name. A player can be in a maximum of 10 chat channels.

type, name = JoinChannelByName("channelName" [,"password" [,frameID[, hasVoice]]])

Parameters

Arguments

channelName: String - The name of the channel to join

password: String (optional) - The channel password, nil if none.
frameID: Number (optional) - The chat frame ID number to add the channel to. Use Frame:GetID() to retrieve it for chat frame objects.
hasVoice: Boolean (1/nil) - Enable voice chat for this channel.

Returns

type: Number - The type of channel. 0 for a undefined channel, 1 for the zone General channel, etc
name: String - The name of the channel (Ohklus: seems to be nil for most channels).

Example

local channel_type, channel_name = JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1);

@@ Line 1: / Line 1: @@
- <center>'''JoinChannelByName''' ''-Documentation by AlexanderYoshi-''</center>
+{{wowapi}}
+Joins the channel with the specified name. A player can be in a maximum of 10 chat channels.
-Joins the channel with the specified name.
+ type, name = JoinChannelByName("channelName" [,"password" [,frameID[, hasVoice]]])
+== Parameters ==
+=== Arguments ===
+:;channelName : String - The name of the channel to join
+:;: You can't use the "-" character in channelName (patch 1.9)
+:;password : String <small>''(optional)''</small> - The channel password, nil if none.
+:;frameID : Number <small>''(optional)''</small> - The chat frame ID number to add the channel to. Use [[API Frame GetID|Frame:GetID()]] to retrieve it for chat frame objects.
+:;hasVoice : Boolean (1/nil) - Enable voice chat for this channel.
-  JoinChannelByName(channelName, password, frameID);
+=== Returns ===
+:;type : Number - The type of channel. 0 for a undefined channel, 1 for the zone General channel,  etc
+:;name : String - The name of the channel (Ohklus: seems to be nil for most channels).
-----
+== Example ==
-;''Arguments''
+<!-- begin code -->
+  local channel_type, channel_name = JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1);
-:(String channelName, String password, String frameID)
+<!-- end code -->
-:;channelName : The name of the channel to leave
-:;password : The channel password (optional)
-:;frameID : Some ID number
-----
-;''Returns''
-:;nil
-----
-;''Example''
-  JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID());
-;''Result''
-----
-;''Description''
-: Joins the channel with the specified name if there are less than 10 live channels.
-----
-{{Template:WoW API}}