RemoveInventoryEventFilter - ScriptObject

Member of: ScriptObject

Removes a form as a "filter" for OnItemAdded and OnItemRemoved events sent to this object. The filters are removed separately from each script attached to an object, so each script on an object needs to separately manage its own filters and will not interfere with any filters on any other scripts attached to the same object. If all filters are removed, the object will no longer receive inventory events.

SyntaxEdit

Function RemoveInventoryEventFilter(Form akFilter) native

ParametersEdit

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

Return ValueEdit

None.

ExamplesEdit

; 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 AlsoEdit