Added fill level sound feature for discharge nodes

Author: scfmod

docs/PROCESSOR_SPLIT.md

@@ -189,6 +189,7 @@ For more details on these look at the official documentation files for Vehicle.
                     ...
                 </effects>
                 <dischargeStateSound template="augerBelt" pitchScale="0.7" volumeScale="1.4" fadeIn="0.2" fadeOut="1" innerRadius="1.0" outerRadius="40.0" linkNode="dischargeNodeFront" />
+                <fillLevelSound template="rollbeltAlarm" linkNode="alarmSoundNode" />
             </node>
         </dischargeNodes>
     </materialProcessor>
@@ -201,7 +202,24 @@ For more details on these look at the official documentation files for Vehicle.
 vehicle.materialProcessor.dischargeNodes.node(%).fillUnitObjectChanges
 ```
 
-### Attributes
+Trigger object changes based on the fill level percentage.
+
+#### Attributes
+| Name      | Type  | Required | Default | Description              |
+|-----------|-------|----|-----------|------------------------------|
+| threshold | float | No | ```0.5```| Defines at which fillUnit fill level percentage the object changes |
+
+### FillLevel sound
+
+```
+vehicle.materialProcessor.dischargeNodes.node(%).fillLevelSound
+```
+
+Play sound depending on the fill level percentage.
+Same as a normal vehicle sample entry, but with two additional attributes.
+
+#### Attributes
 | Name      | Type  | Required | Default | Description              |
 |-----------|-------|----|-----------|------------------------------|
-| threshold | float | No | ```0.5````| Defines at which fillUnit fill level percentage the object changes |
+| threshold | float | No | ```0.5```| Defines at which fillUnit fill level percentage the sound is triggered |
+| thresholdIsGreater | boolean | No  | ```true``` | If true the sound is triggered above threshold, if not then below threshold |

scripts/DischargeNode.lua

@@ -63,6 +63,9 @@
 ---@field distanceObjectChangeThreshold number
 ---@field lineOffset number
 ---@field playSound boolean
+---@field fillLevelSoundThreshold number
+---@field fillLevelSoundThresholdIsGreater boolean
+---@field fillLevelSample? table
 ---
 ---@field canFillOwnVehicle boolean
 ---@field canDischargeToVehicle boolean
@@ -123,6 +126,9 @@ function DischargeNode.registerXMLPaths(schema, key)
     EffectManager.registerEffectXMLPaths(schema, key .. ".effects")
     SoundManager.registerSampleXMLPaths(schema, key, "dischargeSound")
     SoundManager.registerSampleXMLPaths(schema, key, "dischargeStateSound(?)")
+    SoundManager.registerSampleXMLPaths(schema, key, 'fillLevelSound')
+    schema:register(XMLValueType.FLOAT, key .. '.fillLevelSound#threshold', '', 0.5)
+    schema:register(XMLValueType.BOOL, key .. '.fillLevelSound#thresholdIsGreater', '', true)
     schema:register(XMLValueType.BOOL, key .. ".dischargeSound#overwriteSharedSound", "Overwrite shared discharge sound with sound defined in discharge node", false)
     AnimationManager.registerAnimationNodesXMLPaths(schema, key .. ".animationNodes")
     AnimationManager.registerAnimationNodesXMLPaths(schema, key .. ".effectAnimationNodes")
@@ -172,6 +178,7 @@ function DischargeNode:delete()
     g_effectManager:deleteEffects(self.effects)
     g_soundManager:deleteSample(self.sample)
     g_soundManager:deleteSample(self.dischargeSample)
+    g_soundManager:deleteSample(self.fillLevelSample)
     g_soundManager:deleteSamples(self.dischargeStateSamples)
     g_animationManager:deleteAnimations(self.animationNodes)
     g_animationManager:deleteAnimations(self.effectAnimationNodes)
@@ -474,6 +481,7 @@ function DischargeNode:updateTick(dt)
 
     if self.isClient then
         self:updateDischargeSound(dt)
+        self:updateFillLevelSound(dt)
     end
 
     if self.fillUnitObjectChanges ~= nil then
@@ -910,6 +918,22 @@ function DischargeNode:updateDischargeInfo(x, y, z)
     end
 end
 
+function DischargeNode:updateFillLevelSound(dt)
+    if self.playSound and self.fillLevelSample == nil then
+        return
+    end
+
+    local fillLevelPct = self:getFillLevelPercentage()
+    local playSample = (self.fillLevelSoundThresholdIsGreater and fillLevelPct > self.fillLevelSoundThreshold) or (not self.fillLevelSoundThresholdIsGreater and fillLevelPct < self.fillLevelSoundThreshold)
+    local isPlaying = g_soundManager:getIsSamplePlaying(self.fillLevelSample)
+
+    if playSample and not isPlaying then
+        g_soundManager:playSample(self.fillLevelSample)
+    elseif not playSample and isPlaying then
+        g_soundManager:stopSample(self.fillLevelSample)
+    end
+end
+
 ---@param dt number
 function DischargeNode:updateDischargeSound(dt)
     local fillType = self:getDischargeFillType()

scripts/ProcessorUtils.lua

@@ -92,6 +92,10 @@ function ProcessorUtils.loadDischargeEffects(dischargeNode, xmlFile, key)
             dischargeNode.playSound = false
         end
 
+        dischargeNode.fillLevelSoundThreshold = xmlFile:getValue(key .. '.fillLevelSound#threshold', 0.5)
+        dischargeNode.fillLevelSoundThresholdIsGreater = xmlFile:getValue(key .. '.fillLevelSound#thresholdIsGreater', true)
+        dischargeNode.fillLevelSample = g_soundManager:loadSampleFromXML(xmlFile, key, "fillLevelSound", dischargeNode.vehicle.baseDirectory, dischargeNode.vehicle.components, 0, AudioGroup.VEHICLE, dischargeNode.vehicle.i3dMappings, dischargeNode.vehicle)
+
         dischargeNode.dischargeStateSamples = g_soundManager:loadSamplesFromXML(xmlFile, key, "dischargeStateSound", dischargeNode.vehicle.baseDirectory, dischargeNode.vehicle.components, 0, AudioGroup.VEHICLE, dischargeNode.vehicle.i3dMappings, dischargeNode.vehicle)
         dischargeNode.animationNodes = g_animationManager:loadAnimations(xmlFile, key .. ".animationNodes", dischargeNode.vehicle.components, dischargeNode.vehicle, dischargeNode.vehicle.i3dMappings)
         dischargeNode.effectAnimationNodes = g_animationManager:loadAnimations(xmlFile, key .. ".effectAnimationNodes", dischargeNode.vehicle.components, dischargeNode.vehicle, dischargeNode.vehicle.i3dMappings)