Making an API (tutorial) - Revision history

ZudoHackz at 02:37, 26 October 2013

2013-10-26T02:37:49Z

ZudoHackz at 02:35, 26 October 2013

2013-10-26T02:35:26Z

Cranium: /* Including the API */ Added info on absolute path definition

2013-04-23T10:58:58Z

‎Including the API: Added info on absolute path definition

AfterLifeLochie: Reverted edits by 199.19.105.156 (talk) to last revision by Thesbros

2012-12-04T17:10:52Z

Reverted edits by 199.19.105.156 (talk) to last revision by Thesbros

199.19.105.156: PENIS

2012-12-04T17:10:22Z

PENIS

Thesbros: Undo revision 3556 by 85.211.122.17 (talk)

2012-10-29T21:13:00Z

Undo revision 3556 by 85.211.122.17 (talk)

85.211.122.17 at 16:58, 29 October 2012

2012-10-29T16:58:37Z

67.189.72.22 at 22:25, 1 October 2012

2012-10-01T22:25:02Z

67.189.72.22: Undo revision 3251 by 79.102.225.207 (talk)

2012-10-01T22:23:50Z

Undo revision 3251 by 79.102.225.207 (talk)

79.102.225.207: /* The code */

2012-10-01T22:16:08Z

‎The code

← Older revision		Revision as of 02:37, 26 October 2013
Line 78:		Line 78:

	Now if you try to call myCoolNewFunction(), you will get an ''attempt to call nil'' error.		Now if you try to call myCoolNewFunction(), you will get an ''attempt to call nil'' error.
		+
		+	[[Category:Tutorials]]

@@ Line 1: / Line 1: @@
-== MAKING AN API - a tutorial by TheVarmari ==
+An API is a program that is not directly executed, but is a collection of variables that can be accessed from any program on that computer.
-'''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 ==
+<pre>
-Hello, dear Computercraft Wiki user!
+-- My awesome new API
-Today I will tell you how to make a functional API (Application Programming Interface).
-Let's get started!
-== Making the API file ==
+function myCoolNewFunction()
-First we need to define what our API will be called.
+    print(myvar)
-In this case, I use exampleAPI.
+end
-Now edit the file you want your API to be called.
+</pre>
-<!--NOTE: If it exists, call it something else-->
-=== The code ===
+Now try it out. Save and exit the file, then open the ''lua'' program on your ingame computer. Then type:
-Now, we need to put some functions in it!
-Why don't we start with the basics:
 <pre>
- -- this is the file exampleAPI
+os.loadAPI("myapi") -- replace myapi with the name of your API.
- -- our first function:
+myapi.myCoolNewFunction()
- function printMessage(message)
-   print(message)
- end
 </pre>
-=== Including the API ===
+If you have written the program correctly, you will see ''Hello World!'' printed to your screen. Now try:
-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.
 <pre>
- os.loadAPI("exampleAPI")
+print(myapi.myvar)
 </pre>
-This loads the API into the file's memory. Keep in mind that if your API is in a folder, you must include the absolute path to the file:
 <pre>
- os.loadAPI("someFolder/exampleAPI")
+-- My awesome new API
 </pre>
-=== Using the API ===
+If we change our declaration for myvar to local, like this:
-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
+<pre>
-<code>
+-- My awesome new API
- exampleAPI.printMessage("message")
-</code>
-Ta-da! It printed out "message"!
-== A couple of words ==
+local myvar = "Hello World!"
-Thank you for reading this tutorial, it sure was fun to make!
-Correct any mistakes I did!
+function myCoolNewFunction()
-[[User:TheVarmari|TheVarmari]] 16:59, 22 February 2012 (UTC)
+    print(myvar)
-[[Category:Tutorials]]
+Now if you try to call myCoolNewFunction(), you will get an ''attempt to call nil'' error.

@@ Line 41: / Line 41: @@
   os.loadAPI("exampleAPI")
 </pre>
-This loads the API into the file's memory.<br />
+This loads the API into the file's memory. Keep in mind that if your API is in a folder, you must include the absolute path to the file:
 '''NOTE:''' If you want your API to be loaded on every computer, copy your file to ''.minecraft\mods\ComputerCraft\lua\rom\apis\''.

← Older revision		Revision as of 17:10, 4 December 2012
Line 1:		Line 1:
−	~~FUCK YOUR FACE~~	+
		+	== 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.
		+	<!--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:
		+
		+	<pre>
		+	-- this is the file exampleAPI
		+	-- our first function:
		+	function printMessage(message)
		+	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 exampleAPI.
		+	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.<br />
		+	'''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("message")
		+	</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]]

@@ Line 1: / Line 1: @@
+FUCK YOUR FACE
-== 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.
-<!--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:
-−
-<pre>
- -- this is the file exampleAPI
- -- our first function:
- function printMessage(message)
-   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 exampleAPI.
-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.<br />
-'''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("message")
-</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]]

@@ Line 24: / Line 24: @@
   -- this is the file exampleAPI
   -- our first function:
-  function printMessage()
+  function printMessage(message)
-    print("message")
+    print(message)
   end
 </pre>