trapDisarm⚓︎
This event fires when a trap is being disarmed.
--- @param e trapDisarmEventData
local function trapDisarmCallback(e)
end
event.register(tes3.event.trapDisarm, trapDisarmCallback)
Tip
This event supports blocking by setting e.block
to true
or returning false
. Blocking the event prevents vanilla behavior from happening. For example, blocking an equip
event prevents the item from being equipped.
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⚓︎
chance
(number): The chance that the probe attempt will be successful. May be modified. If set to a value<= 0
, the attempt will fail and the "Trap too complex" message will be displayed.disarmer
(tes3mobileNPC): Read-only. The Mobile NPC doing the disarming.lockData
(tes3lockNode): Read-only. The lock data of the reference.reference
(tes3reference): Read-only. The reference that triggered the event (container, door, etc.).tool
(tes3item): Read-only. The item the disarmer is using to disarm the trap.toolItemData
(tes3itemData): Read-only. The item data for the tool.trapPresent
(boolean): Read-only. Indicates if a trap is present on the reference.