WoW:API JoinChannelByName: Difference between revisions
Jump to navigation
Jump to search
JoinChannelByName - Documentation by AlexanderYoshi
No edit summary |
|||
| Line 9: | Line 9: | ||
:;channelName : String - The name of the channel to join | :;channelName : String - The name of the channel to join | ||
:;: You can't use the "-" character in channelName (patch 1.9) | |||
:;password : String <small><i>(optional)</i></small> - The channel password, nil if none. | :;password : String <small><i>(optional)</i></small> - The channel password, nil if none. | ||
:;frameID : Number <small><i>(optional)</i></small> - The chat frame ID number to add the channel to. Use [[API Frame GetID|Frame:GetID()]] to retrieve it for chat frame objects. | :;frameID : Number <small><i>(optional)</i></small> - The chat frame ID number to add the channel to. Use [[API Frame GetID|Frame:GetID()]] to retrieve it for chat frame objects. | ||
Revision as of 08:01, 9 January 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.