Search documentation of bb

# BB.Dsl.State (bb v0.17.0)

Copy Markdown View Source

A custom operational state for the robot.

States define the operational context the robot can be in (beyond the built-in `:idle`). Commands specify which states they can run in via `allowed_states`, and can transition the robot to new states via `next_state:` in their result.

The `:idle` state is always implicitly available and is the default initial state.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %BB.Dsl.State{
      __identifier__: any(),
      __spark_metadata__: Spark.Dsl.Entity.spark_meta(),
      doc: String.t() | nil,
      name: atom()
    }