AddItem - ObjectReference

Member of: ObjectReference Script

Adds X of the specified item to this reference's inventory, possibly silently.

Syntax

Function AddItem(Form akItemToAdd, int aiCount = 1, bool abSilent = false) native

Parameters

• akItemToAdd: The base form add to this reference's inventory. If this is a base object, it will add a newly-created item. If it is a reference, it will move/remove it from own place/container to this container. If a form list, then it will add aiCount of each item in the list.
• aiCount: How many references to add. Note that this must be one if you are passing in an object reference.
  • Default: 1
• abSilent: If true, no message will be printed to the screen
  • Default: false

Return Value

None.

Examples

; Add a two diamonds to the player's inventory, silently
Game.GetPlayer().AddItem(Diamond, 2, true)

; Move the special gem reference from wherever it is into the chest
Chest.AddItem(SpecialGemRef)

Notes

• An item added to a respawning chest using AddItem will most likely not appear. This is due to the chest resetting its contents every day or so. If the player has not talked to the merchant recently, their inventory will reset before they see the item in it.
• Don't call this function immediately when a game is started/loaded as it does not seem to work. You can have the game Wait a second before doing it which should correct this problem.
• akItemToAdd can be a LeveledItem. Removal of a LeveledItem, however won't work with RemoveItem - ObjectReference and the members of the LeveledItem must be passed individually as akItemToRemove.
• As of 6/5/2012, it appears that the latest beta patch (1.6) no longer allows for the AddItem method to add an object or objectreference of Form 'Container' to the player's inventory.

See Also

• ObjectReference Script
• RemoveItem - ObjectReference
• GetItemCount - ObjectReference