Regular API function

simResetDistance / sim.resetDistance

Description Clears the distance state, the distance segment, etc. for a registered distance object. See also sim.handleDistance.
C synopsis simInt simResetDistance(simInt distanceObjectHandle)
C parameters
distanceObjectHandle: handle of the distance object or sim_handle_all or sim_handle_all_except_explicit. (sim_handle_all will reset all registered distance objects, while sim_handle_all_except_explicit will only reset those that are not marked as "explicit handling")
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number result=sim.resetDistance(number distanceObjectHandle)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page