AddInventoryEventFilter - ObjectReference

Member of: ActiveMagicEffect Script, ReferenceAlias Script, ObjectReference Script

Adds a form as a "filter" for OnItemAdded and OnItemRemoved events sent to this object. The filter is applied separately to the reference, any aliases, and any magic effects on the reference, so each will need to add filters to themselves independently.

Syntax

Function AddInventoryEventFilter(Form akFilter) native

Parameters

• akFilter: The item to filter with. If a base object or reference, this object will only be notified of references or base objects matching exactly. If a form list, it will filter using all of the forms in the form list (only items in the form list will be allowed through).

Return Value

None.

Examples

; Make sure we only get events for gold and soul gems
AddInventoryEventFilter(Gold)
AddInventoryEventFilter(SoulGemList)

Notes

The filter will only check inventory objects directly against the objects in the form list, and will not dig inside nested lists to find them.

See Also

• ObjectReference Script
• RemoveAllInventoryEventFilters - ObjectReference
• RemoveInventoryEventFilter - ObjectReference
• OnItemAdded - ObjectReference
• OnItemRemoved - ObjectReference