Merge pull request #350 from runejs/feature/engine-package-cleanup

QoL and more Game Engine cleanup work

Author: Tynarus

src/game-engine/config/config-handler.ts

@@ -17,9 +17,8 @@ import { loadNpcSpawnConfigurations, NpcSpawn } from '@engine/config/npc-spawn-c
 import { loadShopConfigurations, Shop } from '@engine/config/shop-config';
 import { Quest } from '@engine/world/actor/player/quest';
 import { ItemSpawn, loadItemSpawnConfigurations } from '@engine/config/item-spawn-config';
-import { loadSkillGuideConfigurations, SkillGuide } from '@engine/config/skill-guide-config';
 import { loadMusicRegionConfigurations, MusicTrack } from '@engine/config/music-regions-config';
-import { LandscapeObject, loadXteaRegionFiles, ObjectConfig, XteaRegion } from '@runejs/filestore';
+import { loadXteaRegionFiles, ObjectConfig, XteaRegion } from '@runejs/filestore';
 
 require('json5/lib/register');
 
@@ -36,7 +35,6 @@ export let npcSpawns: NpcSpawn[] = [];
 export let musicRegions: MusicTrack[] = [];
 export let itemSpawns: ItemSpawn[] = [];
 export let shopMap: { [key: string]: Shop };
-export let skillGuides: SkillGuide[] = [];
 export let xteaRegions: { [key: number]: XteaRegion };
 
 export const musicRegionMap = new Map<number, number>();
@@ -65,12 +63,11 @@ export async function loadGameConfigurations(): Promise<void> {
     itemSpawns = await loadItemSpawnConfigurations('data/config/item-spawns/');
 
     shopMap = await loadShopConfigurations('data/config/shops/');
-    skillGuides = await loadSkillGuideConfigurations('data/config/skill-guides/');
 
     objectMap = {};
 
     logger.info(`Loaded ${musicRegions.length} music regions, ${Object.keys(itemMap).length} items, ${itemSpawns.length} item spawns, ` +
-        `${Object.keys(npcMap).length} npcs, ${npcSpawns.length} npc spawns, ${Object.keys(shopMap).length} shops and ${skillGuides.length} skill guides.`);
+        `${Object.keys(npcMap).length} npcs, ${npcSpawns.length} npc spawns, and ${Object.keys(shopMap).length} shops.`);
 }
 
 

src/game-engine/config/index.ts

@@ -7,4 +7,3 @@ export * from './npc-spawn-config';
 export * from './quest-config';
 export * from './server-config';
 export * from './shop-config';
-export * from './skill-guide-config';

src/game-engine/config/quest-config.ts

@@ -1,8 +1,6 @@
-import { Player } from '@engine/world/actor/player/player';
-import { Npc } from '@engine/world/actor/npc';
-import { npcInteractionActionHandler } from '@engine/world/action/npc-interaction.action';
 import { logger } from '@runejs/core';
-import { handleTutorial } from '@plugins/quests/goblin-diplomacy-tutorial/goblin-diplomacy-quest.plugin';
+import { Npc, Player } from '@engine/world/actor';
+import { npcInteractionActionHandler } from '@engine/world/action';
 
 
 export type QuestKey = number | 'complete';
@@ -42,7 +40,9 @@ export class PlayerQuest {
     }
 }
 
-export function questDialogueActionFactory(questId: string, npcDialogueHandler: QuestDialogueHandler): npcInteractionActionHandler {
+export function questDialogueActionFactory(questId: string,
+                                           npcDialogueHandler: QuestDialogueHandler,
+                                           stageHandler: (player: Player) => Promise<void>): npcInteractionActionHandler {
     return async({ player, npc }) => {
         const quest = player.getQuest(questId);
         if(!quest) {
@@ -58,7 +58,7 @@ export function questDialogueActionFactory(questId: string, npcDialogueHandler:
                 logger.error(e);
             }
 
-            await handleTutorial(player);
+            await stageHandler(player);
         }
     };
 }

src/game-engine/net/inbound-packet-handler.ts

@@ -23,7 +23,7 @@ export const PACKET_DIRECTORY = `${gameEngineDist}/net/inbound-packets`;
 export async function loadPackets(): Promise<Map<number, InboundPacket>> {
     incomingPackets.clear();
 
-    for await(const path of getFiles(PACKET_DIRECTORY, ['.js'], true)) {
+    for await(const path of getFiles(PACKET_DIRECTORY, ['.packet.js'], true)) {
         const location = './inbound-packets' + path.substring(PACKET_DIRECTORY.length).replace('.js', '');
         const packet = require(location).default;
         if (Array.isArray(packet)) {

src/game-engine/net/inbound-packets/add-friend-packet.js

@@ -0,0 +1,11 @@
+import { PacketData } from '@engine/net';
+import { longToString } from '@engine/util';
+import { Player } from '@engine/world/actor';
+
+
+export default {
+    opcode: 114,
+    size: 8,
+    handler: (player: Player, packet: PacketData) =>
+        player.addFriend(longToString(BigInt(packet.buffer.get('LONG'))))
+};

src/game-engine/net/inbound-packets/add-friend.packet.ts

@@ -0,0 +1,10 @@
+import { longToString } from '@engine/util';
+import { Player } from '@engine/world/actor';
+import { PacketData } from '@engine/net';
+
+export default {
+    opcode: 251,
+    size: 8,
+    handler: (player: Player, packet: PacketData) =>
+        player.addIgnoredPlayer(longToString(BigInt(packet.buffer.get('LONG'))))
+};

src/game-engine/net/inbound-packets/add-ignore-packet.js

@@ -1,6 +1,9 @@
-const blinkingTabClickPacket = (player, packet) => {
+import { Player } from '@engine/world/actor';
+import { PacketData } from '@engine/net';
+
+const blinkingTabClickPacket = (player: Player, packet: PacketData) => {
     const { buffer } = packet;
-    const tabIndex = buffer.get();
+    const tabIndex = buffer.get('byte');
 
     const tabClickEventIndex = player.metadata?.tabClickEvent?.tabIndex || -1;
 

src/game-engine/net/inbound-packets/add-ignore.packet.ts

@@ -1,4 +1,7 @@
-const buttonClickPacket = (player, packet) => {
+import { Player } from '@engine/world/actor';
+import { PacketData } from '@engine/net';
+
+const buttonClickPacket = (player: Player, packet: PacketData) => {
     const { buffer } = packet;
     const widgetId = buffer.get('short');
     const buttonId = buffer.get('short');