Fix implementation of property_can_revert() in PropertyListHelper
#88665
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
Mickeon
approved these changes
Feb 22, 2024
doc/classes/Object.xml
Outdated
| @@ -220,7 +220,7 @@ | |||
| <return type="bool" /> | |||
| <param index="0" name="property" type="StringName" /> | |||
| <description> | |||
| Override this method to customize the given [param property]'s revert behavior. Should return [code]true[/code] if the [param property] can be reverted in the Inspector dock. Use [method _property_get_revert] to specify the [param property]'s default value. | |||
| Override this method to customize the given [param property]'s revert behavior. Should return [code]true[/code] if the [param property] has a custom default value and is revertable in the Inspector dock. Use [method _property_get_revert] to specify the [param property]'s default value. | |||
There was a problem hiding this comment.
Suggested change
| Override this method to customize the given [param property]'s revert behavior. Should return [code]true[/code] if the [param property] has a custom default value and is revertable in the Inspector dock. Use [method _property_get_revert] to specify the [param property]'s default value. | |
| Override this method to customize the given [param property]'s revert behavior. Should return [code]true[/code] if the [param property] has a custom default value and is revertible in the Inspector dock. Use [method _property_get_revert] to specify the [param property]'s default value. |
or
Suggested change
| Override this method to customize the given [param property]'s revert behavior. Should return [code]true[/code] if the [param property] has a custom default value and is revertable in the Inspector dock. Use [method _property_get_revert] to specify the [param property]'s default value. | |
| Override this method to customize the given [param property]'s revert behavior. Should return [code]true[/code] if the [param property] has a custom default value and can be reverted in the Inspector dock. Use [method _property_get_revert] to specify the [param property]'s default value. |
There was a problem hiding this comment.
I wanted to convey that the property can be reverted, but returning true does not force it (i.e. default is still checked).
KoBeWi
force-pushed
the
nice_help_bro
branch
from
7fc1e3f to
5473c7e
Compare
|
Thanks! |
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.
Apparently
_property_can_revert()is supposed to always return true for a recognized custom property. This PR fixes the PropertyListHelper implementation and clarifies the doc.