Difference between revisions of "RemoveItem - ObjectReference"
Jump to navigation
Jump to search
imported>Jlundin |
imported>Fg109 (added note) |
||
| Line 36: | Line 36: | ||
*The function accepts a form object, however you can't make a property to a form object, you need to create a property to another type of object that extends form. Most often a MiscObject, or Weapon, etc. | *The function accepts a form object, however you can't make a property to a form object, you need to create a property to another type of object that extends form. Most often a MiscObject, or Weapon, etc. | ||
*If you pass in a form list, it will remove aiCount of each item in the form list from the container. If there isn't aiCount of a particular item in the container, it will remove all of them. | *If you pass in a form list, it will remove aiCount of each item in the form list from the container. If there isn't aiCount of a particular item in the container, it will remove all of them. | ||
*The function seems to have a preference for equipped items. Or if not equipped items then the first instance of the item that's in inventory (which is the same thing, since when you equip something, it's the first instance of the object in the inventory). | |||
== See Also == | == See Also == | ||
Revision as of 16:33, 5 April 2012
Member of: 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) nativeParameters
- akItemToRemove: The item (or base form) to remove from this reference's inventory. If a reference is passed, the reference is deleted once it's removed.
- aiCount: How many references to remove.
- Default: 1
- 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
; Take away an apple
Chest.RemoveItem(Apple)
; Remove 50 gold from the player
Game.GetPlayer().RemoveItem(GoldBase, 50)Notes
- The function accepts a form object, however you can't make a property to a form object, you need to create a property to another type of object that extends form. Most often a MiscObject, or Weapon, etc.
- If you pass in a form list, it will remove aiCount of each item in the form list from the container. If there isn't aiCount of a particular item in the container, it will remove all of them.
- The function seems to have a preference for equipped items. Or if not equipped items then the first instance of the item that's in inventory (which is the same thing, since when you equip something, it's the first instance of the object in the inventory).