Regular API function

simGetEngineFloatParam / sim.getEngineFloatParam

Description Retrieves a float value from the physics engine properties. See also the other engine properties setter and getter API functions.
C/C++
synopsis
simFloat simGetEngineFloatParam(simInt paramId,simInt objectHandle,const simVoid* object,simBool* ok)
C/C++
parameters
objectHandle: the handle of the shape or joint, or -1 to retrieve a global engine parameter. If -1, then the object argument will be evaluated.
object: a pointer to a shape or joint objects, or nullptr to retrieve a global engine parameter. If nullptr, then the objectHandle argument will be evaluated.
ok: an optional pointer to a value that can be used to determine the success of the API call. Can be nullptr.
C/C++
return value
value of the requested parameter.
Lua
synopsis
float floatParam=sim.getEngineFloatParam(int paramId,int objectHandle)
Lua
parameters
Similar to the C-function counterpart
Lua
return values
Similar to the C-function counterpart
Python
synopsis
float floatParam=sim.getEngineFloatParam(int paramId,int objectHandle)