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 hide annotation to classes #564

Merged
merged 1 commit into from
Jan 11, 2024

Conversation

lilizoey
Copy link
Member

Currently i call the annotation hide but the plugin Unexposed, since hide is probably more intuitive to the user but godot uses exposed as the terminology internally.

Part of #563

@lilizoey lilizoey added feature Adds functionality to the library c: register Register classes, functions and other symbols to GDScript labels Jan 11, 2024
@GodotRust
Copy link

API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-564

Copy link
Member

@Bromeon Bromeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition, thanks!

Comment on lines 365 to 366
/// Even though this class is a `Node` and it has an init function, it still wont show up in the editor as a node you can add to a scene
/// because we have added a `hide` to the class. This will also prevent it from showing up in documentation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Even though this class is a `Node` and it has an init function, it still wont show up in the editor as a node you can add to a scene
/// because we have added a `hide` to the class. This will also prevent it from showing up in documentation.
/// Even though this class is a `Node` and it has an init function, it still won't show up in the editor as a node you can add to a scene
/// because we have added a `hide` key to the class. This will also prevent it from showing up in documentation.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@Bromeon Bromeon added this pull request to the merge queue Jan 11, 2024
Merged via the queue into godot-rust:master with commit e3b61cc Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: register Register classes, functions and other symbols to GDScript feature Adds functionality to the library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants