DropFirstObject - ObjectReference

Revision as of 10:10, 7 July 2016 by imported>Hannibalektr
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: ObjectReference Script

Drops the specified object from this object's inventory.

SyntaxEdit

ObjectReference Function DropFirstObject(bool abInitiallyDisabled=false) native

ParametersEdit

  • abInitiallyDisabled: If true, the dropped object will be disabled when dropped.

Return ValueEdit

The object that was dropped.

ExamplesEdit

; Drops the first item from the player's inventory.
Game.GetPlayer().DropFirstObject()

NotesEdit

The definition of "first" is up to the code, and so this basically drops a random object. However it does it in such a manner that, if called multiple times, is likely to repeatedly drop the same kind of object until that object's stack is exhausted before moving onto the "next" stack.

See AlsoEdit