DropObject - ObjectReference

From the CreationKit Wiki
Revision as of 17:30, 5 April 2012 by imported>Fg109 (added note)
Jump to navigation Jump to search

Member of: ObjectReference Script

Drops the specified object from this object's inventory.

Syntax

ObjectReference Function DropObject(Form akObject, int aiCount = 1) native

Parameters

  • akObject: The object to drop from the inventory.
  • aiCount: How many to drop
    • Default: 1

Return Value

The object that was dropped.

Examples

; Drops one chest from the player's inventory, and unlocks it
Game.GetPlayer().DropObject(ChestProperty).Lock(false)


; Drops one hundred arrows from the player's inventory
Game.GetPlayer().DropObject(ArrowProperty, 100)

Notes

  • If a number greater than 1 is used for aiCount, the objects dropped will be stacked. In order to drop individual items, DropObject must be called for each instance of the item.
  • If akForm is equipped, the game will first search for unequipped items in inventory to drop. Only when there are no more unequipped items will it drop the equipped items.

See Also