Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

X2Chat

Globals

CHAT_ALL_SERVER

integer

CHAT_BIG_MEGAPHONE

integer

CHAT_DAILY_MSG

integer

CHAT_EXPEDITION

integer

CHAT_FACTION

integer

CHAT_FAMILY

integer

CHAT_FIND_PARTY

integer

CHAT_GM_LISTEN

integer

CHAT_INVALID

integer

CHAT_LOCALE_SERVER

integer

CHAT_NOTICE

integer

CHAT_PARTY

integer

CHAT_PLAY_MUSIC

integer

CHAT_RACE

integer

CHAT_RAID

integer

CHAT_RAID_COMMAND

integer

CHAT_REPLYWHISPER

integer

CHAT_SAY

integer

CHAT_SMALL_MEGAPHONE

integer

CHAT_SQUAD

integer

CHAT_SYSTEM

integer

CHAT_TRADE

integer

CHAT_TRIAL

integer

CHAT_USER

integer

CHAT_WHISPER

integer

CHAT_WHISPERED

integer

CHAT_ZONE

integer

CIK_DEFAULT

integer

CMF_ACQ_CONSUME_GROUP

integer

CMF_ADDED_ITEM_GROUP

integer

CMF_ADDED_ITEM_SELF

integer

CMF_ADDED_ITEM_TEAM

integer

CMF_ALL_SERVER

integer

CMF_BEGIN_USE

integer

CMF_BEHAVIOR_RESULT

integer

CMF_BIG_MEGAPHONE

integer

CMF_CHANNEL_INFO

integer

CMF_COMBAT_DEAD

integer

CMF_COMBAT_DST_GROUP

integer

CMF_COMBAT_DST_OTHER

integer

CMF_COMBAT_DST_SELF

integer

CMF_COMBAT_ENVIRONMENTAL_DMANAGE

integer

CMF_COMBAT_MELEE_DAMAGE

integer

CMF_COMBAT_MELEE_GROUP

integer

CMF_COMBAT_MELEE_MISSED

integer

CMF_COMBAT_SPELL_AURA

integer

CMF_COMBAT_SPELL_CAST

integer

CMF_COMBAT_SPELL_DAMAGE

integer

CMF_COMBAT_SPELL_ENERGIZE

integer

CMF_COMBAT_SPELL_GROUP

integer

CMF_COMBAT_SPELL_HEALED

integer

CMF_COMBAT_SPELL_MISSED

integer

CMF_COMBAT_SRC_GROUP

integer

CMF_COMBAT_SRC_OTHER

integer

CMF_COMBAT_SRC_SELF

integer

CMF_COMMUNITY

integer

CMF_CONNECT_ALERT

integer

CMF_CONNECT_EXPEDITION

integer

CMF_CONNECT_FAMILY

integer

CMF_CONNECT_FRIEND

integer

CMF_DE

integer

CMF_DOMINION_AND_SIEGE_INFO

integer

CMF_EMOTIOIN_EXPRESS

integer

CMF_END_USE

integer

CMF_EN_SG

integer

CMF_EN_US

integer

CMF_ETC_GROUP

integer

CMF_EXPEDITION

integer

CMF_FACTION

integer

CMF_FAMILY

integer

CMF_FIND_PARTY

integer

CMF_FR

integer

CMF_HERO_SEASON_UPDATED

integer

CMF_IND

integer

CMF_JA

integer

CMF_KO

integer

CMF_LANG_BEGIN

integer

CMF_LANG_END

integer

CMF_LOCALE_SERVER

integer

CMF_LOOT_METHOD_CHANGED

integer

CMF_NONE

integer

CMF_NOTICE

integer

CMF_OTHER_CONTINENT

integer

CMF_PARTY

integer

CMF_PARTY_AND_RAID_INFO

integer

CMF_PLAY_MUSIC

integer

CMF_QUEST_INFO

integer

CMF_RACE

integer

CMF_RAID

integer

CMF_RAID_COMMAND

integer

CMF_RU

integer

CMF_SAY

integer

CMF_SELF_CONTRIBUTION_POINT_CHANGED

integer

CMF_SELF_HONOR_POINT_CHANGED

integer

CMF_SELF_LEADERSHIP_POINT_CHANGED

integer

CMF_SELF_LIVING_POINT_CHANGED

integer

CMF_SELF_MONEY_CHANGED

integer

CMF_SELF_SKILL_INFO

integer

CMF_SMALL_MEGAPHONE

integer

CMF_SQUAD

integer

CMF_SYSTEM

integer

CMF_TH

integer

CMF_TRADE

integer

CMF_TRADE_STORE_MSG

integer

CMF_TRIAL

integer

CMF_WHISPER

integer

CMF_ZH_CN

integer

CMF_ZH_TW

integer

CMF_ZONE

integer

CMSP_LEFT

integer

CMSP_RIGHT

integer

COLLISION_PART_BOTTOM

integer

COLLISION_PART_FRONT

integer

COLLISION_PART_REAR

integer

COLLISION_PART_SIDE

integer

COLLISION_PART_TOP

integer

LOCALE_DE

integer

LOCALE_EN_SG

integer

LOCALE_EN_US

integer

LOCALE_FR

integer

LOCALE_IND

integer

LOCALE_INVALID

integer

LOCALE_JA

integer

LOCALE_KO

integer

LOCALE_RU

integer

LOCALE_TH

integer

LOCALE_ZH_CN

integer

LOCALE_ZH_TW

integer

QMS_CHECKPOINT

integer

QMS_GIVE_MAIN

integer

QMS_GIVE_NORMAL

integer

QMS_GIVE_REPEAT

integer

QMS_GIVE_SAGA

integer

QMS_LET_IT_DONE

integer

QMS_OVER_DONE

integer

QMS_PROGRESS

integer

QMS_READY_MAIN

integer

QMS_READY_NORMAL

integer

QMS_READY_SAGA

integer

X2Chat

X2Chat

Aliases

CHANNEL_MESSAGE_FILTER

CMF_ACQ_CONSUME_GROUP|CMF_ADDED_ITEM_GROUP|CMF_ADDED_ITEM_SELF|CMF_ADDED_ITEM_TEAM|CMF_ALL_SERVER…(+60)

-- api/X2Chat
CHANNEL_MESSAGE_FILTER:
    | `CMF_ACQ_CONSUME_GROUP` -- Alert>Acquire/Use Info
    | `CMF_ADDED_ITEM_GROUP` -- Alert>Acquired Item Info
    | `CMF_ADDED_ITEM_SELF` -- Alert>Acquired Item Info>Self
    | `CMF_ADDED_ITEM_TEAM` -- Alert>Acquired Item Info>Team
    | `CMF_ALL_SERVER` -- Dialogue>EVO
    | `CMF_BEHAVIOR_RESULT` -- Only displays on All Tab.
    | `CMF_CHANNEL_INFO` -- Alert>Chat Window Info
    | `CMF_COMBAT_DEAD` -- Combat>Dead
    | `CMF_COMBAT_DST_GROUP` -- Combat>Others
    | `CMF_COMBAT_ENVIRONMENTAL_DMANAGE` -- Combat>Environmental Damage
    | `CMF_COMBAT_MELEE_DAMAGE` -- Combat>Basic Attack>Damage
    | `CMF_COMBAT_MELEE_GROUP` -- Combat>Basic Attack
    | `CMF_COMBAT_MELEE_MISSED` -- Combat>Basic Attack>Miss
    | `CMF_COMBAT_SPELL_AURA` -- Combat>Buff/Debuff Effects
    | `CMF_COMBAT_SPELL_DAMAGE` -- Combat>Skill>Damage
    | `CMF_COMBAT_SPELL_ENERGIZE` -- Combat>Skill>Mana Regen
    | `CMF_COMBAT_SPELL_GROUP` -- Combat>Skill
    | `CMF_COMBAT_SPELL_HEALED` -- Combat>Skill>Heal
    | `CMF_COMBAT_SPELL_MISSED` -- Combat>Skill>Miss
    | `CMF_COMBAT_SRC_GROUP` -- Combat>Self
    | `CMF_COMMUNITY` -- Only displays on All Tab.
    | `CMF_CONNECT_ALERT` -- Alert>Online Alert
    | `CMF_CONNECT_EXPEDITION` -- Alert>Online Alert>Guild
    | `CMF_CONNECT_FAMILY` -- Alert>Online Alert>Family
    | `CMF_CONNECT_FRIEND` -- Alert>Online Alert>Friend
    | `CMF_DE`
    | `CMF_DOMINION_AND_SIEGE_INFO` -- Alert>Territory/Siege Info
    | `CMF_EMOTIOIN_EXPRESS` -- Alert>Other>Emote
    | `CMF_END_USE` -- Only displays on All Tab.
    | `CMF_EN_SG`
    | `CMF_EN_US`
    | `CMF_ETC_GROUP` -- Alert>Other
    | `CMF_EXPEDITION` -- Dialogue>Guild
    | `CMF_FAMILY` -- Dialogue>Family
    | `CMF_FR`
    | `CMF_HERO_SEASON_UPDATED` -- Only displays on All Tab.
    | `CMF_IND`
    | `CMF_JA`
    | `CMF_KO`
    | `CMF_LANG_BEGIN`
    | `CMF_LANG_END`
    | `CMF_LOCALE_SERVER` -- Only displays on All Tab.
    | `CMF_LOOT_METHOD_CHANGED` -- Alert>Acquired Item Info>Change Loot Mode
    | `CMF_NOTICE` -- Alert>Alert
    | `CMF_OTHER_CONTINENT` -- Dialogue>Other Continent Dialect
    | `CMF_PARTY` -- Dialogue>Party
    | `CMF_PARTY_AND_RAID_INFO` -- Alert>Party/Raid Info
    | `CMF_PLAY_MUSIC` -- Only displays on All Tab.
    | `CMF_QUEST_INFO` -- Alert>Quest Info
    | `CMF_RAID` -- Dialogue>Raid
    | `CMF_RAID_COMMAND` -- Dialogue>Raid
    | `CMF_RU`
    | `CMF_SELF_CONTRIBUTION_POINT_CHANGED` -- Only displays on All Tab.
    | `CMF_SELF_HONOR_POINT_CHANGED` -- Alert>Acquire/Use Info>Honor Points
    | `CMF_SELF_LEADERSHIP_POINT_CHANGED` -- Only displays on All Tab.
    | `CMF_SELF_LIVING_POINT_CHANGED` -- Alert>Acquire/Use Info>Vocation Badges
    | `CMF_SELF_MONEY_CHANGED` -- Alert>Acquire/Use Info>Gold
    | `CMF_SELF_SKILL_INFO` -- Alert>Other>Skill Info
    | `CMF_SQUAD` -- Dialogue>Team
    | `CMF_SYSTEM` -- Alert>System
    | `CMF_TH`
    | `CMF_TRADE_STORE_MSG` -- Alert>Trade/Shop
    | `CMF_WHISPER` -- Dialogue>Whisper
    | `CMF_ZH_CN`
    | `CMF_ZH_TW`

CHANNEL_MESSAGE_FILTER_SPECIAL

CMF_BEGIN_USE|CMF_BIG_MEGAPHONE|CMF_COMBAT_DST_OTHER|CMF_COMBAT_DST_SELF|CMF_COMBAT_SPELL_CAST…(+11)

-- api/X2Chat
CHANNEL_MESSAGE_FILTER_SPECIAL:
    | `CMF_BEGIN_USE` -- Dialogue>Local
    | `CMF_BIG_MEGAPHONE` -- Only displays on All Tab.
    | `CMF_COMBAT_DST_OTHER` -- Does not work.
    | `CMF_COMBAT_DST_SELF` -- Does not work.
    | `CMF_COMBAT_SPELL_CAST` -- Does not work.
    | `CMF_COMBAT_SRC_OTHER` -- Does not work.
    | `CMF_COMBAT_SRC_SELF` -- Does not work.
    | `CMF_FACTION` -- Dialogue>Faction
    | `CMF_FIND_PARTY` -- Dialogue>Party-Up
    | `CMF_NONE` -- Does not work.
    | `CMF_RACE` -- Only displays on All Tab.
    | `CMF_SAY` -- Dialogue>Local
    | `CMF_SMALL_MEGAPHONE` -- Only displays on All Tab.
    | `CMF_TRADE` -- Dialogue>Trade
    | `CMF_TRIAL` -- Dialogue>Trial
    | `CMF_ZONE` -- Dialogue>Shout

CHAT_ICON_KIND

CIK_DEFAULT

-- api/X2Chat
CHAT_ICON_KIND:
    | `CIK_DEFAULT`

CHAT_MESSAGE_CHANNEL

CHAT_ALL_SERVER|CHAT_BIG_MEGAPHONE|CHAT_DAILY_MSG|CHAT_EXPEDITION|CHAT_FACTION…(+22)

-- api/X2Chat
CHAT_MESSAGE_CHANNEL:
    | `CHAT_ALL_SERVER`
    | `CHAT_BIG_MEGAPHONE`
    | `CHAT_DAILY_MSG`
    | `CHAT_EXPEDITION`
    | `CHAT_FACTION`
    | `CHAT_FAMILY`
    | `CHAT_FIND_PARTY`
    | `CHAT_GM_LISTEN`
    | `CHAT_INVALID`
    | `CHAT_LOCALE_SERVER`
    | `CHAT_NOTICE`
    | `CHAT_PARTY`
    | `CHAT_PLAY_MUSIC`
    | `CHAT_RACE`
    | `CHAT_RAID`
    | `CHAT_RAID_COMMAND`
    | `CHAT_REPLYWHISPER`
    | `CHAT_SAY`
    | `CHAT_SMALL_MEGAPHONE`
    | `CHAT_SQUAD`
    | `CHAT_SYSTEM`
    | `CHAT_TRADE`
    | `CHAT_TRIAL`
    | `CHAT_USER`
    | `CHAT_WHISPER`
    | `CHAT_WHISPERED`
    | `CHAT_ZONE`

CMSP

CMSP_LEFT|CMSP_RIGHT

-- api/X2Chat
-- Chat Message Scroll Position
CMSP:
    | `CMSP_LEFT`
    | `CMSP_RIGHT`

COLLISION_PART

COLLISION_PART_BOTTOM|COLLISION_PART_FRONT|COLLISION_PART_REAR|COLLISION_PART_SIDE|COLLISION_PART_TOP

-- api/X2Chat
COLLISION_PART:
    | `COLLISION_PART_BOTTOM`
    | `COLLISION_PART_FRONT`
    | `COLLISION_PART_REAR`
    | `COLLISION_PART_SIDE`
    | `COLLISION_PART_TOP`

LOCALE

LOCALE_DE|LOCALE_EN_SG|LOCALE_EN_US|LOCALE_FR|LOCALE_IND…(+7)

-- api/X2Chat
LOCALE:
    | `LOCALE_DE`
    | `LOCALE_EN_SG`
    | `LOCALE_EN_US`
    | `LOCALE_FR`
    | `LOCALE_IND`
    | `LOCALE_INVALID`
    | `LOCALE_JA`
    | `LOCALE_KO`
    | `LOCALE_RU`
    | `LOCALE_TH`
    | `LOCALE_ZH_CN`
    | `LOCALE_ZH_TW`

QUEST_MANAGEMENT_STATE

QMS_CHECKPOINT|QMS_GIVE_MAIN|QMS_GIVE_NORMAL|QMS_GIVE_REPEAT|QMS_GIVE_SAGA…(+6)

-- api/X2Chat
QUEST_MANAGEMENT_STATE:
    | `QMS_CHECKPOINT`
    | `QMS_GIVE_MAIN`
    | `QMS_GIVE_NORMAL`
    | `QMS_GIVE_REPEAT`
    | `QMS_GIVE_SAGA`
    | `QMS_LET_IT_DONE`
    | `QMS_OVER_DONE`
    | `QMS_PROGRESS`
    | `QMS_READY_MAIN`
    | `QMS_READY_NORMAL`
    | `QMS_READY_SAGA`

Classes

Class: X2Chat

Method: DispatchChatMessage

(method) X2Chat:DispatchChatMessage(filter: `CMF_ACQ_CONSUME_GROUP`|`CMF_ADDED_ITEM_GROUP`|`CMF_ADDED_ITEM_SELF`|`CMF_ADDED_ITEM_TEAM`|`CMF_ALL_SERVER`...(+76), message: string, option?: ChatMessageOption)

Sends a message to the specified chat channel.

@param filter — The chat Channel Message Filter.

@param message — The message to send.

@param option — Optional chat message settings. (Required for all CHANNEL_MESSAGE_FILTER_SPECIAL)

X2Chat:DispatchChatMessage(CMF_SYSTEM, "Hello, ArcheRage!")
X2Chat:DispatchChatMessage(CMF_SAY, "|o; Hello, ArcheRage!", { isUserChat = true })

-- api/X2Chat
-- api/X2Chat
filter:
    | `CMF_ACQ_CONSUME_GROUP` -- Alert>Acquire/Use Info
    | `CMF_ADDED_ITEM_GROUP` -- Alert>Acquired Item Info
    | `CMF_ADDED_ITEM_SELF` -- Alert>Acquired Item Info>Self
    | `CMF_ADDED_ITEM_TEAM` -- Alert>Acquired Item Info>Team
    | `CMF_ALL_SERVER` -- Dialogue>EVO
    | `CMF_BEHAVIOR_RESULT` -- Only displays on All Tab.
    | `CMF_CHANNEL_INFO` -- Alert>Chat Window Info
    | `CMF_COMBAT_DEAD` -- Combat>Dead
    | `CMF_COMBAT_DST_GROUP` -- Combat>Others
    | `CMF_COMBAT_ENVIRONMENTAL_DMANAGE` -- Combat>Environmental Damage
    | `CMF_COMBAT_MELEE_DAMAGE` -- Combat>Basic Attack>Damage
    | `CMF_COMBAT_MELEE_GROUP` -- Combat>Basic Attack
    | `CMF_COMBAT_MELEE_MISSED` -- Combat>Basic Attack>Miss
    | `CMF_COMBAT_SPELL_AURA` -- Combat>Buff/Debuff Effects
    | `CMF_COMBAT_SPELL_DAMAGE` -- Combat>Skill>Damage
    | `CMF_COMBAT_SPELL_ENERGIZE` -- Combat>Skill>Mana Regen
    | `CMF_COMBAT_SPELL_GROUP` -- Combat>Skill
    | `CMF_COMBAT_SPELL_HEALED` -- Combat>Skill>Heal
    | `CMF_COMBAT_SPELL_MISSED` -- Combat>Skill>Miss
    | `CMF_COMBAT_SRC_GROUP` -- Combat>Self
    | `CMF_COMMUNITY` -- Only displays on All Tab.
    | `CMF_CONNECT_ALERT` -- Alert>Online Alert
    | `CMF_CONNECT_EXPEDITION` -- Alert>Online Alert>Guild
    | `CMF_CONNECT_FAMILY` -- Alert>Online Alert>Family
    | `CMF_CONNECT_FRIEND` -- Alert>Online Alert>Friend
    | `CMF_DE`
    | `CMF_DOMINION_AND_SIEGE_INFO` -- Alert>Territory/Siege Info
    | `CMF_EMOTIOIN_EXPRESS` -- Alert>Other>Emote
    | `CMF_END_USE` -- Only displays on All Tab.
    | `CMF_EN_SG`
    | `CMF_EN_US`
    | `CMF_ETC_GROUP` -- Alert>Other
    | `CMF_EXPEDITION` -- Dialogue>Guild
    | `CMF_FAMILY` -- Dialogue>Family
    | `CMF_FR`
    | `CMF_HERO_SEASON_UPDATED` -- Only displays on All Tab.
    | `CMF_IND`
    | `CMF_JA`
    | `CMF_KO`
    | `CMF_LANG_BEGIN`
    | `CMF_LANG_END`
    | `CMF_LOCALE_SERVER` -- Only displays on All Tab.
    | `CMF_LOOT_METHOD_CHANGED` -- Alert>Acquired Item Info>Change Loot Mode
    | `CMF_NOTICE` -- Alert>Alert
    | `CMF_OTHER_CONTINENT` -- Dialogue>Other Continent Dialect
    | `CMF_PARTY` -- Dialogue>Party
    | `CMF_PARTY_AND_RAID_INFO` -- Alert>Party/Raid Info
    | `CMF_PLAY_MUSIC` -- Only displays on All Tab.
    | `CMF_QUEST_INFO` -- Alert>Quest Info
    | `CMF_RAID` -- Dialogue>Raid
    | `CMF_RAID_COMMAND` -- Dialogue>Raid
    | `CMF_RU`
    | `CMF_SELF_CONTRIBUTION_POINT_CHANGED` -- Only displays on All Tab.
    | `CMF_SELF_HONOR_POINT_CHANGED` -- Alert>Acquire/Use Info>Honor Points
    | `CMF_SELF_LEADERSHIP_POINT_CHANGED` -- Only displays on All Tab.
    | `CMF_SELF_LIVING_POINT_CHANGED` -- Alert>Acquire/Use Info>Vocation Badges
    | `CMF_SELF_MONEY_CHANGED` -- Alert>Acquire/Use Info>Gold
    | `CMF_SELF_SKILL_INFO` -- Alert>Other>Skill Info
    | `CMF_SQUAD` -- Dialogue>Team
    | `CMF_SYSTEM` -- Alert>System
    | `CMF_TH`
    | `CMF_TRADE_STORE_MSG` -- Alert>Trade/Shop
    | `CMF_WHISPER` -- Dialogue>Whisper
    | `CMF_ZH_CN`
    | `CMF_ZH_TW`
    | `CMF_BEGIN_USE` -- Dialogue>Local
    | `CMF_BIG_MEGAPHONE` -- Only displays on All Tab.
    | `CMF_COMBAT_DST_OTHER` -- Does not work.
    | `CMF_COMBAT_DST_SELF` -- Does not work.
    | `CMF_COMBAT_SPELL_CAST` -- Does not work.
    | `CMF_COMBAT_SRC_OTHER` -- Does not work.
    | `CMF_COMBAT_SRC_SELF` -- Does not work.
    | `CMF_FACTION` -- Dialogue>Faction
    | `CMF_FIND_PARTY` -- Dialogue>Party-Up
    | `CMF_NONE` -- Does not work.
    | `CMF_RACE` -- Only displays on All Tab.
    | `CMF_SAY` -- Dialogue>Local
    | `CMF_SMALL_MEGAPHONE` -- Only displays on All Tab.
    | `CMF_TRADE` -- Dialogue>Trade
    | `CMF_TRIAL` -- Dialogue>Trial
    | `CMF_ZONE` -- Dialogue>Shout

See: ChatMessageOption