Navigation · interface

NavPathOptions

Explained in Navigation.

interface NavPathOptions
import type { NavPathOptions } from '@driftengine/nav';

Properties

NameTypeDescription
lookaheadMreadonlyoptionalnumberHow far ahead along the path to aim, metres.
More

The one number that decides whether following looks like driving or like a wind-up toy. Short and the agent snaps at each waypoint in turn; long and it cuts corners so hard it leaves the road. A useful value is a little more than the agent's turning radius, and the default of two metres suits somebody walking.

arriveMreadonlyoptionalnumberWithin this of the last node, the agent has arrived. Default half a metre.