API CheckStorageAndUnloadCargo: Difference between revisions

From Vendetta Lua
Jump to navigationJump to search
No edit summary
No edit summary
 
Line 12: Line 12:
| ret1_type    = nil
| ret1_type    = nil
| notes        = '''Example:'''<br>
| notes        = '''Example:'''<br>
<source lang="lua">CheckStorageAndUnloadCargo{{itemid=1234, quantity=2}, {itemid=1235, quantity=3}}</source><br>
<source lang="lua">CheckStorageAndUnloadCargo{{itemid=1234, quantity=2}, {itemid=1235, quantity=3}}</source>
unload 2 units of the cargo with the itemid 1234 and 3 with the id 1235
unload 2 units of the cargo with the itemid 1234 and 3 with the id 1235
}}
}}

Latest revision as of 01:42, 20 October 2011

CheckStorageAndUnloadCargo

Definition
CheckStorageAndUnloadCargo( table [,  function  cb ]) ->  nil
Description
Unload cargo items and quantities according to the provided table also checks station storage and pops up a dialog if not enough available
Arguments
Type Name Description
table

itemid = itemid of cargo item

quantity = amount of this cargo to unload
function cb optional function to call on success (optional)
Returns
Type Name Description
nil
Notes
Example:
<source lang="lua">CheckStorageAndUnloadCargo{{itemid=1234, quantity=2}, {itemid=1235, quantity=3}}</source> unload 2 units of the cargo with the itemid 1234 and 3 with the id 1235