Scripting system

The Scripting system allows the user to perform very specific and advanced tasks that the program doesn't provide by default.

All project functions and some interface widgets are scriptable using Lua 5.1. See Classes and functions for more details.

The system contains 4 types of scripts:

Common

Stored in the common folder, is used to provide helper functions to other scripts.

Project template

Stored in the projects folder, this type of script is used to initialize a new project (Project -> New).

You must call any of the Project creation funcions:

FF.emptyProject(engineName, projectType)

FF.projectFromFile(fileName, asCopy)

This is the simpliest template that leaves the new project empty. The return value determines if the new project will be accepted as is or discarded.

The return value must be a Project class.

Code snippet

Tool