Difference between revisions of "Turtle (API)"

From ComputerCraft Wiki
Jump to: navigation, search
m (Corrected types: bool -> boolean)
m (Added types)
Line 24: Line 24:
 
|-{{row-lightgreen}}
 
|-{{row-lightgreen}}
 
|{{type|boolean}} success
 
|{{type|boolean}} success
|[[turtle.craft]]( quantity )
+
|[[turtle.craft]]({{type|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.
 
|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.
 
|
 
|
Line 59: Line 59:
 
|-
 
|-
 
|{{type|boolean}} success
 
|{{type|boolean}} success
|[[turtle.select]](slotNum)
+
|[[turtle.select]]({{type|int}} slotNum)
 
|The Turtle selects the given Slot (1 is top left, 16 (9 in 1.33 and earlier) is bottom right)
 
|The Turtle selects the given Slot (1 is top left, 16 (9 in 1.33 and earlier) is bottom right)
 
|
 
|
 
|-
 
|-
 
|{{type|int}} result
 
|{{type|int}} result
|[[turtle.getItemCount]](slotNum)
+
|[[turtle.getItemCount]]({{type|int}} slotNum)
 
|Counts how many items are in the given Slot
 
|Counts how many items are in the given Slot
 
|
 
|
 
|-
 
|-
 
|{{type|int}} result
 
|{{type|int}} result
|[[turtle.getItemSpace]](slotNum)
+
|[[turtle.getItemSpace]]({{type|int}} slotNum)
 
|Counts how many remaining items you need to fill the stack in the given Slot
 
|Counts how many remaining items you need to fill the stack in the given Slot
 
|
 
|
Line 104: Line 104:
 
|-
 
|-
 
|{{type|boolean}} success
 
|{{type|boolean}} success
|[[turtle.place]](signText)
+
|[[turtle.place]]({{type|string}} signText)
 
|Places a Block of the selected slot in front. Engrave signText on signs if provided.
 
|Places a Block of the selected slot in front. Engrave signText on signs if provided.
 
| 1.4
 
| 1.4
Line 149: Line 149:
 
|-
 
|-
 
|{{type|boolean}} result
 
|{{type|boolean}} result
|[[turtle.compareTo]](slot)
+
|[[turtle.compareTo]]({{type|int}} 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.
 
|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
 
| 1.4
 
|-
 
|-
 
|{{type|boolean}} success
 
|{{type|boolean}} success
|[[turtle.drop]](count)
+
|[[turtle.drop]]({{type|int}} count)
 
|Drops all items in the selected slot, or if count is specified, drops that many items.<br />[>= 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.
 
|Drops all items in the selected slot, or if count is specified, drops that many items.<br />[>= 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.
 
|
 
|
 
|-
 
|-
 
|{{type|boolean}} success
 
|{{type|boolean}} success
|[[turtle.drop|turtle.dropUp]](count)
+
|[[turtle.drop|turtle.dropUp]]({{type|int}} count)
 
|Drops all items in the selected slot, or if count is specified, drops that many items.<br />[>= 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.
 
|Drops all items in the selected slot, or if count is specified, drops that many items.<br />[>= 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.
 
|
 
|
 
|-
 
|-
 
|{{type|boolean}} success
 
|{{type|boolean}} success
|[[turtle.drop|turtle.dropDown]](count)
+
|[[turtle.drop|turtle.dropDown]]({{type|int}} count)
 
|Drops all items in the selected slot, or if count is specified, drops that many items.<br />[>= 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.
 
|Drops all items in the selected slot, or if count is specified, drops that many items.<br />[>= 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.
 
|
 
|
Line 184: Line 184:
 
|-
 
|-
 
|{{type|boolean}} success
 
|{{type|boolean}} success
|[[turtle.refuel]](quantity)
+
|[[turtle.refuel]]({{type|int}} quantity)
 
|If the current selected slot contains a fuel item, it will consume it to give the turtle the ability to move.<br />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.
 
|If the current selected slot contains a fuel item, it will consume it to give the turtle the ability to move.<br />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
 
| 1.4
Line 194: Line 194:
 
|-
 
|-
 
|{{type|boolean}} success
 
|{{type|boolean}} success
|[[turtle.transferTo]](slot, quantity)
+
|[[turtle.transferTo]]({{type|int}} slot, {{type|int}} quantity)
 
|Transfers items from the selected slot to the specified slot in the [quantity] inputted.
 
|Transfers items from the selected slot to the specified slot in the [quantity] inputted.
 
| 1.45
 
| 1.45

Revision as of 20:17, 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 the given Slot (1 is top left, 16 (9 in 1.33 and earlier) is bottom right)
int result turtle.getItemCount(int slotNum) Counts how many items are in the given Slot
int result turtle.getItemSpace(int slotNum) Counts how many remaining items you need to fill the stack in the given Slot
boolean success turtle.attack() Attacks in front of the turtle. 1.4
boolean success turtle.attackUp() Attacks over 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, yields true if they are the same, and false if not. 1.4
boolean success turtle.drop(int 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.
boolean success turtle.dropUp(int 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.
boolean success turtle.dropDown(int 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.
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 yields 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 yields 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 yields 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 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
boolean success turtle.transferTo(int slot, int 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.