WoW:API JoinChannelByName: Difference between revisions
Jump to navigation
Jump to search
JoinChannelByName - Documentation by AlexanderYoshi
No edit summary |
|||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | |||
<center>'''JoinChannelByName''' - ''Documentation by AlexanderYoshi''</center> | <center>'''JoinChannelByName''' - ''Documentation by AlexanderYoshi''</center> | ||
| Line 24: | Line 26: | ||
== Details == | == Details == | ||
: Joins the channel with the specified name if there are less than 10 live channels. | : Joins the channel with the specified name if there are less than 10 live channels. | ||
Revision as of 00:58, 4 November 2006
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.