yolkbot
    Preparing search index...

    Interface ActivePath

    A planned route, and how far along it the bot is

    interface ActivePath {
        cursor: number;
        destination: Position;
        follow: boolean;
        nodes: PathNode[];
        partial: boolean;
        reach: number;
    }
    Index

    Properties

    cursor: number

    Which node the bot is heading for

    destination: Position

    Where the route was asked to end up

    follow: boolean

    Whether the route re-plans when the destination moves

    nodes: PathNode[]

    The nodes to travel through, in order

    partial: boolean

    Whether the route only gets as close as the map allows, because the destination is unreachable

    reach: number

    How close counts as arrived