Welcome to the GearBlocks Lua scripting API documentation.

This only covers the API itself, for general information on Lua scripting for GearBlocks, please refer to: Lua Scripting Guide

For step-by-step guides on making script mods and scenarios, please refer to:

• Script Mods: How to Use and Create Them
• Scenarios: How to Create Them

More Information

A tutorial on the Lua language itself is beyond the scope of this documentation, there are many resources online for this.

It is worth mentioning though that GearBlocks uses MoonSharp for its Lua integration, which has some slight differences and additions compared to "standard" Lua. More information can be found at Differences vs Lua and Additions vs Lua.

To learn more about Lua scripting for GearBlocks, the included script mods and scenarios are a good reference, you'll find them here (or equivalent paths for your installation):-

• Script mods: *C:\Program Files (x86)\Steam\steamapps\common\GearBlocks\GearBlocks_Data\StreamingAssets\ScriptMods*
• Scenarios: *C:\Program Files (x86)\Steam\steamapps\common\GearBlocks\GearBlocks_Data\StreamingAssets\Scenes*