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

Add filter buttons to core/custom classes in the Search Help dialog #4285

Open
dalexeev opened this issue Mar 26, 2022 · 1 comment
Open

Comments

@dalexeev
Copy link
Member

Describe the project you are working on

A game.

Describe the problem or limitation you are having in your project

Godot 4.0-dev introduced a script documentation feature. But all your scripts in the project get into the Search Help dialog. When you're looking for engine documentation, your own scripts only get in the way. When you want to look at the structure of a project, you might want to hide the core classes.

Describe the feature / enhancement and how it helps to overcome the problem or limitation

Add the following buttons to the dialog:

  • Show Engine Classes
  • Show Named Classes
  • Show Unnamed Classes

These buttons work like filters. When a class category button is pressed, the corresponding classes are shown in the list. When released, these classes are hidden.

In tree view, the parent classes of all selected categories are displayed whether they belong to the selected categories or not (to show the hierarchy). Such classes can be highlighted in a different color.

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

Also, it would be nice to add a similar filter/setting for the help pages:

If this enhancement will not be used often, can it be worked around with a few lines of script?

As far as I know, this cannot be done with an add-on.

Is there a reason why this should be core and not an add-on in the asset library?

As far as I know, this cannot be done with an add-on.

@dalexeev
Copy link
Member Author

Another filter idea: show/hide classes that are available only in editor builds (EditorScriptPicker, FileSystemDock, VisualScriptNode, etc).

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

2 participants