-
-
Notifications
You must be signed in to change notification settings - Fork 21.2k
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
Clarify that some exclude properties of physics query parameters are copied #94059
Conversation
PhysicsShapeQueryParameters3D.exclude
is copied
This should probably be done to all the cases of this, both 2D and 3D as well as the other parameters such as point and ray queries Edit: to clarify, I don't mean any case at all, but the physics classes, i.e.:
Including some that exclude objects by int |
Your own PR does this but it is done for every Packed Array property. To handles Arrays like these would require a solution that allows properties to add the note automatically given a certain criteria. |
That would be pretty complex as there's no way to detect it, so it'd be a matter of adding a new property to the XML class, not sure it's worth it, but might look into checking how many cases there are for this There's no way to detect this automatically, but we could add a hint or something to make the doc generation add it automatically to the XML, but I don't think it's common enough to justify it |
Not this case specifically, but there are many times where information is repeated that may benefit from such a system, similar to the keywords. |
Absolutely, and I'll look at if there's enough cases to justify a system, but since this isn't automatable, and is likely not very common (i.e. cases that copy and aren't |
Please add to the other cases mentioned to get this to cover all the related cases, then this should be ready! |
You also merged your branch instead of using a force push, please use |
I think I accidentally created a branch from some other local branch instead of master, is it okay if I open new pr with the above changes? |
PhysicsShapeQueryParameters3D.exclude
is copied
You can just rebase it, see the link, it shouldn't matter as long as you rebase on Also please make the final commit message something clear, like the PR title |
oh got it, thank you and sorry for the inconvenience |
No inconvenience at all! Part of what I'm here for is to help along! |
dcb8fdf
to
e8ee73e
Compare
c89f02b
to
e73a193
Compare
After fixing the incorrect line above please update the commit title (using (The title still hasn't been changed, it should be "Clarify that some exclude properties of physics query parameters are copied" instead of "Added exculde's replace-don't-edit type property in docs") |
19e775b
to
4a631d4
Compare
4a631d4
to
34e2159
Compare
done |
Thanks! |
Fixes #93895
Note that [code]exclude[/code] is a replace-don't-edit type property and can only be modified by replacing the entire array.
to the PhysicsShapeQueryParameters3D.exclude docs