Hello World - Revision history

Elverion: /* Intro */

2008-07-31T20:03:15Z

‎Intro

Elverion: /* Intro */

2008-07-31T19:59:00Z

‎Intro

Elverion: /* Hello World */

2008-07-31T19:58:23Z

‎Hello World

Elverion: New page: ===Hello World=== In this tutorial, we will create a script that prints the text "Hello World!" to the screen, then asks the user to press the space bar to terminate the script. We will b...

2008-07-31T19:57:55Z

New page: ===Hello World=== In this tutorial, we will create a script that prints the text "Hello World!" to the screen, then asks the user to press the space bar to terminate the script. We will b...

New page

===Hello World===

In this tutorial, we will create a script that prints the text "Hello World!" to the screen, then asks the user to press the space bar to terminate the script. We will be using [[Library#printf|printf]](), [[Library#startMacro|startMacro]](), and [[Keyboard_Control#keyPressedLocal|keyPressedLocal]]() to accomplish this.

'''The setup'''

The very first thing you will do when starting a new script is insert your main function, and call [[Library#startMacro|startMacro]](). These are not entirely necessary, but make things much easier for us later on because they allow for things such as automatic start/stop keys,automatic timers, and run everything in a protected environment. Your main function can be named anything, but most people just use "main". So lets start with setting that up.
<source lang="lua">
-- This declares our "main" function which will contain our "main loop".
function main()

end

-- startMacro will now call main() within a protected environment for us.
startMacro(main);
</source>

'''The main loop'''

A "main loop" is simply a loop structure (typically a "while" statement) that is run for the duration of your program. That is, the main loop repeats itself over and over until the script should terminate. In this example, we will use a "while" statement to check if the user has pressed a key. Using a 1 inside of while() means that it will keep looping indefinitely. We will check manually inside the loop and use "break" to exit from the while.

Remember, [[Keyboard_Control#keyPressedLocal|keyPressedLocal]]() accepts a virtual key, and tells us if that key is pressed. We will be using this to check if the space bar has been pressed or held down.

<source lang="lua">
-- This declares our "main" function which will contain our "main loop".
function main()

while(1) do
-- if they press space bar, break out of the while
if( keyPressedLocal(key.VK_SPACE) ) then
break;
end
end

end

-- startMacro will now call main() within a protected environment for us.
startMacro(main);
</source>

'''Printing text'''

Now we just need to inform the user what is going on. One of the most handy functions for this is [[Library#printf|printf]](). It allows us to use special tags to replace text, however, we will be using it in it's most simple form. You will note that we are adding a "\n" at the end of the text we want to show the user. The "\n" will '''not''' be visible; it simple means to go down a line.

<source lang="lua">
-- This declares our "main" function which will contain our "main loop".
function main()
printf("Hello World!\n");
printf("Press SPACE BAR to terminate script.\n");

while(1) do
-- if they press space bar, break out of the while
if( keyPressedLocal(key.VK_SPACE) ) then
break;
end
end

printf("Goodbye!\n");

end

-- startMacro will now call main() within a protected environment for us.
startMacro(main);
</source>

And there you have it. If you save this script into your scripts directory and run it, you will see it says "Hello World!" then asks you to press the space bar. Once you press the space bar, it will say "Goodbye!" and the script ends.

@@ Line 5: / Line 5: @@
-'''The setup'''
+===The setup===
 The very first thing you will do when starting a new script is insert your main function, and call [[Library#startMacro|startMacro]](). These are not entirely necessary, but make things much easier for us later on because they allow for things such as automatic start/stop keys, automatic timers, and run everything in a protected environment. Your main function can be named anything, but most people just use "main". So lets start with setting that up.
@@ Line 20: / Line 20: @@
-'''The main loop'''
+===The main loop===
 A "main loop" is simply a loop structure (typically a "while" statement) that is run for the duration of your program. That is, the main loop repeats itself over and over until the script should terminate. In this example, we will use a "while" statement to check if the user has pressed a key. Using a 1 inside of while() means that it will keep looping indefinitely. We will check manually inside the loop and use "break" to exit from the while.
@@ Line 45: / Line 45: @@
-'''Printing text'''
+===Printing text===
-Now we just need to inform the user what is going on. One of the most handy functions for this is [[Library#printf|printf]](). It allows us to use special tags to replace text, however, we will be using it in it's most simple form. You will note that we are adding a "\n" at the end of the text we want to show the user. The "\n" will '''not''' be visible; it simple means to go down a line.
+Now we just need to inform the user what is going on. One of the most handy functions for this is [[Library#printf|printf]](). It allows us to use special tags to replace text, however, we will be using it in it's most simple form. You will note that we are adding a "\n" at the end of the text we want to show the user. The "\n" will '''not''' be visible; it simply means to go down a line.
 <source lang="lua">

← Older revision		Revision as of 19:58, 31 July 2008
Line 1:		Line 1:
−	===~~Hello World~~===	+	===Intro===

	In this tutorial, we will create a script that prints the text "Hello World!" to the screen, then asks the user to press the space bar to terminate the script. We will be using [[Library#printf\|printf]](), [[Library#startMacro\|startMacro]](), and [[Keyboard_Control#keyPressedLocal\|keyPressedLocal]]() to accomplish this.		In this tutorial, we will create a script that prints the text "Hello World!" to the screen, then asks the user to press the space bar to terminate the script. We will be using [[Library#printf\|printf]](), [[Library#startMacro\|startMacro]](), and [[Keyboard_Control#keyPressedLocal\|keyPressedLocal]]() to accomplish this.