Allow exporting custom resources from/to GDScript, VisualScript, C#, and PluginScript.

[willnationsdev]

Old Content:

This is a partial complete 4.0 port of #44879. It does not include the GDScript changes from that PR. (Edit: it now exports GDScript resources in the new parser, and as far as I can tell, NativeScript and PluginScript have been rendered moot by GDNative Extensions)

The changes have been split up into digestible chunks as separate commits. That should hopefully make it easier to review.

While I've tested it somewhat in 3.2.x, I have not yet had a chance to test this 4.0 port thoroughly.

I believe the most controversial set of changes for which I have received limited feedback is "Make script class editor UX feel like C++ types." I recall I wrote it in to help address related proposals, but I can't quite recall now which ones they were. Stuff about making named scripted types having a more authentic feel. Anyway, whether that commit is included really needs more community feedback.

When a final approved version of the PR is ready, I can squash the commits and amend the message.

Also related is #48056 which has duplicate/similar code changes for some parts of the C# support section from this PR.

Edit: Sorry about the 3D nodes reviewers. Accidentally included a previous commit in one of my rebased pushes. Please ignore > that.

I have saved the old history of changes under a new branch called gdres-all-4.0-v1. From this point forward, since this is the PR most people are already "tracking" for solving this issue, I'm going to use it as a staging ground for merging together any relevant PRs that are separately submitted so that others can more easily grab everything significant with which to test out the functionality.

Child PRs:

• Add GDScript resource export. #62411
• Script-class-aware Inspector & related controls. #62413
• Enable QuickOpen to see scripted resources #62417
• Add C# resource export. #63126

Demo Project (Relies on all of the child PRs being present, which they are in this branch's history):
Demo_InspectorResources.zip

Demo Project for C#/Mono (also relies on all child PRs being present):
Demo_InspectorResources_Mono.zip

Bugsquad edit:

• Implements and closes Add first-class custom resource support godot-proposals#18

[willnationsdev]

I have now rebased this to adapt to the introduction of EditorResourcePicker and EditorScriptPicker, though the Inspector functionality now needs testing again (I didn't have time to test). I also added the documentation changes that I forward-ported from the 3.x version of this PR.

[willnationsdev]

Made several changes to the ScriptServer API and the VisualScript script class changes so that StringNames were used in place of String for class name member variables and method parameters. Since these all just get translated into String types in 3.x, it isn't strictly necessary to backport them, though I may do so anyway before the 3.x version is reviewed, just to keep the code more in sync. It's particularly important to get it set up correctly in this PR since String and StringName are different types in the 4.0 scripting API. Naturally, this also updates the XML doc files, so those were affected too.

[RedwanFox]

Will this PR make its way before feature freeze?

[akien-mga]

Yes, there won't be 4.0 beta without this implemented.

Edit: And well now that 4.0 beta 1 has been released some users are prompt at pointing out the failed promise. This feature is still planned for 4.0 and we'll get it implemented one way or another as time and resources permit. Some core changes are needed to facilitate implementing this properly and @reduz will have to work on it when he finds time.

[willnationsdev]

FYI, C# is temporarily removed from this "all together" build because of various inconsistent compiler errors I was getting that seem to be tied to the Mono code not being up-to-date(?). Just going to stop maintaining the C# support (#63126) until advised otherwise since the .NET 6 version will just convert them into native engine types using GDExtension integrations (i.e. they won't even need "global script class" support).

[willnationsdev]

I've just rebased all of the child PRs and re-created this PR, now including the Mono C# support again, so that folks can fully test everything out. Please let me know if you experience any issues.

[antonWetzel]

I would like to test the feature but I get non-trivial merge conflicts, especially with csharp after the merge of dotnet 6. Is there any date this might be possible to merge again?

[CsloudX]

Love this feature so much. @willnationsdev

[willnationsdev]

@antonWetzel I have just now rebased this PR. I had to remove the C# functionality once again, cause I'm pretty sure MOST of what I wrote is completely unnecessary now. I would need to actually find time to get working C# code in the latest beta to figure out where things stand, what's missing, and how best to fill in those missing pieces. In the meantime, C# should at least be accessible from GDScript with these changes since C# is now set up as in-engine classes (to my understanding). I just don't know yet if C# already has proper Export attributes to handle exporting user-defined script resources (or lists thereof - I kinda doubt it has support for either).

From akien's comment above though, it sounds as though these child PRs will need another rebasing that take into account whatever changes reduz is gonna make later down the line. In the meantime, I hope people can "test" it adequately in its current state.

[Calinou]

@willnationsdev Is this PR superseded by #62413 and others?

[akien-mga]

@willnationsdev Is this PR superseded by #62413 and others?

Yes it should be.

[Clonkex]

Apologies if this should be obvious, but should I be able to create a custom resource in C# in beta 6? I've gone through all the relevant issues and pull requests I can find but there's too many for me to follow what the current status of this is. I tried extending Resource but the new resource type didn't show up in the editor. Also, when I export a field requiring the custom resource (like [Export] public Shape shape where Shape : Resource) the picker in the editor just shows a giant list of every possible resource instead of only the Shape resource or its subclasses as I would expect.

So, in Godot 4.0 beta 6, is there a way to create a custom resource in C# that will show up in the editor properly?

[raulsntos]

@Clonkex It's not in C# yet, the relevant PR is #63126