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 tooltip description to PhantomCamera properties #55

Closed
ramokz opened this issue Dec 24, 2022 · 5 comments
Closed

Add tooltip description to PhantomCamera properties #55

ramokz opened this issue Dec 24, 2022 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation phantom camera Related to PhantomCamera nodes
Milestone

Comments

@ramokz
Copy link
Owner

ramokz commented Dec 24, 2022

The Problem

All the properties in PhantomCamera classes currently don't have any descriptions for what they do. So the only way to know what each property does is by looking at the wiki documentation, the source code or trial and error.

Proposed Solution

Add a description to each property that explains what each does.

@ramokz ramokz self-assigned this Dec 24, 2022
@ramokz ramokz added documentation Improvements or additions to documentation phantom camera Related to PhantomCamera nodes labels Dec 24, 2022
@ramokz ramokz modified the milestones: 0.3, 0.2, 0.1 Dec 24, 2022
@ramokz ramokz modified the milestones: 0.2, Future Jan 29, 2023
@BenjaTK
Copy link

BenjaTK commented Dec 29, 2023

I could do this if it's needed.

@ramokz
Copy link
Owner Author

ramokz commented Dec 30, 2023

That would be great!

I chucked this into the backlog since I couldn't figure out a way to add descriptions to properties defined using _get_property_list(), not to mention those added from the Properties file, but hadn't spent too long looking into this.

Long term, was thinking of updating the properties to use the new _validate_property approach added in Godot 4.2.

@BenjaTK
Copy link

BenjaTK commented Dec 31, 2023

Hmm. Yeah, I don't think you can do it with _get_property_list. It would work if the variables were in the PhantomCameras scripts and we added documentation comments but since they're in a separate script I'm not sure if it's possible.

@ramokz
Copy link
Owner Author

ramokz commented Jan 1, 2024

That's fine! Will revisit this once the properties get converted down the line.

@ramokz
Copy link
Owner Author

ramokz commented Feb 8, 2024

Closing as it ended up effectively being a duplication of #168

@ramokz ramokz closed this as completed Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation phantom camera Related to PhantomCamera nodes
Projects
Status: Done
Development

No branches or pull requests

2 participants