Difference between revisions of "Turtle.transferTo"
From ComputerCraft Wiki
Smiley43210 (Talk | contribs) (Made it clear that arg is optional, converted to type templates, corrected grammar, italicized arguments in context) |
(Clarifying.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 2: | Line 2: | ||
{{Function | {{Function | ||
|name=turtle.transferTo | |name=turtle.transferTo | ||
| − | |args={{type| | + | |args={{type|number}} slot [, {{type|number}} quantity] |
|returns={{type|boolean}} success | |returns={{type|boolean}} success | ||
|api=turtle | |api=turtle | ||
|addon=ComputerCraft | |addon=ComputerCraft | ||
| − | |desc=Transfers ''quantity'' items from the selected slot to ''slot''. If the ''quantity'' argument is omitted, tries to transfer all the items from the selected slot. | + | |desc=Transfers ''quantity'' items from the selected slot to the specified ''slot''. If the ''quantity'' argument is omitted, tries to transfer all the items from the selected slot. If the destination slot already has items of a different type, returns false (does not try to fill the next slot, like suck() would). If there are fewer than ''quantity'' items in the selected slot or only room for fewer items in the destination slot, transfers as many as possible and returns true. If none can be transferred, returns false. |
|examples= | |examples= | ||
{{Example | {{Example | ||
Latest revision as of 14:36, 21 April 2015
 Function turtle.transferTo | |
| Transfers quantity items from the selected slot to the specified slot. If the quantity argument is omitted, tries to transfer all the items from the selected slot. If the destination slot already has items of a different type, returns false (does not try to fill the next slot, like suck() would). If there are fewer than quantity items in the selected slot or only room for fewer items in the destination slot, transfers as many as possible and returns true. If none can be transferred, returns false. | |
| Syntax | turtle.transferTo(number slot [, number quantity]) |
| Returns | boolean success |
| Part of | ComputerCraft |
| API | turtle |
Examples
 Example | |
| Transfers 32 items from the selected slot to slot 6. | |
| Code |
turtle.transferTo(6, 32) |
This function became available in version 1.45
