Difference between revisions of "Turtle (API)"

From ComputerCraft Wiki
Jump to: navigation, search
m
Line 50: Line 50:
 
|{{type|bool}} success
 
|{{type|bool}} success
 
|[[turtle.turnLeft]]()
 
|[[turtle.turnLeft]]()
|The Turtle turns left
+
|Let the Turtle turn left
 
|
 
|
 
|-
 
|-
 
|{{type|bool}} success
 
|{{type|bool}} success
 
|[[turtle.turnRight]]()
 
|[[turtle.turnRight]]()
|The Turtle turns right
+
|Let the Turtle turn right
 
|
 
|
 
|-
 
|-

Revision as of 07:22, 12 February 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
bool success turtle.craft( 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.
bool success turtle.forward() Let the Turtle move forward
bool success turtle.back() Let the Turtle move back
bool success turtle.up() Let the Turtle move up
bool success turtle.down() Let the Turtle move down
bool success turtle.turnLeft() Let the Turtle turn left
bool success turtle.turnRight() Let the Turtle turn right
bool success turtle.select(slotNum) The Turtle selects the given Slot (1 is top left, 16 (9 in 1.33 and earlier) is bottom right)
int result turtle.getItemCount(slotNum) Counts how many items are in the given Slot
int result turtle.getItemSpace(slotNum) Counts how many remaining items you need to fill the stack in the given Slot
bool success turtle.attack() Attacks in front of the turtle. 1.4
bool success turtle.attackUp() Attacks over the turtle. 1.4
bool success turtle.attackDown() Attacks under the turtle. 1.4
bool success turtle.dig() Breaks the Block in front. With hoe: tills the dirt in front of it.
bool success turtle.digUp() Breaks the Block above. With hoe: tills the dirt above it.
bool success turtle.digDown() Breaks the Block below. With hoe: tills the dirt below it.
bool success turtle.place(signText) Places a Block of the selected slot in front. Engrave signText on signs if provided. 1.4
bool success turtle.placeUp() Places a Block of the selected slot above
bool success turtle.placeDown() Places a Block of the selected slot below
bool result turtle.detect() Detects if there is a Block in front. Does not detect mobs.
bool result turtle.detectUp() Detects if there is a Block above
bool result turtle.detectDown() Detects if there is a Block below
bool result turtle.compare() Detects if the block in front is the same as the one in the currently selected slot
bool result turtle.compareUp() Detects if the block above is the same as the one in the currently selected slot
bool result turtle.compareDown() Detects if the block below is the same as the one in the currently selected slot
bool result turtle.compareTo(slot) Compare the current selected slot and the given slot to see if the items are the same, yields true if they are the same, and false if not. 1.4
bool success turtle.drop(count) Drops all items in the selected slot, or if count is specified, drops that many 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.
bool success turtle.dropUp(count) Drops all items in the selected slot, or if count is specified, drops that many 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.
bool success turtle.dropDown(count) Drops all items in the selected slot, or if count is specified, drops that many 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.
bool 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 yields false. 1.4
bool 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 yields false. 1.4
bool 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 yields false. 1.4
bool success turtle.refuel(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 yields 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 yields "unlimited".
1.4
bool success turtle.transferTo(slot, quantity) Transfers items from the selected slot to the specified slot in the [quantity] inputted. 1.45

Trivia: During the 1.4 beta, turtle.getFuelLevel() in softcore(that is now turtleneedsfuel = 0) returned 9000.