refactor: add type for client config (varp) in metadata

Author: Jameskmonger

src/engine/net/inbound-packets/item-on-object.packet.ts

@@ -47,12 +47,12 @@ const itemOnObjectPacket = (player: Player, packet: PacketData) => {
         let morphIndex = -1;
         if(objectConfig.varbitId === -1) {
             if(objectConfig.configId !== -1) {
-                const configValue = player.metadata['configs'] && player.metadata['configs'][objectConfig.configId] ? player.metadata['configs'][objectConfig.configId] : 0;
+                const configValue = player.metadata.configs && player.metadata.configs[objectConfig.configId] ? player.metadata.configs[objectConfig.configId] : 0;
                 morphIndex = configValue;
 
             }
         } else {
-            morphIndex = getVarbitMorphIndex(objectConfig.varbitId, player.metadata['configs']);
+            morphIndex = getVarbitMorphIndex(objectConfig.varbitId, player.metadata.configs);
         }
         if(morphIndex !== -1) {
             objectConfig = filestore.configStore.objectStore.getObject(objectConfig.configChangeDest[morphIndex]);

src/engine/net/inbound-packets/object-interaction.packet.ts

@@ -85,11 +85,11 @@ const objectInteractionPacket = (player: Player, packet: PacketData) => {
         let morphIndex = -1;
         if(objectConfig.varbitId === -1) {
             if(objectConfig.configId !== -1) {
-                morphIndex = player.metadata['configs'] && player.metadata['configs'][objectConfig.configId] ?
-                    player.metadata['configs'][objectConfig.configId] : 0;
+                morphIndex = player.metadata.configs && player.metadata.configs[objectConfig.configId] ?
+                    player.metadata.configs[objectConfig.configId] : 0;
             }
         } else {
-            morphIndex = getVarbitMorphIndex(objectConfig.varbitId, player.metadata['configs']);
+            morphIndex = getVarbitMorphIndex(objectConfig.varbitId, player.metadata.configs);
         }
         if(morphIndex !== -1) {
             objectConfig = filestore.configStore.objectStore.getObject(objectConfig.configChangeDest[morphIndex]);

src/engine/net/outbound-packet-handler.ts

@@ -71,7 +71,7 @@ export class OutboundPacketHandler {
 
     public sendProjectile(position: Position, offsetX: number, offsetY: number, id: number, startHeight: number, endHeight: number, speed: number, lockon: number, delay: number) {
         this.updateReferencePosition(position);
-        
+
         const packet = new Packet(1);
         packet.put(0);
         packet.put(offsetY, 'byte');
@@ -85,7 +85,8 @@ export class OutboundPacketHandler {
         packet.put(16);
         packet.put(64);
         this.queue(packet);
-    } 
+    }
+
     public updateFriendStatus(friendName: string, worldId: number): void {
         const packet = new Packet(156);
         packet.put(stringToLong(friendName.toLowerCase()), 'LONG');
@@ -278,8 +279,8 @@ export class OutboundPacketHandler {
     public updateClientConfig(configId: number, value: number): void {
         let packet: Packet;
         const metadata = this.player.metadata;
-        if(!metadata['configs']) {
-            metadata['configs'] = []
+        if(!metadata.configs) {
+            metadata.configs = []
         }
         metadata.configs[configId] = value;
 

src/engine/world/actor/metadata.ts

@@ -15,4 +15,9 @@ export type ActorMetadata = {
      * TODO Should this live on Actor rather than on {@link Player}? I don't think NPCs can have a custom map.
      */
     customMap: ConstructedRegion;
+
+    /**
+     * Set to true if the actor is currently teleporting.
+     */
+    teleporting: boolean;
 };

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

@@ -12,6 +12,11 @@ import { Position } from '@engine/world/position';
  * @author jameskmonger
  */
 export type PlayerMetadata = {
+    /**
+     * The player's client configuration options (varps).
+     */
+    configs: number[];
+
     /**
      * The player's current and previous chunks.
      */

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

@@ -1087,9 +1087,9 @@ export class Player extends Actor {
 
         let morphIndex: number;
         if (originalNpc.varbitId !== -1) {
-            morphIndex = getVarbitMorphIndex(originalNpc.varbitId, this.metadata['configs']);
+            morphIndex = getVarbitMorphIndex(originalNpc.varbitId, this.metadata.configs);
         } else if (originalNpc.settingId !== -1) {
-            morphIndex = this.metadata['configs'] && this.metadata['configs'][originalNpc.settingId] ? this.metadata['configs'][originalNpc.settingId] : 0;
+            morphIndex = this.metadata.configs && this.metadata.configs[originalNpc.settingId] ? this.metadata.configs[originalNpc.settingId] : 0;
         } else {
             logger.warn(`Tried to fetch a child NPC index, but but no varbitId or settingId were found in the NPC details. NPC: ${originalNpc.id}, childrenIDs: ${originalNpc.childrenIds}`);
             return null;