ComputerCraft Wiki - User contributions [en]

Making an API (tutorial)

2012-03-20T18:53:14Z

PTS: Method for auto loading

== MAKING AN API - a tutorial by TheVarmari ==
'''NOTE:''' There is a better tutorial in the [http://www.computercraft.info/forums2/ forums] located [http://www.computercraft.info/forums2/index.php?/topic/145-tutorial-creating-an-api/ here].
Use this if you prefer to use ccwiki.

== Introduction ==
Hello, dear Computercraft Wiki user!
Today I will tell you how to make a functional API (Application Programming Interface).
Let's get started!

== Making the API file ==
First we need to define what our API will be called.
In this case, I use exampleAPI.
Now edit the file you want your API to be called.


=== The code ===
Now, we need to put some functions in it!
Why don't we start with the basics:

<pre>
-- this is the file exampleAPI
-- our first function:
function printMessage()
print("message")
end
</pre>
Which basically prints "message" when excecuted.
Save the file.

=== Including the API ===
Now that we have the API done, let's include it in some file!
Because we speak about APIs, we can't directly execute it.

Edit the file you want to include the API in.
In my case, it is called exampleFile.
Now, we include the API in it by typing this to the '''first''' row:
<pre>
os.loadAPI("exampleAPI")
</pre>
This loads the API into the file's memory. 
'''NOTE:''' If you want your API to be loaded on every computer, copy your file to ''.minecraft\mods\ComputerCraft\lua\rom\apis\''.

=== Using the API ===
Now that that's over, let's include the printMessage command from our API.
Lua loads API's as tables, so you have to use api_name.function_name(function_arguments)

In my case, I use
<code>
exampleAPI.printMessage()
</code>
Ta-da! It printed out "message"!

== A couple of words ==
Thank you for reading this tutorial, it sure was fun to make!
Correct any mistakes I did!
[[User:TheVarmari|TheVarmari]] 16:59, 22 February 2012 (UTC)

[[Category:Tutorials]]

Startup

2012-03-20T18:43:36Z

PTS: Noted boot order. Removed forward slashes from example code paths (lua paths do not begin with a slash)

==Startup Scripts==
If, upon booting, a computer terminal detects a script named "startup" in its root directory, this script will be run. Similarly, if a disk is present in an attached disk drive containing a script named "startup" that script will be run. Disk autorun scripts take prevalence over root directory autorun. This means if both the root directory and the disk contain a file called "startup" the one on the disk will be executed.

===Very simple auto-install script to set up a single-use terminal (e.g. password-protected door):===
Disk contents:
/disk/startup (installer script)
/disk/startup.file (program to be installed on terminal)

The script could look like:
fs.copy("disk/startup.file", "startup")
shell.run("startup")

When the disk is placed into a drive attached to a terminal, and the terminal is rebooted - the startup file on the disk will run. This startup file serves only to copy the program you've named "startup.file" to the root directory of the terminal with the new name "startup" - this will then run each time the terminal is booted, eliminating the need for the disk drive.

[[Category:Tutorials]]

Advanced Turtle Lumberjack (tutorial)

2012-03-20T18:37:52Z

PTS: Fixed the loop so it actually works. Added forward movement after the first block is removed.

== Advanced Turtle Lumberjack ==
=== Introduction ===
Welcome to this [[:Category:Tutorials|tutorial]] about Advanced Turtle Lumberjacks.
See the [[Turtle_Lumberjack_(tutorial)|Turtle Lumberjack Tutorial]] first.

=== What are Advanced Turtle Lumberjacks? ===
Advanced Turtle Lumberjacks are basically [[Turtle_Lumberjack_(tutorial)|Turtle Lumberjacks]] that can dig blocks above them. We first make the turtle dig the block in front of it and then move forward so the rest of the tree is directly above it.

== The Code ==
<code>
turtle.dig()
turtle.forward()
while turtle.detectUp() do
turtle.digUp()
turtle.up()
end
while not turtle.detectDown() do
turtle.down()
end
</code>
This makes us check if there are no blocks to be digged, then we go down until we can't.
That's it!

('''Helpful tip:''' Save this to your computercraft/lua/rom/programs folder, then it will be on all turtles.)

== Category & Author ==
A tutorial by [[User:TheVarmari|TheVarmari]]. Feel free to correct any mistakes!
[[Category:Tutorials]]

Turtle (API)

2012-03-19T15:13:19Z

PTS: Added amount variable to turtle.drop

The Turtle API is used to Work with your Turtles.
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[turtle.forward]]()
|Let the Turtle move forward
|-
|[[turtle.back]]()
|Let the Turtle move back
|-
|[[turtle.up]]()
|Let the Turtle move up
|-
|[[turtle.down]]()
|Let the Turtle move down
|-
|[[turtle.turnLeft]]()
|The Turtle turns left
|-
|[[turtle.turnRight]]()
|The Turtle turns right
|-
|[[turtle.select]]( slotNum )
|The Turtle selects the given Slot (1 is top left, 9 is bottom right)
|-
|[[turtle.getItemCount]]( slotNum )
|Counts how many items are in the given Slot
|-
|[[turtle.getItemSpace]]( slotNum )
|Counts how many items you need to fill the stack in the given Slot
|-
|[[turtle.dig]]()
|Breaks the Block in front
|-
|[[turtle.digUp]]()
|Breaks the Block above
|-
|[[turtle.digDown]]()
|Breaks the Block below
|-
|[[turtle.place]]()
|Places a Block of the selected Slot in front
|-
|[[turtle.placeUp]]()
|Places a Block of the selected Slot above
|-
|[[turtle.placeDown]]()
|Places a Block of the selected Slot below
|-
|[[turtle.detect]]()
|Detects if there is a Block in front
|-
|[[turtle.detectUp]]()
|Detects if there is a Block above
|-
|[[turtle.detectDown]]()
|Detects if there is a Block below
|-
|[[turtle.compare]]()
|Detects if the block in front is the same as the one in the selected Slot
|-
|[[turtle.compareUp]]()
|Detects if the block above is the same as the one in the selected Slot
|-
|[[turtle.compareDown]]()
|Detects if the block below is the same as the one in the selected Slot
|-
|[[turtle.drop]]( [ammount] )
|Drops everything of the selected Slot or the specified amount
|}
[[Category:APIs]]

Peripheral (API)

2012-03-17T09:25:32Z

PTS: Created article, added short description of all methods. Used some data directly from the mod's documentation.

The peripheral API is for interacting with external peripherals, such as the disk drive and monitor.
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|peripheral.isPresent( side )
|Returns '''true''' if a peripheral is present on ''side''.
|-
|peripheral.getType( side )
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.
|-
|peripheral.getMethods( side )
|Returns a table containing all methods for peripheral on ''side''.
|-
|peripheral.call( side, methodName, param1, param2, ... )
|Sends a function call to peripheral located on ''side''. Return values match those of called method. 
'''Note:''' ''methodName'' is a string.
|-
|peripheral.wrap( side )
|Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available, as if calling '''peripheral.call()''', e.g.: 
fdd = peripheral.wrap("left") 
fdd.isPresent() 
''- is the same as -'' 
peripheral.call("left","isPresent")
|}
When new peripherals are added and removed from the computer, the events '''peripheral''' and '''peripheral_detach'' will fire, with the side as a parameter. [[Console|Consoles]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion, compared to with [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''suthdown'', ''reboot'', ''getID''.
[[Category:APIs]]

Textutils (API)

2012-03-17T08:42:45Z

PTS:

Text utilities is used to mess around with text easier.

Its functions include:
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|textutils.slowPrint( text )
|Slowly prints the text.
|-
|textutils.slowWrite( text )
|Slowly writes the text.
|-
|textutils.formatTime( time, bTwentyFourHour)
|Put a time into it, and it spews it out in a different format.
|-
|textutils.tabulate( table, table2, so on)
|Prints tables in an ordered form. Each table is a row, columns' width is auto-adjusted.
|-
|textutils.pagedTabulate( table, table2, so on)
|<no description given>
|-
|textutils.serialize( t )
|<no description given>
|-
|textutils.unserialize( s )
|<no description given>
|-
|textutils.urlEncode( str )
|<no description given>
|}

[[Category:APIs]]