Regular API function

simReadDistance / sim.readDistance

Description Deprecated. See sim.checkDistance instead.
C/C++
synopsis
int simReadDistance(int distanceObjectHandle,double* smallestDistance)
C/C++
parameters
distanceObjectHandle: handle of the distance object
smallestDistance: smallest distance (valid only if return value is different from -1)
C/C++
return value
different from -1 if distance was read, -1 in case of an error.
Lua
synopsis
int result,float smallestDistance=sim.readDistance(int distanceObjectHandle)
Lua
parameters
Similar to the C-function counterpart
Lua
return values
result: 1 if distance was read, and 0 if sim.handleDistance was never called, or if sim.resetDistance was previously called.
smallestDistance: the smallest distance. Is nil if result is not 1