18
0
mirror of https://github.com/MaSzyna-EU07/maszyna.git synced 2026-11-19 12:16:02 +01:00
Files
maszyna/vehicle/enginestart.h
jerrrrycho 13ded6cdfa feat: separate engine start switches for the vehicles in multiple (eu07/maszyna#80)
In vehicles like the ST43, the SP32 or the SN61 every engine of a train in
multiple has its own start and stop buttons in the cab. Until now the cab's
line breaker / engine start switch (main_sw, main_on_bt, main_off_bt) always
started and stopped the engines of all the vehicles under its control.

- .fiz, Engine: JointEngineStart=Yes|No (default Yes, as before). With No
  the cab's main_* work the cab's own vehicle only, and an engine stopping on
  its own (stalled, out of fuel) stops only its own vehicle instead of every
  engine in the train.
- .mmd: mainb_sw, mainb_on_bt, mainb_off_bt work the second vehicle with an
  engine under the cab's control, mainc_sw, mainc_on_bt, mainc_off_bt the
  third one. They count along the control cable from the cab's vehicle,
  behind the cab first. Like main_*, the start switch has to be held for the
  vehicle's IniCDelay with the vehicle ready (MainSwitchCheck); an impulse
  switch of an electric locomotive with series motors closes on release.
- New commands, added at the end of the command list: linebreakertoggleb,
  linebreakeropenb, linebreakercloseb, linebreakertogglec, linebreakeropenc,
  linebreakerclosec. No default keys.
- The logic is in vehicle/enginestart.{h,cpp} (core library), tested in
  tests/unit/test_engine_start.cpp.

Nothing changes for existing vehicles: the new key and the new cab controls
are optional, and without them the code does what it did before.

Game data (SVN, not changed here, to be done separately; the code works
without it): for the SN61 (dynamic/pkp/sn61_v2), whose cab models already
have the buttons start02/stop02/start03/stop03,
- sn61.fiz, sn61-86.fiz, sn61_v1.fiz and the other SN61 .fiz: add
  JointEngineStart=No to the Engine: line;
- sn61.mmd.inc (and the other SN61 includes): after main_on_bt add
  mainb_off_bt: { stop02 mov -0.005 0 0.1 ... }
  mainb_on_bt: { start02 mov -0.005 0 0.1 ... }
  mainc_off_bt: { stop03 mov -0.005 0 0.1 ... }
  mainc_on_bt: { start03 mov -0.005 0 0.1 ... }
  with the sounds of main_off_bt / main_on_bt.
The tooltips "line breaker B" / "line breaker C" are new strings for lang/*.po.
2026-11-08 07:12:30 +01:00

46 lines
2.4 KiB
C++

/*
This Source Code Form is subject to the
terms of the Mozilla Public License, v.
2.0. If a copy of the MPL was not
distributed with this file, You can
obtain one at
http://mozilla.org/MPL/2.0/.
*/
#pragma once
class TMoverParameters;
// starting the engines (closing the line breakers) of the vehicles in multiple from the cab (eu07/maszyna#80). in
// vehicles like the ST43, the SP32 or the SN61 every engine of the train has its own switches in the cab: main_* work
// the cab's own vehicle, mainb_* the second one and mainc_* the third one under its control. Engine:JointEngineStart=No
// in the .fiz of the cab's vehicle keeps main_* to that vehicle alone (TMoverParameters::MainSwitchRange()); by
// default it works all of them, as before.
namespace engine_start {
// the Number-th vehicle with an engine under the cab's control: 1 is Controlled, the cab's own; then the others
// connected through the control cable, those behind the cab of Occupied first, the nearest first, then those in front
// of it. nullptr when there are fewer of them
TMoverParameters *engine(TMoverParameters const &Occupied, TMoverParameters &Controlled, int Number);
// the switch starting the engine of another vehicle in multiple. like the cab's own switch, it has to be held closed
// for the vehicle's InitialCtrlDelay, with the vehicle ready for it, before the engine starts (the line breaker closes)
class remote_switch {
public:
// one step of Deltatime seconds of the switch of Engine, with the switch held closed (Closeheld) or open (Openheld).
// with Closesonrelease, the line breaker closes when the switch is let go after the delay, as the impulse switch
// of an electric locomotive with series motors does
void update(TMoverParameters *Engine, bool Closeheld, bool Openheld, double Deltatime, bool Closesonrelease);
// opens the line breaker / stops the engine of Engine, the vehicle alone; returns whether it was running
static bool open(TMoverParameters &Engine);
// whether the line breaker of Engine is closed or its engine starting or running
static bool is_running(TMoverParameters const &Engine);
private:
TMoverParameters const *m_engine{nullptr}; // the vehicle the switch worked the last step
double m_heldtime{0.0}; // how long the switch is held closed with the vehicle ready to start
bool m_ready{false}; // held long enough, the line breaker closes now or when the switch is let go
};
} // namespace engine_start