Filtered despawn

[originalfoo]

Fixes: #270
Updates: #833

TMPE.zip

• Adds several vehicle-related extensions (see commits)
• Create a filterable (by ExtVehicleType) DespawnVehicles() method in UtilityManager.
• Add an in-game-only checkbox group to Maintenance tab allowing user to filter and despawn
• Beautify missing locale keys, but only in STABLE builds (all strings in image below are missing locale keys)

Edit: Image below is outdated; the text and cims was removed from the All... option as cims are handled by entirely different AI.

Toggling All vehicles and cims checkbox will apply the result to all indented checkbox below. Checking all indented checkbox will result in the All... checkbox being checked; and unchecking one or more indented checkbox will result in All... being unchecked.

Note that Parked Vehicles is handled as a speical case; when Despawn button is clicked, it checks that setting individually and queues relevant manager instance method (RemoveParkedVehicles()).

List of filters that can be used by `UtilityManager.Instance.DespawnVehicles()` for reference

    [Flags]
    public enum ExtVehicleType {
        None = 0,
        PassengerCar = 1,
        Bus = 1 << 1,
        Taxi = 1 << 2,
        CargoTruck = 1 << 3,
        Service = 1 << 4,
        Emergency = 1 << 5,
        PassengerTrain = 1 << 6,
        CargoTrain = 1 << 7,
        Tram = 1 << 8,
        Bicycle = 1 << 9,
        Pedestrian = 1 << 10,
        PassengerShip = 1 << 11,
        CargoShip = 1 << 12,
        PassengerPlane = 1 << 13,
        Helicopter = 1 << 14,
        CableCar = 1 << 15,
        PassengerFerry = 1 << 16,
        PassengerBlimp = 1 << 17,
        CargoPlane = 1 << 18,
        Trolleybus = 1 << 19,
        Plane = PassengerPlane | CargoPlane,
        Ship = PassengerShip | CargoShip,
        CargoVehicle = CargoTruck | CargoTrain | CargoShip | CargoPlane,
        PublicTransport = Bus | Taxi | Tram | PassengerTrain | Trolleybus,
        RoadPublicTransport = Bus | Taxi | Trolleybus,
        RoadVehicle = PassengerCar | Bus | Taxi | CargoTruck | Service | Emergency, //may perform u-turn
        RailVehicle = PassengerTrain | CargoTrain,
        NonTransportRoadVehicle = RoadVehicle & ~PublicTransport,
        Ferry = PassengerFerry,
        Blimp = PassengerBlimp,
    }

Although this is a non-trivial change, I'd like to request it go in to 11.6.4.4 release as it will help users despawn their aircraft should they be stuck due to pathfinding issues tackled in PR #1338

[originalfoo]

The Maintenance options tab now has a new group of checkboxen at the bottom with despawn filters!

It will only appear in-game (not in editor or main menu).

Additionally I've beautified the result of missing translations in STABLE builds (only for basic strings, not advisor tutorials). 3960c45 - DEBUG and TEST builds are unaffected by this change (they'll still show pilcrow and the full locale key).

[kvakvs]

To despawn only cims? Will help with crowded bus stops, but really that should be fixed elsewhere, they should lose patience and find another path.

[originalfoo]

To despawn only cims? Will help with crowded bus stops, but really that should be fixed elsewhere, they should lose patience and find another path.

I can add that in easy enough - should it despawn bicycles as well or just the pedestrians?

As for preventing crowded stops, Dymanoid's "Stops and Stations" mod does exactly that :)

[originalfoo]

duh, RoadVehicle includes Service and Emergency. my bad

ignore this

Trying to track down what's going on in #1342 and found one possible issue that |= operator isn't working at all on ExtVehicleType :

In previous commit I add a new var mask to store the current "compilation" of the bitmask, and at the end of the foreach loop I then set the main despawnerMask to value of the compiled mask - this is all to track down weirdness as shown below:

Select Road vehicles:

Info 343.8976245: Current despawnerMask = None
Info 343.8984347: mask: None
Info 343.8991240: - Despawn.Checkbox:Road vehicles: mask |= RoadVehicle
Info 343.8998197: - mask now: RoadVehicle
Info 343.9006098: Despawner mask: RoadVehicle

Good so far. Now select Service vehicles:

Info 358.6056609: Current despawnerMask = RoadVehicle
Info 358.6065370: mask: None
Info 358.6072393: - Despawn.Checkbox:Road vehicles: mask |= RoadVehicle
Info 358.6079267: - mask now: RoadVehicle
Info 358.6085545: mask: RoadVehicle
Info 358.6093436: - Despawn.Checkbox:Service vehicles: mask |= Service, Emergency
Info 358.6100668: - mask now: RoadVehicle
Info 358.6107582: Despawner mask: RoadVehicle

So (paraphrasing for sake of brevity) if mask == RoadVehicle and I then mask |= Service, Emergency, how exactly does that result in mask == RoadVehicle???

[originalfoo]

And now it's working perfectly :)

[krzychu124]

All vehicles and cims

By cims you mean these in passenger cars and public transport vehicles, right?

[originalfoo]

All vehicles and cims

By cims you mean these in passenger cars and public transport vehicles, right?

I removed the word cims in a recent commit as they are handled by entirely different AI. That can be added in as a future update if required. The cims in vehicles are citizen units or something like that; I assume the game just teleports them to destination if vehicle despawns.

EDIT: updated OP to note that the image is outdated

[krzychu124]

Hmm I don't see despawn section in the options in-game, what I'm doing wrong?🤔

[originalfoo]

It should appear at bottom of maintenance tab in options when in-game (does not appear in main menu or editor though)

[krzychu124]

It should appear at bottom of maintenance tab in options when in-game (does not appear in main menu or editor though)

Yeah, stupid me, I was browsing PR changes but didn't build that version for tests...

[krzychu124]

Seems to be working correctly 👍

[originalfoo]

awesome - pls mege (only one reviewer so far) :)