classes

Aliases

ListCtrlItemSubItem

Button|SubItemString|Textbox|Window

A Button widget is clickable and responds to mouse interaction with four visual states: normal, highlighted (hover), pushed (pressed), and disabled. Supports per-state custom backgrounds, tint colors, text coloring, auto-resize, content insets, and per-mouse-button click registration.

Dependencies:

TextStyle used for the style field.
EffectDrawable used for getting the background state drawable.
ImageDrawable used for getting the background state drawable.
NinePartDrawable used for getting the background state drawable.
ThreePartDrawable used for getting the background state drawable.

Classes

Class: AAFormat

Field: desc

string

Field: samples

number

Field: quality

number

Field: txaa

number

Class: AchievementCategory

Field: categoryType

number

Field: name

string

Field: subCategories

AchievementSubCategory[]

Class: AchievementInfo

Field: achievementKind

`EAK_ACHIEVEMENT`|`EAK_ARCHERAGE`|`EAK_COLLECTION`|`EAK_RACIAL_MISSION`

api/X2Achievement

Field: name

string

Field: objective

number[]|nil

Field: isParentComplete

boolean|nil

TODO this may not exist.

Field: isHidden

boolean

Field: iconPath

string

Field: reward

RewardInfo|nil

Field: subCategoryType

`10`|`11`|`12`|`13`|`14`...(+53)

Field: subCategoryName

string

Field: totalSubCount

number|nil

Field: summary

string

Field: tracing

boolean

Field: highRankAchievementType

number|nil

TODO this may not exist.

Field: grade

number

Field: complete

boolean

Field: categoryName

string

Field: canProgress

boolean

Field: highRank

boolean

Field: completeDate

Time|nil

This is set if complete == true

Field: completeSubCount

number|nil

If totalSubCount exists

Field: completeNum

number

Field: desc

string

Field: current

number

Field: type

number

Class: AchievementLevelSubCategory

Extends AchievementSubCategory

Field: isHeirLevelCategory

boolean

Field: name

string

Field: subCategoryType

`10`|`11`|`12`|`13`|`14`...(+53)

Class: AchievementSubCategory

Field: name

string

Field: subCategoryType

`10`|`11`|`12`|`13`|`14`...(+53)

Class: AchievementSubList

Field: key

number

Class: ActabilityGroupTypeInfo

Extends ActabilityInfo

Field: grade

number

Field: point

number

Field: type

number

Field: name

string

Field: modifyPoint

number

Field: viewGroupType

number

Class: ActabilityInfo

Field: grade

number

Field: point

number

Field: name

string

Field: modifyPoint

number

Field: type

number

Class: ActiveAbilities

Field: [1]

ActiveAbility

Field: [2]

ActiveAbility|nil

Field: [3]

ActiveAbility|nil

Class: ActiveAbility

Field: bool

boolean

Field: levelPercent

number

Field: nextLevelTotalExp

string

Field: level

number

Field: exp

string

Field: type

`10`|`11`|`12`|`14`|`1`...(+11)

api/X2Ability

Class: AddonInfo

Field: enable

boolean

Field: name

string

Class: Appellation

Field: [1]

number

TYPE

Field: [4]

number

ISHAVE

Field: [5]

number

ORDER

Field: [3]

number

GRADE

Field: [2]

string|nil

NAME

Field: [6]

AppellationBuffInfo|nil

BUFFINFO

Class: AppellationBuffInfo

Field: buff_id

number

Field: name

string

Field: path

string

Field: description

string

Field: category

string

Field: tipType

string

Class: AppellationChangeItemInfo

Field: enough

boolean

Field: itemType

number

Field: has

number

Field: need

number

Class: AppellationInfo

Field: iconPath

string

Field: name

string

Class: AppellationMyLevelInfo

Field: exp

number

Field: maxlevel

number

Field: maxExp

number

Field: level

number

Field: minExp

number

Class: AppellationMyStamp

Field: id

number

Field: path

string

Class: AppellationRouteInfo

Field: kind

number

Field: routePopup

number

Field: routeDesc

string

Field: type

number

Class: AppliedAllLevelEffect

Field: attributeType

string

Field: unitModifierType

number

Field: value

number

Class: BaseLinkInfo

Field: linkType

"character"|"craft"|"invalid"|"item"|"none"...(+4)

Class: BasicCursorShape

Field: [1]

number

Field: [4]

number

Field: [5]

number

Field: [3]

number

Field: [2]

number

Field: [6]

number

Class: BlockedCharacter

Field: name

string

Field: unitName

string

Field: worldName

string

Class: BonusesInfo

Field: bufDesc

string

Field: numPieces

number

Field: satisfied

boolean

Class: Bound

Field: height

number

unscaled height

Field: x

number

scaled x (EffectiveOffset)

Field: width

number

unscaled width

Field: y

number

scaled y (EffectiveOffset)

Class: BuffInfo

Field: buff_id

number

Field: timeLeft

number|nil

Field: stack

number

Field: path

string

Field: timeUnit

"msec"|"sec"|nil

Class: BuffTooltip

Extends BuffInfo

Field: buff_id

number

Field: path

string

Field: stack

number

Field: timeLeft

number|nil

Field: timeUnit

"msec"|"sec"|nil

Field: name

string|nil

Field: duration

number|nil

Field: mine

boolean|nil

Field: category

"Buff"|"Debuff"

Field: description

string|nil

Field: tipType

"appStamp"|"buff"|"debuff"|"mate_skill"|"passive"...(+4)

Class: BuildCondition

Field: buildEffect

string

Field: itemType

number

Field: name

string

Field: reqItemCount

number

Field: title

string

Field: itemCount

number

Field: effectDesc

string

Field: isLastStep

boolean

Field: buildExplanation

string

Field: devoteItemCount

number

string

Class: BundleEffectInfo

Field: level

number

Field: reqSupportLevel

number

Field: reqOffenseLevel

number

Field: reqDefenseLevel

number

Field: unitModifierInfos

AppliedAllLevelEffect[]

Class: ButlerChargeInfo

Field: freeChargeAmount

number

Field: maxFreeChargeCount

number

Field: maxWeeklychargeAmount

number

Field: isFree

boolean

Field: freeChargeCount

number

Field: remainWeeklyChargeAmount

number

Class: CHAT_MESSAGE_INFO

Field: charId

string

the unqiue id associated with the character when it was created

Field: speakerInChatBound

boolean

Field: specifyName

string

specifyName or empty

Field: trialPosition

string

trial position or empty

Field: npcBubbleChat

boolean

Field: factionName

string

Field: isUserChat

boolean

Field: displayLocale

`LOCALE_DE`|`LOCALE_EN_SG`|`LOCALE_EN_US`|`LOCALE_FR`|`LOCALE_IND`...(+7)

api/X2Chat

Field: unitId

string

the units id or “0” if unknown

Class: CacheData

Field: cacheType

`CT_ABILITY`|`CT_EXPEDITION_NAME`|`CT_NAME`

types/Widget Cache Type

Field: name

string

Class: CastingInfo

Field: castingTime

number

Field: showTargetCastingTime

boolean

Field: currCastingTime

number

Field: castingUseable

boolean

Field: spellName

string

Class: ChangeOptionInfo

Field: display

false

Class: ChangeVisualRace

Field: itemId

number

Field: skillType

number

Field: raceList

number[]

Field: time

number

Class: CharacterLinkInfo

Extends BaseLinkInfo, CommonLinkFields

Field: filter

number

Field: linkType

"character"

Field: isOtherWorld

boolean

Field: messageTimeStamp

number

Class: ChatMessageOption

Field: isOtherWorldMessage

boolean|nil

Field: npcBubbleChat

boolean|nil

Field: messageLocale

`LOCALE_DE`|`LOCALE_EN_SG`|`LOCALE_EN_US`|`LOCALE_FR`|`LOCALE_IND`...(+8)

api/X2Chat

Field: isUserChat

boolean

Creates a time stamp

Field: specifyName

string|nil

Class: ChronicleInfo

Field: mainKey

number

Field: openKey

number

Field: status

string|"active"|"complete"

Class: CombatAuraSuffix

Field: auraType

"BUFF"|"DEBUFF"

Field: combatText

boolean

Class: CombatCastFailedSuffix

Field: failType

any

TODO

Class: CombatDamageSuffix

Field: damage

number

Field: powerType

"HEALTH"|"MANA"

Field: reduced

number

Field: showElementEffect

boolean

Field: hitType

"CRITICAL"|"HIT"

TODO COMBAT_HIT_TYPE?

Field: elementDamage

number

Field: elementType

number

Field: synergy

boolean

Class: CombatDrainSuffix

Extends CombatEnergizeSuffix

Field: amount

any

Field: powerType

"HEALTH"|"MANA"

Class: CombatEnergizeSuffix

Field: amount

any

Field: powerType

"HEALTH"|"MANA"

Class: CombatEnvironmentalDamage

Extends CombatEnvironmentalPrefix, CombatDamageSuffix

Field: damage

number

Field: reduced

number

Field: showElementEffect

boolean

Field: source

"COLLISION"|"DROWNING"|"FALLING"

Field: subType

`COLLISION_PART_BOTTOM`|`COLLISION_PART_FRONT`|`COLLISION_PART_REAR`|`COLLISION_PART_SIDE`|`COLLISION_PART_TOP`

api/X2Chat

Field: powerType

"HEALTH"|"MANA"

Field: hitType

"CRITICAL"|"HIT"

TODO COMBAT_HIT_TYPE?

Field: mySlave

any

TODO

Field: elementDamage

number

Field: elementType

number

Field: synergy

boolean

Class: CombatEnvironmentalPrefix

Field: mySlave

any

TODO

Field: source

"COLLISION"|"DROWNING"|"FALLING"

Field: subType

`COLLISION_PART_BOTTOM`|`COLLISION_PART_FRONT`|`COLLISION_PART_REAR`|`COLLISION_PART_SIDE`|`COLLISION_PART_TOP`

api/X2Chat

Class: CombatHealedSuffix

Field: elementType

number

Field: hitType

"CRITICAL"|"HIT"

Field: heal

number

Field: showElementEffect

boolean

Class: CombatLeechSuffix

Extends CombatEnergizeSuffix

Field: amount

any

Field: powerType

"HEALTH"|"MANA"

Class: CombatMeleeDamage

Extends CombatDamageSuffix

Field: damage

number

Field: powerType

"HEALTH"|"MANA"

Field: reduced

number

Field: showElementEffect

boolean

Field: hitType

"CRITICAL"|"HIT"

TODO COMBAT_HIT_TYPE?

Field: elementDamage

number

Field: elementType

number

Field: synergy

boolean

Class: CombatMeleeMissed

Extends CombatMissSuffix

Field: damage

number

Field: missType

"BLOCK"|"DODGE"|"IMMUNE"|"MISS"|"PARRY"...(+1)

Field: reduced

number

Field: elementType

number

Field: elementDamage

number

Field: showElementEffect

boolean

Class: CombatMissSuffix

Field: damage

number

Field: missType

"BLOCK"|"DODGE"|"IMMUNE"|"MISS"|"PARRY"...(+1)

Field: reduced

number

Field: elementType

number

Field: elementDamage

number

Field: showElementEffect

boolean

Class: CombatResource

Field: ability

number

Field: resource1Max

number

Field: resource2ColorKey

string|nil

Field: resource2Current

number|nil

Field: resource2Max

number|nil

Field: resource1Current

number

Field: recoveryResourceType

number

Field: resource1ColorKey

string

Field: isDefaultResource

boolean

Field: uiType

`CRU_DOUBLE_GAUGE_2`|`CRU_DOUBLE_GAUGE`|`CRU_GAUGE`|`CRU_OVERLAP`

api/X2CombatResource

Class: CombatResourceInfo

Extends CombatResource

Field: ability

number

Field: resource2ColorKey

string|nil

Field: resource1Max

number

Field: resource2Current

number|nil

Field: resource2Max

number|nil

string

Field: resource1Current

number

Field: recoveryResourceType

number

Field: groupType

number

Field: resource1ColorKey

string

Field: iconPath

string

Field: isDefaultResource

boolean

Field: uiType

`CRU_DOUBLE_GAUGE_2`|`CRU_DOUBLE_GAUGE`|`CRU_GAUGE`|`CRU_OVERLAP`

api/X2CombatResource

Class: CombatResources

Field: [1]

CombatResourceInfo

Field: [2]

CombatResourceInfo

Field: [3]

CombatResourceInfo

Class: CombatSpellAuraApplied

Extends CombatSpellPrefix, CombatAuraSuffix

Field: auraType

"BUFF"|"DEBUFF"

Field: spellName

string

Field: spellId

number

Field: combatText

boolean

Field: spellSchool

string

PHYSICAL|HOLY

Class: CombatSpellAuraRemoved

Extends CombatSpellPrefix, CombatAuraSuffix

Field: auraType

"BUFF"|"DEBUFF"

Field: spellName

string

Field: spellId

number

Field: combatText

boolean

Field: spellSchool

string

PHYSICAL|HOLY

Class: CombatSpellCastFailed

Extends CombatSpellPrefix, CombatCastFailedSuffix

Field: failType

any

TODO

Field: spellName

string

Field: spellId

number

Field: spellSchool

string

PHYSICAL|HOLY

Class: CombatSpellCastStart

Extends CombatSpellPrefix

Field: spellId

number

Field: spellName

string

Field: spellSchool

string

PHYSICAL|HOLY

Class: CombatSpellCastSuccess

Extends CombatSpellPrefix

Field: spellId

number

Field: spellName

string

Field: spellSchool

string

PHYSICAL|HOLY

Class: CombatSpellDamage

Extends CombatSpellPrefix, CombatDamageSuffix

Field: damage

number

Field: showElementEffect

boolean

Field: spellId

number

Field: spellName

string

Field: spellSchool

string

PHYSICAL|HOLY

Field: reduced

number

Field: hitType

"CRITICAL"|"HIT"

TODO COMBAT_HIT_TYPE?

Field: powerType

"HEALTH"|"MANA"

Field: elementDamage

number

Field: elementType

number

Field: synergy

boolean

Class: CombatSpellDotDamage

Extends CombatSpellPrefix, CombatDamageSuffix

Field: damage

number

Field: showElementEffect

boolean

Field: spellId

number

Field: spellName

string

Field: spellSchool

string

PHYSICAL|HOLY

Field: reduced

number

Field: hitType

"CRITICAL"|"HIT"

TODO COMBAT_HIT_TYPE?

Field: powerType

"HEALTH"|"MANA"

Field: elementDamage

number

Field: elementType

number

Field: synergy

boolean

Class: CombatSpellEnergize

Extends CombatSpellPrefix

Field: spellId

number

Field: spellName

string

Field: spellSchool

string

PHYSICAL|HOLY

Class: CombatSpellHealed

Extends CombatSpellPrefix, CombatHealedSuffix

Field: elementType

number

Field: spellId

number

Field: spellName

string

Field: showElementEffect

boolean

Field: heal

number

Field: hitType

"CRITICAL"|"HIT"

Field: spellSchool

string

PHYSICAL|HOLY

Class: CombatSpellMissed

Extends CombatSpellPrefix, CombatMissSuffix

Field: damage

number

Field: showElementEffect

boolean

Field: spellId

number

Field: spellName

string

Field: reduced

number

Field: elementType

number

Field: missType

"BLOCK"|"DODGE"|"IMMUNE"|"MISS"|"PARRY"...(+1)

Field: elementDamage

number

Field: spellSchool

string

PHYSICAL|HOLY

Class: CombatSpellPrefix

Field: spellId

number

Field: spellName

string

Field: spellSchool

string

PHYSICAL|HOLY

Class: CommonFarmItem

Field: growthDone

boolean

Field: name

string

Class: CommonLinkFields

Field: filter

number

Field: isOtherWorld

boolean

Field: messageTimeStamp

number

Class: CompleteCraftOrderInfo

Field: craftCount

number

Field: craftGrade

`0`|`10`|`11`|`12`|`1`...(+8)

Field: craftType

number

Class: Craft

Field: craftType

number

Field: value

number

Class: CraftBaseInfo

Field: actability_satisfied

boolean

Field: required_actability_name

string

Field: require_doodad

number

Field: recommend_level

number

Field: required_actability_point

number

Field: skill_type

number

Field: required_actability_type

number

Field: title

string

Field: orderable

boolean

Field: laborpower_satisfied

boolean

Field: cost

number

Field: consume_lp

number

Field: needed_lp

number

Field: cost_satisfied

boolean

Field: doodad_name

string

Field: craft_type

number

Field: use_only_actability

boolean

Class: CraftInfo

Field: amount

number

Field: item_info

ItemInfo

Field: count

number

Field: mainGrade

boolean

Class: CraftLinkInfo

Extends BaseLinkInfo, CommonLinkFields

Field: craftType

number

Field: linkType

"craft"

Field: isOtherWorld

boolean

Field: filter

number

Field: messageTimeStamp

number

Class: CraftOrderEntries

Field: [1]

CraftOrderEntry|nil

Field: [5]

CraftOrderEntry|nil

Field: [6]

CraftOrderEntry|nil

Field: [7]

CraftOrderEntry|nil

Field: [4]

CraftOrderEntry|nil

Field: [2]

CraftOrderEntry|nil

Field: [3]

CraftOrderEntry|nil

Field: [8]

CraftOrderEntry|nil

Class: CraftOrderEntry

Field: chargeFee

string

Field: entryIndex

number

Field: entryId

number

Field: fee

string

Field: remainTime

number

Field: mine

number

Field: requireLp

number

Field: enableLp

boolean

Field: craftType

number

Field: consumeLp

number

Field: enableAct

boolean

Field: craftCount

number

Field: craftGrade

number

Field: totalFee

string

Class: CraftOrderInfo

Field: craftCount

number

Field: craftGrade

`0`|`10`|`11`|`12`|`1`...(+8)

Field: craftType

number

Class: CraftOrderItemFee

Field: defaultFee

string

Field: maxFee

string

Field: minFee

string

Class: CraftOrderItemSlot

Field: craftCount

number

Field: craftGrade

number

Field: craftType

number

Class: CraftProductInfo

Field: amount

number

Field: productGrade

number

Field: success_rate

number

Field: item_name

string

Field: itemType

number

Field: useGrade

boolean

Class: CursorSize

Field: [1]

number

Field: [2]

number

Field: [3]

number

Class: CustomHairColor

Extends CustomizingHairDefaultColor, CustomizingHairTwoToneColor

Field: defaultB

number

Basic Hair Color Blue. (min: 0, max: 255)

Field: secondWidth

number

Highlights. (min: 0, max: 1)

Field: twoToneB

number

Highlight Color Blue. (min: 0, max: 255)

Field: twoToneG

number

Highlight Color Green. (min: 0, max: 255)

Field: index

number|nil

Old Hair @TODO If this is set by default on the model then rgb cant be used and vice versa, needs more testing.

Field: defaultR

number

Basic Hair Color Red. (min: 0, max: 255)

Field: firstWidth

number

Dye Length. (min: 0, max: 1)

Field: defaultG

number

Basic Hair Color Green. (min: 0, max: 255)

Field: twoToneR

number

Highlight Color Red. (min: 0, max: 255)

Class: CustomizingHairDefaultColor

Field: defaultB

number

Basic Hair Color Blue. (min: 0, max: 255)

Field: defaultR

number

Basic Hair Color Red. (min: 0, max: 255)

Field: defaultG

number

Basic Hair Color Green. (min: 0, max: 255)

Field: index

number|nil

Old Hair @TODO If this is set by default on the model then rgb cant be used and vice versa, needs more testing.

Class: CustomizingHairTwoToneColor

Field: firstWidth

number

Dye Length. (min: 0, max: 1)

Field: twoToneG

number

Highlight Color Green. (min: 0, max: 255)

Field: twoToneB

number

Highlight Color Blue. (min: 0, max: 255)

Field: secondWidth

number

Highlights. (min: 0, max: 1)

Field: twoToneR

number

Highlight Color Red. (min: 0, max: 255)

Class: DetailInstanceInfo

Field: available

boolean

Field: resetCount

number

Field: resetItem

boolean

Field: playingTime

number

Field: permitLimit

number

Field: playRoundCount

number

Field: permitItem

boolean

Field: resetLimit

number

Field: showExpeditionLevel

boolean

Field: uiKey

string

Field: roundTime

number

Field: squadCreatable

boolean

Field: singleApplyAvailable

boolean

Field: zoneList

InstanceZoneInfo[]

Field: permitCount

number

Field: maxEnterCount

number

Field: enterCount

number

Field: entranceTime

EntranceTime

Field: desc

string

Field: balanceLevel

number

Field: name

string

Field: expeditionLevel

number

Field: gearScoreLimitMax

number

Field: levelMin

number

Field: gearScore

number

Field: levelMax

number

Field: hasSquad

boolean

Field: zoneName

string

Class: DiagonalASRDailyInfo

Field: dailyAvg

string

Field: volume

number

Field: minPrice

string

Field: maxPrice

string

Field: weeklyAvg

string

Class: DiagonalASRInfo

Field: [10]

DiagonalASRDailyInfo

Field: [4]

DiagonalASRDailyInfo

Field: [3]

DiagonalASRDailyInfo

Field: [5]

DiagonalASRDailyInfo

Field: [7]

DiagonalASRDailyInfo

Field: [6]

DiagonalASRDailyInfo

Field: [8]

DiagonalASRDailyInfo

Field: [2]

DiagonalASRDailyInfo

Field: [14]

DiagonalASRDailyInfo

Field: [11]

DiagonalASRDailyInfo

Field: [1]

DiagonalASRDailyInfo

Field: [12]

DiagonalASRDailyInfo

Field: [13]

DiagonalASRDailyInfo

Field: [9]

DiagonalASRDailyInfo

Class: DoodadProgress

Field: curCount

any

TODO

Field: maxCount

any

TODO

Class: DoodadTooltipInfo

Field: alignLeft

boolean|nil

Field: length

number|nil

Field: loadedItemName

string|nil

Field: isFree

boolean|nil

Field: id

any

TODO

Field: goodsValue

number|nil

Field: name

string|nil

Field: permission

`1`|`2`|`3`|`4`|`5`...(+2)

Field: owner

string|nil

Field: ptype

any

TODO

Field: progress

DoodadProgress|nil

Field: timeLabel

string|nil

Field: freshnessTooltip

string|nil

Field: explain

string|nil

Field: chillingPercent

any

TODO

Field: chillRemainTime

Time|nil

Field: catched

Time|nil

Field: freshnessRemainTime

Time|nil

Field: chillingRate

any

TODO

Field: displayTime

number|nil

Field: crafterName

string|nil

Field: expeditionOwn

boolean|nil

Field: dtype

any

TODO

Field: weight

number|nil

Class: EntranceTime

Field: timeGroupInfo

GroupInfo[]

Field: weekGroupInfo

GroupInfo[]

Class: EquipSetInfo

Field: bonuses

BonusesInfo[]

Field: equipSetItemInfoDesc

string

Class: EquipSlotReinforceMaterialInfo

Field: [1]

RequiredMaterialInfo

Field: [4]

RequiredMaterialInfo

Field: curExp

number

Field: [3]

RequiredMaterialInfo

Field: [2]

RequiredMaterialInfo

Field: totalExp

number

Class: EscMenuAddButtonInfo

Field: categoryId

`1`|`2`|`3`|`4`|`5`

Taken from db ui_esc_menu_categories

Field: name

string

Field: iconKey

""|"achievement"|"auction"|"bag"|"butler"...(+26)

ui/common/esc_menu.g

Field: uiContentType

`UIC_ABILITY_CHANGE`|`UIC_ACHIEVEMENT`|`UIC_ACTABILITY`|`UIC_ADDON`|`UIC_APPELLATION`...(+121)

api/Addon

Class: EscMenuBadgeData

Field: buttonType

`1`|`2`|`3`

Field: buttonValue

number|nil

0 disable, 1 and more enable or show

Field: colorKey

string|nil

ui/common/default.g > text_badge_bg.colors

Class: EscMenuButtonData

Field: h

number|nil

25

Field: x

number|nil

Field: w

number|nil

25

Field: path

string|nil

Addon/{addonname}/example.dds

Field: y

number|nil

Class: EventTable

Field: ABILITY_CHANGED

fun(newAbility: "adamant"|"assassin"|"death"|"fight"|"hatred"...(+9), oldAbility: "adamant"|"assassin"|"death"|"fight"|"hatred"...(+9))|nil

Event triggers when one of the players ability is changed.

Field: RANK_SNAPSHOTS

fun(rankType: number, divisionId: number)|nil

Event triggers when the player checks ranking info.

Field: RANK_SEASON_RESULT_RECEIVED

fun()|nil

Field: RANK_UNLOCK

fun()|nil

Field: RECOVERABLE_EXP

fun(stringId: string, restorableExp: number, expLoss: number)|nil

Event triggers when the player dies and has recoverable exp.

Field: RECOVERED_EXP

fun(stringId: string, recoveredExp: number)|nil

Event triggers when the player recovers lost exp.

Field: RANK_REWARD_SNAPSHOTS

fun(rankType: number, divisionId: number)|nil

Event triggers when the player views a pervious ranking snapshot.

Field: RANK_PERSONAL_DATA

fun()|nil

Event triggers when the player views a tab of the ranking information window that requires the players personal data.

Field: RANK_RANKER_APPEARANCE

fun(charID: number)|nil

Event triggers when the player views the gear of a player on the ranking information window.

Field: RANK_DATA_RECEIVED

fun()|nil

Field: RANK_LOCK

fun()|nil

Field: RANK_ALARM_MSG

fun(rankType: `RK_CHARACTER_GEAR_SCORE`|`RK_EXPEDITION_BATTLE_RECORD`|`RK_EXPEDITION_GEAR_SCORE`|`RK_EXPEDITION_INSTANCE_RATING`|`RK_FISHING_SUM`...(+7), msg: string)|nil

Event triggers when a ranking information alarm occurs.

Field: REENTRY_NOTIFY_DISABLE

fun()|nil

Event triggers when the player is no longer able to reenter a instance.

Field: REFRESH_COMBAT_RESOURCE

fun(resetBar: boolean, groupType: number, resourceType: number, point?: number)|nil

Event triggers when the players combat resource has been refreshed.

Field: REMOVE_CARRYING_BACKPACK_SLAVE_INFO

fun(arg: any)|nil

Field: REMOVE_BOSS_TELESCOPE_INFO

fun(arg: any)|nil

Field: REMOVE_FISH_SCHOOL_INFO

fun(index: number)|nil

Event triggers when a fish is no longer on fish telescope.

Field: REMOVE_GIVEN_QUEST_INFO

fun(arg1: number, qType: number)|nil

Event triggers when the new quest is not within range of the player.

Field: REENTRY_NOTIFY_ENABLE

fun(param: ReentryParam)|nil

Event triggers when the player can still reenter a instance.

Field: REMOVED_ITEM

fun(itemLinkText: string, itemCount: number, removeState: "consume"|"conversion"|"destroy", itemTaskType: number, tradeOtherName: string)|nil

Event triggers when an item has been deleted/removed from the players inventory.

Field: REFRESH_STORE_MERCHANT_GOOD_LIMIT_PURCHASE

fun()|nil

Event triggers when the stores purchase count for a limited item changes.

Field: RELOAD_CASH

fun(money: any)|nil

Field: REFRESH_COMBAT_RESOURCE_UPDATE_TIME

fun(updateReesourceType: number, nowTime: number, show: boolean)|nil

Event triggers when the players combat resource has been updated.

Field: REFRESH_SQUAD_LIST

fun(arg?: boolean)|nil

Event triggers when the players squad list has refreshed.

Field: REMOVE_NOTIFY_QUEST_INFO

fun(qType: number)|nil

Event triggers when a quest notifcation is removed.

Field: RANDOM_SHOP_UPDATE

fun()|nil

Event triggers when the manastorm shop updates.

Field: RAID_RECRUIT_LIST

fun(data: RaidRecruitListInfo)|nil

Event triggers when the player views the raid recruit window.

Field: QUEST_CONTEXT_OBJECTIVE_EVENT

fun(objText: string)|nil

Event triggers when the players quest updates.

Field: QUEST_CONTEXT_CONDITION_EVENT

fun(objText: string, condition: "dropped"|"started"|"updated")|nil

Event triggers when the players quest condition occurs.

Field: QUEST_CONTEXT_UPDATED

fun(qType: number, status: "dropped"|"started"|"updated")|nil

Event triggers when the players quest updates.

Field: QUEST_DIRECTING_MODE_END

fun()|nil

Field: QUEST_DIRECTING_MODE_HOT_KEY

fun(key: `1`|`2`|`3`)|nil

Event triggers when the player uses a hot key to advance the quest dialog.

Field: QUEST_CHAT_RESTART

fun()|nil

Field: PROGRESS_TALK_QUEST_CONTEXT

fun(qtype: number, useDirectingMode: boolean, npcId: string, doodadId?: string)|nil

Event triggers when the player talks to a npc that is required to progress a quest.

Field: QUEST_CHAT_LET_IT_DONE

fun()|nil

Field: PREMIUM_SERVICE_LIST_UPDATED

fun()|nil

Event triggers when the player opens the patron window.

Field: PROCESS_CRAFT_ORDER

fun(result: boolean, processType: `COPT_INSTANT`|`COPT_INVALID`|`COPT_PC`)|nil

Event triggers when the player processes a crafting order.

Field: RANDOM_SHOP_INFO

fun(isHide: boolean, isdailyReset: boolean)|nil

Event triggers when the manastorm shop updates.

Field: QUEST_ERROR_INFO

fun(errNum: `10`|`11`|`12`|`13`|`14`...(+35), qtype: number, questDetail?: string, isCommon?: boolean)|nil

Event triggers when the players quest has an error.

Field: QUEST_HIDDEN_READY

fun(qtype: number)|nil

Event triggers when the player activates a hidden quest.

Field: RAID_FRAME_SIMPLE_VIEW

fun(simple: boolean)|nil

Event triggers when the player checks the status display of the raid and changing raid window zoom setting.

Field: RAID_RECRUIT_DETAIL

fun(data: RaidRecruitDetailInfo)|nil

Event triggers when the player views the details of a raid recruit.

Field: RAID_RECRUIT_HUD

fun(infos: RaidRecruitInfo[])|nil

Event triggers when the raid hud changes.

Field: QUEST_HIDDEN_COMPLETE

fun(qtype: number)|nil

Event triggers when the player completes a hidden quest.

Field: RAID_APPLICANT_LIST

fun(data: RaidApplicantData)|nil

Event triggers when the player checks their raid applicant list.

Field: QUEST_NOTIFIER_START

fun()|nil

Event triggers when the player loads into the world and the quest notifier needs to be initialized or refreshed.

Field: QUEST_QUICK_CLOSE_EVENT

fun(qtype: number)|nil

Event triggers when a quests window is closed to show a video.

Field: QUEST_LEFT_TIME_UPDATED

fun(qtype: number, leftTime: number)|nil

Event triggers when the players quest updates.

Field: QUEST_MSG

fun(arg1: string, arg2: string)|nil

Field: PREMIUM_SERVICE_BUY_RESULT

fun(err: any)|nil

Field: REMOVE_PING

fun()|nil

Event triggers when the player enters/exits an instance and the map needs to remove all pings.

Field: REMOVE_TRANSFER_TELESCOPE_INFO

fun(index: number)|nil

Event triggers when a transfer vehicle is no longer on the telescope.

Field: SET_ROADMAP_PICKABLE

fun(pick: boolean)|nil

Event triggers when the player enables/disables ping mode.

Field: SET_REBUILD_HOUSE_CAMERA_MODE

fun()|nil

Event triggers when the player enters house preview mode for remodeling a building.

Field: SHOW_ACCUMULATE_HONOR_POINT_DURING_HPW

fun(zoneName: string, accumulatePoint: number, state?: any)|nil

Event triggers when the players honor points change during war due to combat.

Field: SHOW_ADDED_ITEM

fun(item: ItemInfo, count: number, taskType: number)|nil

Event triggers when the player receives an item.

Field: SHOW_ADD_TAB_WINDOW

fun()|nil

Field: SET_PING_MODE

fun(pick: boolean)|nil

Event triggers when the player enables/disables ping mode.

Field: SET_EFFECT_ICON_VISIBLE

fun(isShow: boolean, arg: Widget)|nil

Event triggers when a effect icon should be visible on the map.

Field: SET_OVERHEAD_MARK

fun(unitId: string, index: number, visible: boolean)|nil

Event triggers when a player has a mark set or remove on them.

Field: SELL_SPECIALTY_CONTENT_INFO

fun(list: SpecialtyInfo)|nil

Event triggers when the player checks the specialty price information at a trade outlet.

Field: SET_DEFAULT_EXPAND_RATIO

fun(isSameZone: boolean)|nil

Event triggers when the player is changing zones in the map.

Field: SELL_SPECIALTY

fun(text: string)|nil

Event triggers when the player sells specialty cargo.

Field: SHOW_BANNER

fun(show: boolean, instanceType: number, remainPreNoticeTime?: any)|nil

Event triggers when a banner should appear for content.

Field: SHOW_CRIME_RECORDS

fun(trialState: `TRIAL_FINAL_STATEMENT`|`TRIAL_FREE`|`TRIAL_GUILTY_BY_SYSTEM`|`TRIAL_GUILTY_BY_USER`|`TRIAL_POST_SENTENCE`...(+4))|nil

Event triggers when the player joins a trial and triggers at each trial state.

Field: SHOW_SEXTANT_POS

fun(sextantPos: SEXTANT)|nil

Event triggers when the player uses a sextant.

Field: SHOW_SLAVE_INFO

fun()|nil

Event triggers when the player checks the summon information of the vehicle.

Field: SHOW_VERDICTS

fun(p1: number, p2: number, p3: number, p4: number, p5: number)|nil

Event triggers when the player has to make a verdict in a trial.

Field: SHOW_CHAT_TAB_CONTEXT

fun(arg1: Widget, arg2: number)|nil

Event triggers when the player right clicks on a tab for the context menu.

fun(tooltipInfo: TooltipInfo[], tooltipCount: number)|nil

Event triggers when a tooltip is shown on the roadmap.

Field: SHOW_RAID_FRAME_SETTINGS

fun()|nil

Event triggers when the player views the raid frame settings.

Field: SHOW_RENAME_EXPEIDITON

fun(byItem: any, triedName: any, ownerWnd: any)|nil

Field: SHOW_DEFENDANT_WAIT_JURY

fun()|nil

Field: SHOW_DEFENDANT_WAIT_TRIAL

fun()|nil

Field: REMOVE_SHIP_TELESCOPE_INFO

fun(arg: number)|nil

Event triggers when a ship is no longer on the telescope.

Field: SELECT_SQUAD_LIST

fun(data: SelectSquadList)|nil

Event triggers when the player view the Recruit/Search page for instances.

Field: SCHEDULE_ITEM_UPDATED

fun()|nil

Event triggers every minute to update the schedule.

Field: REQUIRE_ITEM_TO_CHAT

fun(channel: any)|nil

Field: REQUIRE_DELAY_TO_CHAT

fun(channel: any, delay: any, remain: any)|nil

Field: RESET_INGAME_SHOP_MODELVIEW

fun()|nil

Field: RESIDENT_BOARD_TYPE

fun(boardType: `1`|`2`|`3`|`4`|`5`...(+2))|nil

Event triggers when the player views the residents board type.

Field: RESIDENT_HOUSING_TRADE_LIST

fun(infos: ResidentHousing, rownum: number, filter: number, searchword: string, refresh: number)|nil

Event triggers when the player views the housing sales tab of a zone.

Field: REPUTATION_GIVEN

fun()|nil

Event triggers when the player thumbs a player.

Field: REPORT_BAD_USER_UPDATE

fun()|nil

Field: REPORT_CRIME

fun(doodadName: string, locationName: string)|nil

Event triggers when the player begins to report a crime.

Field: RENAME_PORTAL

fun()|nil

Event triggers when the player renames a portal.

Field: RENEW_ITEM_SUCCEEDED

fun()|nil

Field: SELECTED_INSTANCE_DIFFICULT

fun(difficult: any)|nil

Field: RESIDENT_MEMBER_LIST

fun(total: number, start: number, refresh: number, members: ResidentMember[])|nil

Event triggers when the player views the housing residents tab of a zone.

Field: RESIDENT_TOWNHALL

fun(info: ResidentInfo)|nil

Event triggers when the player accesses the task board at resident townhall of the zone.

Field: SAVE_SCREEN_SHOT

fun(path: string)|nil

Event triggers when the player saves a screenshot.

Field: SCALE_ENCHANT_BROADCAST

fun(characterName: string, resultCode: `IEBCT_ENCHANT_GREATE_SUCCESS`|`IEBCT_ENCHANT_SUCCESS`|`IEBCT_EVOVING`, itemLink: string, oldScale: string, newScale: string)|nil

Event triggers when a player increases the temper of their equipment and it is broadcasted to the server.

Field: SCHEDULE_ITEM_SENT

fun()|nil

Event triggers when the player clicks on an scheduled item (loyalty token) to collect it.

Field: RESIDENT_SERVICE_POINT_CHANGED

fun(zoneGroupName: "Abyssal Library"|"Aegis Island"|"Ahnimar Event Arena"|"Ahnimar"|"Airain Rock"...(+143), amount: number, total: number)|nil

Event triggers when the players residental contribution points change.

Field: SAVE_PORTAL

fun()|nil

Event triggers when the player saves a portal.

Field: RULING_CLOSED

fun()|nil

Event triggers when a jury ruling is has come to an end.

Field: RULING_STATUS

fun(count: number, total: number, sentenceType: `SENTENCE_GUILTY_1`|`SENTENCE_GUILTY_2`|`SENTENCE_GUILTY_3`|`SENTENCE_GUILTY_4`|`SENTENCE_GUILTY_5`...(+1), sentenceTime: number)|nil

Event triggers when a member of the jury votes.

Field: RESIDENT_ZONE_STATE_CHANGE

fun()|nil

Event triggers when the player is viewing the location of land for sale in sales tab of the resident townhall for the zone.

Field: ROLLBACK_FAVORITE_CRAFTS

fun(datas: Craft[])|nil

Event triggers when the players favorite crafts are rolledback.

Field: SHOW_WORLDMAP_LOCATION

fun(zoneId: `0`|`100`|`101`|`102`|`104`...(+315), x: number, y: number, z: number)|nil

Event triggers when the world map has a location to be shown.

Field: PREMIUM_POINT_CHANGE

fun()|nil

Field: PREMIUM_GRADE_CHANGE

fun(prevPremiumGrade: any, presentPremiumGrade: any)|nil

Field: MOVIE_LOAD

fun()|nil

Field: MOVIE_ABORT

fun()|nil

Field: MOVIE_STOP

fun()|nil

Field: MULTI_QUEST_CONTEXT_SELECT

fun(targetNpc: boolean, qtype: number, useDirectingMode: boolean, targetId: string, interactionValue: string)|nil

Event triggers when the player interacts with a npc that has multiple quests.

Field: MULTI_QUEST_CONTEXT_SELECT_LIST

fun(questList: QuestSelectList)|nil

Event triggers when the player interacts with a npc that has multiple quests.

Field: MOVE_SPEED_CHANGE

fun()|nil

Event triggers when the players move speed changes.

Field: MOUSE_DOWN

fun(widgetId: string)|nil

Event triggers when the player clicks on a widget.

Field: MOUSE_UP

fun()|nil

Field: MOUNT_SLOT_CHANGED

fun()|nil

Field: MOUSE_CLICK

fun()|nil

Field: MOUNT_PET

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`, isMyPet: boolean)|nil

Event triggers when the player mounts a pet.

Field: NAME_TAG_MODE_CHANGED_MSG

fun(changedNameTagMode: `1`|`2`|`3`|`4`)|nil

Event triggers when the player changes the name tag mode.

Field: NAVI_MARK_POS_TO_MAP

fun()|nil

Field: NOTIFY_AUTH_BILLING_MESSAGE

fun(msg: any, remainTime: any)|nil

Field: NOTIFY_AUTH_ADVERTISING_MESSAGE

fun(msg: any, remainTime: any)|nil

Field: NOTIFY_AUTH_DISCONNECTION_MESSAGE

fun(msg: any, remainTime: any)|nil

Field: NOTIFY_AUTH_FATIGUE_MESSAGE

fun(msg: any, remainTime: any)|nil

Field: NATION_DOMINION

fun(zoneGroupType: `0`|`100`|`101`|`102`|`103`...(+151), force: boolean)|nil

Event triggers when the player is selecting a territory from the Faction > Auroria Territories window.

Field: NOTICE_MESSAGE

fun(noticeType: number, color: string, visibleTime: number, message: string, name: string)|nil

Event triggers when a gm notice message occurs.

Field: NEW_SKILL_POINT

fun(point: number)|nil

Event triggers when the player gains a new skill point.

Field: NEXT_SIEGE_INFO

fun(siegeInfo: NextSiegeInfo)|nil

Event triggers when the next siege information is required.

Field: NAVI_MARK_REMOVE

fun()|nil

Field: NEW_DAY_STARTED

fun()|nil

Event triggers when a new day (daily reset) starts.

Field: NOTIFY_AUTH_NOTICE_MESSAGE

fun(message: any, visibleTime: any, needCountdown: any)|nil

Field: MOUNT_BAG_UPDATE

fun()|nil

Field: MODE_ACTIONS_UPDATE

fun()|nil

Event triggers when the players dynamic shortcut is updated.

Field: MAIL_WRITE_ITEM_UPDATE

fun(index: number)|nil

Event triggers when the player starts to create a new mail.

Field: MAIL_SENT_SUCCESS

fun()|nil

Event triggers when the player successfully sends a mail.

Field: MAP_EVENT_CHANGED

fun()|nil

Event triggers when the player opens the map.

Field: MATE_SKILL_LEARNED

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`, text: string)|nil

Event triggers when the players mount or battlepet learns a new skill.

Field: MATE_STATE_UPDATE

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`, stateIndex: `1`|`2`|`3`|`4`)|nil

Event triggers when the players mount of battlepet state changes without the player changing it.

Field: MAIL_SENTBOX_UPDATE

fun(read: any, mailListKind: any)|nil

Event triggers when the player checks their sent mail.

Field: MAIL_INBOX_UPDATE

fun(read: boolean|nil, mailListKind: `MAIL_LIST_CONTINUE`|`MAIL_LIST_END`|`MAIL_LIST_INVALID`|`MAIL_LIST_START`|nil)|nil

Event triggers when the players mailbox has an update.

Field: MAIL_RETURNED

fun()|nil

Field: MAIL_INBOX_MONEY_TAKEN

fun()|nil

Event triggers when the player takes money from the mail.

Field: MAIL_INBOX_TAX_PAID

fun()|nil

Event triggers when the player pays their taxes through the mail.

Field: MONEY_ACQUISITION_BY_LOOT

fun(charName: any, moneyStr: any)|nil

Field: MEGAPHONE_MESSAGE

fun(show: any, channel: any, name: any, message: any, isMyMessage: any)|nil

Field: MIA_MAIL_INBOX_MONEY_TAKEN

fun()|nil

Field: MIA_MAIL_WRITE_ITEM_UPDATE

fun()|nil

Field: MINE_AMOUNT

fun()|nil

Field: MINI_SCOREBOARD_CHANGED

fun(status: "inactive"|"remove"|"update", info: MiniScoreBoardInfo[]|nil)|nil

Event triggers when the mini scoreboard changes.

Field: MIA_MAIL_INBOX_ITEM_TAKEN

fun()|nil

Field: MIA_MAIL_SENT_SUCCESS

fun()|nil

Field: MIA_MAIL_RETURNED

fun()|nil

Field: MIA_MAIL_SENTBOX_UPDATE

fun()|nil

Field: MIA_MAIL_INBOX_TAX_PAID

fun()|nil

Field: MIA_MAIL_INBOX_UPDATE

fun()|nil

Field: PREMIUM_LABORPOWER_CHANGED

fun(onlineDiff: any, offlineDiff: any)|nil

Field: NOTIFY_AUTH_TC_FATIGUE_MESSAGE

fun(msg: any, remainTime: any)|nil

Field: NPC_CRAFT_UPDATE

fun()|nil

Field: PLAYER_BANK_AA_POINT

fun()|nil

Field: PLAYER_ABILITY_LEVEL_CHANGED

fun()|nil

Event triggers when the players ability level changes.

Field: PLAYER_BANK_MONEY

fun(amount: number, amountStr: string)|nil

Event triggers when the player deposits or withdraws from their bank.

Field: PLAYER_BM_POINT

fun(oldBmPoint: string)|nil

Event triggers when the players loyalty tokens change.

Field: PLAYER_GEAR_POINT

fun()|nil

Field: PLAYER_AA_POINT

fun(change: any, changeStr: any, itemTaskType: any, info: any)|nil

Field: PET_FOLLOWING_MASTER

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`)|nil

Event triggers when the players mount state t is following.

Field: PET_STOP_BY_MASTER

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`)|nil

Event triggers when the players mount state is not following.

Field: PETMATE_UNBOUND

fun()|nil

Event triggers when the player unmounts another players pet.

Field: PET_AUTO_SKILL_CHANGED

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`)|nil

Event triggers when the players pet auto skill changes

Field: PETMATE_BOUND

fun()|nil

Event triggers when the player mounts another players pet.

Field: PLAYER_HONOR_POINT

fun(amount: number, amountStr: string, isCombatInHonorPointWar?: boolean)|nil

Event triggers when the players honor points change.

Field: PLAYER_JURY_POINT

fun()|nil

Event triggers when the player completes a trial.

Field: PLAYER_VISUAL_RACE

fun()|nil

Event triggers when the player changes race.

Field: POST_CRAFT_ORDER

fun(result: boolean)|nil

Event triggers when the player attempts to list a craftring request.

Field: PRELIMINARY_EQUIP_UPDATE

fun()|nil

Event triggers when the player changes equipment.

Field: PLAYER_HONOR_POINT_CHANGED_IN_HPW

fun(amount: number)|nil

Event triggers when the players honor points change in a zone.

Field: PLAYER_RESURRECTION

fun(name: string)|nil

Event triggers when the player has been resurrected.

Field: PLAYER_MONEY

fun(change: number, changeStr: string, itemTaskType: number, info?: any)|nil

Event triggers when the players money changes

Field: PLAYER_RESURRECTED

fun()|nil

Event triggers when the player accepts a resurrection.

Field: PLAYER_LEADERSHIP_POINT

fun(amount: number, amountStr: string)|nil

Event triggers when the player receives leadership points.

Field: PLAYER_LIVING_POINT

fun(amount: number, amountStr: string)|nil

Event triggers when the players vocation changes.

Field: NPC_CRAFT_ERROR

fun()|nil

Field: PASSENGER_UNMOUNT_PET

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`)|nil

Event triggers when a passenger unmounts the players pet.

Field: OPTION_RESET

fun()|nil

Event triggers when the player resets a Game Settings option.

Field: ONE_AND_ONE_CHAT_ADD_MESSAGE

fun(channelId: any, speakerName: any, message: any, isSpeakerGm: any)|nil

Field: NUONS_ARROW_UPDATE

fun(data: NuonsArrowUpdate[])|nil

Event triggers when a continent has regional community center development update.

Field: ONE_AND_ONE_CHAT_END

fun(channelId: any)|nil

Field: ONE_AND_ONE_CHAT_START

fun(channelId: any, targetName: any)|nil

Field: OPEN_CHAT

fun()|nil

Event triggers when the player opens their chat.

Field: NUONS_ARROW_UI_MSG

fun(nuonsMsgInfo: any)|nil

Field: NPC_UNIT_EQUIPMENT_CHANGED

fun()|nil

Field: NUONS_ARROW_SHOW

fun(visible: any)|nil

Field: NPC_INTERACTION_END

fun()|nil

Event triggers when the player ends a interaction with a npc.

Field: NPC_INTERACTION_START

fun(value: "quest", addedValue: "complete"|"start"|"talk", npcId: string)|nil

Event triggers when the player starts a interaction with a npc.

Field: PASSENGER_MOUNT_PET

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`)|nil

Event triggers when a passenger mounts the players pet.

Field: OPEN_COMMON_FARM_INFO

fun(commonFarmType: `1`|`2`|`3`|`4`)|nil

Event triggers when the player opens information board at a public farm to check which items can be placed.

Field: OPEN_CRAFT_ORDER_BOARD

fun(tabName: string)|nil

Event triggers when the player opens the crafting request window by right clicking on a crafting request.

Field: OPEN_PAPER

fun(type: "book"|"page", idx: number)|nil

Event triggers when the player opens a letter/book in their inventory.

Field: OPEN_PROMOTION_EVENT_URL

fun(url: any)|nil

Field: OPTIMIZATION_RESULT_MESSAGE

fun(activated: boolean)|nil

Event triggers when the player enables/disables optimization.

Field: OPEN_CONFIG

fun()|nil

Event triggers when the player opens the escape menu with the escape key.

Field: OPEN_NAVI_DOODAD_NAMING_DIALOG

fun()|nil

Field: OPEN_EXPEDITION_PORTAL_LIST

fun(addPortal: boolean, interactionDoodad: boolean, expeditionOwner: boolean)|nil

Event triggers when the player interacts with their guild portal.

Field: OPEN_MUSIC_SHEET

fun(isShow: boolean, itemIdString: string, isWide: number)|nil

Event triggers when the player opens a music sheet to begin composing music.

Field: OPEN_EMBLEM_IMPRINT_UI

fun()|nil

Field: OPEN_EMBLEM_UPLOAD_UI

fun(doodad: number)|nil

Event triggers when the player opens the crest printer window.

Field: MAIL_INBOX_ITEM_TAKEN

fun(index: number)|nil

Event triggers when the player takes an item from the mail.

fun(tooltipInfo: TooltipInfo[], tooltipCount: number)|nil

Event triggers when a tooltip is shown on the worldmap.

Field: SIEGEWEAPON_UNBOUND

fun()|nil

Event triggers when the player unmounts a siege weapon.

Field: UPDATE_COMPLETED_QUEST_INFO

fun()|nil

Event triggers when the map needs to update the completed quest information.

Field: UPDATE_CLIENT_DRIVEN_INFO

fun(sceneInfo: any)|nil

Field: UPDATE_CONTENT_ROSTER_WINDOW

fun(updateInfo: any)|nil

Field: UPDATE_CORPSE_INFO

fun()|nil

Event triggers when the player dies and when the player respawns.

Field: UPDATE_CRAFT_ORDER_ITEM_FEE

fun(info: CraftOrderItemFee)|nil

Event triggers when the player is attempting to list a requested item.

Field: UPDATE_CHRONICLE_NOTIFIER

fun(init: boolean, mainKey: number)|nil

Event triggers when the players chronicle quest notification tab updates.

Field: UPDATE_CHANGE_VISUAL_RACE_WND

fun(fired: boolean)|nil

Event triggers when the player starts/cancels the race transformation.

Field: UPDATE_CHRONICLE_INFO

fun(info: ChronicleInfo)|nil

Event triggers when the player purchases a chronicle quest.

Field: UPDATE_BUBBLE

fun()|nil

Field: UPDATE_CARRYING_BACKPACK_SLAVE_INFO

fun()|nil

Field: UPDATE_BOT_CHECK_INFO

fun(totalTime: number, remainTime: number, count: number, question: string)|nil

Event triggers when the bot check window info for the player updates.

Field: UPDATE_CRAFT_ORDER_ITEM_SLOT

fun(info?: CraftOrderItemSlot)|nil

Event triggers when the request slot updates.

Field: UPDATE_DEFENCE_INFO

fun(info: any)|nil

Field: UPDATE_EXPEDITION_TODAY_ASSIGNMENT_RESET_COUNT

fun(count: number)|nil

Event triggers when the players guild assignments reset.

Field: UPDATE_EXPEDITION_PORTAL

fun()|nil

Event triggers when the players guild house portal list changes.

Field: UPDATE_FACTION_REZ_DISTRICT

fun()|nil

Event triggers when a hero activates a hero respawn spot.

Field: UPDATE_FISH_SCHOOL_AREA

fun()|nil

Event triggers when the player starts and stops using a ship fish telescope.

Field: UPDATE_CRAFT_ORDER_SKILL

fun(key: string, fired: boolean)|nil

Event triggers when the player starts to make, or cancels, a request for a craft order.

Field: UPDATE_ENCHANT_ITEM_MODE

fun(isExcutable: boolean, isLock: boolean)|nil

Event triggers when an item is about to be enchanted and when at the start of the item being enchanted.

Field: UPDATE_DURABILITY_STATUS

fun(added: boolean, removed: boolean)|nil

Event triggers when the players durability status of their gear changes. (e.g., Item is nearly broken)

Field: UPDATE_DYEING_EXCUTABLE

fun(executeable: boolean)|nil

Event triggers when the player attempts to dye an item and the dye preview window opens.

Field: UPDATE_DOMINION_INFO

fun()|nil

Event triggers whenever there is a siege information update.

Field: UPDATE_DOODAD_INFO

fun()|nil

Event triggers when the player opens the map.

Field: UPDATE_FISH_SCHOOL_INFO

fun()|nil

Event triggers every 500ms while the player is using a ship fish telescope.

Field: UPDATE_BOSS_TELESCOPE_INFO

fun()|nil

Event triggers every 500ms while the player is using a boss telescope.

Field: UPDATE_BINDINGS

fun()|nil

Event triggers when the player applies updates to their hotkey bindings.

Field: TUTORIAL_EVENT

fun(id: number, info: TutorialInfo[])|nil

Event triggers when an tutorial event occurs.

Field: TRY_LOOT_DICE

fun(key: number, timeStamp: number, itemLink: string)|nil

Event triggers when an item that needs to be rolled on drops.

Field: TUTORIAL_HIDE_FROM_OPTION

fun()|nil

Event triggers when the player disables pop-up tutorial windows from their options window.

Field: UCC_IMPRINT_SUCCEEDED

fun()|nil

Event triggers when a ucc imprint has succeeded.

Field: UI_ADDON

fun()|nil

Event triggers when ADDON:FireAddon has been called.

Field: TRIAL_TIMER

fun(state: `TRIAL_FINAL_STATEMENT`|`TRIAL_FREE`|`TRIAL_GUILTY_BY_SYSTEM`|`TRIAL_GUILTY_BY_USER`|`TRIAL_POST_SENTENCE`...(+4), remainTable: Time)|nil

Event triggers every second a player is in a trial.

Field: TRIAL_MESSAGE

fun(text: string)|nil

Event triggers when the player attempts to join a trial that has already begun.

Field: TRIAL_STATUS

fun(state: `TRIAL_FINAL_STATEMENT`|`TRIAL_FREE`|`TRIAL_GUILTY_BY_SYSTEM`|`TRIAL_GUILTY_BY_USER`|`TRIAL_POST_SENTENCE`...(+4), juryCount: number, remainTime: number, arg: number)|nil

Event triggers when the trial changes state,

Field: TRIAL_CANCELED

fun()|nil

Field: TRIAL_CLOSED

fun()|nil

Event triggers when a trial is over.

Field: UPDATE_BOSS_TELESCOPE_AREA

fun()|nil

Event triggers when the player starts and stops using a boss telescope.

Field: UI_PERMISSION_UPDATE

fun()|nil

Event triggers when a ui permission update has occured.

Field: UNFINISHED_BUILD_HOUSE

fun(message: string)|nil

Event triggers when the player attempts to place land while they already have land that is unbuilt.

Field: UNIT_KILL_STREAK

fun(killStreakInfo: KillStreakInfo)|nil

Event triggers when a player is on a kill streak.

Field: UNIT_NAME_CHANGED

fun(unitId: string)|nil

Event triggers when a units name changes.

Field: UNIT_NPC_EQUIPMENT_CHANGED

fun(arg: `ES_ARMS`|`ES_BACKPACK`|`ES_BACK`|`ES_BEARD`|`ES_BODY`...(+27))|nil

Event triggers when the players pet equipment changes.

Field: UI_RELOADED

fun()|nil

Event triggers when the players UI reloads. (Toggling Vertical Sync will cause a UI reload)

Field: UNIT_EQUIPMENT_CHANGED

fun(equipSlot: `ES_ARMS`|`ES_BACKPACK`|`ES_BACK`|`ES_BEARD`|`ES_BODY`...(+27))|nil

Event triggers when the player changes their gear.

Field: UNIT_DEAD

fun(stringId: string, lossExp: number, lossDurabilityRatio: number)|nil

Event triggers when a player dies.

Field: UNIT_DEAD_NOTICE

fun(name: string)|nil

Event triggers when a player dies.

Field: UNITFRAME_ABILITY_UPDATE

fun(unitId: string)|nil

Event triggers when a player changes their class.

Field: UNIT_COMBAT_STATE_CHANGED

fun(combat: boolean, unitId: string)|nil

Event triggers when the combat state of a unit changes.

Field: TRANSFORM_COMBAT_RESOURCE

fun(groupType: `10`|`11`|`12`|`14`|`1`...(+11))|nil

Event triggers when a combat resource has been transformed. (e.g. When Vitalism Prayer reaches max stacks it converts into Divine Response.)

Field: UPDATE_GACHA_LOOT_MODE

fun(isExcutable: boolean, isLock: boolean)|nil

Event triggers when the open chest (gold/silver/copper crate) window receives a update when the player selects a crate or a key and when each crate is opened.

Field: UPDATE_HERO_ELECTION_CONDITION

fun()|nil

Event triggers when the hero election condition has updated.

Field: UPDATE_TELESCOPE_AREA

fun()|nil

Event triggers when the player starts and stops using a ship telescope.

Field: UPDATE_SQUAD

fun()|nil

Event triggers when the players squad updates.

Field: UPDATE_TODAY_ASSIGNMENT

fun(todayInfo?: TodayAssignmentInfo)|nil

Event triggers when the players daily assignment updates.

Field: UPDATE_TODAY_ASSIGNMENT_RESET_COUNT

fun(count: number)|nil

Event triggers when the players daily assignments reset.

Field: UPDATE_TRANSFER_TELESCOPE_AREA

fun()|nil

Event triggers when the player starts and stops using a telescope.

Field: UPDATE_SPECIALTY_RATIO

fun(sellItem: SellSpecialtyInfo)|nil

Event triggers when the player opens the sell cargo window. Event triggers when X2Store:GetZoneSpecialtyRatio is used.

Field: UPDATE_SKILL_ACTIVE_TYPE

fun()|nil

Event triggers when the player learns a new emote.

Field: UPDATE_SLAVE_EQUIPMENT_SLOT

fun(reload: boolean)|nil

Event triggers when the players slave equipment slot updates.

Field: UPDATE_SHORTCUT_SKILLS

fun()|nil

Field: UPDATE_SIEGE_SCORE

fun(offensePoint: number, outlawPoint: number)|nil

Event triggers when the siege score changes.

Field: UPDATE_SHIP_TELESCOPE_INFO

fun()|nil

Event triggers every 500ms while the player is using a ship telescope.

Field: UPDATE_TRANSFER_TELESCOPE_INFO

fun()|nil

Event triggers every 500ms while the player is using a telescope.

Field: UPDATE_ZONE_LEVEL_INFO

fun(level: `0`|`1`|`2`|`3`, id: `0`|`100`|`101`|`102`|`103`...(+151))|nil

Event triggers when the world map zone zoom level changes.

Field: WATCH_TARGET_CHANGED

fun(stringId: any)|nil

Event triggers when the player starts tracking a new target.

Field: WEB_BROWSER_ESC_EVENT

fun(browser: any)|nil

Field: WORLD_MESSAGE

fun(msg: string, iconKey: string, info: WorldMessageInfo)|nil

Event triggers when a world message occurs.

Field: UPDATE_ZONE_INFO

fun()|nil

Event triggers when the player enters a new zone.

Field: WAIT_REPLY_FROM_SERVER

fun(waiting: boolean)|nil

Event triggers when the player is waiting on a reply from the server.

Field: WAIT_FRIENDLIST_UPDATE

fun(updateType: string)|nil

Event triggers when the player receieves a friend request.

Field: WAIT_FRIEND_ADD_ALARM

fun()|nil

Event triggers when the player receieves a friend request.

Field: UPDATE_ZONE_PERMISSION

fun()|nil

Event triggers when the player enters a zone with permissions. (Ipyna Ridge Akasch Invasion)

Field: VIEW_CASH_BUY_WINDOW

fun(sellType: any)|nil

Field: UPDATE_GIVEN_QUEST_STATIC_INFO

fun()|nil

Event triggers when the players given quest information updates.

Field: UPDATE_ROUTE_MAP

fun()|nil

Field: UPDATE_ROADMAP_ANCHOR

fun(file: string)|nil

Event triggers when the player changes zones.

Field: UPDATE_INSTANT_GAME_INVITATION_COUNT

fun(accept: number, totalSize: number)|nil

Event triggers when a instance invitation goes out and each time a player joins.

Field: UPDATE_INGAME_SHOP_VIEW

fun(viewType: "enter_mode"|"leave_mode"|"leave_sort", mode: `1`|`MODE_SEARCH`)|nil

Event triggers when the in game shops view changes.

Field: UPDATE_INSTANT_GAME_KILLSTREAK

fun(count: any)|nil

Field: UPDATE_INSTANT_GAME_KILLSTREAK_COUNT

fun(count: number)|nil

Event triggers when the player kills another player in a instance.

Field: UPDATE_INSTANT_GAME_SCORES

fun()|nil

Event triggers when an instance score updates.

Field: UPDATE_INGAME_SHOP

fun(updateType: "cart"|"checkTime"|"exchange_ratio"|"goods"|"maintab"...(+2), page?: number, totalItems?: number, arg4?: any)|nil

Event triggers when the in game shop receives an event.

Field: UPDATE_INDUN_PLAYING_INFO_BROADCASTING

fun(info: NpcBroadcastingInfo[])|nil

Event triggers every second while the npc info is broadcasting for the player. (e.g. Hereafter Rebellion Win Condition/Progress)

Field: UPDATE_INGAME_BEAUTYSHOP_STATUS

fun()|nil

Event triggers when the players ability to use the beautyshop changes.

Field: UPDATE_HOUSING_INFO

fun()|nil

Event triggers when the housing information for the map updates.

fun(unitId: string)|nil

Event triggers when a housing tooltip updates.

Field: UPDATE_ROSTER_MEMBER_INFO

fun(rosterId: any)|nil

Field: UPDATE_INSTANT_GAME_STATE

fun()|nil

Event triggers when the player queues an instance.

Field: UPDATE_ITEM_LOOK_CONVERT_MODE

fun()|nil

Event triggers when the player opens/closes the item infusion window.

Field: UPDATE_RESTORE_CRAFT_ORDER_ITEM_MATERIAL

fun(infos: ItemInfo)|nil

Event triggers when the player is attemping to revert a crafting order.

Field: UPDATE_RESTORE_CRAFT_ORDER_ITEM_SLOT

fun(info: CraftOrderInfo|nil)|nil

Event triggers when the player is attempting to revert a crafting order.

Field: UPDATE_RETURN_ACCOUNT_STATUS

fun(status: `1`|`2`|`3`)|nil

Event triggers when the player returns to the game after a month. https://na.archerage.to/forums/threads/returning-player-pack.10482/

Field: UPDATE_INSTANT_GAME_TIME

fun()|nil

Event triggers every 500ms while the player is inside an instance.

Field: UPDATE_PING_INFO

fun()|nil

Event triggers when the map has a ping update.

Field: UPDATE_NPC_INFO

fun()|nil

Event triggers when npc information for the map has changed.

Field: UPDATE_OPTION_BINDINGS

fun(overrided?: boolean, oldAction?: string, newAction?: string)|nil

Event triggers when the player opens the settings window and triggers when the player updates a setting.

Field: UPDATE_MONITOR_NPC

fun()|nil

Event triggers when a montiored npc updates for the map.

Field: UPDATE_MY_SLAVE_POS_INFO

fun()|nil

Event triggers every 5 seconds to update the players slave (vehicle) position information.

Field: SIEGEWEAPON_BOUND

fun(arg: number)|nil

Event triggers when the player mounts a siege weapon.

Field: TRADE_UNLOCKED

fun()|nil

Field: TRADE_STARTED

fun(targetName: string)|nil

Event triggers when the player starts trading with another player.

Field: START_QUEST_CONTEXT_NPC

fun(qtype: number, useDirectingMode: boolean, npcId: string)|nil

Event triggers when the player interacts with a npc that gives a quest with context,

Field: START_QUEST_CONTEXT_DOODAD

fun(qtype: number, useDirectingMode: boolean, doodadId: number)|nil

Event triggers when the player starts a quest with a context doodad.

Field: START_QUEST_CONTEXT_SPHERE

fun(qtype: number, stype: number)|nil

Event triggers when the player enters a quest sphere and a quest starts.

Field: START_SENSITIVE_OPERATION

fun(remainTime: any)|nil

Field: START_TALK_QUEST_CONTEXT

fun(doodadId: any)|nil

Field: START_QUEST_CONTEXT

fun(qtype: any, useDirectingMode: any, npcId: any)|nil

Field: START_CHAT_BUBBLE

fun(arg: string)|nil

Event triggers when the player interacts with a npc that starts a chat bubble.

Field: START_HERO_ELECTION_PERIOD

fun()|nil

Field: SPELLCAST_SUCCEEDED

fun(caster: "player"|"target"|"targettarget"|"watchtarget")|nil

Event triggers when a local unit successfully casts a spell.

Field: STARTED_DUEL

fun()|nil

Field: SPELLCAST_STOP

fun(caster: "player"|"target"|"targettarget"|"watchtarget")|nil

Event triggers when a local unit stops casting a spell.

Field: START_TODAY_ASSIGNMENT

fun(stepName: any)|nil

Event triggers when the player opens a daily assignment.

Field: STILL_LOADING

fun(loadingProgress: any)|nil

Field: STORE_SOLD_LIST

fun(soldItems: ItemInfo[])|nil

Event triggers when the player accesses a merchant or when the merchants sold list updates.

Field: STORE_TRADE_FAILED

fun()|nil

Event triggers when the player attempts to purchase an item from a store and their bag is full.

Field: SURVEY_FORM_UPDATE

fun()|nil

Field: STICKED_MSG

fun()|nil

Field: STORE_SELL

fun(itemLinkText: string, stackCount: number)|nil

Event triggers when the player has sold an item to a merchant.

Field: STORE_BUY

fun(itemLinkText: string, stackCount: number)|nil

Event triggers when the player buys an item from merchant.

Field: STORE_FULL

fun()|nil

Event triggers when the player attempts to purchase an item from a store and their bag is full.

Field: STORE_ADD_BUY_ITEM

fun()|nil

Field: STORE_ADD_SELL_ITEM

fun(slotNumber: number)|nil

Event triggers when the player attempts to sell an item a merchant.

Field: SWITCH_ENCHANT_ITEM_MODE

fun(mode: "awaken"|"element"|"evolving"|"evolving_re_roll"|"gem"...(+7))|nil

Event triggers when the player changes their enchanting mode.

Field: SPELLCAST_START

fun(spellName: string, castingTime: number, caster: "player"|"target"|"targettarget"|"watchtarget", castingUseable: boolean)|nil

Event triggers when a local unit starts casting a spell.

Field: SPECIALTY_RATIO_BETWEEN_INFO

fun(specialtyRatioTable: SpecialtyRatioInfo[])|nil

Event triggers when the player checks the specialty ratio between two zones.

Field: SKILL_ALERT_ADD

fun(statusBuffType: `10`|`11`|`12`|`13`|`14`...(+16), buffId: number, remainTime: number, name: "Bleed (All)"|"Bubble Trap"|"Charmed"|"Deep Freeze"|"Enervate"...(+16))|nil

Event triggers when the player receives a status debuff.

Field: SKILLS_RESET

fun(ability: "adamant"|"assassin"|"death"|"fight"|"hatred"...(+9))|nil

Event triggers when the player resets a skill tree.

Field: SKILL_ALERT_REMOVE

fun(statusBuffType: `10`|`11`|`12`|`13`|`14`...(+16))|nil

Event triggers when the players status debuff is gone.

Field: SKILL_CHANGED

fun(text: string, level: number, ability: "adamant"|"assassin"|"death"|"fight"|"hatred"...(+9))|nil

Event triggers when the players skill level changes.

Field: SKILL_LEARNED

fun(text: string, skillType: "buff"|"skill")|nil

Event triggers when the player learns a skill.

Field: SIM_DOODAD_MSG

fun(code?: any)|nil

Field: SIEGE_RAID_TEAM_INFO

fun(info: SiegeRaidInfo)|nil

Event triggers when the player attempts to apply to a siege raid.

Field: SIEGE_WAR_ENDED

fun()|nil

Field: SIEGE_APPOINT_RESULT

fun(isDefender: any, faction: any)|nil

Field: SIEGE_RAID_REGISTER_LIST

fun(zoneGroupType?: any, bRegistState?: any, bListUpdate?: any)|nil

Event triggers when a siege raid is created.

Field: SPECIAL_ABILITY_LEARNED

fun(recvAbility: number)|nil

Event triggers when the player learns to transform.

Field: SKILL_MAP_EFFECT

fun(info: SkillMapEffectInfo)|nil

Event triggers when the worldmap has an effect that that needs to be shown.

Field: SKILL_SELECTIVE_ITEM

fun(list: SkillSelectiveItemList, usingSlotIndex: number)|nil

Event triggers when the player is trying tos select an item from a supply kit.

Field: SLAVE_SPAWN

fun()|nil

Event triggers when the player spawns a vehicle.

Field: SPAWN_PET

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`)|nil

Event triggers when the player spawns a pet.

Field: SPECIALTY_CONTENT_RECIPE_INFO

fun(list: any)|nil

Field: SKILL_MSG

fun(resultCode: "ALERT_OPTION"|"ALERT_OPTION_POPUP_DESC"|"ALERT_OPTION_POSITION_1_TEXT"|"ALERT_OPTION_POSITION_2_TEXT"|"ALERT_OPTION_POSITION_BASIC_TEXT"...(+202), param: string, skillType: number)|nil

Event triggers when the player uses as skill has a message.

Field: SLAVE_SHIP_UNBOARDING

fun()|nil

Field: SKILL_UPGRADED

fun(skillType: number, level: number, oldLevel: number)|nil

Event triggers when the players skill upgrades.

Field: SLAVE_SHIP_BOARDING

fun()|nil

Field: SKILL_SELECTIVE_ITEM_NOT_AVAILABLE

fun()|nil

Field: SKILL_SELECTIVE_ITEM_READY_STATUS

fun(status: boolean)|nil

Event triggers when the player attempts to open an item that has a selection.

Field: TRADE_UI_TOGGLE

fun()|nil

Field: SYNC_PORTAL

fun()|nil

Field: SYS_INDUN_STAT_UPDATED

fun()|nil

Event triggers when the player views the system status of a dungeon instance.

Field: TOWER_DEF_MSG

fun(towerDefInfo: TowerDefInfo)|nil

Event triggers when a tower defense message occurs.

Field: TOWER_DEF_INFO_UPDATE

fun()|nil

Event triggers when a tower defense information updates.

Field: TRADE_CANCELED

fun()|nil

Field: TRADE_CAN_START

fun(unitIdStr: any)|nil

Field: TRADE_ITEM_PUTUP

fun(inventoryIdx: number, amount: number)|nil

Event triggers when the player puts an item up for trade.

Field: TOGGLE_WALK

fun(speed: number)|nil

Event triggers when the player toggles walk.

Field: TOGGLE_RAID_FRAME_PARTY

fun(party: number, visible: boolean)|nil

Event triggers when a party in the raid is shown or hidden.

Field: TOGGLE_ROADMAP

fun()|nil

Event triggers when the roadmap size is changed.

Field: TOGGLE_RAID_FRAME

fun(show: boolean)|nil

Event triggers when the first raid frame is shown or hidden.

Field: TOGGLE_RAID_FRAME2

fun()|nil

Event triggers when the second raid frame is shown or hidden.

Field: TOGGLE_PORTAL_DIALOG

fun(addPortal: boolean, skillTypeNumber: number, itemTypeNumber: number)|nil

Event triggers when the player uses a teleport book.

Field: TRADE_ITEM_TOOKDOWN

fun(inventoryIdx: any)|nil

Field: TRADE_LOCKED

fun()|nil

Event triggers when the player locks their trade.

Field: TRADE_OTHER_LOCKED

fun()|nil

Event triggers when the other player being traded with locks their trade.

Field: TRADE_OTHER_MONEY_PUTUP

fun(money: any)|nil

Field: TRADE_OTHER_OK

fun()|nil

Event triggers when the other player being traded with confirms their trade.

Field: TRADE_ITEM_UPDATED

fun()|nil

Field: TRADE_OTHER_ITEM_TOOKDOWN

fun(otherIdx: any)|nil

Field: TRADE_OK

fun()|nil

Event triggers when the player confirms the trade.

Field: TRADE_OTHER_ITEM_PUTUP

fun(otherIdx: any, type: any, stackCount: any, tooltip: any)|nil

Field: TRADE_MADE

fun()|nil

Event triggers when a trade has been made.

Field: TRADE_MONEY_PUTUP

fun(money: string)|nil

Event triggers when the player puts up money on their trade.

Field: SYSMSG

fun(msg: string)|nil

Event triggers when there is a system message.

Field: TOGGLE_PET_MANAGE

fun()|nil

Field: TOGGLE_IN_GAME_NOTICE

fun(url: any)|nil

Field: TEAM_JOINT_BROKEN

fun()|nil

Event triggers when a co raid splits.

Field: TEAM_JOINT_BREAK

fun(requester: any, enable: any)|nil

Field: TEAM_JOINT_CHAT

fun()|nil

Field: TEAM_JOINT_RESPONSE

fun()|nil

Field: TEAM_JOINT_TARGET

fun(isJointable: any)|nil

Field: TEAM_JOINTED

fun()|nil

Event triggers when a raid joins another raid join.

Field: TARGET_OVER

fun(targetType: "doodad"|"nothing"|"ui"|"unit", unitId: string|number)|nil

Event triggers when the players mouse is over a target.

Field: TARGET_TO_TARGET_CHANGED

fun(stringId: string|nil, targetType: "doodad"|"nothing"|"ui"|"unit"|nil)|nil

Event triggers when the players target changes their target.

Field: TARGET_CHANGED

fun(stringId: string|nil, targetType: "housing"|"npc"|nil)|nil

Event triggers when the player targets a new unit.

Field: TARGET_NPC_HEALTH_CHANGED_FOR_DEFENCE_INFO

fun(curHp: any, maxHp: any)|nil

Field: TOGGLE_PARTY_FRAME

fun(show: boolean)|nil

Event triggers when the players party is shown or hidden.

Field: TEAM_MEMBERS_CHANGED

fun(reason: "joined"|"leaved"|"refreshed", value: TeamMember)|nil

Event triggers when the players team changes.

Field: TEAM_MEMBER_UNIT_ID_CHANGED

fun(oldStringId: string, stringId: string)|nil

Event triggers when a team members unit id changes.

Field: TOGGLE_CRAFT

fun()|nil

Field: TOGGLE_FACTION

fun()|nil

Field: TOGGLE_FOLLOW

fun(on: boolean)|nil

Event triggers when the player toggles follow on another player.

Field: TEAM_MEMBER_DISCONNECTED

fun(isParty: boolean, jointOrder: number, stringId: string, memberIndex: number)|nil

Event triggers when a player in the team is disconnected.

Field: TOGGLE_COMMUNITY

fun()|nil

Field: TIME_MESSAGE

fun(key: any, timeTable: any)|nil

Field: TOGGLE_CHANGE_VISUAL_RACE

fun(data: ChangeVisualRace)|nil

Event triggers when the player attempts to use a race change elixir.

Field: TEAM_ROLE_CHANGED

fun(jointOrder: number, memberIndex: number, role: `TMROLE_DEALER`|`TMROLE_HEALER`|`TMROLE_NONE`|`TMROLE_RANGED_DEALER`|`TMROLE_TANKER`)|nil

Event triggers when a player changes their team role.

Field: TEAM_SUMMON_SUGGEST

fun()|nil

Field: ZONE_SCORE_CONTENT_STATE

fun(states?: any)|nil

Event triggers when the zones content score changes.

Field: MAIL_INBOX_ATTACHMENT_TAKEN_ALL

fun(mailId: number)|nil

Event triggers when the player takes all from a mail.

Field: LOOT_PACK_ITEM_BROADCAST

fun(characterName: string, sourceName: string, useItemLink: string, resultItemLink: string)|nil

Event triggers when a player loots an item that broadcasts to the server.

Field: COMPLETE_QUEST_CONTEXT_NPC

fun(qtype: number, useDirectingMode: boolean, npcId: string)|nil

Event triggers when the player completes a npc context quest.

Field: COMPLETE_QUEST_CONTEXT_DOODAD

fun(qtype: number, useDirectingMode: boolean, doodadId: string)|nil

Event triggers when the player completes part of a quest doodad.

Field: CONVERT_TO_RAID_TEAM

fun()|nil

Event triggers when the players party is converted into a raid.

Field: COPY_RAID_MEMBERS_TO_CLIPBOARD

fun()|nil

Event triggers when the players copies raid members to their clipboard.

Field: CRAFTING_END

fun()|nil

Field: COMPLETE_CRAFT_ORDER

fun(info: CraftOrderInfo)|nil

Event triggers when the players craft order has been completed.

Field: COMMUNITY_ERROR

fun(msg: any)|nil

Event triggers when the player attempts to send a friend request to a player that does not exist, or attempts to block a character that is already blocked.

Field: COMPLETE_ACHIEVEMENT

fun(newAchievementType: number)|nil

Event triggers when the player completes an achievement.

Field: COMBAT_TEXT_SYNERGY

fun(arg: number)|nil

Event triggers when a skill has a combo effect.

Field: COMMON_FARM_UPDATED

fun()|nil

Event triggers whenever the players common (public) farm updates.

Field: COMBAT_TEXT_COLLISION

fun(targetUnitId: string, combatEvent: string, source: string, target: string, collisionSource: "COLLISION"|"DROWNING"|"FALLING", subType: `COLLISION_PART_BOTTOM`|`COLLISION_PART_FRONT`|`COLLISION_PART_REAR`|`COLLISION_PART_SIDE`|`COLLISION_PART_TOP`, mySlave: boolean, damage: number, powerType: "HEALTH"|"MANA")|nil

Event triggers when there is a collision.

Field: CRAFTING_START

fun(doodadId: any, count: any)|nil

Event triggers when the player opens the crafting window.

Field: CRAFT_ENDED

fun(leftCount: any)|nil

Event triggers when an item has been crafted.

Field: CRIME_REPORTED

fun(diffPoint: number, diffRecord: number, diffScore: number)|nil

Event triggers when the players crime has been reported.

Field: CREATE_ORIGIN_UCC_ITEM

fun()|nil

Field: DEBUFF_UPDATE

fun(action: "create"|"destroy", target: "character"|"mate"|"slave")|nil

Event triggers when a debuff is created or destroyed for a unit.

Field: DELETE_CRAFT_ORDER

fun()|nil

Event triggers when a crafting order has been removed.

Field: CRAFT_DOODAD_INFO

fun()|nil

Field: CRAFT_TRAINED

fun()|nil

Field: CRAFT_RECIPE_ADDED

fun()|nil

Field: CRAFT_STARTED

fun(leftCount: number)|nil

Event triggers when the player has started crafting.

Field: CRAFT_FAILED

fun(itemLinkText: string)|nil

Event triggers when the player fails to craft an item.

Field: CRAFT_ORDER_ENTRY_SEARCHED

fun(infos: CraftOrderEntries, totalCount: number, page: number)|nil

Event triggers when crafting order entries are requested.

Field: DELETE_PORTAL

fun()|nil

Event triggers when a portal has been deleted from the players teleport book.

Field: COMBAT_TEXT

fun(sourceUnitId: string, targetUnitId: string, amount: number, a: number, b: string, hitType: "CRITICAL"|"HIT"|"IMMUNE", d: number, e: boolean, f: number, g: boolean, distance: number)|nil

Field: COFFER_UPDATE

fun(bagId: number, slotId: number)|nil

Event triggers when the players coffer (storage chest) updates.

Field: CLEAR_HOUSING_INFO

fun()|nil

Event triggers when the housing information needs to be cleared from the map.

Field: CLEAR_GIVEN_QUEST_STATIC_INFO

fun()|nil

Event triggers when the given quest information needs to be cleared from the map.

Field: CLEAR_MY_SLAVE_POS_INFO

fun()|nil

Event triggers every 5 seconds to clear the players slave (vehicle) position information.

Field: CLEAR_NOTIFY_QUEST_INFO

fun()|nil

Event triggers when the notify quest information needs to be cleared from the map.

Field: CLEAR_NPC_INFO

fun()|nil

Event triggers when the npc information needs to be cleared from the map.

Field: CLEAR_FISH_SCHOOL_INFO

fun()|nil

Event triggers when the fish school information needs to be cleared from the map.

Field: CLEAR_CORPSE_INFO

fun()|nil

Event triggers when the player dies and when the player respawns or the players corpse information expires.

Field: CLEAR_DOODAD_INFO

fun()|nil

Event triggers when the player opens the map.

Field: CLEAR_CARRYING_BACKPACK_SLAVE_INFO

fun()|nil

Event triggers when the pack slave information needs to be cleared from the map.

Field: CLEAR_COMPLETED_QUEST_INFO

fun()|nil

Event triggers when the completed quest information needs to be cleared from the map.

Field: COMBAT_MSG

fun(targetUnitId: string, combatEvent: "ENVIRONMENTAL_DAMAGE"|"ENVIRONMENTAL_DRAIN"|"ENVIRONMENTAL_ENERGIZE"|"ENVIRONMENTAL_HEALED"|"ENVIRONMENTAL_LEECH"...(+14), source: string, target: string, ...any)|nil

Event triggers when a combat message occurs.

Field: CLEAR_SHIP_TELESCOPE_INFO

fun()|nil

Event triggers when the player stops using a ship telescope.

Field: CLOSE_CRAFT_ORDER

fun()|nil

Event triggers when the player creates a craft order.

Field: COFFER_TAB_REMOVED

fun()|nil

Event triggers when the player deletes a tab from the coffer (storage chest).

Field: COFFER_TAB_SORTED

fun(bagId: number)|nil

Event triggers when the player sorts the coffer (storage chest).

Field: COFFER_TAB_SWITCHED

fun(tabId: number)|nil

Event triggers when the player changes their coffer (storage chest) tab.

Field: CLEAR_TRANSFER_TELESCOPE_INFO

fun()|nil

Event triggers when the player stops using a telescope.

Field: COFFER_TAB_CREATED

fun()|nil

Event triggers when the player creates a tab for the coffer (storage chest).

Field: COFFER_INTERACTION_START

fun()|nil

Field: COFFER_REAL_INDEX_SHOW

fun(isRealSlotShow: any)|nil

Field: CLOSE_MUSIC_SHEET

fun()|nil

Event triggers when the player attempts to use sheet music.

Field: COFFER_INTERACTION_END

fun()|nil

Event triggers when the player interacts with something other than the coffer (storage chest).

Field: CLEAR_BOSS_TELESCOPE_INFO

fun()|nil

Event triggers when the boss telescope information needs to be cleared from the map.

Field: DESTROY_PAPER

fun()|nil

Event triggers when the player deletes a letter/book from their inventory.

Field: DIAGONAL_LINE

fun()|nil

Field: ENTERED_SUBZONE

fun(zoneName: ""|"3rd Corps Camp"|"Abandoned Claimstake"|"Abandoned Drill Camp"|"Abandoned Guardpost"...(+1163))|nil

Event triggers when the player enters a subzone.

Field: ENTERED_SCREEN_SHOT_CAMERA_MODE

fun()|nil

Event triggers when the player enters screenshot mode.

Field: ENTERED_WORLD

fun(unknown: boolean)|nil

Event triggers when the player enters the world.

Field: ENTER_ANOTHER_ZONEGROUP

fun(zoneId: `0`|`100`|`101`|`102`|`103`...(+151))|nil

Event triggers when the player enters another zone group.

Field: ENTER_ENCHANT_ITEM_MODE

fun(mode: "awaken"|"element"|"evolving"|"evolving_re_roll"|"gem"...(+7))|nil

Event triggers when the player attempts to enter enchanting mode.

Field: ENTERED_LOADING

fun(worldImagePath: string)|nil

Event triggers when the player enters a loading screen.

Field: END_QUEST_CHAT_BUBBLE

fun(playedBubble: boolean)|nil

Event triggers when the player talks to a npc with a quest chat bubble.

Field: ENTERED_INSTANT_GAME_ZONE

fun(arg: number)|nil

Event triggers when the player enters a instance.

Field: ENDED_DUEL

fun()|nil

Field: END_HERO_ELECTION_PERIOD

fun()|nil

Event triggers when the hero election period has ended.

Field: ENCHANT_SAY_ABILITY

fun()|nil

Field: ENTER_GACHA_LOOT_MODE

fun()|nil

Event triggers when the player opens the open chest (gold/silver/copper crate) window.

Field: EQUIP_SLOT_REINFORCE_EXPAND_PAGE

fun()|nil

Event triggers when the player expands their Ipnysh Artifacts pages.

Field: EQUIP_SLOT_REINFORCE_UPDATE

fun(equipSlot: any)|nil

Event triggers when the player increases the ipnysh level of an equipment slot.

Field: ESCAPE_END

fun()|nil

Event triggers when the player stops using the escape skill or the player has successfully escaped.

Field: ESCAPE_START

fun(waitTime: number)|nil

Event triggers when the player attempts to use the escape skill.

Field: ENTER_ITEM_LOOK_CONVERT_MODE

fun()|nil

Field: EQUIP_SLOT_REINFORCE_SELECT_PAGE

fun()|nil

Event triggers when the player changes their Ipnysh Artifacts page.

Field: EQUIP_SLOT_REINFORCE_MSG_LEVEL_UP

fun(equipSlot: `ES_ARMS`|`ES_BACKPACK`|`ES_BACK`|`ES_BEARD`|`ES_BODY`...(+27), level: number)|nil

Event triggers when the players ipnysh equipment slot levels up.

Field: EQUIP_SLOT_REINFORCE_MSG_SET_EFFECT

fun(equipSlotAttribute: number, level: number)|nil

Event triggers when the players ipnysh equipment slot levels up.

Field: EQUIP_SLOT_REINFORCE_MSG_CHANGE_LEVEL_EFFECT

fun()|nil

Field: EQUIP_SLOT_REINFORCE_MSG_LEVEL_EFFECT

fun(equipSlot: `ES_ARMS`|`ES_BACKPACK`|`ES_BACK`|`ES_BEARD`|`ES_BODY`...(+27), level: number)|nil

Event triggers when the players ipnysh equipment slot effect levels up.

Field: DIAGONAL_ASR

fun(itemName: string, itemGrade: `0`|`10`|`11`|`12`|`1`...(+8), askMarketPriceUi: boolean, values: DiagonalASRInfo)|nil

Event triggers when the market price of an item is requested.

Field: ENCHANT_RESULT

fun(resultCode: any, itemLink: any, oldGrade: any, newGrade: any, breakRewardItemType: any, breakRewardItemCount: any, breakRewardByMail: any)|nil

Field: ENABLE_TEAM_AREA_INVITATION

fun(enable: boolean)|nil

Event triggers when the player does a radius invite and when that radius invite is off cooldown.

Field: DOMINION_GUARD_TOWER_STATE_NOTICE

fun(key: `0`|`1`|`2`|`3`|`4`...(+2), name: string, factionName: string)|nil

Event triggers when the siege lodestones state changes.

Field: DOMINION

fun(action: string, zoneGroupName: string, expeditionName: string)|nil

Event triggers when the player events a siegable zone.

fun(unitId: any)|nil

Field: DOMINION_SIEGE_PARTICIPANT_COUNT_CHANGED

fun(count: number)|nil

Event triggers when the player joins a siege raid.

Field: DOMINION_SIEGE_PERIOD_CHANGED

fun(siegeInfo: SiegeInfo)|nil

Event triggers when the siege period changes.

Field: DIVE_START

fun()|nil

Event triggers when the player starts diving.

Field: DISMISS_PET

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`)|nil

Event triggers when the player dismisses a pet.

Field: DIVE_END

fun()|nil

Event triggers when the player stops diving.

Field: DICE_BID_RULE_CHANGED

fun(diceBidRule: `1`|`2`|`3`)|nil

Event triggers when the players bid type changes.

Field: DISCONNECTED_BY_WORLD

fun(title: string, body: string)|nil

Event triggers every 500ms when the player has disconnected from the world.

Field: ENCHANT_EXAMINE

fun()|nil

Field: DOMINION_SIEGE_SYSTEM_NOTICE

fun()|nil

Field: DOODAD_LOGIC

fun()|nil

Field: DYEING_START

fun()|nil

Event triggers when the player wants to start dying an item.

Field: DYNAMIC_ACTION_BAR_HIDE

fun()|nil

Event triggers when the player dynamic action bar (interaction bar) is hidden.

Field: DYNAMIC_ACTION_BAR_SHOW

fun(dynamicActionType: any)|nil

Event triggers when the player dynamic action bar (interaction bar) is shown.

Field: DOMINION_SIEGE_UPDATE_TIMER

fun(secondHalf: boolean)|nil

Event triggers every 500ms while a siege update is occuring.

Field: DYEING_END

fun()|nil

Event triggers when the player ends dying an item.

Field: DRAW_DOODAD_SIGN_TAG

fun(tooltip: nil)|nil

Event triggers when the player hovers over a doodad and the tooltip appears in the bottom right of the screen.

fun(info: DoodadTooltipInfo)|nil

Event triggers every frame the players mouse hovers a doodad.

Field: DOODAD_PHASE_MSG

fun(text: string)|nil

Event triggers when a doodad phase message occurs. (ex: Strength of the Faction message)

Field: DOODAD_PHASE_UI_MSG

fun(phaseMsgInfo: PhaseMsgInfo)|nil

Event triggers when a title UI message appears.

Field: ESC_MENU_ADD_BUTTON

fun(info: EscMenuAddButtonInfo)|nil

Event triggers when a new button is added to the escape menu.

Field: CHECK_TEXTURE

fun(texturePath: string)|nil

Field: CHAT_MSG_DOODAD

fun(message: string, author: string, authorId: string, isSelf: boolean, tailType: `CBK_NORMAL`|`CBK_SYSTEM`|`CBK_THINK`, showTime: number, fadeTime: number, currentBubbleType: number|nil, qtype: number|nil, forceFinished: boolean|nil)|nil

Event triggers when the player receives a chat message from a doodad/npc.

Field: AUCTION_CHARACTER_LEVEL_TOO_LOW

fun(msg: string)|nil

Event triggers when the player attempts to list an item or search for an item in the auction house and they are too low of a level.

Field: AUCTION_CANCELED

fun(itemName: string)|nil

Event triggers when the player cancels a listed item.

Field: AUCTION_ITEM_ATTACHMENT_STATE_CHANGED

fun(attached: boolean)|nil

Event triggers when a player is listing an item on the auction house.

Field: AUCTION_ITEM_PUT_UP

fun(itemName: string)|nil

Event triggers when a player is listing an item on the auction house.

Field: AUCTION_ITEM_SEARCH

fun()|nil

Event triggers when a player is listing or searching for an item on the auction house.

Field: AUCTION_BOUGHT_BY_SOMEONE

fun(itemName: string, moneyStr: string)|nil

Event triggers when the player sells something on the auction house.

Field: AUCTION_BIDDEN

fun(itemName: string, moneyStr: string)|nil

Event triggers when the player receives a bid on an item on the auction house.

Field: AUCTION_BOUGHT

fun()|nil

Event triggers when the player buys something on the auction house.

Field: ASK_FORCE_ATTACK

fun(forceAttackLevel: number)|nil

Event triggers when the player attempts to turn on bloodlust.

Field: AUCTION_BIDDED

fun(itemName: string, moneyStr: string)|nil

Event triggers when the player bids on an item on the auction house.

Field: ASK_BUY_LABOR_POWER_POTION

fun()|nil

Event triggers when the players labor is low and the game recommends they buy a labor potion from the market place.

Field: AUCTION_ITEM_SEARCHED

fun(clearLastSearchArticle: boolean)|nil

Event triggers when a player is listing or searching for an item on the auction house.

Field: AUCTION_PERMISSION_BY_CRAFT

fun(icraftType: number)|nil

Event triggers when a player has started crafting and after each craft end.

Field: BAG_ITEM_CONFIRMED

fun()|nil

Event triggers when the player receives an item to their bag.

Field: BAG_REAL_INDEX_SHOW

fun(isRealSlotShow: boolean)|nil

Field: BAG_TAB_CREATED

fun()|nil

Event triggers when the player creates a tab in their bag.

Field: AUCTION_LOWEST_PRICE

fun(itemType: number, grade: `0`|`10`|`11`|`12`|`1`...(+8), price: string)|nil

Event triggers when a player is listing an item on the auction house.

Field: BAG_EXPANDED

fun()|nil

Event triggers when the player expands their bag.

Field: BADWORD_USER_REPORED_RESPONE_MSG

fun(success: boolean)|nil

Event triggers when the player attempts to report a player for inappropriate language.

Field: BAD_USER_LIST_UPDATE

fun()|nil

Event triggers when the list of people who reported a suspicious user is updated.

Field: AUDIENCE_JOINED

fun(audienceName: string)|nil

Event triggers when a player joins the jury audience.

Field: AUDIENCE_LEFT

fun(audienceName: string)|nil

Event triggers when a player leaves the jury audience.

Field: BAG_TAB_REMOVED

fun()|nil

Event triggers when the player deletes a tab in their bag.

Field: APPELLATION_STAMP_SET

fun()|nil

Event triggers when the players stamp (name icon) changes.

Field: APPELLATION_CHANGED

fun(stringId: string, isChanged: boolean)|nil

Event triggers when a player changes their appellation.

Field: ACHIEVEMENT_UPDATE

fun(status: string|"update", newAchievementType: number)|nil

Event triggers when the player updates an achievement.

Field: ACCOUNT_RESTRICT_NOTICE

fun()|nil

Event triggers when the players account gets restricted.

Field: ACQUAINTANCE_LOGIN

fun(cmf: `CMF_ACQ_CONSUME_GROUP`|`CMF_ADDED_ITEM_GROUP`|`CMF_ADDED_ITEM_SELF`|`CMF_ADDED_ITEM_TEAM`|`CMF_ALL_SERVER`...(+60), charName: string)|nil

Event triggers when an acquaintance (guild member) logs in.

Field: ACTABILITY_EXPERT_CHANGED

fun(actabilityId: number, name: string, diff: string|number, final: string|number)|nil

Event triggers when the players proficiency changes.

Field: ACTABILITY_EXPERT_EXPANDED

fun()|nil

Event triggers when the player expands their maximum proficiency specializations.

Field: ACCOUNT_ATTENDANCE_LOADED

fun()|nil

Event triggers when dailies reset.

Field: ABILITY_SET_USABLE_SLOT_COUNT_CHANGED

fun()|nil

Event triggers when the players statsaver is expanded.

Field: ACCOUNT_ATTENDANCE_ADDED

fun()|nil

Event triggers when the player tracks their daily login.

Field: ABILITY_EXP_CHANGED

fun(expStr: string)|nil

Field: ABILITY_SET_CHANGED

fun(responseType: `1`|`2`|`3`)|nil

Event triggers when the players statsaver set is saved, changed, or deleted

Field: APPELLATION_GAINED

fun(str: string)|nil

Event triggers when the player gains a title.

Field: ACTABILITY_EXPERT_GRADE_CHANGED

fun(actabilityId: `10`|`11`|`12`|`13`|`14`...(+32), isUpgrade: boolean, name: "Alchemy"|"Artistry"|"Carpentry"|"Commerce"|"Construction"...(+32), gradeName: "Adept"|"Amateur"|"Authority"|"Celebrity"|"Champion"...(+7))|nil

Event triggers when the players proficiency level changes.

Field: ACTABILITY_REFRESH_ALL

fun()|nil

Event triggers when the players proficiencies need to be refreshed.

Field: ADD_GIVEN_QUEST_INFO

fun(type: `0`|`1`, questType: number)|nil

Event triggers when a new event has appeared with in the players range.

Field: ADD_NOTIFY_QUEST_INFO

fun(qType: number)|nil

Event triggers when the player has a quest notification info.

Field: ALL_SIEGE_RAID_TEAM_INFOS

fun(teamInfos: SiegeRaidTeamInfos)|nil

Event triggers when the player views the Siege Info tab when a siege period has started.

Field: ACTABILITY_MODIFIER_UPDATE

fun()|nil

Event triggers when the players proficiency modifiers are updated.

Field: ADDON_LOADED

fun()|nil

Event triggers when the addon has fully loaded.

Field: ACTION_BAR_PAGE_CHANGED

fun(page: number)|nil

Event triggers when the players action bar changes. (min: 1)

Field: ADDED_ITEM

fun(itemLinkText: string, itemCount: number, itemTaskType: number, tradeOtherName: string)|nil

Event triggers when an item has been added to the players inventory.

Field: ACTIONS_UPDATE

fun()|nil

Field: ACTION_BAR_AUTO_REGISTERED

fun(slotIndex: number)|nil

Event triggers when the players shortcut bar has a skill auto registered. (e.g. When the player is leveling and learns a skill and it auto registers to the players shortcut bar.)

Field: CHAT_MSG_QUEST

fun(message: string, author: string, authorId: string, isSelf: boolean, tailType: `CBK_NORMAL`|`CBK_SYSTEM`|`CBK_THINK`, showTime: number, fadeTime: number, currentBubbleType: number|nil, qtype: number|nil, forceFinished: boolean|nil)|nil

Event triggers when the player interacts with a npc that has a quest message.

Field: BAG_TAB_SORTED

fun(arg: number)|nil

Event triggers when the players sorts their bag.

Field: BAG_UPDATE

fun(bagId: number, slotId: number)|nil

Event triggers when the players bag updates.

Field: CANDIDATE_LIST_SHOW

fun()|nil

Field: CANDIDATE_LIST_SELECTION_CHANGED

fun()|nil

Field: CHANGED_MSG

fun()|nil

Field: CHANGE_ACTABILITY_DECO_NUM

fun()|nil

Field: CHANGE_CONTRIBUTION_POINT_TO_PLAYER

fun(isGain: boolean, diff: string, total: string)|nil

Event triggers when the player contributes a change to the guilds prestige.

Field: CANDIDATE_LIST_HIDE

fun()|nil

Field: CANCEL_REBUILD_HOUSE_CAMERA_MODE

fun()|nil

Event triggers when the player exists house preview mode for remodeling a building.

Field: CANDIDATE_LIST_CHANGED

fun()|nil

Field: BUY_SPECIALTY_CONTENT_INFO

fun(list: SpecialtyContentInfo[])|nil

Event triggers when the player opens the purchase cargo window.

Field: CANCEL_CRAFT_ORDER

fun(result: boolean)|nil

Event triggers when a crafting order has been canceled.

Field: BUTLER_UI_COMMAND

fun(mode: `ADD_GARDEN_MODE`|`CHANGE_LOOK_MODE`|`RECHARGE_COST_MODE`|`REGISTER_HARVEST_MODE`|`REGISTER_TRACTOR_MODE`...(+1))|nil

Event triggers if the player does something that activates the butler ui such as using vitalizing treats.

Field: CHANGE_CONTRIBUTION_POINT_TO_STORE

fun()|nil

Event triggers when the players guilds prestige changes.

Field: CHANGE_OPTION

fun(optionType: number, infoTable: ChangeOptionInfo)|nil

Event triggers when the player changes a Game Settings option.

Field: CHAT_LEAVED_CHANNEL

fun(channel: `CHAT_ALL_SERVER`|`CHAT_BIG_MEGAPHONE`|`CHAT_DAILY_MSG`|`CHAT_EXPEDITION`|`CHAT_FACTION`...(+22), name: string)|nil

Event triggers when the player leaves a channel.

Field: CHAT_MESSAGE

fun(channel: `CHAT_ALL_SERVER`|`CHAT_BIG_MEGAPHONE`|`CHAT_DAILY_MSG`|`CHAT_EXPEDITION`|`CHAT_FACTION`...(+22), relation: `UR_FRIENDLY`|`UR_HOSTILE`|`UR_NEUTRAL`, name: string, message: string, info: CHAT_MESSAGE_INFO)|nil

Event triggers when a chat message occurs.

Field: CHAT_MSG_ALARM

fun(text: string)|nil

Event triggers when a chat message alarm occurs.

Field: CHANGE_MY_LANGUAGE

fun()|nil

Event triggers when the player changes their language.

Field: CHAT_JOINED_CHANNEL

fun(channel: `CHAT_ALL_SERVER`|`CHAT_BIG_MEGAPHONE`|`CHAT_DAILY_MSG`|`CHAT_EXPEDITION`|`CHAT_FACTION`...(+22), name: string)|nil

Event triggers when the player joins a channel.

Field: CHAT_EMOTION

fun(message: string)|nil

Event triggers when a player does a chat emotion.

Field: CHAT_FAILED

fun(message: string, channelName: string)|nil

Event triggers when the player fails to send a chat message.

Field: CHANGE_VISUAL_RACE_ENDED

fun()|nil

Event triggers when the player changes race.

Field: CHAT_DICE_VALUE

fun(msg: string)|nil

Event triggers when a player uses /roll.

Field: BAG_TAB_SWITCHED

fun(tabId: number)|nil

Event triggers when the player changes the bag tab.

Field: BUTLER_INFO_UPDATED

fun(event: "equipment"|"garden"|"harvestSlot"|"labowPower"|"productionCost"...(+5), noError: boolean)|nil

Event triggers when the player is updating the farmhand.

Field: BUILDER_STEP

fun(step: "position"|"roation")|nil

Event triggers when the player is attempting to place something that can be built.

Field: BANK_UPDATE

fun(bagId: number, slotId: number)|nil

Event triggers when the players bank updates.

Field: BANK_TAB_SWITCHED

fun(tabId: number)|nil

Event triggers when the player changes the bank tab.

Field: BEAUTYSHOP_CLOSE_BY_SYSTEM

fun()|nil

Event triggers when the beautyshop is closed by the system. (e.g the player dies while in the beautyshop)

Field: BLESS_UTHSTIN_EXTEND_MAX_STATS

fun()|nil

Event triggers when the player increases their maximum stat migration limit.

Field: BLESS_UTHSTIN_ITEM_SLOT_CLEAR

fun()|nil

Event triggers when the players stat migration slot is clear.

Field: BANK_TAB_SORTED

fun()|nil

Event triggers when the player sorts their bank.

Field: BANK_TAB_CREATED

fun()|nil

Event triggers when the players creates a tab in their bank.

Field: BANK_TAB_REMOVED

fun()|nil

Event triggers when the player deletes a tab in their bank.

Field: BANK_EXPANDED

fun()|nil

Event triggers when the player expands their bank.

Field: BANK_REAL_INDEX_SHOW

fun(isRealSlotShow: boolean)|nil

Field: BUILD_CONDITION

fun(condition: BuildCondition)|nil

Event triggers when the player views the build condition of a community center.

Field: BLESS_UTHSTIN_ITEM_SLOT_SET

fun(msgapplycountlimit?: any)|nil

Event triggers when the player sets a item in the stat migration slot.

Field: BLESS_UTHSTIN_UPDATE_STATS

fun()|nil

Event triggers when the player changes their stat migration or activates a different stat migration.

Field: BUFF_SKILL_CHANGED

fun()|nil

Event triggers when the players buff/debuff/hidden buff that gives a skill for the dynamic shortcut changes.

Field: BUFF_UPDATE

fun(action: "create"|"destroy", target: "character"|"mate"|"slave")|nil

Event triggers when a buff is created or destroyed for a unit.

Field: BUILDER_END

fun()|nil

Event triggers when the player cancels trying to place something that can be built.

Field: BLESS_UTHSTIN_MESSAGE

fun(messageType: number)|nil

Event triggers when the players stat migration or ipnysh artifacts emmits a message.

Field: BOT_SUSPECT_REPORTED

fun(sourceName: string, targetName: string)|nil

Field: BLOCKED_USER_LIST

fun(msg: string)|nil

Event triggers when a user is added or removed from the players block list.

Field: BLOCKED_USER_UPDATE

fun()|nil

Event triggers when a user is added or removed from the players block list.

Field: BLESS_UTHSTIN_WILL_APPLY_STATS

fun(itemType: number, incStatsKind: `1`|`2`|`3`|`4`|`5`, decStatsKind: `1`|`2`|`3`|`4`|`5`, incStatsPoint: number, decStatsPoint: number)|nil

Event triggers when the player applies the stat migration item in the slot.

Field: BLOCKED_USERS_INFO

fun()|nil

Field: LP_MANAGE_CHARACTER_CHANGED

fun()|nil

Field: EVENT_SCHEDULE_START

fun(msg: any)|nil

Field: EXPEDITION_APPLICANT_ACCEPT

fun(expeditionName: string)|nil

Event triggers when the players application to a guild is accepted.

Field: HOUSE_STEP_INFO_UPDATED

fun(structureType: "housing"|"shipyard")|nil

Event triggers when a house is being built within range of the player.

Field: HOUSE_SET_SELL_SUCCESS

fun(houseName: string)|nil

Event triggers when the player successfully set the house to sell.

Field: HOUSE_TAX_INFO

fun(dominionTaxRate: any, hostileTaxRate: any, taxString: any, dueTime: any, prepayTime: any, weeksWithoutPay: any, weeksPrepay: any, isAlreadyPaid: any, isHeavyTaxHouse: any, depositString: any, taxType: any, id: any)|nil

Field: HOUSING_UCC_CLOSE

fun()|nil

Field: HOUSING_UCC_ITEM_SLOT_CLEAR

fun()|nil

Event triggers when the customization window slot is cleared.

Field: HOUSE_SET_SELL_FAIL

fun()|nil

Event triggers when the player fails to set the house to sell.

Field: HOUSE_ROTATE_CONFIRM

fun()|nil

Field: HOUSE_SALE_SUCCESS

fun(houseName: string)|nil

Event triggers when the player successfully sells a house.

Field: HOUSE_PERMISSION_UPDATED

fun()|nil

Event triggers when the player changes the building permissions.

Field: HOUSE_REBUILD_TAX_INFO

fun()|nil

Event triggers when the player opens the remodel window for their house.

Field: HOUSE_INTERACTION_START

fun(structureType: string, viewType: string, arg: boolean)|nil

Event triggers when the player starts interacting with the building.

Field: HOUSING_UCC_ITEM_SLOT_SET

fun()|nil

Event triggers when the player places a crest stamp in the housing ucc customization window slot.

Field: HOUSING_UCC_UPDATED

fun()|nil

Event triggers when the players housing ucc updates.

Field: INDUN_UPDATE_ROUND_INFO

fun()|nil

Event triggers when a instance round begins. (e.g. Noryette Challenge)

Field: INDUN_ROUND_START

fun(round: number, isBossRound: boolean)|nil

Event triggers when a instance round begins. (e.g. Noryette Challenge)

Field: INGAME_SHOP_BUY_RESULT

fun()|nil

Event triggers when the player attempts to purchase an item from the marketplace.

Field: INIT_CHRONICLE_INFO

fun()|nil

Event triggers when the player loads into the world to initalize the chronicle quest window.

Field: HOUSING_UCC_LEAVE

fun()|nil

Event triggers when the player leaves the house ucc customization window.

Field: INDUN_ROUND_END

fun(success: boolean, round: number, isBossRound: boolean, lastRound: boolean)|nil

Event triggers when a instance round ends. (e.g. Noryette Challenge)

Field: IME_STATUS_CHANGED

fun()|nil

Event triggers when the players ime status changes.

Field: INDUN_INITAL_ROUND_INFO

fun()|nil

Event triggers when a instance initial round starts. (e.g. Noryette Challenge)

Field: HPW_ZONE_STATE_CHANGE

fun(zoneId: `0`|`100`|`101`|`102`|`103`...(+151))|nil

Event triggers when the state of a zone changes.

Field: HPW_ZONE_STATE_WAR_END

fun(zoneId: `0`|`100`|`101`|`102`|`103`...(+151), points: number)|nil

Event triggers when a zones war state ends.

Field: INSERT_CRAFT_ORDER

fun()|nil

Event triggers when a crafting order is listed.

Field: HOUSE_INTERACTION_END

fun()|nil

Event triggers when the player ends interacting with the building.

Field: HOUSE_FARM_MSG

fun(name: any, total: any, harvestable: any)|nil

Field: HERO_RANK_DATA_RETRIEVED

fun(factionID: `101`|`102`|`103`|`104`|`105`...(+124))|nil

Event triggers when the player tries to retrieve hero information.

Field: HERO_NOTI

fun()|nil

Field: HERO_RANK_DATA_TIMEOUT

fun()|nil

Field: HERO_SCORE_UPDATED

fun()|nil

Event triggers when the players leadership increases.

Field: HERO_SEASON_OFF

fun()|nil

Event triggers when a hero season is over.

Field: HERO_ELECTION_VOTED

fun()|nil

Event triggers when the player casts their vote in a hero election,

Field: HERO_ELECTION_DAY_ALERT

fun(title: any, desc: any)|nil

Field: HERO_ELECTION_RESULT

fun()|nil

Event triggers when the hero election has results.

Field: HERO_CANDIDATE_NOTI

fun()|nil

Field: HERO_ELECTION

fun()|nil

Event triggers when the player opens the hero election list to cast a vote.

Field: HOUSE_INFO_UPDATED

fun()|nil

Field: HERO_SEASON_UPDATED

fun()|nil

Event triggers when a new hero season has begun.

Field: HIDE_SKILL_MAP_EFFECT

fun(index: number)|nil

Event triggers when the worldmap has an effect that that needs to be hidden.

Field: HOUSE_CANCEL_SELL_FAIL

fun()|nil

Event triggers when the player fails to cancel selling their house.

Field: HOUSE_CANCEL_SELL_SUCCESS

fun(houseName: string)|nil

Event triggers when the player successfully cancels selling their house.

Field: HOUSE_DECO_UPDATED

fun()|nil

fun(text: any)|nil

Event triggers when the roadmap tooltip is hidden.

Field: HOUSE_BUY_SUCCESS

fun(houseName: string)|nil

Event triggers when the player buys a house.

Field: HOUSE_BUILD_INFO

fun(hType: `100`|`101`|`102`|`103`|`104`...(+832), baseTax: string, hTax: string, heavyTaxHouseCount: number, normalTaxHouseCount: number, isHeavyTaxHouse: boolean, hostileTaxRate: number, monopolyTaxRate: number, depositString: string, taxType: `HOUSING_TAX_CONTRIBUTION`|`HOUSING_TAX_SEAL`, completion: boolean)|nil

Event triggers when the player attempts to place a building and the start construction window is shown/hidden.

Field: HOUSE_BUY_FAIL

fun()|nil

fun()|nil

Event triggers when the worldmap tooltip is hidden.

Field: HOTKEY_ACTION

fun(actionName: string, keyUp: boolean)|nil

Event triggers for the key down and key up when the player uses a hotkey that an addon has registered.

Field: HERO_CANDIDATES_ANNOUNCED

fun()|nil

Field: INSTANCE_ENTERABLE_MSG

fun(info: InstanceEnterableInfo)|nil

Event triggers when an instance is now enterable.

Field: INSTANT_GAME_END

fun()|nil

Event triggers when the instance game ends.

Field: LEAVE_ITEM_LOOK_CONVERT_MODE

fun()|nil

Event triggers when the player closes the item infusion window.

Field: LEAVE_GACHA_LOOT_MODE

fun()|nil

Event triggers when the player closes the open chest (gold/silver/copper crate) window.

Field: LEAVING_WORLD_CANCELED

fun()|nil

Event triggers if the player cancels leaving the world.

Field: LEAVING_WORLD_STARTED

fun(waitTime: number, exitTarget: `EXIT_CLIENT_NONE_ACTION`|`EXIT_CLIENT`|`EXIT_TO_CHARACTER_LIST`|`EXIT_TO_WORLD_LIST`, idleKick: boolean)|nil

Event triggers if the player is leaving the world.

Field: LEFT_LOADING

fun()|nil

Event triggers when the player is finished loading.

Field: LEAVE_ENCHANT_ITEM_MODE

fun()|nil

Event triggers when the player leaves enchanting mode.

Field: LABORPOWER_CHANGED

fun(diff: number, laborPower: number)|nil

Event triggers when the players labor changes.

Field: LEAVED_INSTANT_GAME_ZONE

fun()|nil

Event triggers when the player leaves the instance.

Field: JURY_OK_COUNT

fun(count: number, total: number)|nil

Event triggers when the jury count changes.

Field: JURY_WAITING_NUMBER

fun(num: number)|nil

Event triggers when the player is checking their current jury waiting number.

Field: ITEM_SOCKET_UPGRADE

fun(socketItemType: number)|nil

Event triggers when the player upgrades a socketed lunagem in an item.

Field: LEFT_SCREEN_SHOT_CAMERA_MODE

fun()|nil

Event triggers when the player leaves screenshot mode

Field: LEFT_WORLD

fun()|nil

Event triggers when the player leaves the world.

Field: LOOT_BAG_CHANGED

fun(setTime: boolean)|nil

Event triggers when the player opens the loot bag of a mob.

Field: LOOT_BAG_CLOSE

fun()|nil

Event triggers when the player closes the loot bag of a mob.

Field: LOOT_DICE

fun(charName: string, itemLinkText: string, diceValue: number)|nil

Event triggers when a player rolls for an item.

Field: LEFT_SUBZONE

fun(zoneId: `1000`|`1001`|`1002`|`1003`|`1004`...(+1351), zoneName: ""|"3rd Corps Camp"|"Abandoned Claimstake"|"Abandoned Drill Camp"|"Abandoned Guardpost"...(+1163))|nil

Event triggers when the player leaves a subzone.

Field: LOOTING_RULE_METHOD_CHANGED

fun(lootMethod: number)|nil

Event triggers when the raid leader sets the loot method rule.

Field: LOOTING_RULE_GRADE_CHANGED

fun(grade: number)|nil

Event triggers when the raid leader sets the loot grade rule.

Field: LOOTING_RULE_MASTER_CHANGED

fun(charName: string)|nil

Event triggers when the raid leader sets the loot master rule.

Field: LEVEL_CHANGED

fun(name: string, stringId: string)|nil

Event triggers when a players level changes.

Field: LOOTING_RULE_BOP_CHANGED

fun(rollForBop: number)|nil

Event triggers when the raid leader sets the loot bind on pick up rule.

Field: INSTANT_GAME_BEST_RATING_REWARD

fun()|nil

Field: ITEM_SOCKETING_RESULT

fun(resultCode: `1`, itemLink: string, socketItemType: number, install: boolean)|nil

Event triggers when the player sockets a lunagem into an item.

Field: ITEM_REFURBISHMENT_RESULT

fun(resultCode: `IGER_BREAK`|`IGER_DISABLE`|`IGER_DOWNGRADE`|`IGER_FAIL`|`IGER_GREAT_SUCCESS`...(+2), itemLink: string, beforeScale: string, afterScale: string)|nil

Event triggers when the player attempts to temper an item.

Field: INSTANT_GAME_ROUND_RESULT

fun(resultState: any, resultRound: any)|nil

Field: INSTANT_GAME_RETIRE

fun()|nil

Field: INSTANT_GAME_START

fun()|nil

Event triggers when an instance game starts.

Field: INSTANT_GAME_START_POINT_RETURN_MSG

fun(remainSec: number)|nil

Field: INSTANT_GAME_UNEARNED_WIN_REMAIN_TIME

fun(remainTime: any)|nil

Field: INSTANT_GAME_READY

fun()|nil

Event triggers when an instance game is ready.

Field: INSTANT_GAME_KILL

fun(msgInfo: InstanceGameKillInfo)|nil

Event triggers when a player kills another player in an instance.

Field: INSTANT_GAME_PICK_BUFFS

fun()|nil

Event triggers when the instance game pickable buffs is available.

Field: INSTANT_GAME_JOIN_APPLY

fun()|nil

Field: INSTANT_GAME_JOIN_CANCEL

fun()|nil

Event triggers when an instance queue has been canceled.

Field: ITEM_SMELTING_RESULT

fun(resultCode: any, itemLink: any, smeltingItemType: any)|nil

Field: INSTANT_GAME_WAIT

fun()|nil

Event triggers when the instance game is waiting.

Field: INTERACTION_START

fun()|nil

Field: ITEM_EQUIP_RESULT

fun(ItemEquipResult: `ITEM_MATE_NOT_EQUIP`|`ITEM_MATE_UNSUMMON`|`ITEM_SLAVE_NOT_EQUIP`|`ITEM_SLAVE_UNSUMMON`)|nil

Event triggers when the player attempt to equip an item to a mate/slave and it fails.

Field: ITEM_LOOK_CONVERTED

fun(itemLinkText: string)|nil

Event triggers when the player changes the image of an item.

Field: ITEM_LOOK_CONVERTED_EFFECT

fun(itemInfo: ItemInfo)|nil

Event triggers when the player changes the image of an item.

Field: INTERACTION_END

fun()|nil

Event triggers when the player stops interacting with something.

Field: ITEM_ENCHANT_MAGICAL_RESULT

fun(resultCode: number|`1`, itemLink: string, gemItemType: number)|nil

Event triggers when the player enchants an item with a lunastone.

Field: ITEM_ACQUISITION_BY_LOOT

fun(charName: string, itemLinkText: string, itemCount: number)|nil

Event triggers when a player acquires loot.

Field: ITEM_CHANGE_MAPPING_RESULT

fun(result: `ICMR_FAIL_DISABLE_ENCHANT`|`ICMR_FAIL`|`ICMR_SUCCESS`, oldGrade: `0`|`10`|`11`|`12`|`1`...(+8), oldGearScore: number, itemLink: string, bonusRate: number)|nil

Event triggers when the player attempts to awaken a item.

Field: INVALID_NAME_POLICY

fun(namePolicyType: any)|nil

Field: INVEN_SLOT_SPLIT

fun(invenType: string, slot: number, amount: number)|nil

Event triggers when the player starts to split items in their inventory.

Field: EVENT_SCHEDULE_STOP

fun(msg: any)|nil

Field: HERO_ANNOUNCE_REMAIN_TIME

fun(remainTime: number, isStartTime: boolean)|nil

Event triggers every 10 seconds when hero annoucement is about to happen.

Field: HEIR_SKILL_UPDATE

fun()|nil

Event triggers when the player changes an ancestral skill.

Field: FACTION_COMPETITION_RESULT

fun(infos: FactionCompetitionResultInfos)|nil

Event triggers when a faction competition is over. (e.g. Akasch Invasion/Mysthrane Gorge/Reedwind/Great Prairie/Cinderstone+Ynystere war)

Field: FACTION_COMPETITION_INFO

fun(info: FactionCompetitionInfo)|nil

Event triggers when the player enters a zone with a competition. (e.g. Akasch Invasion/Mysthrane Gorge/Reedwind/Great Prairie/Cinderstone+Ynystere war)

Field: FACTION_COMPETITION_UPDATE_POINT

fun(infos: FactionCompetitionPointInfo)|nil

Event triggers when a factions competition points (e.g. Akasch Invasion/Mysthrane Gorge/Reedwind/Great Prairie/Cinderstone+Ynystere war) update.

Field: FACTION_RELATION_ACCEPTED

fun(name: any, factionName: any)|nil

Field: FACTION_RELATION_CHANGED

fun(isHostile: boolean, f1Name: string, f2Name: string)|nil

Event triggers when a faction relation changes.

Field: FACTION_CHANGED

fun()|nil

Field: EXPIRED_ITEM

fun(itemLinkText: string)|nil

Event triggers when an item expires for the player.

Field: EXP_CHANGED

fun(stringId: string, expNum: number, expStr: string)|nil

Event triggers when the player receives experience.

Field: EXPEDITION_WAR_SET_PROTECT_DATE

fun()|nil

Event triggers when the players guild dominion protection date changes.

Field: EXPEDITION_WAR_STATE

fun(related: boolean, state: string, declarer: string, defendant: string, winner: string)|nil

Event triggers when a guild starts a dominion with another guild.

Field: EXPEDITION_WAR_KILL_SCORE

fun(toggle: boolean)|nil

Event triggers when the player views the current dominion status.

Field: FACTION_RELATION_COUNT

fun()|nil

Field: FACTION_RELATION_HISTORY

fun()|nil

Event triggers when the player views the alliance history of a faction.

Field: FAMILY_EXP_ADD

fun(amount: any)|nil

Field: FAMILY_INFO_REFRESH

fun()|nil

Field: FAMILY_LEVEL_UP

fun(levelName: any)|nil

Field: FACTION_RELATION_DENIED

fun(name: any)|nil

Field: FAMILY_ERROR

fun(msg: any)|nil

Field: FACTION_RENAMED

fun(isExpedition: boolean, oldName: string, newName: string)|nil

Event triggers if a nation or guild is renamed.

Field: FAILED_TO_SET_PET_AUTO_SKILL

fun(mateType: `MATE_TYPE_BATTLE`|`MATE_TYPE_NONE`|`MATE_TYPE_RIDE`)|nil

Event triggers when the player failed to set a pet auto skill. (e.g. Mount skill auto use/Battlepet not in defensive mode skill auto use)

Field: FACTION_RELATION_REQUESTED

fun(name: any, factionName: any)|nil

Field: FACTION_RELATION_WILL_CHANGE

fun(f1Name: string, f2Name: string)|nil

Event triggers when a faction relation will change.

Field: FAMILY_MEMBER

fun(owner: any, member: any, role: any, title: any)|nil

Field: EXPEDITION_WAR_DECLARATION_MONEY

fun(unitId: any, name: any, money: any)|nil

Field: EXPEDITION_SUMMON_SUGGEST

fun()|nil

Field: EXPEDITION_MANAGEMENT_APPLICANT_ACCEPT

fun(charId: any)|nil

Field: EXPEDITION_MANAGEMENT_APPLICANTS

fun(infos: ExpeditionApplicant[])|nil

Event triggers when a guild member (who has permissions) opens the manage applicants window.

Field: EXPEDITION_MANAGEMENT_APPLICANT_ADD

fun(expeditionId: any)|nil

Field: EXPEDITION_MANAGEMENT_APPLICANT_DEL

fun(expeditionId: any)|nil

Field: EXPEDITION_MANAGEMENT_APPLICANT_REJECT

fun(charId: any)|nil

Field: EXPEDITION_LEVEL_UP

fun(level: any)|nil

Field: EXPEDITION_EXP

fun(amount: number, amountStr: string)|nil

Event triggers when the player changes the guilds experience.

Field: EXPEDITION_HISTORY

fun(tabId: number)|nil

Event triggers when the player accesses their guild history.

Field: EXPEDITION_APPLICANT_REJECT

fun(expeditionName: string)|nil

Event triggers when the players application to a guild is rejected.

Field: EXPEDITION_BUFF_CHANGE

fun(expedition: number)|nil

Event triggers when a guilds buff changes.

Field: EXPEDITION_WAR_DECLARATION_FAILED

fun(errorMsg: any, param: any)|nil

Field: EXPEDITION_MANAGEMENT_GUILD_FUNCTION_CHANGED

fun()|nil

Field: EXPEDITION_MANAGEMENT_MEMBER_NAME_CHANGED

fun()|nil

Event triggers when a member of the players guild changes their name.

Field: EXPEDITION_MANAGEMENT_ROLE_CHANGED

fun()|nil

Field: EXPEDITION_MANAGEMENT_UPDATED

fun()|nil

Event triggers when the guild prestige changes.

Field: EXPEDITION_RANKING

fun()|nil

Field: EXPEDITION_MANAGEMENT_MEMBERS_INFO

fun(totalCount: number, startIndex: number, memberInfos: MemberInfo[])|nil

Event triggers when the player views the members tab in their guild.

Field: EXPEDITION_MANAGEMENT_RECRUITMENT_DEL

fun(expeditionId: any)|nil

Field: EXPEDITION_MANAGEMENT_RECRUITMENTS

fun(total: number, perPageItemCount: number, infos: GuildRecruitmentInfo[])|nil

Event triggers when the player opens the guild recruitment tab.

Field: EXPEDITION_MANAGEMENT_RECRUITMENT_ADD

fun(info: any)|nil

Field: EXPEDITION_MANAGEMENT_MEMBER_STATUS_CHANGED

fun()|nil

Event triggers when the prestige of a guild member changes.

Field: EXPEDITION_MANAGEMENT_POLICY_CHANGED

fun()|nil

Field: HERO_ALL_SCORE_UPDATED

fun(factionID: `101`|`102`|`103`|`104`|`105`...(+124))|nil

Event triggers when the player tries to retrieve hero information or hero mission status.

Field: FAMILY_MEMBER_ADDED

fun(owner: any, member: any, title: any)|nil

Field: FAMILY_MEMBER_LEFT

fun(member: any)|nil

Field: GUARDTOWER_HEALTH_CHANGED

fun(arg1: string, arg2: string, arg3: string)|nil

Event triggers when a guard tower health changes.

Field: GRADE_ENCHANT_RESULT

fun(resultCode: `IGER_BREAK`|`IGER_DISABLE`|`IGER_DOWNGRADE`|`IGER_FAIL`|`IGER_GREAT_SUCCESS`...(+2), itemLink: string, oldGrade: `0`|`10`|`11`|`12`|`1`...(+8), newGrade: `0`|`10`|`11`|`12`|`1`...(+8), breakRewardItemType: number, breakRewardItemCount: number, breakRewardByMail: boolean)|nil

Event triggers when the player regrades an item.

Field: GUILD_BANK_INTERACTION_END

fun()|nil

Event triggers when the player ends interacting with their guild bank.

Field: GUILD_BANK_INTERACTION_START

fun()|nil

Field: GUILD_BANK_INVEN_SHOW

fun()|nil

Event triggers when the guild bank is shown to the player.

Field: GRADE_ENCHANT_BROADCAST

fun(characterName: string, resultCode: `IEBCT_ENCHANT_GREATE_SUCCESS`|`IEBCT_ENCHANT_SUCCESS`|`IEBCT_EVOVING`, itemLink: string, oldGrade: `0`|`10`|`11`|`12`|`1`...(+8), newGrade: `0`|`10`|`11`|`12`|`1`...(+8))|nil

Event triggers when a player successfully enchants an item to a new grade.

Field: GOODS_MAIL_SENT_SUCCESS

fun()|nil

Field: GOODS_MAIL_WRITE_ITEM_UPDATE

fun()|nil

Field: GOODS_MAIL_RETURNED

fun()|nil

Field: GOODS_MAIL_SENTBOX_UPDATE

fun()|nil

Field: GOODS_MAIL_INBOX_UPDATE

fun(read: boolean, arg: number)|nil

Event triggers when the players marketplace mail updates.

Field: GUILD_BANK_MONEY_UPDATE

fun()|nil

Field: GUILD_BANK_TAB_CREATED

fun()|nil

Event triggers when the player creates a tab for their guild bank.

Field: HEIR_SKILL_ACTIVE_TYPE_MSG

fun(activeType: number, ability: number, text: string, pos: `1`|`2`|`3`|`4`|`5`...(+3))|nil

Field: HEIR_SKILL_LEARN

fun(text: string, pos: `1`|`2`|`3`|`4`|`5`...(+3))|nil

Event triggers when the player changes an ancestral skill.

Field: HEIR_SKILL_RESET

fun(isAll: boolean, text: string, info: `1`|`2`|`3`|`4`|`5`...(+3))|nil

Event triggers when the player resets an ancestral skill.

Field: GUILD_BANK_REAL_INDEX_SHOW

fun()|nil

Field: HEIR_LEVEL_UP

fun(myUnit: boolean, unitId: string)|nil

Event triggers when a players acestral level increases.

Field: GUILD_BANK_TAB_SWITCHED

fun()|nil

Event triggers when the player changes their guild bank tab.

Field: GUILD_BANK_UPDATE

fun(arg1: number, slot: number)|nil

Event triggers when the player takes/places an item into their guild bank.

Field: GUILD_BANK_TAB_REMOVED

fun()|nil

Event triggers when the player deletes a tab from their guild bank.

Field: GUILD_BANK_TAB_SORTED

fun()|nil

Event triggers when the player sorts their guild bank.

Field: FAMILY_MEMBER_KICKED

fun(member: any)|nil

Field: GOODS_MAIL_INBOX_TAX_PAID

fun()|nil

Field: GOODS_MAIL_INBOX_ITEM_TAKEN

fun(index: any)|nil

Event triggers when the player takes an item from their marketplace mailbox.

Field: FIND_FACTION_REZ_DISTRICT_COOLTIME_FAIL

fun(cooltime: number)|nil

Event triggers when the player (as a hero) tries to activate a respawn location that is not available yet due to a cooltime.

Field: FAMILY_REMOVED

fun()|nil

Field: FIND_FACTION_REZ_DISTRICT_DURATION_FAIL

fun(remain: number)|nil

Event triggers when the player (as a hero) tries to activate a respawn location that is already in use.

Field: FOLDER_STATE_CHANGED

fun(arg: string)|nil

Event triggers when the player changes the state of a folder.

Field: FORCE_ATTACK_CHANGED

fun(uiserId: string, inBloodlust: boolean)|nil

Event triggers when a player toggles bloodlust mode.

Field: FAMILY_REFRESH

fun()|nil

Field: FAMILY_NAME_CHANGED

fun(FAMILY_NAME_CHANGED: any)|nil

Field: FAMILY_OWNER_CHANGED

fun(owner: any)|nil

Field: FAMILY_MEMBER_ONLINE

fun()|nil

Field: FAMILY_MGR

fun()|nil

Field: GOODS_MAIL_INBOX_MONEY_TAKEN

fun()|nil

Field: FRIENDLIST

fun(msg: string)|nil

Event triggers when the player sends a friend request.

Field: FRIENDLIST_UPDATE

fun(updateType: "delete"|"insert", dataField: string|FriendInfo)|nil

Event triggers when the players friend list updates.

Field: GAME_SCHEDULE

fun()|nil

Field: GENDER_TRANSFERED

fun()|nil

Event triggers when the player changes their characters gender.

Field: GLIDER_MOVED_INTO_BAG

fun()|nil

Event triggers when the player picks up something that moves their glider into their bag.

Field: FRIENDLIST_INFO

fun(totalCount: number, memberInfos: FriendInfo[])|nil

Event triggers when the player opens their friend list.

Field: GAME_EVENT_INFO_REQUESTED

fun()|nil

Event triggers when the player opens the daily schedule window after loading into the world.

Field: GAME_EVENT_EMPTY

fun()|nil

Field: GAME_EVENT_INFO_LIST_UPDATED

fun()|nil

Event triggers when the player opens the daily schedule window.

Field: GACHA_LOOT_PACK_LOG

fun(logs: GachaLootPackLog)|nil

Event triggers when the player opens a locked crate.

Field: GACHA_LOOT_PACK_RESULT

fun(results: GachaLootPackResult)|nil

Event triggers when the player opens a locked crate.

Field: ZONE_SCORE_UPDATED

fun(kind: any, info: any)|nil

Class: EvolvingInfo

Field: evolveChance

number

Field: modifier

EvolvingInfoModifier[]

Field: minSectionExp

number

Field: minExp

number

Field: percent

number

Class: EvolvingInfoModifier

Field: gsNum

number

Field: type

number

Field: value

number

Class: ExpeditionApplicant

Field: day

number

Field: month

number

Field: name

string

Field: memo

string

Field: heirLevel

number

Field: level

number

Field: year

number

Class: FactionCompetitionInfo

Field: zoneIn

boolean

Class: FactionCompetitionPointInfo

Field: pointList

FactionPointInfo[]

Class: FactionCompetitionResultInfos

Field: pointList

FactionPointInfo[]

Field: winFaction

`101`|`102`|`103`|`104`|`105`...(+124)

api/Addon db > system_factions

Class: FactionPointInfo

Field: factionId

`101`|`102`|`103`|`104`|`105`...(+124)

api/Addon db > system_factions

Field: point

number

Class: FontSizeList

Field: cinema

number

Field: small

number

Field: xlarge

number

Field: middle

number

Field: default

number

Field: large

number

Field: xxlarge

number

Class: FrameInfo

Field: alpha

number|nil

Field: showTime

number|nil

Field: scale

number|nil

Field: time

number|nil

Field: w

number|nil

Field: x

number|nil

Field: moveY

number|nil

Field: h

number|nil

Field: moveX

number|nil

Field: animTime

number|nil

Field: animType

`DAT_LINEAR_ALPHA`|`DAT_LINEAR_SCALE`|`DAT_MOVE`|`LAT_AFTERIMAGE`|`LAT_COUNT`...(+5)

This can add multiple LINEAR_ANIMATION_TYPE

Field: y

number|nil

Class: FriendInfo

Field: [10]

number|nil

CHK

Field: [5]

`RACE_DARU`|`RACE_DWARF`|`RACE_ELF`|`RACE_FAIRY`|`RACE_FERRE`...(+5)

api/X2Unit

Field: [6]

boolean

Online

Field: [7]

boolean

Party

Field: [8]

number

Ancestral Level

Field: [4]

Time

Last login

Field: [2]

number

Basic Level

Field: [3]

UnitClass

Class

Field: [1]

string

Name

Field: [9]

`101`|`102`|`103`|`104`|`105`...(+124)

Faction

Class: GachaLootPackItemLog

Field: itemGrade

`0`|`10`|`11`|`12`|`1`...(+8)

Field: itemType

number

Field: stackSize

number

Class: GachaLootPackItemResult

Field: grade

`0`|`10`|`11`|`12`|`1`...(+8)

Field: linkText

string

Field: stackSize

number

Class: GachaLootPackLog

Field: [1]

GachaLootPackItemLog

Gold

Field: [2]

GachaLootPackItemLog

Item

Class: GachaLootPackResult

Field: [1]

GachaLootPackItemResult

Gold

Field: [2]

GachaLootPackItemResult

Item

Class: GearScoreItemInfo

Field: bare

number

Field: equipSlotReinforce

number

Field: total

number

Class: GroupInfo

Field: anyTime

boolean

Field: toHH

number

Field: toMM

number

Field: fromMM

number

Field: fromHH

number

Field: weekInfoList

number[]

Class: GuildInterests

Field: [1]

number

Dungeon

Field: [4]

number

Raid

Field: [5]

number

Adventure

Field: [3]

number

Naval Battles

Field: [2]

number

War

Field: [6]

number

Crafting

Class: GuildRecruitmentInfo

Field: apply

boolean

Field: introduce

string

Field: memberCount

number

Field: owner_name

string

Field: pull

boolean

Full

Field: interests

GuildInterests

Field: expedition_level

number

Field: expedition_name

string

Field: expeditionId

number

Field: remainTime

number

Class: HotKeyInfo

Field: featureSet

string

Field: restart

boolean

Field: title

string

Field: hotkeyActionName

string

Field: featureSetCondition

boolean

string

Class: HousingTaxInfo

Field: base_tax

number

Field: tax_type

number

Field: deposit

number

Field: count

number

Field: total_tax

number

Class: InsetData

Extends number

Field: [1]

number|nil

Left

Field: [3]

number|nil

Bottom

Field: [2]

number|nil

Top

Field: [4]

number|nil

Right

Class: InstanceByKind

Field: globalArena

boolean

Field: showFestivalIcon

boolean

Field: type

number

Field: memberCount

number[]

Field: globalField

boolean

Field: uiKey

string

Class: InstanceEnterableInfo

Field: content

string

Field: iconKey

string

Field: title

string

Class: InstanceGameKillInfo

Field: killer

string

Field: ruleMode

number

Field: victim

string

Field: victimCorps

string

Field: killerKillstreak

number

Field: killerCorps

string

Field: killerCorpsKill

number

Field: victimCorpsDeath

number

Class: InstanceUiKind

Field: listButtonPath

string

Field: showHonorStore

boolean

Field: name

string

Field: type

number

Class: InstanceZoneInfo

Field: uiKey

string

Field: zoneKey

number

Field: zoneName

string

Class: InvalidLinkInfo

Extends BaseLinkInfo, CommonLinkFields

Field: filter

number

Field: linkType

"invalid"

Field: isOtherWorld

boolean

Field: messageTimeStamp

number

Class: ItemData

Extends ItemTree

Field: child

ItemTree[]|nil

Field: subColor

RGBAColor|nil

Field: selectColor

RGBAColor|nil

Requires useColor = true.

Field: overColor

RGBAColor|nil

Requires useColor = true.

Field: subtext

string|nil

Only renders if subColor is defined.

Field: tailIconPath

string|nil

Field: tailIconCoord

string|nil

Field: text

string|nil

Field: useColor

boolean|nil

if true defaultColor, selectColor, overColor, disableColor, and color need to all be set or they will be invisible.

Field: opened

boolean|nil

(default: false)

Field: indexing

number[]

{ parentIndex[, childIndex…] } (min: 0)

Field: defaultColor

RGBAColor|nil

Requires useColor = true.

Field: color

RGBAColor|nil

Requires useColor = true.

Field: infoKey

string|nil

Field: disableColor

RGBAColor|nil

Requires useColor = true.

Field: iconPath

string|nil

Field: enable

boolean|nil

true to enable, false to disable. (default: true)

Field: value

number|nil

Class: ItemInfo

Field: DPS

number

Field: lookChanged

boolean

Field: lookType

number

Field: longitudeSec

number

Field: longitudeMin

number

Field: longitudeDir

"E"|"W"

Field: magicDps

number

Field: maxDamage

number

Field: maxStack

number

Field: magicResistance

number

Field: maxSetItemCount

number

Field: maxDurability

number

Field: minDamage

number

Field: longitudeDeg

number

Field: location_zone_name

string

Field: level_limit

number

Field: level_requirement

number

Field: level

number

Field: latitudeSec

number

Field: locked

boolean

Field: lifeSpan

number

Field: lifeSpanType

string

Field: location_world_name

string

Field: lifeSpanDayOfWeek

boolean

Field: livingPointPrice

number

Field: linkKind

"auciton"|"coffer"|"guildBank"|nil

Field: latitudeMin

number

Field: modifier

ModifireTable[]

Field: name

string

Field: socketInfo

SocketInfo

Field: soul_bind

string

Field: slotTypeNum

number

Field: slotType

string

Field: skillType

number

Field: soul_bind_type

number

Field: stack

number

Field: useAsStat

boolean

Field: soul_bound

number

Field: useAsSkin

boolean

Field: uccTooltip

string

Field: moveSpeed

number

Field: sideEffect

boolean

Field: sellable

boolean

Field: pinned

boolean

Field: processedState

string

Field: overIcon

string

Field: needsUnpack

boolean

Field: setItems

SetItemsInfo[]

Field: rechargeBuff

RechargeBuffInfo

Field: repairable

number

Field: securityState

`ITEM_SECURITY_INVALID`|`ITEM_SECURITY_LOCKED`|`ITEM_SECURITY_UNLOCKED`|`ITEM_SECURITY_UNLOCKING`

api/X2Item

Field: refund

number

Field: scalable

boolean

Field: requiredCondition

RequiredConditionInfo

Field: useConsumeItem

boolean

Field: latitudeDir

"N"|"S"

Field: item_impl

"accessory"|"armor"|"butler_armor"|"enchanting_gem"|"itemGrade"...(+11)

Field: crafter

string

Field: dead

boolean

Field: craftedWorldName

string

Field: craftType

number

Field: cost

number

Field: description

string

Field: element

string

Field: equiped

boolean

Field: durability

number

Field: equipSetInfo

EquipSetInfo

Field: elementName

string

Field: equippedSetItemCount

number

Field: convertibleItem

boolean

Field: checkUnitReq

boolean

Field: attackDelay

number

Field: auction_only

boolean

Field: armorType

string

Field: armor

number

Field: contributionPointPrice

number

Field: backpackType

number

Field: buffType

number

Field: category_id

number

Field: baseEquipment

boolean

Field: category

string

Field: canEvolve

boolean

Field: latitudeDeg

number

Field: evolvingCategory

boolean

Field: extraArmor

number

Field: isMyWorld

boolean

Field: isPetOnly

boolean

Field: isMaterial

boolean

Field: isEnchantDisable

boolean

Field: indestructible

boolean

Field: isStackable

boolean

Field: itemGrade

number

Field: item_flag_cannot_equip

boolean

Field: isUnderWaterCreature

boolean

Field: itemUsage

string

Field: itemType

number

Field: evolvingInfo

EvolvingInfo

Field: icon

string

Field: healDps

number

Field: gemInfo

number

Field: gemModifireTable

ModifireTable[]

Field: gearScore

GearScoreItemInfo

Field: extraDPS

number

Field: honorPrice

number

Field: gender

string

Field: gradeColor

string

Field: grade

string

Field: gradeIcon

string

Field: gradeEnchantable

boolean

Field: wear

boolean

Class: ItemLinkInfo

Extends BaseLinkInfo, CommonLinkFields

Field: filter

number

Field: linkKind

`1`|`2`|`3`

Field: linkType

"item"

Field: itemLinkText

string

Field: isOtherWorld

boolean

Field: itemGrade

`0`|`10`|`11`|`12`|`1`...(+8)

Field: messageTimeStamp

number

Class: ItemMaterialInfo

Field: count

number

Field: item

ItemInfo

Class: ItemTree

Field: child

ItemTree[]|nil

Field: subtext

string|nil

Only renders if subColor is defined.

Field: subColor

RGBAColor|nil

Field: selectColor

RGBAColor|nil

Requires useColor = true.

Field: tailIconCoord

string|nil

Field: text

string

Field: tailIconPath

string|nil

Field: useColor

boolean|nil

if true defaultColor, selectColor, overColor, disableColor, and color need to all be set or they will be invisible.

Field: overColor

RGBAColor|nil

Requires useColor = true.

Field: infoKey

string|nil

Field: defaultColor

RGBAColor|nil

Requires useColor = true.

Field: color

RGBAColor|nil

Requires useColor = true.

Field: opened

boolean|nil

(default: false)

Field: disableColor

RGBAColor|nil

Requires useColor = true.

Field: iconPath

string|nil

Field: enable

boolean|nil

true to enable, false to disable. (default: true)

Field: value

number

Class: ItemTreeInfos

Field: itemInfos

ItemTreeValue[]

Class: ItemTreeValue

Field: value

number

Class: ItemsInfo

Field: indexing

number[]

{ parentIndex[, childIndex…] } (min: 0)

Field: text

string

Field: opened

boolean

Field: value

number

Class: KillStreakInfo

Field: gameType

number

Field: param1

number

Field: param2

number

threeKillCount

Field: killerName

string

Field: killerKillStreak

number

Field: victimName

number

Class: LevelEffect

Field: attributeType

number

Field: unitModifierType

number

Field: triggerLevel

number

Field: isChangeable

boolean

Field: value

number

Class: LevelEffectChangeUIInfo

Field: item

ItemInfo

Field: levelEffectList

LevelEffect[]

Class: LevelEffectInfo

Field: attribute

number

Field: attributeKey

string

Field: value

number

Class: ListCtrlItem

Extends Window

Field: eventWindow

Window

Window

A Window widget represents a UI window with optional modal behavior, title text and styling, and layer management. It supports closing via the Escape key, custom title insets, and modal backgrounds.

Dependencies:

EmptyWidget used for the modalBackgroundWindow field.

TextStyle used for the titleStyle field.

Field: subItems

Button|SubItemString|Textbox|Window[]

Class: MemberInfo

Field: [10]

number

Ancestral Level

Field: [5]

table|Time

Connection Status (last active date or could be empty if the player is online)

Field: [4]

number

Guild Role

Field: [6]

string

Memo

Field: [7]

boolean

Online

Field: [8]

boolean

Party

Field: [3]

UnitClassNames

Class

Field: [1]

string

Name

Field: [2]

number

Basic Level

Field: [11]

number

Weekly Contribution Points

Field: [12]

any

CHK

Field: [9]

number

Contribution Points

Class: MiniScoreBoardInfo

Field: footer

string

Field: type

number

Field: rows

MiniScoreBoardRowInfo[]

Field: footerGuide

string

Field: visibleOrder

number

Class: MiniScoreBoardRowInfo

Field: curHp

number

Field: name

string

Field: type

number

Field: moduleType

number

Field: maxHp

number

Field: visibleOrder

number

Class: ModifireTable

Field: name

string

Field: type

number

Field: value

number

Class: MutedCharacter

Field: name

string

Field: unitName

string

Field: worldName

string

Class: NextSiegeInfo

Field: hour

number

Field: week

string

Field: min

number

Field: zoneGroupName

"Abyssal Library"|"Aegis Island"|"Ahnimar Event Arena"|"Ahnimar"|"Airain Rock"...(+143)

Class: NoneLinkInfo

Extends BaseLinkInfo

Field: linkType

"none"

Class: NpcBroadcastingInfo

Field: broadcastingType

`NIBC_BUFF_LEFT_TIME`|`NIBC_BUFF_STACK`

api/X2BattleField

Field: iconPath

string

Field: buffType

number

Field: buffName

string

Field: stack

number

Class: NuonsArrowUpdate

Field: charge

string

Field: step

string

Field: name

"Abyssal Library"|"Aegis Island"|"Ahnimar Event Arena"|"Ahnimar"|"Airain Rock"...(+143)

Field: zoneGroup

`0`|`100`|`101`|`102`|`103`...(+151)

Obtained from db zone_groups

Class: OptionInfo

Field: restart

boolean

Field: title

string

string

Class: PhaseMsgInfo

Field: color

string

Field: titleColor

string

Field: msg

string

Field: iconKey

string

Field: titleMsg

string

Class: Point

Field: beginX

number

Field: endX

number

Field: beginY

number

Field: endY

number

Class: QuestItem

Field: order

`QUEST_MARK_ORDER_DAILY_HUNT`|`QUEST_MARK_ORDER_DAILY`|`QUEST_MARK_ORDER_LIVELIHOOD`|`QUEST_MARK_ORDER_MAIN`|`QUEST_MARK_ORDER_NORMAL`...(+2)

api/X2Quest

Field: qtype

number

Class: QuestLinkInfo

Extends BaseLinkInfo, CommonLinkFields

Field: filter

number

Field: messageTimeStamp

number

Field: linkType

"quest"

Field: isOtherWorld

boolean

Field: questType

number

Class: QuestObjectiveText

Field: category

string

Field: npc_type

number

Field: status

string

Field: name

string

Field: done

number

Field: summary

string

Class: QuestSelectList

Field: gives

QuestItem[]

Class: RGBA

Field: a

number

Field: g

number

Field: b

number

Field: r

number

Class: RGBAColor

Field: [1]

number

Red (min: 0, max: 1)

Field: [3]

number

Blue (min: 0, max: 1)

Field: [2]

number

Green (min: 0, max: 1)

Field: [4]

number

Alpha (min: 0, max: 1)

Class: RadioItem

Extends EmptyWidget

Field: check

CheckButton

CheckButton

A CheckButton widget is a small clickable widget that represents a binary on/off or true/false setting or option. It inherits from Button and supports the same four visual states: normal, highlighted (hover), pushed (pressed), and disabled. Adds checked/unchecked state management with separate background drawables for checked and disabled-checked states. Can trigger the widget "OnCheckChanged" action.

Dependencies:

TextStyle used for the style field.

Class: RaidApplicant

Field: abilities

UnitClass

Field: name

string

Field: level

number

Field: gearPoint

number

Field: role

`TMROLE_DEALER`|`TMROLE_HEALER`|`TMROLE_NONE`|`TMROLE_RANGED_DEALER`|`TMROLE_TANKER`

api/X2Team

Class: RaidApplicantData

Field: applicantList

RaidApplicant[]

Field: headcount

number

Field: createTime

string

Field: autoJoin

boolean

Field: memberCount

number

Class: RaidLinkInfo

Extends BaseLinkInfo, CommonLinkFields

Field: createTime

string

Field: linkType

"raid"

Field: messageTimeStamp

number

Field: isOtherWorld

boolean

Field: filter

number

Field: ownerId

string

Class: RaidRecruitDetailInfo

Field: createTime

string

Field: ownerLevel

number

Field: ownerId

string

Field: ownerName

string

Field: subType

number

Field: subTypeName

string

Field: ownerExpedition

string

Field: minute

number

Field: hour

number

Field: msg

string

Field: limitGearPoint

number

Field: limitLevel

number

Field: type

number

Class: RaidRecruitInfo

Field: hour

number

Field: minute

number

Field: isRecruiter

boolean

Field: subTypeName

string

Class: RaidRecruitListInfo

Field: recruiter

boolean

Field: subRecruiter

boolean

Class: RaidRecruitSubType

Field: name

string

Field: subType

number

Class: RaidRecruitSubTypeInfo

Field: comment

string

Field: level

number

Field: name

string

Field: gearScoreLimitMax

number

Field: gearScore

number

Field: subType

number

Class: RaidRecruitType

Field: iconKey

string

Field: name

string

Field: type

number

Class: RechargeBuffInfo

Field: chargeLifetime

Time

Field: remainTime

Time

Class: ReentryParam

Field: [1]

boolean

reentry

Field: [2]

number

timeLeft in milliseconds

Field: [3]

string|nil

instanceName

Class: ReinforceInfo

Field: exp

number

Field: level

number

Field: isMaxLevel

boolean

Field: totalExp

number

Class: RequiredConditionInfo

Field: equipSlotTypes

string[]

Class: RequiredMaterialInfo

Field: currency

number

Field: itemList

ItemMaterialInfo[]

Field: materialType

number

Field: hasCashItem

boolean

Field: currencyValue

number

Field: gainExp

number

Field: name

string

Class: ResidentBoardContent

Field: [1]

string|nil

Field: contents

ResidentBoardContent

Field: faction

string

Field: [4]

string|nil

Field: [2]

string|nil

Field: [3]

string|nil

Field: title

string

Class: ResidentHousing

Field: decoextendnum

number

Field: posy

number

Field: posz

number

Field: price

number

Field: sellername

string

Field: posx

number

Field: division

string

Field: kind

string

Field: decolimitnum

number

Field: zoneId

`0`|`100`|`101`|`102`|`103`...(+151)

Obtained from db zone_groups

Class: ResidentInfo

Field: huntingCharge

number

Field: localFactionIcon

string

Field: memberCount

number|nil

Field: name

string

Field: refreshRemain

number|nil

Field: localFaction

string

Field: localCharge

string|nil

Field: localEffect

string

Field: isResident

boolean

Field: servicePoint

number|nil

Class: ResidentMember

Field: [1]

string

Name

Field: [6]

boolean

Party

Field: [7]

boolean

CHK

Field: [8]

number

Ancestral Level

Field: [5]

boolean

Online

Field: [3]

number

Contribution

Field: [4]

number

Family

Field: [2]

number

Basic Level

Field: [9]

number

Contribution Rank

Class: RewardInfo

Field: appellation

AppellationInfo

Field: item

RewardItemInfo

Class: RewardItemInfo

Field: count

number

Field: itemType

number

Class: SEXTANT

Field: deg_lat

number

Field: min_lat

number

Field: min_long

number

Field: sec_lat

number

Field: longitude

"E"|"W"

Field: deg_long

number

Field: latitude

"N"|"S"

Field: sec_long

number

Class: ScreenResolution

Field: scale

number

Field: x

number

width of screen

Field: y

number

height of screen

Class: SelectSquadList

Field: curPage

number

Field: listInfo

SquadInfo[]

Field: maxCount

number

Class: SellSpecialtyInfo

Field: count

number

Field: refundItemCount

number

Field: refundItemType

number

Field: sellerRatio

number

Field: specialtyZone

`0`|`100`|`101`|`102`|`103`...(+151)

Obtained from db zone_groups

Field: refund

string

Field: noEventRefund

string

Field: ratio

number

Field: freshnessRatio

number

Field: item

ItemInfo

Field: supply

SpecialtySupplyInfo

Class: SetEffect

Field: desc

string

Field: requiredLevel

number

Field: enable

boolean

Field: step

number

Class: SetItemsInfo

Field: equipped

boolean

Field: item_name

string

Field: item_type

number

Class: SiegeInfo

Field: action

"change_state"|"ignore"

Field: periodName

"siege_period_hero_volunteer"|"siege_period_peace"

Field: team

string

Field: zoneGroupName

"Abyssal Library"|"Aegis Island"|"Ahnimar Event Arena"|"Ahnimar"|"Airain Rock"...(+143)

Field: offenseName

string

Field: defenseName

string

Field: isMyInfo

boolean

Field: zoneGroupType

`0`|`100`|`101`|`102`|`103`...(+151)

Obtained from db zone_groups

Class: SiegeRaidInfo

Field: memberInfo

SiegeRaidMemberInfo[]

Field: zoneInfo

SiegeRaidZoneInfo

Class: SiegeRaidMemberInfo

Field: ability

`10`|`11`|`12`|`14`|`1`...(+11)[]

Field: level

number

Field: heirLevel

number

Field: gearScore

number

Field: name

string

Class: SiegeRaidScheduleInfo

Field: endHour

number

Field: startMin

number

Field: startHour

number

Field: endMin

number

Field: weekDay

string

Class: SiegeRaidTeam

Field: defense

boolean

Field: ownerName

string

Field: period

string

Field: membetCount

number

xlgames misspelt this

Field: fName

string

Field: isWaitWar

boolean

Field: ranking

number

Class: SiegeRaidTeamInfos

Field: [1]

SiegeRaidTeam

Field: [2]

SiegeRaidTeam

Field: [3]

SiegeRaidTeam

Class: SiegeRaidZoneInfo

Field: commanderName

string

Field: scheduleInfo

SiegeRaidScheduleInfo

Field: siegeState

string

= “siege_state_ready_to_siege”,

Field: memberMax

number

Field: factionId

`101`|`102`|`103`|`104`|`105`...(+124)

api/Addon db > system_factions

Field: memberCnt

number

Field: zoneName

string

TODO ZONE_NAME?

Class: SkillInfo

Field: abilityName

string

Field: maxRange

number

Field: manaCost

number

Field: levelStep

number

Field: learnLeavel

number

Field: minRange

number

Field: nextLearnLevel

number

Field: name

string

Field: show

boolean

Field: skillPoints

number

Field: isMeleeAttack

boolean

Field: isHarmful

boolean

Field: cooldownTime

number

Field: castingTime

number

Field: isHelpful

boolean

Field: description

string

Field: hasRange

boolean

Field: firstLearnLevel

number

Field: iconPath

string

Field: upgradeCost

number

Class: SkillMapEffectInfo

Field: a

number

Field: time

number

Field: texturePath

string

Field: useEffect

boolean

Field: x

number

Field: y

number

Field: textureKey

string

Field: r

number

Field: b

number

Field: radius

number

Field: g

number

Field: index

number

Field: z

number

Class: SkillSelectiveItemList

Field: is_multi

boolean

Field: popup_text

string

Field: select

number

Field: maxTryCount

number

Field: itemTables

SkillSelectiveItemTable[]

Field: srcItem

ItemInfo

Class: SkillSelectiveItemTable

Field: count

number

Field: name

string

Field: selectable

boolean

Field: idx

number

Field: grade

number

Field: type

number

Class: SkillTooltip

Field: ability

string

Field: minRange

number|nil

Field: name

string

Field: minCombatResource

number

Field: meleeDpsMultiplier

number|nil

Field: maxRange

number|nil

Field: path

string

Field: skillLevel

number

Field: targetAreaRadius

number|nil

Field: show

boolean

Field: synergyIconInfo

SynergyIconInfo[]|nil

Field: skillPoints

number

Field: tipType

string

Field: maxCombatResource

number

Field: levelStep

number

Field: category

string

Field: channeling

number

Field: casting

number

Field: abilityLevel

number

Field: mana

number

Field: cooldown

number

Field: firstLearnLevel

number

Field: learnLevel

number

Field: description

string

Field: isRaceSkill

boolean

Field: heirSkillName

number

Field: type

number

Class: SocketInfo

Field: maxSocket

number

Field: socketItem

number[]

Class: SpecialtyBaseInfo

Field: item

ItemInfo

Field: refund

string

Field: ratio

number

Field: noEventRefund

string

Field: supply

SpecialtySupplyInfo

Class: SpecialtyContentInfo

Extends SpecialtyBaseInfo

Field: item

ItemInfo

Field: refund

string

Field: stock

number

Field: ratio

number

Field: noEventRefund

string

Field: supply

SpecialtySupplyInfo

Class: SpecialtyInfo

Extends SpecialtyBaseInfo

Field: count

number

Field: ratio

number

Field: refund

string

Field: specialtyZone

`0`|`100`|`101`|`102`|`103`...(+151)

Obtained from db zone_groups

Field: noEventRefund

string

Field: delay

number

Field: item

ItemInfo

Field: supply

SpecialtySupplyInfo

Class: SpecialtyRatioInfo

Field: itemInfo

ItemInfo

Field: ratio

number

Class: SpecialtySupplyInfo

Field: iconCoord

string

Field: label

string

Field: iconPath

string

Field: priceIndex

number

Class: SquadInfo

Field: buttonEnable

boolean

Field: nameCacheQueryId

string|nil

Field: maxMemberCount

number

Field: openType

number

Field: squadId

number

Field: ownerLevel

number

Field: worldName

string

Field: limitLevel

number

Field: isMySquad

boolean

Field: buttonType

number

Field: limitGearScore

number

Field: curMemberCount

number

Field: fieldType

number

Field: explanationText

string

Field: zoneGroupType

`0`|`100`|`101`|`102`|`103`...(+151)

Obtained from db zone_groups

Class: SquadLinkInfo

Extends BaseLinkInfo, CommonLinkFields

Field: battleFieldType

number

Field: linkType

"squad"

Field: messageTimeStamp

number

Field: squadId

number

Field: joinKey

string

Field: filter

number

Field: isOtherWorld

boolean

Field: zoneGroupType

number

Class: StampChangeItemInfo

Field: enough

boolean

Field: itemType

number

Field: has

number

Field: need

number

Class: StampInfo

Extends AppellationMyStamp

Field: canEquip

number

Field: name

string

Field: path

string

Field: reqLevel

number

Field: modifier

table

Field: effectDescription

string

Field: id

number

Field: description

string

Field: tipType

string|"appStamp"

Class: SubItemString

Field: style

TextStyle

TextStyle

A TextStyle defines the visual appearance of text within a widget, including font, size, color, alignment, outline, shadow, ellipsis, and snapping behavior. It can measure text width and line height, and supports special font types for image-based text rendering.

Class: SubOptionItem

Field: optionId

number

Field: value

number

Class: SubcategoryInfo

Field: completedCount

number

Field: name

string

Field: rewardAchievementType

number

Field: isHeirLevelCategory

boolean

Field: desc

string

Field: totalCount

number

Class: SynergyIconInfo

Field: conditionbuffkind

boolean

Field: resultbuffkind

boolean

Field: desc

string

Field: conditionicon

string

Field: resulticon

string

Class: TargetAbility

Field: [1]

TargetAbilityTemplate

Field: [2]

TargetAbilityTemplate

Field: [3]

TargetAbilityTemplate

Class: TargetAbilityTemplate

Field: index

number|`10`|`11`|`12`|`14`...(+12)

api/X2Ability

Field: level

number

Field: name

string

Class: TeamMember

Field: isParty

boolean

Field: name

string

Field: memberIndex

number

Field: jointOrder

number

1 or 2

Field: teamRoleType

string

Class: TextureColorKey

Field: [1]

number

Red (min: 0, max: 1)

Field: [2]

number

Green (min: 0, max: 1)

Field: [3]

number

Blue (min: 0, max: 1)

Class: TextureColors

Field: [string]

RGBAColor

Class: TextureCoords

Field: [1]

number

x

Field: [3]

number

width

Field: [2]

number

y

Field: [4]

number

height

Class: TextureData

Field: colorKey

TextureColorKey

Field: extent

TextureDimensions

Field: inset

TextureInset

Field: coords

TextureCoords

Field: colors

TextureColors|nil

Field: offset

number[]

Class: TextureDimensions

Field: [1]

number

resized width

Field: [2]

number

resized height

Class: TextureInset

Field: [1]

number

leftPadding

Field: [3]

number

rightPadding

Field: [2]

number

topPadding

Field: [4]

number

bottomPadding

Class: TextureKeyData

Field: height

number

Field: keys

string[]

Field: width

number

Class: Time

Field: day

number

Field: month

number

Field: second

number

Field: minute

number

Field: hour

number

Field: year

number

Class: TodayAssignmentGoal

Field: goal

number

Field: itemCount

number

Field: itemType

number

Class: TodayAssignmentInfo

Field: desc

string

Field: requireItemCount

number|nil

Field: requireItem

number|nil

Field: requireLevel

number

Field: sort

number

Field: satisfy

boolean

Field: status

number

Field: realStep

number

Field: levelMin

number

Field: iconPath

string

Field: questType

number

Field: init

boolean

Field: levelMax

number

Field: title

string

Class: TooltipInfo

Field: buff

boolean|nil

Field: name

string|nil

Field: maxHp

string|number|nil

Field: list

CommonFarmItem[]|nil

Field: owner

string|nil

Field: territoryName

string|nil

Field: possible

boolean|nil

true if the player can use the ezi light

Field: text

string

Field: tooltipType

"carrying_backpack_slave"|"commonFarm"|"common_farm"|"conquest"|"corpse"...(+7)

Field: kind

"big_sailing_ship"|"boat"|"fishboat"|"gubuk"|"leviathan"...(+8)

db ui_texts category_id 100

Field: hp

string|number|nil

Field: enemy

boolean|nil

Field: count

number|nil

Field: id

number|nil

Field: expedition

string|nil

Field: factionName

string|nil

Field: factionId

`101`|`102`|`103`|`104`|`105`...(+125)

api/Addon db > system_factions

Field: factions

`101`|`102`|`103`|`104`|`105`...(+124)[]|nil

Field: zoneId

`0`|`100`|`101`|`102`|`103`...(+152)

Obtained from db zone_groups

Class: TowerDefInfo

Field: color

string

Field: step

string

Field: titleMsg

string

Field: msg

string

Field: iconKey

string

Field: zoneGroup

`0`|`100`|`101`|`102`|`103`...(+151)

Obtained from db zone_groups

Class: TutorialInfo

Field: [1]

{ title: string }

Field: [2]

{ [1]: string }

Class: UIBound

Field: bound

Bound

Field: screenResolution

ScreenResolution

Class: UnitAppellationRoute

Field: key

number

Field: value

string

Class: UnitAttributeModifierInfo

Field: armor

number

Field: melee_parry_mul

number

Field: melee_parry_rate

number

Field: melee_min_dps

number

Field: melee_max_dps

number

Field: melee_dps

number

Field: melee_success_rate

number

Field: offhand_melee_speed

number

Field: move_speed

number

Field: persistent_mana_regen

number

Field: persistent_health_regen

number

Field: ranged_attack_speed_mul

number

Field: melee_damage_mul_anti_pc

number

Field: melee_damage_mul

number

Field: max_health

number

Field: mana_regen

number

Field: mainhand_melee_speed

number

Field: melee_damage_mul_anti_npc

number

Field: max_mana

number

Field: melee_critical_bonus

number

Field: melee_attack_speed_mul

number

Field: melee_critical_rate

number

Field: melee_critical_mul

number

Field: magic_resist

number

Field: ranged_critical_bonus

number

Field: ranged_critical_rate

number

Field: spell_damage_critical_mul

number

Field: spell_damage_mul

number

Field: spell_damage_critical_bonus

number

Field: spell_critical_rate

number

Field: spell_critical_mul

number

Field: spell_damage_mul_anti_npc

number

Field: spell_dps

number

Field: spell_damage_mul_anti_pc

number

Field: spi

number

Field: spell_success_rate

number

Field: ranged_critical_mul

number

Field: spell_critical_bonus

number

Field: ranged_speed

number

Field: ranged_damage_mul_anti_pc

number

Field: ranged_damage_mul_anti_npc

number

Field: ranged_damage_mul

number

Field: ranged_success_rate

number

Field: ranged_dps

number

Field: ranged_min_dps

number

Field: ranged_max_dps

number

Field: ranged_parry_rate

number

Field: ranged_parry_mul

number

Field: sta

number

Field: magic_penetration

number

Field: loot_gold_mul

number

Field: drop_rate_mul

number

Field: exp_mul

number

Field: dodge_rate

number

Field: dodge_mul

number

Field: dex

number

Field: flexibility

number

Field: heal_critical_bonus

number

Field: gear_score

number

Field: heal_critical_rate

number

Field: heal_critical_mul

number

Field: heal_damage_mul

number

Field: detect_stealth_range_mul

number

Field: casting_time

number

Field: backattack_ranged_damage_mul

number

Field: backattack_melee_damage_mul

number

Field: attack_anim_speed_mul

number

Field: casting_time_mul

number

Field: backattack_spell_damage_mul

number

Field: block_mul

number

Field: battle_resist

number

Field: bulls_eye

number

Field: block_rate

number

Field: magic_effect_resist_percentage

number

Field: heal_damage_mul_anti_npc

number

Field: heal_mul

number

Field: incoming_siege_damage_mul

number

Field: incoming_ranged_damage_val

number

Field: incoming_ranged_damage_mul

number

Field: incoming_ranged_damage_add_anti_npc

number

Field: incoming_siege_damage_val

number

Field: incoming_spell_damage_mul

number

Field: incoming_spell_damage_add_anti_npc

number

Field: int

number

Field: incoming_spell_damage_val

number

Field: heal_dps

number

Field: incoming_melee_damage_val

number

Field: incoming_melee_damage_add_anti_npc

number

Field: ignore_armor

number

Field: health_regen

number

Field: heal_mul_only_heal

number

Field: incoming_melee_damage_mul

number

Field: ignore_shield_bonus

number

Field: ignore_shield_chance

number

Field: ignore_shield_bonus_mul

number

Field: incoming_heal_mul

number

Field: incoming_damage_mul_anti_npc

number

Field: str

number

Class: UnitAttributesInfo

Field: armor

number

Field: melee_damage_mul_anti_pc

number

Field: melee_damage_mul_anti_npc

number

Field: melee_damage_mul

number

Field: melee_critical_rate

number

Field: melee_dps

number

Field: melee_min_dps

number

Field: melee_max_dps

number

Field: melee_success_rate

number

Field: melee_parry_rate

number

Field: move_speed

number

Field: melee_critical_bonus

number

Field: mainhand_melee_speed

number

Field: int

number

Field: incoming_spell_damage_val

number

Field: incoming_spell_damage_mul

number

Field: mana_regen

number

Field: loot_gold_mul

number

Field: magic_penetration

number

Field: magic_effect_resist_percentage

number

Field: magic_resist_percentage

number

Field: magic_resist

number

Field: incoming_spell_damage_add_anti_npc

number

Field: move_speed_rate

number

Field: persistent_health_regen

number

Field: spell_damage_mul

number

Field: spell_critical_rate

number

Field: spell_critical_bonus

number

Field: ranged_success_rate

number

Field: spell_damage_mul_anti_npc

number

Field: spell_dps

number

Field: spell_damage_mul_anti_pc

number

Field: spi

number

Field: spell_success_rate

number

Field: offhand_melee_speed

number

Field: ranged_speed

number

Field: ranged_min_dps

number

Field: ranged_critical_rate

number

Field: ranged_critical_bonus

number

Field: persistent_mana_regen

number

Field: ranged_parry_rate

number

Field: ranged_damage_mul

number

Field: ranged_damage_mul_anti_pc

number

Field: ranged_damage_mul_anti_npc

number

Field: ranged_max_dps

number

Field: ranged_dps

number

Field: sta

number

Field: incoming_siege_damage_val

number

Field: incoming_ranged_damage_val

number

Field: detect_stealth_range_mul

number

Field: detect_stealth_range

number

Field: casting_time_mul

number

Field: casting_time

number

Field: dex

number

Field: drop_rate_mul

number

Field: dodge_rate

number

Field: flexibility

number

Field: exp_mul

number

Field: flexibility_bonus

number

Field: bulls_eye_rate

number

Field: block_rate

number

Field: attack_anim_speed_mul

number

Field: attack_anim_speed

number

Field: armor_percentage

number

Field: bulls_eye

number

Field: backattack_melee_damage_mul

number

Field: backattack_spell_damage_mul

number

Field: backattack_ranged_damage_mul

number

Field: battle_resist_rate

number

Field: battle_resist

number

Field: incoming_siege_damage_mul

number

Field: flexibility_ratio

number

Field: global_cooldown_mul

number

Field: incoming_heal_mul

number

Field: incoming_damage_mul_anti_npc

number

Field: ignore_shield_chance

number

Field: ignore_shield_bonus_mul

number

Field: incoming_melee_damage_add_anti_npc

number

Field: incoming_melee_damage_val

number

Field: incoming_melee_damage_mul

number

Field: incoming_ranged_damage_mul

number

Field: incoming_ranged_damage_add_anti_npc

number

Field: gear_score

number

Field: ignore_shield_bonus

number

Field: health_regen

number

Field: heal_damage_mul

number

Field: heal_critical_rate

number

Field: heal_critical_bonus

number

Field: ignore_armor

number

Field: heal_damage_mul_anti_npc

number

Field: heal_mul

number

Field: heal_dps

number

Field: heal_mul_only_heal

number

Field: str

number

Class: UnitClass

Field: [1]

`10`|`11`|`12`|`14`|`1`...(+11)

api/X2Ability

Field: [2]

`10`|`11`|`12`|`14`|`1`...(+11)

api/X2Ability

Field: [3]

`10`|`11`|`12`|`14`|`1`...(+11)

api/X2Ability

Class: UnitClassNames

Field: [1]

"adamant"|"assassin"|"death"|"fight"|"hatred"...(+9)

Field: [2]

"adamant"|"assassin"|"death"|"fight"|"hatred"...(+9)

Field: [3]

"adamant"|"assassin"|"death"|"fight"|"hatred"...(+9)

Class: UnitDistance

Field: distance

number

Field: over_distance

boolean

Class: UnitInSight

Field: id

number

Field: unit_owner

"character"|"housing"|"mate"|"npc"|"shipyard"...(+2)

Class: UnitInfo

Field: base_progress

number|nil

if type == housing

Field: kind

string|nil

if type == npc

Field: is_portal

boolean|nil

if type == npc

Field: hp

string

Field: level

number

Field: name

string

Field: max_hp

string

Field: nick_name

string|nil

Field: owner_name

string|nil

if type == housing

Field: house_category

string|nil

if type == housing

Field: grade

string|nil

Field: class

UnitClass

Field: building_state

string|"done"|nil

if type == housing

Field: heirLevel

number

Field: expeditionName

string|nil

if type == character

Field: family_name

string

Field: faction

string

Field: type

"character"|"housing"|"mate"|"npc"|"shipyard"...(+2)

Class: UrlLinkInfo

Extends BaseLinkInfo, CommonLinkFields

Field: addr

string

Field: linkType

"url"

Field: messageTimeStamp

number

Field: isOtherWorld

boolean

Field: filter

number

Field: text

string

Class: Vec3

Field: x

number|nil

Field: y

number|nil

Field: z

number|nil

Class: VirtualMemoryStats

Field: usage

number

Field: workingSet

number

Class: WorldMessageInfo

Field: factionName

"170906 DO NOT TRANSLATE"|"184394 DO NOT TRANSLATE"|"27499 DO NOT TRANSLATE"|"27500 DO NOT TRANSLATE"|"27501 DO NOT TRANSLATE"...(+115)

Obtained from db system_factions.name

Field: trgFactionName

"170906 DO NOT TRANSLATE"|"184394 DO NOT TRANSLATE"|"27499 DO NOT TRANSLATE"|"27500 DO NOT TRANSLATE"|"27501 DO NOT TRANSLATE"...(+115)

Obtained from db system_factions.name

Field: trgMotherFactionName

"170906 DO NOT TRANSLATE"|"184394 DO NOT TRANSLATE"|"27499 DO NOT TRANSLATE"|"27500 DO NOT TRANSLATE"|"27501 DO NOT TRANSLATE"...(+115)

Obtained from db system_factions.name

Field: trgName

string

Field: sextant

SEXTANT

Field: motherFactionName

"170906 DO NOT TRANSLATE"|"184394 DO NOT TRANSLATE"|"27499 DO NOT TRANSLATE"|"27500 DO NOT TRANSLATE"|"27501 DO NOT TRANSLATE"...(+115)

Obtained from db system_factions.name

Field: name

string

Field: zoneGroupName

"Abyssal Library"|"Aegis Island"|"Ahnimar Event Arena"|"Ahnimar"|"Airain Rock"...(+143)

Class: ZoneInfo

Field: continentName

string

Field: id

number

Field: zoneGroupName

string

Class: ZoneStateInfo

Field: conflictState

`-1`|`HPWS_BATTLE`|`HPWS_PEACE`|`HPWS_TROUBLE_0`|`HPWS_TROUBLE_1`...(+4)

api/X2Dominion

Field: localDevelopmentStep

number|nil

Field: localDevelopmentName

string|nil

Field: isSiegeZone

boolean

Field: isPeaceZone

boolean

Field: lockTime

number|nil

Field: nonRate

boolean|nil

Field: nonPeaceState

boolean

Field: remainTime

number|nil

Field: warChaos

boolean

Field: isNuiaProtectedZone

boolean

Field: isInstanceZone

boolean

Field: goldRate

number|nil

Field: festivalName

string|nil

Field: dropRate

number|nil

Field: isLocalDevelopment

boolean

Field: isConflictZone

boolean

Field: isFestivalZone

boolean

Field: isCurrentZone

boolean

Field: isHariharaProtectedZone

boolean

Field: zoneName

"Abyssal Library"|"Aegis Island"|"Ahnimar Event Arena"|"Ahnimar"|"Airain Rock"...(+143)

Keyboard shortcuts

ArcheAge Addon Documentation