screeps-clockwork 0.2.1 → 0.4.0

package/dist/src/wasm/screeps_clockwork.d.ts

@@ -1,16 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * @returns {string}
- */
-export function version(): string;
-/**
- * Exports the global range calculation between two positions.
- * @param {number} packed_pos_1
- * @param {number} packed_pos_2
- * @returns {number}
- */
-export function get_range(packed_pos_1: number, packed_pos_2: number): number;
 /**
  * WASM wrapper for the Dijkstra flow field function.
  * @param {Uint32Array} start_packed
@@ -19,26 +8,42 @@ export function get_range(packed_pos_1: number, packed_pos_2: number): number;
  */
 export function js_dijkstra_flow_field(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): FlowField;
 /**
- * WASM wrapper for the Dijkstra mono flow field function.
- * @param {Uint32Array} start_packed
- * @param {ClockworkCostMatrix} cost_matrix
- * @returns {MonoFlowField}
+ * @param {number} start
+ * @param {MonoFlowField} flow_field
+ * @returns {Path}
  */
-export function js_dijkstra_mono_flow_field(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): MonoFlowField;
+export function js_path_to_mono_flow_field_origin(start: number, flow_field: MonoFlowField): Path;
 /**
- * WASM wrapper for the BFS flow field function.
+ * WASM wrapper for the Dijkstra distance map function.
  * @param {Uint32Array} start_packed
  * @param {ClockworkCostMatrix} cost_matrix
- * @returns {FlowField}
+ * @returns {DistanceMap}
  */
-export function js_bfs_flow_field(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): FlowField;
+export function js_dijkstra_distance_map(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): DistanceMap;
 /**
- * WASM wrapper for the Dijkstra distance map function.
+ * WASM wrapper for the BFS mono flow field function.
  * @param {Uint32Array} start_packed
  * @param {ClockworkCostMatrix} cost_matrix
- * @returns {DistanceMap}
+ * @returns {MonoFlowField}
  */
-export function js_dijkstra_distance_map(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): DistanceMap;
+export function js_bfs_mono_flow_field(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): MonoFlowField;
+/**
+ * @param {number} start
+ * @param {DistanceMap} distance_map
+ * @returns {Path}
+ */
+export function js_path_to_distance_map_origin(start: number, distance_map: DistanceMap): Path;
+/**
+ * @returns {string}
+ */
+export function version(): string;
+/**
+ * Exports the global range calculation between two positions.
+ * @param {number} packed_pos_1
+ * @param {number} packed_pos_2
+ * @returns {number}
+ */
+export function get_range(packed_pos_1: number, packed_pos_2: number): number;
 /**
  * WASM wrapper for the BFS distance map function.
  * @param {Uint32Array} start_packed
@@ -47,12 +52,25 @@ export function js_dijkstra_distance_map(start_packed: Uint32Array, cost_matrix:
  */
 export function js_bfs_distance_map(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): DistanceMap;
 /**
- * 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 {FlowField}
+ */
+export function js_bfs_flow_field(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): FlowField;
+/**
+ * WASM wrapper for the Dijkstra mono flow field function.
  * @param {Uint32Array} start_packed
  * @param {ClockworkCostMatrix} cost_matrix
  * @returns {MonoFlowField}
  */
-export function js_bfs_mono_flow_field(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): MonoFlowField;
+export function js_dijkstra_mono_flow_field(start_packed: Uint32Array, cost_matrix: ClockworkCostMatrix): MonoFlowField;
+/**
+ * @param {number} start
+ * @param {FlowField} flow_field
+ * @returns {Path}
+ */
+export function js_path_to_flow_field_origin(start: number, flow_field: FlowField): Path;
 /**
  * Translates `COLOR_*` and `COLORS_ALL` constants.
  */
@@ -315,6 +333,76 @@ export class MonoFlowField {
    */
   set(x: number, y: number, value?: Direction): void;
 }
+/**
+ * A list of positions representing a path.
+ */
+export class Path {
+  free(): void;
+  /**
+   * @param {number} packed_position
+   */
+  add(packed_position: number): void;
+  /**
+   * @param {number} index
+   * @returns {number | undefined}
+   */
+  get(index: number): number | undefined;
+  /**
+   * @returns {number}
+   */
+  len(): number;
+  /**
+   * Given a position, find the index of the next adjacent position
+   * in the path. If the position is not in the path, the target is
+   * the next adjacent position closest to the end of the path. If
+   * the position is neither on nor adjacent to the path, return None.
+   * @param {number} packed_position
+   * @returns {number | undefined}
+   */
+  find_next_index(packed_position: number): number | undefined;
+  /**
+   * @returns {Uint32Array}
+   */
+  to_array(): Uint32Array;
+  /**
+   * @returns {Uint32Array}
+   */
+  to_array_reversed(): Uint32Array;
+}
+/**
+ * Tracks fatigue cost for each position in a path. Used to calculate move time
+ * for a given creep build.
+ */
+export class PathFatigue {
+  free(): void;
+  /**
+   * @param {Path} path
+   */
+  constructor(path: Path);
+  /**
+   * Refreshes fatigue cost for each position in the path. If the PathFatigue
+   * has not been initialized yet, every position's fatigue cost will be set,
+   * even if there is no vision in the room, based on terrain costs. If the
+   * list *has* been initialized, only positions with vision will be updated.
+   *
+   * When there is vision, this also accounts for roads at the position.
+   * @param {Path} path
+   */
+  refresh(path: Path): void;
+  /**
+   * @returns {number}
+   */
+  len(): number;
+  /**
+   * Calculates the total move time for the path, given a fatigue ratio.
+   *
+   * For unboosted creeps, the ratio is `Math.floor(moveParts * 2 / fatigueParts)`
+   * where `fatigue_parts` are any part except MOVE and empty CARRY parts.
+   * @param {number} fatigue_ratio
+   * @returns {number}
+   */
+  moveTime(fatigue_ratio: number): number;
+}
 export class SearchGoal {
   free(): void;
   readonly pos: any;
@@ -325,11 +413,26 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 
 export interface InitOutput {
   readonly memory: WebAssembly.Memory;
-  readonly version: (a: number) => void;
-  readonly get_range: (a: number, b: number) => number;
+  readonly __wbg_path_free: (a: number, b: number) => void;
+  readonly __wbg_pathfatigue_free: (a: number, b: number) => void;
+  readonly path_add: (a: number, b: number) => void;
+  readonly path_get: (a: number, b: number, c: number) => void;
+  readonly path_len: (a: number) => number;
+  readonly path_find_next_index: (a: number, b: number, c: number) => void;
+  readonly path_to_array: (a: number, b: number) => void;
+  readonly path_to_array_reversed: (a: number, b: number) => void;
+  readonly pathfatigue_new: (a: number) => number;
+  readonly pathfatigue_refresh: (a: number, b: number) => void;
+  readonly pathfatigue_moveTime: (a: number, b: number) => number;
+  readonly pathfatigue_len: (a: number) => number;
   readonly js_dijkstra_flow_field: (a: number, b: number, c: number) => number;
-  readonly js_dijkstra_mono_flow_field: (a: number, b: number, c: number) => number;
-  readonly js_bfs_flow_field: (a: number, b: number, c: number) => number;
+  readonly __wbg_flowfield_free: (a: number, b: number) => void;
+  readonly flowfield_get: (a: number, b: number, c: number) => number;
+  readonly flowfield_set: (a: number, b: number, c: number, d: number) => void;
+  readonly flowfield_getDirections: (a: number, b: number, c: number, d: number) => void;
+  readonly flowfield_setDirections: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly flowfield_addDirection: (a: number, b: number, c: number, d: number) => void;
+  readonly js_path_to_mono_flow_field_origin: (a: number, b: number) => number;
   readonly __wbg_monoflowfield_free: (a: number, b: number) => void;
   readonly monoflowfield_get: (a: number, b: number, c: number) => number;
   readonly monoflowfield_set: (a: number, b: number, c: number, d: number) => void;
@@ -337,25 +440,26 @@ export interface InitOutput {
   readonly clockworkcostmatrix_new: (a: number) => number;
   readonly clockworkcostmatrix_get: (a: number, b: number, c: number) => number;
   readonly clockworkcostmatrix_set: (a: number, b: number, c: number, d: number) => void;
+  readonly js_dijkstra_distance_map: (a: number, b: number, c: number) => number;
+  readonly js_bfs_mono_flow_field: (a: number, b: number, c: number) => number;
+  readonly js_path_to_distance_map_origin: (a: number, b: number) => number;
   readonly __wbg_distancemap_free: (a: number, b: number) => void;
   readonly distancemap_toArray: (a: number, b: number) => void;
   readonly distancemap_get: (a: number, b: number, c: number) => number;
   readonly distancemap_set: (a: number, b: number, c: number, d: number) => void;
-  readonly js_dijkstra_distance_map: (a: number, b: number, c: number) => number;
-  readonly __wbg_flowfield_free: (a: number, b: number) => void;
-  readonly flowfield_get: (a: number, b: number, c: number) => number;
-  readonly flowfield_set: (a: number, b: number, c: number, d: number) => void;
-  readonly flowfield_getDirections: (a: number, b: number, c: number, d: number) => void;
-  readonly flowfield_setDirections: (a: number, b: number, c: number, d: number, e: number) => void;
-  readonly flowfield_addDirection: (a: number, b: number, c: number, d: number) => void;
+  readonly version: (a: number) => void;
+  readonly get_range: (a: number, b: number) => number;
   readonly js_bfs_distance_map: (a: number, b: number, c: number) => number;
-  readonly js_bfs_mono_flow_field: (a: number, b: number, c: number) => number;
+  readonly js_bfs_flow_field: (a: number, b: number, c: number) => number;
+  readonly js_dijkstra_mono_flow_field: (a: number, b: number, c: number) => number;
+  readonly js_path_to_flow_field_origin: (a: number, b: number) => number;
   readonly __wbg_searchgoal_free: (a: number, b: number) => void;
   readonly searchgoal_pos: (a: number) => number;
   readonly searchgoal_range: (a: number) => number;
   readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
   readonly __wbindgen_free: (a: number, b: number, c: number) => void;
   readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_exn_store: (a: number) => void;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;

package/dist/src/wrappers/path.d.ts

@@ -0,0 +1,26 @@
+import { Path as ClockworkPath } from '../wasm/screeps_clockwork';
+export declare class Path {
+    private readonly path;
+    constructor(path: ClockworkPath);
+    [Symbol.iterator](): {
+        next: () => {
+            value: RoomPosition;
+            done: boolean;
+        };
+    };
+    /**
+     * Iterate over the path in reverse order
+     */
+    reversed(): Generator<never, {
+        next: () => {
+            value: RoomPosition;
+            done: boolean;
+        };
+    }, unknown>;
+    get(index: number): RoomPosition;
+    get length(): number;
+    findNextIndex(index: number): number | undefined;
+    toArray(): RoomPosition[];
+    toArrayReversed(): RoomPosition[];
+    free(): void;
+}

package/dist/src/wrappers/pathtoDistanceMapOrigin.d.ts

@@ -0,0 +1,3 @@
+import { DistanceMap } from '../wasm/screeps_clockwork';
+import { Path } from './path';
+export declare function pathToDistanceMapOrigin(start: RoomPosition, distanceMap: DistanceMap): Path;

package/dist/src/wrappers/pathtoFlowFieldOrigin.d.ts

@@ -0,0 +1,3 @@
+import { FlowField } from '../wasm/screeps_clockwork';
+import { Path } from './path';
+export declare function pathToFlowFieldOrigin(start: RoomPosition, flowField: FlowField): Path;

package/dist/src/wrappers/pathtoMonoFlowFieldOrigin.d.ts

@@ -0,0 +1,3 @@
+import { MonoFlowField } from '../wasm/screeps_clockwork';
+import { Path } from './path';
+export declare function pathToMonoFlowFieldOrigin(start: RoomPosition, flowField: MonoFlowField): Path;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screeps-clockwork",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "A WASM movement library for Screeps",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",