Regular API function
simGetSimulationState / sim.getSimulationState
Description
Retrieves current
simulation state
. See also the
simulation state diagram
.
C/C++
synopsis
simInt simGetSimulationState()
C/C++
parameters
C/C++
return value
The current state of the simulation (sim.simulation_stopped, sim.simulation_paused, etc. (see the
simulation state values
)), or -1 in case of an error
Lua
synopsis
int simulationState=sim.getSimulationState()
Lua
parameters
Similar to the C-function counterpart
Lua
return values
Similar to the C-function counterpart
Python
synopsis
int simulationState=sim.getSimulationState()
