Scripting
Luau guides and API reference for Asterune scripts.
Asterune scripts use Luau to read and modify instances in a place. The API reference lists classes, data types, enums, and globals from the engine API snapshot.
Getting started
Your first script covers instances, properties, and events.
Guides
| Guide | Topics |
|---|---|
| Working with instances | Creation, lookup, parenting, and destruction |
| Responding to events | Connections, one-time handlers, and contact events |
| Building with parts | Shape, material, collision, and constraints |
| Moving things | Position, rotation, tweens, and velocity |
| Players and characters | Player lifecycle, health, respawn, and teams |
| Server and client | Execution context, replication, and remote calls |
| Reacting to players | Clicks, prompts, input bindings, and seats |
| On-screen interfaces | ScreenGui, layout, text, and buttons |
| Light, sound and effects | Lighting, audio, particles, and explosions |
| Timing and loops | Scheduling, elapsed time, and frame updates |
| Sharing code with modules | ModuleScript, require, and module state |
| Component definitions | Schemas, fields, handles, queries, persistence, and validation |
| Systems and scheduling | Phases, dependencies, intervals, and parallel execution |
| Errors and debugging | Error handling and troubleshooting |
API reference
- Classes: instance properties, methods, events, and callbacks.
- Data types: constructors, fields, and value operations.
- Enums: named options and numeric values.
- Globals: names supplied by the engine.
- Parameter and result types: option tables, result records, and type aliases.
Luau standard-library functions such as print, pcall, math, string, and
table are documented at luau.org.
Reference page structure
Class pages show construction or service access, inheritance, and replication metadata before the member tables. Detailed member sections follow the tables. Inherited members link to their defining classes. Related APIs and examples appear below the member documentation.
Signatures, defaults, access restrictions, and thread-safety metadata come from the API snapshot. Named constants whose meanings are fully specified by their names and values use the generated enum tables.