VoidExpanse/scope-items: Difference between revisions

From AtomicTorchWiki
Line 38: Line 38:
ID of the container||
ID of the container||
Returns ID of the station shop container, which contains all the items available for sale on the station.
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|||
Remove cargo from container
}}
}}

Revision as of 09:18, 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".


GetShipInventoryContainerId
Arguments Returns Example
  • int shipID

ID of the container

Description

Returns ID of the ship inventory and cargo container. You can get it also by the GetGameObjectContainerId() function.


GetStationShopContainerId
Arguments Returns Example
  • int stationID

ID of the container

Description

Returns ID of the station shop container, which contains all the items available for sale on the station.


GetStationStorageContainerId
Arguments Returns Example
  • int stationID, int shipID

ID of the container

Description

Returns ID of the station storage container for the specific ship.


RemoveCargo
Arguments Returns Example
  • int containerID
Description

Remove cargo from container