refactor: create types for remaining metadata properties

Author: Jameskmonger

src/engine/world/actor/actor.ts

@@ -119,13 +119,13 @@ export abstract class Actor {
     // https://oldschool.runescape.wiki/w/Combat_level#:~:text=Calculating%20combat%20level,-Simply&text=Add%20your%20Strength%20and%20Attack,have%20your%20melee%20combat%20level.&text=Multiply%20this%20by%200.325%20and,have%20your%20magic%20combat%20level
     // https://oldschool.runescape.wiki/w/Damage_per_second/Melee#:~:text=1%20Step%20one%3A%20Calculate%20the%20effective%20strength%20level%3B,1.7%20Step%20seven%3A%20Calculate%20the%20melee%20damage%20output
     public getAttackRoll(defender): Attack {
-        
+
         //the amount of damage is random from 0 to Max
         //stance modifiers
         const _stance_defense = 3;
         const _stance_accurate = 0;
         const _stance_controlled = 1;
-        
+
         // base level
         // ToDo: calculate prayer effects
         // round decimal result calulcation up
@@ -141,7 +141,7 @@ export abstract class Actor {
 
             Effective strength level
             Multiply by(Equipment Melee Strength + 64)
-            Add 320 
+            Add 320
             Divide by 640
             Round down to nearest integer
             Multiply by gear bonus
@@ -221,7 +221,7 @@ export abstract class Actor {
         return attack;
         //+ stance modifier
     }
-    // #endregion  
+    // #endregion
 
     public damage(amount: number, damageType: DamageType = DamageType.DAMAGE) {
         const armorReduction = 0;
@@ -357,7 +357,7 @@ export abstract class Actor {
 
     public follow(target: Actor): void {
         this.face(target, false, false, false);
-        this.metadata['following'] = target;
+        this.metadata.following = target;
 
         this.moveBehind(target);
         const subscription = target.walkingQueue.movementEvent.subscribe(() => {
@@ -372,7 +372,7 @@ export abstract class Actor {
         ).subscribe(() => {
             subscription.unsubscribe();
             this.face(null);
-            delete this.metadata['following'];
+            delete this.metadata.following;
         });
     }
 
@@ -386,7 +386,7 @@ export abstract class Actor {
         if(distance <= 1) {
             return false;
         }
-        
+
         if(distance > 16) {
             this.clearFaceActor();
             this.metadata.faceActorClearedByWalking = true;
@@ -408,7 +408,7 @@ export abstract class Actor {
             return;
         }
 
-        this.metadata['tailing'] = target;
+        this.metadata.tailing = target;
 
         this.moveTo(target);
         const subscription = target.walkingQueue.movementEvent.subscribe(async () => this.moveTo(target));
@@ -419,7 +419,7 @@ export abstract class Actor {
         ).subscribe(() => {
             subscription.unsubscribe();
             this.face(null);
-            delete this.metadata['tailing'];
+            delete this.metadata.tailing;
         });
     }
 
@@ -434,8 +434,8 @@ export abstract class Actor {
             this.updateFlags.facePosition = face;
         } else if(face instanceof Actor) {
             this.updateFlags.faceActor = face;
-            this.metadata['faceActor'] = face;
-            this.metadata['faceActorClearedByWalking'] = clearedByWalking;
+            this.metadata.faceActor = face;
+            this.metadata.faceActorClearedByWalking = clearedByWalking;
 
             if(autoClear) {
                 setTimeout(() => {
@@ -451,9 +451,9 @@ export abstract class Actor {
     }
 
     public clearFaceActor(): void {
-        if(this.metadata['faceActor']) {
+        if(this.metadata.faceActor) {
             this.updateFlags.faceActor = null;
-            this.metadata['faceActor'] = undefined;
+            this.metadata.faceActor = undefined;
         }
     }
 

src/engine/world/actor/metadata.ts

@@ -1,4 +1,6 @@
 import { ConstructedRegion } from '../map';
+import { Position } from '../position';
+import { Actor } from './actor';
 
 /**
  * The definition of the metadata available on an {@link Actor}.
@@ -12,10 +14,41 @@ export type ActorMetadata = {
     /**
      * The custom constructed map region for this actor.
      *
-     * TODO Should this live on Actor rather than on {@link Player}? I don't think NPCs can have a custom map.
+     * TODO (jameskmonger) Should this live on Actor rather than on {@link Player}? I don't think NPCs can have a custom map.
      */
     customMap: ConstructedRegion;
 
+    /**
+     * The player's current target position.
+     *
+     * Used within the action pipeline.
+     */
+    walkingTo: Position;
+
+    /**
+     * The actor currently being `tailed` by this actor.
+     *
+     * TODO (jameskmonger) we should delete this - only used by deleted code in the old combat plugin
+     */
+    tailing: Actor;
+
+    /**
+     * The actor currently being followed by this actor.
+     */
+    following: Actor;
+
+    /**
+     * The actor which the local actor is facing towards.
+     */
+    faceActor: Actor;
+
+    /**
+     * Whether a walk action has cleared the actor which the local actor is facing towards.
+     *
+     * TODO (jameskmonger) does this belong on this metadata?
+     */
+    faceActorClearedByWalking: boolean;
+
     /**
      * Set to true if the actor is currently teleporting.
      */

src/engine/world/actor/player/metadata.ts

@@ -1,6 +1,7 @@
-import { Subscription } from 'rxjs';
+import { Subject, Subscription } from 'rxjs';
 import { Chunk } from '@engine/world/map';
 import { Position } from '@engine/world/position';
+import { LandscapeObject } from '@runejs/filestore';
 
 /**
  * The definition of the metadata directly available on a {@link Player}.
@@ -31,6 +32,15 @@ export type PlayerMetadata = {
      */
     lastPosition: Position;
 
+    /**
+     * Used to prevent the `object_interaction` pipe from running.
+     *
+     * TODO (jameskmonger) We should probably deprecate this, it seems like it's already been
+     *          replaced by the `busy` property which is itself deprecated. This is only
+     *          used in Goblin Diplomacy.
+     */
+    blockObjectInteractions: boolean;
+
     /**
      * The player's currently open shop.
      *
@@ -44,4 +54,57 @@ export type PlayerMetadata = {
      * Used to remove a player from a shop when they close the shop's widget.
      */
     shopCloseListener: Subscription;
+
+    /**
+     * Allows listening to a player clicking on the tab at the specified index.
+     *
+     * The `event` property is a `Subject` that will emit a `boolean` value when the player clicks on the tab.
+     *
+     * TODO (jameskmonger) This is only used in Goblin Diplomacy. It is only present when the player is taking part
+     *                  in Goblin Displomacy.
+     */
+    tabClickEvent: {
+        tabIndex: number;
+        event: Subject<boolean>;
+    };
+
+    /**
+     * Used to process dialogue trees.
+     */
+    dialogueIndices: Record<string, number>;
+
+    /**
+     * The player's current dialogue tree.
+     *
+     * This is a `ParsedDialogueTree` type, but that type is not exported.
+     */
+    dialogueTree: any;
+
+    /**
+     * A list of custom landscape objects that have been spawned by the player.
+     *
+     * Initialised by, and used by, the `spawn-scenery` command.
+     */
+    spawnedScenery: LandscapeObject[];
+
+    /**
+     * The last custom landscape object that was spawned by the player.
+     *
+     * Used to provide `undo` functionality to the `spawn-scenery` command.
+     */
+    lastSpawnedScenery: LandscapeObject;
+
+    /**
+     * The timestamp of the last time the player lit a fire.
+     *
+     * Used to prevent the player from lighting fires too quickly.
+     *
+     * TODO (jameskmonger) this should not be using Dates for timing and will be converted in the new task system
+     */
+    lastFire: number;
+
+    /**
+     * The ID of the player's currently open skill guide.
+     */
+    activeSkillGuide: number;
 };

src/engine/world/actor/walking-queue.ts

@@ -144,7 +144,7 @@ export class WalkingQueue {
 
         const walkPosition = this.queue.shift();
 
-        if(this.actor.metadata['faceActorClearedByWalking'] === undefined || this.actor.metadata['faceActorClearedByWalking']) {
+        if(this.actor.metadata.faceActorClearedByWalking === undefined || this.actor.metadata.faceActorClearedByWalking) {
             this.actor.clearFaceActor();
         }
 

src/plugins/skills/firemaking.plugin.ts

@@ -108,13 +108,13 @@ const lightFire = (player: Player, position: Position, worldItemLog: WorldItem,
 
     player.face(position, false);
     player.metadata.lastFire = Date.now();
-    player.metadata.busy = false;
+    player.busy = false;
 };
 
 const action: itemOnItemActionHandler = (details) => {
     const { player, usedItem, usedWithItem, usedSlot, usedWithSlot } = details;
 
-    if(player.metadata['lastFire'] && Date.now() - player.metadata['lastFire'] < 600) {
+    if(player.metadata.lastFire && Date.now() - player.metadata.lastFire < 600) {
         return;
     }
 
@@ -134,7 +134,7 @@ const action: itemOnItemActionHandler = (details) => {
     player.removeItem(removeFromSlot);
     const worldItemLog = player.instance.spawnWorldItem(log, player.position, { owner: player, expires: 300 });
 
-    if(player.metadata['lastFire'] && Date.now() - player.metadata['lastFire'] < 1200 &&
+    if(player.metadata.lastFire && Date.now() - player.metadata.lastFire < 1200 &&
         canChain(skillInfo.requiredLevel, player.skills.firemaking.level)) {
         lightFire(player, position, worldItemLog, skillInfo.experienceGained);
     } else {
@@ -151,7 +151,7 @@ const action: itemOnItemActionHandler = (details) => {
 
             if(canLightFire) {
                 loop.cancel();
-                player.metadata.busy = true;
+                player.busy = true;
                 setTimeout(() => lightFire(player, position, worldItemLog, skillInfo.experienceGained), 1200);
                 return;
             }

src/plugins/skills/skill-guides/skill-guides.plugin.ts

@@ -62,7 +62,7 @@ function loadGuide(player: Player, guideId: number, subGuideId: number = 0, refr
         slot: 'screen',
         multi: false
     });
-    player.metadata['activeSkillGuide'] = guideId;
+    player.metadata.activeSkillGuide = guideId;
 }
 
 export const guideHandler: buttonActionHandler = async (details) => {
@@ -82,7 +82,7 @@ export const subGuideHandler: widgetInteractionActionHandler = async (details) =
         guides = await loadSkillGuideConfigurations(skillGuidePath);
     }
 
-    const activeSkillGuide = player.metadata['activeSkillGuide'];
+    const activeSkillGuide = player.metadata.activeSkillGuide;
 
     if(!activeSkillGuide) {
         return;