Implement hidden class in ScriptServer to replace EditorX class being hidden. #91020

ajreckof · 2024-04-22T16:08:55Z

Implements godotengine/godot-proposals#1047
This is the ScriptServer counterpart of #90765

This enables marking scripts as hidden for any ScriptServer. I have done the GdScript implementation (similar to @tool) but have yet to do the same for C# (never built or even used C# so might need some help with that).

For the GdScript syntax this is what I went for as a recommended syntax

@hide class_name CustomClass
extends RichTextLabel

but any place before class_name would work except for this

extends RichTextLabel
@hide class_name CustomClass

modules/gdscript/gdscript_parser.h

editor/editor_file_system.h

core/object/script_language.h

core/object/script_language.cpp

modules/gdscript/gdscript_parser.cpp

ajreckof · 2024-04-23T19:47:47Z

So I've added the C# implementation and separated the C# and Gdscript implementation into their own commits separate from the base one introducing the change in ScriptServer for easier reviewing (could be squashed later).
I'm not sure where to document the new C# attribute if someone could indicate the right place to put it ? (maybe it should be in the godot-docs repo?)

modules/mono/glue/GodotSharp/GodotSharp/Core/Attributes/HideAttribute.cs

modules/mono/glue/GodotSharp/GodotSharp/Core/Bridge/ScriptManagerBridge.cs

raulsntos · 2024-04-23T20:07:28Z

I'm not sure where to document the new C# attribute if someone could indicate the right place to put it ? (maybe it should be in the godot-docs repo?)

The XMLDoc in the C# files should be the equivalent to the documentation you added in @GDScript.xml. For additional documentation you could add it to godot-docs: GDScript reference: Registering named classes for GDScript and C# global classes for C#.

modules/mono/glue/GodotSharp/GodotSharp/Core/Attributes/GlobalClassAttribute.cs

KoBeWi · 2024-04-30T21:15:27Z

modules/gdscript/doc_classes/@GDScript.xml

+		<annotation name="@hide">
+			<return type="void" />
+			<description>
+				Prevent the current class from appearing in the Create Node dialog.


This also applies to Create Resource etc.

KoBeWi

Looks fine on editor side.

raulsntos

The C# changes look good to me. It works as expected when using it with C# scripts.

AThousandShips · 2024-05-01T11:26:18Z

core/object/script_language.cpp

@@ -429,6 +431,10 @@ void ScriptServer::remove_global_class_by_path(const String &p_path) {
 bool ScriptServer::is_global_class(const StringName &p_class) {
 	return global_classes.has(p_class);
 }
+bool ScriptServer::is_class_hidden(const StringName &p_class) {


Suggested change

bool ScriptServer::is_class_hidden(const StringName &p_class) {

bool ScriptServer::is_class_hidden(const StringName &p_class) {

adamscott · 2024-08-20T13:19:40Z

Hi there @ajreckof, my friend! I made a PR not knowing about yours.

I saw your code and it seems very complicated compared to my version. I don't know why we should bind the "hidden" property only to global classes, as it can simply be a boolean set the same way @tool sets is_tool to be true in scripts.

raulsntos · 2024-08-20T14:34:52Z

Why would you hide a script that is not a global class? Those are already not shown in the Add Node/Create Resource dialogs.

mihe · 2025-03-14T11:40:35Z

@ajreckof Any chance that the merge conflicts in this PR (which mostly seem to come from #101489) could be resolved? It would be great to try to get this approved and merged for 4.5.

ajreckof · 2025-03-15T15:21:07Z

@ajreckof Any chance that the merge conflicts in this PR (which mostly seem to come from #101489) could be resolved? It would be great to try to get this approved and merged for 4.5.

I fully agree we first need to get the parent PR merged which I just rebased and answered the last concern. After that we can get this one merged. It would have been great to add this one to 4.4 but unfortunately I was too taken with work and I couldn't push for it.
Edit : forget what i said! I forgot the two PR were independent and just tightly related. So I'm rebasing it right now. I still think both should still be merged on the same pass as this one doesn't make sense without the other.

core/object/script_language.cpp

… hidden.

mihe · 2025-03-17T11:34:55Z

core/object/script_language.cpp

 	ERR_FAIL_COND_MSG(p_class == p_base || (global_classes.has(p_base) && get_global_class_native_base(p_base) == p_class), "Cyclic inheritance in script class.");
 	GlobalScriptClass *existing = global_classes.getptr(p_class);
 	if (existing) {
 		// Update an existing class (only set dirty if something changed).
-		if (existing->base != p_base || existing->path != p_path || existing->language != p_language) {
+		if (existing->base != p_base || existing->path != p_path || existing->language != p_language || existing->language != p_language) {


This new condition seems to be a duplicate.

AThousandShips added enhancement feature proposal topic:editor topic:core labels Apr 22, 2024

ajreckof force-pushed the Implement-hidden-class-in-ScriptServer-to-replace-EditorX-class-being-hidden- branch 2 times, most recently from e81494b to 3dfb4c7 Compare April 23, 2024 12:25

AThousandShips added this to the 4.x milestone Apr 23, 2024

ajreckof force-pushed the Implement-hidden-class-in-ScriptServer-to-replace-EditorX-class-being-hidden- branch from 3dfb4c7 to 350113e Compare April 23, 2024 17:24

ajreckof marked this pull request as ready for review April 23, 2024 17:25

ajreckof requested review from a team as code owners April 23, 2024 17:25

AThousandShips reviewed Apr 23, 2024

View reviewed changes

ajreckof force-pushed the Implement-hidden-class-in-ScriptServer-to-replace-EditorX-class-being-hidden- branch 3 times, most recently from 2b9fb92 to 3ab8c2a Compare April 23, 2024 19:40

raulsntos requested changes Apr 23, 2024

View reviewed changes

modules/mono/glue/GodotSharp/GodotSharp/Core/Attributes/HideAttribute.cs Outdated Show resolved Hide resolved

modules/mono/glue/GodotSharp/GodotSharp/Core/Bridge/ScriptManagerBridge.cs Outdated Show resolved Hide resolved

ajreckof force-pushed the Implement-hidden-class-in-ScriptServer-to-replace-EditorX-class-being-hidden- branch 2 times, most recently from 83ae3b8 to 8bb2abd Compare April 23, 2024 21:34

ajreckof requested a review from raulsntos April 23, 2024 23:06

raulsntos reviewed Apr 24, 2024

View reviewed changes

modules/mono/glue/GodotSharp/GodotSharp/Core/Attributes/GlobalClassAttribute.cs Outdated Show resolved Hide resolved

ajreckof force-pushed the Implement-hidden-class-in-ScriptServer-to-replace-EditorX-class-being-hidden- branch from 8bb2abd to f5092bc Compare April 24, 2024 03:13

KoBeWi reviewed Apr 30, 2024

View reviewed changes

KoBeWi approved these changes Apr 30, 2024

View reviewed changes

raulsntos approved these changes May 1, 2024

View reviewed changes

akien-mga modified the milestones: 4.x, 4.3 May 1, 2024

akien-mga modified the milestones: 4.3, 4.x May 1, 2024

AThousandShips reviewed May 1, 2024

View reviewed changes

raulsntos mentioned this pull request Aug 19, 2024

Add is_internal property to scripts to hide objects from create dialog #95806

Open

adamscott mentioned this pull request Nov 29, 2024

[TRACKER] GDScript class_name #99766

Open

11 tasks

This was referenced Dec 21, 2024

Implement specific functional metadatas for Script instances that contain custom global classes godotengine/godot-proposals#11238

Open

Add @hide_from_dialog and @suffix annotations for GDScript classes #100690

Closed

ajreckof force-pushed the Implement-hidden-class-in-ScriptServer-to-replace-EditorX-class-being-hidden- branch from f5092bc to 59d0fcb Compare March 15, 2025 19:00

ajreckof requested review from a team as code owners March 15, 2025 19:00

ajreckof force-pushed the Implement-hidden-class-in-ScriptServer-to-replace-EditorX-class-being-hidden- branch from 59d0fcb to d52b9e9 Compare March 15, 2025 20:13

AThousandShips reviewed Mar 15, 2025

View reviewed changes

core/object/script_language.cpp Outdated Show resolved Hide resolved

ajreckof added 3 commits March 15, 2025 21:18

Implement hidden class in ScriptServer to replace EditorX class being…

91e5f49

… hidden.

Implement @hide in GdScript.

f7ce55f

Implement Hidden in C#.

6f1f1fc

ajreckof force-pushed the Implement-hidden-class-in-ScriptServer-to-replace-EditorX-class-being-hidden- branch from d52b9e9 to 6f1f1fc Compare March 15, 2025 20:19

mihe reviewed Mar 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement hidden class in ScriptServer to replace EditorX class being hidden. #91020

Implement hidden class in ScriptServer to replace EditorX class being hidden. #91020

ajreckof commented Apr 22, 2024 •

edited by AThousandShips

Loading

ajreckof commented Apr 23, 2024

raulsntos commented Apr 23, 2024

KoBeWi Apr 30, 2024

KoBeWi left a comment

raulsntos left a comment

AThousandShips May 1, 2024

adamscott commented Aug 20, 2024

raulsntos commented Aug 20, 2024

mihe commented Mar 14, 2025

ajreckof commented Mar 15, 2025 •

edited

Loading

mihe Mar 17, 2025

	bool ScriptServer::is_class_hidden(const StringName &p_class) {

	bool ScriptServer::is_class_hidden(const StringName &p_class) {

Implement hidden class in ScriptServer to replace EditorX class being hidden. #91020

Are you sure you want to change the base?

Implement hidden class in ScriptServer to replace EditorX class being hidden. #91020

Conversation

ajreckof commented Apr 22, 2024 • edited by AThousandShips Loading

ajreckof commented Apr 23, 2024

raulsntos commented Apr 23, 2024

KoBeWi Apr 30, 2024

Choose a reason for hiding this comment

KoBeWi left a comment

Choose a reason for hiding this comment

raulsntos left a comment

Choose a reason for hiding this comment

AThousandShips May 1, 2024

Choose a reason for hiding this comment

adamscott commented Aug 20, 2024

raulsntos commented Aug 20, 2024

mihe commented Mar 14, 2025

ajreckof commented Mar 15, 2025 • edited Loading

mihe Mar 17, 2025

Choose a reason for hiding this comment

ajreckof commented Apr 22, 2024 •

edited by AThousandShips

Loading

ajreckof commented Mar 15, 2025 •

edited

Loading