RemoveAllItems - ObjectReference

Revision as of 16:11, 23 January 2018 by imported>Kalevala (→‎Notes)

Member of: ObjectReference Script

Removes all items from this object's inventory, optionally transferring them to another object.

Syntax

Function RemoveAllItems(ObjectReference akTransferTo = None, bool abKeepOwnership = false) native

Parameters

  • akTransferTo: The object to transfer the items we removed to.
    • Default: None
  • abKeepOwnership: Should the item's ownership be kept when moved to the other object?
    • Default: False

Return Value

None.

Examples

; Remove all items from the chest
ChestProperty.RemoveAllItems()


; Remove all items from the player's inventory, but keep ownership information
Game.GetPlayer().RemoveAllItems(abKeepOwnership = true)

Notes

  • The calling object and akTransferTo must be loaded.
  • If akTransferTo is not loaded in memory, for example if not persisted and in an unloaded cell, the items will be deleted instead.

See Also