Merge github.com:runejs/server

Author: nicknick-io

.gitignore

@@ -22,3 +22,4 @@ yarn-error.log*
 *.njsproj
 *.sln
 *.sw?
+/.vs

src/game-engine/net/inbound-packets/widget-interaction-packet.js renamed to src/game-engine/net/inbound-packets/widget-interaction-packet.ts

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

src/game-engine/world/action/index.ts

@@ -61,10 +61,15 @@ export type ActionCancelType =
     | 'widget';
 
 
+/**
+ * The definition for the actual action pipe handler function.
+ */
+export type ActionPipeHandler = (...args: any[]) => RunnableHooks | void;
+
 /**
  * Basic definition of a game engine action file (.action.ts exports).
  */
-export type ActionPipe = [ ActionType, (...args: any[]) => void ];
+export type ActionPipe = [ ActionType, ActionPipeHandler ];
 
 
 /**
@@ -86,7 +91,7 @@ export interface RunnableHooks<T = any> {
  */
 export class ActionPipeline {
 
-    private static pipes = new Map<string, any>();
+    private static pipes = new Map<string, ActionPipeHandler>();
 
     private runningTasks: TaskExecutor<any>[] = [];
     private canceling: boolean = false;
@@ -97,12 +102,12 @@ export class ActionPipeline {
             .subscribe(async () => this.cancelRunningTasks());
     }
 
-    public static getPipe(action: ActionType): Map<string, any> {
+    public static getPipe(action: ActionType): ActionPipeHandler {
         return ActionPipeline.pipes.get(action);
     }
 
-    public static register(action: ActionType, actionPipe: (...args: any[]) => void): void {
-        ActionPipeline.pipes.set(action.toString(), actionPipe);
+    public static register(action: ActionType, actionPipeHandlerFn: ActionPipeHandler): void {
+        ActionPipeline.pipes.set(action.toString(), actionPipeHandlerFn);
     }
 
     public shutdown(): void {
@@ -113,7 +118,7 @@ export class ActionPipeline {
         const actionHandler = ActionPipeline.pipes.get(action.toString());
         if(actionHandler) {
             try {
-                await this.runActionHandler(actionHandler, ...args);
+                await this.runActionHandler(actionHandler, args);
             } catch(error) {
                 if(error) {
                     logger.error(`Error handling action ${action.toString()}`);
@@ -141,7 +146,7 @@ export class ActionPipeline {
         this.canceling = false;
     }
 
-    private async runActionHandler(actionHandler: any, ...args: any[]): Promise<void> {
+    private async runActionHandler(actionHandler: any, args: any[]): Promise<void> {
         const runnableHooks: RunnableHooks | null | undefined = await actionHandler(...args);
 
         if(!runnableHooks?.hooks || runnableHooks.hooks.length === 0) {
@@ -150,7 +155,6 @@ export class ActionPipeline {
 
         for(let i = 0; i < runnableHooks.hooks.length; i++) {
             const hook = runnableHooks.hooks[i];
-
             if(!hook) {
                 continue;
             }

src/game-engine/world/action/widget-interaction.action.ts

@@ -48,9 +48,10 @@ export interface WidgetInteractionAction {
  * @param optionId The widget context option chosen by the player.
  */
 const widgetActionPipe = (player: Player, widgetId: number, childId: number, optionId: number): RunnableHooks<WidgetInteractionAction> => {
-    const playerWidget = Object.values(player.interfaceState.widgetSlots).find((widget) => widget && widget.widgetId === widgetId);
+    const playerWidget = Object.values(player.interfaceState.widgetSlots)
+        .find((widget) => widget && widget.widgetId === widgetId);
 
-    if(playerWidget && playerWidget.fakeWidget != undefined) {
+    if(playerWidget?.fakeWidget) {
         widgetId = playerWidget.fakeWidget;
     }
 
@@ -86,9 +87,11 @@ const widgetActionPipe = (player: Player, widgetId: number, childId: number, opt
         return null;
     }
 
+    const action: WidgetInteractionAction = { player, widgetId, childId, optionId };
+
     return {
         hooks: matchingHooks,
-        action: { player, widgetId, childId, optionId }
+        action
     };
 };
 

src/plugins/items/rotten-potato/helpers/rotten-potato-helpers.ts

@@ -2,11 +2,12 @@ import { findItem, widgets } from '@engine/config';
 import { ItemDetails } from '@engine/config/item-config';
 import { Rights } from '@engine/world/actor/player/player';
 import { ItemOnItemAction } from '@engine/world/action/item-on-item.action';
+import { WidgetInteractionAction } from '@engine/world/action/widget-interaction.action';
 
 export const RottenPotatoItem: ItemDetails = findItem('rs:rotten_potato');
 
 
-export const ExecuteIfAdmin = (details: ItemOnItemAction, callback) => {
+export const ExecuteIfAdmin = (details: ItemOnItemAction | WidgetInteractionAction, callback) => {
     if(details.player.rights === Rights.ADMIN) {
         callback(details);
         return;

src/plugins/items/rotten-potato/rotten-potato.plugin.ts

@@ -6,6 +6,7 @@ import peelPotato from '@plugins/items/rotten-potato/hooks/rotten-potato-peel';
 import { potatoOnPlayer, potatoManipulatePlayerInventory } from '@plugins/items/rotten-potato/hooks/rotten-potato-item-on-player';
 import eatPotato from '@plugins/items/rotten-potato/hooks/rotten-potato-eat';
 import { travelMenuInteract } from '@plugins/items/rotten-potato/helpers/rotten-potato-travel';
+import { WidgetInteractionActionHook } from '@engine/world/action/widget-interaction.action';
 
 export default {
     pluginId: 'promises:rotten-potato',
@@ -52,8 +53,9 @@ export default {
         },
         {
             type: 'widget_interaction',
-            widgetId: 3100002,
+            widgetIds: 3100002,
             handler: (details) => ExecuteIfAdmin(details, travelMenuInteract),
-        }
+            multi: true
+        } as WidgetInteractionActionHook
     ]
 };

src/plugins/objects/crates/crates.plugin.ts

@@ -0,0 +1,37 @@
+import { findItem, widgets } from '@engine/config';
+import { objectInteractionActionHandler } from '@engine/world/action/object-interaction.action';
+import { World } from '@engine/world';
+import { itemIds } from '@engine/world/config/item-ids';
+import { LandscapeObject } from '@runejs/filestore';
+
+export const action: objectInteractionActionHandler = (details) => {
+    const veggies = [itemIds.onion, itemIds.grain, itemIds.cabbage];
+    details.player.busy = true;
+    details.player.playAnimation(827);
+    
+    const random = Math.floor(Math.random() * 3);  
+    const pickedItem = findItem(veggies[random]);
+    
+    details.player.outgoingPackets.sendUpdateAllWidgetItems(widgets.inventory, details.player.inventory);
+
+    setTimeout(() => {
+        details.player.sendMessage(`You found a ${pickedItem.name.toLowerCase()} chest!.`);
+        details.player.playSound(2581, 7);
+        details.player.instance.hideGameObjectTemporarily(details.object, 60);
+        details.player.giveItem(pickedItem.gameId);
+        details.player.busy = false;
+    }, World.TICK_LENGTH);
+};
+
+export default {
+    pluginId: 'rs:crates',
+    hooks: [
+        {
+            type: 'object_interaction',
+            objectIds: [ 366, 357, 355 ],
+            options: ['loot', 'search', 'examine' ],
+            walkTo: true,
+            handler: action
+        }
+    ]
+};

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

@@ -1,6 +1,9 @@
-import { buttonActionHandler } from '@engine/world/action/button.action';
+import { buttonActionHandler, ButtonActionHook } from '@engine/world/action/button.action';
 import { Player } from '@engine/world/actor/player/player';
-import { widgetInteractionActionHandler } from '@engine/world/action/widget-interaction.action';
+import {
+    widgetInteractionActionHandler,
+    WidgetInteractionActionHook
+} from '@engine/world/action/widget-interaction.action';
 import { skillGuides, widgets } from '@engine/config';
 import { SkillGuide, SkillSubGuide } from '@engine/config/skill-guide-config';
 
@@ -94,13 +97,13 @@ export default {
             widgetId: widgets.skillsTab,
             buttonIds,
             handler: guideHandler
-        },
+        } as ButtonActionHook,
         {
             type: 'widget_interaction',
             widgetIds: widgets.skillGuide,
             childIds: sidebarTextIds,
             optionId: 0,
             handler: subGuideHandler
-        }
+        } as WidgetInteractionActionHook
     ]
 };