Mod:Creation Kit/RemoveItem - ObjectReference

Member of: Mod:Creation Kit/ObjectReference Script

Removes X of the specified item from this reference's inventory, possibly silently.

Syntax
Function RemoveItem(Form akItemToRemove, int aiCount = 1, bool abSilent = false, ObjectReference akOtherContainer = None) native

Parameters

 * akItemToRemove: The function will accept several variants:
 * ObjectReference - if a reference is passed, the reference is deleted once it's removed.
 * Note: This can accept non-persistent references in containers.
 * Base object - removes no more than aiCount of that item.
 * FormList of base objects, keywords, or components - removes no more than aiCount of items, starting with the first item in the form list and working down the form list.
 * Keyword - removes no more than aiCount of items matching that keyword from the container.
 * Component - removes no more than aiCount of items containing at least 1 of the component
 * aiCount: How many references to remove.
 * Default: 1
 * Note: Values less than 0 will remove all the items of this type.
 * abSilent: If true, no message will be printed to the screen
 * Default: false
 * akOtherContainer: If not None, the removed item(s) will be moved into this ref's inventory
 * Default: None

Return Value
None.

Examples
Chest.RemoveItem(Apple) Game.GetPlayer.RemoveItem(GoldBase, 50)
 * Take away an apple
 * Remove 50 gold from the player