refactor: add types for position-related metadata

Author: Jameskmonger

src/engine/world/actor/metadata.ts

@@ -1,3 +1,5 @@
+import { ConstructedRegion } from '../map';
+
 /**
  * The definition of the metadata available on an {@link Actor}.
  *
@@ -7,4 +9,10 @@
  * @author jameskmonger
  */
 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.
+     */
+    customMap: ConstructedRegion;
 };

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

@@ -1,3 +1,6 @@
+import { Chunk } from '@engine/world/map';
+import { Position } from '@engine/world/position';
+
 /**
  * The definition of the metadata directly available on a {@link Player}.
  *
@@ -9,4 +12,16 @@
  * @author jameskmonger
  */
 export type PlayerMetadata = {
+    /**
+     * The player's current and previous chunks.
+     */
+    updateChunk: {
+        oldChunk: Chunk;
+        newChunk: Chunk;
+    };
+
+    /**
+     * The player's last position before teleporting.
+     */
+    lastPosition: Position;
 };

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

@@ -429,16 +429,16 @@ export class Player extends Actor {
 
             this.outgoingPackets.flushQueue();
 
-            if(this.metadata['updateChunk']) {
-                const { newChunk, oldChunk } = this.metadata['updateChunk'];
+            if(this.metadata.updateChunk) {
+                const { newChunk, oldChunk } = this.metadata.updateChunk;
                 oldChunk.removePlayer(this);
                 newChunk.addPlayer(this);
                 this.chunkChanged(newChunk);
-                this.metadata['updateChunk'] = null;
+                this.metadata.updateChunk = null;
             }
 
-            if(this.metadata['teleporting']) {
-                this.metadata['teleporting'] = null;
+            if(this.metadata.teleporting) {
+                this.metadata.teleporting = null;
             }
 
             resolve();
@@ -677,9 +677,9 @@ export class Player extends Actor {
     public teleport(newPosition: Position, updateRegion: boolean = true): void {
         this.walkingQueue.clear();
         const originalPosition = this.position.copy();
-        this.metadata['lastPosition'] = originalPosition;
+        this.metadata.lastPosition = originalPosition;
         this.position = newPosition;
-        this.metadata['teleporting'] = true;
+        this.metadata.teleporting = true;
 
         this.updateFlags.mapRegionUpdateRequired = updateRegion;
         this.lastMapRegionUpdatePosition = newPosition;
@@ -690,7 +690,7 @@ export class Player extends Actor {
         if(!oldChunk.equals(newChunk)) {
             oldChunk.removePlayer(this);
             newChunk.addPlayer(this);
-            this.metadata['updateChunk'] = { newChunk, oldChunk };
+            this.metadata.updateChunk = { newChunk, oldChunk };
 
             if(updateRegion) {
                 this.actionPipeline.call('region_change', regionChangeActionFactory(

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

@@ -98,7 +98,7 @@ export function syncTrackedActors(packet: Packet, playerPosition: Position, appe
 
         if(exists && nearbyActors.findIndex(m => m.actor.equals(trackedActor)) !== -1
                 && trackedActor.position.withinViewDistance(playerPosition)
-                && !trackedActor.metadata['teleporting']) {
+                && !trackedActor.metadata.teleporting) {
             appendMovement(trackedActor, packet);
             appendUpdateMaskData(trackedActor);
             existingTrackedActors.push(trackedActor);

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

@@ -30,10 +30,10 @@ export class PlayerSyncTask extends SyncTask<void> {
 
             const updateMaskData = new ByteBuffer(5000);
 
-            if(updateFlags.mapRegionUpdateRequired || this.player.metadata['teleporting']) {
+            if(updateFlags.mapRegionUpdateRequired || this.player.metadata.teleporting) {
                 playerUpdatePacket.putBits(1, 1); // Update Required
                 playerUpdatePacket.putBits(2, 3); // Map Region changed (movement type - 0=nomove, 1=walk, 2=run, 3=mapchange
-                playerUpdatePacket.putBits(1, this.player.metadata['teleporting'] ? 1 : 0); // Whether or not the client should discard the current walking queue (1 if teleporting, 0 if not)
+                playerUpdatePacket.putBits(1, this.player.metadata.teleporting ? 1 : 0); // Whether or not the client should discard the current walking queue (1 if teleporting, 0 if not)
                 playerUpdatePacket.putBits(2, this.player.position.level); // Player Height
                 playerUpdatePacket.putBits(1, updateFlags.updateBlockRequired ? 1 : 0); // Whether or not an update flag block follows
                 playerUpdatePacket.putBits(7, this.player.position.chunkLocalX); // Player Local Chunk X

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

@@ -213,7 +213,7 @@ export class WalkingQueue {
 
             if(!oldChunk.equals(newChunk)) {
                 if(this.actor instanceof Player) {
-                    this.actor.metadata['updateChunk'] = { newChunk, oldChunk };
+                    this.actor.metadata.updateChunk = { newChunk, oldChunk };
 
                     this.actor.actionPipeline.call('region_change', regionChangeActionFactory(
                         this.actor, originalPosition, this.actor.position));

src/plugins/commands/travel-back-command.plugin.ts

@@ -4,8 +4,8 @@ import { Skill } from '@engine/world/actor/skills';
 const action: commandActionHandler = (details) => {
     const { player } = details;
 
-    if (player.metadata['lastPosition']) {
-        player.teleport(player.metadata['lastPosition']);
+    if (player.metadata.lastPosition) {
+        player.teleport(player.metadata.lastPosition);
     }
 };