Robust Turtle API - Revision history

MKlegoman357: Editing of the .jar file is NOT the way to add/replace programs

2016-06-16T18:29:25Z

Editing of the .jar file is NOT the way to add/replace programs

Requios at 18:15, 13 June 2016

2016-06-13T18:15:12Z

Requios: Updated installation instructions

2016-06-13T15:05:49Z

Updated installation instructions

Requios: Changed the digging code and a few minor things. Renamed placeExt to placeRow.

2013-04-15T08:10:48Z

Changed the digging code and a few minor things. Renamed placeExt to placeRow.

Requios at 03:28, 14 April 2013

2013-04-14T03:28:51Z

Requios at 03:16, 14 April 2013

2013-04-14T03:16:16Z

Requios at 03:13, 14 April 2013

2013-04-14T03:13:55Z

Requios at 03:11, 14 April 2013

2013-04-14T03:11:12Z

Requios: A turtle API that extends on the original turtle API and makes it more robust.

2013-04-14T02:42:34Z

A turtle API that extends on the original turtle API and makes it more robust.

New page

This is an unofficial API. This means that you have to install it manually.
 This API extends on the original turtle API and makes it more robust. It strives to make coding a turtle easier.
 When traveling, for example, it will not get stopped by mobs, players, or any block. Not even sand that comes falling down.

==Installation==

* Go to minecraft/mods/computercraft.zip/lua/rom/apis/turtle (if you are running on a server, only the server needs to have it).
* Save the code beneath as 't', so that you can easily call every function in-game, e.g. "t.forward()".
* Add the file to the folder.

==Explanation==

A lot of the functions do the same as the default turtle API, except with additional checks.
 The names are the same, but instead of writing "turtle." in front, you can now write "t.".

 '''Digging'''
 These will dig as long as there is a block in the way. So if sand comes falling down, it will dig as long as necessary.
* t.dig()
* t.digUp()
* t.digDown()

 '''Traveling'''
 These will not be stopped by blocks or mobs.
 ''[amount]'' is optional, you can leave it out. It is the amount of blocks to travel. If left out these will travel 1 block.
* t.forward(''[amount]'')
* t.up(''[amount]'')
* t.down(''[amount]'')
* t.back(''[amount]'')

 '''Placing blocks'''
 Here, 'block' is a number between 1 and 16. I highly recommend adding e.g. "stoneBrick = 1" at the beginning of the code. This way you can later easily see which block must go in which slot. Example: "t.place(stoneBrick)".
* t.place(''block'')
* t.placeUp(''block'')
* t.placeDown(''block'')
* t.placeRight(''block'')
* t.placeLeft(''block'')
* t.placeBack(''block'')
If any of these run out of their resource, the API will write a message and waits for any text input to continue. This way you can refill and write something (anything) to continue the program.

 The following is a special function. It places a row of blocks:
* t.placeExt(''placeDir'', ''block'', ''travelDir'', ''length'')
**''travelDir'' is the most logical one. It is the direction the turtle travels to. Possible directions: "forward","up","down","right","left","back".
**''placeDir'' is a bit more difficult to understand. ''placeDir'' is the direction to place the block in. The turtle travels in one direction, but it cannot place a block in that direction (it can, but it will get dug up again). This means that the place direction must be another direction as the travel direction. Possible directions are the same as ''travelDir''.
**''length'' is the amount of blocks to travel.
**Example: t.placeExt(up, marble, forward, 15)

 '''Turning'''
 This function simply turns right twice. If you really want, you can easily change it to turn left twice.
* t.turnAround()

 These are simply a shorter way to write turtle.turnLeft() and turtle.turnRight().
* t.right()
* t.left()

 These simply turn left or right, and move forward an amount.
 ''[amount]'' is optional, and is the amount of blocks to travel forward. If left out these will travel 1 block.
* t.goRight(''[amount]'')
* t.goLeft(''[amount]'')

 These are the same as the previous functions, except at the end they turn in the opposite direction again.
* t.strafeRight(''[amount]'')
* t.strafeLeft(''[amount]'')

==Code==

<pre>
--Digging with gravel/sand detection
function dig()
while turtle.detect() do
turtle.dig()
sleep(0.4)
end
end

function digUp()
while turtle.detectUp() do
turtle.digUp()
sleep(0.4)
end
end

function digDown()
while turtle.detectDown() do
turtle.digDown()
sleep(0.4)
end
end

--Traveling: Goes in the direction no matter what (almost)
--Will not be stopped by blocks or mobs
function forward(l)
l=l or 1
for i=1,l do
local tries = 0
while turtle.forward() ~= true do
turtle.dig()
turtle.attack()
sleep(0.2)
tries = tries + 1
if tries>500 then
print("Error: can't move forward.")
return false
end
end
end
return true
end

function up(l)
l=l or 1
for i=1,l do
local tries = 0
while turtle.up() ~= true do
turtle.digUp()
turtle.attackUp()
sleep(0.2)
tries = tries + 1
if tries>500 then
print("Error: can't move up.")
return false
end
end
end
return true
end

function down(l)
l=l or 1
for i=1,l do
local tries = 0
while turtle.down() ~= true do
turtle.digDown()
turtle.attackDown()
sleep(0.2)
tries = tries + 1
if tries>500 then
print("Error: can't move down.")
return false
end
end
end
return true
end

function back(l)
l=l or 1
for i=1,l do
if turtle.back() ~= true then
turnAround()
forward()
turnAround()
end
end
end

--Place blocks
--Does not place when there's already the right block.
function place(block)
turtle.select(block)
if turtle.compare()==false then
if turtle.getItemCount(block)==0 then
outOfResource(block)
end
dig()
turtle.place()
end
end

function placeUp(block)
turtle.select(block)
if turtle.compareUp()==false then
if turtle.getItemCount(block)==0 then
outOfResource(block)
end
digUp()
turtle.placeUp()
end
end

function placeDown(block)
turtle.select(block)
if turtle.compareDown()==false then
if turtle.getItemCount(block)==0 then
outOfResource(block)
end
digDown()
turtle.placeDown()
end
end

local function outOfResource()
print("Ran out of a resource. Block: ",block , ".")
print("Refill, then say something to proceed.")
read()
end

function placeRight(block)
turtle.turnRight()
place(block)
turtle.turnLeft()
end

function placeLeft(block)
turtle.turnLeft()
place(block)
turtle.turnRight()
end

function placeBack(block)
turnAround()
place(block)
turnAround()
end

--place extended e.g. placeExt(up, marble, forward, 15)
function placeExt(placeDir, block, travelDir, l)
l=l or 1
for i=1,l do
if placeDir == "forward" then
place(block)
elseif placeDir == "up" then
placeUp(block)
elseif placeDir == "down" then
placeDown(block)
elseif placeDir == "right" then
placeRight(block)
elseif placeDir == "left" then
placeLeft(block)
elseif placeDir == "back" then
placeBack(block)
else
print('"', placeDir, '" is not a valid direction!')
return false
end
if travelDir == "forward" then
forward()
elseif travelDir == "up" then
up()
elseif travelDir == "down" then
down()
elseif travelDir == "right" then
strafeRight()
elseif travelDir == "left" then
strafeLeft()
elseif travelDir == "back" then
back()
else
print('"', travelDir, '" is not a valid direction!')
return false
end
end
return true
end

--Turning
function turnAround()
turtle.turnRight()
turtle.turnRight()
end

function right()
turtle.turnRight()
end

function left()
turtle.turnLeft()
end

function goRight(l)
l=l or 1
turtle.turnRight()
forward(l)
end

function goLeft(l)
l=l or 1
turtle.turnLeft()
forward(l)
end

function strafeRight(l)
l=l or 1
goRight(l)
turtle.turnLeft()
end

function strafeLeft(l)
l=l or 1
goLeft(l)
turtle.turnRight()
end
</pre>

[[Category:Unofficial_APIs]]

@@ Line 6: / Line 6: @@
 ==Installation==
-* Find minecraft/mods/computercraft.jar and change its extension to .zip (make sure the file browser doesn't hide extensions).
+Install globally on all Turtles:
-* Inside the zip, navigate to assets/computercraft/lua/rom/apis/turtle (if you are running on a server, only the server needs the file).
+* Create and install a new [[Lua_Resource_Pack_Making_(Tutorial)|resource pack]] on the client (if playing singleplayer) or the server (if playing multiplayer).
-* Save the code beneath as 't' (without '.txt'), so that you can easily call every function in-game, e.g. "t.forward()".
+* [http://pastebin.com/0TnEBf2P Download the API] and save it in the 'assets/computercraft/lua/rom/apis/turtle' directory inside the resource pack.
-* Add the file to the folder.
+* The name of the file will determine the name of the API (If you save it as 't' you'd call the 'forward()' function like so: <var>t.forward()</var>).
-* Change the extension back to .jar (optional, mods tend to work as .zip too).
+* The API will automatically be loaded for every Turtle.
 ==Usage==

@@ Line 10: / Line 10: @@
 * Save the code beneath as 't' (without '.txt'), so that you can easily call every function in-game, e.g. "t.forward()".
 * Add the file to the folder.
-* Change the extension back to .jar.
+* Change the extension back to .jar (optional, mods tend to work as .zip too).

@@ Line 6: / Line 6: @@
 ==Installation==
-* Go to minecraft/mods/computercraft.zip/lua/rom/apis/turtle (if you are running on a server, only the server needs the file).
+* Find minecraft/mods/computercraft.jar and change its extension to .zip (make sure the file browser doesn't hide extensions).
 * Save the code beneath as 't' (without '.txt'), so that you can easily call every function in-game, e.g. "t.forward()".
 * Add the file to the folder.

@@ Line 1: / Line 1: @@
 This is an <b>unofficial API</b>. This means that you have to install it manually.
 <br/> This API extends on the original turtle API and makes it more robust. It also strives to make coding a turtle easier.
-<br/> When traveling for example, it will not get stopped by mobs, players, or any block. Not even sand that comes falling down.
+<br/> When traveling for example, it will not get stopped by mobs, players, sand, or any other block.

@@ Line 1: / Line 1: @@
 This is an <b>unofficial API</b>. This means that you have to install it manually.
-<br/> This API extends on the original turtle API and makes it more robust. It strives to make coding a turtle easier.
+<br/> This API extends on the original turtle API and makes it more robust. It also strives to make coding a turtle easier.
 <br/> When traveling for example, it will not get stopped by mobs, players, or any block. Not even sand that comes falling down.

@@ Line 1: / Line 1: @@
 This is an <b>unofficial API</b>. This means that you have to install it manually.
 <br/> This API extends on the original turtle API and makes it more robust. It also strives to make coding a turtle easier.
-<br/> When traveling for example, it will not get stopped by mobs, players, sand, or any other block.
+<br/> When traveling, for example, it will not get stopped by mobs, players, sand, or any other block.
@@ Line 31: / Line 31: @@
 <br/>'''Placing blocks'''
-<br/>Here, '<i>block</i>' is a number between 1 and 16. I highly recommend adding e.g. "stoneBrick = 1" at the beginning of the code. This way you can later easily see which block must go in which slot. Example: "t.place(stoneBrick)".
+<br/>Here, '<i>block</i>' is a number between 1 and 16. It combines selecting and placing.
 * t.place(''block'')
 * t.placeUp(''block'')
@@ Line 38: / Line 40: @@
 * t.placeLeft(''block'')
 * t.placeBack(''block'')
-<br/> The following is a special function. It is an extended version of the place functions. It places a row of blocks:
+<br/>The following function places a row of blocks:
-* t.placeExt(''placeDir'', ''block'', ''travelDir'', ''length'')
+* t.placeRow(''placeDir'', ''block'', ''travelDir'', ''length'')
 **''travelDir'' is the most logical one. It is the direction the turtle travels to. Possible directions: "forward","up","down","right","left","back".
 **''placeDir'' is a bit more difficult to understand. ''placeDir'' is the direction to place the block in. The turtle travels in one direction, but it cannot place a block in that direction (it can, but it will get dug up again). This means that the place direction must be another direction as the travel direction. The possible directions are the same as ''travelDir''.
 **''length'' is the amount of blocks to travel.
-**Example: t.placeExt(up, marble, forward, 15)
+**Example: t.placeRow(up, marble, forward, 15)
 <br/>'''Turning'''
-<br/>This function simply turns right twice. If you really want, you can change it to turn left twice.
+<br/>This function simply turns right twice. If you really want, you can change it to turn left twice ;).
 * t.turnAround()
@@ Line 66: / Line 71: @@
 ==Code==
-Download: [http://pastebin.com/D4ysDZLc Robust Turtle API]
+Download: [http://pastebin.com/0TnEBf2P Robust Turtle API]
 <br/>Save it as 't', without ".txt".
@@ Line 74: / Line 79: @@
 --Digging with gravel/sand detection
 function dig()
    while turtle.detect() do
      turtle.dig()
      sleep(0.4)
    end
 end
 function digUp()
    while turtle.detectUp() do
      turtle.digUp()
      sleep(0.4)
    end
 end
 function digDown()
    while turtle.detectDown() do
      turtle.digDown()
      sleep(0.4)
    end
 end
@@ Line 222: / Line 248: @@
 end
---place extended     e.g. placeExt(up, marble, forward, 15)
+--place row     e.g. placeRow(up, marble, forward, 15)
-function placeExt(placeDir, block, travelDir, l)
+function placeRow(placeDir, block, travelDir, l)
    l=l or 1
    for i=1,l do

@@ Line 1: / Line 1: @@
 This is an <b>unofficial API</b>. This means that you have to install it manually.
 <br/> This API extends on the original turtle API and makes it more robust. It strives to make coding a turtle easier.
-<br/> When traveling, for example, it will not get stopped by mobs, players, or any block. Not even sand that comes falling down.
+<br/> When traveling for example, it will not get stopped by mobs, players, or any block. Not even sand that comes falling down.
 ==Installation==
-* Go to minecraft/mods/computercraft.zip/lua/rom/apis/turtle (if you are running on a server, only the server needs to have it).
+* Go to minecraft/mods/computercraft.zip/lua/rom/apis/turtle (if you are running on a server, only the server needs the file).
 * Save the code beneath as 't', so that you can easily call every function in-game, e.g. "t.forward()".
 * Add the file to the folder.
-==Explanation==
+==Usage==
-A lot of the functions do the same as the default turtle API, except with additional checks.
+A lot of the functions do the same as the default turtle API, except with additional checks. There are also some functions that combine default functions for ease of use. E.g. turnAround() turns right twice.
-<br/>The names are the same, but instead of writing "turtle." in front, you can now write "t.".
+<br/>Most of the function names are the same, but instead of writing "turtle." in front, you now write "t.".
 <br/>'''Digging'''
-<br/>These will dig as long as there is a block in the way. So if sand comes falling down, it will dig as long as necessary.
+<br/>These will dig as long as there is a block in the way. So if sand falls down, it will dig as long as necessary.
 * t.dig()
 * t.digUp()
@@ Line 40: / Line 40: @@
 If any of these run out of their resource, the API will write a message and waits for any text input to continue. This way you can refill and write something (anything) to continue the program.
-<br/> The following is a special function. It places a row of blocks:
+<br/> The following is a special function. It is an extended version of the place functions. It places a row of blocks:
 * t.placeExt(''placeDir'', ''block'', ''travelDir'', ''length'')
 **''travelDir'' is the most logical one. It is the direction the turtle travels to. Possible directions: "forward","up","down","right","left","back".
@@ Line 48: / Line 48: @@
 <br/>'''Turning'''
-<br/>This function simply turns right twice. If you really want, you can easily change it to turn left twice.
+<br/>This function simply turns right twice. If you really want, you can change it to turn left twice.
 * t.turnAround()
@@ Line 60: / Line 60: @@
 * t.goLeft(''[amount]'')
-<br/>These are the same as the previous functions, except at the end they turn in the opposite direction again.
+<br/>These are the same as the previous functions, except at the end they turn back again.
 * t.strafeRight(''[amount]'')
 * t.strafeLeft(''[amount]'')