Add GDScript resource export. #62411

willnationsdev · 2022-06-25T20:56:42Z

Adds support for GDScript to be able to export user-defined resource types.

Related Issues:

Add first-class custom resource support godot-proposals#18

Related PRs:

Allow exporting custom resources from/to GDScript, VisualScript, C#, and PluginScript. #48201
- implements the GDScript component

Sibling PRs:

Considerations:

GDScript does not yet support exports for non-GDScript languages because there is no @export("<typename>") syntax yet.

PoisonousGame · 2022-07-01T11:50:14Z

willnationsdev · 2022-07-05T07:20:58Z

If you were attempting to test out just this pull request, then the way to do that would more or less be to confirm whether the GDScript compiler gave you some sort of error when attempting to export a user-defined resource type (whether through static typing or not). I'm not really sure you tested this out correctly.

willnationsdev · 2022-07-17T22:31:36Z

@vnen I was just getting C# working and made an attempt to export C# types in a GDScript property when I ran into some trouble. I have no way to export a global C# resource property from a GDScript node or resource. I would like clarification on which syntax below should be used. Neither of them are currently supported.

There is no way to have a dynamically typed variable that supports exporting resources, of any kind. So this legacy syntax that used to work in 3.x does not work now.

class_name MyNode
extends Node

# Godot used to let you have a dynamically typed variable
# that would be presented in the Inspector as a global script class resource.
# You could still assign alternative values within the script though, because it has no dynamic type.
@export("MyResource") var my_data

There is no way to statically export global script classes that are not GDScript types. This is because during GDScriptAnalyzer::resolve_datatype(), it detects that the variable is using a global script class, but it then parses that file as a GDScript even if it doesn't have a .gd file extension. It then gets a parse failed error during get_parser_for() and raise_status(), resulting in push_error(vformat(R"(Could not parse global class "%s" from "%s".)", ....); So, the following use case is not allowed either:
```
class_name MyNode
extends Node

# `CSData` would be some C# resource global script class.
@export var cs_data: CSData = null
```

willnationsdev · 2022-07-31T00:54:20Z

I have made an update to this branch that allows GDScript to use global script classes from other languages (NOT GDScript) for static typing. So you should now be able to add a scripting language using GDExtension or add global script classes to VisualScript, and then use those global script classes as static type hints. Then the GDScript language will accurately perform static type checks, provide autocompletion/intellisense, etc. Exporting ones extending Resource also works (option 2 above in my previous comment).

Zireael07 · 2022-09-15T18:40:06Z

Is this going to make it intp 4.0?

willnationsdev · 2022-09-16T06:07:10Z

@Zireael07 Yeah, it should, from what I've heard. There are just some hangups that have to get resolved before it and the sibling PRs can be merged.

reduz

This looks ok to me on the exported part, the analyzer part I have no idea, would appreciate more eyes there.

reduz · 2022-09-16T08:30:09Z

@willnationsdev Thanks hugely for the work in this area. We wanted to discuss and implement a cleaner API for you to rely on that would allow better information retrieval regarding to global classes, which is why we did not want to merge this right away.

Unfortunately, we did not have the time and resources to work on this, and given the demand there is for this feature, and given these PRs are already very good, it will do as-is and we can discuss cleaning up the global class registration in 4.1.

Again, thanks for working on this and apologies for the delay in getting this merged, but circumstances beyond our control made properly reviewing and merging this difficult.

akien-mga · 2022-09-16T12:48:37Z

Tested this PR together with #62413, it seems to work well!

One needs to reload the project after defining a new custom resource with class_name but AFAIK that's been the problem with class_name from the beginning.

@export var some_res: MyCustomRes

works fine to export it from GDScript.

It's properly filtered in the Inspector, with multi-level inheritance taken into account (MyCustomSubRes extends MyCustomRes):

Drag and drop of saved custom resources works from the FileSystem dock:

Just some testing fun :)

(That's an existing issue: #57286.)

I didn't test #62417 for now because it looks way hackier and far reaching into core internals and multiple editor components. We do want it to work in the QuickOpen eventually but I suggest focusing on getting #62411 and #62413 merged first, which IMO implement the missing feature in a quite satisfactory way already.

YuriSizov · 2022-09-16T14:05:05Z

modules/gdscript/gdscript_parser.cpp

@@ -3758,6 +3758,33 @@ bool GDScriptParser::export_annotations(const AnnotationNode *p_annotation, Node
 					return false;
 				}
 				break;
+			case GDScriptParser::DataType::CLASS:
+				// can assume type is a global GDScript class.
+				if (!ClassDB::is_parent_class(export_type.native_type, Resource::get_class_static())) {


Suggested change

if (!ClassDB::is_parent_class(export_type.native_type, Resource::get_class_static())) {

if (!ClassDB::is_parent_class(export_type.native_type, SNAME("Resource"))) {

For consistency with the existing code.

I can definitely make this change, but it also kinda confuses me why this would be preferable implementation-wise (if addressed, it'd be in a totally different proposal/PR probably).

I get that using the cached StaticCString is better here, but if that's the case, why not arrange things so that get_class() and get_class_static() return a StringName that is likewise constructed from _scs_create(...), that way you can get performance benefits of SNAME(...) built into those methods? That would then allow you to clean up all of these stringly-typed class name references throughout the code.

modules/gdscript/gdscript_parser.cpp

modules/gdscript/gdscript_analyzer.cpp

YuriSizov

I just have nitpicks, otherwise looks fine + I trust Akien's testing.

willnationsdev · 2022-09-16T15:03:39Z

@akien-mga

One needs to reload the project after defining a new custom resource with class_name but AFAIK that's been the problem with class_name from the beginning.

Was it? I didn't think that was the case, even in Godot 3.x. Either way, that was already an issue in 4.0 before I implemented all of my stuff. I'm not entirely sure why it's happening, but I haven't yet had time to diagnose the cause. Perhaps something related to EditorData caching information about script class inheritance.

YuriSizov · 2022-09-16T15:07:10Z

Was it? I didn't think that was the case, even in Godot 3.x.

Yes, there are some things that don't update and recognize class_name changes without an editor restart, so we kind of roll with it for now.

willnationsdev · 2022-09-18T02:17:36Z

I've made the requested adjustments. Should be good to go for merge at this point afaik.

akien-mga

Looks good to me, and seems to work well.

@vnen might still want to give the analyzer changes a qualified review but that can be done after merge when he's available.

akien-mga · 2022-09-18T09:00:01Z

Thanks a ton for your work and your patience with this series of PRs - you've officially solved the most upvoted Godot proposal ever 🎉

willnationsdev requested a review from a team as a code owner June 25, 2022 20:56

Calinou added enhancement topic:gdscript labels Jun 25, 2022

Calinou added this to the 4.0 milestone Jun 25, 2022

This was referenced Jun 25, 2022

Script-class-aware Inspector & related controls. #62413

Merged

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

Closed

willnationsdev force-pushed the gdres-gdscript branch 2 times, most recently from 56f1d67 to f2ff10f Compare June 25, 2022 22:02

willnationsdev mentioned this pull request Jun 26, 2022

Enable QuickOpen to see scripted resources #62417

Merged

willnationsdev force-pushed the gdres-gdscript branch from f2ff10f to 6dc84a7 Compare July 16, 2022 16:04

willnationsdev mentioned this pull request Jul 17, 2022

Add C# resource export. #63126

Closed

willnationsdev force-pushed the gdres-gdscript branch 2 times, most recently from 41e3b8b to 1465bd3 Compare July 30, 2022 23:31

willnationsdev force-pushed the gdres-gdscript branch from 1465bd3 to 9b082c8 Compare August 1, 2022 05:07

willnationsdev mentioned this pull request Aug 1, 2022

Add top-level @export to separate class_name. #63758

Open

willnationsdev force-pushed the gdres-gdscript branch from 9b082c8 to 497d711 Compare August 19, 2022 00:04

willnationsdev force-pushed the gdres-gdscript branch from 497d711 to a3ddf3a Compare September 15, 2022 18:07

reduz approved these changes Sep 16, 2022

View reviewed changes

YuriSizov reviewed Sep 16, 2022

View reviewed changes

modules/gdscript/gdscript_parser.cpp Outdated Show resolved Hide resolved

YuriSizov reviewed Sep 16, 2022

View reviewed changes

modules/gdscript/gdscript_parser.cpp Outdated Show resolved Hide resolved

YuriSizov reviewed Sep 16, 2022

View reviewed changes

modules/gdscript/gdscript_analyzer.cpp Show resolved Hide resolved

YuriSizov approved these changes Sep 16, 2022

View reviewed changes

Add GDScript resource export.

339aba1

willnationsdev force-pushed the gdres-gdscript branch from a3ddf3a to 339aba1 Compare September 17, 2022 23:05

akien-mga approved these changes Sep 18, 2022

View reviewed changes

akien-mga merged commit 0aea7f2 into godotengine:master Sep 18, 2022

akien-mga mentioned this pull request Sep 18, 2022

Add first-class custom resource support godotengine/godot-proposals#18

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GDScript resource export. #62411

Add GDScript resource export. #62411

willnationsdev commented Jun 25, 2022 •

edited

Loading

PoisonousGame commented Jul 1, 2022

willnationsdev commented Jul 5, 2022

willnationsdev commented Jul 17, 2022

willnationsdev commented Jul 31, 2022 •

edited

Loading

Zireael07 commented Sep 15, 2022

willnationsdev commented Sep 16, 2022

reduz left a comment

reduz commented Sep 16, 2022

akien-mga commented Sep 16, 2022 •

edited

Loading

YuriSizov Sep 16, 2022

willnationsdev Sep 17, 2022

YuriSizov left a comment

willnationsdev commented Sep 16, 2022

YuriSizov commented Sep 16, 2022 •

edited

Loading

willnationsdev commented Sep 18, 2022

akien-mga left a comment

akien-mga commented Sep 18, 2022

	if (!ClassDB::is_parent_class(export_type.native_type, Resource::get_class_static())) {
	if (!ClassDB::is_parent_class(export_type.native_type, SNAME("Resource"))) {

Add GDScript resource export. #62411

Add GDScript resource export. #62411

Conversation

willnationsdev commented Jun 25, 2022 • edited Loading

PoisonousGame commented Jul 1, 2022

willnationsdev commented Jul 5, 2022

willnationsdev commented Jul 17, 2022

willnationsdev commented Jul 31, 2022 • edited Loading

Zireael07 commented Sep 15, 2022

willnationsdev commented Sep 16, 2022

reduz left a comment

Choose a reason for hiding this comment

reduz commented Sep 16, 2022

akien-mga commented Sep 16, 2022 • edited Loading

YuriSizov Sep 16, 2022

Choose a reason for hiding this comment

willnationsdev Sep 17, 2022

Choose a reason for hiding this comment

YuriSizov left a comment

Choose a reason for hiding this comment

willnationsdev commented Sep 16, 2022

YuriSizov commented Sep 16, 2022 • edited Loading

willnationsdev commented Sep 18, 2022

akien-mga left a comment

Choose a reason for hiding this comment

akien-mga commented Sep 18, 2022

willnationsdev commented Jun 25, 2022 •

edited

Loading

willnationsdev commented Jul 31, 2022 •

edited

Loading

akien-mga commented Sep 16, 2022 •

edited

Loading

YuriSizov commented Sep 16, 2022 •

edited

Loading