1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
//! Interface for Screeps [`RawMemory`] global object.
//!
//! This is available as an alternative to the `Memory` object in the js heap,
//! which itself is just a light wrapper around serializing into and
//! deserializing JSON into [`RawMemory`]. String data stored can be retrieved
//! after the running bot code is restarted (either by the server or by a new
//! version of the code being uploaded) and decoded using serde or another
//! option.
//!
//! Also contains functions for accessing memory segments and other
//! players' active foreign segments.
//!
//! [`RawMemory`]: https://docs.screeps.com/api/#RawMemory
use js_sys::{Array, JsString, Object};
use wasm_bindgen::prelude::*;
use crate::prelude::*;
#[wasm_bindgen]
extern "C" {
type RawMemory;
#[wasm_bindgen(static_method_of = RawMemory, getter = segments)]
fn segments() -> Object;
#[wasm_bindgen(static_method_of = RawMemory, getter = foreignSegment)]
fn foreign_segment() -> Option<ForeignSegment>;
#[wasm_bindgen(static_method_of = RawMemory)]
fn get() -> JsString;
#[wasm_bindgen(static_method_of = RawMemory)]
fn set(val: &JsString);
#[wasm_bindgen(static_method_of = RawMemory, js_name = setActiveSegments)]
fn set_active_segments(segment_ids: &Array);
#[wasm_bindgen(static_method_of = RawMemory, js_name = setActiveForeignSegment)]
fn set_active_foreign_segment(username: &JsString, segment_id: Option<u8>);
#[wasm_bindgen(static_method_of = RawMemory, js_name = setDefaultPublicSegment)]
fn set_default_public_segment(segment_id: JsValue);
#[wasm_bindgen(static_method_of = RawMemory, js_name = setPublicSegments)]
fn set_public_segments(segment_ids: &Array);
}
/// Get a [`JsHashMap<u8, String>`] with all of the segments requested on
/// the previous tick, with segment numbers as keys and segment data in
/// [`JsString`] form as values.
///
/// [Screeps documentation](https://docs.screeps.com/api/#RawMemory.segments)
pub fn segments() -> JsHashMap<u8, String> {
RawMemory::segments().into()
}
/// Get the foreign memory segment belonging to another player requested
/// last tick.
///
/// [Screeps documentation](https://docs.screeps.com/api/#RawMemory.foreignSegment)
pub fn foreign_segment() -> Option<ForeignSegment> {
RawMemory::foreign_segment()
}
/// Get the stored serialized memory as a [`JsString`].
///
/// [Screeps documentation](https://docs.screeps.com/api/#RawMemory.get)
pub fn get() -> JsString {
RawMemory::get()
}
/// Overwrite the stored memory with a new [`JsString`]. Maximum allowed
/// size [`MEMORY_SIZE_LIMIT`] UTF-16 units.
///
/// [Screeps documentation](https://docs.screeps.com/api/#RawMemory.set)
///
/// [`MEMORY_SIZE_LIMIT`]: crate::constants::MEMORY_SIZE_LIMIT
pub fn set(val: &JsString) {
RawMemory::set(val)
}
/// Sets available memory segments for the next tick, as an array of numbers
/// from 0 to 99 (max of 10 segments allowed).
///
/// [Screeps documentation](https://docs.screeps.com/api/#RawMemory.setActiveSegments)
pub fn set_active_segments(segment_ids: &[u8]) {
let segment_ids: Array = segment_ids
.iter()
.map(|s| *s as f64)
.map(JsValue::from_f64)
.collect();
RawMemory::set_active_segments(&segment_ids)
}
/// Sets available foreign memory segment for the next tick to a memory
/// segment marked as public by another user. If no id is passed, the user's
/// default public segment is retrieved.
///
/// [Screeps documentation](https://docs.screeps.com/api/#RawMemory.setActiveForeignSegment)
pub fn set_active_foreign_segment(username: &JsString, segment_id: Option<u8>) {
RawMemory::set_active_foreign_segment(username, segment_id)
}
/// Sets your default foreign memory segment for other players to read, or
/// remove your public segment with `None`.
///
/// [Screeps documentation](https://docs.screeps.com/api/#RawMemory.setDefaultPublicSegment)
pub fn set_default_public_segment(segment_id: Option<u8>) {
RawMemory::set_default_public_segment(
segment_id
.map(|f| JsValue::from_f64(f as f64))
.unwrap_or(JsValue::NULL),
)
}
/// Sets which of your memory segments are readable to other players as
/// foreign segments, overriding previous settings.
///
/// [Screeps documentation](https://docs.screeps.com/api/#RawMemory.setPublicSegments)
pub fn set_public_segments(segment_ids: &[u8]) {
let segment_ids: Array = segment_ids
.iter()
.map(|s| *s as f64)
.map(JsValue::from_f64)
.collect();
RawMemory::set_public_segments(&segment_ids)
}
#[wasm_bindgen]
extern "C" {
/// The data from another user's foreign memory segment, which can be
/// retrieved by [`foreign_segment`], after being requested on the previous
/// tick by [`set_active_foreign_segment`].
#[wasm_bindgen]
pub type ForeignSegment;
#[wasm_bindgen(method, getter)]
pub fn username(this: &ForeignSegment) -> JsString;
#[wasm_bindgen(method, getter)]
pub fn id(this: &ForeignSegment) -> u8;
#[wasm_bindgen(method, getter)]
pub fn data(this: &ForeignSegment) -> JsString;
}