Merge pull request #444 from DrJacobHolden/is-actor-type-guards

Convert isNpc and isPlayer to be type guards

Author: Katilith

src/engine/action/hook/task.ts

@@ -149,8 +149,8 @@ export class TaskExecutor<T> {
     public getDetails(): TaskDetails<T> {
         return {
             actor: this.actor,
-            player: this.actor.isPlayer ? this.actor as Player : undefined,
-            npc: this.actor.isNpc ? this.actor as Npc : undefined,
+            player: this.actor.isPlayer() ? this.actor : undefined,
+            npc: this.actor.isNpc() ? this.actor : undefined,
             actionData: this.actionData,
             session: this.session
         };

src/engine/world/actor/actor.ts

@@ -15,6 +15,8 @@ import { Task, TaskScheduler } from '@engine/task';
 import { logger } from '@runejs/common';
 import { ObjectConfig } from '@runejs/filestore';
 import { QueueableTask } from '@engine/action/pipe/task/queueable-task';
+import { Npc } from '@engine/world/actor/npc';
+import { Player } from '@engine/world/actor/player';
 
 
 export type ActorType = 'player' | 'npc';
@@ -355,8 +357,8 @@ export abstract class Actor {
             return;
         }
 
-        if(this.isNpc) {
-            const nearbyPlayers = activeWorld.findNearbyPlayers(this.position, 24, this.instance?.instanceId);
+        if(this.isNpc()) {
+            const nearbyPlayers = activeWorld.findNearbyPlayers(this.position, 24, this.instance.instanceId);
             if(nearbyPlayers.length === 0) {
                 // No need for this actor to move if there are no players nearby to witness it, save some memory. :)
                 return;
@@ -483,6 +485,14 @@ export abstract class Actor {
         this.scheduler.tick();
     }
 
+    public isPlayer(): this is Player {
+        return this.type === 'player';
+    }
+
+    public isNpc(): this is Npc {
+        return this.type === 'npc';
+    }
+
     public get position(): Position {
         return this._position;
     }
@@ -551,14 +561,6 @@ export abstract class Actor {
         this._instance = value;
     }
 
-    public get isPlayer(): boolean {
-        return this.type === 'player';
-    }
-
-    public get isNpc(): boolean {
-        return this.type === 'npc';
-    }
-
     public get bonuses(): { offensive: OffensiveBonuses, defensive: DefensiveBonuses, skill: SkillBonuses } {
         return this._bonuses;
     }

src/engine/world/actor/dialogue.ts

@@ -666,7 +666,7 @@ async function runParsedDialogue(player: Player, dialogueTree: ParsedDialogueTre
 
 export async function dialogue(participants: (Player | NpcParticipant)[], dialogueTree: DialogueTree,
     additionalOptions?: AdditionalOptions): Promise<boolean> {
-    const player = participants.find(p => p instanceof Player) as Player;
+    const player: Player | undefined = participants.find(p => p instanceof Player);
 
     if (!player) {
         throw new Error('Player instance not provided to dialogue action.');

src/engine/world/actor/player/sync/actor-sync.ts

@@ -86,8 +86,8 @@ export function syncTrackedActors(packet: Packet, playerPosition: Position, appe
         const trackedActor: Actor = trackedActors[i];
         let exists = true;
 
-        if(trackedActor instanceof Player) {
-            if(!activeWorld.playerOnline(trackedActor as Player)) {
+        if(trackedActor.isPlayer()) {
+            if(!activeWorld.playerOnline(trackedActor)) {
                 exists = false;
             }
         } else {

src/engine/world/actor/skills.ts

@@ -226,14 +226,14 @@ export class Skills extends SkillShortcuts {
 
         this.setExp(skill, finalExp);
 
-        if(this.actor instanceof Player) {
+        if(this.actor.isPlayer()) {
             this.actor.outgoingPackets.updateSkill(this.getSkillId(skill), finalLevel, finalExp);
         }
 
         if(currentLevel !== finalLevel) {
             this.setLevel(skill, finalLevel);
 
-            if(this.actor instanceof Player) {
+            if(this.actor.isPlayer()) {
                 const achievementDetails = skillDetails[this.getSkillId(skill)];
                 if(!achievementDetails) {
                     return;
@@ -262,11 +262,11 @@ export class Skills extends SkillShortcuts {
     }
 
     public showLevelUpDialogue(skill: number | SkillName, level: number): void {
-        if(!(this.actor instanceof Player)) {
+        if(!(this.actor.isPlayer())) {
             return;
         }
 
-        const player = this.actor as Player;
+        const player = this.actor;
         const achievementDetails = skillDetails[this.getSkillId(skill)];
         const widgetId = achievementDetails.advancementWidgetId;
 

src/engine/world/world.ts

@@ -113,15 +113,15 @@ export class World {
         let tileModifications;
         let personalTileModifications;
 
-        if(actor.isPlayer) {
-            const instance = (actor as Player).instance;
+        if(actor.isPlayer()) {
+            const instance = actor.instance;
 
             if (!instance) {
-                throw new Error(`Player ${(actor as Player).username} has no instance.`);
+                throw new Error(`Player ${actor.username} has no instance.`);
             }
 
             tileModifications = instance.getTileModifications(objectPosition);
-            personalTileModifications = (actor as Player).personalInstance.getTileModifications(objectPosition);
+            personalTileModifications = actor.personalInstance.getTileModifications(objectPosition);
         } else {
             tileModifications = this.globalInstance.getTileModifications(objectPosition);
         }
@@ -130,7 +130,7 @@ export class World {
         if(!landscapeObject) {
             const tileObjects = [ ...tileModifications.mods.spawnedObjects ];
 
-            if(actor.isPlayer) {
+            if(actor.isPlayer()) {
                 tileObjects.push(...personalTileModifications.mods.spawnedObjects);
             }
 
@@ -146,7 +146,7 @@ export class World {
 
         const hiddenTileObjects = [ ...tileModifications.mods.hiddenObjects ];
 
-        if(actor.isPlayer) {
+        if(actor.isPlayer()) {
             hiddenTileObjects.push(...personalTileModifications.mods.hiddenObjects);
         }