Smarter Turtles v0.1a - Documentation

turtle.up(n, afterEachMove, retryOnFail)
    Move the turtle up a specified number of times.
    Arguments:
        n : The number of steps to take [Default: 1]
        afterEachMove : The function to run after each step.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.up([1-n* [, (function|nil) [, (true | false)]]])
        * where n is some number greater than 1 which will not take your turtle above the sky box

turtle.down(n, afterEachMove, retryOnFail)
    Move the turtle down a specified number of times.
    Arguments:
        n : The number of steps to take [Default: 1]
        afterEachMove : The function to run after each step.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.down([1-n* [, (function|nil) [, (true | false)]]])
        * where n is some number greater than 1 which will not take your turtle below bedrock

turtle.back(n, afterEachMove, retryOnFail)
    Move the turtle back a specified number of times.
    Arguments:
        n : The number of steps to take [Default: 1]
        afterEachMove : The function to run after each step.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.back([1-n* [, (function|nil) [, (true | false)]]])
        * where n is some number greater than 1 which will not take your turtle into an unloaded chunk

turtle.forward(n, afterEachMove, retryOnFail)
    Move the turtle forward a specified number of times.
    Arguments:
        n : The number of steps to take [Default: 1]
        afterEachMove : The function to run after each step.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.forward([1-n* [, (function|nil) [, (true | false)]]])
        * where n is some number greater than 1 which will not take your turtle into an unloaded chunk

turtle.left(n, reorientAfterEachMove, reorientWhenDone, afterEachMove, retryOnFail)
    Move the turtle left a specified number of times.  In order to move left, the turtle will first turn left, then start walking forwards.
    Arguments:
        n : The number of steps to take [Default: 1]
        reorientAfterEachMove : A flag indicating whether or not the turtle should face its original direction after each step. [Default: false]
        reorientWhenDone : A flag indicating whether or not the turtle should face its original direction when it has finished moving n times.  Note, if reorientAfterEachMove is set to true, this value is ignored [Default: true]
        afterEachMove : The function to run after each step.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.left([1-n* [, (true | false) [, (true | false) [, (function|nil) [, (true | false)]]]]])
        * where n is some number greater than 1 which will not take your turtle into an unloaded chunk

turtle.right(n, reorientAfterEachMove, reorientWhenDone, afterEachMove, retryOnFail)
    Move the turtle right a specified number of times.  In order to move right, the turtle will first turn right, then start walking forwards.
    Arguments:
        n : The number of steps to take [Default: 1]
        reorientAfterEachMove : A flag indicating whether or not the turtle should face its original direction after each step. [Default: false]
        reorientWhenDone : A flag indicating whether or not the turtle should face its original direction when it has finished moving n times.  Note, if reorientAfterEachMove is set to true, this value is ignored [Default: true]
        afterEachMove : The function to run after each step.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.right([1-n* [, (true | false) [, (true | false) [, (function|nil) [, (true | false)]]]]])
        * where n is some number greater than 1 which will not take your turtle into an unloaded chunk

turtle.dig(n, afterEachDig, whenDone, retryOnFail)
    Digs forwards a specified number of times.  When n is greater than 1, the turtle will move forward after each dig.  The turtle will wait for and dig out any falling entities before moving forward.  If no blocks are detected, the turtle will move forwards until it finds blocks to dig or until it reaches n.
    Arguments:
        n : The number of times to dig [Default: 1]
        afterEachDig : A function to run each time the turtle digs something up.  If the turtle does not encounter a block and, instead, walks through empty space, this function is not called.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        whenDone : A function to run when the turtle has finished digging n times.  Useful for getting the turtle to return to its original place. Takes a "steps" argument which is n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.dig([1-n* [, (function | nil) [, (function|nil) [, (true | false)]]]])
        * where n is some number greater than 1 which will not take your turtle into an unloaded chunk

turtle.digUp(n, afterEachDig, whenDone, retryOnFail)
    Digs up a specified number of times.  When n is greater than 1, the turtle will move up after each dig.  The turtle will wait for and dig out any falling entities before moving up.  If no blocks are detected, the turtle will move up until it finds blocks to dig or until it reaches n.
    Arguments:
        n : The number of times to dig [Default: 1]
        afterEachDig : A function to run each time the turtle digs something up.  If the turtle does not encounter a block and, instead, walks through empty space, this function is not called.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        whenDone : A function to run when the turtle has finished digging n times.  Useful for getting the turtle to return to its original place. Takes a "steps" argument which is n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.digUp([1-n* [, (function | nil) [, (function|nil) [, (true | false)]]]])
        * where n is some number greater than 1 which will not take your turtle above the sky box

turtle.digDown(n, afterEachDig, whenDone, retryOnFail)
    Digs down a specified number of times.  When n is greater than 1, the turtle will move down after each dig.  If no blocks are detected, the turtle will move down until it finds blocks to dig or until it reaches n.
    Arguments:
        n : The number of times to dig [Default: 1]
        afterEachDig : A function to run each time the turtle digs something up.  If the turtle does not encounter a block and, instead, walks through empty space, this function is not called.  Takes a "step" argument which is the current step from 1 to n. [Default: nil]
        whenDone : A function to run when the turtle has finished digging n times.  Useful for getting the turtle to return to its original place. Takes a "steps" argument which is n. [Default: nil]
        retryOnFail : A flag indicating whether or not to retry the action until successful [Default: true]
    Usage:
        turtle.digUp([1-n* [, (function | nil) [, (function|nil) [, (true | false)]]]])
        * where n is some number greater than 1 which will not take your turtle below bedrock

Note regarding retryOnFail: When enabled (enabled by default), if the turtle gets stuck for any reason (can't move, can't dig, etc) the program it is executing will pause and it will wait for assistance.  An example of this can be seen in the YouTube teaser.