Basic lua: Index

From The Official Visionaire Studio: Adventure Game Engine Wiki
< Index >

A'llo & welcome to AFRLme's guide to Lua script; for code dummies & monkeys alike. Here, I will be explaining the general basic fundamentals of Lua script, along with examples & images. If you are wanting to learn how to use Lua script in combination with Visionaire Studio, then you need to check out scripting, data structure, player commands, common commands, script index, & also the official Visionaire Studio luadocs page.

Before we begin, if you have not already done so, then you will need a text editor capable of compiling Lua script. Please follow the instructions below, else skip to the index list & have fun learning.


# Contents Description
0 Index This page...
1 Introduction Quick overview of Lua script, with some additional notes.
2 Basics The basic fundamentals of Lua script.
3 Operators Lua operators are expressions used to perform calculations or to pass arguments between different value types.
4 Types Lua types can range from numbers, to strings, to tables, to conditions & even functions.
5 Tables Tables are one of the most fundamental features of Lua script.
6 Functions Functions are used to process & return data. They are also great for reducing workload & increasing workflow.


Quick note: this section is actually optional & is only for if you want to follow along with what is being shown on the pages of this guide; alternatively you could actually follow along via the script section of Visionaire Studio - it's just that I'm a bit of a snob & I like to type up my scripts in sublime text.

1. You need to download a suitable text editor capable of compiling Lua script. I use Sublime Text.
2a. If you decided to use Sublime Text then you will need to create a build script for lua, as it doesn't come with one.
2b. Open up Sublime Text & go to: Tools > Build System > New Build System...
2c. A new tab should open up titled untitled.sublime-build.
2d. Replace the code that is already in the tab with... (taken from lua.sublime-build by Rory Driscoll)

"cmd": ["lua", "$file"],
"file_regex": "^lua: (...*?):([0-9]*):?([0-9]*)",
"selector": "source.lua"

2e. Save the document as lua.sublime-build
3. Set the build system to lua by going to: Tools > Build System > lua.
4. Voila you can now use ctrl+b to run your scripts. (documents must be saved with .lua extension before scripts can be compiled)

Quick note: the screenshots I have included in this guide belong to the atom text editor by github because I didn't want to include all the millions of tabs I have open in sublime text; also atom is 100% free.

< Index >