Regular API function


Description Retrieves a float value from the physics engine properties. See also the other engine properties setter and getter API functions.
C synopsis simFloat simGetEngineFloatParameter(simInt paramId,simInt objectHandle,const simVoid* object,simBool* ok)
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 NULL to retrieve a global engine parameter. If NULL, 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 NULL.
C return value
value of the requested parameter. This function call doesn't generate any error message.
Lua synopsis number floatParam=simGetEngineFloatParameter(number paramId,number objectHandle)
Lua parameters
Similar as C-function
Lua return values
Same as C-function

All regular API functions on one page