Merge pull request #181 from rune-js/feature/actor-following

Implementing a new follow action to make one actor follow another

Author: TheBlackParade

src/plugins/commands/follow-command.js

@@ -0,0 +1,9 @@
+import { ActionType } from '../plugin';
+import { world } from '../../game-server';
+import { followActor } from '../../world/actor/player/action/follow-action';
+
+module.exports = {
+    type: ActionType.COMMAND,
+    commands: 'follow',
+    action: details => followActor(details.player, world.npcList[0])
+};

src/plugins/player/follow-player-plugin.js

@@ -0,0 +1,8 @@
+import { ActionType } from '../plugin';
+import { followActor } from '../../world/actor/player/action/follow-action';
+
+module.exports = {
+    type: ActionType.PLAYER_ACTION,
+    options: 'follow',
+    action: details => followActor(details.player, details.otherPlayer)
+};

src/plugins/player/follow-player-plugin.ts

@@ -8,6 +8,8 @@ import { Position } from '@server/world/position';
 import { DirectionData, directionFromIndex } from '@server/world/direction';
 import { CombatAction } from '@server/world/actor/player/action/combat-action';
 import { Pathfinding } from '@server/world/actor/pathfinding';
+import { Subject } from 'rxjs';
+import { ActionCancelType } from '@server/world/actor/player/action/action';
 
 /**
  * Handles an actor within the game world.
@@ -30,6 +32,8 @@ export abstract class Actor {
     private _combatActions: CombatAction[];
     public pathfinding: Pathfinding;
     public lastMovementPosition: Position;
+    public readonly actionsCancelled: Subject<ActionCancelType>;
+    public readonly movementEvent: Subject<Position>;
 
     protected constructor() {
         this.updateFlags = new UpdateFlags();
@@ -43,6 +47,8 @@ export abstract class Actor {
         this._busy = false;
         this._combatActions = [];
         this.pathfinding = new Pathfinding(this);
+        this.actionsCancelled = new Subject<ActionCancelType>();
+        this.movementEvent = new Subject<Position>();
     }
 
     public damage(amount: number, damageType: DamageType = DamageType.DAMAGE): void {

src/world/actor/actor.ts

@@ -0,0 +1,42 @@
+import { Actor } from '@server/world/actor/actor';
+
+
+export const walkToActor = async (actor: Actor, target: Actor): Promise<boolean> => {
+    const distance = Math.floor(target.position.distanceBetween(actor.position));
+    if(distance > 16) {
+        actor.clearFaceActor();
+        actor.metadata.faceActorClearedByWalking = true;
+        throw new Error(`Distance too great!`);
+    }
+
+    let ignoreDestination = true;
+    let desiredPosition = target.position;
+    if(target.lastMovementPosition) {
+        desiredPosition = target.lastMovementPosition;
+        ignoreDestination = false;
+    }
+
+    await actor.pathfinding.walkTo(desiredPosition, {
+        pathingSearchRadius: distance + 2,
+        ignoreDestination
+    });
+
+    return Promise.resolve(true);
+};
+
+export const followActor = (follower: Actor, following: Actor): void => {
+    follower.face(following, false, false, false);
+
+    walkToActor(follower, following);
+
+    const subscription = following.movementEvent.subscribe(() => {
+        walkToActor(follower, following);
+    });
+    const actionCancelled = follower.actionsCancelled.subscribe(type => {
+        if(type !== 'pathing-movement') {
+            subscription.unsubscribe();
+            actionCancelled.unsubscribe();
+            follower.face(null);
+        }
+    });
+};

src/world/actor/player/action/follow-action.ts

@@ -101,9 +101,7 @@ export class Player extends Actor {
     public readonly dialogueInteractionEvent: Subject<number>;
     public readonly numericInputEvent: Subject<number>;
     private _walkingTo: Position;
-    public readonly movementEvent: Subject<Position>;
     private _nearbyChunks: Chunk[];
-    public readonly actionsCancelled: Subject<ActionCancelType>;
     private quadtreeKey: QuadtreeKey = null;
     public savedMetadata: { [key: string]: any } = {};
     public sessionMetadata: { [key: string]: any } = {};
@@ -131,9 +129,7 @@ export class Player extends Actor {
         this._equipment = new ItemContainer(14);
         this.dialogueInteractionEvent = new Subject<number>();
         this.numericInputEvent = new Subject<number>();
-        this.movementEvent = new Subject<Position>();
         this._nearbyChunks = [];
-        this.actionsCancelled = new Subject<ActionCancelType>();
 
         this.loadSaveData();
     }

src/world/actor/player/player.ts

@@ -208,8 +208,9 @@ export class WalkingQueue {
 
             const newChunk = world.chunkManager.getChunkForWorldPosition(this.actor.position);
 
+            this.actor.movementEvent.next(this.actor.position);
+
             if(this.actor instanceof Player) {
-                this.actor.movementEvent.next(this.actor.position);
                 const mapDiffX = this.actor.position.x - (lastMapRegionUpdatePosition.chunkX * 8);
                 const mapDiffY = this.actor.position.y - (lastMapRegionUpdatePosition.chunkY * 8);
                 if(mapDiffX < 16 || mapDiffX > 87 || mapDiffY < 16 || mapDiffY > 87) {