Struct screeps::objects::MoveToOptions

pub struct MoveToOptions<'a, F>where
    F: FnMut(RoomName, CostMatrix<'a>) -> SingleRoomCostResult<'a>,{ /* private fields */ }

Implementations

impl MoveToOptions<'static, fn(_: RoomName, _: CostMatrix<'static>) -> SingleRoomCostResult<'static>>

pub fn new() -> Self

Creates default SearchOptions

impl<'a, F> MoveToOptions<'a, F>where
    F: FnMut(RoomName, CostMatrix<'a>) -> SingleRoomCostResult<'a>,

pub fn reuse_path(self, n_ticks: u32) -> Self

Enables caching of the calculated path. Default: 5 ticks

pub fn serialize_memory(self, serialize: bool) -> Self

Whether to use the short serialized form. Default: True

pub fn no_path_finding(self, no_finding: bool) -> Self

Return an ERR_NOT_FOUND if no path is already cached. Default: False

pub fn visualize_path_style(self, style: PolyStyle) -> Self

Sets the style to trace the path used by this creep. See doc for default.

pub fn ignore_creeps(self, ignore: bool) -> Self

Sets whether the algorithm considers creeps as walkable. Default: False.

pub fn ignore_destructible_structures(self, ignore: bool) -> Self

Sets whether the algorithm considers destructible structure as walkable. Default: False.

pub fn cost_callback<'b, F2>(self, cost_callback: F2) -> MoveToOptions<'b, F2>where
    F2: FnMut(RoomName, CostMatrix<'b>) -> SingleRoomCostResult<'b>,

Sets cost callback - default |_, _| {}.

pub fn max_ops(self, ops: u32) -> Self

Sets maximum ops - default 2000.

pub fn heuristic_weight(self, weight: f64) -> Self

Sets heuristic weight - default 1.2.

pub fn serialize(self, s: bool) -> Self

Sets whether the returned path should be passed to Room.serializePath.

pub fn max_rooms(self, rooms: u32) -> Self

Sets maximum rooms - default 16, max 16.

pub fn range(self, k: u32) -> Self

pub fn plain_cost(self, cost: u8) -> Self

Sets plain cost - default 1.

pub fn swamp_cost(self, cost: u8) -> Self

Sets swamp cost - default 5.

pub fn find_options<'b, F2>(
    self,
    find_options: FindOptions<'b, F2, SingleRoomCostResult<'b>>
) -> MoveToOptions<'b, F2>where
    F2: FnMut(RoomName, CostMatrix<'b>) -> SingleRoomCostResult<'b>,

Sets options related to FindOptions. Defaults to FindOptions default.

Trait Implementations

impl Default for MoveToOptions<'static, fn(_: RoomName, _: CostMatrix<'static>) -> SingleRoomCostResult<'static>>

fn default() -> Self

Returns the “default value” for a type.