Share

Applies to 2025.0 Update and later

 
 

Lua script library reference

Dialog functions and switches explained

Jump to:

Access

Open the Lua script library from the main menu via Home > Prepare > Run script > Run Lua script.

Note: The library dialog and any of its subordinate dialogs like the editor or debugger are blocking focus, preventing interaction with their respective parent windows while they are open, including the main Netfabb window. To keep the view clear as needed, move a dialog out of the away before proceeding.
Top

Scripts list

Name

Name used when the script is selected for quick access

Technically optional but recommended to be non-empty

Description

Space to hold a comment on the respective script

Optional

Type

Default or Custom; Default scripts are those that come already loaded in the library and cannot be modified or deleted, Custom scripts are all others.

Quick access

Scripts set to Yes here are listed in the main menu so that they can be run via Home > Prepare > Run script > Quick access.

This also makes them available for adding them to a custom menu.

Restriction: The availability of Lua scripts enabled for quick access is only a reference. Any scripts added to a custom menu must also remain enabled for quick access, and in the original order, otherwise different scripts or none at all appear in place of the scripts originally added to a custom menu.
Tip: Click the column headers to alphabetically sort the list of scripts by the contents of the respective column.
Top

Scripts list context menu

Right-click any row in the Scripts list to access its context menu.

Save as

Prompts to save the selected script to a file

Set for shortcut

Marks the script as the one to run when using the Execute Lua script shortcut (Shift+L by default)

No visual indicator, cannot be unset, only changed to a different script

Edit

Opens an editor dialog if the selected script is of Custom type, otherwise prompts to create an editable duplicate

Duplicate

Creates an editable duplicate of the selected script

Remove

Deletes the script

Unavailable for Default-type scripts

Remove from quick access

Removes the script from the main menu

Available for scripts currently marked with Yes

Add to quick access

Adds the script to the main menu

Clear quick access settings

Clears the Yes marking for any and all scripts, removing them from the main menu

Run debugger

Runs the script in a debugger window with step controls, display of objects and variables, and other helpful tools to observe the execution of the script

Top

Dialog buttons

New script

Opens an empty editor dialog

Edit script

Opens the editor dialog on the selected script

Delete script

Prompts to delete the selected script

Execute script

Closes the Lua script library and runs the script

Leave the dialog with the Close button in the top-right corner.

Top
Parent topic: About Lua in Netfabb

Was this information helpful?