OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
navigation.route_simulation_if.RouteSimulationIf Class Reference

Allow a navigation input source to follow an already-calculated route. More...

Inherits Protocol.

Public Member Functions

None follow_route (self, RouteResult route, *float time_scale=60.0)
 Begin following route at an accelerated simulation rate.
 
None stop_route (self)
 Stop route following and return to the source's normal simulation.
 

Detailed Description

Allow a navigation input source to follow an already-calculated route.

Member Function Documentation

◆ follow_route()

None navigation.route_simulation_if.RouteSimulationIf.follow_route (   self,
RouteResult  route,
*float   time_scale = 60.0 
)

Begin following route at an accelerated simulation rate.

Parameters
routeCalculated route to traverse.
time_scaleSimulation speed multiplier relative to real time.

The documentation for this class was generated from the following file: