Wowpedia
Advertisement
Game Flavors
Links
Patch
Added in 8.0.1 / 1.13.2

Registers an addon message prefix, allowing messages sent over addon channels with that prefix to be received by the client.

successfulRequest = C_ChatInfo.RegisterAddonMessagePrefix(prefix)

Arguments

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

Returns

successfulRequest 
boolean - true if registration succeeded, false if too many prefixes have been registered (>512). Caveat: This does not return false if the prefix length is too big (>16).

Details

  • Registering prefixes does not persist after doing a /reload
  • See the Globe wut page for a list of addons that use this API to avoid collisions. It's otherwise a good practice 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 having to figure the name of an abbreviation.

Patch changes

  • Battle for Azeroth Patch 8.0.1 / API (2018-07-17): Moved to C_ChatInfo.RegisterAddonMessagePrefix()
  • Cataclysm Patch 4.1.0 / API (2011-04-26): Added as RegisterAddonMessagePrefix()

See also

Advertisement