/ HALion Developer Resource / HALion Script / Getting Started /

Exploring the Code Examples

On this page:

Many of the classes and functions that are are described in the Class Reference and on the Reference pages provide working code examples. The code examples use syntax highlighting. Comments are displayed in green, functions in magenta and values in blue, for example. See Lua Syntax Highlighting for more details.

Example

-- "Hello world!" Lua script

print("Hello world!")

The easiest way to explore the code examples is to copy the code to the clipboard and to paste it to the internal script editor of the Lua Script MIDI module. Please read below how to do this.

Jump to Top

Program for Code Examples

If not stated otherwise, the following simple program will be sufficient for exploring the code examples in HALion.

  1. Download the program Explore Code Examples.vstpreset
  2. Drag the program to the Slot Rack.

This describes how you create the program manually.

  1. Select an empty program in the Program Table.
  2. In the Program Tree, click Create New MIDI Module Create New MIDI Module and select Lua Script.
  3. In the Program Tree, click Create New Zone Create New Zone and select Synth Zone.
  4. Load the program to the Slot Rack.

This is how your program should look like in the program tree.

Simple Program

Jump to Top

Loading the Code Examples

The program described above should be loaded in the Slot Rack.

  1. Open a page with a code example, for example, onNote.
  2. Double-click the code example to select all lines and press Ctrl/Cmd-C to copy the code to the clipboard.
  3. Go to HALion and select Lua Script in the Program Tree.
  4. Open the section for the Lua Script MIDI module, either in the Sound or in the MIDI Modules editor.
  5. Click Edit Script to open the internal Script Editor.
  6. Give the Script Editor the window focus and press Ctrl/Cmd-V to paste the code from the clipboard.
  7. Click OK to activate the script.

Internal Script Editor

Depending on the code example, you usually have to play a note or send a MIDI controller to get a sound or output message from the script. Typically, the description of the feature and the comments in the code will give you enough hints for what to do. In the above example, onNote prints the note ID, the MIDI note number and the MIDI velocity, each time you play a note.

Script Output Messages

Jump to Top