VoidExpanse/scope-items: Difference between revisions

From AtomicTorchWiki
Line 20: Line 20:
ID of the container||
ID of the container||
Get container for any space object (currently it works for ship and crate containers)
Get container for any space object (currently it works for ship and crate containers)
}}
{{Scripting_api|GetItemsAndCargo|
* int containerID|
ID of the container||
Returns array of items and cargo of the container. Array contains of objects with fields "item_id", "xml_id", "quantity".
}}
}}

Revision as of 09:12, 20 April 2015


Items scope

Used to access items containers, add or remove items.

Visibility: Global.

List of functions

AddItem
Arguments Returns Example
  • int containerID, string item_type, int quantity

object with fields: item_id, xml_id, type, quantity

Description

Add item of specific type and quantity to the specified container ID. Returned object contains "type" field, which can have "item" or "resource" value.


GetGameObjectContainerId
Arguments Returns Example
  • int objId

ID of the container

Description

Get container for any space object (currently it works for ship and crate containers)


GetItemsAndCargo
Arguments Returns Example
  • int containerID

ID of the container

Description

Returns array of items and cargo of the container. Array contains of objects with fields "item_id", "xml_id", "quantity".