ComputerCraft Wiki - User contributions [en]

Making an API (tutorial)

2012-02-24T18:24:19Z

Webmilio:

== 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 an functioning API.
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.
''NOTE: If it exists, call it something else''

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

<code>
-- this is the file exampleAPI
-- our first function:
function printMessage()
print("message")
end
</code>
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 do it the proper way.
No shell.run's!

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:
<code>
os.loadAPI("exampleAPI")
</code>
This loads the API into the file's memory.
''NOTE: You have to do this for every file you include it in.
CC doesn't have long-term memory.''

=== 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]]

Making an API (tutorial)

2012-02-24T18:22:21Z

Webmilio:

== MAKING AN API - a tutorial by TheVarmari ==
'''NOTE:''' There is a better tutorial in the [http://www.computercraft.info/forums2/ forums].
Use this if you prefer to use ccwiki.

== Introduction ==
Hello, dear Computercraft Wiki user!
Today I will tell you how to make an functioning API.
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.
''NOTE: If it exists, call it something else''

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

<code>
-- this is the file exampleAPI
-- our first function:
function printMessage()
print("message")
end
</code>
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 do it the proper way.
No shell.run's!

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:
<code>
os.loadAPI("exampleAPI")
</code>
This loads the API into the file's memory.
''NOTE: You have to do this for every file you include it in.
CC doesn't have long-term memory.''

=== 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]]

ComputerCraft

2012-02-24T18:19:28Z

Webmilio:

The mod itself. This mod, created by dan200, has a [http://www.minecraftforum.net/topic/892282-11-computercraft-13/ thread] on the minecraft forums and it's own [http://computercraft.info wiki]. You can see the history of this mod on the ''[http://http://computercraft.info/wiki/index.php?title=Changelog Changelog]'' page on the wiki.

ComputerCraft

2012-02-24T18:19:08Z

Webmilio: Created the page.

The mod itself. This mod, created by dan200 on the minecraft forums, has a [http://www.minecraftforum.net/topic/892282-11-computercraft-13/ thread] on the minecraft forums and it's own [http://computercraft.info wiki]. You can see the history of this mod on the ''[http://http://computercraft.info/wiki/index.php?title=Changelog Changelog]'' page on the wiki.