Add an editor tool to automatically upgrade and re-save meshes

[clayjohn]

Fixes: #83287

This PR adds a popup the first time a surface that needs to be upgraded is encountered. The user can select "Upgrade" to have the engine automatically re-import/re-save all meshes so they are saved with the new format.

Also, changes the warning message (when p_path is available) to:

A surface of " + p_path + " uses an old surface format and needs to be upgraded. The upgrade happens automatically at load time every time until the mesh is saved again or re-imported. Once saved (or re-imported), this mesh will be incompatible with earlier versions of Godot.

[YuriSizov]

I haven't tested it, but from the code point of few it looks good, aside from a couple nits and small suggestions.

[noidexe]

I tested importing a project with 4.1.1 and then opening it with the windows-editor artifact generated by this PR and it seems to work well overall.

I only had an issue with a large gltf file, getting a "Safe save failed" error message. I could reproduce it on Windows 10 and Windows 11, even with Windows Defender disabled. Disabling safe save and reloading the project to re-trigger the conversion worked well. Even with safe save active, just clicking on reimport after the error also seemed to work well.

The rest of the gltf files converted flawlessly so it's probably an unrelated issue. In terms of UX I think everything's much clearer now.

[lostminds]

As reported here #83429 the importer on 4.2 will change the names of some meshes (due to previous bug with mesh name that is now fixed) breaking references. Could this tool be a good place to detect/warn or even deal with this as well when the reimport happens?

[YuriSizov]

@lostminds This is tightly related to checks done in the rendering server, which has nothing to do with the importer. So without a completely different implementation this is not compatible with your suggestion.

For the linked issue we want to introduce a way to version importer behavior, so you can keep the old logic for existing scenes.

[akien-mga]

Tested on https://github.com/team-godog/NGJ2023_Godog and another local prototype, both options work great!

[fire]

I approve of the idea and it's necessary to avoid usability problems upgrading the mesh format.

[akien-mga]

Thanks!

[TokisanGames]

Is there now versioning inside of ArrayMesh?
What Godot versions are meshes upgraded from and to? Only from Godot 4.0 alpha 15 through 4.1.2 upgraded to 4.2?

[clayjohn]

Is there now versioning inside of ArrayMesh?

Yes.

What Godot versions are meshes upgraded from and to? Only from Godot 4.0 alpha 15 through 4.1.2 upgraded to 4.2?

That's right

[Lippanon]

Upgrading engine from v4.2.dev.custom_build [f7bc653] to v4.2.beta.custom_build [9144457]
It seems when upgrading a project that has an addon active (GodotJolt in my case), the first time opening the project there will be a prompt about restarting due to addon:

On selecting Restart, when the project reopens there will be no upgrade prompt, it automatically chooses to upgrade it seems (I can only tell from the console). That probably shouldn't happen.
On selecting Continue, it will eventually bring the mesh upgrade tool.

I'm upgrading a reasonable size project and it corrupts many scenes, removing everything from the tscn file except the first line. It is corrupting scenes that have no meshes in them but I'll try to gather more information before opening an issue.

[TokisanGames]

FYI, only certain GDExtensions like Godot-Jolt and Terrain3D use this prompt.

What creates the restart prompt is set_minimum_library_initialization_level(MODULE_INITIALIZATION_LEVEL_SERVERS) instead of MODULE_INITIALIZATION_LEVEL_SCENE in register_types.cpp. Without this prompt, Godot crashes on the first startup, though that may be resolved in 4.2. See #80850 and #81478.

TokisanGames/Terrain3D@dc007d4#diff-c23d1074e35b344ac28577f61ecb59e92261b451b50fc76b18eec920384c91b0R40

[clayjohn]

@TokisanGames this tool doesn't interact with add-ons at all. If you are having problems with the add-on prompt, I suggest you open an issue about it.

There are known problems with the surface upgrade tool (see #83991) and I am fixing them as quickly as I can.