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

Fill remaining global scope constant descriptions #83652

Merged
merged 1 commit into from
Nov 13, 2023

Conversation

KoBeWi
Copy link
Member

@KoBeWi KoBeWi commented Oct 20, 2023

Brings @GlobalScope to 100% completion.

Note that some of the constants were very obscure and I'm not sure if everything is 100% correct.

@KoBeWi KoBeWi added this to the 4.2 milestone Oct 20, 2023
@KoBeWi KoBeWi requested a review from a team as a code owner October 20, 2023 00:40
@@ -2823,6 +2823,7 @@
Hints that a [Color] property should be edited without affecting its transparency ([member Color.a] is not editable).
</constant>
<constant name="PROPERTY_HINT_OBJECT_ID" value="22" enum="PropertyHint">
Hints that the property's value is an object encoded as [ObjectID], with its type specified in the hint string. Used by the debugger.
Copy link
Member Author

Choose a reason for hiding this comment

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

"object encoded as ObjectID" probably doesn't fully make sense, but it's related to EncodedObjectAsID class, so idk.

doc/classes/@GlobalScope.xml Outdated Show resolved Hide resolved
doc/classes/@GlobalScope.xml Outdated Show resolved Hide resolved
</constant>
<constant name="PROPERTY_USAGE_NIL_IS_VARIANT" value="131072" enum="PropertyUsageFlags" is_bitfield="true">
If property has [code]nil[/code] as default value, its type will be [Variant].
Copy link
Member Author

@KoBeWi KoBeWi Oct 20, 2023

Choose a reason for hiding this comment

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

This looks like documentation hint, not sure what else it does. Also this description is probably not really accurate.

Copy link
Contributor

@YuriSizov YuriSizov Nov 13, 2023

Choose a reason for hiding this comment

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

Seems to be used for method info in core and extension API dump, but that still may be just for the docs. I think what it does is makes sure null values are represented as a variant and not as a null? So instead of saying that a method takes or returns null we say that it returns a variant, even if the data tells us it's a variant of type NIL.

@akien-mga akien-mga requested a review from a team October 20, 2023 07:43
Copy link
Contributor

@YuriSizov YuriSizov left a comment

Choose a reason for hiding this comment

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

This seems overall good to me, but some adjustments are probably necessary as outlined above.

@KoBeWi KoBeWi requested review from a team as code owners November 13, 2023 14:17
@KoBeWi
Copy link
Member Author

KoBeWi commented Nov 13, 2023

I removed references to PROPERTY_USAGE_SCRIPT_DEFAULT_VALUE and PROPERTY_USAGE_DEFERRED_SET_RESOURCE. The former is no longer used (the code no longer exists), the latter was never implemented.

@akien-mga akien-mga merged commit 85ecb85 into godotengine:master Nov 13, 2023
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@KoBeWi KoBeWi deleted the PROPERTY_HINT_DOC_IS_FULL branch November 13, 2023 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants