robot256
commented
2 years ago Making notes here instead of some other random place. This is still a notional long-term plan, if it ever works. Feel free to comment with any new ideas.
- The only absolute reason this mod needs to be involved is to handle third-party ships that travel on waterways. Otherwise, these will be treated as trains and removed by Cargo Ships.
- One solution to this would simply be a "whitelist" of entities that are allowed on waterways. Then the other mod would have to have its own ship engines and engine-spawning logic.
- The more general case, which would also make it easier to add ships in this mod too, is to create a registry of each ship type with all the specific parameters required to detect it and create its engine. This is what I've basically done in Vehicle Wagon.
- Parameters needed would be: name of placed ship entity, name of engine to be created (if any), whether engine is in front or behind ship entity (localize_engine, has_connected_stock), distance away to make the ship engine (localize_engine), whether the player can enter it from a distance. Also need an interface to add new engines, and whether players can enter those from a distance.
- Mods would add cargo-ships as a dependency, and call the remote interface during on_configuration_changed to add both ships and engines. cargo-ships would maintain global tables:
- Ship name -> engine building data. (list of ships and their localize_engine data)
- Engine name -> engine data. (list of engines and whether they use fuel that needs to be recovered)
- Ship/engine name -> true. (list of stock that can be entered with the Enter Ship command)
- This might be a good time to retire the glitchy boat placement code, by allowing the player to intentionally craft the waterway-boat (like converting between AI and normal vehicles) and not needing the script to choose which the player intended. Then we would not have to expand it to handle other dual-mode boats.
- This refactor should also move some of the larger blocks of code out of control.lua into logic files. The ship, oil rig, and waterway build/mine/delete code should be moved, and the "enter vehicle" code as well.
- In fact, one possibility is to use the well-supported FLIB events library (which is maintained by Krastorio and Factory Planner devs). This allows multiple subcomponents of a single mod to subscribe to the same event. It would take the place of the existing logic which decides whether to act on a boat, ship, oilrig, waterway, rail, or bridge.
squidy5
This will require a large refactoring, which I got partially working about a year ago.