WoW:API JoinChannelByName: Difference between revisions
Jump to navigation
Jump to search
(added information about Parameter "name") |
m (add return values) |
||
| Line 17: | Line 17: | ||
== Example == | == Example == | ||
<!-- begin code --> | <!-- begin code --> | ||
JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1); | local channel_type, channel_name = JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1); | ||
<!-- end code --> | <!-- end code --> | ||
Revision as of 20:21, 1 June 2009
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 (Ohklus: seems to be nil for most channels).
Example
local channel_type, channel_name = JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1);