uiPreEvent is triggered through various UI events. This includes scrolling through panes, clicking buttons, selecting icons, or a host of other UI-related activities. This event fires before uiEvent, and has the additional advantage of being able to be blocked.
--- @param e uiPreEventEventData local function uiPreEventCallback(e) end event.register(tes3.event.uiPreEvent, uiPreEventCallback)
This event can be filtered based on the
source.id event data.
This event supports blocking by setting
true or returning
false. Blocking the event prevents vanilla behavior from happening. For example, blocking an
equip event prevents the item from being equipped.
An event can be claimed by setting
true, or by returning
false from the callback. Claiming the event prevents any lower priority callbacks from being called.
parent(tes3uiElement): Read-only. The calling element's parent.
property(tes3.uiProperty): Read-only. The property identifier that is being triggered.
source(tes3uiElement): Read-only. The UI element that is firing this event.
var1(number): Read-only. One of two undefined variables related to the event.
var2(number): Read-only. One of two undefined variables related to the event.