View source for VoidExpanse/scope-items

<noinclude>
[[Category:VoidExpanse/api_scopes]]
</noinclude>
= Items scope =
Used to access items/cargo containers, add or remove items.
Please note that the cargo is stored in the same container (so ID for items/cargo containers is the same).

'''Visibility:''' Global.

== List of functions ==

{{Scripting_api|AddItem|
* int containerID
* string item_type
* int quantity|
object:
* int: item_id - game identifier of item (use it for Remove function)
* string: xml_id - xml item type ID
* string: type - can be "item" or "resource"
* int: quantity - amount of item added
|
<pre style="margin:0px;">var obj = items.AddItem(24556, "SomeItem2", 5);</pre>
|
Add item of specific type and quantity to the specified container ID.
}}

{{Scripting_api|GetGameObjectContainerId|
* int objId|
ID of the container||
Get container for any space object (currently it works for ship and crate containers).
}}

{{Scripting_api|GetItemsAndCargo|
* int containerID
|
Array of objects.


Object format:
* int: item_id - game identifier of item (use it for Remove function)
* string: xml_id - xml item type ID
* int: quantity - amount of item added
|
|
Returns array of items and cargo of the container.
}}

{{Scripting_api|GetShipInventoryContainerId|
* int shipID|
ID of the container||
Returns ID of the ship inventory and cargo container. You can get it also by the GetGameObjectContainerId() function.
}}

{{Scripting_api|GetStationShopContainerId|
* int stationID|
ID of the container||
Returns ID of the station shop container, which contains all the items available for sale on the station.
}}

{{Scripting_api|GetStationStorageContainerId|
* int stationID
* int shipID|
ID of the container||
Returns ID of the station storage container for the specific ship.
}}

{{Scripting_api|RemoveCargo|
* int containerID
* string cargo_type
* int quantity|<no result>||
Remove cargo from container.
}}

{{Scripting_api|RemoveItem|
* int container_id
* int item_id
* int quantity
|<no result>||
Remove item from container (if quantity not specified or zero - remove all quantity).
}}