This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
component:transposer [2018/03/02 04:05] kiritow |
component:transposer [2018/09/21 07:23] payonel |
||
|---|---|---|---|
| Line 7: | Line 7: | ||
| Callbacks: | Callbacks: | ||
| - | - `transferFluid(sourceSide:number, sinkSide:number, count:number):number` | + | - `transferFluid(sourceSide:number, sinkSide:number, count:number):boolean, number` |
| - | Transfer some items between two inventories. | + | Transfer some fluids between two fluid handlers (pipes or tanks, etc). `sourceSide` is the side pulled from and `sinkSide` is the side transferred to. As with all side parameters, the side is relative the front facing perspective of the computer machine controlling the component. `count` is the number of millibuckets to transfers. Returns true and the number of millibuckets transfered on success, or false and an error message on failure. |
| - `store(side:number, slot:number, dbAddress:string, dbSlot:number):boolean` | - `store(side:number, slot:number, dbAddress:string, dbSlot:number):boolean` | ||
| Store an item stack description in the specified slot of the database with the specified address. | Store an item stack description in the specified slot of the database with the specified address. | ||
| Line 38: | Line 38: | ||
| Get the capacity of the specified tank on the specified side. | Get the capacity of the specified tank on the specified side. | ||
| - `getAllStacks(side:number):userdata` | - `getAllStacks(side:number):userdata` | ||
| - | Get a description of all stacks in the inventory on the specified side of the device. | + | Get a description of all stacks in the inventory on the specified side of the device. |
| + | The return value is callable. Calling it will return a table describing the stack in the inventory or nothing if the iterator reaches end. | ||
| + | The return value provides the followings callbacks: | ||
| + | `getAll():table` | ||
| + | Returns ALL the stack in the this.array. Memory intensive. | ||
| + | `count():number` | ||
| + | Returns the number of elements in the this.array. | ||
| + | `reset()` | ||
| + | Reset the iterator index so that the next call will return the first element. | ||
| + | | ||
| ---- | ---- | ||
| {{page>component:contents&noheader&noeditbutton&nouser&nofooter}} | {{page>component:contents&noheader&noeditbutton&nouser&nofooter}} | ||