Struct screeps::pathfinder::JsSearchOptions
source · pub struct JsSearchOptions { /* private fields */ }
Expand description
Object that represents a set of options for a call to
[PathFinder::search
].
Implementations§
source§impl JsSearchOptions
impl JsSearchOptions
sourcepub fn room_callback(&self, callback: &Closure<dyn FnMut(JsString) -> JsValue>)
pub fn room_callback(&self, callback: &Closure<dyn FnMut(JsString) -> JsValue>)
Room callback, which should return a CostMatrix
, or
JsValue::FALSE
to avoid pathing through a room.
source§impl JsSearchOptions
impl JsSearchOptions
sourcepub fn plain_cost(&self, cost: u8)
pub fn plain_cost(&self, cost: u8)
Set the cost of moving on plains tiles during this pathfinder search. Defaults to 1.
source§impl JsSearchOptions
impl JsSearchOptions
sourcepub fn swamp_cost(&self, cost: u8)
pub fn swamp_cost(&self, cost: u8)
Set the cost of moving on swamp tiles during this pathfinder search. Defaults to 5.
source§impl JsSearchOptions
impl JsSearchOptions
sourcepub fn heuristic_weight(&self, weight: f64)
pub fn heuristic_weight(&self, weight: f64)
Heuristic weight to use for the A* algorithm to be guided toward the goal. Defaults to 1.2.
source§impl JsSearchOptions
impl JsSearchOptions
pub fn new() -> JsSearchOptions
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue = _
pub const UNDEFINED: JsValue = _
pub const TRUE: JsValue = _
pub const FALSE: JsValue = _
sourcepub fn as_f64(&self) -> Option<f64>
pub fn as_f64(&self) -> Option<f64>
Returns the f64
value of this JS value if it’s an instance of a
number.
If this JS value is not an instance of a number then this returns
None
.
sourcepub fn as_string(&self) -> Option<String>
Available on crate feature std
only.
pub fn as_string(&self) -> Option<String>
std
only.If this JS value is a string value, this function copies the JS string
value into wasm linear memory, encoded as UTF-8, and returns it as a
Rust String
.
To avoid the copying and re-encoding, consider the
JsString::try_from()
function from js-sys
instead.
If this JS value is not an instance of a string or if it’s not valid
utf-8 then this returns None
.
UTF-16 vs UTF-8
JavaScript strings in general are encoded as UTF-16, but Rust strings
are encoded as UTF-8. This can cause the Rust string to look a bit
different than the JS string sometimes. For more details see the
documentation about the str
type which contains a few
caveats about the encodings.
sourcepub fn as_bool(&self) -> Option<bool>
pub fn as_bool(&self) -> Option<bool>
Returns the bool
value of this JS value if it’s an instance of a
boolean.
If this JS value is not an instance of a boolean then this returns
None
.
sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
source§impl AsRef<JsSearchOptions> for JsSearchOptions
impl AsRef<JsSearchOptions> for JsSearchOptions
source§fn as_ref(&self) -> &JsSearchOptions
fn as_ref(&self) -> &JsSearchOptions
source§impl AsRef<JsValue> for JsSearchOptions
impl AsRef<JsValue> for JsSearchOptions
source§impl Default for JsSearchOptions
impl Default for JsSearchOptions
source§impl Deref for JsSearchOptions
impl Deref for JsSearchOptions
source§impl From<JsSearchOptions> for JsValue
impl From<JsSearchOptions> for JsValue
source§fn from(obj: JsSearchOptions) -> JsValue
fn from(obj: JsSearchOptions) -> JsValue
source§impl From<JsValue> for JsSearchOptions
impl From<JsValue> for JsSearchOptions
source§fn from(obj: JsValue) -> JsSearchOptions
fn from(obj: JsValue) -> JsSearchOptions
source§impl FromWasmAbi for JsSearchOptions
impl FromWasmAbi for JsSearchOptions
source§impl<'a> IntoWasmAbi for &'a JsSearchOptions
impl<'a> IntoWasmAbi for &'a JsSearchOptions
source§impl IntoWasmAbi for JsSearchOptions
impl IntoWasmAbi for JsSearchOptions
source§impl JsCast for JsSearchOptions
impl JsCast for JsSearchOptions
source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moresource§fn unchecked_from_js(val: JsValue) -> Self
fn unchecked_from_js(val: JsValue) -> Self
source§fn unchecked_from_js_ref(val: &JsValue) -> &Self
fn unchecked_from_js_ref(val: &JsValue) -> &Self
source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere
T: JsCast,
T
. Read moresource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
T
. Read moresource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
T
. Read moresource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere
T: JsCast,
source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
source§impl LongRefFromWasmAbi for JsSearchOptions
impl LongRefFromWasmAbi for JsSearchOptions
§type Abi = <JsValue as LongRefFromWasmAbi>::Abi
type Abi = <JsValue as LongRefFromWasmAbi>::Abi
RefFromWasmAbi::Abi
§type Anchor = JsSearchOptions
type Anchor = JsSearchOptions
RefFromWasmAbi::Anchor
source§unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
RefFromWasmAbi::ref_from_abi
source§impl OptionFromWasmAbi for JsSearchOptions
impl OptionFromWasmAbi for JsSearchOptions
source§impl<'a> OptionIntoWasmAbi for &'a JsSearchOptions
impl<'a> OptionIntoWasmAbi for &'a JsSearchOptions
source§impl OptionIntoWasmAbi for JsSearchOptions
impl OptionIntoWasmAbi for JsSearchOptions
source§impl RefFromWasmAbi for JsSearchOptions
impl RefFromWasmAbi for JsSearchOptions
§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.§type Anchor = ManuallyDrop<JsSearchOptions>
type Anchor = ManuallyDrop<JsSearchOptions>
Self
for the duration of the
invocation of the function that has an &Self
parameter. This is
required to ensure that the lifetimes don’t persist beyond one function
call, and so that they remain anonymous.Auto Trait Implementations§
impl RefUnwindSafe for JsSearchOptions
impl !Send for JsSearchOptions
impl !Sync for JsSearchOptions
impl Unpin for JsSearchOptions
impl UnwindSafe for JsSearchOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.