Dev Inquiry: Best practice for triggering ADS faults via external mod (Tornado Physics)

[whitevamp]

Hey id577,

I'm the dev behind the Tornado Physics mod. I love the complexity of your Advanced Damage System, and I'm currently writing a compatibility bridge in my mod to detect if a player has your mod installed.

The plan is: If my tornado hits a tractor and detects FS25_AdvancedDamageSystem, instead of applying generic damage, I want to trigger your specific fault codes (like FUEL_PUMP_MALFUNCTION or TRANSMISSION_SLIP) to simulate storm damage.

I just wanted to give you a heads-up as a courtesy. I'm currently looking at injecting faults into vehicle.spec_AdvancedDamageSystem.activeEffects. If you have a preferred 'public' function for other mods to trigger breakdowns, let me know!

Thanks for the great work!

[id577]

Hey id577,

I'm the dev behind the Tornado Physics mod. I love the complexity of your Advanced Damage System, and I'm currently writing a compatibility bridge in my mod to detect if a player has your mod installed.

The plan is: If my tornado hits a tractor and detects FS25_AdvancedDamageSystem, instead of applying generic damage, I want to trigger your specific fault codes (like FUEL_PUMP_MALFUNCTION or TRANSMISSION_SLIP) to simulate storm damage.

I just wanted to give you a heads-up as a courtesy. I'm currently looking at injecting faults into vehicle.spec_AdvancedDamageSystem.activeEffects. If you have a preferred 'public' function for other mods to trigger breakdowns, let me know!

Thanks for the great work!

Hey whitevamp! Yes, there is a registered function for vehicles with the ADS specialization:
function AdvancedDamageSystem:addBreakdown(breakdownId, stage)

Example usage:
vehicle:addBreakdown('FUEL_PUMP_MALFUNCTION', 1)

You can find all available breakdownIds in ADS_Breakdowns.BreakdownRegistry.

Just a heads-up: vehicle.spec_AdvancedDamageSystem.activeEffects only contains the effects caused by faults, not the faults themselves. The actual breakdowns are stored in vehicle.spec_AdvancedDamageSystem.activeBreakdowns. However, I highly recommend using the function I mentioned, as it handles all necessary checks (like preventing duplicate breakdowns).

Sorry for the delay, I missed your message. If you have any other questions, feel free to ask!

[id577]

A quick follow-up (I just double-checked my code :D).

If you plan to use addBreakdown to trigger a specific fault, you must manually check if that fault is valid for the specific vehicle type first. You can do this by calling isApplicable(vehicle) from ADS_Breakdowns.BreakdownRegistry.<BREAKDOWN_ID>. If it returns true, you can proceed.

For example:

if ADS_Breakdowns.BreakdownRegistry.FUEL_PUMP_MALFUNCTION.isApplicable(vehicle) then
    vehicle:addBreakdown('FUEL_PUMP_MALFUNCTION', 1)
end

However, if you just want the tornado to cause random damage, it is much easier to use getRandomBreakdown(). This function automatically returns a breakdown ID that is applicable to the current vehicle, handling all the compatibility and probability checks for you.

Example:

local breakdownId = vehicle:getRandomBreakdown()
if breakdownId then
    -- Apply Stage 1 damage
    vehicle:addBreakdown(breakdownId, 1) 
    
    -- OR for critical damage (instant max stage):
    -- local maxStage = #ADS_Breakdowns.BreakdownRegistry[breakdownId].stages
    -- vehicle:addBreakdown(breakdownId, maxStage)
end

[whitevamp]

sorry for the late reply back. and thanks for the information. greatly appreciated.