Difference between revisions of "API CheckStorageAndUnloadCargo"
From Vendetta Lua
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
| name = CheckStorageAndUnloadCargo | | name = CheckStorageAndUnloadCargo | ||
| desc = Unload cargo items and quantities according to the provided table also checks station storage and pops up a dialog if not enough available | | desc = Unload cargo items and quantities according to the provided table also checks station storage and pops up a dialog if not enough available | ||
| − | | | + | | arg1_type = table |
| − | | | + | | arg1_desc = <nowiki>{{number itemid, number quantity} ..}</nowiki><br> |
| − | + | ''itemid'' = [[itemid]] of cargo item<br> | |
| − | + | ''quantity'' = amount of this cargo to unload | |
| − | + | | arg2_name = cb | |
| − | + | | arg2_type = function | |
| − | | | + | | arg2_desc = optional function to call on success |
| − | | | + | | arg2_opt = true |
| − | | | + | |
| − | | | + | |
| 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 | + | <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
| Type | Name | Description |
|---|---|---|
| table | {{number itemid, number quantity} ..} itemid = itemid of cargo item | |
| function | cb | optional function to call on success (optional) |
| Type | Name | Description |
|---|---|---|
| nil |
CheckStorageAndUnloadCargo{{itemid=1234, quantity=2}, {itemid=1235, quantity=3}}
unload 2 units of the cargo with the itemid 1234 and 3 with the id 1235
