screeps-clockwork 0.1.1 → 0.2.1

package/README.md

@@ -1,7 +1,100 @@
 # Screeps Clockwork
 
-## Environment Setup
+<div style="text-align: center;"><a href="https://glitchassassin.github.io/screeps-clockwork/">Understand the Theory</a> | <a href="https://glitchassassin.github.io/screeps-clockwork/api/">API Docs</a></div>
 
-[Rust & cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
-[wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
-[node LTS](https://github.com/nvm-sh/nvm)
+## Usage
+
+This guide will assume you're using Rollup along the lines of the Screeps Typescript starter kit.
+
+Set up dependencies:
+
+```
+npm install screeps-clockwork
+npm install -D @rollup/plugin-wasm rollup-plugin-copy
+```
+
+Update your Rollup build script to copy the WASM binary to your dist folder:
+
+```js
+// add to existing dependencies
+import wasm from '@rollup/plugin-wasm';
+import copy from 'rollup-plugin-copy';
+
+// ...
+
+export default {
+  // ...
+  external: ['screeps_clockwork.wasm'],
+  plugins: [
+    clear({ targets: ['dist'] }),
+    wasm(),
+    copy({
+      targets: [
+        {
+          src: 'node_modules/screeps-clockwork/dist/screeps_clockwork.wasm',
+          dest: 'dist'
+        }
+      ]
+    }),
+    // ...
+    screeps({ config: cfg, dryRun: cfg == null })
+  ]
+};
+```
+
+`rollup-plugin-screeps` will automatically push the wasm file out when it deploys.
+
+## Dev Setup
+
+Dependencies to build and run the project:
+
+```bash
+# Install Rust + Cargo via rustup
+curl https://sh.rustup.rs -sSf | sh
+
+# Install wasm-pack
+curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+
+# Add rust-src component
+rustup component add rust-src --toolchain nightly-x86_64-unknown-linux-gnu
+
+# Install nvm
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
+
+# Install node
+nvm install --lts
+nvm use --lts
+nvm alias default --lts # optional
+```
+
+To build the project:
+
+```bash
+npm run build
+```
+
+To set up the local Screeps server, you'll need to have docker installed:
+
+```bash
+cp .env.sample .env # fill this out with the path to your Screeps .nw package and Steam key
+./reset-docker.sh
+```
+
+Once running, you can log in and spawn into the server with the [local screeps-steamless-client](http://localhost:8080/).
+
+- **Username:** clockwork
+- **Password:** passw0rd
+
+To deploy the test codebase, once the server is running:
+
+```bash
+npm run watch
+```
+
+Set up commitizen and pre-commit for conventional commits:
+
+```bash
+# requires Python 3.8+
+pip install --user -U commitizen pre-commit
+pre-commit install
+```

package/dist/index.js

@@ -4,13 +4,25 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
+var EncoderDecoderTogether_min = {};
+
+var hasRequiredEncoderDecoderTogether_min;
+
+function requireEncoderDecoderTogether_min () {
+	if (hasRequiredEncoderDecoderTogether_min) return EncoderDecoderTogether_min;
+	hasRequiredEncoderDecoderTogether_min = 1;
 (function(q){function y(){}function C(b){var c=b.charCodeAt(0)|0;if(55296<=c)if(56319>=c)if(b=b.charCodeAt(1)|0,56320<=b&&57343>=b){if(c=(c<<10)+b-56613888|0,65535<c)return v(240|c>>18,128|c>>12&63,128|c>>6&63,128|c&63)}else c=65533;else 57343>=c&&(c=65533);return 2047>=c?v(192|c>>6,128|c&63):v(224|c>>12,128|c>>6&63,128|c&63)}function z(){}function A(b,c){var g=void 0===b?"":(""+b).replace(D,C),d=g.length|0,a=0,k=0,f=c.length|0,h=b.length|0;f<d&&(d=f);a:for(;a<d;a=a+1|0){b=g.charCodeAt(a)|
-0;switch(b>>4){case 0:case 1:case 2:case 3:case 4:case 5:case 6:case 7:k=k+1|0;case 8:case 9:case 10:case 11:break;case 12:case 13:if((a+1|0)<f){k=k+1|0;break}case 14:if((a+2|0)<f){k=k+1|0;break}case 15:if((a+3|0)<f){k=k+1|0;break}default:break a}c[a]=b;}return {written:a,read:h<k?h:k}}var v=String.fromCharCode,x={}.toString,E=x.call(q.SharedArrayBuffer),F=x(),t=q.Uint8Array,w=t||Array,u=t?ArrayBuffer:w,G=u.isView||function(b){return b&&"length"in b},H=x.call(u.prototype),B=z.prototype;u=q.TextEncoder;
-var D=/[\x80-\uD7ff\uDC00-\uFFFF]|[\uD800-\uDBFF][\uDC00-\uDFFF]?/g,e=new (t?Uint16Array:w)(32);y.prototype.decode=function(b){if(!G(b)){var c=x.call(b);if(c!==H&&c!==E&&c!==F)throw TypeError("Failed to execute 'decode' on 'TextDecoder': The provided value is not of type '(ArrayBuffer or ArrayBufferView)'");b=t?new w(b):b||[];}for(var g=c="",d=0,a=b.length|0,k=a-32|0,f,h,l=0,r=0,n,m=0,p=-1;d<a;){for(f=d<=k?32:a-d|0;m<f;d=d+1|0,m=m+1|0){h=b[d]&255;switch(h>>4){case 15:n=b[d=d+1|0]&255;if(2!==n>>6||
-247<h){d=d-1|0;break}l=(h&7)<<6|n&63;r=5;h=256;case 14:n=b[d=d+1|0]&255,l<<=6,l|=(h&15)<<6|n&63,r=2===n>>6?r+4|0:24,h=h+256&768;case 13:case 12:n=b[d=d+1|0]&255,l<<=6,l|=(h&31)<<6|n&63,r=r+7|0,d<a&&2===n>>6&&l>>r&&1114112>l?(h=l,l=l-65536|0,0<=l&&(p=(l>>10)+55296|0,h=(l&1023)+56320|0,31>m?(e[m]=p,m=m+1|0,p=-1):(n=p,p=h,h=n))):(h>>=8,d=d-h-1|0,h=65533),l=r=0,f=d<=k?32:a-d|0;default:e[m]=h;continue;case 11:case 10:case 9:case 8:}e[m]=65533;}g+=v(e[0],e[1],e[2],e[3],e[4],e[5],e[6],e[7],e[8],e[9],e[10],
-e[11],e[12],e[13],e[14],e[15],e[16],e[17],e[18],e[19],e[20],e[21],e[22],e[23],e[24],e[25],e[26],e[27],e[28],e[29],e[30],e[31]);32>m&&(g=g.slice(0,m-32|0));if(d<a){if(e[0]=p,m=~p>>>31,p=-1,g.length<c.length)continue}else -1!==p&&(g+=v(p));c+=g;g="";}return c};B.encode=function(b){b=void 0===b?"":""+b;var c=b.length|0,g=new w((c<<1)+8|0),d,a=0,k=!t;for(d=0;d<c;d=d+1|0,a=a+1|0){var f=b.charCodeAt(d)|0;if(127>=f)g[a]=f;else {if(2047>=f)g[a]=192|f>>6;else {a:{if(55296<=f)if(56319>=f){var h=b.charCodeAt(d=
-d+1|0)|0;if(56320<=h&&57343>=h){f=(f<<10)+h-56613888|0;if(65535<f){g[a]=240|f>>18;g[a=a+1|0]=128|f>>12&63;g[a=a+1|0]=128|f>>6&63;g[a=a+1|0]=128|f&63;continue}break a}f=65533;}else 57343>=f&&(f=65533);!k&&d<<1<a&&d<<1<(a-7|0)&&(k=!0,h=new w(3*c),h.set(g),g=h);}g[a]=224|f>>12;g[a=a+1|0]=128|f>>6&63;}g[a=a+1|0]=128|f&63;}}return t?g.subarray(0,a):g.slice(0,a)};B.encodeInto=A;if(!u)q.TextDecoder=y,q.TextEncoder=z;else if(!(q=u.prototype).encodeInto){var I=new u;q.encodeInto=function(b,c){var g=b.length|0,
-d=c.length|0;if(g<d>>1){var a=I.encode(b);if((a.length|0)<d)return c.set(a),{read:g,written:a.length|0}}return A(b,c)};}})("undefined"==typeof commonjsGlobal?"undefined"==typeof self?commonjsGlobal:self:commonjsGlobal);//AnonyCo
+	0;switch(b>>4){case 0:case 1:case 2:case 3:case 4:case 5:case 6:case 7:k=k+1|0;case 8:case 9:case 10:case 11:break;case 12:case 13:if((a+1|0)<f){k=k+1|0;break}case 14:if((a+2|0)<f){k=k+1|0;break}case 15:if((a+3|0)<f){k=k+1|0;break}default:break a}c[a]=b;}return {written:a,read:h<k?h:k}}var v=String.fromCharCode,x={}.toString,E=x.call(q.SharedArrayBuffer),F=x(),t=q.Uint8Array,w=t||Array,u=t?ArrayBuffer:w,G=u.isView||function(b){return b&&"length"in b},H=x.call(u.prototype),B=z.prototype;u=q.TextEncoder;
+	var D=/[\x80-\uD7ff\uDC00-\uFFFF]|[\uD800-\uDBFF][\uDC00-\uDFFF]?/g,e=new (t?Uint16Array:w)(32);y.prototype.decode=function(b){if(!G(b)){var c=x.call(b);if(c!==H&&c!==E&&c!==F)throw TypeError("Failed to execute 'decode' on 'TextDecoder': The provided value is not of type '(ArrayBuffer or ArrayBufferView)'");b=t?new w(b):b||[];}for(var g=c="",d=0,a=b.length|0,k=a-32|0,f,h,l=0,r=0,n,m=0,p=-1;d<a;){for(f=d<=k?32:a-d|0;m<f;d=d+1|0,m=m+1|0){h=b[d]&255;switch(h>>4){case 15:n=b[d=d+1|0]&255;if(2!==n>>6||
+	247<h){d=d-1|0;break}l=(h&7)<<6|n&63;r=5;h=256;case 14:n=b[d=d+1|0]&255,l<<=6,l|=(h&15)<<6|n&63,r=2===n>>6?r+4|0:24,h=h+256&768;case 13:case 12:n=b[d=d+1|0]&255,l<<=6,l|=(h&31)<<6|n&63,r=r+7|0,d<a&&2===n>>6&&l>>r&&1114112>l?(h=l,l=l-65536|0,0<=l&&(p=(l>>10)+55296|0,h=(l&1023)+56320|0,31>m?(e[m]=p,m=m+1|0,p=-1):(n=p,p=h,h=n))):(h>>=8,d=d-h-1|0,h=65533),l=r=0,f=d<=k?32:a-d|0;default:e[m]=h;continue;case 11:case 10:case 9:case 8:}e[m]=65533;}g+=v(e[0],e[1],e[2],e[3],e[4],e[5],e[6],e[7],e[8],e[9],e[10],
+	e[11],e[12],e[13],e[14],e[15],e[16],e[17],e[18],e[19],e[20],e[21],e[22],e[23],e[24],e[25],e[26],e[27],e[28],e[29],e[30],e[31]);32>m&&(g=g.slice(0,m-32|0));if(d<a){if(e[0]=p,m=~p>>>31,p=-1,g.length<c.length)continue}else -1!==p&&(g+=v(p));c+=g;g="";}return c};B.encode=function(b){b=void 0===b?"":""+b;var c=b.length|0,g=new w((c<<1)+8|0),d,a=0,k=!t;for(d=0;d<c;d=d+1|0,a=a+1|0){var f=b.charCodeAt(d)|0;if(127>=f)g[a]=f;else {if(2047>=f)g[a]=192|f>>6;else {a:{if(55296<=f)if(56319>=f){var h=b.charCodeAt(d=
+	d+1|0)|0;if(56320<=h&&57343>=h){f=(f<<10)+h-56613888|0;if(65535<f){g[a]=240|f>>18;g[a=a+1|0]=128|f>>12&63;g[a=a+1|0]=128|f>>6&63;g[a=a+1|0]=128|f&63;continue}break a}f=65533;}else 57343>=f&&(f=65533);!k&&d<<1<a&&d<<1<(a-7|0)&&(k=!0,h=new w(3*c),h.set(g),g=h);}g[a]=224|f>>12;g[a=a+1|0]=128|f>>6&63;}g[a=a+1|0]=128|f&63;}}return t?g.subarray(0,a):g.slice(0,a)};B.encodeInto=A;if(!u)q.TextDecoder=y,q.TextEncoder=z;else if(!(q=u.prototype).encodeInto){var I=new u;q.encodeInto=function(b,c){var g=b.length|0,
+	d=c.length|0;if(g<d>>1){var a=I.encode(b);if((a.length|0)<d)return c.set(a),{read:g,written:a.length|0}}return A(b,c)};}})("undefined"==typeof commonjsGlobal?"undefined"==typeof self?EncoderDecoderTogether_min:self:commonjsGlobal);//AnonyCo
+	
+	return EncoderDecoderTogether_min;
+}
+
+requireEncoderDecoderTogether_min();
 
 let wasm;
 
@@ -72,6 +84,36 @@ function getStringFromWasm0(ptr, len) {
     ptr = ptr >>> 0;
     return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
 }
+/**
+ * @returns {string}
+ */
+function version() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.version(retptr);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred1_0 = r0;
+        deferred1_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+    }
+}
+
+/**
+ * Exports the global range calculation between two positions.
+ * @param {number} packed_pos_1
+ * @param {number} packed_pos_2
+ * @returns {number}
+ */
+function get_range(packed_pos_1, packed_pos_2) {
+    const ret = wasm.get_range(packed_pos_1, packed_pos_2);
+    return ret >>> 0;
+}
 
 let cachedUint32ArrayMemory0 = null;
 
@@ -98,87 +140,64 @@ function _assertClass(instance, klass) {
     return instance.ptr;
 }
 /**
- *
- * * WASM wrapper for the BFS distance map function.
- *
+ * WASM wrapper for the Dijkstra flow field function.
  * @param {Uint32Array} start_packed
  * @param {ClockworkCostMatrix} cost_matrix
- * @returns {DistanceMap}
+ * @returns {FlowField}
  */
-function js_bfs_distance_map(start_packed, cost_matrix) {
+function js_dijkstra_flow_field(start_packed, cost_matrix) {
     const ptr0 = passArray32ToWasm0(start_packed, wasm.__wbindgen_malloc);
     const len0 = WASM_VECTOR_LEN;
     _assertClass(cost_matrix, ClockworkCostMatrix);
-    const ret = wasm.js_bfs_distance_map(ptr0, len0, cost_matrix.__wbg_ptr);
-    return DistanceMap.__wrap(ret);
+    const ret = wasm.js_dijkstra_flow_field(ptr0, len0, cost_matrix.__wbg_ptr);
+    return FlowField.__wrap(ret);
 }
 
 /**
- *
- * * WASM wrapper for the BFS flow field function.
- *
+ * WASM wrapper for the Dijkstra mono flow field function.
  * @param {Uint32Array} start_packed
  * @param {ClockworkCostMatrix} cost_matrix
- * @returns {FlowField}
+ * @returns {MonoFlowField}
  */
-function js_bfs_flow_field(start_packed, cost_matrix) {
+function js_dijkstra_mono_flow_field(start_packed, cost_matrix) {
     const ptr0 = passArray32ToWasm0(start_packed, wasm.__wbindgen_malloc);
     const len0 = WASM_VECTOR_LEN;
     _assertClass(cost_matrix, ClockworkCostMatrix);
-    const ret = wasm.js_bfs_flow_field(ptr0, len0, cost_matrix.__wbg_ptr);
-    return FlowField.__wrap(ret);
+    const ret = wasm.js_dijkstra_mono_flow_field(ptr0, len0, cost_matrix.__wbg_ptr);
+    return MonoFlowField.__wrap(ret);
 }
 
 /**
- *
- * * WASM wrapper for the BFS mono flow field function.
- *
+ * WASM wrapper for the BFS flow field function.
  * @param {Uint32Array} start_packed
  * @param {ClockworkCostMatrix} cost_matrix
- * @returns {MonoFlowField}
+ * @returns {FlowField}
  */
-function js_bfs_mono_flow_field(start_packed, cost_matrix) {
+function js_bfs_flow_field(start_packed, cost_matrix) {
     const ptr0 = passArray32ToWasm0(start_packed, wasm.__wbindgen_malloc);
     const len0 = WASM_VECTOR_LEN;
     _assertClass(cost_matrix, ClockworkCostMatrix);
-    const ret = wasm.js_bfs_mono_flow_field(ptr0, len0, cost_matrix.__wbg_ptr);
-    return MonoFlowField.__wrap(ret);
-}
-
-/**
- * @returns {string}
- */
-function version() {
-    let deferred1_0;
-    let deferred1_1;
-    try {
-        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.version(retptr);
-        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
-        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-        deferred1_0 = r0;
-        deferred1_1 = r1;
-        return getStringFromWasm0(r0, r1);
-    } finally {
-        wasm.__wbindgen_add_to_stack_pointer(16);
-        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
-    }
-}
-
-/**
- * @param {number} packed_pos_1
- * @param {number} packed_pos_2
- * @returns {number}
- */
-function get_range(packed_pos_1, packed_pos_2) {
-    const ret = wasm.get_range(packed_pos_1, packed_pos_2);
-    return ret >>> 0;
+    const ret = wasm.js_bfs_flow_field(ptr0, len0, cost_matrix.__wbg_ptr);
+    return FlowField.__wrap(ret);
 }
 
 function getArrayU32FromWasm0(ptr, len) {
     ptr = ptr >>> 0;
     return getUint32ArrayMemory0().subarray(ptr / 4, ptr / 4 + len);
 }
+/**
+ * WASM wrapper for the Dijkstra distance map function.
+ * @param {Uint32Array} start_packed
+ * @param {ClockworkCostMatrix} cost_matrix
+ * @returns {DistanceMap}
+ */
+function js_dijkstra_distance_map(start_packed, cost_matrix) {
+    const ptr0 = passArray32ToWasm0(start_packed, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    _assertClass(cost_matrix, ClockworkCostMatrix);
+    const ret = wasm.js_dijkstra_distance_map(ptr0, len0, cost_matrix.__wbg_ptr);
+    return DistanceMap.__wrap(ret);
+}
 
 function getArrayJsValueFromWasm0(ptr, len) {
     ptr = ptr >>> 0;
@@ -199,6 +218,34 @@ function passArrayJsValueToWasm0(array, malloc) {
     WASM_VECTOR_LEN = array.length;
     return ptr;
 }
+/**
+ * WASM wrapper for the BFS distance map function.
+ * @param {Uint32Array} start_packed
+ * @param {ClockworkCostMatrix} cost_matrix
+ * @returns {DistanceMap}
+ */
+function js_bfs_distance_map(start_packed, cost_matrix) {
+    const ptr0 = passArray32ToWasm0(start_packed, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    _assertClass(cost_matrix, ClockworkCostMatrix);
+    const ret = wasm.js_bfs_distance_map(ptr0, len0, cost_matrix.__wbg_ptr);
+    return DistanceMap.__wrap(ret);
+}
+
+/**
+ * WASM wrapper for the BFS mono flow field function.
+ * @param {Uint32Array} start_packed
+ * @param {ClockworkCostMatrix} cost_matrix
+ * @returns {MonoFlowField}
+ */
+function js_bfs_mono_flow_field(start_packed, cost_matrix) {
+    const ptr0 = passArray32ToWasm0(start_packed, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    _assertClass(cost_matrix, ClockworkCostMatrix);
+    const ret = wasm.js_bfs_mono_flow_field(ptr0, len0, cost_matrix.__wbg_ptr);
+    return MonoFlowField.__wrap(ret);
+}
+
 /**
  * Translates `COLOR_*` and `COLORS_ALL` constants.
  */
@@ -256,7 +303,11 @@ Object.freeze({ Plain:0,"0":"Plain",Wall:1,"1":"Wall",Swamp:2,"2":"Swamp", });
 const ClockworkCostMatrixFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_clockworkcostmatrix_free(ptr >>> 0, 1));
-
+/**
+ * A wrapper around the `LocalCostMatrix` type from the Screeps API.
+ * Instances can be passed between WASM and JS as a pointer, using the
+ * methods to get and set values, rather than copying the entire matrix.
+ */
 class ClockworkCostMatrix {
 
     __destroy_into_raw() {
@@ -270,13 +321,19 @@ class ClockworkCostMatrix {
         const ptr = this.__destroy_into_raw();
         wasm.__wbg_clockworkcostmatrix_free(ptr, 0);
     }
-    constructor() {
-        const ret = wasm.clockworkcostmatrix_new();
+    /**
+     * Creates a new cost matrix within the WASM module. Optionally, a default value
+     * can be provided to initialize all cells in the matrix to that value.
+     * @param {number | undefined} [_default]
+     */
+    constructor(_default) {
+        const ret = wasm.clockworkcostmatrix_new(isLikeNone(_default) ? 0xFFFFFF : _default);
         this.__wbg_ptr = ret >>> 0;
         ClockworkCostMatrixFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
     /**
+     * Gets the cost of a given position in the cost matrix.
      * @param {number} x
      * @param {number} y
      * @returns {number}
@@ -286,6 +343,7 @@ class ClockworkCostMatrix {
         return ret;
     }
     /**
+     * Sets the cost of a given position in the cost matrix.
      * @param {number} x
      * @param {number} y
      * @param {number} value
@@ -299,7 +357,7 @@ const DistanceMapFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_distancemap_free(ptr >>> 0, 1));
 /**
- * Maps arbitrary data onto individual room tile positions.
+ * Maps a distance value onto individual room tile positions.
  */
 class DistanceMap {
 
@@ -323,6 +381,7 @@ class DistanceMap {
         wasm.__wbg_distancemap_free(ptr, 0);
     }
     /**
+     * Converts the distance map into a flat array of distances.
      * @returns {Uint32Array}
      */
     toArray() {
@@ -339,6 +398,7 @@ class DistanceMap {
         }
     }
     /**
+     * Gets the distance value at a given position.
      * @param {number} x
      * @param {number} y
      * @returns {number}
@@ -348,6 +408,7 @@ class DistanceMap {
         return ret >>> 0;
     }
     /**
+     * Sets the distance value at a given position.
      * @param {number} x
      * @param {number} y
      * @param {number} value
@@ -361,12 +422,10 @@ const FlowFieldFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_flowfield_free(ptr >>> 0, 1));
 /**
- *
- * * A flow field is a 50x50 grid (representing a room), representing viable directions
- * * to travel to reach a particular target (or targets). A given tile may have multiple
- * * equally valid directions, so we represent this as a bitfield (where each bit in an
- * * 8-bit unsigned integer represents a direction that is either viable or not).
- *
+ * A flow field is a 50x50 grid (representing a room), representing viable directions
+ * to travel to reach a particular target (or targets). A given tile may have multiple
+ * equally valid directions, so we represent this as a bitfield (where each bit in an
+ * 8-bit unsigned integer represents a direction that is either viable or not).
  */
 class FlowField {
 
@@ -390,9 +449,7 @@ class FlowField {
         wasm.__wbg_flowfield_free(ptr, 0);
     }
     /**
-     *
-     *     * Get the internal value for a given coordinate.
-     *
+     * Get the internal value for a given coordinate.
      * @param {number} x
      * @param {number} y
      * @returns {number}
@@ -402,9 +459,7 @@ class FlowField {
         return ret;
     }
     /**
-     *
-     *     * Set the internal value for a given coordinate.
-     *
+     * Set the internal value for a given coordinate.
      * @param {number} x
      * @param {number} y
      * @param {number} value
@@ -413,9 +468,7 @@ class FlowField {
         wasm.flowfield_set(this.__wbg_ptr, x, y, value);
     }
     /**
-     *
-     *     * Get the list of valid directions for a given coordinate.
-     *
+     * Get the list of valid directions for a given coordinate.
      * @param {number} x
      * @param {number} y
      * @returns {any[]}
@@ -434,9 +487,7 @@ class FlowField {
         }
     }
     /**
-     *
-     *     * Set the list of valid directions for a given coordinate.
-     *
+     * Set the list of valid directions for a given coordinate.
      * @param {number} x
      * @param {number} y
      * @param {any[]} directions
@@ -447,6 +498,7 @@ class FlowField {
         wasm.flowfield_setDirections(this.__wbg_ptr, x, y, ptr0, len0);
     }
     /**
+     * Add a direction to the list of valid directions for a given coordinate.
      * @param {number} x
      * @param {number} y
      * @param {Direction} direction
@@ -460,12 +512,10 @@ const MonoFlowFieldFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_monoflowfield_free(ptr >>> 0, 1));
 /**
- *
- * * A flow field is a 50x50 grid (representing a room), representing viable directions
- * * to travel to reach a particular target (or targets). A mono flow field only stores
- * * a single direction for each tile, so we represent this as 4 bits of an unsigned
- * * integer (0 for no direction, 1 for TOP, etc.).
- *
+ * A flow field is a 50x50 grid (representing a room), representing viable directions
+ * to travel to reach a particular target (or targets). A mono flow field only stores
+ * a single direction for each tile, so we represent this as 4 bits of an unsigned
+ * integer (0 for no direction, 1 for TOP, etc.).
  */
 class MonoFlowField {
 
@@ -489,9 +539,7 @@ class MonoFlowField {
         wasm.__wbg_monoflowfield_free(ptr, 0);
     }
     /**
-     *
-     *     * Get the direction for a given coordinate.
-     *
+     * Get the direction for a given coordinate.
      * @param {number} x
      * @param {number} y
      * @returns {Direction | undefined}
@@ -501,9 +549,7 @@ class MonoFlowField {
         return ret === 0 ? undefined : ret;
     }
     /**
-     *
-     *     * Set the direction for a given coordinate.
-     *
+     * Set the direction for a given coordinate.
      * @param {number} x
      * @param {number} y
      * @param {Direction | undefined} [value]
@@ -591,23 +637,145 @@ function initSync(module) {
     return __wbg_finalize_init(instance);
 }
 
+/**
+ * Generate a [distance map](https://glitchassassin.github.io/screeps-clockwork/primitives/flowfield.html) for a set of positions
+ * using a breadth-first search algorithm.
+ *
+ * The BFS algorithm doesn't include variable costs, and only considers
+ * values of 255 (impassible) in the provided cost matrix. Any other
+ * values are ignored.
+ *
+ * This might be useful for creeps with only MOVE parts and/or empty
+ * CARRY parts, which don't generate fatigue.
+ *
+ * Note that the `roomName` on start positions is ignored - all positions
+ * are assumed to be in the same room as the cost matrix.
+ *
+ * @param start - The starting positions.
+ * @param costMatrix - The cost matrix to use for the flow field.
+ * @returns The flow field.
+ */
 function bfsDistanceMap(start, costMatrix) {
     const startPacked = new Uint32Array(start.map(pos => pos.__packedPos));
     const result = js_bfs_distance_map(startPacked, costMatrix);
     return result;
 }
 
+/**
+ * Generate a [flow field](https://glitchassassin.github.io/screeps-clockwork/primitives/flowfield.html) for a set of positions
+ * using a breadth-first search algorithm.
+ *
+ * The BFS algorithm doesn't include variable costs, and only considers
+ * values of 255 (impassible) in the provided cost matrix. Any other
+ * values are ignored.
+ *
+ * This might be useful for creeps with only MOVE parts and/or empty
+ * CARRY parts, which don't generate fatigue.
+ *
+ * @param start - The starting positions.
+ * @param costMatrix - The cost matrix to use for the flow field.
+ * @returns The flow field.
+ */
 function bfsFlowField(start, costMatrix) {
     const startPacked = new Uint32Array(start.map(pos => pos.__packedPos));
     const result = js_bfs_flow_field(startPacked, costMatrix);
     return result;
 }
+/**
+ * Generate a [mono-directional flow field](https://glitchassassin.github.io/screeps-clockwork/primitives/flowfield.html)
+ * for a set of positions using a breadth-first search algorithm.
+ *
+ * The BFS algorithm doesn't include variable costs, and only considers
+ * values of 255 (impassible) in the provided cost matrix. Any other
+ * values are ignored.
+ *
+ * This might be useful for creeps with only MOVE parts and/or empty
+ * CARRY parts, which don't generate fatigue.
+ *
+ * Note that the `roomName` on start positions is ignored - all positions
+ * are assumed to be in the same room as the cost matrix.
+ *
+ * @param start - The starting positions.
+ * @param costMatrix - The cost matrix to use for the flow field.
+ * @returns The flow field.
+ */
 function bfsMonoFlowField(start, costMatrix) {
     const startPacked = new Uint32Array(start.map(pos => pos.__packedPos));
     const result = js_bfs_mono_flow_field(startPacked, costMatrix);
     return result;
 }
 
+/**
+ * Generate a [distance map](https://glitchassassin.github.io/screeps-clockwork/primitives/flowfield.html) for a set of positions
+ * using Dijkstra's algorithm.
+ *
+ * Dijkstra's algorithm includes variable costs to account for terrain or other cost functions.
+ *
+ * Note that values of 0 in the cost matrix may have unexpected behavior. You probably want
+ * a cost matrix with a default value of at least 1.
+ *
+ * Note that the `roomName` on start positions is ignored - all positions
+ * are assumed to be in the same room as the cost matrix.
+ *
+ * @param start - The starting positions.
+ * @param costMatrix - The cost matrix to use for the flow field.
+ * @returns The flow field.
+ */
+function dijkstraDistanceMap(start, costMatrix) {
+    const startPacked = new Uint32Array(start.map(pos => pos.__packedPos));
+    const result = js_dijkstra_distance_map(startPacked, costMatrix);
+    return result;
+}
+
+/**
+ * Generate a [flow field](https://glitchassassin.github.io/screeps-clockwork/primitives/flowfield.html) for a set of positions
+ * using Dijkstra's algorithm.
+ *
+ * Dijkstra's algorithm includes variable costs to account for terrain or other cost functions.
+ *
+ * Note that values of 0 in the cost matrix may have unexpected behavior. You probably want
+ * a cost matrix with a default value of at least 1.
+ *
+ * @param start - The starting positions.
+ * @param costMatrix - The cost matrix to use for the flow field.
+ * @returns The flow field.
+ */
+function dijkstraFlowField(start, costMatrix) {
+    const startPacked = new Uint32Array(start.map(pos => pos.__packedPos));
+    const result = js_dijkstra_flow_field(startPacked, costMatrix);
+    return result;
+}
+/**
+ * Generate a [mono-directional flow field](https://glitchassassin.github.io/screeps-clockwork/primitives/flowfield.html)
+ * for a set of positions using Dijkstra's algorithm.
+ *
+ * Dijkstra's algorithm includes variable costs to account for terrain or other cost functions.
+ *
+ * Note that values of 0 in the cost matrix may have unexpected behavior. You probably want
+ * a cost matrix with a default value of at least 1.
+ *
+ * Note that the `roomName` on start positions is ignored - all positions
+ * are assumed to be in the same room as the cost matrix.
+ *
+ * @param start - The starting positions.
+ * @param costMatrix - The cost matrix to use for the flow field.
+ * @returns The flow field.
+ */
+function dijkstraMonoFlowField(start, costMatrix) {
+    const startPacked = new Uint32Array(start.map(pos => pos.__packedPos));
+    const result = js_dijkstra_mono_flow_field(startPacked, costMatrix);
+    return result;
+}
+
+/**
+ * Get the global range between two positions. This is different
+ * from the `getRange` method on `RoomPosition`, which gets the
+ * range only within the same room.
+ *
+ * @param pos1 - The first position.
+ * @param pos2 - The second position.
+ * @returns The range between the two positions.
+ */
 function getRange(pos1, pos2) {
     return get_range(pos1.__packedPos, pos2.__packedPos);
 }
@@ -616,6 +784,14 @@ let wasm_bytes;
 let wasm_module;
 let wasm_instance;
 let initialized = false;
+/**
+ * The `initialize` function should be called in your main loop before
+ * using any other screeps-clockwork functions. Depending on available
+ * CPU, it may not load the WASM module completely in the first tick,
+ * but it will pick back up where it left off if the script times out.
+ *
+ * @param verbose - If true, will log the state of the WASM module as it loads.
+ */
 function initialize(verbose = false) {
     if (!wasm_bytes)
         wasm_bytes = require('screeps_clockwork.wasm');
@@ -641,6 +817,9 @@ exports.MonoFlowField = MonoFlowField;
 exports.bfsDistanceMap = bfsDistanceMap;
 exports.bfsFlowField = bfsFlowField;
 exports.bfsMonoFlowField = bfsMonoFlowField;
+exports.dijkstraDistanceMap = dijkstraDistanceMap;
+exports.dijkstraFlowField = dijkstraFlowField;
+exports.dijkstraMonoFlowField = dijkstraMonoFlowField;
 exports.getRange = getRange;
 exports.initialize = initialize;
 //# sourceMappingURL=index.js.map