Skip to content

tes3uiEventData⚓︎

Contains information from a standard UI callback. This is the parameter passed to callbacks when using :register, :registerBefore, or :registerAfter on tes3uiElements.

Properties⚓︎

character⚓︎

Read-only. For tes3.uiEvent.keyPress events, this is the human-facing character that was pressed. While the keyData shows the direct keyboard state, character shows the translated input. Note that this is language-specific.

Returns:

  • result (string, nil)

data0⚓︎

Read-only. Event-specific raw data values. For mouse events, these are the screen X and Y coordinates of the pointer. For keyboard events, data0 is the scan code.

Returns:

  • result (number)

data1⚓︎

Read-only. Event-specific raw data values. For mouse events, these are the screen X and Y coordinates of the pointer.

Returns:

  • result (number)

forwardSource⚓︎

Read-only. No description yet available.

Returns:


id⚓︎

Read-only. The ID of the event that is being triggered.

Returns:

  • result (number)

keyData⚓︎

Read-only. For tes3.uiEvent.keyPress events, this is the raw DirectInput data associated with the input. Note that the keyCode provided here maps to DirectInput tes3.keyboardCode enums, and are not the virtual scan codes from tes3.scanCode.

Returns:


relativeX⚓︎

Read-only. For mouse-related events, this is the relative horizontal position for the current element.

Returns:

  • result (number, nil)

relativeY⚓︎

Read-only. For mouse-related events, this is the relative vertical position for the current element.

Returns:

  • result (number, nil)

source⚓︎

Read-only. The element that owns the event.

Returns:


widget⚓︎

Read-only. The widget element that the source belongs to, if the element is a sub-part of a widget. May not be accurate if the element is not a sub-part.

Returns: