Vehicle type exclusion list for "Disable despawning" feature

[krzychu124]

Add options to allow despawn of specific vehicle types when "Disable despawning" feature is active

Closes #1434

[originalfoo]

Still need to test in-game

[originalfoo]

Tested in-game and it works but... it's a bit weird. Summarising the MayDespawn logic:

may despawn =

    Despawning is not disabled, or
    Vehicle is blown|floating, or
    Vehicle is parking, or
    Vehicle type is allowed to despawn

I have no way of knowing, as a user, that if I don't enable Disable Despawning then my disabled Allow Despawning filters won't have any effect.

Additionally, the options are on separate tabs (Gameplay vs. Maintenance) and there's no obvious linkage between the TM:PE Disable Despawning toolbar button and the filters in mod options.

I'm wondering if it would be better to refactor how despawning works more generally? For example:

• Move the filters to a pop-up panel
• Right-click on the Disable Despawning toolbar button = open panel
• User chooses which vehicle types are allowed (disallowed?) to despawn
• Left clicking the toolbar button works as it currently does, toggling the main despawn option

[krzychu124]

@aubergine10 what do you think?

[originalfoo]

Looks good!

[krzychu124]

Updated.
Also, I think we could change that if..else for missing translation keys to cover Stable and TEST till we add missing options (as translation keys are not final yet).

[originalfoo]

Also, I think we could change that if..else for missing translation keys to cover Stable and TEST till we add missing options (as translation keys are not final yet).

??

[krzychu124]

Also, I think we could change that if..else for missing translation keys to cover Stable and TEST till we add missing options (as translation keys are not final yet).

??

You've created some code in LookupTable to show stripped translation key if not found. Instead of "¶Checkbox: Something something" it shows "Something something"
It does not work on TEST build and few users already reported that, unless you changed something since implementation: 3960c45

[krzychu124]

Waiting for #1444

[originalfoo]

Just been testing this again and it still feels a bit weird the association of Disable Despawning and Allow Despawn.

I noticed also that the Disable Despawning mod option was at some point in the past inverted from Allow Despawn meaning we have weirdness like this to contend with in (de)serialization:

// OptionsManager.LoadData():
GameplayTab_VehicleBehaviourGroup.DisableDespawning.Value = !LoadBool(data, idx: 15, true); // inverted

// OptionsManager.SaveData():
save[15] = (byte)(Options.disableDespawning ? 0 : 1); // inverted

Would it make sense to rename the Disable Despawning option to Allow Despawning (and then the Allow Despawn filters seem a bit more natural in that context)? It would mean we could remove the weird byte inversion too, so existing saves would work as expected.

Also it would mean that Options.AllowDespawn.Value == AllowedDespawnVehicleTypes > 0 at any given time, making interaction/sync between filters and checkbox much more semantic.

[krzychu124]

To me making an option: Allow despawn suggest that despawning is disabled by default.
I don't like messing with options since the model is pretty fragile. Up to you, just don't break anything 😂

[kianzarrin]

I think multi-select dropdown is more suitable here (I have used it a lot if you needed any help).

[kianzarrin]

see comments above

[krzychu124]

I think multi-select dropdown is more suitable here (I have used it a lot if you needed any help).

Keep in mind that modal opens when you right click despawning button on the main menu in game (tooltip needs an update). I wanted to create single solution for all.

[krzychu124]

I've added ExtVehicleType to IsFlagSet and callback to make the button read-only when Disable despawning is not active

[kianzarrin]

Cool.

Maybe it would be nice to indent that button if possible to make it clear it belongs to Disable de-spawning. (I have some code for that in my mod if you needed help)

[krzychu124]

@kianzarrin I'm not sure if necessary, I already tweaked the button text so IMO it's pretty descriptive what it does and when it is active:

[originalfoo]

@kianzarrin can you post link to your code for indenting buttons and I'll add that to the base button class in separate PR as part of 11.6.5.2 branch.

[originalfoo]

LGTM 👍

[kianzarrin]

@aubergine10 my code actually puts the checkbox and the button in the same raw
https://github.com/kianzarrin/LoadOrder/blob/260f79ba8287040ab8c78e0c29d02e76370977d9/LoadOrderMod/Settings/Settings.cs#L39

but it can be modified to indent the button. we need to add a panel. I think this should work:

            var container = button.parent as UIComponent; // not sure about this line. 
            var panel = container.AddUIComponent<UIPanel>();
            panel.width = container.width;
            panel.height = button.height;

            button.AlignTo(panel, UIAlignAnchor.TopLeft);
            button.relativePosition += new Vector3(10, 0);