Skip to content

Reference

This section contains the technical reference for the NUClear framework. Use it to look up specific APIs, DSL words, emit scopes, and extension points.

Sections

  • API — Core classes: PowerPlant, Reactor, Configuration, ReactionHandle
  • DSL Words — All 24 DSL words for building reactions
  • Emit Scopes — The 7 emit scopes controlling data distribution
  • Extension System — How to extend the DSL with custom words

Looking for a tutorial instead?

If you're new to NUClear, start with the [Tutorials](../tutorials/index.md) section.

For task-oriented guidance, see the How-to Guides.