Stormworks Addon Lua Documentation

📚 Overview

A simple repo containing the Stormworks Addon Lua documentation.

For intellisense (auto-completion, etc) with Visual Studio Code and the Lua extension, /docs/intellisense.lua is what you're looking for.

❔ How To Use

• Install the VSCode Lua extension (or your IDE's equivalent).
• Download and copy /docs/intellisense.lua into your workspace.
• Open the workspace with your IDE (e.g. VSCode), and every single function, callback, type, etc., should all be annotated and recognised by your IDE (see below).

💡 Purpose

• Provides intellisense support for the Stormworks Addon Lua API
• No more having to constantly look at external documentation while coding (for the most part!)
• Allows your IDE to detect any type errors (e.g. passing a string to a function that expects a number)
• Provides auto-completion for all functions, types, callbacks, etc
• Makes it easier to discover available functions and types as you code

🤝 Other Documentation

• Component Mod Lua
• Microcontroller Lua

👨‍🦱 Credit

• Cuh4 - Maintainer
• NameousChangey & Toastery - Original Creators of /docs/intellisense.lua