Difference between revisions of "Turtle (API)"
From ComputerCraft Wiki
Smiley43210 (Talk | contribs) m (Made it clear that arg is optional, cleared up descriptions for turtle.drop(), .dropUp(), .dropDown()) |
Smiley43210 (Talk | contribs) m (Correcter case ("Block" -> "block", "Turtle" -> "turtle"), changed descriptions to reference args, italicized args in context) |
||
| Line 25: | Line 25: | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.craft]]({{type|int}} quantity) | |[[turtle.craft]]({{type|int}} quantity) | ||
| − | |Craft items using ingredients anywhere in the | + | |Craft items using ingredients anywhere in the turtle's inventory and place results in the active slot. If a quantity is specified, it will craft only up to that many items, otherwise, it will craft as many of the items as possible. |
| | | | ||
|- | |- | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.forward]]() | |[[turtle.forward]]() | ||
| − | |Let the | + | |Let the turtle move forward |
| | | | ||
|- | |- | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.back]]() | |[[turtle.back]]() | ||
| − | |Let the | + | |Let the turtle move back |
| | | | ||
|- | |- | ||
| Line 45: | Line 45: | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.down]]() | |[[turtle.down]]() | ||
| − | |Let the | + | |Let the turtle move down |
| | | | ||
|- | |- | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.turnLeft]]() | |[[turtle.turnLeft]]() | ||
| − | |Let the | + | |Let the turtle turn left |
| | | | ||
|- | |- | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.turnRight]]() | |[[turtle.turnRight]]() | ||
| − | |Let the | + | |Let the turtle turn right |
| | | | ||
|- | |- | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.select]]({{type|int}} slotNum) | |[[turtle.select]]({{type|int}} slotNum) | ||
| − | |The | + | |The turtle selects slot ''slotNum'' (1 is top left, 16 (9 in 1.33 and earlier) is bottom right) |
| | | | ||
|- | |- | ||
|{{type|int}} items | |{{type|int}} items | ||
|[[turtle.getItemCount]]({{type|int}} slotNum) | |[[turtle.getItemCount]]({{type|int}} slotNum) | ||
| − | |Counts how many items are in | + | |Counts how many items are in slot ''slotNum'' |
| | | | ||
|- | |- | ||
|{{type|int}} items | |{{type|int}} items | ||
|[[turtle.getItemSpace]]({{type|int}} slotNum) | |[[turtle.getItemSpace]]({{type|int}} slotNum) | ||
| − | |Counts how many remaining items you need to fill the stack in | + | |Counts how many remaining items you need to fill the stack in slot ''slotNum'' |
| | | | ||
|-{{row-lightred}} | |-{{row-lightred}} | ||
| Line 80: | Line 80: | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.attackUp]]() | |[[turtle.attackUp]]() | ||
| − | |Attacks | + | |Attacks above the turtle. |
| 1.4 | | 1.4 | ||
|-{{row-lightred}} | |-{{row-lightred}} | ||
| Line 90: | Line 90: | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.dig]]() | |[[turtle.dig]]() | ||
| − | |Breaks the | + | |Breaks the block in front. With hoe: tills the dirt in front of it. |
| | | | ||
|-{{row-lightyellow}} | |-{{row-lightyellow}} | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.digUp]]() | |[[turtle.digUp]]() | ||
| − | |Breaks the | + | |Breaks the block above. With hoe: tills the dirt above it. |
| | | | ||
|-{{row-lightyellow}} | |-{{row-lightyellow}} | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.digDown]]() | |[[turtle.digDown]]() | ||
| − | |Breaks the | + | |Breaks the block below. With hoe: tills the dirt below it. |
| | | | ||
|- | |- | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.place]]({{type|string}} signText) | |[[turtle.place]]({{type|string}} signText) | ||
| − | |Places a | + | |Places a block of the selected slot in front. Engrave ''signText'' on signs if provided. |
| 1.4 | | 1.4 | ||
|- | |- | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.placeUp]]() | |[[turtle.placeUp]]() | ||
| − | |Places a | + | |Places a block of the selected slot above |
| | | | ||
|- | |- | ||
|{{type|boolean}} success | |{{type|boolean}} success | ||
|[[turtle.placeDown]]() | |[[turtle.placeDown]]() | ||
| − | |Places a | + | |Places a block of the selected slot below |
| | | | ||
|- | |- | ||
|{{type|boolean}} result | |{{type|boolean}} result | ||
|[[turtle.detect]]() | |[[turtle.detect]]() | ||
| − | |Detects if there is a | + | |Detects if there is a block in front. Does not detect mobs. |
| | | | ||
|- | |- | ||
|{{type|boolean}} result | |{{type|boolean}} result | ||
|[[turtle.detectUp]]() | |[[turtle.detectUp]]() | ||
| − | |Detects if there is a | + | |Detects if there is a block above |
| | | | ||
|- | |- | ||
|{{type|boolean}} result | |{{type|boolean}} result | ||
|[[turtle.detectDown]]() | |[[turtle.detectDown]]() | ||
| − | |Detects if there is a | + | |Detects if there is a block below |
| | | | ||
|- | |- | ||
Revision as of 20:48, 4 May 2013
The Turtle API is used to work with your Turtles.
Key
| Color | Turtles that can perform this |
|---|---|
| White | All |
| Green | Crafty |
| Yellow | Mining, Felling, Digging, Farming |
| Red | Any tool |
API
| Return | Method name | Description | Min version |
|---|---|---|---|
| boolean success | turtle.craft(int quantity) | Craft items using ingredients anywhere in the turtle's inventory and place results in the active slot. If a quantity is specified, it will craft only up to that many items, otherwise, it will craft as many of the items as possible. | |
| boolean success | turtle.forward() | Let the turtle move forward | |
| boolean success | turtle.back() | Let the turtle move back | |
| boolean success | turtle.up() | Let the Turtle move up | |
| boolean success | turtle.down() | Let the turtle move down | |
| boolean success | turtle.turnLeft() | Let the turtle turn left | |
| boolean success | turtle.turnRight() | Let the turtle turn right | |
| boolean success | turtle.select(int slotNum) | The turtle selects slot slotNum (1 is top left, 16 (9 in 1.33 and earlier) is bottom right) | |
| int items | turtle.getItemCount(int slotNum) | Counts how many items are in slot slotNum | |
| int items | turtle.getItemSpace(int slotNum) | Counts how many remaining items you need to fill the stack in slot slotNum | |
| boolean success | turtle.attack() | Attacks in front of the turtle. | 1.4 |
| boolean success | turtle.attackUp() | Attacks above the turtle. | 1.4 |
| boolean success | turtle.attackDown() | Attacks under the turtle. | 1.4 |
| boolean success | turtle.dig() | Breaks the block in front. With hoe: tills the dirt in front of it. | |
| boolean success | turtle.digUp() | Breaks the block above. With hoe: tills the dirt above it. | |
| boolean success | turtle.digDown() | Breaks the block below. With hoe: tills the dirt below it. | |
| boolean success | turtle.place(string signText) | Places a block of the selected slot in front. Engrave signText on signs if provided. | 1.4 |
| boolean success | turtle.placeUp() | Places a block of the selected slot above | |
| boolean success | turtle.placeDown() | Places a block of the selected slot below | |
| boolean result | turtle.detect() | Detects if there is a block in front. Does not detect mobs. | |
| boolean result | turtle.detectUp() | Detects if there is a block above | |
| boolean result | turtle.detectDown() | Detects if there is a block below | |
| boolean result | turtle.compare() | Detects if the block in front is the same as the one in the currently selected slot | |
| boolean result | turtle.compareUp() | Detects if the block above is the same as the one in the currently selected slot | |
| boolean result | turtle.compareDown() | Detects if the block below is the same as the one in the currently selected slot | |
| boolean result | turtle.compareTo(int slot) | Compare the current selected slot and the given slot to see if the items are the same. Returns true if they are the same, false if not. | 1.4 |
| boolean success | turtle.drop([int count]) | Drops all items in the selected slot, or specified, drops count items. [>= 1.4 only:] If there is a inventory on the side (i.e in front of the turtle) it will try to place into the inventory, returning false if the inventory is full. |
|
| boolean success | turtle.dropUp([int count]) | Drops all items in the selected slot, or specified, drops count items. [>= 1.4 only:] If there is a inventory on the side (i.e above the turtle) it will try to place into the inventory, returning false if the inventory is full. If below a furnace, will place item in the bottom slot. |
|
| boolean success | turtle.dropDown([int count]) | Drops all items in the selected slot, or specified, drops count items. [>= 1.4 only:] If there is a inventory on the side (i.e below the turtle) it will try to place into the inventory, returning false if the inventory is full. If above a furnace, will place item in the top slot. |
|
| boolean success | turtle.suck() | Picks up an item stack of any number, from the ground or an inventory in front of the turtle. If the turtle can't pick up the item, the function returns false. | 1.4 |
| boolean success | turtle.suckUp() | Picks up an item stack of any number, from the ground or an inventory above the turtle. If the turtle can't pick up the item, the function returns false. | 1.4 |
| boolean success | turtle.suckDown() | Picks up an item stack of any number, from the ground or an inventory below the turtle. If the turtle can't pick up the item, the function returns false. | 1.4 |
| boolean success | turtle.refuel([int quantity]) | If the current selected slot contains a fuel item, it will consume it to give the turtle the ability to move. Added in 1.4 and is only needed in needfuel mode. If the current slot doesn't contain a fuel item, it returns false. Fuel values for different items can be found at Turtle.refuel#Fuel_Values. If a quantity is specified, it will refuel only up to that many items, otherwise, it will consume all the items in the slot. |
1.4 |
| int fuel | turtle.getFuelLevel() | Returns the current fuel level of the turtle, this is the number of blocks the turtle can move. If turtleNeedFuel = 0 then it returns "unlimited". |
1.4 |
| boolean success | turtle.transferTo(int slot [, int quantity]) | Transfers quantity items from the selected slot to slot. If quantity isn't specified, will attempt to transfer everything in the selected slot to slot. | 1.45 |
Trivia: During the 1.4 beta, turtle.getFuelLevel() in softcore(that is now turtleneedsfuel = 0) returned 9000.
