This event is triggered when the game is about to play a sound when an item gets added or removed from an inventory. Can be blocked to play custom sound instead.
--- @param e playItemSoundEventData local function playItemSoundCallback(e) end event.register(tes3.event.playItemSound, playItemSoundCallback)
This event can be filtered based on the
item 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.
item(tes3baseObject): Read-only. The item for which the sound is about to be played.
reference(tes3reference): Read-only. The actor reference that picked or dropped the item that's now about to play the sound.
state(tes3.itemSoundState): Read-only. Maps to values in tes3.itemSoundState namespace.