Merge pull request #2885 from QuentinGruber/perf/resource-event-throttle

perf(resources): change-gate ResourceEvent sends to stop per-tick spam

Author: Z1Meme

src/servers/ZoneServer2016/entities/basefullcharacter.ts

@@ -150,6 +150,9 @@ export abstract class BaseFullCharacter extends BaseLightweightCharacter {
 
   /** BaseFullCharacter loadout values */
   _resources: { [resourceId: number]: number } = {};
+  /** Last resource value actually sent to clients, per resourceId - used to change-gate ResourceEvent
+   *  spam so a resource is only re-sent when the client-displayed value changes. Reset on respawn/resync. */
+  _lastSentResources: { [resourceId: number]: number } = {};
   _loadout: { [loadoutSlotId: number]: LoadoutItem } = {};
   _equipment: { [equipmentSlotId: number]: CharacterEquipment } = {};
   _containers: { [loadoutSlotId: number]: LoadoutContainer } = {};

src/servers/ZoneServer2016/entities/character.ts

@@ -1579,6 +1579,8 @@ export class Character2016 extends BaseFullCharacter {
   }
 
   resetResources(server: ZoneServer2016) {
+    // Full resource resync: clear the change-gate cache so every value below is (re)sent.
+    this._lastSentResources = {};
     this._resources[ResourceIds.HEALTH] = 10000;
     this._resources[ResourceIds.STAMINA] = 600;
     this._resources[ResourceIds.BLEEDING] = 0;

src/servers/ZoneServer2016/zoneserver.ts

@@ -331,6 +331,11 @@ const spawnLocations2 = PluginManager.loadServerData(
     "2016/sampleData/equipmentModelTexturesMapping.json"
   );
 
+// A player resource is only re-sent to clients when it crosses one of these fractions of its MAX_VALUE
+// (permille), so continuously-decaying resources no longer emit a ResourceEvent every tick for a change
+// the client cannot render. TODO: RE-confirm the client's actual resource-bar granularity.
+const RESOURCE_SEND_STEPS = 1000;
+
 export class ZoneServer2016 extends EventEmitter {
   /** Networking layer - allows sending game data to the game client,
    * lays on top of the H1Z1 protocol (on top of the actual H1Z1 packets)
@@ -4024,13 +4029,47 @@ export class ZoneServer2016 extends EventEmitter {
     }
   }
 
+  /**
+   * Change-gate for ResourceEvent sends. Returns true (and updates the character's last-sent cache) only
+   * when the value differs from the last value sent by enough to change what the client displays - killing
+   * per-tick spam for continuously-decaying resources whose raw value ticks by a client-imperceptible
+   * amount. The client renders resources as a fraction of MAX_VALUE, so the value is quantized to
+   * RESOURCE_SEND_STEPS. Non-player entities (vehicles/doors/etc., not in _characters) are never gated, so
+   * their existing behavior is unchanged.
+   */
+  private _shouldSendResourceEvent(
+    entityId: string,
+    resourceId: number,
+    value: number
+  ): boolean {
+    const character = this._characters[entityId];
+    if (!character) return true; // non-player resource - preserve existing behavior
+    const v = value >= 0 ? value : 0;
+    const last = character._lastSentResources[resourceId];
+    const max = this.getResourceMaxValue(resourceId as ResourceIds);
+    let changed: boolean;
+    if (last === undefined || max <= 0) {
+      changed = last !== v;
+    } else {
+      const quantum = (n: number) =>
+        Math.round((n / max) * RESOURCE_SEND_STEPS);
+      changed =
+        quantum(v) !== quantum(last) ||
+        // always emit exact empty/full transitions (drive starving/dehydrated/full states)
+        ((v <= 0 || v >= max) && v !== last);
+    }
+    if (changed) character._lastSentResources[resourceId] = v;
+    return changed;
+  }
+
   updateResource(
     client: Client,
     entityId: string,
     value: number,
     resourceId: ResourceIds,
     resourceType?: number // most resources have the same id and type
   ) {
+    if (!this._shouldSendResourceEvent(entityId, resourceId, value)) return;
     this.sendData<ResourceEvent>(client, "ResourceEvent", {
       eventData: {
         type: 3,
@@ -4051,6 +4090,7 @@ export class ZoneServer2016 extends EventEmitter {
     resourceType: number,
     dictionary: EntityDictionary<BaseEntity>
   ) {
+    if (!this._shouldSendResourceEvent(entityId, resourceId, value)) return;
     this.sendDataToAllWithSpawnedEntity<ResourceEvent>(
       dictionary,
       entityId,