Struct PathfinderOpts 

#[non_exhaustive]
pub struct PathfinderOpts { /* private fields */ }

Configuration options that the pathfinder will use when calculating and executing a path.

This can be passed into Client::goto_with_opts or Client::start_goto_with_opts.

// example config to disallow mining blocks and to not do parkour
let opts = PathfinderOpts::new()
    .allow_mining(false)
    .successors_fn(moves::basic::basic_move);

Implementations

impl PathfinderOpts

pub const fn new() -> Self

pub fn successors_fn(self, successors_fn: SuccessorsFn) -> Self

Set the function that’s used for checking what moves are possible.

Defaults to moves::default_move.

pub fn allow_mining(self, allow_mining: bool) -> Self

Set whether the bot is allowed to break blocks while pathfinding.

Defaults to true.

pub fn retry_on_no_path(self, retry_on_no_path: bool) -> Self

Whether we should recalculate the path when the pathfinder timed out and there’s no partial path to try.

Defaults to true.

pub fn min_timeout(self, min_timeout: PathfinderTimeout) -> Self

The minimum amount of time that should pass before the A* pathfinder function can return a timeout if it finds a path that seems good enough. It may take up to Self::max_timeout if it can’t immediately find a usable path.

Defaults to PathfinderTimeout::Time(Duration::from_secs(1)).

Also see PathfinderTimeout::Nodes

pub fn max_timeout(self, max_timeout: PathfinderTimeout) -> Self

The absolute maximum amount of time that the pathfinder function can take to find a path. If it takes this long, it means no usable path was found (so it might be impossible).

Defaults to PathfinderTimeout::Time(Duration::from_secs(5)).

Trait Implementations

impl Clone for PathfinderOpts

fn clone(&self) -> PathfinderOpts

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PathfinderOpts

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PathfinderOpts

fn default() -> Self

Returns the “default value” for a type.