Rename core classes

[marcinn]

• TrainController -> LegacyRailVehicle
• introduce base class RailVehicle
• TrainPart -> RailVehicleModule
• inroduce LegacyRailVehicleModule for Mover-related modules
• TrainEngine* -> RailVehicleEngine*
• TrainSecuritySytem -> RailVehicleSecurityModule (do not use "System" for components/modules)
• TrainSystem -> RailVehicleSystem
• Update documentation

Provide custom icons for Godot Editor

[JezSonic]

Suggestion:
RailVehicle:

• TrainCar
• Locomotive
• MultipleUnit (future?)
• Dreisine (future?)

RailVehicleModule:

• DieselEngine
• ElectricEngine
• TrainSetDoors

TrainController -> LegacyRailVehicle

[marcinn]

---
title: Rail vehicle
---
classDiagram

RailVehicle <|-- LegacyRailVehicle
RailVehicle: String ID
RailVehicle: Dictionary state

LegacyRailVehicle: TMoverParameters *mover

Loading

---
title: Rail vehicle modules
---
classDiagram

RailVehicleModule <|-- LegacyRailVehicleModule
RailVehicleModule <|-- GenericRailVehicleModule
LegacyRailVehicleModule <|-- LegacySecuritySystem
LegacyRailVehicleModule <|-- LegacyEngine
LegacyRailVehicleModule <|-- LegacyTrainBrakes
LegacyRailVehicleModule <|-- LegacyTrainDoors

LegacyEngine <|-- LegacyDieselEngine
LegacyEngine <|-- LegacyElectricEngine
LegacyDieselEngine <|-- LegacyDieselElectricEngine

GenericRailVehicleModule:  _process_module(delta)

RailVehicleModule: RailVehicle get_rail_vehicle()
RailVehicleModule: bool enabled

LegacyRailVehicleModule: _do_update_mover(*mover)
LegacyRailVehicleModule: _do_process_mover(*mover, delta)
LegacyRailVehicleModule: _do_fetch_config_from_mover(*mover, &config)
LegacyRailVehicleModule: _do_fetch_state_from_mover(*mover, &state)

Loading

[JezSonic]

I took a fresh look at this and I see one thing that makes my eyes hurt - Legacy everywhere.

It's additional word that does not really mean anything and it makes the class name unnecessarily longer

And what does really Legacy mean in this context and why should we use it there? It even imo sounds bad

Better and more clear approach would be as described on this graph, but remove Legacy suffix from everywhere except TMoverParameters

We don't even have a legacy code in it's dictionary meaning (old computer source code that is no longer supported on standard hardware and environments)
We have just MaSzyna's code inside and neither Legacy, Propertiary nor Third-Party are proper ways to describe/mark it.

So given those arguments I'd rather not use any prefix to not make any unnecessary inconvenience for future users (I don't wanna risk somebody thinking that there's some 30 y.o. code or something)

Current naming is good as for now and I would leave it as is and not reinvent the wheel

However if renaming would be really necessary I'd suggest going with

---
title: Rail vehicle modules
---
classDiagram

RailVehiclePart <|-- BaseRailVehiclePart
RailVehiclePart <|-- SecuritySystem
RailVehiclePart <|-- BaseEngine
RailVehiclePart <|-- Brakes
RailVehiclePart <|-- Doors
RailVehiclePart: We can consider leaving the "Train" prefix. BaseEngine is an exception hence Engine class is built-in Godot class

BaseEngine <|-- DieselEngine
BaseEngine <|-- ElectricEngine
DieselEngine <|-- DieselElectricEngine

BaseRailVehiclePart:  _process_module(delta)
BaseRailVehiclePart: This class will be (at least close to be an) equivalent to current GenericTrainPart

RailVehiclePart: RailVehicle get_rail_vehicle()
RailVehiclePart: bool enabled

RailVehiclePart: _update_mover(*mover)
RailVehiclePart: _process_mover(*mover, delta)
RailVehiclePart: _fetch_config_from_mover(*mover, &config)
RailVehiclePart: _fetch_state_from_mover(*mover, &state)
RailVehiclePart: _do prefixes are also unnecessary there

Loading

[marcinn]

it makes the class name unnecessarily longer
We don't even have a legacy code

In the context of system we're developing here, every Mover's based class is a "legacy". We can consider prefixing it with "Mover" instead, but the core idea will remain the same.

However if renaming would be really necessary I'd suggest going with

Please look carefully at the diagrams - base classes have no relation with Mover.

[JezSonic]

Mover prefix would sound a lot better