Add get_property_list
#707
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-707 |
d401513 to
e9efb15
Compare
Bromeon
reviewed
May 21, 2024
| #(#cfg_attrs)* | ||
| impl ::godot::obj::cap::GodotGetPropertyList for #class_name { | ||
| fn __godot_get_property_list(&mut self) -> Vec<::godot::builtin::meta::PropertyInfo> { | ||
| // Only supported in godot api > 4.3. If support is added for earlier versions this is still needed. |
There was a problem hiding this comment.
You probably mean >= 4.3 here and not >.
Also not exactly sure what you mean by "If support is added for earlier versions this is still needed.", could you maybe elaborate what you mean by "support" and "this is still needed"?
(also capitalization, "Godot API")
godot-core/src/builtin/meta/mod.rs
Outdated
| use crate::engine::global; | ||
| use crate::engine::global::{self, PropertyHint, PropertyUsageFlags}; | ||
| use crate::property::{Export, PropertyHintInfo}; | ||
| use crate::{builtin::*, property::Var}; |
Comment on lines
+299
to
+307
| // No UB or anything else like a crash or panic should happen when `property_can_revert` and `property_get_revert` return | ||
| // inconsistent values, but in case something like that happens we should be able to detect it through this function. | ||
| "property_changes" => { | ||
| if INC.fetch_add(1, std::sync::atomic::Ordering::AcqRel) % 2 == 0 { | ||
| None | ||
| } else { | ||
| Some(true.to_variant()) | ||
| } | ||
| } |
Add `property_can_revert`
Cleanup a couple of things
e9efb15 to
54ac2fc
Compare
Bromeon
approved these changes
May 25, 2024
21 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This does three main things
Adds
get_property_listAlso adds
property_get_revert/property_can_revert(combined into one function).This allows the user to fully dynamically generate the property list as well as set all relevant options for the property list. This also provides a mechanism to group exports in the editor #226, however it's not the most ergonomic way as it requires all grouped properties to be defined in the
get_property_listmethod.Adds some convenience functions to
PropertyInfoThis makes it easier to generate property infos corresponding to the usual property types. For instance to generate a
#[var]declaration you can now just doPropertyInfo::new_var::<Type>("property_name")rather than needing to specify all the individual properties.I also added documentation to each field of
PropertyInfosince it's a more public facing type like this.Adds sys-conversions that pass ownership for
PropertyInfo,GString, andStringNameUnlike
sys(), these methods namedinto_owned_(string/property)_sysandfree_owned_(string/property)_sysallow us to convert aPropertyInfodirectly into asys::GDExtensionPropertyInfowhile:free_*function can appropriately free the value later)This is used in
get_property_listandfree_property_listto pass a list of property infos to Godot and then later free the values.closes #665