Add support for multi-opcode packets

package.json

@@ -1,54 +1,54 @@
-{
-	"name": "@ffxiv-teamcraft/pcap-ffxiv",
-	"version": "0.11.4",
-	"description": "A Machina wrapper for FINAL FANTASY XIV packet capture in JS/TS.",
-	"main": "lib/index.js",
-	"repository": "https://github.com/ffxiv-teamcraft/pcap-ffxiv.git",
-	"author": "karashiiro <49822414+karashiiro@users.noreply.github.com>",
-	"license": "MIT",
-	"scripts": {
-		"prebuild": "rimraf lib/* && yarn pcap-types:generate && yarn copyfiles && node prebuild.js",
-		"build": "yarn prebuild && tsc",
-		"build:watch": "yarn prebuild && tsc -w",
-		"docs:generate": "typedoc",
-		"docs:deploy": "yarn docs:generate && node gh-pages.js",
-		"prepublish": "yarn format && yarn build && yarn docs:deploy && node gh-pages.js",
-		"format": "prettier . --write",
-		"copyfiles": "copyfiles ./MachinaWrapper/* ./lib",
-		"pcap-types:generate": "barrelsby -D -d ./src/definitions && barrelsby -D -d ./src/models"
-	},
-	"files": [
-		"lib/"
-	],
-	"eslintConfig": {
-		"extends": [
-			"prettier"
-		],
-		"env": {
-			"es11": true
-		}
-	},
-	"prettier": {
-		"singleQuote": false,
-		"printWidth": 120,
-		"semi": true,
-		"useTabs": true,
-		"trailingComma": "all",
-		"endOfLine": "crlf"
-	},
-	"devDependencies": {
-		"@types/node": "^14.14.19",
-		"barrelsby": "^2.2.0",
-		"copyfiles": "^2.4.1",
-		"eslint": "^7.17.0",
-		"eslint-config-prettier": "^7.1.0",
-		"gh-pages": "^3.1.0",
-		"prettier": "^2.2.1",
-		"rimraf": "^3.0.2",
-		"typedoc": "^0.20.35",
-		"typescript": "^4.1.3"
-	},
-	"dependencies": {
-		"heap-js": "^2.1.5"
-	}
-}
+{
+	"name": "@ffxiv-teamcraft/pcap-ffxiv",
+	"version": "0.11.4",
+	"description": "A Machina wrapper for FINAL FANTASY XIV packet capture in JS/TS.",
+	"main": "lib/index.js",
+	"repository": "https://github.com/ffxiv-teamcraft/pcap-ffxiv.git",
+	"author": "karashiiro <49822414+karashiiro@users.noreply.github.com>",
+	"license": "MIT",
+	"scripts": {
+		"prebuild": "rimraf lib/* && yarn pcap-types:generate && yarn copyfiles && node prebuild.js",
+		"build": "yarn prebuild && tsc",
+		"build:watch": "yarn prebuild && tsc -w",
+		"docs:generate": "typedoc",
+		"docs:deploy": "yarn docs:generate && node gh-pages.js",
+		"prepublish": "yarn format && yarn build && yarn docs:deploy && node gh-pages.js",
+		"format": "prettier . --write",
+		"copyfiles": "copyfiles ./MachinaWrapper/* ./lib",
+		"pcap-types:generate": "barrelsby -D -d ./src/definitions && barrelsby -D -d ./src/models"
+	},
+	"files": [
+		"lib/"
+	],
+	"eslintConfig": {
+		"extends": [
+			"prettier"
+		],
+		"env": {
+			"es11": true
+		}
+	},
+	"prettier": {
+		"singleQuote": false,
+		"printWidth": 120,
+		"semi": true,
+		"useTabs": true,
+		"trailingComma": "all",
+		"endOfLine": "lf"
+	},
+	"devDependencies": {
+		"@types/node": "^14.14.19",
+		"barrelsby": "^2.2.0",
+		"copyfiles": "^2.4.1",
+		"eslint": "^7.17.0",
+		"eslint-config-prettier": "^7.1.0",
+		"gh-pages": "^3.1.0",
+		"prettier": "^2.2.1",
+		"rimraf": "^3.0.2",
+		"typedoc": "^0.20.35",
+		"typescript": "^4.1.3"
+	},
+	"dependencies": {
+		"heap-js": "^2.1.5"
+	}
+}

prebuild.js

@@ -74,14 +74,14 @@ function generateInterfaces(processors, parentInterfaceName, excludeImports) {
 function createMessageType() {
 	const { processors } = generateImportsAndProcessors("processors");
 	const actorControlProcessors = generateImportsAndProcessors("processors/actor-control").processors;
-	const resultDialogProcessors = generateImportsAndProcessors("processors/result-dialog").processors;
+	const eventResumeProcessors = generateImportsAndProcessors("processors/event-resume").processors;
 
 	const entries = [
 		...generateInterfaces(processors),
 		...generateInterfaces(actorControlProcessors, "ActorControl"),
 		...generateInterfaces(actorControlProcessors, "ActorControlSelf", true),
 		...generateInterfaces(actorControlProcessors, "ActorControlTarget", true),
-		...generateInterfaces(resultDialogProcessors, "ResultDialog"),
+		...generateInterfaces(eventResumeProcessors, "EventResume"),
 	];
 
 	const fileContent = `import { GenericMessage } from "./GenericMessage";
@@ -116,12 +116,12 @@ createProcessorsLoader(
 );
 
 createProcessorsLoader(
-	"result-dialog-packet-processors",
-	"resultDialogPacketProcessors",
-	"processors/result-dialog",
-	"SuperPacketProcessor<ResultDialog>",
+	"event-resume-packet-processors",
+	"eventResumePacketProcessors",
+	"processors/event-resume",
+	"SuperPacketProcessor<EventResume>",
 	"SuperPacketProcessor",
-	[`import { ResultDialog } from "../definitions";`],
+	[`import { EventResume } from "../definitions";`],
 );
 
 createMessageType();

src/definitions/EventResume.ts

@@ -0,0 +1,9 @@
+import { EventHandlerType } from "../models";
+import { SuperPacket } from "../models/SuperPacket";
+
+export interface EventResume extends SuperPacket {
+	category: EventHandlerType;
+	subcategory: number;
+	scene: number;
+	params: Array<number>;
+}

src/definitions/event-resume/DesynthResult.ts

@@ -0,0 +1,14 @@
+import { EventResume } from "../EventResume";
+
+export interface DesynthResult extends EventResume {
+	itemId: number;
+	itemHq: boolean;
+	result: {
+		itemId: number;
+		itemHq: boolean;
+		itemQuantity: number;
+	}[];
+	unknown: boolean;
+	unknown2: number; // TODO: Gather data, probably ClassJobId for skill up
+	unknown3: number; // TODO: Gather data, probably experience gained
+}

src/definitions/event-resume/ReductionResult.ts

@@ -0,0 +1,11 @@
+import { EventResume } from "../EventResume";
+
+export interface ReductionResult extends EventResume {
+	itemId: number;
+	unknown: boolean;
+	result: {
+		itemId: number;
+		itemHq: boolean;
+		itemQuantity: number;
+	}[];
+}

src/definitions/event-resume/RetrieveMateriaResult.ts

@@ -0,0 +1,17 @@
+import { EventResume } from "../EventResume";
+
+export enum RetrieveMateriaOutcome {
+	InventoryFull = "inventoryfull",
+	Shattered = "shattered",
+	Retrieved = "retrieved",
+
+	Unknown = "unknown",
+}
+
+export interface RetrieveMateriaResult extends EventResume {
+	outcome: RetrieveMateriaOutcome;
+
+	itemId: number;
+	itemHq: boolean;
+	materiaId: number;
+}

src/definitions/event-resume/TalkEvent.ts

@@ -0,0 +1,3 @@
+import { EventResume } from "../EventResume";
+
+export interface TalkEvent extends EventResume {}

src/definitions/result-dialog/MarketTaxRates.ts → src/definitions/event-resume/talk-event/MarketTaxRates.ts

@@ -1,10 +1,11 @@
-export interface MarketTaxRates {
-	category: number;
-	limsaLominsa: number;
-	gridania: number;
-	uldah: number;
-	ishgard: number;
-	kugane: number;
-	crystarium: number;
-	oldSharlayan: number;
-}
+import { TalkEvent } from "../TalkEvent";
+
+export interface MarketTaxRates extends TalkEvent {
+	limsaLominsa: number;
+	gridania: number;
+	uldah: number;
+	ishgard: number;
+	kugane: number;
+	crystarium: number;
+	oldSharlayan: number;
+}

src/definitions/index.ts

@@ -28,7 +28,6 @@ export * from "./ContainerInfo";
 export * from "./CraftingLog";
 export * from "./CurrencyCrystalInfo";
 export * from "./DesynthOrReductionResult";
-export * from "./DesynthResult";
 export * from "./EffectResult";
 export * from "./EorzeaTimeOffset";
 export * from "./EquipDisplayFlags";
@@ -38,6 +37,7 @@ export * from "./EventPlay32";
 export * from "./EventPlay4";
 export * from "./EventPlay8";
 export * from "./EventPlayN";
+export * from "./EventResume";
 export * from "./EventStart";
 export * from "./FreeCompanyDialog";
 export * from "./FreeCompanyInfo";
@@ -67,8 +67,6 @@ export * from "./PlayerStats";
 export * from "./PlayTime";
 export * from "./Position3";
 export * from "./PrepareZoning";
-export * from "./ReductionResult";
-export * from "./ResultDialog";
 export * from "./RetainerInformation";
 export * from "./ServerNotice";
 export * from "./StatusEffectList";
@@ -93,4 +91,8 @@ export * from "./actor-control/SetMountSpeed";
 export * from "./actor-control/StatusEffectLose";
 export * from "./actor-control/ToggleWeapon";
 export * from "./actor-control/UpdateRestedExp";
-export * from "./result-dialog/MarketTaxRates";
+export * from "./event-resume/DesynthResult";
+export * from "./event-resume/ReductionResult";
+export * from "./event-resume/RetrieveMateriaResult";
+export * from "./event-resume/TalkEvent";
+export * from "./event-resume/talk-event/MarketTaxRates";

src/models/EventHandlerType.ts

@@ -0,0 +1,7 @@
+export enum EventHandlerType {
+	TalkEvent = 0xb0009,
+
+	DesynthesisResult = 0x390000,
+	RetrieveMateriaResult = 0x390001,
+	ReductionResult = 0x390002,
+}