Removed fillLevelObjectChanges and fillLevelSound from DischargeNode

Author: scfmod

docs/DISCHARGE_NODE.md

@@ -1,9 +1,3 @@
-# Table of contents
-
-- [Custom discharge node](#custom-discharge-node)
-- [Fill level object changes](#fill-level-object-changes)
-- [Fill level sound](#fill-level-sound)
-
 ## Custom discharge node
 
 ```
@@ -77,73 +71,3 @@ Material Processor relies on using custom discharge nodes to enchance functional
     </materialProcessor>
 </vehicle>
 ```
-
-## Fill level object changes
-
-```
-vehicle.materialProcessor.dischargeNodes.node(%).fillLevelObjectChanges
-```
-
-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 |
-
-
-### Example
-```xml
-<?xml version="1.0" encoding="utf-8" standalone="no"?>
-<vehicle>
-    <materialProcessor type="split">
-        <configurations>
-            ...
-        </configurations>
-
-        <dischargeNodes>
-            <node node="dischargeNodeSideR" emptySpeed="100" fillUnitIndex="4" unloadInfoIndex="1">
-                ...
-                <fillLevelObjectChanges threshold="0.85">
-					<objectChange node="alarmBeacon" visibilityActive="true" visibilityInactive="false" />
-				</fillLevelObjectChanges>
-            </node>
-        </dischargeNodes>
-    </materialProcessor>
-</vehicle>
-```
-
-## Fill level sound
-
-```
-vehicle.materialProcessor.dischargeNodes.node(%).fillLevelSound
-```
-
-Play sound depending on the fill level percentage.
-Same as a normal vehicle sample entry, but with additional attributes.
-
-### Attributes
-| Name      | Type  | Required | Default | Description              |
-|-----------|-------|----|-----------|------------------------------|
-| 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 |
-| enabledIfNotProcessing | boolean | No | ```true``` | Determine whether sound can be played if the processor is active or not |
-
-### Example
-```xml
-<?xml version="1.0" encoding="utf-8" standalone="no"?>
-<vehicle>
-    <materialProcessor type="split">
-        <configurations>
-            ...
-        </configurations>
-
-        <dischargeNodes>
-            <node node="dischargeNodeSideR" emptySpeed="100" fillUnitIndex="4" unloadInfoIndex="1">
-                ...
-                <fillLevelSound threshold="0.9" template="rollbeltAlarm" linkNode="alarmSoundNode" />
-            </node>
-        </dischargeNodes>
-    </materialProcessor>
-</vehicle>
-```

scripts/DischargeNode.lua

@@ -44,8 +44,6 @@
 ---@field dischargeStateSamples table
 ---@field turnOffSoundTimer? number
 ---@field stateObjectChanges? table
----@field fillLevelObjectChanges? table
----@field fillLevelObjectChangeThreshold number
 ---@field isAsyncRaycastActive boolean
 ---@field raycastDischargeObject? table
 ---@field raycastDischargeHitObject? table
@@ -63,10 +61,6 @@
 ---@field distanceObjectChangeThreshold number
 ---@field lineOffset number
 ---@field playSound boolean
----@field fillLevelSoundThreshold number
----@field fillLevelSoundThresholdIsGreater boolean
----@field fillLevelSoundEnabledIfNotProcessing boolean
----@field fillLevelSample? table
 ---
 ---@field canFillOwnVehicle boolean
 ---@field canDischargeToVehicle boolean
@@ -118,19 +112,13 @@ function DischargeNode.registerXMLPaths(schema, key)
     schema:register(XMLValueType.FLOAT, key .. ".distanceObjectChanges#threshold", "Defines at which raycast distance the object changes", 0.5)
     ObjectChangeUtil.registerObjectChangeXMLPaths(schema, key .. '.distanceObjectChanges')
     ObjectChangeUtil.registerObjectChangeXMLPaths(schema, key .. ".stateObjectChanges")
-    schema:register(XMLValueType.FLOAT, key .. '.fillLevelObjectChanges#threshold', 'Defines at which fillUnit fill level percentage the object changes', 0.5)
-    ObjectChangeUtil.registerObjectChangeXMLPaths(schema, key .. ".fillLevelObjectChanges")
 
     -- Discharge effects, animations
     schema:register(XMLValueType.NODE_INDEX, key .. '#soundNode', 'Sound node index path')
     schema:register(XMLValueType.BOOL, key .. '#playSound', 'Whether to play sounds', true)
     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 .. '.fillLevelSound#enabledIfNotProcessing', '', 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")
@@ -180,7 +168,6 @@ 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)
@@ -483,12 +470,6 @@ function DischargeNode:updateTick(dt)
 
     if self.isClient then
         self:updateDischargeSound(dt)
-        self:updateFillLevelSound(dt)
-    end
-
-    if self.fillLevelObjectChanges ~= nil then
-        local fillLevelPct = self:getFillLevelPercentage()
-        ObjectChangeUtil.setObjectChanges(self.fillLevelObjectChanges, fillLevelPct > self.fillLevelObjectChangeThreshold, self.vehicle, self.vehicle.setMovingToolDirty)
     end
 
     if self.isServer then
@@ -920,26 +901,6 @@ 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 not self.fillLevelSoundEnabledIfNotProcessing and not self.vehicle:getIsProcessingEnabled() then
-        playSample = false
-    end
-
-    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,11 +92,6 @@ function ProcessorUtils.loadDischargeEffects(dischargeNode, xmlFile, key)
             dischargeNode.playSound = false
         end
 
-        dischargeNode.fillLevelSoundEnabledIfNotProcessing = xmlFile:getValue(key .. '.fillLevelSound#enabledIfNotProcessing', true)
-        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)
@@ -129,14 +124,4 @@ function ProcessorUtils.loadDischargeObjectChanges(node, xmlFile, key)
     else
         ObjectChangeUtil.setObjectChanges(node.stateObjectChanges, false, node.vehicle, node.vehicle.setMovingToolDirty)
     end
-
-    node.fillLevelObjectChanges = {}
-    ObjectChangeUtil.loadObjectChangeFromXML(xmlFile, key .. '.fillLevelObjectChanges', node.fillLevelObjectChanges, node.vehicle.components, node.vehicle)
-
-    if #node.fillLevelObjectChanges == 0 then
-        node.fillLevelObjectChanges = nil
-    else
-        node.fillLevelObjectChangeThreshold = xmlFile:getValue(key .. '.fillLevelObjectChanges#threshold', 0.5)
-        ObjectChangeUtil.setObjectChanges(node.fillLevelObjectChanges, false, node.vehicle, node.vehicle.setMovingToolDirty)
-    end
 end