Fixing teleporting not re-syncing players correctly in local chunks

Author: Tynarus

src/game-engine/world/action/hooks/task.ts

@@ -131,7 +131,9 @@ export class TaskExecutor<T> {
         this.running = false;
         this.intervalSubscription?.unsubscribe();
 
-        await this.task?.onComplete(this, this.iteration);
+        if(this.task?.onComplete) {
+            await this.task.onComplete(this, this.iteration);
+        }
 
         this.session = null;
     }

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

@@ -642,6 +642,8 @@ export class Player extends Actor {
         this.metadata['teleporting'] = true;
 
         if(!oldChunk.equals(newChunk)) {
+            oldChunk.removePlayer(this);
+            newChunk.addPlayer(this);
             this.metadata['updateChunk'] = { newChunk, oldChunk };
 
             this.actionPipeline.call('region_change', regionChangeActionFactory(

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

@@ -97,7 +97,8 @@ export function syncTrackedActors(packet: Packet, playerPosition: Position, appe
         }
 
         if(exists && nearbyActors.findIndex(m => m.actor.equals(trackedActor)) !== -1
-                && trackedActor.position.withinViewDistance(playerPosition)) {
+                && trackedActor.position.withinViewDistance(playerPosition)
+                && !trackedActor.metadata['teleporting']) {
             appendMovement(trackedActor, packet);
             appendUpdateMaskData(trackedActor);
             existingTrackedActors.push(trackedActor);
@@ -144,6 +145,6 @@ export function appendMovement(actor: Actor, packet: ByteBuffer): void {
 
 export abstract class SyncTask<T> {
 
-    public abstract async execute(): Promise<T>;
+    public abstract execute(): Promise<T>;
 
 }

src/plugins/buttons/magic-teleports.plugin.ts

@@ -1,10 +1,11 @@
-import { buttonActionHandler } from '@engine/world/action/button.action';
+import { ButtonAction, buttonActionHandler, ButtonActionHook } from '@engine/world/action/button.action';
 import { Player } from '@engine/world/actor/player/player';
 import { Position } from '@engine/world/position';
 import { animationIds } from '@engine/world/config/animation-ids';
 import { soundIds } from '@engine/world/config/sound-ids';
 import { gfxIds } from '@engine/world/config/gfx-ids';
 import { loopingEvent } from '@engine/game-server';
+import { TaskExecutor } from '@engine/world/action';
 
 enum Teleports {
     Home = 591,
@@ -22,57 +23,61 @@ const buttonIds: number[] = [
     591, // Home Teleport
 ];
 
-function homeTeleport(player: Player): void {
-    let elapsedTicks = 0;
+function homeTeleport(player: Player, elapsedTicks: number): boolean {
+    if (elapsedTicks === 0) {
+        player.playAnimation(animationIds.homeTeleportDraw);
+        player.playGraphics({ id: gfxIds.homeTeleportDraw, delay: 0, height: 0 });
+        player.outgoingPackets.playSound(soundIds.homeTeleportDraw, 10);
+    } else if (elapsedTicks === 7) {
+        player.playAnimation(animationIds.homeTeleportSit);
+        player.playGraphics({ id: gfxIds.homeTeleportFullDrawnCircle, delay: 0, height: 0 });
+        player.outgoingPackets.playSound(soundIds.homeTeleportSit, 10);
+    } else if (elapsedTicks === 12) {
+        player.playAnimation(animationIds.homeTeleportPullOutAndReadBook);
+        player.playGraphics({ id: gfxIds.homeTeleportPullOutBook, delay: 0, height: 0 });
+        player.outgoingPackets.playSound(soundIds.homeTeleportPullOutBook, 10);
+    } else if (elapsedTicks === 16) {
+        player.playAnimation(animationIds.homeTeleportReadBookAndGlowCircle);
+        player.playGraphics({ id: gfxIds.homeTeleportCircleGlow, delay: 0, height: 0 });
+        player.outgoingPackets.playSound(soundIds.homeTeleportCircleGlowAndTeleport, 10);
+    } else if (elapsedTicks === 20) {
+        player.playAnimation(animationIds.homeTeleport);
+        player.playGraphics({ id: gfxIds.homeTeleport, delay: 0, height: 0 });
+    } else if (elapsedTicks === 22) {
+        player.teleport(new Position(3218, 3218));
+        return true;
+    }
 
-    const loop = loopingEvent({ player });
-    loop.event.subscribe(() => {
-        if (elapsedTicks === 0) {
-            player.playAnimation(animationIds.homeTeleportDraw);
-            player.playGraphics({ id: gfxIds.homeTeleportDraw, delay: 0, height: 0 });
-            player.outgoingPackets.playSound(soundIds.homeTeleportDraw, 10);
-        }
-        if (elapsedTicks === 7) {
-            player.playAnimation(animationIds.homeTeleportSit);
-            player.playGraphics({ id: gfxIds.homeTeleportFullDrawnCircle, delay: 0, height: 0 });
-            player.outgoingPackets.playSound(soundIds.homeTeleportSit, 10);
-        }
-        if (elapsedTicks === 12) {
-            player.playAnimation(animationIds.homeTeleportPullOutAndReadBook);
-            player.playGraphics({ id: gfxIds.homeTeleportPullOutBook, delay: 0, height: 0 });
-            player.outgoingPackets.playSound(soundIds.homeTeleportPullOutBook, 10);
-        }
-        if (elapsedTicks === 16) {
-            player.playAnimation(animationIds.homeTeleportReadBookAndGlowCircle);
-            player.playGraphics({ id: gfxIds.homeTeleportCircleGlow, delay: 0, height: 0 });
-            player.outgoingPackets.playSound(soundIds.homeTeleportCircleGlowAndTeleport, 10);
-        }
-        if (elapsedTicks === 20) {
-            player.playAnimation(animationIds.homeTeleport);
-            player.playGraphics({ id: gfxIds.homeTeleport, delay: 0, height: 0 });
-        }
-        if (elapsedTicks === 22) {
-            player.teleport(new Position(3218, 3218));
-            loop.cancel();
-            return;
-        }
-        elapsedTicks++;
-    });
+    return false;
 }
 
-export const handler: buttonActionHandler = (details) => {
-    const { player, buttonId } = details;
+export const activate = (task: TaskExecutor<ButtonAction>, elapsedTicks: number = 0) => {
+    const { player, buttonId } = task.actionData;
+
+    let completed: boolean = false;
 
     switch (buttonId) {
         case Teleports.Home:
-            homeTeleport(player);
+            completed = homeTeleport(player, elapsedTicks);
             break;
     }
+
+    if(completed) {
+        task.stop();
+    }
 };
 
 export default {
     pluginId: 'rs:magic_teleports',
     hooks: [
-        { type: 'button', widgetId: 192, buttonIds: buttonIds, handler }
+        {
+            type: 'button',
+            widgetId: 192,
+            buttonIds: buttonIds,
+            task: {
+                activate,
+                interval: 1
+            }
+        } as ButtonActionHook
     ]
 };