Improve mod options lifecycle in editors

[originalfoo]

Compiled mod for testing: TMPE.zip

TM:PE mod options should not be persisted while in editors, particularly the map/scenario editor (which are essentially savegames; any user starting new city from them would get unexpected options set = confuses users).

This PR makes the following changes:

• Mod options are never persisted in editors
  • Note: Other data such as road customisations is unaffected by this change
• When starting a new game, options will always be reset to default
• When loading a savegame, options are loaded normally
• If no data to deserialize, default options will be applied

Additionally:

• TTL tools can now be used in the map/scenario editor

Fixes: #1423
Updates: #1452
Updates: #1449
Updates: #959

[originalfoo]

@krzychu124 Is the CI artifact thing still disabled?

[krzychu124]

How does that fix the issue? In asset editor that function is not used at all IIRC

[krzychu124]

@krzychu124 Is the CI artifact thing still disabled?

Enabled and rerun builds, we will see if works

[originalfoo]

@krzychu124 Is the CI artifact thing still disabled?

Enabled and rerun builds, we will see if works

Yup, working again :)

[originalfoo]

How does that fix the issue? In asset editor that function is not used at all IIRC

The asset editor has auto-save interval in map editor. IIRC that will be triggering any mods to save their stuff in to the map (which is essentially a savegame file tagged "Map" instead of "Savegame").

[originalfoo]

If is saving TM:PE options to map in the editor, then a better fix would be to check for PlayMode right at the outset in TMPELifecycle:

public override void OnSaveData() => if (PlayMode) Save();

Note: I have no clue what effect that would have on whatever it is that TM:PE does to store road customisations in the editors.

[krzychu124]

I'll check the save loop later to see what is going on

[originalfoo]

I suspect the primary cause is the way we currently define defaults in the option fields themselves which means they can be overwritten by previous in-game or in-editor session when doing subsequent load in the same app session.

#1423 (comment)

[krzychu124]

Is it ready for review? After looking how it works it seem that should fix the issue

[originalfoo]

Was it actually saving options/etc to map in Map Editor?

[krzychu124]

Map created in the map editor is like regular save game but running in special mode to limit interactions. Once created, new games created from it becomes detached from the source so any later updates to original map won't affect games that has been already created.
I've not tested it yet, but knowing that it makes sense.

[originalfoo]

Should I move the PlayMode check to the TMPELivecycle.OnSaveData() as mentioned in comment above?

I have no clue how road customisation data gets saved in map/asset editor (ie. stuff we do want storing in the map/asset file) so not sure if it will have unintentional effects.

[originalfoo]

Also... should I add something that checks NewGame or NewGameFromScenario and if true prevent loading options (and other?) data? That would help solve any issues relating to maps that are already out there containing stored options/settings.

[krzychu124]

Should I move the PlayMode check to the TMPELivecycle.OnSaveData() as mentioned in comment above?

I have no clue how road customisation data gets saved in map/asset editor (ie. stuff we do want storing in the map/asset file) so not sure if it will have unintentional effects.

If you mean if (PlayMode) Save(); -> that will completely break saving other things in the map editor (arrows, lane connections etc.)

should I add something that checks NewGame or NewGameFromScenario

yes, that might help if the user subscribed to already published maps on workshop

(and other?)

Which other? AFAIK Timed traffic lights could be enabled in the map editor since created "map" is in 99% a regular savegame, but still disabled in asset editor because asset segments/nodes needs to be remapped after creation (asset editor segment/node ids are just the template to mirror settings) and we don't have mapper for TTL

[originalfoo]

Tweaked how it works - see OP for details.

EDIT: Ready for review.

[originalfoo]

@krzychu124 any further comments on this?

[kianzarrin]

I do allow NC options to be stored in map mode so that the when the user loads a map the roads wouldn't change slopes.

[krzychu124]

@krzychu124 any further comments on this?

I'm going to test it when I clear my github notification list :)

[originalfoo]

Need some additional tweaks as per #1452 (comment)

brb

[originalfoo]

Just pushed a commit which:

• Allows TTL tool in map/scenario editor
  • ...essentially a save game, so TTL customisations should carry across to new games
• Only force option reset to default when starting new games (from map or scenario).

[originalfoo]

Waiting for more review prior to merge.

[krzychu124]

Wiki needs an update because features listed in the table below are enabled by default 😉

As of PR, tested scenario, looks like it nicely saves and loads tmpe feature settings, options are not loaded unless I already saved wrong settings with previous version of the mod. Still need to test map save and restore of TTL, just in case if you haven't already.

[originalfoo]

Wiki needs an update

Done :)

Still need to test map save and restore of TTL, just in case if you haven't already.

I've only tested the scenario editor, I've not yet tested map editor.

[kianzarrin]

it does fix the icons in new game

[krzychu124]

it does fix the icons in new game

Yeah, I already merged in atlas fix from #1451 :)
We didn't test saving/loading settings in Map editor and that's probably the last thing that needs to be tested before merging this.

[krzychu124]

Working in map editor and scenario editor, loads and saves all tm:pe features, mod options are not saved 👍 Works as expected in the Asset/intersection editor.