Regular API function

simGetFloatParameter
remote API equivalent: simxGetFloatingParameter
RosPlugin API equivalent: simRosGetFloatingParameter

Description Retrieves a floating point value. See the floating-point parameter identifiers. See also simSetFloatParameter, simGetBoolParameter, simGetInt32Parameter, simGetArrayParameter and simGetStringParameter.
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=simGetFloatParameter(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