WoW:API JoinChannelByName: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{wowapi}} | {{wowapi}} | ||
Joins the channel with the specified name. | Joins the channel with the specified name. A player can be in a maximum of 10 chat channels. | ||
type, name = JoinChannelByName("channelName" [,"password" [,frameID]]) | type, name = JoinChannelByName("channelName" [,"password" [,frameID[, hasVoice]]]) | ||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
:;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) | :;: You can't use the "-" character in channelName (patch 1.9) | ||
:;password : String <small>''(optional)''</small> - The channel password, nil if none. | :;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. | :;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. | |||
=== Returns === | === Returns === | ||
| Line 18: | Line 17: | ||
== Example == | == Example == | ||
<!-- begin code --> | <!-- begin code --> | ||
JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID()); | JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1); | ||
<!-- end code --> | <!-- end code --> | ||
Revision as of 15:12, 15 December 2008
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
- 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.
- 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.
Example
JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1);