Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Classes that are exposed but lead to empty docs pages. #76918

Open
MewPurPur opened this issue May 10, 2023 · 3 comments
Open

Classes that are exposed but lead to empty docs pages. #76918

MewPurPur opened this issue May 10, 2023 · 3 comments

Comments

@MewPurPur
Copy link
Contributor

MewPurPur commented May 10, 2023

Godot version

4.0.2

System information

Ubuntu 22.04.1 LTS

Issue description

I found two classes are exposed to scripting. They are highlighted as such:

image

But they are undocumented - nothing in F1, and Ctrl+LMB leads here:

image

I also noticed that GodotSharp is listed in GlobalScope's documentation, yet leads to a similar empty documentation page, but it might not be related.

I know that the GDScriptNative class can show up like this:

print(Node)  # <GDScriptNativeClass#-9223372027929296496>

I know nothing about the other class, though.

Steps to reproduce

Here are all such classes I discovered:

EditorHelp
FramebufferCacheRD
GodotPhysicsServer2D
GodotPhysicsServer3D
GDScriptEditorTranslationParserPlugin
GDScriptNativeClass
IPUnix
ResourceImporterOggVorbis
ResourceImporterMP3
ResourceFormatImporterSaver
UniformSetCacheRD

Minimal reproduction project

N/A

@MewPurPur
Copy link
Contributor Author

MewPurPur commented May 10, 2023

I assume these classes should have documentation pages even if they don't have methods - similar to TextServerDummy. Weirdly enough, GDScriptNative is also not in autocomplete.

@dalexeev
Copy link
Member

GDScriptNativeClass is not exposed, but you can obtain it in GDScript. And this is a problem, as there is confusion between static methods of a class and non-static methods of a class object.

@dsnopek
Copy link
Contributor

dsnopek commented Aug 29, 2023

It seems like we need a ClassDB::is_class_exposed(class_name) check somewhere?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants