From d8f3875929b6fd4829cc6c69ea52de6f03892e0b Mon Sep 17 00:00:00 2001 From: jerrrrycho Date: Sat, 7 Nov 2026 18:22:42 +0100 Subject: [PATCH] fix(gfx): diesel smoke only once the engine fires, not while the starter turns (eu07/maszyna#523) The smoke of a diesel came out at full strength the moment its ignition set Mains and started the spin up, together with the ignition sound, whose first part is the starter cranking the engine. The ignition now starts a countdown of the new optional .fiz parameter SmokeDelay (Engine section of DieselEngine and DieselElectric vehicles, seconds, default 2.0, 0 restores the old behaviour); the smoke source of the vehicle spawns nothing until it runs out. Engines already running, or switched on another way, smoke as before. No SVN data change is needed; vehicle authors may tune SmokeDelay to the cranking part of their ignition: sample. --- McZapkie/MOVER.h | 4 +++ McZapkie/Mover.cpp | 7 ++++ tests/unit/test_smoke.cpp | 68 +++++++++++++++++++++++++++++++++++++++ vehicle/smoke.cpp | 2 +- vehicle/smoke.h | 1 + 5 files changed, 81 insertions(+), 1 deletion(-) diff --git a/McZapkie/MOVER.h b/McZapkie/MOVER.h index 199c65a0c..f39de8e26 100644 --- a/McZapkie/MOVER.h +++ b/McZapkie/MOVER.h @@ -2171,6 +2171,10 @@ class TMoverParameters bool dizel_startup{false}; // engine startup procedure request indicator bool dizel_ignition{false}; // engine ignition request indicator bool dizel_spinup{false}; // engine spin up to idle speed flag + // the starter turns the engine a while before it fires: smoke comes out only after SmokeDelay (the Engine section of the .fiz, + // seconds from the start of the spin up) has passed. 0 lets it out as soon as the starter turns, as before eu07/maszyna#523 + double dizel_SmokeDelay{2.0}; + double dizel_FiringCountdown{0.0}; // seconds left until the engine being started fires, 0 once it runs on its own double dizel_engagedeltaomega = 0.0; /*roznica predkosci katowych tarcz sprzegla*/ double dizel_n_old = 0.0; /*poredkosc na potrzeby obliczen sprzegiel*/ double dizel_Torque = 0.0; /*aktualny moment obrotowy silnika spalinowego*/ diff --git a/McZapkie/Mover.cpp b/McZapkie/Mover.cpp index 330e8eb8f..8632e404e 100644 --- a/McZapkie/Mover.cpp +++ b/McZapkie/Mover.cpp @@ -7843,6 +7843,9 @@ bool TMoverParameters::dizel_Update(double dt) WaterHeaterCheck(dt); OilPumpCheck(dt); FuelPumpCheck(dt); + // the engine being started fires once the starter has turned it a while; one stopped meanwhile starts over + dizel_FiringCountdown = (Mains ? std::max(0.0, dizel_FiringCountdown - dt) : 0.0); + if (true == dizel_startup && true == dizel_StartupCheck()) { dizel_ignition = true; @@ -7857,6 +7860,7 @@ bool TMoverParameters::dizel_Update(double dt) LastSwitchingTime = 0; Mains = true; dizel_spinup = true; + dizel_FiringCountdown = dizel_SmokeDelay; enrot = std::max(enrot, 0.35 * ( // TODO: dac zaleznie od temperatury i baterii EngineType == TEngineType::DieselEngine ? dizel_nmin : DElist[0].RPM / 60.0)); @@ -11365,6 +11369,9 @@ void TMoverParameters::LoadFIZ_Engine(std::string const &Input) // oil pump extract_value(OilPump.pressure_minimum, "OilMinPressure", Input, ""); extract_value(OilPump.pressure_maximum, "OilMaxPressure", Input, ""); + // the time the starter turns the engine before it fires and smokes (eu07/maszyna#523) + extract_value(dizel_SmokeDelay, "SmokeDelay", Input, ""); + dizel_SmokeDelay = std::max(0.0, dizel_SmokeDelay); // engine cooling factore extract_value(dizel_heat.kw, "HeatKW", Input, ""); extract_value(dizel_heat.kv, "HeatKV", Input, ""); diff --git a/tests/unit/test_smoke.cpp b/tests/unit/test_smoke.cpp index 05fb8ae8b..a1ea788f3 100644 --- a/tests/unit/test_smoke.cpp +++ b/tests/unit/test_smoke.cpp @@ -2,6 +2,7 @@ #include "doctest.h" #include "vehicle.h" +#include "drive.h" #include "vehicle/smoke.h" @@ -83,3 +84,70 @@ TEST_CASE("smoke: the pending particles never outgrow the room of the source") { CHECK(smoke::vehicle_spawn_count(vehicle.mover(), true, rate, 10.0) == rate.limit); } + +TEST_CASE("smoke: an engine the starter turns lets out no smoke until it fires (#523)") { + auto vehicle{diesel()}; + vehicle->dizel_spinup = true; + auto pending{source}; + pending.pending = 5.f; + + vehicle->dizel_FiringCountdown = 0.5; + CHECK(smoke::vehicle_spawn_count(vehicle.mover(), true, pending, update) == 0.f); + + vehicle->dizel_FiringCountdown = 0.0; + CHECK(smoke::vehicle_spawn_count(vehicle.mover(), true, pending, update) >= 1.f); +} + +namespace { + +// the locomotive's engine started the way the AI starts it, a second at a time, until it runs (Mains) +bool start_engine(test::driven const &Driven, test::track const &Track) { + for (int second = 0; second < 120 && false == Driven.controlling.Mains; ++second) { + test::start_up(Driven, Track, 1.0); + } + return Driven.controlling.Mains; +} + +} // namespace + +TEST_CASE("smoke: a real diesel smokes only once its engine has fired, SmokeDelay after the starter began (#523)") { + // a diesel with a mechanical transmission and a diesel-electric one + for (auto const *path : {"sm42_v1/6d1", "st44_v2/m62-1151"}) { + CAPTURE(path); + test::track const track{}; + { + // the default delay + test::vehicle locomotive{test::definition::fiz(path)}; + REQUIRE(locomotive->dizel_SmokeDelay == doctest::Approx(2.0)); + auto const driven{test::driving(locomotive)}; + REQUIRE(start_engine(driven, track)); + // the engine started less than a second ago: the starter still turns it + CHECK(locomotive->dizel_FiringCountdown > 0.5); + CHECK(smoke::vehicle_spawn_count(locomotive.mover(), true, source, update) == 0.f); + // it has fired since + test::drive(driven, track, 3.0); + CHECK(locomotive->Mains); + CHECK(locomotive->dizel_FiringCountdown == 0.0); + CHECK(smoke::vehicle_spawn_count(locomotive.mover(), true, source, update) >= 1.f); + } + { + // SmokeDelay=0: smoke as soon as the starter turns, as before + test::vehicle locomotive{test::definition{test::definition::fiz(path)}.set("Engine", "SmokeDelay", 0)}; + REQUIRE(locomotive->dizel_SmokeDelay == 0.0); + auto const driven{test::driving(locomotive)}; + REQUIRE(start_engine(driven, track)); + CHECK(locomotive->dizel_FiringCountdown == 0.0); + CHECK(smoke::vehicle_spawn_count(locomotive.mover(), true, source, update) >= 1.f); + } + { + // a longer delay from the .fiz + test::vehicle locomotive{test::definition{test::definition::fiz(path)}.set("Engine", "SmokeDelay", 5)}; + auto const driven{test::driving(locomotive)}; + REQUIRE(start_engine(driven, track)); + test::drive(driven, track, 3.0); + CHECK(smoke::vehicle_spawn_count(locomotive.mover(), true, source, update) == 0.f); + test::drive(driven, track, 3.0); + CHECK(smoke::vehicle_spawn_count(locomotive.mover(), true, source, update) >= 1.f); + } + } +} diff --git a/vehicle/smoke.cpp b/vehicle/smoke.cpp index b6e923222..f5f64bef0 100644 --- a/vehicle/smoke.cpp +++ b/vehicle/smoke.cpp @@ -34,7 +34,7 @@ double engine_load(TMoverParameters const &Mover) { } // namespace float vehicle_spawn_count(TMoverParameters const &Mover, bool const Ontracks, spawn_rate const &Rate, double const Timedelta) { - if (false == Ontracks) { + if (false == Ontracks || Mover.dizel_FiringCountdown > 0.0) { return 0.f; } // the steady rate of the source, the way a source of the scenery spawns... diff --git a/vehicle/smoke.h b/vehicle/smoke.h index e9dac2622..dbcc131ae 100644 --- a/vehicle/smoke.h +++ b/vehicle/smoke.h @@ -25,6 +25,7 @@ struct spawn_rate { // number of particles the smoke source of a vehicle has to spawn after Timedelta seconds: the steady rate of the // source, plus a share which grows with the work of its engine. a vehicle taken off the tracks (Ontracks false: gone through a portal, or waiting in the pool of the road // traffic) puffs no more, the particles it already let out fade away as usual +// an engine the starter turns but which hasn't fired yet (TMoverParameters::dizel_FiringCountdown) lets out no smoke either float vehicle_spawn_count(TMoverParameters const &Mover, bool Ontracks, spawn_rate const &Rate, double Timedelta); } // namespace smoke