API Reference
The API reference is the index for every API-*.md page in the RBXStateMachine wiki. Use it when you know the subsystem you need, but not yet which dedicated page to open.
Tip
For setup and conceptual walkthroughs, start with Getting Started, Quick Start, or Architecture. For terminology, use Glossary.
| If you need to... | Start here |
|---|---|
| Bootstrap the framework and create runtime objects | API: Orchestrator |
| Understand how classes are compiled and registered | API: Factory |
| Author states, transitions, and timers | API: BaseStateMachine |
| Build schema-backed data models | API: BaseEntity |
| Schedule work under a frame budget | API: Scheduler |
| Debug live state in the dashboard | API: ServiceManager |
| Work with persistence and DataStores | API: EntityPersistence, API: DataStoreHandler |
| Page | What it covers |
|---|---|
| API: Orchestrator | Runtime bootstrap, object creation, lookup, cancellation, networking wrappers, and ServiceManager launch hooks. |
| API: Factory | Module compilation, class lookup, registry ownership, and entity/FSM creation or reuse. |
| API: BaseStateMachine | State registration, transitions, lifecycle signals, hierarchical FSMs, WaitSpan, ScheduleTransition, and Timeout. |
| API: BaseEntity | Schema validation, staged updates, locking, serialization, replication, and cleanup. |
| API: Scheduler | Frame-budgeted task execution, priority handling, task lifecycle, metrics, and heartbeat integration. |
| Page | What it covers |
|---|---|
| API: BehaviorTree | Functional behavior-tree nodes such as Selector, Sequence, Condition, and SetState. |
| API: Signal | Lightweight event primitive used throughout the framework for connections, one-shots, and waits. |
| API: NetworkManager | Remotes, request/response plumbing, entity commands, event-bus telemetry, and structured remote activity. |
| API: ServiceManager | Dashboard boot flow, subsystem layout, snapshot model, drill-downs, and client/server inspection behavior. |
| API: Logger | Structured logging, history buffers, level filtering, and component-scoped loggers. |
| Page | What it covers |
|---|---|
| API: EntityPersistence | Entity save/load envelopes, persistence manager behavior, and DataStore integration patterns. |
| API: DataStoreHandler | Safe DataStore wrapper with throttling, caching, retry, and wrapper-level configuration. |
| API: ActorPool | Round-robin Actor workers for CPU-bound parallel jobs that stay out of the main thread. |
| API: Settings | Runtime tuning knobs for logging, scheduling, replication, persistence, and other core subsystems. |
| API: Types | Public type contracts for strict Luau modules and framework-aware annotations. |
This index links every API page currently shipped in the wiki:
API-ActorPoolAPI-BaseEntityAPI-BaseStateMachineAPI-BehaviorTreeAPI-DataStoreHandlerAPI-EntityPersistenceAPI-FactoryAPI-LoggerAPI-NetworkManagerAPI-OrchestratorAPI-SchedulerAPI-ServiceManagerAPI-SettingsAPI-SignalAPI-Types
With this page included, the API section contains 16 total API-*.md pages.
- Architecture — subsystem relationships and bootstrap order
- Replication Pipeline — entity sync flow and snapshots
- Hierarchical FSM — nested state-machine patterns
- Performance Tuning — frame budgets, actor pools, and scheduling strategy
- Versioning — persistence envelopes and migration strategy
- Glossary — definitions for framework terms used across the API docs