Widget - ArcheAge Addon Documentation

Globals

CT_ABILITY

integer

CT_EXPEDITION_NAME

integer

CT_NAME

integer

DC_ALWAYS

integer

DC_SHIFT_KEY_DOWN

integer

Aliases

CT_ABILITY|CT_EXPEDITION_NAME|CT_NAME

-- types/Widget
-- Cache Type
CT:
    | `CT_ABILITY`
    | `CT_EXPEDITION_NAME`
    | `CT_NAME`

CharacterCacheDataHandler

fun(self: Widget, data: CacheData)

DRAG_CONDITION

DC_ALWAYS|DC_SHIFT_KEY_DOWN

-- types/Widget
DRAG_CONDITION:
    | `DC_ALWAYS`
    | `DC_SHIFT_KEY_DOWN`

DelegatorHandler

fun(delegator: Widget, callbacker: Widget, mbt: “LeftButton”|“RightButton”)

Classes

Extends Uibounds, Uiobject

Method: ApplyUIScale

(method) Widget:ApplyUIScale(apply: boolean)

Applies or removes UI scaling for the Widget.

@param apply — true to apply UI scale, false to remove. (default: true)

Method: SetCharacterCacheDataHandler

(method) Widget:SetCharacterCacheDataHandler(handler: fun(self: Widget, data: CacheData))

Sets a handler for character cache data.

@param handler — The handler function.

See: CharacterCacheDataHandler

Method: SetCategory

(method) Widget:SetCategory(category: string)

Sets the category for the Widget.

@param category — The category to set.

Method: SetAlphaAnimation

(method) Widget:SetAlphaAnimation(initialAlpha: number, finalAlpha: number, velocityTime: number, accelerationTime: number)

Sets an alpha animation for the Widget.

@param initialAlpha — The starting alpha (min: 0, max: 1).

@param finalAlpha — The ending alpha (min: 0, max: 1).

@param velocityTime — Duration in seconds for velocity.

@param accelerationTime — Duration in seconds for acceleration.

Method: SetAlpha

(method) Widget:SetAlpha(alpha: number)

Sets the alpha value of the Widget.

@param alpha — The alpha value (min: 0, max: 1).

Method: SetDelegator

(method) Widget:SetDelegator(action: "OnAcceptFocus"|"OnAlphaAnimeEnd"|"OnBoundChanged"|"OnChangedAnchor"|"OnCheckChanged"...(+44), delegator: Widget, handler: fun(delegator: Widget, callbacker: Widget, mbt: "LeftButton"|"RightButton"))

Sets a handler for a specific action on a delegator widget.

@param action — The action name.

@param delegator — The delegator widget.

@param handler — The handler function.

action:
    | "OnAcceptFocus" -- Triggers when the widget accepts focus.
    | "OnAlphaAnimeEnd" -- Triggers when the widgets alpha animation has ended.
    | "OnBoundChanged" -- Triggers when the widgets ui bound has changed.
    | "OnChangedAnchor" -- Triggers when the widgets anchor has been changed.
    | "OnCheckChanged" -- triggers when the CheckButton widget check has been changed.
    | "OnClick" -- Triggers when the widget has been clicked.
    | "OnCloseByEsc" -- Triggers when the Window widget has been closed when the escape key has been pressed. Requires `widget:SetCloseOnEscape(true)`.
    | "OnContentUpdated" -- Triggers when the contents of a widget are updated.
    | "OnCursorMoved" -- Triggers when the EditboxMultiline widgets cursor has moved.
    | "OnDragReceive" -- Triggers when the Window widget has dragging enabled and drag is received.
    | "OnDragStart" -- Triggers when the Window widget has dragging enabled and drag has started.
    | "OnDragStop" -- Triggers when the Window widget has dragging enabled and drag has stopped.
    | "OnDynamicListUpdatedView" -- Triggers when he DynamicList widget view has updated.
    | "OnEffect" -- Triggers every frame while the widget is shown.
    | "OnEnableChanged" -- Triggers when the widget is enabled or disabled.
    | "OnEndFadeIn" -- Triggers when the widget has ended the fade in animation for showing the widget.
    | "OnEndFadeOut" -- Triggers when the widget has ended the fade out animation for hiding the widget.
    | "OnEnter" -- Triggers when the mouse enters the widgets ui bounds.
    | "OnEnterPressed" -- Triggers when the widget is focused and the enter key is pressed.
    | "OnEscapePressed" -- Triggers when the widget is focused and the escape key is pressed.
    | "OnEvent" -- Triggers when an event registered to the widget triggers.
    | "OnHide" -- Triggers when the widget is hidden.
    | "OnKeyDown" -- Triggers when the widget has keyboard enabled and the key has been pushed.
    | "OnKeyUp" -- Triggers when the widget has keyboard enabled and the key has been released.
    | "OnLeave" -- Triggers when mouse leaves the widgets ui bounds.
    | "OnListboxToggled" -- Triggers when the Listbox widget is toggled.
    | "OnModelChanged" -- triggers when the Model widget model changes.
    | "OnMouseDown" -- Triggers when the mouse left or right click is released while within the ui bounds of the widget.
    | "OnMouseMove" -- Triggers when the mouse moves while within the widgets ui bounds.
    | "OnMouseUp" -- Triggers when the mouse left or right click is pressed while within the ui bounds of the widget.
    | "OnMovedPosition" -- Triggers when the Window widget has dragging enabled and the widget has moved.
    | "OnPageChanged" -- Triggers when the Pageable widget page changes.
    | "OnPermissionChanged" -- Triggers when the permission changes.
    | "OnRadioChanged" -- Triggers when the RadioGroup widget radio changes.
    | "OnRestricted" -- #
    | "OnScale" -- Triggers when the widgets scale has been applied or set.
    | "OnScaleAnimeEnd" -- Triggers when the widgets scale animation has ended.
    | "OnSelChanged" -- Triggers when the Listbox or ListCtrl widget selection changes.
    | "OnShow" -- Triggers when the object is shown.
    | "OnSliderChanged" -- Triggers when the Slider widget slider changes.
    | "OnTabChanged" -- Triggers when the Tab widget tab changes.
    | "OnTextChanged" -- Triggers when the Editbox widget text changes.
    | "OnTooltip" -- Triggers when the Listbox widget should show a tooltip.
    | "OnUpdate" -- Triggers every frame while the widget is shown.
    | "OnVisibleChanged" -- Triggers when the widget is shown or hidden.
    | "OnWheelDown" -- Triggers when the mouse is within the widgets ui bounds and the mouse wheel is scrolled down.
    | "OnWheelUp" -- Triggers when the mouse is within the widgets ui bounds mouse wheel is scrolled up.
    | "PreClick" -- Triggers when the Slot widget is clicked.
    | "PreUse" -- Triggers when the Slot widget is clicked.

See: DelegatorHandler

Method: SetDragCondition

(method) Widget:SetDragCondition(dragCondition: `DC_ALWAYS`|`DC_SHIFT_KEY_DOWN`)

Sets the drag condition for the Widget. This restricts when the events OnDragReceive, OnDragStart, and OnDragStop are fired.

@param dragCondition — The drag condition. (default: DC_ALWAYS)
-- types/Widget
dragCondition:
    | `DC_ALWAYS`
    | `DC_SHIFT_KEY_DOWN`

Method: SetDeletedHandler

(method) Widget:SetDeletedHandler(handler: function)

Sets a handler for the Widget deletion event. This executes right before the widget is deleted from the Object pool and should be used to set any variable that referenced the widget as nil, otherwise the widget will become an invalid object.

@param handler — The handler function.

Method: SetDrawPriority

(method) Widget:SetDrawPriority(drawPriority: number)

Sets the draw priority for the Widget relative to its sibling Widgets.

@param drawPriority — The draw priority (z-index) value.

Method: SetDrawableLayerAlpha

(method) Widget:SetDrawableLayerAlpha(alpha: number, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")

Sets the alpha for a specific drawable layer.

@param alpha — Alpha value (min: 0, max: 1). (default: 1)

@param nameLayer — The layer to apply the alpha to.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: RequestCharacterCacheData

(method) Widget:RequestCharacterCacheData(cacheQueryId: string)

Requests character cache data.

@param cacheQueryId — The cache query ID.

Method: RemoveAllDrawables

(method) Widget:RemoveAllDrawables(nameLayer: "artwork"|"background"|"overlay"|"overoverlay")

Removes all drawables for the specified layer.

@param nameLayer — The layer to clear.

-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: MoveTo

(method) Widget:MoveTo(x: number, y: number)

Moves the Widget to the specified coordinates from the TOPLEFT corner.

@param x — The x-coordinate.

@param y — The y-coordinate.

Method: Lower

(method) Widget:Lower()

Lowers the Widget in the UI hierarchy.

Method: IsVisible

(method) Widget:IsVisible()
  -> visible: boolean

Checks if the Widget is visible.

@return visible — true if visible, false otherwise.

Method: RemoveDrawable

(method) Widget:RemoveDrawable(drawableTable: Drawablebase)

Removes a specific drawable table from the widget.

@param drawableTable — The drawable table to remove.

See: Drawablebase

Method: Raise

(method) Widget:Raise()

Raises the Widget in the UI hierarchy.

Method: ReleaseDeletedHandler

(method) Widget:ReleaseDeletedHandler()

Releases the deleted handler for the Widget.

Method: RegisterEvent

(method) Widget:RegisterEvent(eventName: "ABILITY_CHANGED"|"ABILITY_EXP_CHANGED"|"ABILITY_SET_CHANGED"|"ABILITY_SET_USABLE_SLOT_COUNT_CHANGED"|"ACCOUNT_ATTENDANCE_ADDED"...(+872))

Registers an event for the Widget to be accessible by the OnEvent handler action.

@param eventName — The event to register.

eventName:
    | "ABILITY_CHANGED"
    | "ABILITY_EXP_CHANGED"
    | "ABILITY_SET_CHANGED"
    | "ABILITY_SET_USABLE_SLOT_COUNT_CHANGED"
    | "ACCOUNT_ATTENDANCE_ADDED"
    | "ACCOUNT_ATTENDANCE_LOADED"
    | "ACCOUNT_ATTRIBUTE_UPDATED"
    | "ACCOUNT_RESTRICT_NOTICE"
    | "ACHIEVEMENT_UPDATE"
    | "ACQUAINTANCE_LOGIN"
    | "ACTABILITY_EXPERT_CHANGED"
    | "ACTABILITY_EXPERT_EXPANDED"
    | "ACTABILITY_EXPERT_GRADE_CHANGED"
    | "ACTABILITY_MODIFIER_UPDATE"
    | "ACTABILITY_REFRESH_ALL"
    | "ACTION_BAR_AUTO_REGISTERED"
    | "ACTION_BAR_PAGE_CHANGED"
    | "ACTIONS_UPDATE"
    | "ADD_GIVEN_QUEST_INFO"
    | "ADD_NOTIFY_QUEST_INFO"
    | "ADDED_ITEM"
    | "ADDON_LOADED"
    | "AGGRO_METER_CLEARED"
    | "AGGRO_METER_UPDATED"
    | "ALL_SIEGE_RAID_TEAM_INFOS"
    | "ANTIBOT_PUNISH"
    | "APPELLATION_CHANGED"
    | "APPELLATION_GAINED"
    | "APPELLATION_STAMP_SET"
    | "ARCHE_PASS_BUY"
    | "ARCHE_PASS_COMPLETED"
    | "ARCHE_PASS_DROPPED"
    | "ARCHE_PASS_EXPIRED"
    | "ARCHE_PASS_LOADED"
    | "ARCHE_PASS_MISSION_CHANGED"
    | "ARCHE_PASS_MISSION_COMPLETED"
    | "ARCHE_PASS_OWNED"
    | "ARCHE_PASS_RESETED"
    | "ARCHE_PASS_STARTED"
    | "ARCHE_PASS_UPDATE_POINT"
    | "ARCHE_PASS_UPDATE_REWARD_ITEM"
    | "ARCHE_PASS_UPDATE_TIER"
    | "ARCHE_PASS_UPGRADE_PREMIUM"
    | "ASK_BUY_LABOR_POWER_POTION"
    | "ASK_FORCE_ATTACK"
    | "AUCTION_BIDDED"
    | "AUCTION_BIDDEN"
    | "AUCTION_BOUGHT"
    | "AUCTION_BOUGHT_BY_SOMEONE"
    | "AUCTION_CANCELED"
    | "AUCTION_CHARACTER_LEVEL_TOO_LOW"
    | "AUCTION_ITEM_ATTACHMENT_STATE_CHANGED"
    | "AUCTION_ITEM_PUT_UP"
    | "AUCTION_ITEM_SEARCH"
    | "AUCTION_ITEM_SEARCHED"
    | "AUCTION_LOWEST_PRICE"
    | "AUCTION_PERMISSION_BY_CRAFT"
    | "AUCTION_TOGGLE"
    | "AUDIENCE_JOINED"
    | "AUDIENCE_LEFT"
    | "BAD_USER_LIST_UPDATE"
    | "BADWORD_USER_REPORED_RESPONE_MSG"
    | "BAG_EXPANDED"
    | "BAG_ITEM_CONFIRMED"
    | "BAG_REAL_INDEX_SHOW"
    | "BAG_TAB_CREATED"
    | "BAG_TAB_REMOVED"
    | "BAG_TAB_SORTED"
    | "BAG_TAB_SWITCHED"
    | "BAG_UPDATE"
    | "BAN_PLAYER_RESULT"
    | "BANK_EXPANDED"
    | "BANK_REAL_INDEX_SHOW"
    | "BANK_TAB_CREATED"
    | "BANK_TAB_REMOVED"
    | "BANK_TAB_SORTED"
    | "BANK_TAB_SWITCHED"
    | "BANK_UPDATE"
    | "BEAUTYSHOP_CLOSE_BY_SYSTEM"
    | "BLESS_UTHSTIN_EXTEND_MAX_STATS"
    | "BLESS_UTHSTIN_ITEM_SLOT_CLEAR"
    | "BLESS_UTHSTIN_ITEM_SLOT_SET"
    | "BLESS_UTHSTIN_MESSAGE"
    | "BLESS_UTHSTIN_UPDATE_STATS"
    | "BLESS_UTHSTIN_WILL_APPLY_STATS"
    | "BLOCKED_USER_LIST"
    | "BLOCKED_USER_UPDATE"
    | "BLOCKED_USERS_INFO"
    | "BOT_SUSPECT_REPORTED"
    | "BUFF_SKILL_CHANGED"
    | "BUFF_UPDATE"
    | "BUILD_CONDITION"
    | "BUILDER_END"
    | "BUILDER_STEP"
    | "BUTLER_INFO_UPDATED"
    | "BUTLER_UI_COMMAND"
    | "BUY_RESULT_AA_POINT"
    | "BUY_SPECIALTY_CONTENT_INFO"
    | "CANCEL_CRAFT_ORDER"
    | "CANCEL_REBUILD_HOUSE_CAMERA_MODE"
    | "CANDIDATE_LIST_CHANGED"
    | "CANDIDATE_LIST_HIDE"
    | "CANDIDATE_LIST_SELECTION_CHANGED"
    | "CANDIDATE_LIST_SHOW"
    | "CHANGE_ACTABILITY_DECO_NUM"
    | "CHANGE_CONTRIBUTION_POINT_TO_PLAYER"
    | "CHANGE_CONTRIBUTION_POINT_TO_STORE"
    | "CHANGE_MY_LANGUAGE"
    | "CHANGE_OPTION"
    | "CHANGE_PAY_INFO"
    | "CHANGE_VISUAL_RACE_ENDED"
    | "CHANGED_AUTO_USE_AAPOINT"
    | "CHANGED_MSG"
    | "CHAT_DICE_VALUE"
    | "CHAT_EMOTION"
    | "CHAT_FAILED"
    | "CHAT_JOINED_CHANNEL"
    | "CHAT_LEAVED_CHANNEL"
    | "CHAT_MESSAGE"
    | "CHAT_MSG_ALARM"
    | "CHAT_MSG_DOODAD"
    | "CHAT_MSG_QUEST"
    | "CHECK_TEXTURE"
    | "CLEAR_BOSS_TELESCOPE_INFO"
    | "CLEAR_CARRYING_BACKPACK_SLAVE_INFO"
    | "CLEAR_COMPLETED_QUEST_INFO"
    | "CLEAR_CORPSE_INFO"
    | "CLEAR_DOODAD_INFO"
    | "CLEAR_FISH_SCHOOL_INFO"
    | "CLEAR_GIVEN_QUEST_STATIC_INFO"
    | "CLEAR_HOUSING_INFO"
    | "CLEAR_MY_SLAVE_POS_INFO"
    | "CLEAR_NOTIFY_QUEST_INFO"
    | "CLEAR_NPC_INFO"
    | "CLEAR_SHIP_TELESCOPE_INFO"
    | "CLEAR_TRANSFER_TELESCOPE_INFO"
    | "CLOSE_CRAFT_ORDER"
    | "CLOSE_MUSIC_SHEET"
    | "COFFER_INTERACTION_END"
    | "COFFER_INTERACTION_START"
    | "COFFER_REAL_INDEX_SHOW"
    | "COFFER_TAB_CREATED"
    | "COFFER_TAB_REMOVED"
    | "COFFER_TAB_SORTED"
    | "COFFER_TAB_SWITCHED"
    | "COFFER_UPDATE"
    | "COMBAT_MSG"
    | "COMBAT_TEXT"
    | "COMBAT_TEXT_COLLISION"
    | "COMBAT_TEXT_SYNERGY"
    | "COMMON_FARM_UPDATED"
    | "COMMUNITY_ERROR"
    | "COMPLETE_ACHIEVEMENT"
    | "COMPLETE_CRAFT_ORDER"
    | "COMPLETE_QUEST_CONTEXT_DOODAD"
    | "COMPLETE_QUEST_CONTEXT_NPC"
    | "CONSOLE_WRITE"
    | "CONVERT_TO_RAID_TEAM"
    | "COPY_RAID_MEMBERS_TO_CLIPBOARD"
    | "CRAFT_DOODAD_INFO"
    | "CRAFT_ENDED"
    | "CRAFT_FAILED"
    | "CRAFT_ORDER_ENTRY_SEARCHED"
    | "CRAFT_RECIPE_ADDED"
    | "CRAFT_STARTED"
    | "CRAFT_TRAINED"
    | "CRAFTING_END"
    | "CRAFTING_START"
    | "CREATE_ORIGIN_UCC_ITEM"
    | "CRIME_REPORTED"
    | "DEBUFF_UPDATE"
    | "DELETE_CRAFT_ORDER"
    | "DELETE_PORTAL"
    | "DESTROY_PAPER"
    | "DIAGONAL_ASR"
    | "DIAGONAL_LINE"
    | "DICE_BID_RULE_CHANGED"
    | "DISCONNECT_FROM_AUTH"
    | "DISCONNECTED_BY_WORLD"
    | "DISMISS_PET"
    | "DIVE_END"
    | "DIVE_START"
    | "DOMINION"
    | "DOMINION_GUARD_TOWER_STATE_NOTICE"
    | "DOMINION_GUARD_TOWER_UPDATE_TOOLTIP"
    | "DOMINION_SIEGE_PARTICIPANT_COUNT_CHANGED"
    | "DOMINION_SIEGE_PERIOD_CHANGED"
    | "DOMINION_SIEGE_SYSTEM_NOTICE"
    | "DOMINION_SIEGE_UPDATE_TIMER"
    | "DOODAD_LOGIC"
    | "DOODAD_PHASE_MSG"
    | "DOODAD_PHASE_UI_MSG"
    | "DRAW_DOODAD_SIGN_TAG"
    | "DRAW_DOODAD_TOOLTIP"
    | "DYEING_END"
    | "DYEING_START"
    | "DYNAMIC_ACTION_BAR_HIDE"
    | "DYNAMIC_ACTION_BAR_SHOW"
    | "ENABLE_TEAM_AREA_INVITATION"
    | "ENCHANT_EXAMINE"
    | "ENCHANT_RESULT"
    | "ENCHANT_SAY_ABILITY"
    | "END_HERO_ELECTION_PERIOD"
    | "END_QUEST_CHAT_BUBBLE"
    | "ENDED_DUEL"
    | "ENTER_ANOTHER_ZONEGROUP"
    | "ENTER_ENCHANT_ITEM_MODE"
    | "ENTER_GACHA_LOOT_MODE"
    | "ENTER_ITEM_LOOK_CONVERT_MODE"
    | "ENTER_WORLD_CANCELLED"
    | "ENTERED_INSTANT_GAME_ZONE"
    | "ENTERED_LOADING"
    | "ENTERED_LOGIN"
    | "ENTERED_SCREEN_SHOT_CAMERA_MODE"
    | "ENTERED_SUBZONE"
    | "ENTERED_WORLD"
    | "ENTERED_WORLD_SELECT"
    | "EQUIP_SLOT_REINFORCE_MSG_CHAGNE_LEVEL_EFFECT"
    | "EQUIP_SLOT_REINFORCE_EXPAND_PAGE"
    | "EQUIP_SLOT_REINFORCE_MSG_LEVEL_EFFECT"
    | "EQUIP_SLOT_REINFORCE_MSG_LEVEL_UP"
    | "EQUIP_SLOT_REINFORCE_MSG_SET_EFFECT"
    | "EQUIP_SLOT_REINFORCE_SELECT_PAGE"
    | "EQUIP_SLOT_REINFORCE_UPDATE"
    | "ESC_MENU_ADD_BUTTON"
    | "ESCAPE_END"
    | "ESCAPE_START"
    | "EVENT_SCHEDULE_START"
    | "EVENT_SCHEDULE_STOP"
    | "EXP_CHANGED"
    | "EXPEDITION_APPLICANT_ACCEPT"
    | "EXPEDITION_APPLICANT_REJECT"
    | "EXPEDITION_BUFF_CHANGE"
    | "EXPEDITION_EXP"
    | "EXPEDITION_HISTORY"
    | "EXPEDITION_LEVEL_UP"
    | "EXPEDITION_MANAGEMENT_APPLICANT_ACCEPT"
    | "EXPEDITION_MANAGEMENT_APPLICANT_ADD"
    | "EXPEDITION_MANAGEMENT_APPLICANT_DEL"
    | "EXPEDITION_MANAGEMENT_APPLICANT_REJECT"
    | "EXPEDITION_MANAGEMENT_APPLICANTS"
    | "EXPEDITION_MANAGEMENT_GUILD_FUNCTION_CHANGED"
    | "EXPEDITION_MANAGEMENT_MEMBER_NAME_CHANGED"
    | "EXPEDITION_MANAGEMENT_MEMBER_STATUS_CHANGED"
    | "EXPEDITION_MANAGEMENT_MEMBERS_INFO"
    | "EXPEDITION_MANAGEMENT_POLICY_CHANGED"
    | "EXPEDITION_MANAGEMENT_RECRUITMENT_ADD"
    | "EXPEDITION_MANAGEMENT_RECRUITMENT_DEL"
    | "EXPEDITION_MANAGEMENT_RECRUITMENTS"
    | "EXPEDITION_MANAGEMENT_ROLE_CHANGED"
    | "EXPEDITION_MANAGEMENT_UPDATED"
    | "EXPEDITION_RANKING"
    | "EXPEDITION_SUMMON_SUGGEST"
    | "EXPEDITION_WAR_DECLARATION_FAILED"
    | "EXPEDITION_WAR_DECLARATION_MONEY"
    | "EXPEDITION_WAR_KILL_SCORE"
    | "EXPEDITION_WAR_SET_PROTECT_DATE"
    | "EXPEDITION_WAR_STATE"
    | "EXPIRED_ITEM"
    | "FACTION_CHANGED"
    | "FACTION_COMPETITION_INFO"
    | "FACTION_COMPETITION_RESULT"
    | "FACTION_COMPETITION_UPDATE_POINT"
    | "FACTION_RELATION_ACCEPTED"
    | "FACTION_RELATION_CHANGED"
    | "FACTION_RELATION_COUNT"
    | "FACTION_RELATION_DENIED"
    | "FACTION_RELATION_HISTORY"
    | "FACTION_RELATION_REQUESTED"
    | "FACTION_RELATION_WILL_CHANGE"
    | "FACTION_RENAMED"
    | "FADE_INOUT_DONE"
    | "FAIL_WEB_PLAY_DIARY_INSTANT"
    | "FAILED_TO_SET_PET_AUTO_SKILL"
    | "FAMILY_ERROR"
    | "FAMILY_EXP_ADD"
    | "FAMILY_INFO_REFRESH"
    | "FAMILY_LEVEL_UP"
    | "FAMILY_MEMBER"
    | "FAMILY_MEMBER_ADDED"
    | "FAMILY_MEMBER_KICKED"
    | "FAMILY_MEMBER_LEFT"
    | "FAMILY_MEMBER_ONLINE"
    | "FAMILY_MGR"
    | "FAMILY_NAME_CHANGED"
    | "FAMILY_OWNER_CHANGED"
    | "FAMILY_REFRESH"
    | "FAMILY_REMOVED"
    | "FIND_FACTION_REZ_DISTRICT_COOLTIME_FAIL"
    | "FIND_FACTION_REZ_DISTRICT_DURATION_FAIL"
    | "FOLDER_STATE_CHANGED"
    | "FORCE_ATTACK_CHANGED"
    | "FRIENDLIST"
    | "FRIENDLIST_INFO"
    | "FRIENDLIST_UPDATE"
    | "GACHA_LOOT_PACK_LOG"
    | "GACHA_LOOT_PACK_RESULT"
    | "GAME_EVENT_EMPTY"
    | "GAME_EVENT_INFO_LIST_UPDATED"
    | "GAME_EVENT_INFO_REQUESTED"
    | "GAME_SCHEDULE"
    | "GENDER_TRANSFERED"
    | "GLIDER_MOVED_INTO_BAG"
    | "GOODS_MAIL_INBOX_ITEM_TAKEN"
    | "GOODS_MAIL_INBOX_MONEY_TAKEN"
    | "GOODS_MAIL_INBOX_TAX_PAID"
    | "GOODS_MAIL_INBOX_UPDATE"
    | "GOODS_MAIL_RETURNED"
    | "GOODS_MAIL_SENT_SUCCESS"
    | "GOODS_MAIL_SENTBOX_UPDATE"
    | "GOODS_MAIL_WRITE_ITEM_UPDATE"
    | "GRADE_ENCHANT_BROADCAST"
    | "GRADE_ENCHANT_RESULT"
    | "GUARDTOWER_HEALTH_CHANGED"
    | "GUILD_BANK_INTERACTION_END"
    | "GUILD_BANK_INTERACTION_START"
    | "GUILD_BANK_INVEN_SHOW"
    | "GUILD_BANK_MONEY_UPDATE"
    | "GUILD_BANK_REAL_INDEX_SHOW"
    | "GUILD_BANK_TAB_CREATED"
    | "GUILD_BANK_TAB_REMOVED"
    | "GUILD_BANK_TAB_SORTED"
    | "GUILD_BANK_TAB_SWITCHED"
    | "GUILD_BANK_UPDATE"
    | "HEIR_LEVEL_UP"
    | "HEIR_SKILL_ACTIVE_TYPE_MSG"
    | "HEIR_SKILL_LEARN"
    | "HEIR_SKILL_RESET"
    | "HEIR_SKILL_UPDATE"
    | "HERO_ALL_SCORE_UPDATED"
    | "HERO_ANNOUNCE_REMAIN_TIME"
    | "HERO_CANDIDATE_NOTI"
    | "HERO_CANDIDATES_ANNOUNCED"
    | "HERO_ELECTION"
    | "HERO_ELECTION_DAY_ALERT"
    | "HERO_ELECTION_RESULT"
    | "HERO_ELECTION_VOTED"
    | "HERO_NOTI"
    | "HERO_RANK_DATA_RETRIEVED"
    | "HERO_RANK_DATA_TIMEOUT"
    | "HERO_SCORE_UPDATED"
    | "HERO_SEASON_OFF"
    | "HERO_SEASON_UPDATED"
    | "HIDE_ROADMAP_TOOLTIP"
    | "HIDE_SKILL_MAP_EFFECT"
    | "HIDE_WORLDMAP_TOOLTIP"
    | "HOUSE_BUILD_INFO"
    | "HOUSE_BUY_FAIL"
    | "HOUSE_BUY_SUCCESS"
    | "HOUSE_CANCEL_SELL_FAIL"
    | "HOUSE_CANCEL_SELL_SUCCESS"
    | "HOUSE_DECO_UPDATED"
    | "HOUSE_FARM_MSG"
    | "HOUSE_INFO_UPDATED"
    | "HOUSE_INTERACTION_END"
    | "HOUSE_INTERACTION_START"
    | "HOUSE_PERMISSION_UPDATED"
    | "HOUSE_REBUILD_TAX_INFO"
    | "HOUSE_ROTATE_CONFIRM"
    | "HOUSE_SALE_SUCCESS"
    | "HOUSE_SET_SELL_FAIL"
    | "HOUSE_SET_SELL_SUCCESS"
    | "HOUSE_STEP_INFO_UPDATED"
    | "HOUSE_TAX_INFO"
    | "HOUSING_UCC_CLOSE"
    | "HOUSING_UCC_ITEM_SLOT_CLEAR"
    | "HOUSING_UCC_ITEM_SLOT_SET"
    | "HOUSING_UCC_LEAVE"
    | "HOUSING_UCC_UPDATED"
    | "HPW_ZONE_STATE_CHANGE"
    | "HPW_ZONE_STATE_WAR_END"
    | "IME_STATUS_CHANGED"
    | "INDUN_INITAL_ROUND_INFO"
    | "INDUN_ROUND_END"
    | "INDUN_ROUND_START"
    | "INDUN_UPDATE_ROUND_INFO"
    | "INGAME_SHOP_BUY_RESULT"
    | "INIT_CHRONICLE_INFO"
    | "INSERT_CRAFT_ORDER"
    | "INSTANCE_ENTERABLE_MSG"
    | "INSTANT_GAME_BEST_RATING_REWARD"
    | "INSTANT_GAME_END"
    | "INSTANT_GAME_JOIN_APPLY"
    | "INSTANT_GAME_JOIN_CANCEL"
    | "INSTANT_GAME_KILL"
    | "INSTANT_GAME_PICK_BUFFS"
    | "INSTANT_GAME_READY"
    | "INSTANT_GAME_RETIRE"
    | "INSTANT_GAME_ROUND_RESULT"
    | "INSTANT_GAME_START"
    | "INSTANT_GAME_START_POINT_RETURN_MSG"
    | "INSTANT_GAME_UNEARNED_WIN_REMAIN_TIME"
    | "INSTANT_GAME_WAIT"
    | "INTERACTION_END"
    | "INTERACTION_START"
    | "INVALID_NAME_POLICY"
    | "INVEN_SLOT_SPLIT"
    | "ITEM_ACQUISITION_BY_LOOT"
    | "ITEM_CHANGE_MAPPING_RESULT"
    | "ITEM_ENCHANT_MAGICAL_RESULT"
    | "ITEM_EQUIP_RESULT"
    | "ITEM_LOOK_CONVERTED"
    | "ITEM_LOOK_CONVERTED_EFFECT"
    | "ITEM_REFURBISHMENT_RESULT"
    | "ITEM_SMELTING_RESULT"
    | "ITEM_SOCKET_UPGRADE"
    | "ITEM_SOCKETING_RESULT"
    | "JURY_OK_COUNT"
    | "JURY_WAITING_NUMBER"
    | "LABORPOWER_CHANGED"
    | "LEAVE_ENCHANT_ITEM_MODE"
    | "LEAVE_GACHA_LOOT_MODE"
    | "LEAVE_ITEM_LOOK_CONVERT_MODE"
    | "LEAVED_INSTANT_GAME_ZONE"
    | "LEAVING_WORLD_CANCELED"
    | "LEAVING_WORLD_STARTED"
    | "LEFT_LOADING"
    | "LEFT_LOGIN"
    | "LEFT_SCREEN_SHOT_CAMERA_MODE"
    | "LEFT_SUBZONE"
    | "LEFT_WORLD"
    | "LEVEL_CHANGED"
    | "LOGIN_CHARACTER_UPDATED"
    | "LOGIN_DENIED"
    | "LOOT_BAG_CHANGED"
    | "LOOT_BAG_CLOSE"
    | "LOOT_DICE"
    | "LOOT_PACK_ITEM_BROADCAST"
    | "LOOTING_RULE_BOP_CHANGED"
    | "LOOTING_RULE_GRADE_CHANGED"
    | "LOOTING_RULE_MASTER_CHANGED"
    | "LOOTING_RULE_METHOD_CHANGED"
    | "LP_MANAGE_CHARACTER_CHANGED"
    | "MAIL_INBOX_ATTACHMENT_TAKEN_ALL"
    | "MAIL_INBOX_ITEM_TAKEN"
    | "MAIL_INBOX_MONEY_TAKEN"
    | "MAIL_INBOX_TAX_PAID"
    | "MAIL_INBOX_UPDATE"
    | "MAIL_RETURNED"
    | "MAIL_SENT_SUCCESS"
    | "MAIL_SENTBOX_UPDATE"
    | "MAIL_WRITE_ITEM_UPDATE"
    | "MAP_EVENT_CHANGED"
    | "MATE_SKILL_LEARNED"
    | "MATE_STATE_UPDATE"
    | "MEGAPHONE_MESSAGE"
    | "MIA_MAIL_INBOX_ITEM_TAKEN"
    | "MIA_MAIL_INBOX_MONEY_TAKEN"
    | "MIA_MAIL_INBOX_TAX_PAID"
    | "MIA_MAIL_INBOX_UPDATE"
    | "MIA_MAIL_RETURNED"
    | "MIA_MAIL_SENT_SUCCESS"
    | "MIA_MAIL_SENTBOX_UPDATE"
    | "MIA_MAIL_WRITE_ITEM_UPDATE"
    | "MINE_AMOUNT"
    | "MINI_SCOREBOARD_CHANGED"
    | "MODE_ACTIONS_UPDATE"
    | "MONEY_ACQUISITION_BY_LOOT"
    | "MOUNT_BAG_UPDATE"
    | "MOUNT_PET"
    | "MOUNT_SLOT_CHANGED"
    | "MOUSE_CLICK"
    | "MOUSE_DOWN"
    | "MOUSE_UP"
    | "MOVE_SPEED_CHANGE"
    | "MOVIE_ABORT"
    | "MOVIE_LOAD"
    | "MOVIE_START"
    | "MOVIE_STOP"
    | "MULTI_QUEST_CONTEXT_SELECT"
    | "MULTI_QUEST_CONTEXT_SELECT_LIST"
    | "NAME_TAG_MODE_CHANGED_MSG"
    | "NATION_DOMINION"
    | "NAVI_MARK_POS_TO_MAP"
    | "NAVI_MARK_REMOVE"
    | "NEW_DAY_STARTED"
    | "NEW_SKILL_POINT"
    | "NEXT_SIEGE_INFO"
    | "NOTICE_MESSAGE"
    | "NOTIFY_AUTH_ADVERTISING_MESSAGE"
    | "NOTIFY_AUTH_BILLING_MESSAGE"
    | "NOTIFY_AUTH_DISCONNECTION_MESSAGE"
    | "NOTIFY_AUTH_FATIGUE_MESSAGE"
    | "NOTIFY_AUTH_NOTICE_MESSAGE"
    | "NOTIFY_AUTH_TC_FATIGUE_MESSAGE"
    | "NOTIFY_WEB_TRANSFER_STATE"
    | "NPC_CRAFT_ERROR"
    | "NPC_CRAFT_UPDATE"
    | "NPC_INTERACTION_END"
    | "NPC_INTERACTION_START"
    | "UNIT_NPC_EQUIPMENT_CHANGED"
    | "NUONS_ARROW_SHOW"
    | "NUONS_ARROW_UI_MSG"
    | "NUONS_ARROW_UPDATE"
    | "ONE_AND_ONE_CHAT_ADD_MESSAGE"
    | "ONE_AND_ONE_CHAT_END"
    | "ONE_AND_ONE_CHAT_START"
    | "OPEN_ARS"
    | "OPEN_CHAT"
    | "OPEN_COMMON_FARM_INFO"
    | "OPEN_CONFIG"
    | "OPEN_CRAFT_ORDER_BOARD"
    | "OPEN_EMBLEM_IMPRINT_UI"
    | "OPEN_EMBLEM_UPLOAD_UI"
    | "OPEN_EXPEDITION_PORTAL_LIST"
    | "OPEN_MUSIC_SHEET"
    | "OPEN_NAVI_DOODAD_NAMING_DIALOG"
    | "OPEN_OTP"
    | "OPEN_PAPER"
    | "OPEN_PCCERT"
    | "OPEN_PROMOTION_EVENT_URL"
    | "OPEN_SECURE_CARD"
    | "OPEN_WORLD_QUEUE"
    | "OPTIMIZATION_RESULT_MESSAGE"
    | "OPTION_RESET"
    | "PASSENGER_MOUNT_PET"
    | "PASSENGER_UNMOUNT_PET"
    | "PET_AUTO_SKILL_CHANGED"
    | "PET_FOLLOWING_MASTER"
    | "PET_STOP_BY_MASTER"
    | "PETMATE_BOUND"
    | "PETMATE_UNBOUND"
    | "PLAYER_AA_POINT"
    | "PLAYER_ABILITY_LEVEL_CHANGED"
    | "PLAYER_BANK_AA_POINT"
    | "PLAYER_BANK_MONEY"
    | "PLAYER_BM_POINT"
    | "PLAYER_GEAR_POINT"
    | "PLAYER_HONOR_POINT"
    | "PLAYER_HONOR_POINT_CHANGED_IN_HPW"
    | "PLAYER_JURY_POINT"
    | "PLAYER_LEADERSHIP_POINT"
    | "PLAYER_LIVING_POINT"
    | "PLAYER_MONEY"
    | "PLAYER_RESURRECTED"
    | "PLAYER_RESURRECTION"
    | "PLAYER_VISUAL_RACE"
    | "POST_CRAFT_ORDER"
    | "PRELIMINARY_EQUIP_UPDATE"
    | "PREMIUM_FIRST_BUY_BONUS"
    | "PREMIUM_GRADE_CHANGE"
    | "PREMIUM_LABORPOWER_CHANGED"
    | "PREMIUM_POINT_CHANGE"
    | "PREMIUM_SERVICE_BUY_RESULT"
    | "PREMIUM_SERVICE_LIST_UPDATED"
    | "PROCESS_CRAFT_ORDER"
    | "PROGRESS_TALK_QUEST_CONTEXT"
    | "QUEST_CHAT_LET_IT_DONE"
    | "QUEST_CHAT_RESTART"
    | "QUEST_CONTEXT_CONDITION_EVENT"
    | "QUEST_CONTEXT_OBJECTIVE_EVENT"
    | "QUEST_CONTEXT_UPDATED"
    | "QUEST_DIRECTING_MODE_END"
    | "QUEST_DIRECTING_MODE_HOT_KEY"
    | "QUEST_ERROR_INFO"
    | "QUEST_HIDDEN_COMPLETE"
    | "QUEST_HIDDEN_READY"
    | "QUEST_LEFT_TIME_UPDATED"
    | "QUEST_MSG"
    | "QUEST_NOTIFIER_START"
    | "QUEST_QUICK_CLOSE_EVENT"
    | "RAID_APPLICANT_LIST"
    | "RAID_FRAME_SIMPLE_VIEW"
    | "RAID_RECRUIT_DETAIL"
    | "RAID_RECRUIT_HUD"
    | "RAID_RECRUIT_LIST"
    | "RANDOM_SHOP_INFO"
    | "RANDOM_SHOP_UPDATE"
    | "RANK_ALARM_MSG"
    | "RANK_DATA_RECEIVED"
    | "RANK_LOCK"
    | "RANK_PERSONAL_DATA"
    | "RANK_RANKER_APPEARANCE"
    | "RANK_REWARD_SNAPSHOTS"
    | "RANK_SEASON_RESULT_RECEIVED"
    | "RANK_SNAPSHOTS"
    | "RANK_UNLOCK"
    | "READY_TO_CONNECT_WORLD"
    | "RECOVERABLE_EXP"
    | "RECOVERED_EXP"
    | "REENTRY_NOTIFY_DISABLE"
    | "REENTRY_NOTIFY_ENABLE"
    | "REFRESH_COMBAT_RESOURCE"
    | "REFRESH_COMBAT_RESOURCE_UPDATE_TIME"
    | "REFRESH_SQUAD_LIST"
    | "REFRESH_STORE_MERCHANT_GOOD_LIMIT_PURCHASE"
    | "REFRESH_WORLD_QUEUE"
    | "RELOAD_CASH"
    | "REMOVE_BOSS_TELESCOPE_INFO"
    | "REMOVE_CARRYING_BACKPACK_SLAVE_INFO"
    | "REMOVE_FISH_SCHOOL_INFO"
    | "REMOVE_GIVEN_QUEST_INFO"
    | "REMOVE_NOTIFY_QUEST_INFO"
    | "REMOVE_PING"
    | "REMOVE_SHIP_TELESCOPE_INFO"
    | "REMOVE_TRANSFER_TELESCOPE_INFO"
    | "REMOVED_ITEM"
    | "RENAME_CHARACTER_FAILED"
    | "RENAME_PORTAL"
    | "RENEW_ITEM_SUCCEEDED"
    | "BAD_USER_LIST_UPDATE"
    | "REPORT_CRIME"
    | "REPRESENT_CHARACTER_RESULT"
    | "REPUTATION_GIVEN"
    | "REQUIRE_DELAY_TO_CHAT"
    | "REQUIRE_ITEM_TO_CHAT"
    | "RESET_INGAME_SHOP_MODELVIEW"
    | "RESIDENT_BOARD_TYPE"
    | "RESIDENT_HOUSING_TRADE_LIST"
    | "RESIDENT_MEMBER_LIST"
    | "RESIDENT_SERVICE_POINT_CHANGED"
    | "RESIDENT_TOWNHALL"
    | "RESIDENT_ZONE_STATE_CHANGE"
    | "ROLLBACK_FAVORITE_CRAFTS"
    | "RULING_CLOSED"
    | "RULING_STATUS"
    | "SAVE_PORTAL"
    | "SAVE_SCREEN_SHOT"
    | "SCALE_ENCHANT_BROADCAST"
    | "SCHEDULE_ITEM_SENT"
    | "SCHEDULE_ITEM_UPDATED"
    | "SECOND_PASSWORD_ACCOUNT_LOCKED"
    | "SECOND_PASSWORD_CHANGE_COMPLETED"
    | "SECOND_PASSWORD_CHECK_COMPLETED"
    | "SECOND_PASSWORD_CHECK_OVER_FAILED"
    | "SECOND_PASSWORD_CLEAR_COMPLETED"
    | "SECOND_PASSWORD_CREATION_COMPLETED"
    | "SELECT_SQUAD_LIST"
    | "SELECTED_INSTANCE_DIFFICULT"
    | "SELL_SPECIALTY"
    | "SELL_SPECIALTY_CONTENT_INFO"
    | "SENSITIVE_OPERATION_VERIFY"
    | "SENSITIVE_OPERATION_VERIFY_SUCCESS"
    | "SET_DEFAULT_EXPAND_RATIO"
    | "SET_EFFECT_ICON_VISIBLE"
    | "SET_LOGIN_BROWSER_URL"
    | "SET_OVERHEAD_MARK"
    | "SET_PING_MODE"
    | "SET_REBUILD_HOUSE_CAMERA_MODE"
    | "SET_ROADMAP_PICKABLE"
    | "SET_UI_MESSAGE"
    | "SET_WEB_MESSENGE_COUNT"
    | "SHOW_ACCUMULATE_HONOR_POINT_DURING_HPW"
    | "SHOW_ADD_TAB_WINDOW"
    | "SHOW_ADDED_ITEM"
    | "SHOW_BANNER"
    | "SHOW_CHARACTER_ABILITY_WINDOW"
    | "SHOW_CHARACTER_CREATE_WINDOW"
    | "SHOW_CHARACTER_CUSTOMIZE_WINDOW"
    | "SHOW_CHARACTER_SELECT_WINDOW"
    | "SHOW_CHAT_TAB_CONTEXT"
    | "SHOW_CRIME_RECORDS"
    | "SHOW_DEPENDANT_WAIT_JURY"
    | "SHOW_DEPENDANT_WAIT_TRIAL"
    | "SHOW_GAME_RATING"
    | "SHOW_HEALTH_NOTICE"
    | "SHOW_HIDDEN_BUFF"
    | "SHOW_LOGIN_WINDOW"
    | "SHOW_PRIVACY_POLICY_WINDOW"
    | "SHOW_RAID_FRAME_SETTINGS"
    | "SHOW_RECOMMEND_USING_SECOND_PASSWORD"
    | "SHOW_RENAME_EXPEIDITON"
    | "SHOW_ROADMAP_TOOLTIP"
    | "SHOW_SERVER_SELECT_WINDOW"
    | "SHOW_SEXTANT_POS"
    | "SHOW_SLAVE_INFO"
    | "SHOW_VERDICTS"
    | "SHOW_WORLDMAP_LOCATION"
    | "SHOW_WORLDMAP_TOOLTIP"
    | "SIEGE_APPOINT_RESULT"
    | "SIEGE_RAID_REGISTER_LIST"
    | "SIEGE_RAID_TEAM_INFO"
    | "SIEGE_WAR_ENDED"
    | "SIEGEWEAPON_BOUND"
    | "SIEGEWEAPON_UNBOUND"
    | "SIM_DOODAD_MSG"
    | "SKILL_ALERT_ADD"
    | "SKILL_ALERT_REMOVE"
    | "SKILL_CHANGED"
    | "SKILL_DEBUG_MSG"
    | "SKILL_LEARNED"
    | "SKILL_MAP_EFFECT"
    | "SKILL_MSG"
    | "SKILL_SELECTIVE_ITEM"
    | "SKILL_SELECTIVE_ITEM_NOT_AVAILABLE"
    | "SKILL_SELECTIVE_ITEM_READY_STATUS"
    | "SKILL_UPGRADED"
    | "SKILLS_RESET"
    | "SLAVE_SHIP_BOARDING"
    | "SLAVE_SHIP_UNBOARDING"
    | "SLAVE_SPAWN"
    | "SPAWN_PET"
    | "SPECIAL_ABILITY_LEARNED"
    | "SPECIALTY_CONTENT_RECIPE_INFO"
    | "SPECIALTY_RATIO_BETWEEN_INFO"
    | "SPELLCAST_START"
    | "SPELLCAST_STOP"
    | "SPELLCAST_SUCCEEDED"
    | "START_CHAT_BUBBLE"
    | "START_HERO_ELECTION_PERIOD"
    | "START_QUEST_CONTEXT"
    | "START_QUEST_CONTEXT_DOODAD"
    | "START_QUEST_CONTEXT_NPC"
    | "START_QUEST_CONTEXT_SPHERE"
    | "START_SENSITIVE_OPERATION"
    | "START_TALK_QUEST_CONTEXT"
    | "START_TODAY_ASSIGNMENT"
    | "STARTED_DUEL"
    | "STICKED_MSG"
    | "STILL_LOADING"
    | "STORE_ADD_BUY_ITEM"
    | "STORE_ADD_SELL_ITEM"
    | "STORE_BUY"
    | "STORE_FULL"
    | "STORE_SELL"
    | "STORE_SOLD_LIST"
    | "STORE_TRADE_FAILED"
    | "SURVEY_FORM_UPDATE"
    | "SWITCH_ENCHANT_ITEM_MODE"
    | "SYNC_PORTAL"
    | "SYS_INDUN_STAT_UPDATED"
    | "SYSMSG"
    | "TARGET_CHANGED"
    | "TARGET_NPC_HEALTH_CHANGED_FOR_DEFENCE_INFO"
    | "TARGET_OVER"
    | "TARGET_TO_TARGET_CHANGED"
    | "TEAM_JOINT_BREAK"
    | "TEAM_JOINT_BROKEN"
    | "TEAM_JOINT_CHAT"
    | "TEAM_JOINT_RESPONSE"
    | "TEAM_JOINT_TARGET"
    | "TEAM_JOINTED"
    | "TEAM_MEMBER_DISCONNECTED"
    | "TEAM_MEMBER_UNIT_ID_CHANGED"
    | "TEAM_MEMBERS_CHANGED"
    | "TEAM_ROLE_CHANGED"
    | "TEAM_SUMMON_SUGGEST"
    | "TENCENT_HEALTH_CARE_URL"
    | "TIME_MESSAGE"
    | "TOGGLE_CHANGE_VISUAL_RACE"
    | "TOGGLE_COMMUNITY"
    | "TOGGLE_CRAFT"
    | "TOGGLE_FACTION"
    | "TOGGLE_FOLLOW"
    | "TOGGLE_IN_GAME_NOTICE"
    | "TOGGLE_MEGAPHONE_CHAT"
    | "TOGGLE_PARTY_FRAME"
    | "TOGGLE_PET_MANAGE"
    | "TOGGLE_PORTAL_DIALOG"
    | "TOGGLE_RAID_FRAME"
    | "TOGGLE_RAID_FRAME_PARTY"
    | "TOGGLE_RAID_FRAME2"
    | "TOGGLE_ROADMAP"
    | "TOGGLE_WALK"
    | "TOWER_DEF_INFO_UPDATE"
    | "TOWER_DEF_MSG"
    | "TRADE_CAN_START"
    | "TRADE_CANCELED"
    | "TRADE_ITEM_PUTUP"
    | "TRADE_ITEM_TOOKDOWN"
    | "TRADE_ITEM_UPDATED"
    | "TRADE_LOCKED"
    | "TRADE_MADE"
    | "TRADE_MONEY_PUTUP"
    | "TRADE_OK"
    | "TRADE_OTHER_ITEM_PUTUP"
    | "TRADE_OTHER_ITEM_TOOKDOWN"
    | "TRADE_OTHER_LOCKED"
    | "TRADE_OTHER_MONEY_PUTUP"
    | "TRADE_OTHER_OK"
    | "TRADE_STARTED"
    | "TRADE_UI_TOGGLE"
    | "TRADE_UNLOCKED"
    | "TRANSFORM_COMBAT_RESOURCE"
    | "TRIAL_CANCELED"
    | "TRIAL_CLOSED"
    | "TRIAL_MESSAGE"
    | "TRIAL_STATUS"
    | "TRIAL_TIMER"
    | "TRY_LOOT_DICE"
    | "TUTORIAL_EVENT"
    | "TUTORIAL_HIDE_FROM_OPTION"
    | "UCC_IMPRINT_SUCCEEDED"
    | "UI_ADDON"
    | "UI_PERMISSION_UPDATE"
    | "UI_RELOADED"
    | "ULC_ACTIVATE"
    | "ULC_SKILL_MSG"
    | "UNFINISHED_BUILD_HOUSE"
    | "UNIT_COMBAT_STATE_CHANGED"
    | "UNIT_DEAD"
    | "UNIT_DEAD_NOTICE"
    | "UNIT_ENTERED_SIGHT"
    | "UNIT_EQUIPMENT_CHANGED"
    | "UNIT_KILL_STREAK"
    | "UNIT_LEAVED_SIGHT"
    | "UNIT_NAME_CHANGED"
    | "UNIT_NPC_EQUIPMENT_CHANGED"
    | "UNITFRAME_ABILITY_UPDATE"
    | "UNMOUNT_PET"
    | "UPDATE_BINDINGS"
    | "UPDATE_BOSS_TELESCOPE_AREA"
    | "UPDATE_BOSS_TELESCOPE_INFO"
    | "UPDATE_BOT_CHECK_INFO"
    | "BUBBLE_UPDATE"
    | "UPDATE_CARRYING_BACKPACK_SLAVE_INFO"
    | "UPDATE_CHANGE_VISUAL_RACE_WND"
    | "UPDATE_CHRONICLE_INFO"
    | "UPDATE_CHRONICLE_NOTIFIER"
    | "UPDATE_CLIENT_DRIVEN_INFO"
    | "UPDATE_COMPLETED_QUEST_INFO"
    | "UPDATE_CONTENT_ROSTER_WINDOW"
    | "UPDATE_CORPSE_INFO"
    | "UPDATE_CRAFT_ORDER_ITEM_FEE"
    | "UPDATE_CRAFT_ORDER_ITEM_SLOT"
    | "UPDATE_CRAFT_ORDER_SKILL"
    | "UPDATE_DEFENCE_INFO"
    | "UPDATE_DOMINION_INFO"
    | "UPDATE_DOODAD_INFO"
    | "UPDATE_DURABILITY_STATUS"
    | "UPDATE_DYEING_EXCUTABLE"
    | "UPDATE_ENCHANT_ITEM_MODE"
    | "UPDATE_EXPEDITION_PORTAL"
    | "UPDATE_EXPEDITION_TODAY_ASSIGNMENT_RESET_COUNT"
    | "UPDATE_FACTION_REZ_DISTRICT"
    | "UPDATE_FISH_SCHOOL_AREA"
    | "UPDATE_FISH_SCHOOL_INFO"
    | "UPDATE_GACHA_LOOT_MODE"
    | "UPDATE_GIVEN_QUEST_STATIC_INFO"
    | "UPDATE_HERO_ELECTION_CONDITION"
    | "UPDATE_HOUSING_INFO"
    | "UPDATE_HOUSING_TOOLTIP"
    | "UPDATE_INGAME_BEAUTYSHOP_STATUS"
    | "UPDATE_INGAME_SHOP"
    | "UPDATE_INGAME_SHOP_VIEW"
    | "UPDATE_INSTANT_GAME_INVITATION_COUNT"
    | "UPDATE_INSTANT_GAME_KILLSTREAK"
    | "UPDATE_INSTANT_GAME_KILLSTREAK_COUNT"
    | "UPDATE_INSTANT_GAME_SCORES"
    | "UPDATE_INSTANT_GAME_STATE"
    | "UPDATE_INSTANT_GAME_TARGET_NPC_INFO"
    | "UPDATE_INSTANT_GAME_TIME"
    | "UPDATE_ITEM_LOOK_CONVERT_MODE"
    | "UPDATE_MONITOR_NPC"
    | "UPDATE_MY_SLAVE_POS_INFO"
    | "UPDATE_NPC_INFO"
    | "UPDATE_INDUN_PLAYING_INFO_BROADCASTING"
    | "UPDATE_OPTION_BINDINGS"
    | "UPDATE_PING_INFO"
    | "UPDATE_RESTORE_CRAFT_ORDER_ITEM_MATERIAL"
    | "UPDATE_RESTORE_CRAFT_ORDER_ITEM_SLOT"
    | "UPDATE_RETURN_ACCOUNT_STATUS"
    | "UPDATE_ROADMAP_ANCHOR"
    | "UPDATE_ROSTER_MEMBER_INFO"
    | "UPDATE_ROUTE_MAP"
    | "UPDATE_SHIP_TELESCOPE_INFO"
    | "UPDATE_SHORTCUT_SKILLS"
    | "UPDATE_SIEGE_SCORE"
    | "UPDATE_SKILL_ACTIVE_TYPE"
    | "UPDATE_SLAVE_EQUIPMENT_SLOT"
    | "UPDATE_SPECIALTY_RATIO"
    | "UPDATE_SQUAD"
    | "UPDATE_TELESCOPE_AREA"
    | "UPDATE_TODAY_ASSIGNMENT"
    | "UPDATE_TODAY_ASSIGNMENT_RESET_COUNT"
    | "UPDATE_TRANSFER_TELESCOPE_AREA"
    | "UPDATE_TRANSFER_TELESCOPE_INFO"
    | "UPDATE_ZONE_INFO"
    | "UPDATE_ZONE_LEVEL_INFO"
    | "UPDATE_ZONE_PERMISSION"
    | "VIEW_CASH_BUY_WINDOW"
    | "WAIT_FRIEND_ADD_ALARM"
    | "WAIT_FRIENDLIST_UPDATE"
    | "WAIT_REPLY_FROM_SERVER"
    | "WATCH_TARGET_CHANGED"
    | "WEB_BROWSER_ESC_EVENT"
    | "WORLD_MESSAGE"
    | "ZONE_SCORE_CONTENT_STATE"
    | "ZONE_SCORE_UPDATED"

Method: ReleaseHandler

(method) Widget:ReleaseHandler(actionName: "OnAcceptFocus"|"OnAlphaAnimeEnd"|"OnBoundChanged"|"OnChangedAnchor"|"OnCheckChanged"...(+44))

Releases a handler for the specified action.

@param actionName — The action name to release.

actionName:
    | "OnAcceptFocus" -- Triggers when the widget accepts focus.
    | "OnAlphaAnimeEnd" -- Triggers when the widgets alpha animation has ended.
    | "OnBoundChanged" -- Triggers when the widgets ui bound has changed.
    | "OnChangedAnchor" -- Triggers when the widgets anchor has been changed.
    | "OnCheckChanged" -- triggers when the CheckButton widget check has been changed.
    | "OnClick" -- Triggers when the widget has been clicked.
    | "OnCloseByEsc" -- Triggers when the Window widget has been closed when the escape key has been pressed. Requires `widget:SetCloseOnEscape(true)`.
    | "OnContentUpdated" -- Triggers when the contents of a widget are updated.
    | "OnCursorMoved" -- Triggers when the EditboxMultiline widgets cursor has moved.
    | "OnDragReceive" -- Triggers when the Window widget has dragging enabled and drag is received.
    | "OnDragStart" -- Triggers when the Window widget has dragging enabled and drag has started.
    | "OnDragStop" -- Triggers when the Window widget has dragging enabled and drag has stopped.
    | "OnDynamicListUpdatedView" -- Triggers when he DynamicList widget view has updated.
    | "OnEffect" -- Triggers every frame while the widget is shown.
    | "OnEnableChanged" -- Triggers when the widget is enabled or disabled.
    | "OnEndFadeIn" -- Triggers when the widget has ended the fade in animation for showing the widget.
    | "OnEndFadeOut" -- Triggers when the widget has ended the fade out animation for hiding the widget.
    | "OnEnter" -- Triggers when the mouse enters the widgets ui bounds.
    | "OnEnterPressed" -- Triggers when the widget is focused and the enter key is pressed.
    | "OnEscapePressed" -- Triggers when the widget is focused and the escape key is pressed.
    | "OnEvent" -- Triggers when an event registered to the widget triggers.
    | "OnHide" -- Triggers when the widget is hidden.
    | "OnKeyDown" -- Triggers when the widget has keyboard enabled and the key has been pushed.
    | "OnKeyUp" -- Triggers when the widget has keyboard enabled and the key has been released.
    | "OnLeave" -- Triggers when mouse leaves the widgets ui bounds.
    | "OnListboxToggled" -- Triggers when the Listbox widget is toggled.
    | "OnModelChanged" -- triggers when the Model widget model changes.
    | "OnMouseDown" -- Triggers when the mouse left or right click is released while within the ui bounds of the widget.
    | "OnMouseMove" -- Triggers when the mouse moves while within the widgets ui bounds.
    | "OnMouseUp" -- Triggers when the mouse left or right click is pressed while within the ui bounds of the widget.
    | "OnMovedPosition" -- Triggers when the Window widget has dragging enabled and the widget has moved.
    | "OnPageChanged" -- Triggers when the Pageable widget page changes.
    | "OnPermissionChanged" -- Triggers when the permission changes.
    | "OnRadioChanged" -- Triggers when the RadioGroup widget radio changes.
    | "OnRestricted" -- #
    | "OnScale" -- Triggers when the widgets scale has been applied or set.
    | "OnScaleAnimeEnd" -- Triggers when the widgets scale animation has ended.
    | "OnSelChanged" -- Triggers when the Listbox or ListCtrl widget selection changes.
    | "OnShow" -- Triggers when the object is shown.
    | "OnSliderChanged" -- Triggers when the Slider widget slider changes.
    | "OnTabChanged" -- Triggers when the Tab widget tab changes.
    | "OnTextChanged" -- Triggers when the Editbox widget text changes.
    | "OnTooltip" -- Triggers when the Listbox widget should show a tooltip.
    | "OnUpdate" -- Triggers every frame while the widget is shown.
    | "OnVisibleChanged" -- Triggers when the widget is shown or hidden.
    | "OnWheelDown" -- Triggers when the mouse is within the widgets ui bounds and the mouse wheel is scrolled down.
    | "OnWheelUp" -- Triggers when the mouse is within the widgets ui bounds mouse wheel is scrolled up.
    | "PreClick" -- Triggers when the Slot widget is clicked.
    | "PreUse" -- Triggers when the Slot widget is clicked.

Method: IsNowAnimation

(method) Widget:IsNowAnimation()
  -> nowAnimation: boolean

Checks if the Widget is currently animating.

@return nowAnimation — true if animating, false otherwise.

Method: SetHandler

(method) Widget:SetHandler(actionName: "OnAcceptFocus"|"OnAlphaAnimeEnd"|"OnBoundChanged"|"OnChangedAnchor"|"OnCheckChanged"...(+44), handler: function)

Sets a handler for the specified action.

@param actionName — The action name.

@param handler — The handler function.

actionName:
    | "OnAcceptFocus" -- Triggers when the widget accepts focus.
    | "OnAlphaAnimeEnd" -- Triggers when the widgets alpha animation has ended.
    | "OnBoundChanged" -- Triggers when the widgets ui bound has changed.
    | "OnChangedAnchor" -- Triggers when the widgets anchor has been changed.
    | "OnCheckChanged" -- triggers when the CheckButton widget check has been changed.
    | "OnClick" -- Triggers when the widget has been clicked.
    | "OnCloseByEsc" -- Triggers when the Window widget has been closed when the escape key has been pressed. Requires `widget:SetCloseOnEscape(true)`.
    | "OnContentUpdated" -- Triggers when the contents of a widget are updated.
    | "OnCursorMoved" -- Triggers when the EditboxMultiline widgets cursor has moved.
    | "OnDragReceive" -- Triggers when the Window widget has dragging enabled and drag is received.
    | "OnDragStart" -- Triggers when the Window widget has dragging enabled and drag has started.
    | "OnDragStop" -- Triggers when the Window widget has dragging enabled and drag has stopped.
    | "OnDynamicListUpdatedView" -- Triggers when he DynamicList widget view has updated.
    | "OnEffect" -- Triggers every frame while the widget is shown.
    | "OnEnableChanged" -- Triggers when the widget is enabled or disabled.
    | "OnEndFadeIn" -- Triggers when the widget has ended the fade in animation for showing the widget.
    | "OnEndFadeOut" -- Triggers when the widget has ended the fade out animation for hiding the widget.
    | "OnEnter" -- Triggers when the mouse enters the widgets ui bounds.
    | "OnEnterPressed" -- Triggers when the widget is focused and the enter key is pressed.
    | "OnEscapePressed" -- Triggers when the widget is focused and the escape key is pressed.
    | "OnEvent" -- Triggers when an event registered to the widget triggers.
    | "OnHide" -- Triggers when the widget is hidden.
    | "OnKeyDown" -- Triggers when the widget has keyboard enabled and the key has been pushed.
    | "OnKeyUp" -- Triggers when the widget has keyboard enabled and the key has been released.
    | "OnLeave" -- Triggers when mouse leaves the widgets ui bounds.
    | "OnListboxToggled" -- Triggers when the Listbox widget is toggled.
    | "OnModelChanged" -- triggers when the Model widget model changes.
    | "OnMouseDown" -- Triggers when the mouse left or right click is released while within the ui bounds of the widget.
    | "OnMouseMove" -- Triggers when the mouse moves while within the widgets ui bounds.
    | "OnMouseUp" -- Triggers when the mouse left or right click is pressed while within the ui bounds of the widget.
    | "OnMovedPosition" -- Triggers when the Window widget has dragging enabled and the widget has moved.
    | "OnPageChanged" -- Triggers when the Pageable widget page changes.
    | "OnPermissionChanged" -- Triggers when the permission changes.
    | "OnRadioChanged" -- Triggers when the RadioGroup widget radio changes.
    | "OnRestricted" -- #
    | "OnScale" -- Triggers when the widgets scale has been applied or set.
    | "OnScaleAnimeEnd" -- Triggers when the widgets scale animation has ended.
    | "OnSelChanged" -- Triggers when the Listbox or ListCtrl widget selection changes.
    | "OnShow" -- Triggers when the object is shown.
    | "OnSliderChanged" -- Triggers when the Slider widget slider changes.
    | "OnTabChanged" -- Triggers when the Tab widget tab changes.
    | "OnTextChanged" -- Triggers when the Editbox widget text changes.
    | "OnTooltip" -- Triggers when the Listbox widget should show a tooltip.
    | "OnUpdate" -- Triggers every frame while the widget is shown.
    | "OnVisibleChanged" -- Triggers when the widget is shown or hidden.
    | "OnWheelDown" -- Triggers when the mouse is within the widgets ui bounds and the mouse wheel is scrolled down.
    | "OnWheelUp" -- Triggers when the mouse is within the widgets ui bounds mouse wheel is scrolled up.
    | "PreClick" -- Triggers when the Slot widget is clicked.
    | "PreUse" -- Triggers when the Slot widget is clicked.

Method: SetLText

(method) Widget:SetLText(category: `ABILITY_CATEGORY_DESCRIPTION_TEXT`|`ABILITY_CATEGORY_TEXT`|`ABILITY_CHANGER_TEXT`|`ATTRIBUTE_TEXT`|`ATTRIBUTE_VARIATION_TEXT`...(+117), key: string, ...string)

Sets localized text for the Widget with multiple optional parameters.

@param category — The UI text category. (default: COMMON_TEXT)

@param key — The key from the database ui_texts table.

@param ... — Arguments to replace placeholders (must match number of $).

-- api/Addon
category:
    | `ABILITY_CATEGORY_DESCRIPTION_TEXT`
    | `ABILITY_CATEGORY_TEXT`
    | `ABILITY_CHANGER_TEXT`
    | `ATTRIBUTE_TEXT`
    | `ATTRIBUTE_VARIATION_TEXT`
    | `AUCTION_TEXT`
    | `BATTLE_FIELD_TEXT`
    | `BEAUTYSHOP_TEXT`
    | `BINDING`
    | `BUTLER`
    | `CASTING_BAR_TEXT`
    | `CHARACTER_CREATE_TEXT`
    | `CHARACTER_POPUP_SUBTITLE_TEXT`
    | `CHARACTER_POPUP_SUBTITLE_TOOLTIP_TEXT`
    | `CHARACTER_SELECT_TEXT`
    | `CHARACTER_SUBTITLE_INFO_TOOLTIP_TEXT`
    | `CHARACTER_SUBTITLE_TEXT`
    | `CHARACTER_SUBTITLE_TOOLTIP_TEXT`
    | `CHARACTER_TITLE_TEXT`
    | `CHAT_CHANNEL_TEXT`
    | `CHAT_COMBAT_LOG_TEXT`
    | `CHAT_CREATE_TAB_TEXT`
    | `CHAT_FILTERING`
    | `CHAT_FORCE_ATTACK_TEXT`
    | `CHAT_LIST_TEXT`
    | `CHAT_SYSTEM_TEXT`
    | `COMBAT_MESSAGE_TEXT`
    | `COMBAT_TEXT`
    | `COMBINED_ABILITY_NAME_TEXT`
    | `COMMON_TEXT`
    | `COMMUNITY_TEXT`
    | `COMPOSITION_TEXT`
    | `CRAFT_TEXT`
    | `CUSTOMIZING_TEXT`
    | `DATE_TIME_TEXT`
    | `DOMINION`
    | `DUEL_TEXT`
    | `EQUIP_SLOT_TYPE_TEXT`
    | `ERROR_MSG`
    | `EXPEDITION_TEXT`
    | `FACTION_TEXT`
    | `FARM_TEXT`
    | `GENDER_TEXT`
    | `GRAVE_YARD_TEXT`
    | `HERO_TEXT`
    | `HONOR_POINT_WAR_TEXT`
    | `HOUSING_PERMISSIONS_TEXT`
    | `HOUSING_TEXT`
    | `INFOBAR_MENU_TEXT`
    | `INFOBAR_MENU_TIP_TEXT`
    | `INGAMESHOP_TEXT`
    | `INSTANT_GAME_TEXT`
    | `INVEN_TEXT`
    | `ITEM_GRADE`
    | `ITEM_LOOK_CONVERT_TEXT`
    | `KEY_BINDING_TEXT`
    | `LEARNING_TEXT`
    | `LEVEL_CHANGED_TEXT`
    | `LOADING_TEXT`
    | `LOGIN_CROWDED_TEXT`
    | `LOGIN_DELETE_TEXT`
    | `LOGIN_ERROR`
    | `LOGIN_TEXT`
    | `LOOT_METHOD_TEXT`
    | `LOOT_TEXT`
    | `MAIL_TEXT`
    | `MAP_TEXT`
    | `MONEY_TEXT`
    | `MSG_BOX_BODY_TEXT`
    | `MSG_BOX_BTN_TEXT`
    | `MSG_BOX_TITLE_TEXT`
    | `MUSIC_TEXT`
    | `NATION_TEXT`
    | `OPTION_TEXT`
    | `PARTY_TEXT`
    | `PERIOD_TIME_TEXT`
    | `PET_TEXT`
    | `PHYSICAL_ENCHANT_TEXT`
    | `PLAYER_POPUP_TEXT`
    | `PORTAL_TEXT`
    | `PREMIUM_TEXT`
    | `PRIEST_TEXT`
    | `PROTECT_SENSITIVE_OPERATION_TEXT`
    | `QUEST_ACT_OBJ_PTN_TEXT`
    | `QUEST_ACT_OBJ_TEXT`
    | `QUEST_CONDITION_TEXT`
    | `QUEST_DISTANCE_TEXT`
    | `QUEST_ERROR`
    | `QUEST_INTERACTION_TEXT`
    | `QUEST_OBJ_STATUS_TEXT`
    | `QUEST_SPHERE_TEXT`
    | `QUEST_STATUS_TEXT`
    | `QUEST_TEXT`
    | `RACE_DETAIL_DESCRIPTION_TEXT`
    | `RACE_TEXT`
    | `RAID_TEXT`
    | `RANKING_TEXT`
    | `REPAIR_TEXT`
    | `RESTRICT_TEXT`
    | `SECOND_PASSWORD_TEXT`
    | `SERVER_TEXT`
    | `SKILL_TEXT`
    | `SKILL_TRAINING_MSG_TEXT`
    | `SLAVE_KIND`
    | `SLAVE_TEXT`
    | `STABLER_TEXT`
    | `STORE_TEXT`
    | `TARGET_POPUP_TEXT`
    | `TEAM_TEXT`
    | `TERRITORY_TEXT`
    | `TIME`
    | `TOOLTIP_TEXT`
    | `TRADE_TEXT`
    | `TRIAL_TEXT`
    | `TUTORIAL_TEXT`
    | `UCC_TEXT`
    | `UNIT_FRAME_TEXT`
    | `UNIT_GRADE_TEXT`
    | `UNIT_KIND_TEXT`
    | `UTIL_TEXT`
    | `WEB_TEXT`
    | `WINDOW_TITLE_TEXT`

Method: StartMoving

(method) Widget:StartMoving()

Starts moving the Widget. Should be used in conjunction with Widget:StopMovingOrSizing.
widget:SetHandler("OnDragStart", function(self)
  self:StartMoving()
end)

widget:SetHandler("OnDragStop", function(self)
  self:StopMovingOrSizing()
end)

Method: Show

(method) Widget:Show(show: boolean, fadeTime?: number)

Shows or hides the widget and enables/disables its "OnUpdate" handler. Showing before the extents and anchors are set can cause issues.

@param show — true to show, false to hide. (default: false)

@param fadeTime — The optional fade duration in milliseconds.

Method: SetText

(method) Widget:SetText(text: string)

Sets the text for the Widget.

@param text — The text to set.

Method: SetStartAnimation

(method) Widget:SetStartAnimation(alpha: boolean, scale: boolean)

Enables or disables start animations for alpha and scale.

@param alpha — true to enable alpha animation, false to disable. (default: false)

@param scale — true to enable scale animation, false to disable. (default: false)

Method: StartSizing

(method) Widget:StartSizing(anchorPoint: "BOTTOM"|"BOTTOMLEFT"|"BOTTOMRIGHT"|"CENTER"|"LEFT"...(+4))

Starts resizing the Widget from the specified anchor point.

@param anchorPoint — The anchor point for resizing.
anchorPoint:
    | "TOPLEFT"
    | "TOP"
    | "TOPRIGHT"
    | "LEFT"
    | "CENTER"
    | "RIGHT"
    | "BOTTOMLEFT"
    | "BOTTOM"
    | "BOTTOMRIGHT"

Method: TriggerMoveAnimation

(method) Widget:TriggerMoveAnimation(on: boolean)

Triggers or stops the move animation of the Widget.

@param on — true to start the animation, false to stop.

Method: StopMovingOrSizing

(method) Widget:StopMovingOrSizing()

Stops moving or resizing the Widget.
widget:SetHandler("OnDragStop", function(self)
  self:StopMovingOrSizing()
end)

Method: UseDynamicContentState

(method) Widget:UseDynamicContentState(use: boolean)

Enables or disables dynamic content state for the widget.

@param use — true to enable, false to disable.

Method: SetLText

(method) Widget:SetLText(key: string, ...string)

Sets localized text for the Widget with multiple optional parameters.

@param key — The key from the database ui_texts table under the COMMON_TEXT category.

@param ... — Arguments to replace placeholders (must match number of $).

Method: SetSounds

(method) Widget:SetSounds(name: "ability_change"|"achievement"|"auction"|"auction_put_up"|"bag"...(+45))

Sets the sounds to play for the Widget, this plays differently for each type of widget, for instance a button will play its sound when clicked, and a window will play its sound when shown/hidden.

@param name — The sound name.

name:
    | "ability_change"
    | "achievement"
    | "auction"
    | "auction_put_up"
    | "bag"
    | "bank"
    | "battlefield_entrance"
    | "character_info"
    | "coffer"
    | "common_farm_info"
    | "community"
    | "composition_score"
    | "config"
    | "cosmetic_details"
    | "craft"
    | "crime_records"
    | "default_r"
    | "dialog_common"
    | "dialog_enter_beautyshop"
    | "dialog_gender_transfer"
    | "dyeing"
    | "edit_box"
    | "item_enchant"
    | "loot"
    | "mail"
    | "mail_read"
    | "mail_write"
    | "my_farm_info"
    | "option"
    | "pet_info"
    | "portal"
    | "prelim_equipment"
    | "quest_context_list"
    | "quest_directing_mode"
    | "raid_team"
    | "ranking"
    | "ranking_reward"
    | "skill_book"
    | "store"
    | "store_drain"
    | "submenu"
    | "trade"
    | "tutorial"
    | "ucc"
    | "wash"
    | "web_messenger"
    | "web_note"
    | "web_play_diary"
    | "web_wiki"
    | "world_map"

Method: SetScale

(method) Widget:SetScale(scale: number)

Sets the scale of the Widget.

@param scale — The scale value.

Method: SetMaxResizingExtent

(method) Widget:SetMaxResizingExtent(width: number, height: number)

Sets the maximum resizing extent for the Widget.

@param width — The maximum width.

@param height — The maximum height.

Method: SetLayerColor

(method) Widget:SetLayerColor(r: number, g: number, b: number, a: number, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")

Sets the color for the specified layer.

@param r — Red value (min: 0, max: 1).

@param g — Green value (min: 0, max: 1).

@param b — Blue value (min: 0, max: 1).

@param a — Alpha value (min: 0, max: 1).

@param nameLayer — The layer to apply the color to.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: SetScaleAnimation

(method) Widget:SetScaleAnimation(initialScale: number, finalScale: number, velocityTime: number, accelerationTime: number, scaleAnchor: "BOTTOM"|"BOTTOMLEFT"|"BOTTOMRIGHT"|"CENTER"|"LEFT"...(+4))

Sets a scale animation for the Widget. Requires widget:SetStartAnimation.

@param initialScale — The starting scale (must be greater than 0).

@param finalScale — The ending scale.

@param velocityTime — Duration in seconds for velocity.

@param accelerationTime — Duration in seconds for acceleration.

@param scaleAnchor — The anchor point for scaling.
scaleAnchor:
    | "TOPLEFT"
    | "TOP"
    | "TOPRIGHT"
    | "LEFT"
    | "CENTER"
    | "RIGHT"
    | "BOTTOMLEFT"
    | "BOTTOM"
    | "BOTTOMRIGHT"

Method: SetMinResizingExtent

(method) Widget:SetMinResizingExtent(width: number, height: number)

Sets the minimum resizing extent for the Widget.

@param width — The minimum width.

@param height — The minimum height.

Method: SetResizingBorderSize

(method) Widget:SetResizingBorderSize(left: number, top: number, right: number, bottom: number)

Sets the resizing border size for the Widget. SetMinResizingExtent and SetMaxResizingExtent must be called or this can cause a crash!

@param left — The left border size.

@param top — The top border size.

@param right — The right border size.

@param bottom — The bottom border size.
widget:SetResizingBorderSize(10, 10, 10, 10)
widget:SetMinResizingExtent(345, 160)
widget:SetMaxResizingExtent(1050, 1020)

Method: SetMoveAnimation

(method) Widget:SetMoveAnimation(direction: string, delta: number, time: number, repeatAnimation: number)

Sets a move animation for the Widget.

@param direction — The direction of the animation.

@param delta — The movement distance.

@param time — The duration in seconds.

@param repeatAnimation — The number of animation repetitions.

Method: SetRotation

(method) Widget:SetRotation(rs: string)

Sets the rotation of the widget.

@param rs — The rotation value.

Method: UseDynamicDrawableState

(method) Widget:UseDynamicDrawableState(nameLayer: "artwork"|"background"|"overlay"|"overoverlay", use: boolean)

Enables or disables dynamic drawable state for the specified layer.

@param nameLayer — The layer to modify.

@param use — true to enable, false to disable.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: IsMouseOver

(method) Widget:IsMouseOver()
  -> mouseOver: boolean

Checks if the mouse is over the Widget.

@return mouseOver — true if the mouse is over, false otherwise.

Method: IsDescendantWidget

(method) Widget:IsDescendantWidget(id: string)
  -> descendantWidget: boolean

Checks if the specified ID is a descendant of the Widget.

@param id — The ID to check.

@return descendantWidget — true if the ID is a descendant, false otherwise.
local button = widget:CreateChildWidget("button", "exampleButton", 0, true)
local descendantWidget = widget:IsDescendantWidget(button:GetId())

Method: CreateImageDrawable

(method) Widget:CreateImageDrawable(texturePath: string, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: ImageDrawable|nil

Requires importing the ImageDrawable Object.

Creates an image drawable for the specified texture and layer. Addon images can be used Addon/{addonname}/example.dds

@param texturePath — The texture path.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created image drawable, an empty table if the object ImageDrawable hasn’t been imported, or nil if the texture doesn’t exist.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: ImageDrawable

Method: CreateIconDrawable

(method) Widget:CreateIconDrawable(nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: IconDrawable

Requires importing the IconDrawable Object.

Creates an icon drawable for the specified layer.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created icon drawable, or an empty table if the object IconDrawable hasn’t been imported.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: IconDrawable

Method: CreateEffectDrawableByKey

(method) Widget:CreateEffectDrawableByKey(texturePath: string, textureKey: string, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: EffectDrawable

Requires importing the EffectDrawable Object.

Creates an effect drawable using a key for the specified texture and layer.

@param texturePath — The texture name.

@param textureKey — The texture key.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created effect drawable, or an empty table if the object EffectDrawable hasn’t been imported.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: EffectDrawable

Method: CreateEffectDrawable

(method) Widget:CreateEffectDrawable(texturePath: string, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: EffectDrawable|nil

Requires importing the EffectDrawable Object.

Creates an effect drawable for the specified texture and layer.

@param texturePath — The texture name.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created effect drawable, an empty table if the object EffectDrawable hasn’t been imported, or nil if the texture doesn’t exist.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: EffectDrawable

Method: CreateNinePartDrawable

(method) Widget:CreateNinePartDrawable(texturePath: string, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: NinePartDrawable

Requires importing the NinePartDrawable Object.

Creates a nine-part drawable for the specified texture and layer.

@param texturePath — The texture path.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created nine-part drawable, or an empty table if the object NinePartDrawable hasn’t been imported.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: NinePartDrawable

Method: CreateThreeColorDrawable

(method) Widget:CreateThreeColorDrawable(width: number, height: number, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: ThreeColorDrawable

Requires importing the ThreeColorDrawable Object.

Creates a three-color drawable for the specified dimensions and layer.

@param width — The width of the drawable.

@param height — The height of the drawable.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created three-color drawable, or an empty table if the object ThreeColorDrawable hasn’t been imported.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: ThreeColorDrawable

Method: CreateTextDrawable

(method) Widget:CreateTextDrawable(fontPath: "font_combat"|"font_main"|"font_sub", fontSize: number, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: TextDrawable

Requires importing the TextDrawable Object.

Creates a text drawable for the specified font and size.

@param fontPath — The font path.

@param fontSize — The font size.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created text drawable, or an empty table if the object TextDrawable hasn’t been imported.
fontPath:
    | "font_main"
    | "font_sub"
    | "font_combat"

-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: TextDrawable

Method: CreateThreePartDrawable

(method) Widget:CreateThreePartDrawable(texturePath: string, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: ThreePartDrawable

Requires importing the ThreePartDrawable Object.

Creates a three-part drawable for the specified texture and layer.

@param texturePath — The texture path.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created three-part drawable, or an empty table if the object ThreePartDrawable hasn’t been imported.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: ThreePartDrawable

Method: DetachWidget

(method) Widget:DetachWidget()

Detaches the Widget from its parent.

Method: CreateDrawable

(method) Widget:CreateDrawable(texturePath: string, textureKey: string, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: DrawableDDS

Requires importing the correct Drawable Object type for the textureKey.

Creates a drawable from the specified texture path and key. The key’s type will define what drawableType object needs to be imported. Casting the return to the appropriate type may be neccessary.

@param texturePath — The texture path.

@param textureKey — The texture key taken from the path *.g file.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created drawable, or an empty table if the object DrawableDDS hasn’t been imported.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: CreateColorDrawable

(method) Widget:CreateColorDrawable(r: number, g: number, b: number, a: number, nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: ColorDrawable

Requires importing the ColorDrawable Object.

Creates a color drawable for the specified layer.

@param r — Red value (min: 0, max: 1).

@param g — Green value (min: 0, max: 1).

@param b — Blue value (min: 0, max: 1).

@param a — Alpha value (min: 0, max: 1).

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created color drawable, or an empty table if the object ColorDrawable hasn’t been imported.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4
See: ColorDrawable

Method: CancelRequestCharacterCacheData

(method) Widget:CancelRequestCharacterCacheData()

Cancels the request for character cache data.

Method: AttachWidget

(method) Widget:AttachWidget(widget: Widget)

Attaches a widget to the current Widget.

@param widget — The widget to attach.

Method: CreateColorDrawableByKey

(method) Widget:CreateColorDrawableByKey(colorKey: "action_slot_state_img_able"|"action_slot_state_img_can_learn"|"action_slot_state_img_cant_or_not_learn"|"action_slot_state_img_disable"|"common_black_bg"...(+27), nameLayer: "artwork"|"background"|"overlay"|"overoverlay")
  -> drawable: ColorDrawable

Requires importing the ColorDrawable Object.

Creates a color drawable using a color key for the specified layer.

@param colorKey — The color key to use.

@param nameLayer — The layer to apply the drawable to.

@return drawable — The created color drawable, or an empty table if the object ColorDrawable hasn’t been imported.

-- ui/setting/etc_color.g
colorKey:
    | "action_slot_state_img_able"
    | "action_slot_state_img_can_learn"
    | "action_slot_state_img_cant_or_not_learn"
    | "action_slot_state_img_disable"
    | "common_black_bg"
    | "common_white_bg"
    | "craft_step_disable"
    | "craft_step_enable"
    | "editbox_cursor_default"
    | "editbox_cursor_light"
    | "icon_button_overlay_black"
    | "icon_button_overlay_none"
    | "icon_button_overlay_red"
    | "icon_button_overlay_yellow"
    | "login_stage_black_bg"
    | "map_hp_bar_bg"
    | "map_hp_bar"
    | "market_price_column_over"
    | "market_price_last_column"
    | "market_price_line_daily"
    | "market_price_line_weekly"
    | "market_price_volume"
    | "market_prict_cell"
    | "quest_content_directing_fade_in"
    | "quest_content_directing_fade_out"
    | "quest_content_directing_under_panel"
    | "quick_slot_bg"
    | "texture_check_window_bg"
    | "texture_check_window_data_label"
    | "texture_check_window_rect"
    | "texture_check_window_tooltip_bg"
    | "web_browser_background"

-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

See: ColorDrawable

Method: ChangeChildAnchorByScrollValue

(method) Widget:ChangeChildAnchorByScrollValue(typeStr: "horz"|"vert", value: number)

Changes the child anchor based on scroll value for the specified direction.

@param typeStr — The scroll direction (horizontal or vertical).

@param value — The scroll value.
typeStr:
    | "horz"
    | "vert"

Method: CreateChildWidget

(method) Widget:CreateChildWidget(objectTypeStr: "avi"|"button"|"chatwindow"|"checkbutton"|"circlediagram"...(+34), name: string, index: number, reflectToScriptTable: boolean)
  -> widget: Widget

Creates and returns a child widget, attaching it as a property to the Widget, and gives the widget a draw priority z-index.

@param objectTypeStr — The type of widget to create.

@param name — The name of the widget.

@param index — The index of the widget, 0 sets widget.name whereas any number above 0 sets widget.name[index].

@param reflectToScriptTable — Whether to attach the widget to the script table under its name.

@return widget — The created child widget, empty table if the widget hasn’t been imported, or nil if creation fails.
local button = widget:CreateChildWidget("button", "exampleButton", 0, true)
-- widget.exampleButton This is automatically set by this method.
objectTypeStr:
    | "avi"
    | "button"
    | "chatwindow"
    | "checkbutton"
    | "circlediagram"
    | "colorpicker"
    | "combobox"
    | "cooldownbutton"
    | "cooldownconstantbutton"
    | "cooldowninventorybutton"
    | "damagedisplay"
    | "dynamiclist"
    | "editbox"
    | "editboxmultiline"
    | "emptywidget"
    | "folder"
    | "gametooltip"
    | "grid"
    | "label"
    | "line"
    | "listbox"
    | "listctrl"
    | "megaphonechatedit"
    | "message"
    | "modelview"
    | "pageable"
    | "paintcolorpicker"
    | "radiogroup"
    | "roadmap"
    | "slider"
    | "slot"
    | "statusbar"
    | "tab"
    | "textbox"
    | "unitframetooltip"
    | "webbrowser"
    | "window"
    | "worldmap"
    | "x2editbox"
See: Widget

Method: Clickable

(method) Widget:Clickable(clickable: boolean)

Enables or disables clickability for the Widget. (default: true)

@param clickable — true to enable clicking, false to disable.

Method: CreateChildWidgetByType

(method) Widget:CreateChildWidgetByType(objectType: `0`|`10`|`11`|`12`|`13`...(+51), name: string, index: number, reflectToScriptTable: boolean)
  -> widget: Widget

Creates and returns a child widget by type and gives the widget a draw priority z-index.

@param objectType — The type of widget to create.

@param name — The name of the widget.

@param index — The index of the widget, 0 sets widget.name whereas any number above 0 sets widget.name[index].

@param reflectToScriptTable — Whether to attach the widget to the script table.

@return widget — The created child widget, empty table if the widget hasn’t been imported, or nil if creation fails.

local button = widget:CreateChildWidgetByType(OBJECT.Button, "exampleButton", 0, true)
-- widget.exampleButton This is automatically set by this method.

objectType:
    | `0` -- Window
    | `1` -- Label
    | `2` -- Button
    | `3` -- Editbox
    | `4` -- EditboxMultiline
    | `5` -- Listbox
    | `6` -- Drawable
    | `7` -- ColorDrawable
    | `8` -- NinePartDrawable
    | `9` -- ThreePartDrawable
    | `10` -- ImageDrawable
    | `11` -- IconDrawable
    | `12` -- TextDrawable
    | `13` -- TextStyle
    | `14` -- ThreeColorDrawable
    | `15` -- EffectDrawable
    | `16` -- Message
    | `17` -- StatusBar
    | `18` -- GameTooltip
    | `19` -- UnitframeTooltip
    | `20` -- CooldownButton
    | `21` -- CooldownInventoryButton
    | `22` -- CooldownConstantButton
    | `23` -- CheckButton
    | `24` -- Slider
    | `25` -- Pageable
    | `26` -- WorldMap
    | `27` -- RoadMap
    | `28` -- Grid
    | `29` -- ModelView
    | `30` -- Webbrowser
    | `31` -- CircleDiagram
    | `32` -- ColorPicker
    | `33` -- PaintColorPicker
    | `34` -- Folder
    | `35` -- DamageDisplay
    | `36` -- Tab
    | `37` -- SliderTab
    | `38` -- ChatWindow
    | `39` -- Textbox
    | `40` -- Combobox
    | `41` -- ComboListButton
    | `42` -- ChatMessage
    | `43` -- ChatEdit
    | `44` -- MegaphoneChatEdit
    | `45` -- ListCtrl
    | `46` -- EmptyWidget
    | `47` -- Slot
    | `48` -- Line
    | `49` -- Root
    | `50` -- TextureDrawable
    | `51` -- Webview
    | `52` -- Avi
    | `53` -- X2Editbox
    | `54` -- DynamicList
    | `55` -- RadioGroup

See: Widget

Method: IsEnabled

(method) Widget:IsEnabled()
  -> enabled: boolean

Checks if the Widget is enabled.

@return enabled — true if enabled, false otherwise.

Method: DisableDrawables

(method) Widget:DisableDrawables(nameLayer: "artwork"|"background"|"overlay"|"overoverlay")

Disables drawables for the specified layer.

@param nameLayer — The layer to disable.

-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: Enable

(method) Widget:Enable(enable: boolean, enableChildren?: boolean)

Enables or disables the Widget, changes the state of the widget if supported, and enables or disables its handler actions:

"OnClick"

"OnMouseDown"

"OnMouseMove"

"OnMouseUp"

@param enable — true to enable, false to disable. (default: true)

@param enableChildren — true to enable, false to disable. (default: true)

Method: GetText

(method) Widget:GetText()
  -> text: string

Retrieves the text of the Widget.

@return text — The text content.

Method: GetRotation

(method) Widget:GetRotation()
  -> rotation: string|nil

Retrieves the rotation of the widget.

Method: GetParent

(method) Widget:GetParent()
  -> parentWidget: Widget

Retrieves the parent widget of the Widget. Returns the current widget if no parent exists. Casting the return to the appropriate type may be neccessary.

@return parentWidget — The parent widget.

Method: GetAttachedWidget

(method) Widget:GetAttachedWidget()
  -> attachedWidget: Widget|nil

Retrieves the last attached widget of the Widget. Casting the return to the appropriate type may be neccessary.

@return attachedWidget — The attached widget, or nil if none.

See: Widget

Method: GetUILayer

(method) Widget:GetUILayer()
  -> uiLayer: "background"|"dialog"|"game"|"hud"|"normal"...(+3)

Retrieves the UI layer of the Widget.

@return uiLayer — The UI layer. (default: "normal")

-- Widgets with layers of the same level and parent can overlap based on focus.
uiLayer:
    | "background" -- Layer 0 (invisible)
    | "game" -- Layer 1
   -> "normal" -- Layer 2 (default)
    | "hud" -- Layer 3
    | "questdirecting" -- Layer 4
    | "dialog" -- Layer 5
    | "tooltip" -- Layer 6
    | "system" -- Layer 7

Method: HasHandler

(method) Widget:HasHandler(actionName: "OnAcceptFocus"|"OnAlphaAnimeEnd"|"OnBoundChanged"|"OnChangedAnchor"|"OnCheckChanged"...(+44))
  -> handlerExists: boolean

Checks if the Widget has a handler for the specified action.

@param actionName — The action name to check.

@return handlerExists — true if a handler exists, false otherwise.

actionName:
    | "OnAcceptFocus" -- Triggers when the widget accepts focus.
    | "OnAlphaAnimeEnd" -- Triggers when the widgets alpha animation has ended.
    | "OnBoundChanged" -- Triggers when the widgets ui bound has changed.
    | "OnChangedAnchor" -- Triggers when the widgets anchor has been changed.
    | "OnCheckChanged" -- triggers when the CheckButton widget check has been changed.
    | "OnClick" -- Triggers when the widget has been clicked.
    | "OnCloseByEsc" -- Triggers when the Window widget has been closed when the escape key has been pressed. Requires `widget:SetCloseOnEscape(true)`.
    | "OnContentUpdated" -- Triggers when the contents of a widget are updated.
    | "OnCursorMoved" -- Triggers when the EditboxMultiline widgets cursor has moved.
    | "OnDragReceive" -- Triggers when the Window widget has dragging enabled and drag is received.
    | "OnDragStart" -- Triggers when the Window widget has dragging enabled and drag has started.
    | "OnDragStop" -- Triggers when the Window widget has dragging enabled and drag has stopped.
    | "OnDynamicListUpdatedView" -- Triggers when he DynamicList widget view has updated.
    | "OnEffect" -- Triggers every frame while the widget is shown.
    | "OnEnableChanged" -- Triggers when the widget is enabled or disabled.
    | "OnEndFadeIn" -- Triggers when the widget has ended the fade in animation for showing the widget.
    | "OnEndFadeOut" -- Triggers when the widget has ended the fade out animation for hiding the widget.
    | "OnEnter" -- Triggers when the mouse enters the widgets ui bounds.
    | "OnEnterPressed" -- Triggers when the widget is focused and the enter key is pressed.
    | "OnEscapePressed" -- Triggers when the widget is focused and the escape key is pressed.
    | "OnEvent" -- Triggers when an event registered to the widget triggers.
    | "OnHide" -- Triggers when the widget is hidden.
    | "OnKeyDown" -- Triggers when the widget has keyboard enabled and the key has been pushed.
    | "OnKeyUp" -- Triggers when the widget has keyboard enabled and the key has been released.
    | "OnLeave" -- Triggers when mouse leaves the widgets ui bounds.
    | "OnListboxToggled" -- Triggers when the Listbox widget is toggled.
    | "OnModelChanged" -- triggers when the Model widget model changes.
    | "OnMouseDown" -- Triggers when the mouse left or right click is released while within the ui bounds of the widget.
    | "OnMouseMove" -- Triggers when the mouse moves while within the widgets ui bounds.
    | "OnMouseUp" -- Triggers when the mouse left or right click is pressed while within the ui bounds of the widget.
    | "OnMovedPosition" -- Triggers when the Window widget has dragging enabled and the widget has moved.
    | "OnPageChanged" -- Triggers when the Pageable widget page changes.
    | "OnPermissionChanged" -- Triggers when the permission changes.
    | "OnRadioChanged" -- Triggers when the RadioGroup widget radio changes.
    | "OnRestricted" -- #
    | "OnScale" -- Triggers when the widgets scale has been applied or set.
    | "OnScaleAnimeEnd" -- Triggers when the widgets scale animation has ended.
    | "OnSelChanged" -- Triggers when the Listbox or ListCtrl widget selection changes.
    | "OnShow" -- Triggers when the object is shown.
    | "OnSliderChanged" -- Triggers when the Slider widget slider changes.
    | "OnTabChanged" -- Triggers when the Tab widget tab changes.
    | "OnTextChanged" -- Triggers when the Editbox widget text changes.
    | "OnTooltip" -- Triggers when the Listbox widget should show a tooltip.
    | "OnUpdate" -- Triggers every frame while the widget is shown.
    | "OnVisibleChanged" -- Triggers when the widget is shown or hidden.
    | "OnWheelDown" -- Triggers when the mouse is within the widgets ui bounds and the mouse wheel is scrolled down.
    | "OnWheelUp" -- Triggers when the mouse is within the widgets ui bounds mouse wheel is scrolled up.
    | "PreClick" -- Triggers when the Slot widget is clicked.
    | "PreUse" -- Triggers when the Slot widget is clicked.

Method: GetValue

(method) Widget:GetValue(typeStr: string)
  -> value: number

Retrieves the value for the specified type.

@param typeStr — The type to query.

@return value — The value associated with the type.

Method: InheritAnimationData

(method) Widget:InheritAnimationData(widget: Widget)

Inherits animation data from the specified widget.

@param widget — The widget to inherit animation data from.

Method: DisableDrawablesWithChildren

(method) Widget:DisableDrawablesWithChildren(nameLayer: "artwork"|"background"|"overlay"|"overoverlay")

Disables drawables for the specified layer and its children.

@param nameLayer — The layer to disable.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: GetAlpha

(method) Widget:GetAlpha()
  -> alpha: number

Retrieves the alpha value of the Widget.

@return alpha — The alpha value (min: 0, max: 1).

Method: EnablePick

(method) Widget:EnablePick(enable: boolean)

Enables or disables the Widgets ability to be picked and the widget actions that relate to a widget being picked:

"OnClick"

"OnDragReceive"

"OnDragStart"

"OnDragStop"

"OnEnter"

"OnEscapePressed"

"OnLeave"

"OnMouseDown"

"OnMouseMove"

"OnMouseUp"

@param enable — true to enable picking, false to disable. (default: true)

Method: EnableDrawables

(method) Widget:EnableDrawables(nameLayer: "artwork"|"background"|"overlay"|"overoverlay")

Enables drawables for the specified layer.

@param nameLayer — The layer to enable.

-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: EnableDrag

(method) Widget:EnableDrag(enable: boolean)

Enables or disables the Widget handler actions "OnDragStart" and "OnDragStop".

@param enable — true to enable dragging, false to disable. (default: false)

Method: EnableScroll

(method) Widget:EnableScroll(enable: boolean)

Enables or disables scrolling for the Widget. Children widgets outside of the parent widget will not render.

@param enable — true to enable scrolling, false to disable.

Method: EnableDrawablesWithChildren

(method) Widget:EnableDrawablesWithChildren(nameLayer: "artwork"|"background"|"overlay"|"overoverlay")

Enables drawables for the specified layer and its children.

@param nameLayer — The layer to enable.
-- Drawables with layers of the same level and parent can overlap based on focus.
nameLayer:
    | "background" -- Layer 1
    | "artwork" -- Layer 2
    | "overlay" -- Layer 3
    | "overoverlay" -- Layer 4

Method: EnableHidingIsRemove

(method) Widget:EnableHidingIsRemove(enable: boolean)

Enables or disables Widget:SetDeletedHandler and when the widget is hidden fires that event and then removes the Widget from the Object Pool but doesn’t remove all references.

@param enable — true to enable removal on hide, false to disable. (default: false)

Method: EnableFocus

(method) Widget:EnableFocus(enable: boolean)

Enables or disables focus for the Widget and when the widget is focus enables the widget handler actions "OnKeyUp" and "OnKeyDown".

@param enable — true to enable focus, false to disable.

Method: EnableKeyboard

(method) Widget:EnableKeyboard(enable: boolean)

Enables or disables the Widget handler actions "OnKeyUp" and "OnKeyDown".

@param enable — true to enable keyboard input, false to disable.

Method: UseResizing

(method) Widget:UseResizing(use: boolean)

Enables or disables resizing for the Widget.

@param use — true to enable resizing, false to disable. (default: false)

Keyboard shortcuts

ArcheAge Addon Documentation