# 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 %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.overdare.com/development/api-reference/enums/ballstate.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.