Difference between revisions of "Turtle.suck"

Revision as of 14:58, 16 August 2014

Function turtle.suck
Moves one or more items from either the ground in front of the turtle, or, from an inventory-enabled block (such as a chest) in front of the turtle. If an item is in the square directly in front of the turtle, it picks up one of those items. If a chest is in the square directly in front of the turtle, it picks up the items from the first non-empty chest slot, moving from top left to bottom right. The items are moved into the currently selected turtle slot if there is room. If the currently selected turtle slot is filled up before all of the items are picked up, the remaining picked up items are put in the next available turtle slot. If the currently selected turtle slot is 16 and the next slot is required, it will loop around and try turtle slot 1, and so on. As of Minecraft 1.5/ComputerCraft 1.51, turtle.suckUp can be used to pick items out of the output slot of a furnace. As of ComputerCraft 1.6, if an amount is specified, the turtle will attempt to pick up at most the specified number of items. Earlier builds always attempt to pick up a full slot.
Syntax	turtle.suck([number amount])
Returns	boolean `true` if at least one item was moved into the turtle's inventory; `false` otherwise.
Part of	ComputerCraft
API	turtle

Example
Picks up some items from in front of the turtle.
Code	turtle.suck()

Example
Picks up some items from above the turtle.
Code	turtle.suckUp()

Example
Picks up some items from below the turtle.
Code	turtle.suckDown()

@@ Line 3: / Line 3: @@
 |name=turtle.suck
 |args=[<nowiki></nowiki>{{type|number}} amount]
-|returns=[[boolean_(type)|boolean]] true if at least one item was moved into the turtle's inventory; false otherwise.
+|returns={{type|boolean}} <var>true</var> if at least one item was moved into the turtle's inventory; <var>false</var> otherwise.
 |api=turtle
 |addon=ComputerCraft
@@ Line 17: / Line 17: @@
 {{Example
 |desc=Picks up some items from in front of the turtle.
-|code=turtle.suck()
+|code='''turtle.suck()'''
 }}
 {{Example
 |desc=Picks up some items from above the turtle.
-|code=turtle.suckUp()
+|code='''turtle.suckUp()'''
 }}
 {{Example
 |desc=Picks up some items from below the turtle.
-|code=turtle.suckDown()
+|code='''turtle.suckDown()'''
 }}
 }}
 [[Category:Lua_Core_Functions]]