> For the complete documentation index, see [llms.txt](https://docs.overdare.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.overdare.com/development/api-reference/enums/ballstate.md).

# BallState

## Overview

BallState is an Enum that represents the current state of a SimulationBall.

It is used in the **BallState** property of SimulationBall to control and check the playback state of the ball simulation. It manages states such as playing, paused, and stopped after the simulation is complete.

## Items

| Name    | Value | Description                                                                                                                             |
| ------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Stopped | 0     | The simulation is stopped. Calling the `Stop()` method transitions to this state, and the playback time is reset to 0.                  |
| Paused  | 1     | The simulation is paused. Calling the `Pause()` method transitions to this state, pausing playback while maintaining the playback time. |
| Playing | 2     | The simulation is currently playing. Calling the `Play()` method transitions to this state, and the ball starts moving.                 |

## Options

| Name      | Value | Description                                                                                                                             |
| --------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Simulated | 0     | The simulation is complete and ready for playback. This state is reached after calling the `Simulate()` method.                         |
| Playing   | 1     | The simulation is currently playing. Calling the `Play()` method transitions to this state, and the ball starts moving.                 |
| Stopped   | 2     | The simulation is stopped. Calling the `Stop()` method transitions to this state, and the playback time is reset to 0.                  |
| Paused    | 3     | The simulation is paused. Calling the `Pause()` method transitions to this state, pausing playback while maintaining the playback time. |

## See also

{% content-ref url="/pages/ZaoG57umzS7C4yIBXybF" %}
[SimulationBall](/development/api-reference/classes/simulationball.md)
{% endcontent-ref %}