Struct GotoEvent

#[non_exhaustive]
pub struct GotoEvent {
    pub entity: Entity,
    pub goal: Arc<dyn Goal>,
    pub successors_fn: SuccessorsFn,
    pub allow_mining: bool,
    pub retry_on_no_path: bool,
    pub min_timeout: PathfinderTimeout,
    pub max_timeout: PathfinderTimeout,
}

Send this event to start pathfinding to the given goal.

Also see [PathfinderClientExt::goto].

This event is read by [goto_listener].

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entity: Entity

The local bot entity that will do the pathfinding and execute the path.

goal: Arc<dyn Goal>

successors_fn: SuccessorsFn

The function that’s used for checking what moves are possible. Usually moves::default_move.

allow_mining: bool

Whether the bot is allowed to break blocks while pathfinding.

retry_on_no_path: bool

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

Should usually be set to true.

min_timeout: PathfinderTimeout

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

A good default value for this is PathfinderTimeout::Time(Duration::from_secs(1)).

Also see PathfinderTimeout::Nodes

max_timeout: PathfinderTimeout

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).

A good default value for this is PathfinderTimeout::Time(Duration::from_secs(5)).

Implementations

impl GotoEvent

pub fn new(entity: Entity, goal: impl Goal + 'static) -> Self

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

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

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

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

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

Trait Implementations

impl Event for GotoEvent

where Self: Send + Sync + 'static,

const AUTO_PROPAGATE: bool = false

When true, this event will always attempt to propagate when triggered, without requiring a call to Trigger::propagate.

type Traversal = ()

The component that describes which Entity to propagate this event to next, when propagation is enabled.

fn register_component_id(world: &mut World) -> ComponentId

Generates the [ComponentId] for this event type.

fn component_id(world: &World) -> Option<ComponentId>

Fetches the [ComponentId] for this event type, if it has already been generated.