refactor: rename navigation() to pathfinder() (#430)

kaplayjs · Oct 6, 2024 · 74a2382 · 74a2382
1 parent 8e9bee1
commit 74a2382
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 32 deletions.
diff --git a/examples/ghosthunting.js b/examples/ghosthunting.js
@@ -256,8 +256,8 @@ function addEnemy(p) {
         }),
         // Patrol can make the enemy follow a computed path
         patrol({ speed: 100 }),
-        // Navigator can compute a path given a graph
-        navigation({
+        // Pathfinder can compute a path given a graph
+        pathfinder({
             graph: nav,
             navigationOpt: {
                 type: "edges",

diff --git a/src/components/level/index.ts b/src/components/level/index.ts
@@ -1,5 +1,5 @@
 export * from "./agent";
-export * from "./navigation";
+export * from "./pathfinder";
 export * from "./patrol";
 export * from "./sentry";
 export * from "./tile";
diff --git a/src/components/level/navigation.ts → src/components/level/pathfinder.ts b/src/components/level/navigation.ts → src/components/level/pathfinder.ts
@@ -3,7 +3,7 @@ import { type Graph } from "../../math/navigation";
 import type { Comp, GameObj } from "../../types";
 import type { PosComp } from "../transform/pos";
 
-export interface NavigationMapComp extends Comp {
+export interface PathfinderMapComp extends Comp {
     /*
      * Get navigation waypoints to reach the given target from the given origin.
      */
@@ -18,27 +18,27 @@ export interface NavigationMapComp extends Comp {
     graph: Graph | undefined;
 }
 
-export interface NavigationMapCompOpt {
+export interface PathfinderMapCompOpt {
     /*
-     * The graph to use for navigation. If null, the ancestors are queried for a navigatorMap component.
+     * The graph to use for navigation. If null, the ancestors are queried for a pathfinderMap component.
      */
     graph?: Graph;
 }
 
-export function navigationMap(
-    opts: NavigationMapCompOpt,
-): NavigationMapComp {
+export function pathfinderMap(
+    opts: PathfinderMapCompOpt,
+): PathfinderMapComp {
     let graph = opts.graph;
     return {
-        id: "navigatorMap",
+        id: "pathfinderMap",
         get graph(): Graph | undefined {
             return graph;
         },
         set graph(value) {
             graph = value;
         },
         navigate(
-            this: GameObj<NavigationMapComp>,
+            this: GameObj<PathfinderMapComp>,
             origin: Vec2,
             target: Vec2,
             navigationOpt: any = {},
@@ -48,7 +48,7 @@ export function navigationMap(
     };
 }
 
-export interface NavigationComp extends Comp {
+export interface PathfinderComp extends Comp {
     /*
      * Get navigation waypoints to reach the given target from the current position.
      */
@@ -59,9 +59,9 @@ export interface NavigationComp extends Comp {
     graph: Graph | undefined;
 }
 
-export interface NavigationCompOpt {
+export interface PathfinderCompOpt {
     /*
-     * The graph to use for navigation. If null, the ancestors are queried for a navigatorMap component.
+     * The graph to use for navigation. If null, the ancestors are queried for a pathfinderMap component.
      */
     graph?: Graph;
     /*
@@ -70,15 +70,15 @@ export interface NavigationCompOpt {
     navigationOpt?: any;
 }
 
-export function navigation(
-    opts: NavigationCompOpt,
-): NavigationComp {
+export function pathfinder(
+    opts: PathfinderCompOpt,
+): PathfinderComp {
     let graph = opts.graph;
     return {
-        id: "navigator",
+        id: "pathfinder",
         require: ["pos"],
         navigateTo(
-            this: GameObj<NavigationComp | PosComp>,
+            this: GameObj<PathfinderComp | PosComp>,
             target: Vec2,
         ): Vec2[] | undefined {
             const graph: Graph | undefined = this.graph;
@@ -89,9 +89,9 @@ export function navigation(
                 return graph;
             }
             let parent: GameObj<any> | null =
-                (this as unknown as GameObj<NavigationComp>).parent;
+                (this as unknown as GameObj<PathfinderComp>).parent;
             while (parent) {
-                if (parent.is("navigatormap")) {
+                if (parent.is("pathfinderMap")) {
                     return parent.graph;
                 }
                 parent = parent.parent;

diff --git a/src/index.ts b/src/index.ts
@@ -57,16 +57,16 @@ export type {
     LifespanCompOpt,
     MaskComp,
     NamedComp,
-    NavigationComp,
-    NavigationCompOpt,
-    NavigationMapComp,
-    NavigationMapCompOpt,
     OffScreenComp,
     OffScreenCompOpt,
     OpacityComp,
     OutlineComp,
     ParticlesComp,
     ParticlesOpt,
+    PathfinderComp,
+    PathfinderCompOpt,
+    PathfinderMapComp,
+    PathfinderMapCompOpt,
     PatrolComp,
     PatrolCompOpt,
     PlatformEffectorComp,

diff --git a/src/kaplay.ts b/src/kaplay.ts
@@ -189,11 +189,11 @@ import {
     mask,
     move,
     named,
-    navigation,
     offscreen,
     opacity,
     outline,
     particles,
+    pathfinder,
     patrol,
     pointEffector,
     polygon,
@@ -1123,7 +1123,7 @@ const kaplay = <
         agent,
         sentry,
         patrol,
-        navigation,
+        pathfinder,
         // group events
         on,
         onFixedUpdate,

diff --git a/src/math/navigation.ts b/src/math/navigation.ts
@@ -1,4 +1,4 @@
-import { BinaryHeap } from "../utils/";
+import { BinaryHeap } from "../utils";
 import { Vec2 } from "./math";
 
 export interface Graph {

diff --git a/src/types.ts b/src/types.ts
@@ -40,12 +40,12 @@ import type {
     LifespanCompOpt,
     MaskComp,
     NamedComp,
-    NavigationComp,
-    NavigationCompOpt,
     OffScreenComp,
     OffScreenCompOpt,
     OpacityComp,
     OutlineComp,
+    PathfinderComp,
+    PathfinderCompOpt,
     PatrolComp,
     PatrolCompOpt,
     PointEffectorComp,
@@ -977,12 +977,12 @@ export interface KAPLAYCtx<
      */
     patrol(opts: PatrolCompOpt): PatrolComp;
     /**
-     * A navigator which can calculate waypoints to a goal.
+     * A navigator pathfinder which can calculate waypoints to a goal.
      *
      * @since v3001.0
      * @group Components
      */
-    navigation(opts: NavigationCompOpt): NavigationComp;
+    pathfinder(opts: PathfinderCompOpt): PathfinderComp;
     /**
      * @group Math
      */