Add travellingVendor related events

Author: alexemanuelol

src/languages/en.json

@@ -125,8 +125,6 @@
     "eventNotificationSetting-patrolHelicopterSpawned": "Patrol Helicopter Spawned",
     "eventNotificationSetting-travellingVendorDespawned": "Travelling Vendor Despawned",
     "eventNotificationSetting-travellingVendorSpawned": "Travelling Vendor Spawned",
-    "eventNotificationSetting-travellingVendorStarted": "Travelling Vendor Started Moving",
-    "eventNotificationSetting-travellingVendorStopped": "Travelling Vendor Stopped Moving",
     "eventNotificationSetting-vendingMachineDespawned": "Vending Machine Despawned",
     "eventNotificationSetting-vendingMachineSpawned": "Vending Machine Spawned",
     "expireAt": "Expire: {time}",
@@ -174,6 +172,10 @@
     "inGameEvent-patrolHelicopterSpawned": "Patrol Helicopter spawned at {location}.",
     "inGameEvent-patrolHelicopterSpawned-enters": "Patrol Helicopter enters the map from {location}.",
     "inGameEvent-patrolHelicopterSpawned-located": "Patrol Helicopter is located at {location}.",
+    "inGameEvent-travellingVendorDespawned": "Travelling Vendor despawned at {location}.",
+    "inGameEvent-travellingVendorDespawned-soon": "Travelling Vendor at {location} will leave in 5 min.",
+    "inGameEvent-travellingVendorSpawned": "Travelling Vendor spawned at {location}.",
+    "inGameEvent-travellingVendorSpawned-located": "Travelling Vendor is located at {location}.",
     "inGameEvent-vendingMachineSpawned": "A new Vending Machine located at {location}.",
     "inGameTime": "In-Game time: {time}.",
     "issuedAt": "Issued: {time}",

src/managers/guildInstanceManager.ts

@@ -166,8 +166,6 @@ export interface EventNotificationSettings {
     patrolHelicopterLeaving: EventNotificationSetting;
     travellingVendorSpawned: EventNotificationSetting;
     travellingVendorDespawned: EventNotificationSetting;
-    travellingVendorStopped: EventNotificationSetting;
-    travellingVendorStarted: EventNotificationSetting;
 }
 
 export interface EventNotificationSetting {
@@ -216,8 +214,6 @@ export interface SettingsMessages {
     patrolHelicopterLeaving: types.MessageId | null;
     travellingVendorSpawned: types.MessageId | null;
     travellingVendorDespawned: types.MessageId | null;
-    travellingVendorStopped: types.MessageId | null;
-    travellingVendorStarted: types.MessageId | null;
 }
 
 export interface Alias {
@@ -619,9 +615,7 @@ export class GuildInstanceManager {
                 patrolHelicopterDestroyed: null,
                 patrolHelicopterLeaving: null,
                 travellingVendorSpawned: null,
-                travellingVendorDespawned: null,
-                travellingVendorStopped: null,
-                travellingVendorStarted: null
+                travellingVendorDespawned: null
             },
             aliases: [],
             blacklist: {
@@ -1077,9 +1071,7 @@ export function isValidEventNotificationSettings(object: unknown): object is Eve
         'patrolHelicopterDestroyed',
         'patrolHelicopterLeaving',
         'travellingVendorSpawned',
-        'travellingVendorDespawned',
-        'travellingVendorStopped',
-        'travellingVendorStarted'
+        'travellingVendorDespawned'
     ];
 
     const errors: (vu.ValidationError | null)[] = [];
@@ -1116,10 +1108,6 @@ export function isValidEventNotificationSettings(object: unknown): object is Eve
         isValidEventNotificationSetting));
     errors.push(vu.validateInterface('travellingVendorDespawned', obj.travellingVendorDespawned,
         isValidEventNotificationSetting));
-    errors.push(vu.validateInterface('travellingVendorStopped', obj.travellingVendorStopped,
-        isValidEventNotificationSetting));
-    errors.push(vu.validateInterface('travellingVendorStarted', obj.travellingVendorStarted,
-        isValidEventNotificationSetting));
 
     const filteredErrors = errors.filter((error): error is vu.ValidationError => error !== null);
 
@@ -1215,9 +1203,7 @@ export function isValidSettingsMessages(object: unknown): object is SettingsMess
         'patrolHelicopterDestroyed',
         'patrolHelicopterLeaving',
         'travellingVendorSpawned',
-        'travellingVendorDespawned',
-        'travellingVendorStopped',
-        'travellingVendorStarted'
+        'travellingVendorDespawned'
     ];
 
     const errors: (vu.ValidationError | null)[] = [];
@@ -1261,8 +1247,6 @@ export function isValidSettingsMessages(object: unknown): object is SettingsMess
     errors.push(vu.validateType('patrolHelicopterLeaving', obj.patrolHelicopterLeaving, 'string', null));
     errors.push(vu.validateType('travellingVendorSpawned', obj.travellingVendorSpawned, 'string', null));
     errors.push(vu.validateType('travellingVendorDespawned', obj.travellingVendorDespawned, 'string', null));
-    errors.push(vu.validateType('travellingVendorStopped', obj.travellingVendorStopped, 'string', null));
-    errors.push(vu.validateType('travellingVendorStarted', obj.travellingVendorStarted, 'string', null));
 
     const filteredErrors = errors.filter((error): error is vu.ValidationError => error !== null);
 

src/structures/rustPlusMapMarkers.ts

@@ -52,6 +52,7 @@ const CARGO_SHIP_HARBOR_UNDOCKED_DISTANCE = 280;
 const CARGO_SHIP_LEAVE_AFTER_HARBOR_NO_CRATES_MS = 2 * 60 * 1000; /* 2 min */
 const CARGO_SHIP_LEAVE_AFTER_HARBOR_WITH_CRATES_MS = 19.5 * 60 * 1000; /* 19.5 min */
 const PATROL_HELICOPTER_LEAVING_SPEED_MIN = 400;
+const TRAVELLING_VENDOR_ACTIVE_TIME_MS = 30 * 60 * 1000;
 
 export interface CargoShipMetaData {
     lockedCrateSpawnCounter: number;
@@ -90,6 +91,7 @@ export class RustPlusMapMarkers {
     public cargoShipEgressAfterHarbor2TimeoutIds: { [cargoShip: number]: Timer };
     public cargoShipLockedCrateSpawnIntervalIds: { [cargoShip: number]: NodeJS.Timeout };
     public cargoShipUndockingNotificationTimeoutIds: { [cargoShip: number]: NodeJS.Timeout };
+    public travellingVendorLeavingNotificationTimeoutIds: { [travellingVendor: number]: NodeJS.Timeout };
 
     public timeSinceSmallOilRigWasTriggered: Date | null;
     public timeSinceLargeOilRigWasTriggered: Date | null;
@@ -124,6 +126,7 @@ export class RustPlusMapMarkers {
         this.cargoShipEgressAfterHarbor1TimeoutIds = {}
         this.cargoShipLockedCrateSpawnIntervalIds = {};
         this.cargoShipUndockingNotificationTimeoutIds = {};
+        this.travellingVendorLeavingNotificationTimeoutIds = {};
 
         /* Event dates */
         this.timeSinceSmallOilRigWasTriggered = null;
@@ -715,9 +718,55 @@ export class RustPlusMapMarkers {
         }
     }
 
-    /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
     private updateTravellingVendors(mapMarkers: rp.AppMapMarkers) {
+        const type = rp.AppMarkerType.TravellingVendor;
+        const gInstance = gim.getGuildInstance(this.rpInstance.guildId) as GuildInstance;
+        const language = gInstance.generalSettings.language;
+
+        const newMarkers = this.getNewMarkersById(type, mapMarkers.markers);
+        const leftMarkers = this.getLeftMarkersById(type, mapMarkers.markers);
+        const remainingMarkers = this.getRemainingMarkersById(type, mapMarkers.markers);
+
+        /* Markers that are new. */
+        for (const marker of newMarkers) {
+            const travellingVendorPos = getPos(marker.x, marker.y, this.rpInstance) as Position;
+            const travellingVendorPosString = getPosString(travellingVendorPos, this.rpInstance, false, true);
+
+            const phrase = 'inGameEvent-travellingVendorSpawned' + (this.firstPoll ? '-located' : '');
+            const eventText = lm.getIntl(language, phrase, { location: travellingVendorPosString });
+            this.rpInstance.sendEventNotification('travellingVendorSpawned', eventText);
+
+            /* Notify 5 min before leaving */
+            this.travellingVendorLeavingNotificationTimeoutIds[marker.id] = setTimeout(
+                this.notifyTravellingVendorLeavingSoon.bind(this, marker.id),
+                TRAVELLING_VENDOR_ACTIVE_TIME_MS - (5 * 60 * 1000)
+            );
+
+            this.travellingVendors.push(marker);
+        }
+
+        /* Markers that have left. */
+        for (const marker of leftMarkers) {
+            const travellingVendorPos = getPos(marker.x, marker.y, this.rpInstance) as Position;
+            const travellingVendorPosString = getPosString(travellingVendorPos, this.rpInstance, false, true);
 
+            const phrase = 'inGameEvent-travellingVendorDespawned';
+            const eventText = lm.getIntl(language, phrase, { location: travellingVendorPosString });
+            this.rpInstance.sendEventNotification('travellingVendorDespawned', eventText);
+
+            if (Object.hasOwn(this.travellingVendorLeavingNotificationTimeoutIds, marker.id)) {
+                clearTimeout(this.travellingVendorLeavingNotificationTimeoutIds[marker.id]);
+                delete this.travellingVendorLeavingNotificationTimeoutIds[marker.id];
+            }
+
+            this.travellingVendors = this.travellingVendors.filter(e => e.id !== marker.id);
+        }
+
+        /* Markers that still remains. */
+        for (const marker of remainingMarkers) {
+            const travellingVendor = this.travellingVendors.find(e => e.id === marker.id) as rp.AppMarker;
+            Object.assign(travellingVendor, marker);
+        }
     }
 
 
@@ -901,4 +950,25 @@ export class RustPlusMapMarkers {
             delete this.cargoShipUndockingNotificationTimeoutIds[cargoShipId];
         }
     }
+
+    private notifyTravellingVendorLeavingSoon(travellingVendorId: number) {
+        const gInstance = gim.getGuildInstance(this.rpInstance.guildId) as GuildInstance;
+        const language = gInstance.generalSettings.language;
+
+        const travellingVendor = this.travellingVendors.find(e => e.id === travellingVendorId);
+        if (!travellingVendor) return;
+
+        const travellingVendorPos = getPos(travellingVendor.x, travellingVendor.y, this.rpInstance);
+        if (travellingVendorPos) {
+            const travellingVendorPosString = getPosString(travellingVendorPos, this.rpInstance, false, true);
+            const phrase = 'inGameEvent-travellingVendorDespawned-soon';
+            const eventText = lm.getIntl(language, phrase, { location: travellingVendorPosString });
+            this.rpInstance.sendEventNotification('travellingVendorDespawned', eventText);
+        }
+
+        if (Object.hasOwn(this.travellingVendorLeavingNotificationTimeoutIds, travellingVendorId)) {
+            clearTimeout(this.travellingVendorLeavingNotificationTimeoutIds[travellingVendorId]);
+            delete this.travellingVendorLeavingNotificationTimeoutIds[travellingVendorId];
+        }
+    }
 }

src/templates/eventNotificationSettingsTemplate.json

@@ -145,19 +145,5 @@
         "image": "travelling_vendor_logo.png",
         "inGame": false,
         "voice": true
-    },
-    "travellingVendorStopped": {
-        "color": "#7FFF00",
-        "discord": true,
-        "image": "travelling_vendor_logo.png",
-        "inGame": false,
-        "voice": true
-    },
-    "travellingVendorStarted": {
-        "color": "#8B008B",
-        "discord": true,
-        "image": "travelling_vendor_logo.png",
-        "inGame": false,
-        "voice": true
     }
 }

v2_todo.md

@@ -112,29 +112,27 @@
 - [ ] vending machine handler
 
 ### RustPlus events
-- [ ] Vending Machine spawned
-- [ ] Vending Machine despawned
-- [ ] CH47 spawned
-- [ ] CH47 despawned
-- [ ] CH47 destroyed
-- [ ] Locked crate dropped
-- [ ] Heavy scientists called to oil rig
-- [ ] Locked crate unlocked at oil rig
-- [ ] cargoship spawned
-- [ ] cargoship despawned
-- [ ] cargoship leaving
-- [ ] cargoship docking
-- [ ] cargoship docked
-- [ ] cargoship undocking
-- [ ] cargoship locked crate spawned
-- [ ] patrol helicopter spawned
-- [ ] patrol helicopter despawned
-- [ ] patrol helicopter destroyed
-- [ ] patrol helicopter leaving
-- [ ] travelling vendor spawned
-- [ ] travelling vendor despawned
-- [ ] travelling vendor stopped moving
-- [ ] travelling vendor started moving
+- [x] Vending Machine spawned
+- [x] Vending Machine despawned
+- [x] CH47 spawned
+- [x] CH47 despawned
+- [x] CH47 destroyed
+- [x] Locked crate dropped
+- [x] Heavy scientists called to oil rig
+- [x] Locked crate unlocked at oil rig
+- [x] cargoship spawned
+- [x] cargoship despawned
+- [x] cargoship leaving
+- [x] cargoship docking
+- [x] cargoship docked
+- [x] cargoship undocking
+- [x] cargoship locked crate spawned
+- [x] patrol helicopter spawned
+- [x] patrol helicopter despawned
+- [x] patrol helicopter destroyed
+- [x] patrol helicopter leaving
+- [x] travelling vendor spawned
+- [x] travelling vendor despawned
 
 ## Trackers
 - [ ] Class