Regular API function

simPerformPathSearchStep (DEPRECATED)

Description DEPRECATED. See the OMPL library based path/motion planning functionality instead.

Performs a path search in several sub-steps. simInitializePathSearch has to be called previously. Call this function in a loop until the return value is different from -2. When operating from a threaded child script, rather use the simSearchPath function
C synopsis simInt simPerformPathSearchStep(simInt temporaryPathSearchObject,simBool abortSearch)
C parameters
temporaryPathSearchObject: handle of a temporary path search object (returned by simInitializePathSearch)
abortSearch: 0 to continue the search, any other value to abort
C return value
-2 if nothing was found but search can continue (by calling this function again), -1 in case of an error, 0 if no path was found, 1 if a partial path was found, and 2 if a full path was found. Unless the return value is -2, the temporary path search object will be destroyed
Lua synopsis number result=simPerformPathSearchStep(number temporaryPathSearchObjectHandle,boolean abortSearch)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page