Skip to content

keyUp⚓︎

The key event fires when a key is released.

--- @param e keyUpEventData
local function keyUpCallback(e)
end
event.register(tes3.event.keyUp, keyUpCallback)

Tip

This event can be filtered based on the keyCode 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 UI element that the key is going to be dispatched to, or nil if one is not in focus.
  • isAltDown (boolean): Read-only. True if either alt key is held.
  • isControlDown (boolean): Read-only. True if either control key is held.
  • isShiftDown (boolean): Read-only. True if either shift key is held.
  • isSuperDown (boolean): Read-only. True if super (Windows key) is held.
  • keyCode (tes3.scanCode): Read-only. The scan code of the key that raised the event. Maps to values in tes3.scanCode table.

keyDown