pyrobosim.core.robot.Robot.follow_path

Robot.follow_path(path, target_location=None, realtime_factor=1.0, use_thread=True, blocking=False)

Follows a specified path using the attached path executor.

Parameters:

  • path (pyrobosim.utils.motion.Path) – The path to follow.

  • target_location (Entity.) – The target location at the intended goal, used for tracking robot state.

  • realtime_factor (float) – A real-time multiplier on execution speed, defaults to 1.0.

  • use_thread (bool) – If True, spawns a new thread to execute the path.

  • blocking – If path executes in a new thread, set to True to block and wait for the thread to complete before returning.

Returns:

True if path following is successful, or the path following thread is successfully started.

Return type:

bool