VoidExpanse/scope-items - Revision history

Ai enabled: The method name corrected - RemoveItemQuantity

2017-07-27T04:57:04Z

The method name corrected - RemoveItemQuantity

← Older revision		Revision as of 04:57, 27 July 2017
Line 72:		Line 72:
	}}		}}

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

Ai enabled: /* List of functions */

2015-04-20T09:37:47Z

List of functions

← Older revision		Revision as of 09:37, 20 April 2015
Line 11:		Line 11:

	{{Scripting_api\|AddItem\|		{{Scripting_api\|AddItem\|
	* int containerID		* int: containerID
	* string item_type		* string: item_type
	* int quantity\|		* int: quantity\|
	object:		object:
	* int: item_id - game identifier of item (use it for Remove function)		* int: item_id - game identifier of item (use it for Remove function)
Line 26:		Line 26:

	{{Scripting_api\|GetGameObjectContainerId\|		{{Scripting_api\|GetGameObjectContainerId\|
	* int objId\|		* int: objId\|
	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).
Line 32:		Line 32:

	{{Scripting_api\|GetItemsAndCargo\|		{{Scripting_api\|GetItemsAndCargo\|
	* int containerID		* int: containerID
	\|		\|
	Array of objects.		Array of objects.
Line 47:		Line 47:

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

	{{Scripting_api\|GetStationShopContainerId\|		{{Scripting_api\|GetStationShopContainerId\|
	* int stationID\|		* int: stationID\|
	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.
Line 59:		Line 59:

	{{Scripting_api\|GetStationStorageContainerId\|		{{Scripting_api\|GetStationStorageContainerId\|
	* int stationID		* int: stationID
	* int shipID\|		* int: shipID\|
	ID of the container\|\|		ID of the container\|\|
	Returns ID of the station storage container for the specific ship.		Returns ID of the station storage container for the specific ship.
Line 66:		Line 66:

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

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

Ai enabled: /* List of functions */

2015-04-20T09:36:59Z

List of functions

← Older revision		Revision as of 09:36, 20 April 2015
Line 73:		Line 73:

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

Ai enabled: /* List of functions */

2015-04-20T09:36:42Z

List of functions

← Older revision		Revision as of 09:36, 20 April 2015
Line 11:		Line 11:

	{{Scripting_api\|AddItem\|		{{Scripting_api\|AddItem\|
	* int containerID, string item_type, int quantity\|		* int containerID
			* string item_type
			* int quantity\|
	object:		object:
	* int: item_id - game identifier of item (use it for Remove function)		* int: item_id - game identifier of item (use it for Remove function)
Line 57:		Line 59:

	{{Scripting_api\|GetStationStorageContainerId\|		{{Scripting_api\|GetStationStorageContainerId\|
	* int stationID, int shipID\|		* int stationID
			* int shipID\|
	ID of the container\|\|		ID of the container\|\|
	Returns ID of the station storage container for the specific ship.		Returns ID of the station storage container for the specific ship.
Line 63:		Line 66:

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

Ai enabled: /* Items scope */

2015-04-20T09:29:05Z

Items scope

← Older revision		Revision as of 09:29, 20 April 2015
Line 4:		Line 4:
	= Items scope =		= Items scope =
	Used to access items/cargo containers, add or remove items.		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.		'''Visibility:''' Global.

Ai enabled: /* Items scope */

2015-04-20T09:28:28Z

Items scope

← Older revision		Revision as of 09:28, 20 April 2015
Line 3:		Line 3:
	</noinclude>		</noinclude>
	= Items scope =		= Items scope =
	Used to access items containers, add or remove items.		Used to access items/cargo containers, add or remove items.

	'''Visibility:''' Global.		'''Visibility:''' Global.

Ai enabled: /* List of functions */

2015-04-20T09:27:40Z

List of functions

← Older revision		Revision as of 09:27, 20 April 2015
Line 31:		Line 31:
	* int containerID		* int containerID
	\|		\|
	~~array~~ of objects.		Array of objects.

Ai enabled: /* List of functions */

2015-04-20T09:27:27Z

List of functions

← Older revision		Revision as of 09:27, 20 April 2015
Line 32:		Line 32:
	\|		\|
	array of objects.		array of objects.


	Object format:		Object format:
	* int: item_id - game identifier of item (use it for Remove function)		* int: item_id - game identifier of item (use it for Remove function)

Ai enabled: /* List of functions */

2015-04-20T09:27:06Z

List of functions

← Older revision		Revision as of 09:27, 20 April 2015
Line 29:		Line 29:

	{{Scripting_api\|GetItemsAndCargo\|		{{Scripting_api\|GetItemsAndCargo\|
	* int containerID\|		* 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"~~.		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.
	}}		}}

Ai enabled: /* List of functions */

2015-04-20T09:24:39Z

List of functions

← Older revision		Revision as of 09:24, 20 April 2015
Line 15:		Line 15:
	* string: xml_id - xml item type ID		* string: xml_id - xml item type ID
	* string: type - can be "item" or "resource"		* string: type - can be "item" or "resource"
	* int: quantity - amount of item added\|		* 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.		Add item of specific type and quantity to the specified container ID.
	}}		}}