WoW:API JoinChannelByName

From AddOn Studio
Jump to navigation Jump to search
JoinChannelByName - Documentation by AlexanderYoshi

Joins the channel with the specified name.

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

Parameters

Arguments

("channelName" [,"password" [,frameID]])
channelName
String - The name of the channel to join
You can't use the "-" character in channelName (patch 1.9)
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.

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.

Example

JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID());

Details

Joins the channel with the specified name if there are less than 10 live channels.



Template:WoW API