|
1 | 1 | # Simulation states used in SetSimulationState and returned in GetSimulationState
|
2 | 2 |
|
3 |
| -uint8 STATE_STOPPED = 0 # Simulation is stopped, which is equivalent to pausing and resetting with ALL. |
4 |
| - # This is typically the default state when simulator is launched. |
5 |
| - # Stopped simulation can be played. It can also be paused, which means |
6 |
| - # starting simulation in a paused state immediately, |
7 |
| - # without any time steps for physics or simulated clock ticks. |
8 |
| -uint8 STATE_PLAYING = 1 # Simulation is playing, can be either paused or stopped. |
9 |
| -uint8 STATE_PAUSED = 2 # Simulation is paused, can be either stopped (which will reset it) or played. |
10 |
| -uint8 STATE_QUITTING = 3 # Closing the simulator application. Switching from STATE_PLAYING or STATE_PAUSED |
11 |
| - # states is expected to stop the simulation first, and then exit. |
12 |
| - # Simulation interfaces will become unavailable after quitting. |
13 |
| - # Running simulation application is outside of the simulation interfaces as |
14 |
| - # there is no service to handle the call when the simulator is not up. |
| 3 | +uint8 STATE_STOPPED = 0 # Simulation is stopped, which is equivalent to pausing and resetting with ALL_PAUSED. |
| 4 | + # This is typically the default state when simulator is launched. |
| 5 | + # Stopped simulation can be played. It can also be paused, which means |
| 6 | + # starting simulation in a paused state immediately, |
| 7 | + # without any time steps for physics or simulated clock ticks. |
15 | 8 |
|
16 |
| -uint8 STATE_NO_WORLD = 4 # Simulation world is currently unloaded, and/or a new world has not finished loading yet. |
17 |
| - # The simulation is inactive and cannot be started, stopped, or paused. |
| 9 | +uint8 STATE_PLAYING = 1 # Simulation is playing, can be either paused or stopped. |
| 10 | + |
| 11 | +uint8 STATE_PAUSED = 2 # Simulation is paused, can be either stopped (which will reset it) or played. |
| 12 | + |
| 13 | +uint8 STATE_QUITTING = 3 # Closing the simulator application. Switching from STATE_PLAYING or STATE_PAUSED |
| 14 | + # states is expected to stop the simulation first, and then exit. |
| 15 | + # Simulation interfaces will become unavailable after quitting. |
| 16 | + # Running simulation application is outside of the simulation interfaces as |
| 17 | + # there is no service to handle the call when the simulator is not up. |
| 18 | + |
| 19 | +uint8 STATE_NO_WORLD = 4 # Simulation world is currently unloaded. |
| 20 | + # The simulation is inactive and cannot be started, stopped, or paused. |
| 21 | + |
| 22 | +uint8 STATE_LOADING_WORLD = 5 # Simulation world is currently loading. |
| 23 | + # The simulation is inactive while world is loading and cannot be started, stopped, or paused. |
18 | 24 | uint8 state
|
0 commit comments