 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Retrieves the id and the name from a specific channel.
id, name, instanceID = GetChannelName(id);
- Arguments
- id
- The numeric id of the channel you want to query, or a string containing the name of the channel.
- Returns
- id
- a number containing the id of the channel, e.g. 2, or 0 if the channel is not found
- name
- a string containing the name of the channel, e.g. "Trade - Stormwind", or nil if the channel is not found or the id parameter was a invalid (not an integer).
- instanceID
- a numeric identifier differentiating one scenario, instance, or raid from another
- Important
If the channel argument is the channel name (ie "testchan1"), then the returned channel name is a nil value. If the channel argument is the channel number (ie 6 or "6"), then the returned channel name is correct. The channel id returns correctly in both cases.
It's also worth noting the behavior of (at least) Trade channel. Login to a city, GetChannelName("Trade - City") will return the channel number it's on. Step outside the city, you'll leave the channel yet making that call again will return the channel number you *were* on. As such, it's not entirely reliable for detecting if you're in a trade enabled zone.
- Example
-- Check if the specific channel exists
myChannel = 1;
id, name = GetChannelName(myChannel);
if (id > 0 and name ~= nil) then
SendChatMessage("This is just a test.", "CHANNEL", nil, id);
end
- Result
Checks if the channel with id stored in myChannel exists and in this case sends the text "This is just a test" to it.
- Description
- Retrieves the name from a specific channel.