Regular API function

simGetPathPosition

Description Retrieves the intrinsic position of a path object (a distance along the path). The position is given in meters, but the actual returned position is dependent on the selected path length calculation method for the given path object. See also simSetPathPosition, simGetPathLength, simGetPositionOnPath and simGetClosestPositionOnPath.
C synopsis simInt simGetPathPosition(simInt objectHandle,simFloat* position)
C parameters
objectHandle: handle of the path object
position: linear position on the path given in meters (but dependent on the selected path length calculation method)
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number position=simGetPathPosition(number objectHandle)
Lua parameters
objectHandle: handle of the path object
Lua return values
position: linear position on the path given in meters (but dependent on the selected path length calculation method), or nil in case of an error

All regular API functions on one page