RemoveInventoryEventFilter - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ActiveMagicEffect Script, ReferenceAlias Script, ObjectReference Script

Removes a form as a "filter" for OnItemAdded and OnItemRemoved events sent to this object. The filters are removed separately from the reference, any aliases, and any magic effects on the reference, so each will need to remove filters from themselves independently. If all filters are removed, the object will get events for everything again.

Syntax

Function RemoveInventoryEventFilter(Form akFilter) native

Parameters

  • akFilter: The filter to remove. Events related to this filter will no longer be sent to this object.

Return Value

None.

Examples

; We no longer want inventory events for gold (if we have other filters) - or we want all events (if no other filters are set)
RemoveInventoryEventFilter(Gold)

See Also