-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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
Deprecate damping
, add reflectivity
to match AudioEffectReverb
's documentation
#99222
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changing the name of a property and its methods breaks compatibility, so this isn't something we can do so lightly.
If it's correct that the name damping
is wrong, then renaming it to reflectivity
may be correct, but a deprecated compatibility binding still needs to be included, so that user projects don't break.
b16ffc0
to
66f63ca
Compare
This is the best I could do. I can't really wrap my head around compatibility issues. |
You did pretty well! This would be sufficient if our compatibility system was advanced enough, but sadly that provides compatibility for GDExtension but not for GDScript. For GDScript we'll want to keep registering normal (not compatibility) The compatibility method bindings are used when doing changes like adding a new optional parameter, which breaks compat for GDExtension but not for GDScript. I can update the PR myself with these changes if you want, it's not something we have well documented currently. |
I'll try to give it my best later. I think i can handle it. |
For reference, take a look at how Control's deprecated |
fb1343a
to
642f65f
Compare
Thanks, @Mickeon. The deprecated 'auto_translate' property were a good reference. I'm glad it was able to pass CI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to let someone else review the compatibility code
damping
to reflectivity
to match AudioEffectReverb
's documentationdamping
, add reflectivity
to match AudioEffectReverb
's documentation
Closes #98945.
Renamed
damping
toreflectivity
in the documentation and class ofAudioEffectReverb
. And tested it.