RestartRoute

Calling this method resets the object position to the given waypoint index. Usually, this is used to reset the object position to the beginning of the route (index = 0).

 

JavaScript
RestartRoute(       Index = 0)

 

C#
void RestartRoute(       int Index = 0)

 

C++
HRESULT RestartRoute(       long Index)

Parameters

Index

A zero based index of the waypoint at which the object should restart.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.