Interface PathPlan

A path the bot has just planned, emitted as BotEvents.pathPlan

interface PathPlan {
    from: Position;
    legs: LinkKind[];
    partial: boolean;
    reason: PathReason;
    to: Position;
    waypoints: Position[];
}

Index

Properties

from legs partial reason to waypoints

Properties

from

Where the bot was when it planned

legs

legs: LinkKind[]

How each leg has to be travelled; one shorter than the waypoints

partial

partial: boolean

Whether the destination is unreachable and this only gets as close as it can

reason

reason: PathReason

Why it planned

to

Where it is trying to get to

waypoints

waypoints: Position[]

Every waypoint, in order