Difference between revisions of "RemoveItemTarget"
Jump to navigation
Jump to search
imported>Jazzisparis (Created page with "{{Function |origin = NVSE |summary = Similar to the vanilla RemoveItem - removes <i>quantity</i> of the specified item from the calling reference's inventory. However, i...") |
imported>Jazzisparis |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
|origin = | |origin = JIP | ||
|summary = Similar to the vanilla [[RemoveItem]] - removes <i>quantity</i> of the specified item from the calling reference's inventory. However, instead of being destroyed, the items are moved to the specified <i>target</i> container/actor. | |summary = Similar to the vanilla [[RemoveItem]] - removes <i>quantity</i> of the specified item from the calling reference's inventory. However, instead of being destroyed, the items are moved to the specified <i>target</i> container/actor. | ||
|name = RemoveItemTarget | |name = RemoveItemTarget | ||
| Line 14: | Line 14: | ||
|Name = quantity | |Name = quantity | ||
|Type = int | |Type = int | ||
|Optional = y | |||
}}{{FunctionArgument | |||
|Name = clearOwnership | |||
|Type = 0/1 | |||
|Optional = y | |Optional = y | ||
}} | }} | ||
|example = <pre>SourceRef.RemoveItemTarget Camera TargetRef</pre> | |example = <pre>SourceRef.RemoveItemTarget Camera TargetRef</pre> | ||
This will move <i>all</i> Camera items from <i>SourceRef</i> to <i>TargetRef</i>. | This will move <i>all</i> Camera items from <i>SourceRef</i> to <i>TargetRef</i>. | ||
<pre>SourceRef.RemoveItemTarget NVHoldoutWeapons TargetRef 4</pre> | <pre>SourceRef.RemoveItemTarget NVHoldoutWeapons TargetRef 4 1</pre> | ||
This will move 4 of each item in the list <i>NVHoldoutWeapons</i> from <i>SourceRef</i> to <i>TargetRef</i>. | This will move 4 of each item in the list <i>NVHoldoutWeapons</i> from <i>SourceRef</i> to <i>TargetRef</i>. Ownership will be cleared off all moved items. | ||
}} | }} | ||
==Notes== | ==Notes== | ||
* | *All stats/attributes (health, script, mods, ownership, etc.) of removed items are preserved. | ||
*If <i>quantity</i> is not specified or is <= 0, <u>all</u> instances of the item are removed. | *If <i>quantity</i> is not specified or is <= 0, <u>all</u> instances of the item are removed. | ||
*The function accepts a FormList as parameter (in place of an item) and also supports sub-lists. | *The function accepts a FormList as parameter (in place of an item) and also supports sub-lists. | ||
==See Also== | ==See Also== | ||
*[[RemoveItem]] | *[[RemoveItem]] | ||
*[[RemoveAllItems]] | |||
*[[RemoveAllTypedItems]] | |||
[[Category:Functions_(JIP)]] | [[Category:Functions_(JIP)]] | ||
[[Category:Inventory Functions (JIP)]] | |||
Latest revision as of 20:12, 23 September 2015
< [[::Category:Functions|Category:Functions]]
A function added by the JIP NVSE Plugin.
Description
Similar to the vanilla RemoveItem - removes quantity of the specified item from the calling reference's inventory. However, instead of being destroyed, the items are moved to the specified target container/actor.
Syntax
reference.RemoveItemTarget item/list:ref target:ref quantity:int clearOwnership:0/1
Example
SourceRef.RemoveItemTarget Camera TargetRef
This will move all Camera items from SourceRef to TargetRef.
SourceRef.RemoveItemTarget NVHoldoutWeapons TargetRef 4 1
This will move 4 of each item in the list NVHoldoutWeapons from SourceRef to TargetRef. Ownership will be cleared off all moved items.
Notes
- All stats/attributes (health, script, mods, ownership, etc.) of removed items are preserved.
- If quantity is not specified or is <= 0, all instances of the item are removed.
- The function accepts a FormList as parameter (in place of an item) and also supports sub-lists.