Export support for gdscript resource types #26162

vixelz · 2019-02-22T16:10:55Z

Allow GDScript export statements to export global class types.

Updates gdscriptparser to accept identifiers as export types, and resolve them at around the same time as export-type / type-hint checking.
Adds a method to editordata to be able to check if one class is equal to, or a parent of another, regardless of whether the class being checked is a native class or a script
Updated editorpropertyresource to handle the above changes:
- Filter drag drop
- Detecting if resources assigned via "Load" are of the correct type
- Builds on Include global class resources in Resource property inspector #26122 to provide better property resource inlining

Zylann · 2019-02-22T18:27:30Z

Note that if the script you export extends a node type, it will leak unless you add it to the tree in code or free it.

Zireael07 · 2019-02-22T18:42:38Z

@Zylann I believe that bit it worth adding to the docs?

vixelz · 2019-02-22T22:49:34Z

@Zylann if I'm understanding correctly, I think this shouldn't be an issue because the type resolution step should ensure that the exported type derives from Resource, either directly or through other global script classes.

samgreen · 2019-02-24T06:37:06Z

This is wonderful

Much like how script defined global classes can be created from the "New Resource..." button in the FileSystem panel, this allows the creation of script defined resources to be embedded.

vixelz · 2019-03-11T01:02:02Z

This has broken and conflicts with other changes. I'm going to wait till 3.1 is branched and I'll fix it up for review in to 3.2

akien-mga · 2019-04-30T11:36:12Z

This needs a rebase (and a review, ping @vnen @bojidar-bg).

bojidar-bg · 2019-04-30T12:18:56Z

Solves same issue as #22660?

akien-mga · 2019-05-29T14:05:51Z

Still needs a rebase. Should be compared with #22660 which seems to address a similar feature, to see which implementation is the most interesting (if they do overlap). CC @willnationsdev

willnationsdev · 2019-05-29T14:09:24Z

@akien-mga Mine stopped working quite a ways back and I never went back to fix it (and it was buggy to begin with), so I'd opt to go for this solution over the one I wrote.

willnationsdev

@vixelz Out of curiosity, does the implementation work with resources declared as constants too and/or arrays of custom resources?

willnationsdev · 2019-05-29T14:12:40Z

editor/editor_properties.cpp

@@ -2754,6 +2770,20 @@ void EditorPropertyResource::set_use_sub_inspector(bool p_enable) {
 	use_sub_inspector = p_enable;
 }

+String EditorPropertyResource::_get_file_script_name_or_default(const RES &p_resource) const {
+	Ref<Script> rscript = p_resource->get_script();
+	if (rscript != 0) {


For consistency/clarity, I would recommend making this be if (rscript.is_valid()) or something.

xDGameStudios · 2019-06-30T18:26:48Z

Ohh I can’t wait for this to be rebased and merged! Please let it be soon! ;)

ClementRivaille · 2019-08-18T14:16:09Z

I've encountered an error while testing the branch. If I try to type an exported var, I get the error:

export hint type (GDScriptNativeClass) doesn't match the variable type ({Class})

This will appear on any type of export, whether they're custom, native, or even primitive.

# None of those work
export(Texture) var texture: Texture
export(int) var index: int
export(String) var text := "Hello"
export(Array, AudioStream) var streams: Array

The error can be avoided by not typing exported variables. This is not convenient though, as it prevents auto-completion, safe lines… Well, everything that comes with typed variables.

I see the branch needs to be rebased, so maybe this has already been fixed on master. I hope this feature will soon be included in a release, because it might become indispensable for plugins! :)

akien-mga · 2019-09-02T14:24:23Z

We discussed this briefly on IRC with @vnen and @bojidar-bg, some comments:

16:05 <Akien> Next: #26162
16:05 <IssueBot> #26162: Export support for gdscript resource types | https://git.io/fhF7v
16:08 <bojidar_bg> I feel like reducing constants might be a better idea than checking for identifiers separatelly
16:09 <bojidar_bg> .. we are already reducing the constant though D:
16:12 <vnen> constant reduction does not always happen with current implementation
16:16 <bojidar_bg> it uses global script names exclusively, which might cause trouble later on
16:17 <vnen> why would it cause trouble?
16:17 <bojidar_bg> `const X = preload("res://X.gd)`, `export var x: X`
16:18 <bojidar_bg> also, if the global class names start getting resolved to a constant, it will break
16:19 <vnen> not sure if you can declare a constant if the name is already in the global scope
16:19 <vnen> in any case, the implementation is complex and may need to be reviewed properly (code for export vars is one of the most complex in the parser)
16:20 <vnen> and there's a valid issue raised in the last comment

As we're in feature freeze for 3.2 and this PR is not merge-ready for now, moving to the 4.0 milestone. It's a good feature proposal though, but some updates and a thorough review are needed.

hsandt · 2020-04-10T12:06:17Z

editor/editor_properties.h

@@ -582,6 +582,8 @@ class EditorPropertyResource : public EditorProperty {
 	void _button_input(const Ref<InputEvent> &p_event);
 	void _open_editor_pressed();
 	void _fold_other_editors(Object *p_self);
+


Just clean whitespaces in empty line to pass clang-format in Travis

aaronfranke · 2020-05-13T07:54:36Z

@vixelz Is this still desired? If so, it needs to be rebased on the latest master branch. Additionally, the above feedback needs to be addressed.

If not, abandoned pull requests will be closed in the future as announced here.

rcorre · 2020-05-13T11:43:47Z

@aaronfranke I'm still interested and happy to finish the work if @vixelz does not.

GalaxyCr8r · 2020-05-13T12:41:58Z

For what its worth, I am very much interested in this feature - working on a space station economy simulator and this would make the data-driven exports soooo much cleaner.

willnationsdev · 2020-05-13T13:34:40Z

@aaronfranke @rcorre I'd thought that my PR was further along in this as it is derived from vixelz's initial work. I am planning to rebase and fixup that PR too. #32018

aaronfranke · 2020-06-17T01:08:12Z

This PR has not received any new commits for over a year and is abandoned by the author, closing.

This PR can be salvaged, but it seems that @willnationsdev is already doing so.

vixelz requested review from bojidar-bg, reduz and vnen as code owners February 22, 2019 16:10

vixelz force-pushed the export-gdscript-resource-types branch 3 times, most recently from aca178b to 4e62432 Compare February 22, 2019 17:06

bruvzg added enhancement topic:gdscript labels Feb 22, 2019

hpvb added this to the 3.2 milestone Feb 22, 2019

vixelz force-pushed the export-gdscript-resource-types branch 2 times, most recently from 2d12065 to dc87d74 Compare February 23, 2019 09:57

vixelz force-pushed the export-gdscript-resource-types branch from dc87d74 to 450b34c Compare February 26, 2019 21:26

vixelz added 2 commits March 5, 2019 09:21

Include global class resources in Resource property inspector

a6152db

Much like how script defined global classes can be created from the "New Resource..." button in the FileSystem panel, this allows the creation of script defined resources to be embedded.

GDScript support for exporting script defined global classes

2b7b64f

vixelz force-pushed the export-gdscript-resource-types branch from 450b34c to 2b7b64f Compare March 5, 2019 09:56

akien-mga removed the request for review from reduz April 30, 2019 12:44

willnationsdev reviewed May 29, 2019

View reviewed changes

erodozer mentioned this pull request Jun 30, 2019

Add GDScript exports for pre-loaded const Resource scripts and Resource-derived script classes. #22660

Closed

ClementRivaille mentioned this pull request Aug 18, 2019

Custom-made resource types cannot be used in export statement #6763

Closed

akien-mga added the needs work label Aug 28, 2019

akien-mga modified the milestones: 3.2, 4.0 Sep 2, 2019

vnen mentioned this pull request Sep 5, 2019

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

Closed

willnationsdev mentioned this pull request Sep 6, 2019

Enable script class resource exports. #32018

Closed

rcorre mentioned this pull request Jan 1, 2020

Use fuzzy selection in more places godotengine/godot-proposals#346

Open

distractedmosfet mentioned this pull request Jan 18, 2020

First pass at entity definition system. QodotPlugin/qodot-plugin#66

Merged

hsandt reviewed Apr 10, 2020

View reviewed changes

rsubtil mentioned this pull request Jun 13, 2020

Exported custom Resource can be assigned any res type - no warning, and broken at runtime #39499

Closed

aaronfranke closed this Jun 17, 2020

aaronfranke added archived salvageable labels Jun 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Export support for gdscript resource types #26162

Export support for gdscript resource types #26162

vixelz commented Feb 22, 2019 •

edited

Loading

Zylann commented Feb 22, 2019 •

edited

Loading

Zireael07 commented Feb 22, 2019

vixelz commented Feb 22, 2019

samgreen commented Feb 24, 2019

vixelz commented Mar 11, 2019

akien-mga commented Apr 30, 2019

bojidar-bg commented Apr 30, 2019

akien-mga commented May 29, 2019

willnationsdev commented May 29, 2019

willnationsdev left a comment

willnationsdev May 29, 2019

xDGameStudios commented Jun 30, 2019

ClementRivaille commented Aug 18, 2019

akien-mga commented Sep 2, 2019

hsandt Apr 10, 2020

aaronfranke commented May 13, 2020

rcorre commented May 13, 2020

GalaxyCr8r commented May 13, 2020

willnationsdev commented May 13, 2020

aaronfranke commented Jun 17, 2020

Export support for gdscript resource types #26162

Export support for gdscript resource types #26162

Conversation

vixelz commented Feb 22, 2019 • edited Loading

Zylann commented Feb 22, 2019 • edited Loading

Zireael07 commented Feb 22, 2019

vixelz commented Feb 22, 2019

samgreen commented Feb 24, 2019

vixelz commented Mar 11, 2019

akien-mga commented Apr 30, 2019

bojidar-bg commented Apr 30, 2019

akien-mga commented May 29, 2019

willnationsdev commented May 29, 2019

willnationsdev left a comment

Choose a reason for hiding this comment

willnationsdev May 29, 2019

Choose a reason for hiding this comment

xDGameStudios commented Jun 30, 2019

ClementRivaille commented Aug 18, 2019

akien-mga commented Sep 2, 2019

hsandt Apr 10, 2020

Choose a reason for hiding this comment

aaronfranke commented May 13, 2020

rcorre commented May 13, 2020

GalaxyCr8r commented May 13, 2020

willnationsdev commented May 13, 2020

aaronfranke commented Jun 17, 2020

vixelz commented Feb 22, 2019 •

edited

Loading

Zylann commented Feb 22, 2019 •

edited

Loading