Difference between revisions of "AddItem"
Jump to navigation
Jump to search
imported>DragoonWraith (using HTML unordered list to include the code sample in the list) |
imported>SnakeChomp (Use function template. Move bug into specific bugs section. Reword examples.) |
||
| Line 1: | Line 1: | ||
== | {{Function | ||
|origin = GECK1 | |||
|summary = Adds Count items of object ObjectID to the calling container's inventory. It has two required parameters (the object to add and the quantity) and one optional parameter (whether to display a message on screen). | |||
|referenceType = <nowiki>ActorID|ContainerID</nowiki> | |||
== | |arguments = {{FunctionArgument | ||
|Name = ObjectID | |||
|Type = ref | |||
}}{{FunctionArgument | |||
== | |Name = Count | ||
|Type = int | |||
}}{{FunctionArgument | |||
|Name = HideMessageFlag | |||
|Type = int | |||
|Optional = y | |||
}} | |||
}} | |||
==Examples== | |||
buddyref.additem Stimpack 11 | buddyref.additem Stimpack 11 | ||
Adds 11 stimpacks to Buddy's inventory | |||
player.additem SuperStimpak 10 | player.additem SuperStimpak 10 | ||
Adds 10 super stimpacks to the player's inventory and the message displays like normal | |||
player.additem SuperStimpak 10 1 | player.additem SuperStimpak 10 1 | ||
Adds 10 super stimpacks to the player's inventory and no message is displayed | |||
== | ==Notes== | ||
*You can use a FormList as the item parameter - in this case, the function adds the count for each item in the list. | |||
<ul> | ==Bugs== | ||
<li>Calling [[AddItem]] in an Effect Script will cause the target | <ul><li>Calling [[AddItem]] in an Effect Script will cause the target actor's weapon to toggle between being visible and usable and being invisible and unusable. The cause of this bug is unknown, but as a workaround, use something like this in the script of the item that is being added: | ||
<pre>ref rContainer | <pre>ref rContainer | ||
Begin OnAdd | Begin OnAdd | ||
| Line 27: | Line 35: | ||
End</pre></li></ul> | End</pre></li></ul> | ||
== | ==See Also== | ||
[[RemoveItem]] | *[[RemoveItem]] | ||
[[AddItemHealthPercent]] | *[[AddItemHealthPercent]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
Revision as of 14:11, 10 February 2009
< [[::Category:Functions|Category:Functions]]
A function included in the GECK version 1.1.0.36.
Description
Adds Count items of object ObjectID to the calling container's inventory. It has two required parameters (the object to add and the quantity) and one optional parameter (whether to display a message on screen).
Syntax
ActorID|ContainerID.AddItem ObjectID:ref Count:int HideMessageFlag:int
Examples
buddyref.additem Stimpack 11
Adds 11 stimpacks to Buddy's inventory
player.additem SuperStimpak 10
Adds 10 super stimpacks to the player's inventory and the message displays like normal
player.additem SuperStimpak 10 1
Adds 10 super stimpacks to the player's inventory and no message is displayed
Notes
- You can use a FormList as the item parameter - in this case, the function adds the count for each item in the list.
Bugs
- Calling AddItem in an Effect Script will cause the target actor's weapon to toggle between being visible and usable and being invisible and unusable. The cause of this bug is unknown, but as a workaround, use something like this in the script of the item that is being added:
ref rContainer Begin OnAdd set rContainer to GetContainer rContainer.AddItem Pencil01 1 1 rContainer.RemoveItem Pencil01 1 1 End