Move global script class cache to separate file #70557

KoBeWi · 2022-12-25T14:17:58Z

This PR removes _global_script_classes and _global_script_class_icons from project.godot and moves them to a separate file .godot/global_script_class_cache.cfg. The file is also included in the exported project.

Closes godotengine/godot-proposals#5631
Also fixes #62889

dalexeev · 2022-12-25T15:16:12Z

The file is also included in the exported project.

If it's not difficult, could you check if class icons are preserved after export? Perhaps it is worth splitting the cache into two files, since icons are not needed after export?

KoBeWi · 2022-12-25T15:25:20Z

Icon path is just a single string, so it's not worth stripping it. Previously icons were also included, because they were in project.godot.

jtnicholl · 2022-12-26T21:45:52Z

This also closes godotengine/godot-proposals#5631.

zaevi · 2022-12-27T08:07:05Z

Good work, however moving global-class cache to .godot means it loses global-class data when projects need re-generating .godot(like cloning from git).

This will cause some issues. For example: I enable a plugin with global class in my project. If I drop .godot and send the project to others, it will throw error when initializing the project and the plugin won't be enabled (because the editor can't find global class at present).

This is the reproduction for the example: global_class_issue.zip. It will cause error using this branch.

dalexeev · 2022-12-27T09:34:38Z

For example: I enable a plugin with global class in my project. If I drop .godot and send the project to others, it will throw error when initializing the project and the plugin won't be enabled (because the editor can't find global class at present).

If now you try to remove these keys from project.godot and open the project again, will this error occur when the project is initialized or not? A possible solution is to run plugins after the GDScript class cache is initialized?

KoBeWi · 2022-12-27T10:08:52Z

If your plugin preloads a resource (texture, audio) it will have the same problem if the resources are not imported yet.

KoBeWi · 2022-12-28T12:59:16Z

I opened a new PR that should fix this issue #70668

doc/classes/Variant.xml

akien-mga · 2023-01-16T09:22:19Z

One thing we should check is how it works when exporting from the command line without the .godot folder.
We have some logic to force reimport of resources on command line export (possibly broken as I see 4.0 have to use some hacks to get it to work), but will it also generate the script class cache?

Edit: Yep, did a test and that's broken. Trying to export a simple project without existing .godot folder:

$ godot-git --export-debug "Linux/X11" build/lin.x86_64
Godot Engine v4.0.beta.custom_build.6444c7d12 - https://godotengine.org
Vulkan API 1.3.230 - Using Vulkan Device #1: AMD - AMD Radeon RX Vega M GL Graphics (RADV VEGAM)
 
ERROR: Cannot save editor settings to file 'res://.godot/editor/project_metadata.cfg'.
   at: set_project_metadata (editor/editor_settings.cpp:1121)
ERROR: Cannot save editor settings to file 'res://.godot/editor/project_metadata.cfg'.
   at: set_project_metadata (editor/editor_settings.cpp:1121)
ERROR: Cannot save editor settings to file 'res://.godot/editor/project_metadata.cfg'.
   at: set_project_metadata (editor/editor_settings.cpp:1121)
reimport: begin: (Re)Importing Assets steps: 1
        reimport: step 0: icon.svg
ERROR: Condition "f.is_null()" is true.
   at: _save_ctex (editor/import/resource_importer_texture.cpp:340)
ERROR: Cannot open MD5 file 'res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.md5'.
   at: _reimport_file (editor/editor_file_system.cpp:2036)
ERROR: Cannot create file 'res://.godot/editor/filesystem_cache7'. Check user write permissions.
   at: _save_filesystem_cache (editor/editor_file_system.cpp:339)
savepack: begin: Packing steps: 102
ERROR: Can't open file from path 'res://.godot/global_script_class_cache.cfg'.
   at: get_file_as_bytes (core/io/file_access.cpp:699)
        savepack: step 2: Storing File: res://.godot/global_script_class_cache.cfg
ERROR: Can't open file from path 'res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex'.
   at: get_file_as_bytes (core/io/file_access.cpp:699)
        savepack: step 27: Storing File: res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex
        savepack: step 27: Storing File: res://icon.svg.import
ERROR: Unable to open file: res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex.
   at: _load_data (scene/resources/texture.cpp:814)
ERROR: Failed loading resource: res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex. Make sure resources have been imported by opening the project in the editor at least once.
   at: _load (core/io/resource_loader.cpp:214)
ERROR: Failed loading resource: res://icon.svg. Make sure resources have been imported by opening the project in the editor at least once.
   at: _load (core/io/resource_loader.cpp:214)
ERROR: res://node_2d.tscn:15 - Parse Error: [ext_resource] referenced non-loaded resource at: res://icon.svg
   at: _parse_ext_resource (scene/resources/resource_format_text.cpp:178)
        savepack: step 52: Storing File: res://.godot/exported/133200997/export-362256a061aa8890e9a1e558b11e5ec3-node_2d.scn
        savepack: step 77: Storing File: res://SomeClass.gd
        savepack: step 102: Storing File: res://node_2d.tscn.remap
        savepack: step 102: Storing File: res://icon.svg
        savepack: step 102: Storing File: res://.godot/uid_cache.bin
        savepack: step 102: Storing File: res://project.binary
savepack: end
reimport: end
ERROR: Cannot create file 'res://.godot/editor/filesystem_cache7'. Check user write permissions.
   at: _save_filesystem_cache (editor/editor_file_system.cpp:339)
WARNING: Scan thread aborted...
     at: _notification (editor/editor_file_system.cpp:1205)
ERROR: Condition "_first != nullptr" is true.
   at: ~List (./core/templates/self_list.h:106)
ERROR: 3 RID allocations of type 'N18RendererCanvasCull4ItemE' were leaked at exit.
ERROR: 2 RID allocations of type 'PN18TextServerAdvanced22ShapedTextDataAdvancedE' were leaked at exit.
ERROR: 1 RID allocations of type 'PN18TextServerAdvanced12FontAdvancedE' were leaked at exit.
WARNING: ObjectDB instances leaked at exit (run with --verbose for details).
     at: cleanup (core/object/object.cpp:1980)
ERROR: Resources still in use at exit (run with --verbose for details).
   at: clear (core/io/resource.cpp:473)

And the exported project fails to load the script classes:

ERROR: Couldn't find the given section "" and key "list", and no default was given.
   at: get_value (core/io/config_file.cpp:86)

MRP (exporting with editor build compiled from this PR, as "custom debug template"):

TestProj.zip

KoBeWi · 2023-01-16T10:13:19Z

Weird, because it does create the .godot folder with script cache. It's as if export happens too early.

akien-mga · 2023-01-16T10:34:38Z

Yeah this might be related to #69511. I think it was working in 3.x so it seems to be a regression.

For my simple MRP, it works OK by forcing the initial import / script class cache generation with godot-git --headless --editor --quit before exporting. But based on the above issue it probably doesn't work reliably for more complex projects (and it shouldn't be needed at all - Godot should ensure that this step is done before it starts exporting).

KoBeWi · 2023-01-16T10:44:54Z

So assuming it's the same issue as #69511, it's not a problem with this PR and requires the same fix as #69511.

akien-mga · 2023-01-16T12:21:02Z

Thanks!

wickworks · 2023-01-18T14:34:42Z

This has also broken the only way (that I know of, at least) of getting a list of all custom classes in at runtime by using ProjectSettings.get_setting("_global_script_classes").

KoBeWi · 2023-01-18T14:37:19Z

The new way of getting classes is documented.

h0lley · 2023-01-20T19:05:54Z

had to delete the .godot folder for the global_script_class_cache.cfg to be generated.
before that, no custom classes would be registered (class_name ignored).

KoBeWi added enhancement topic:core topic:editor labels Dec 25, 2022

KoBeWi added this to the 4.x milestone Dec 25, 2022

KoBeWi requested review from a team as code owners December 25, 2022 14:17

KoBeWi force-pushed the class_yeet branch from 62d3dc7 to 49bc2d8 Compare December 25, 2022 15:26

akien-mga reviewed Jan 16, 2023

View reviewed changes

doc/classes/Variant.xml Outdated Show resolved Hide resolved

akien-mga approved these changes Jan 16, 2023

View reviewed changes

akien-mga modified the milestones: 4.x, 4.0 Jan 16, 2023

Move global script class cache to separate file

6444c7d

KoBeWi force-pushed the class_yeet branch from 49bc2d8 to 6444c7d Compare January 16, 2023 09:16

akien-mga approved these changes Jan 16, 2023

View reviewed changes

akien-mga merged commit 5ca6c1f into godotengine:master Jan 16, 2023

KoBeWi deleted the class_yeet branch January 16, 2023 12:32

jtnicholl mentioned this pull request Jan 17, 2023

[3.x] Project manager does not parse project.godot files from 4.0 if the project uses class_name #66514

Closed

Qubus0 mentioned this pull request Jan 18, 2023

Autoload order is not affected by override.cfg #71589

Closed

wickworks mentioned this pull request Jan 18, 2023

How to obtain a list of custom classes should be more discoverable godotengine/godot-docs#6632

Open

bitsawer mentioned this pull request Jan 19, 2023

Expose and document ProjectSettings.get_global_class_list() #71665

Merged

YuriSizov mentioned this pull request Jan 20, 2023

ClassDB cannot find/does not include custom classes #71744

Closed

aaronfranke mentioned this pull request Jan 27, 2023

Script classes are not regenerated project-wide after first import #72154

Closed

Qubus0 mentioned this pull request Aug 28, 2023

Set global script classes on Godot 4 GodotModding/godot-mod-loader#335

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move global script class cache to separate file #70557

Move global script class cache to separate file #70557

KoBeWi commented Dec 25, 2022 •

edited

Loading

dalexeev commented Dec 25, 2022

KoBeWi commented Dec 25, 2022

jtnicholl commented Dec 26, 2022

zaevi commented Dec 27, 2022

dalexeev commented Dec 27, 2022

KoBeWi commented Dec 27, 2022

KoBeWi commented Dec 28, 2022

akien-mga commented Jan 16, 2023 •

edited

Loading

KoBeWi commented Jan 16, 2023

akien-mga commented Jan 16, 2023 •

edited

Loading

KoBeWi commented Jan 16, 2023

akien-mga commented Jan 16, 2023

wickworks commented Jan 18, 2023

KoBeWi commented Jan 18, 2023

h0lley commented Jan 20, 2023

Move global script class cache to separate file #70557

Move global script class cache to separate file #70557

Conversation

KoBeWi commented Dec 25, 2022 • edited Loading

dalexeev commented Dec 25, 2022

KoBeWi commented Dec 25, 2022

jtnicholl commented Dec 26, 2022

zaevi commented Dec 27, 2022

dalexeev commented Dec 27, 2022

KoBeWi commented Dec 27, 2022

KoBeWi commented Dec 28, 2022

akien-mga commented Jan 16, 2023 • edited Loading

KoBeWi commented Jan 16, 2023

akien-mga commented Jan 16, 2023 • edited Loading

KoBeWi commented Jan 16, 2023

akien-mga commented Jan 16, 2023

wickworks commented Jan 18, 2023

KoBeWi commented Jan 18, 2023

h0lley commented Jan 20, 2023

KoBeWi commented Dec 25, 2022 •

edited

Loading

akien-mga commented Jan 16, 2023 •

edited

Loading

akien-mga commented Jan 16, 2023 •

edited

Loading