Events

From ESOUI Wiki

(Difference between revisions)
Jump to: navigation, search
 
Line 64: Line 64:
* {{GitHubSearch|Search=EVENT_ACTION_SLOTS_ACTIVE_HOTBAR_UPDATED}} [[EVENT_ACTION_SLOTS_ACTIVE_HOTBAR_UPDATED]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOTS_ACTIVE_HOTBAR_UPDATED|''eventCode'']], '''boolean''' ''didActiveHotbarChange'', '''boolean''' ''shouldUpdateAbilityAssignments'', '''number''' [[Globals#HotBarCategory|HotBarCategory]] ''activeHotbarCategory'')
* {{GitHubSearch|Search=EVENT_ACTION_SLOTS_ACTIVE_HOTBAR_UPDATED}} [[EVENT_ACTION_SLOTS_ACTIVE_HOTBAR_UPDATED]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOTS_ACTIVE_HOTBAR_UPDATED|''eventCode'']], '''boolean''' ''didActiveHotbarChange'', '''boolean''' ''shouldUpdateAbilityAssignments'', '''number''' [[Globals#HotBarCategory|HotBarCategory]] ''activeHotbarCategory'')
* {{GitHubSearch|Search=EVENT_ACTION_SLOTS_ALL_HOTBARS_UPDATED}} [[EVENT_ACTION_SLOTS_ALL_HOTBARS_UPDATED]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOTS_ALL_HOTBARS_UPDATED|''eventCode'']])
* {{GitHubSearch|Search=EVENT_ACTION_SLOTS_ALL_HOTBARS_UPDATED}} [[EVENT_ACTION_SLOTS_ALL_HOTBARS_UPDATED]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOTS_ALL_HOTBARS_UPDATED|''eventCode'']])
-
* <s>{{GitHubSearch|Search=EVENT_ACTION_SLOTS_FULL_UPDATE}} [[EVENT_ACTION_SLOTS_FULL_UPDATE]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOTS_FULL_UPDATE|''eventCode'']], '''boolean''' ''isHotbarSwap'')</s> - Was removed with API 100025 "Murkmire" patch!
+
* {{GitHubSearch|Search=EVENT_ACTION_SLOTS_FULL_UPDATE}} [[EVENT_ACTION_SLOTS_FULL_UPDATE]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOTS_FULL_UPDATE|''eventCode'']], '''boolean''' ''isHotbarSwap'') - Missing from API document since 100025 "Murkmire" patch, but still working in 100028
* <s>{{GitHubSearch|Search=EVENT_ACTION_SLOT_ABILITY_SLOTTED}} [[EVENT_ACTION_SLOT_ABILITY_SLOTTED]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOT_ABILITY_SLOTTED|''eventCode'']], '''boolean''' ''newAbilitySlotted'')</s> - Removed in 100028
* <s>{{GitHubSearch|Search=EVENT_ACTION_SLOT_ABILITY_SLOTTED}} [[EVENT_ACTION_SLOT_ABILITY_SLOTTED]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOT_ABILITY_SLOTTED|''eventCode'']], '''boolean''' ''newAbilitySlotted'')</s> - Removed in 100028
* {{GitHubSearch|Search=EVENT_ACTION_SLOT_ABILITY_USED}} [[EVENT_ACTION_SLOT_ABILITY_USED]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOT_ABILITY_USED|''eventCode'']], '''number''' ''actionSlotIndex'') - Changed in 100028
* {{GitHubSearch|Search=EVENT_ACTION_SLOT_ABILITY_USED}} [[EVENT_ACTION_SLOT_ABILITY_USED]] ('''number''' [[Constant_Values#EVENT_ACTION_SLOT_ABILITY_USED|''eventCode'']], '''number''' ''actionSlotIndex'') - Changed in 100028

Latest revision as of 20:05, 16 July 2019

Page up-to-date to API Version 100028


Contents

Introduction

All events can be bound to a callback which will be triggered once the event in question occurs. This can be done via the following syntax:

EVENT_MANAGER:RegisterForEvent("YourAddonName", EVENT_NAME_AS_LISTED_BELOW, FunctionToTriggerWhenEventOccurs)

You may also unbind the event from the callback with the following syntax:

EVENT_MANAGER:UnregisterForEvent("YourAddonName", EVENT_NAME_AS_LISTED_BELOW)

The callback may be declared as follows:

local function FunctionToTriggerWhenEventOccurs(eventCode, eventArg2, eventArg3)
	--Do something
end

Please see more examples at Writing_your_first_addon


Event Filtering

This one should be used when possible. Please have a closer look at AddFilterForEvent for detailed information.



Abilities

Removed in 100026 * Search on ESOUI Source Code EVENT_SKILL_ABILITY_PROGRESSIONS_UPDATED (number eventCode)


Achievements


Action Bar


Alliance War Campaign


Alliance War Keeps


Alliance War Scoring


Bank


Battlegrounds


Books and Lore


Cadwell


Camera


Champion System


Chat


Collectibles


Combat


Crafting


Crown Store


Daedric Artifact


Daily Login Awards


Dueling


Crown Gifts


Outfits


Emotes


Enlightenment


Experience


Fast Travel


Fence


Fishing


Groups

Removed in 100026 * Search on ESOUI Source Code EVENT_UNIT_FRAME_UPDATE (number eventCode, string unitTag)


Guild


Guild Bank


Guild Finder


Guild Heraldry


Guild Kiosk


Housing


Imperial City


Ingame Help


Inventory and Currencies


Justice


Launder


Life and Death


Lockpicking


Looting


Mail


Map and Zoning


Mounts


Party Finder


Pledge of Mara


Quests


Raids & Dungeons


Retrait


Siege Weapons


Social


Stuck


Subscription


Swim


Trading


Trading House

Removed in 100026 * Search on ESOUI Source Code EVENT_TRADING_HOUSE_SEARCH_RESULTS_RECEIVED (number eventCode, number guildId, number numItemsOnPage, number currentPage, boolean hasMorePages)

Trial Period


Tutorial & Alerts


Vendors


World Interactions


UI

Removed in 100026 * Search on ESOUI Source Code EVENT_REMOTE_SCENE_SYNC (number eventCode, SceneManagerMessageOrigin messageOrigin, RemoteSceneSyncType syncType, string sceneName)

Removed in 100026 * Search on ESOUI Source Code EVENT_REMOTE_SCENE_FINISHED_FRAGMENT_TRANSITION (number eventCode, SceneManagerMessageOrigin messageOrigin, string sceneName)


UI Cursor


UI Error Handling


UI Focus


UI Gamepad


UI Keybinding


UI Keyboard / Mouse Management


UI Loading


UI Logout


UI Reticle


UI Screenshots


UI Subtitles


UI Toggling


UI Video


Miscellaneous


World Events


Zone Guide


ZOS Tickets


ZOS GameMasters Chat


ZOS GM & System Broadcasting

Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox