uiActivated⚓︎
This event is invoked after a UI menu has been built or made visible, at the point that all menu elements contain updated data. Below is a table with all the menus this event triggers for.
| Menu id | Description |
|---|---|
"MenuAlchemy" |
|
"MenuAttributes" |
|
"MenuAttributesList" |
Enchanting/spellmaking effect attribute |
"MenuAudio" |
Options, audio |
"MenuBarter" |
|
"MenuBirthSign" |
|
"MenuBook" |
|
"MenuChooseClass" |
|
"MenuClassChoice" |
|
"MenuClassMessage" |
|
"MenuConsole" |
|
"MenuContents" |
Container/NPC inventory |
"MenuCreateClass" |
|
"MenuCtrls" |
Options, controls |
"MenuDialog" |
|
"MenuEnchantment" |
|
"MenuInput" |
|
"MenuInputSave" |
|
"MenuInventory" |
Player inventory |
"MenuInventorySelect" |
Item selector |
"MenuJournal" |
|
"MenuLevelUp" |
|
"MenuLoad" |
|
"MenuLoading" |
|
"MenuMagic" |
Spell/enchanted item selector |
"MenuMagicSelect" |
|
"MenuMap" |
|
"MenuMapNoteEdit" |
|
"MenuMessage" |
|
"MenuMulti" |
Status bars, current weapon/magic, active effects and minimap |
"MenuName" |
|
"MenuNotify1" |
|
"MenuNotify2" |
|
"MenuNotify3" |
|
"MenuOptions" |
Main menu |
"MenuPersuasion" |
|
"MenuPrefs" |
Options, preferences |
"MenuQuantity" |
|
"MenuQuick" |
Quick keys |
"MenuRaceSex" |
|
"MenuRepair" |
|
"MenuRestWait" |
|
"MenuSave" |
|
"MenuScroll" |
|
"MenuServiceRepair" |
|
"MenuServiceSpells" |
|
"MenuServiceTraining" |
|
"MenuServiceTravel" |
|
"MenuSetValues" |
Enchanting/spellmaking effect values |
"MenuSkills" |
|
"MenuSkillsList" |
Enchanting/spellmaking effect skill |
"MenuSpecialization" |
|
"MenuSpellmaking" |
|
"MenuStat" |
Player attributes, skills, factions etc. |
"MenuStatReview" |
|
"MenuSwimFillBar" |
|
"MenuTimePass" |
|
"MenuTopic" |
|
"MenuVideo" |
Options, video |
--- @param e uiActivatedEventData
local function uiActivatedCallback(e)
end
event.register(tes3.event.uiActivated, uiActivatedCallback)
Tip
This event can be filtered based on the element.name event data.
Tip
An event can be claimed by setting e.claim to true, or by returning false from the callback. Claiming the event prevents any lower priority callbacks from being called.
Event Data⚓︎
element(tes3uiElement): Read-only. The menu element that was created. The event is filtered on element.name.newlyCreated(boolean): Read-only. true if the menu was created for the first time or destroyed and re-created; false if it was made visible after being hidden. This can be used when adding custom elements to a menu, as elements previously added will still exist if the menu was hidden. If the menu was re-created, the elements will need to be added again.