C_ChatInfo.RegisterAddonMessagePrefix

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Blizzard Docs  Townlong Yak  Offline /api  GitHub Search
Info
Added in 8.0.1 / 1.13.2

Registers an addon message prefix to receive messages for that prefix.

result = C_ChatInfo.RegisterAddonMessagePrefix(prefix)

Arguments

prefix

string - The message prefix to register for delivery, at most 16 characters.

Returns

result

Enum.RegisterAddonMessagePrefixResult - Result code indicating if the prefix was registered successfully.

Details

• Registering prefixes does not persist after doing a /reload.
• It's recommended to use the addon name as a prefix (provided it fits within the 16 byte limit) since it's more likely to be unique and other addon authors will have an easier time instead of figuring out what addon a certain abbreviation belongs to. See the Globe wut page for a list of addons that use this API to avoid collisions.

Patch changes

Retail

Patch 10.2.7 (2024-05-07): Now returns a result code, rather than a boolean.
Patch 8.0.1 (2018-07-17): Moved to C_ChatInfo.RegisterAddonMessagePrefix()
Patch 4.1.0 (2011-04-26): Added as RegisterAddonMessagePrefix()

Classic

Patch 4.4.0 (2024-04-30): Now returns a result code, rather than a boolean.

See also

• C_ChatInfo.GetRegisteredAddonMessagePrefixes()
• C_ChatInfo.IsAddonMessagePrefixRegistered()
• C_ChatInfo.SendAddonMessage()