util: add basic support for CEs to encounter_tools

This is a basic initial attempt at supporting critical encounters and
critical engagements from the encounter tools. It relies on the CE
information we recently started generating from the xivapi, as well as
the DirectorUpdate IDs pulled by hand.

It does appear to work properly at least as far as finding encounters
go. It does at least log the encounter name based off its English
translation.

There is likely more work required to verify that no other encounter
logic breaks. Additionally, we might want to improve the make_timeline
support to use the 0x21 log line as an entry check, since this is what
we do in the timeline files that support critical encounters.

This code was originally based on work from Valarnin, but its been
heavily modified to now pull the CE data from the xivapi. This version
only accepts CEs that match the zone we're in so it should have minimal
chance of breaking other flows. I did end up hard coding the
association of zone to encounter list, which could possibly be improved
somehow.

Signed-off-by: Jacob Keller <[email protected]>

Author: jacob-keller

util/logtools/encounter_tools.ts

@@ -1,9 +1,16 @@
+import BozjaDirectorIds from '../../resources/bozja_ce_map';
+import BozjaCEs from '../../resources/bozja_encounters';
 import ContentType from '../../resources/content_type';
 import DTFuncs from '../../resources/datetime';
 import NetRegexes, { commonNetRegex } from '../../resources/netregexes';
 import { UnreachableCode } from '../../resources/not_reached';
 import PetData from '../../resources/pet_names';
+import SouthHornDirectorIds from '../../resources/south_horn_ce_map';
+import SouthHornCEs from '../../resources/south_horn_encounters';
 import StringFuncs from '../../resources/stringhandlers';
+import ZadnorDirectorIds from '../../resources/zadnor_ce_map';
+import ZadnorCEs from '../../resources/zadnor_encounters';
+import ZoneId from '../../resources/zone_id';
 import ZoneInfo from '../../resources/zone_info';
 import { NetAnyMatches, NetMatches } from '../../types/net_matches';
 import { CactbotBaseRegExp } from '../../types/net_trigger';
@@ -90,6 +97,7 @@ export class EncounterFinder {
   currentZone: ZoneEncInfo = {};
   currentFight: FightEncInfo = {};
   currentSeal?: string;
+  currentCE?: string;
   zoneInfo?: typeof ZoneInfo[number];
 
   haveWon = false;
@@ -112,6 +120,7 @@ export class EncounterFinder {
 
   sealRegexes: Array<CactbotBaseRegExp<'GameLog'>> = [];
   unsealRegexes: Array<CactbotBaseRegExp<'GameLog'>> = [];
+  ceRegex: CactbotBaseRegExp<'ActorControl'>;
 
   initializeZone(): void {
     this.currentZone = {};
@@ -152,6 +161,8 @@ export class EncounterFinder {
       const line = `.*?${lang}.*?`;
       this.unsealRegexes.push(NetRegexes.message({ line: line }));
     }
+
+    this.ceRegex = NetRegexes.network6d({ command: '80000014' });
   }
 
   skipZone(): boolean {
@@ -324,6 +335,12 @@ export class EncounterFinder {
         return;
       }
     }
+
+    const ce = this.ceRegex.exec(line)?.groups;
+
+    if (ce) {
+      this.onCE(line, ce);
+    }
   }
 
   // start/endZone always bracket all fights and seals.
@@ -340,7 +357,7 @@ export class EncounterFinder {
   }
   onStartFight(
     line: string,
-    matches: NetMatches['Ability' | 'GameLog' | 'SystemLogMessage' | 'InCombat'],
+    matches: NetMatches['Ability' | 'ActorControl' | 'GameLog' | 'SystemLogMessage' | 'InCombat'],
     fightName?: string,
     sealId?: string,
   ): void {
@@ -380,6 +397,44 @@ export class EncounterFinder {
     this.onEndFight(line, matches, 'Unseal');
     this.currentSeal = undefined;
   }
+
+  onCE(line: string, matches: NetMatches['ActorControl']): void {
+    let validDirectorIds = undefined;
+    let validCEs = undefined;
+    if (this.currentZone.zoneId === ZoneId.TheBozjanSouthernFront) {
+      validDirectorIds = BozjaDirectorIds;
+      validCEs = BozjaCEs;
+    } else if (this.currentZone.zoneId === ZoneId.Zadnor) {
+      validDirectorIds = ZadnorDirectorIds;
+      validCEs = ZadnorCEs;
+    } else if (this.currentZone.zoneId === ZoneId.TheOccultCrescentSouthHorn) {
+      validDirectorIds = SouthHornDirectorIds;
+      validCEs = SouthHornCEs;
+    } else {
+      return;
+    }
+
+    if (matches.data0 === '00') {
+      this.onEndFight(line, matches, 'CE End');
+      this.currentCE = undefined;
+    } else {
+      const id = matches.data0;
+      const ceKey = validDirectorIds[id];
+      if (ceKey === undefined) {
+        // Unrecognized Director ID value
+        return;
+      }
+      const ceInfo = validCEs[ceKey];
+      if (ceInfo === undefined) {
+        // Unexpected missing key
+        return;
+      }
+      const ceName = ceInfo.name.en;
+
+      this.currentCE = id;
+      this.onStartFight(line, matches, ceName);
+    }
+  }
 }
 
 class EncounterCollector extends EncounterFinder {