Difference between revisions of "AddItem"

← Older edit

AddItem (edit)

Revision as of 19:40, 28 March 2010

1,560 bytes added , 19:40, 28 March 2010

→‎Console Usage: Moved some text to the discussion page

Anonymous user

imported>Shademe

@@ Line 1: / Line 1: @@
+__NOTOC__
 '''Syntax:'''
-  AddItem ''ObjectID'', ''Count''
+  [''ActorID''|''ContainerID''.]AddItem ''ObjectID'', ''Count''
-'''Example:'''
- AddItem MyObject, 1
-----
+Adds ''Count'' items of object ''ObjectID'' to the calling container's inventory.
-Adds Count items of object ObjectID to the calling container's inventory.
+'''Examples:'''
+ AddItem MyObject, 1
-NOTE: This will not trigger [[OnAdd]] blocks, because the item is created inside the inventory rather than actually being added. For creating items from the console that you need to trigger OnAdd, use [[PlaceAtMe]] instead and pick the item up from the ground.
+ Ref MyItem
+ Short count
+ set MyItem to ArenaAkaviriLongSword
+ set count to 1
+ player.additem MyItem Count
+==Notes==
+* You can use a [[Variable_types:_reference_variables|reference variable]] as ''ObjectID'' and a [[Variable_types:_shortint|short]] variable for ''count''.
+* This function will trigger an [[onAdd]] block in a script attached to the target container, as long as the container is in a loaded cell. When used on a container in a remote cell, the [[onAdd]] block won't run until the player enters that container's cell. However, if the player enters the remote cell after saving and loading, the onAdd block won't run.
+** Note that this is only true for the onAdd block, the rest of the script will still run if applicable (GameMode block will run if it's GameMode, MenuMode if MenuMode, etc.). The script will run once, as if it were loaded. If you have any variables set on the script, it will run the next frame as well and will continue to run until no variables are set.
+* See [[Message Spam]] for techniques to avoid unwanted "Item Added" messages.
+==Console Usage==
+When using AddItem with the console, you must use the desired item's FormID, not the EditorID.
+So, instead of using
+ player.additem lockpick 1
+to give yourself a lockpick, you must use
+ player.additem 00000A 1
+==See Also==
+*[[AddItemNS]] - Spamless version of command (OBSE 15).
+*[[GetItemCount]]
+*[[RemoveItem]]
+*[[Message Spam]] - Techniques for avoiding message spam.
+==Reference==
+[[AddItem_Reference|List of existing scripts that use AddItem]]
 [[Category: Functions]]
-[[Category: Object Functions]]
+[[Category:Functions (CS)]]
+[[Category: Functions (CS 1.0)]]
+[[Category: Inventory Functions]]
+[[Category: Inventory Functions (CS 1.0)]]
+[[Category: Actor Functions]]
+[[Category: Actor Functions (CS 1.0)]]
+<!-- Begin Search Terms
+ Add
+ Item
+End Search Terms -->