import{_ as t,a,b as n,ag as i}from"./chunks/framework.BcrMLAmg.js";const c=JSON.parse('{"title":"Lua Annotations Guide","description":"","frontmatter":{},"headers":[],"relativePath":"guides/annotations.md","filePath":"guides/annotations.md","lastUpdated":1739870373000}'),o={name:"guides/annotations.md"};function l(r,e,s,d,u,p){return n(),a("div",null,e[0]||(e[0]=[i('Lua Annotations Guide
Writing Lua code for CC: Tweaked and Basalt becomes much more enjoyable with proper type annotations. They provide code completion, type checking, and inline documentation.
Setting Up Annotations
CC: Tweaked Annotations
Download the official CC: Tweaked type definitions from: CC: Tweaked Annotations
The GitHub page includes a detailed installation guide that will help you set up everything correctly.
Basalt Annotations
The Basalt Dev version includes built-in type definitions that provide:
- Complete type information for all Basalt elements
- Method parameter hints
- Return type information
- Event type definitions
To get started, simply download the Dev version of Basalt.
IDE Configuration
Required Extensions
For the best development experience, you'll need:
- A Lua Language Server
- An IDE with Lua support
For Visual Studio Code users:
- Install Summeko Lua
- The extension provides full language server capabilities
Benefits
With properly configured annotations, you get:
- ✓ Intelligent code completion
- ✓ Real-time type checking
- ✓ Documentation on hover
- ✓ Method signature help
- ✓ Better error detection
',19)]))}const m=t(o,[["render",l]]);export{c as __pageData,m as default};