Move page script: Move page script moved page API SendChatMessage to WoW:API SendChatMessage without leaving a redirect

2023-08-15T04:47:15Z

Move page script moved page API SendChatMessage to API SendChatMessage without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

Authors on WoWWiki: This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

2019-11-30T14:06:51Z

This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

← Older revision	Revision as of 14:06, 30 November 2019
Line 1:	Line 1:
		{{wowapi}}__NOTOC__
		Sends a chat message.

		/script SendChatMessage("msg" ,"chatType" ,"language" ,"channel");

		== Parameters ==
		=== Arguments===

		:(msg, chatType, language, channel)

		:;msg
		:: String, The message to be sent, maximum length of 255 characters. (Not all characters in this string are allowed: See list of [[ValidChatMessageCharacters\|valid chat message characters]])

		:;chatType
		:: String - (Optional) The type of chat message to be sent, "SAY", "PARTY", etc. See the list of [[chatTypeId]]s.
		::If chatType is '''nil''' or omitted then "SAY" will be used.

		:
		:
		:;language
		:: String - (Optional) The language used to translate the message.
		:::'''Languages''': "COMMON", "DARNASSIAN", "DWARVEN", "DRAENEI", "TAURAHE", "ORCISH", "GUTTERSPEAK", "DEMONIC", "DRACONIC", "KALIMAG", "TITAN", "GNOMISH", "TROLL"
		::If language is '''nil''' or omitted the default language will be used: "ORCISH" for the Horde, and "COMMON" for the Alliance, as returned by [[API_GetDefaultLanguage\|GetDefaultLanguage]]("player").
		:: Instead of the name string, it is also valid to use the languageID to specify the language to speak in. This will use the language selected by the user:
		::: SendChatMessage("ExampleText", "SAY", DEFAULT_CHAT_FRAME.editBox.languageID);

		:;channel
		:: String - The channel or player receiving the message for "CHANNEL"/"WHISPER" communication. If sending to a channel you must use the number (eg. "1"); obtain it using [[API_GetChannelName\|GetChannelName]]("channelName"). This field is required for the "CHANNEL"/"WHISPER" chat types and ignored for any other chat type.

		=== Returns ===
		:;nil

		== Example ==
		/script SendChatMessage("Hello Bob!", "WHISPER", "Common", "Bob");

		=== Result ===
		:To [Bob]: Hello Bob!

		== Example ==
		local s = "Hello World"
		local index = GetChannelName("General") -- It finds General is a channel at index 1
		if (index~=nil) then
		SendChatMessage(s , "CHANNEL", nil, index);
		end

		=== Result ===
		:[1. General - ''Current Zone Name''][Bob]: Hello World

		=== Example ===
		/run msg = "Buy my gems"
		/run SendChatMessage(msg, "WHISPER", nil, GetUnitName("PLAYERTARGET"))

		=== Result ===
		:Whispers current target "Buy my gems"

		== Details ==

		: Sends a chat message of the specified in 'msg' (ex. "Hey!"), to the system specified in 'chatType' ("SAY", "WHISPER", "EMOTE", "CHANNEL", "PARTY", "BATTLEGROUND", "GUILD", "OFFICER", "YELL", "RAID", "RAID_WARNING", "AFK", "DND"), in the language specified in 'language' ("COMMON", "DARNASSIAN", "DWARVISH", "TAURAHE", "ORCISH", "GUTTERSPEAK", "DEMONIC", "DRACONIC", "KALIMAG", "TITAN", "GNOMISH"), to the player or channel specified in 'channel'(ex. "1", "Bob").

		;''Notes''

		*The earliest you can send a chat message to "GUILD" is after the event "CLUB_STREAM_SUBSCRIBED" is fired, as this is when the Community channel is loaded. (Guild is a Community channel)
		*"AFK" and "DND" set your AFK or DND auto-reply. To cancel afk/dnd status, send another message to the same 'channel'.

		*It should be noted that you must provide a 'language' (be it nil or an actual language name) before the 'channel' when sending to the "WHISPER" or "CHANNEL" system.

		*To send a whisper to the player's selected target, use [[API_UnitName\|UnitName]]("target") as the Channel.

		*[[Patch 1.11.0]] added the "RAID_WARNING" system, only usable by the raid leader and raid assistants. The default UI shows messages send via "RAID_WARNING" in big letters on the center of the screen. As of a recent change in [[patch 2.0.0]] this is also available in party and usable by all party member; Please don't abuse this idea.

		*Some channels may have restrictions on who may speak in them. For example, in order to speak in the 'World Defense' channel, you must have a PvP rank of 11 or higher.

		*Patch 2.0.0 throws an error when trying to speak a language you don't know.

		*"Trying to spoof item links will disconnect you." -- directly taken from [[patch 1.10.0]] patch changes. This includes miscontructed link strings of genuine items/spells/tradeskills, such as capitalizing the hex codes for the link colors.

		*As of [[patch 2.4.0]] (or [[patch 2.3.0\|2.3]]?), you are no longer disconnected when sending over-long messages. The message is silently truncated to 255 characters.

		*patch 2.4: Sending 10+ messages at a time resulting in high RTT for the 9+ messages. (se "Discussion" page for more info)

		<!--
		: It could be a bug, but when you run this API command you can send Whispers using any language (including those from other factions). The end listener hears it in their own language, and thus understands it, however on your screen the message is in untranslated Orcish, Dwarvish or whatever you like.
		::This is not a bug, no matter what language you send a tell in, it always comes out in the end listeners default language.

		: This also works in CHANNEL, PARTY, GUILD, and RAID. But not in say or yell.
		:: You can speak in other languages, but they will not be able to read it unless they know that language, blizzard removed this from Yell and Say when people were using this to talk to eachother.
		-->

24.203.26.205: Formatted for readability

2019-11-30T14:06:50Z

Formatted for readability

← Older revision

Revision as of 14:06, 30 November 2019

WoWWiki>GuyPlasma: /* Example */

2011-02-18T06:33:42Z

Example

← Older revision

Revision as of 06:33, 18 February 2011

WoWWiki>RocketBrother: The /script part seems essential, I at least couldn't get anything working without it. Thusly added .

2009-11-14T17:31:20Z

The /script part seems essential, I at least couldn't get anything working without it. Thusly added .

← Older revision

Revision as of 17:31, 14 November 2009

WoWWiki>Xenutu at 11:22, 21 October 2009

2009-10-21T11:22:55Z

← Older revision

Revision as of 11:22, 21 October 2009

WoWWiki>Jrooksjr: Making patch links 3 numbers #.#.# not 2 #.#

2009-08-11T15:30:18Z

Making patch links 3 numbers #.#.# not 2 #.#

← Older revision

Revision as of 15:30, 11 August 2009

WoWWiki>Crxi: /* Details */

2008-08-22T17:31:25Z

Details

← Older revision	Revision as of 17:31, 22 August 2008
(No difference)

WoWWiki>Eirik Ratcatcher: 1.10 -> Patch 1.10

2008-06-11T22:42:47Z

1.10 -> Patch 1.10

← Older revision

Revision as of 22:42, 11 June 2008

WoWWiki>NefariousN: Formatting

2007-12-29T06:52:05Z

Formatting

← Older revision	Revision as of 06:52, 29 December 2007
(No difference)

WoW:API SendChatMessage - Revision history

Move page script: Move page script moved page API SendChatMessage to WoW:API SendChatMessage without leaving a redirect

Authors on WoWWiki: This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

24.203.26.205: Formatted for readability

WoWWiki>GuyPlasma: /* Example */

WoWWiki>RocketBrother: The /script part seems essential, I at least couldn't get anything working without it. Thusly added .

WoWWiki>Xenutu at 11:22, 21 October 2009

WoWWiki>Jrooksjr: Making patch links 3 numbers #.#.# not 2 #.#

WoWWiki>Crxi: /* Details */

WoWWiki>Eirik Ratcatcher: 1.10 -> Patch 1.10

WoWWiki>NefariousN: Formatting