Regular API function

simGetFloatParameter / sim.getFloatParameter (remote API equivalent: simxGetFloatingParameter)

Description Retrieves a floating point value. See the floating-point parameter identifiers. See also sim.setFloatParameter, sim.getBoolParameter, sim.getInt32Parameter, sim.getArrayParameter and sim.getStringParameter.
C synopsis simInt simGetFloatParameter(simInt parameter,simFloat* floatState)
C parameters
floatState: value of the parameter
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number parameterValue=sim.getFloatParameter(number parameter)
Lua parameters
parameter: parameter identifier (sim_floatparam_...)
Lua return values
parameterValue: value of the parameter or nil in case of an error

All regular API functions on one page