Skip to content

playItemSound⚓︎

This event is triggered when the game is about to play a sound when an item gets added or removed from an inventory, or when eaten or consumed. Can be blocked to play custom sound instead.

--- @param e playItemSoundEventData
local function playItemSoundCallback(e)
end
event.register(tes3.event.playItemSound, playItemSoundCallback)

Tip

This event can be filtered based on the item event data.

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⚓︎

soundObjectPlay