Home
Reference Index
Editor
Advanced Tab
Script Description Editor
This window is used to create script description files (NL2SCRIPT). This file type is required when creating editor plugins. Reusable scripts designed for Play Mode might also benefit from a NL2SCRIPT description file.
Main Buttons
New
Start a new NL2SCRIPT file.
Open
Open an existing NL2SCRIPT file.
Save
Save the current settings to the NL2SCRIPT file.
Close
Close the current NL2SCRIPT file.
Help
Display this help window.
General Tab
Script Class
The nlvm file with the scripted program code. When using the script for coasters, environments or scene objects, the class inside the nlvm file must extend from the com.nolimitscoaster.Script class. If the script is meant to be executed from the editor, it needs to implement the public static void main(); method.
Class Path
The root folder of all nlvm files used by the script. This can be left empty. When it is left empty, the class path is identical to the folder the selected script class file is located in.
Description
Enter a description to be shown inside the File Browser.
Preview
Select a thumbnail preview image to be shown inside the File Browser.
Private Virtual Machine
When this is enabled, the script instance will run in its own virtual machine. When turned off (default), all scripts using the same class path will run in a shared virtual machine and will share global (static) variables. Sharing the virtual machine has the advantage of lower loading times. Private virtual machines are only required for backwards compatibility and special cases where each script requires its own set of global variables. When unsure turn this option off.
Resource Files Tab
An optional list of files (typically sound files) that are accessed by the script. This list is used by the package manager to help detect what resource files are used by the script, so that they can be added to a package automatically.
Note that the package manager is smart enough to automatically detect resource files from constant strings used inside the scripts. When scripts do not use any resource files or when only constant strings are used as paths to resource files, the resource file list can be left empty.