Regular API function

simGetBoolParameter / sim.getBoolParameter

Description Retrieves a boolean value. See the Boolean parameter identifiers. See also sim.setBoolParameter, sim.getInt32Parameter, sim.getFloatParameter, sim.getArrayParameter and sim.getStringParameter.
C synopsis simInt simGetBoolParameter(simInt parameter)
C parameters
C return value
value of the parameter (0 or 1) or -1 in case of an error
Lua synopsis boolean boolState=sim.getBoolParameter(number parameter)
Lua parameters
Similar to the C-function counterpart
Lua return values
boolState: value of the Boolean parameter
Remote API equiv.
B0-based remote API: simxGetBoolParameter
Legacy remote API: simxGetBooleanParameter

All regular API functions on one page