Regular API function

simPauseSimulation / sim.pauseSimulation

Description Requests a pause of a simulation. See also sim.startSimulation, sim.stopSimulation and sim.getSimulationState. See also the simulation state diagram.
C/C++
synopsis
simInt simPauseSimulation()
C/C++
parameters
C/C++
return value
-1 in case of an error, 0 if the operation could not be performed. >0 in case of success.
Lua synopsis int result=sim.pauseSimulation()
Lua parameters
Similar to the C-function counterpart
Lua return values
Similar to the C-function counterpart
Python synopsis int result=sim.pauseSimulation()