Reference

Complete, lookup-oriented documentation. If you’re learning, start with Getting started or the tutorials; come here when you need the exact signature, field, or shape.

• API reference
  • Modules
  • Core
  • Headless API
  • Plans & geometry
  • Materials
  • Placement & validation
  • Rooms & auto-systems
  • Presets, config & UI
• Structure definition
  • Identity
  • Build mode
  • Disassembly
  • Material
  • Validation
  • Sprites & geometry
  • UI & flags
  • Worked example A - minimal (raw inventory, generic builder)
  • Worked example B - heavily customized (MilitaryTents-style)
  • Registration is validated
• Data contracts
  • Stability policy
  • Plan (RCSFPlan) - stable
  • Piece (RCSFPiece) - stable
  • Planned-construction record (RCSFPlannedRecord) - stable
  • Builder outcomes - stable
  • Room assignment + event payloads - stable
• Events
  • Subscribing
  • Firing side / authority
  • The events
  • RCSF.Events
• Roadmap
  • Delivered
  • Proposed next

Quick map

• API reference - every public module and function, grouped by feature area, with a signature block for each.

• Structure definition - every field and callback of the table you pass to registerStructure.

• Data contracts - the plan, piece, and record table shapes you read and serialize.

• Events - the four OnRCSF* Lua events and their payloads.

• Roadmap - what’s delivered and what’s proposed next.

Tip

Every public module ships full EmmyLua annotations, and the data structures are declared as @class types in Contracts.lua. A LuaLS-aware editor autocompletes the whole API.