mirror of
https://github.com/araxiaonline/wow-wotlk-declarations.git
synced 2026-06-13 02:42:25 -04:00
42 lines
2.2 KiB
TypeScript
42 lines
2.2 KiB
TypeScript
/** @noSelfInFile */
|
|
|
|
declare namespace WoWAPI {
|
|
type AddonMessageType = "PARTY" | "RAID" | "GUILD" | "BATTLEGROUND" | "WHISPER" | "CHANNEL";
|
|
type ChatFlag = "AFK" | "DND" | "GM";
|
|
type ChatJoinLeftType = "YOU_JOINED" | "YOU_LEFT" | "THROTTLED";
|
|
type ChatUserNoticeType = "ANNOUNCEMENTS_OFF" | "ANNOUNCEMENTS_ON" | "BANNED" |
|
|
"OWNER_CHANGED" | "INVALID_NAME" | "INVITE" | "MODERATION_OFF" | "MODERATION_ON" |
|
|
"MUTED" | "NOT_MEMBER" | "NOT_MODERATED" | "SET_MODERATOR" | "UNSET_MODERATOR";
|
|
interface C_ChatInfo {
|
|
|
|
/**
|
|
* Registers an addon message prefix, allowing messages sent over addon channels with that prefix to be received by the client
|
|
* @param prefix The message prefix to register for delivery
|
|
* @see https://wow.gamepedia.com/API_RegisterAddonMessagePrefix
|
|
*/
|
|
RegisterAddonMessagePrefix(this: C_ChatInfo, prefix: string): void;
|
|
|
|
/**
|
|
* Sends a message to the hidden addon channel
|
|
* @param prefix Message prefix, can be used as your addon identifier; at most 15 characters
|
|
* @param text Text to send, at most 250 characters
|
|
* @param type AddOn channel to send to. Valid types are "PARTY", "RAID", "GUILD", "BATTLEGROUND", "WHISPER", and "CHANNEL".
|
|
* @since 1.12.0
|
|
*/
|
|
SendAddonMessage(this: C_ChatInfo, prefix: string, text: string, type: Exclude<AddonMessageType, "WHISPER" | "CHANNEL">): void;
|
|
|
|
/**
|
|
* Sends a message to the hidden addon channel
|
|
* @param prefix Message prefix, can be used as your addon identifier; at most 15 characters
|
|
* @param text Text to send, at most 250 characters
|
|
* @param type AddOn channel to send to. Valid types are "PARTY", "RAID", "GUILD", "BATTLEGROUND", "WHISPER", and "CHANNEL".
|
|
* @param target sed only for "WHISPER" and "CHANNEL" communications - the player to whisper to for "WHISPER" or the channel name to
|
|
* broadcast to for "CHANNEL"
|
|
* @since 2.1.0
|
|
*/
|
|
SendAddonMessage(this: C_ChatInfo, prefix: string, text: string, type: "WHISPER" | "CHANNEL", target: string): void;
|
|
}
|
|
}
|
|
|
|
declare const C_ChatInfo: WoWAPI.C_ChatInfo;
|