RemoveInventoryEventFilter function - ScriptObject script

Found in:

Vanilla

voidfunctionRemoveInventoryEventFilter(FormakFilter)Native

Description

Wiki Description

Removes a form as a "filter" for ObjectReference.OnItemAdded(...) and ObjectReference.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.

Documentation Comment

Remove an inventory event filter from this object. Item added/removed events matching the specified form (or in the
specified form list) will no longer be let through.
Objects without filters CANNOT receive inventory add/remove events!

Parameters

FormakFilter
CK Wiki Description
The filter to remove. Events related to this filter will no longer be sent to this object.

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)

Auto-Generated Example

Form myForm__akFilter

myScriptObject__toCallFunctionOn.RemoveInventoryEventFilter(myForm__akFilter)

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki