-
-
Notifications
You must be signed in to change notification settings - Fork 21.5k
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
Fill remaining global scope constant descriptions #83652
Conversation
doc/classes/@GlobalScope.xml
Outdated
@@ -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. |
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.
"object encoded as ObjectID" probably doesn't fully make sense, but it's related to EncodedObjectAsID
class, so idk.
</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]. |
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.
This looks like documentation hint, not sure what else it does. Also this description is probably not really accurate.
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.
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
.
2ec5976
to
a4960fe
Compare
a4960fe
to
5d01cc3
Compare
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.
This seems overall good to me, but some adjustments are probably necessary as outlined above.
5d01cc3
to
dca86d1
Compare
dca86d1
to
4296f0a
Compare
I removed references to |
Thanks! |
Brings
@GlobalScope
to 100% completion.Note that some of the constants were very obscure and I'm not sure if everything is 100% correct.