feat: allow ActorWalkToTask to accept a LandscapeObject as a target

Author: Jameskmonger

src/engine/task/impl/actor-landscape-object-interaction-task.ts

@@ -1,6 +1,6 @@
+import { LandscapeObject } from '@runejs/filestore';
 import { activeWorld, Position } from '@engine/world';
 import { Actor } from '@engine/world/actor';
-import { LandscapeObject } from '@runejs/filestore';
 import { ActorWalkToTask } from './actor-walk-to-task';
 
 /**
@@ -11,8 +11,9 @@ import { ActorWalkToTask } from './actor-walk-to-task';
  *
  * @author jameskmonger
  */
-export abstract class ActorLandscapeObjectInteractionTask<TActor extends Actor = Actor> extends ActorWalkToTask<TActor> {
+export abstract class ActorLandscapeObjectInteractionTask<TActor extends Actor = Actor> extends ActorWalkToTask<TActor, LandscapeObject> {
     private _landscapeObject: LandscapeObject;
+    private _objectPosition: Position;
 
     /**
      * Gets the {@link LandscapeObject} that this task is interacting with.
@@ -37,6 +38,19 @@ export abstract class ActorLandscapeObjectInteractionTask<TActor extends Actor =
         return this._landscapeObject;
     }
 
+    /**
+     * Get the position of this task's landscape object
+     *
+     * @returns The position of this task's landscape object, or null if the landscape object is not present
+     */
+    protected get landscapeObjectPosition(): Position {
+        if (!this._landscapeObject) {
+            return null;
+        }
+
+        return this._objectPosition;
+    }
+
     /**
      * @param actor The actor executing this task.
      * @param landscapeObject The landscape object to interact with.
@@ -51,7 +65,7 @@ export abstract class ActorLandscapeObjectInteractionTask<TActor extends Actor =
     ) {
         super(
             actor,
-            new Position(landscapeObject.x, landscapeObject.y, landscapeObject.level),
+            landscapeObject,
             Math.max(sizeX, sizeY)
         );
 
@@ -60,6 +74,8 @@ export abstract class ActorLandscapeObjectInteractionTask<TActor extends Actor =
             return;
         }
 
+        // create the Position here to prevent instantiating a new Position every tick
+        this._objectPosition = new Position(landscapeObject.x, landscapeObject.y, landscapeObject.level);
         this._landscapeObject = landscapeObject;
     }
 
@@ -80,7 +96,7 @@ export abstract class ActorLandscapeObjectInteractionTask<TActor extends Actor =
             return;
         }
 
-        const { object: worldObject } = activeWorld.findObjectAtLocation(this.actor, this._landscapeObject.objectId, this.destination);
+        const { object: worldObject } = activeWorld.findObjectAtLocation(this.actor, this._landscapeObject.objectId, this._objectPosition);
 
         if (!worldObject) {
             this.stop();

src/engine/task/impl/actor-walk-to-task.ts

@@ -1,3 +1,4 @@
+import { LandscapeObject } from '@runejs/filestore';
 import { Position } from '@engine/world/position';
 import { Actor } from '@engine/world/actor';
 import { TaskStackType, TaskBreakType, TaskStackGroup } from '../types';
@@ -11,7 +12,7 @@ import { ActorTask } from './actor-task';
  *
  * @author jameskmonger
  */
-export interface ActorWalkToTask<TActor extends Actor = Actor> extends ActorTask<TActor> {
+export interface ActorWalkToTask<TActor extends Actor = Actor, TTarget extends LandscapeObject | Position = Position> extends ActorTask<TActor> {
     /**
      * An optional function that is called when the actor arrives at the destination.
      */
@@ -26,7 +27,7 @@ export interface ActorWalkToTask<TActor extends Actor = Actor> extends ActorTask
  *
  * @author jameskmonger
  */
-export abstract class ActorWalkToTask<TActor extends Actor = Actor> extends ActorTask<TActor> {
+export abstract class ActorWalkToTask<TActor extends Actor = Actor, TTarget extends LandscapeObject | Position = Position> extends ActorTask<TActor> {
     private _atDestination: boolean = false;
 
     /**
@@ -43,7 +44,7 @@ export abstract class ActorWalkToTask<TActor extends Actor = Actor> extends Acto
      */
     constructor (
         actor: TActor,
-        protected readonly destination: Position,
+        protected readonly destination: TTarget,
         protected readonly distance = 1,
     ) {
         super(
@@ -58,7 +59,11 @@ export abstract class ActorWalkToTask<TActor extends Actor = Actor> extends Acto
             }
         );
 
-        this.actor.pathfinding.walkTo(destination, { })
+        if(destination instanceof Position) {
+            this.actor.pathfinding.walkTo(destination, { })
+        } else {
+            this.actor.pathfinding.walkTo(new Position(destination.x, destination.y), { })
+        }
     }
 
     /**