Adding support for named item actions for item plugins.

package.json

@@ -24,7 +24,7 @@
     "license": "GPL-3.0",
     "dependencies": {
         "@hapi/joi": "^16.1.8",
-        "@runejs/cache-parser": "0.3.0-rc.0",
+        "@runejs/cache-parser": "0.3.0",
         "@runejs/logger": "^1.0.0",
         "bigi": "^1.4.2",
         "body-parser": "^1.19.0",

src/net/incoming-packet-directory.ts

@@ -18,7 +18,7 @@ import { dropItemPacket } from '@server/net/incoming-packets/drop-item-packet';
 import { itemOnItemPacket } from '@server/net/incoming-packets/item-on-item-packet';
 import { widgetsClosedPacket } from '@server/net/incoming-packets/widgets-closed-packet';
 import { pickupItemPacket } from '@server/net/incoming-packets/pickup-item-packet';
-import { itemOption2Packet } from '@server/net/incoming-packets/item-option-2-packet';
+import { itemOption4Packet } from '@server/net/incoming-packets/item-option-4-packet';
 
 const ignore = [ 234, 160, 58 /* camera move */ ];
 
@@ -39,7 +39,7 @@ const packets: { [key: number]: incomingPacket } = {
     40:  itemOnItemPacket,
     102: itemEquipPacket,
     38:  itemOption1Packet,
-    98:  itemOption2Packet,
+    98:  itemOption4Packet,
     29:  dropItemPacket,
     85:  pickupItemPacket,
 

src/net/incoming-packets/item-option-1-packet.ts

@@ -2,15 +2,17 @@ import { incomingPacket } from '../incoming-packet';
 import { RsBuffer } from '@server/net/rs-buffer';
 import { Player } from '../../world/actor/player/player';
 import { itemAction } from '@server/world/actor/player/action/item-action';
+import { getItemOption } from '@server/world/items/item';
 
 export const itemOption1Packet: incomingPacket = (player: Player, packetId: number, packetSize: number, packet: RsBuffer): void => {
     const itemId = packet.readNegativeOffsetShortBE();
     const slot = packet.readShortLE();
     const widgetId = packet.readShortLE();
     const containerId = packet.readShortLE();
 
-    // @TODO parse widgets and find actual item option NAME to pass to this
-    itemAction(player, itemId, slot, widgetId, containerId, 'option-1');
+    const option = getItemOption(itemId, 1, { widgetId, containerId });
+
+    itemAction(player, itemId, slot, widgetId, containerId, option);
 
     /*
     // Handles the value option in shops.
@@ -56,4 +58,5 @@ export const itemOption1Packet: incomingPacket = (player: Player, packetId: numb
     if(widgetId === widgetIds.equipment.widgetId && containerId === widgetIds.equipment.containerId) {
         unequipItemAction(player, itemId, slot);
     }*/
+
 };

src/net/incoming-packets/item-option-4-packet.ts

@@ -0,0 +1,28 @@
+import { incomingPacket } from '../incoming-packet';
+import { RsBuffer } from '@server/net/rs-buffer';
+import { Player } from '../../world/actor/player/player';
+import { itemAction } from '@server/world/actor/player/action/item-action';
+import { getItemOption } from '@server/world/items/item';
+
+export const itemOption4Packet: incomingPacket = (player: Player, packetId: number, packetSize: number, packet: RsBuffer): void => {
+    const slot = packet.readShortBE();
+    const widgetId = packet.readShortLE();
+    const containerId = packet.readShortLE();
+    const itemId = packet.readShortBE();
+    // packet.readNegativeOffsetShortBE();
+    // packet.readUnsignedShortLE();
+    // packet.readShortLE(); // either widget id or container id
+    // packet.readShortLE(); // either widget id or container id
+    //
+    // Class32.packetBuffer.putShortBE(i);
+    // Class32.packetBuffer.putIntME1(i_10_);
+    // Class32.packetBuffer.putShortBE(i_12_);
+    //
+    // Class32.packetBuffer.putCustomNegativeOffsetShortBE(i_12_, -128);
+    // Class32.packetBuffer.putShortLE(i);
+    // Class32.packetBuffer.putIntME1(i_10_);
+
+    const option = getItemOption(itemId, 4, { widgetId, containerId });
+
+    itemAction(player, itemId, slot, widgetId, containerId, option);
+};

src/plugins/equipment/unequip-item-plugin.ts

@@ -44,7 +44,7 @@ export default new RunePlugin({
         widgets.equipment,
         widgets.equipmentStats
     ],
-    options: 'option-1',
+    options: 'remove',
     action,
     cancelOtherActions: false
 });

src/plugins/items/buckets/empty-bucket-plugin.ts

@@ -24,7 +24,7 @@ export const action: itemAction = (details) => {
 export default new RunePlugin({
     type: ActionType.ITEM_ACTION,
     widgets: widgets.inventory,
-    options: 'option-2',
+    options: 'empty',
     itemIds: [itemIds.bucketOfMilk, itemIds.bucketOfWater],
     action,
     cancelOtherActions: false

src/world/items/item.ts

@@ -1,4 +1,54 @@
+import { gameCache } from '@server/game-server';
+
 export interface Item {
     itemId: number;
     amount: number;
 }
+
+function itemInventoryOptions(itemId: number): string[] {
+    const itemDefinition = gameCache.itemDefinitions.get(itemId);
+    if(!itemDefinition) {
+        return [];
+    }
+
+    return itemDefinition.inventoryOptions;
+}
+
+export const getItemOptions = (itemId: number, widget: { widgetId: number, containerId: number }): string[] => {
+    const widgetDefinition = gameCache.widgetDefinitions.get(widget.widgetId);
+    if(!widgetDefinition || !widgetDefinition.children || widgetDefinition.children.length <= widget.containerId) {
+        return itemInventoryOptions(itemId);
+    }
+
+    const widgetChild = widgetDefinition.children[widget.containerId];
+    if(!widgetChild || !widgetChild.items || !widgetChild.options) {
+        return itemInventoryOptions(itemId);
+    }
+
+    let hasWidgetOptions = false;
+    for(const option of widgetChild.options) {
+        if(option) {
+            hasWidgetOptions = true;
+        }
+    }
+
+    if(!hasWidgetOptions) {
+        return itemInventoryOptions(itemId);
+    }
+
+    return widgetChild.options;
+};
+
+export const getItemOption = (itemId: number, optionNumber: number, widget: { widgetId: number, containerId: number }): string => {
+    const optionIndex = optionNumber - 1;
+    const options = getItemOptions(itemId, widget);
+    let option = 'option-' + optionNumber;
+
+    if(options && options.length >= optionNumber) {
+        if(options[optionIndex] !== null && options[optionIndex].toLowerCase() !== 'hidden') {
+            option = options[optionIndex].toLowerCase();
+        }
+    }
+
+    return option;
+};