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.

Sign up for GitHub

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

Jump to bottom

Plane, some parameters name are inconsistent #5976

Closed
sent44 opened this issue Jul 23, 2022 · 1 comment · Fixed by godotengine/godot#63381
Closed

Plane, some parameters name are inconsistent #5976

sent44 opened this issue Jul 23, 2022 · 1 comment · Fixed by godotengine/godot#63381
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository bug

Comments

@sent44
Copy link

sent44 commented Jul 23, 2022

Your Godot version:
4 alpha 12

Issue description:
Variant intersects_segment(from: Vector3, to: Vector3)
Returns the intersection point of a segment from position begin to position end with this plane. If no intersection is found, null is returned.
-- I didn't create PR because I don't know which one do you use, from or begin

and

bool is_point_over(plane: Vector3)
Returns true if point is located above the plane.
-- Is parameter name is point? Or plane is correct and then what is this plane mean?

URL to the documentation page:
https://docs.godotengine.org/en/latest/classes/class_plane.html#class-plane
@sent44 sent44 added the bug label Jul 23, 2022
@YuriSizov YuriSizov added the area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository label Jul 23, 2022
@jynus jynus mentioned this issue Jul 24, 2022
Merged
@jynus
Copy link
Contributor

jynus commented Jul 24, 2022 •
edited
Loading

I think my patch should fix this discrepancy- although it won't be shown automatically if/when merged.

jynus added a commit to jynus/godot that referenced this issue Jul 24, 2022
@jynus
Solve discrepancy between code and class reference for Plane
1a3d57f 
On godotengine#43310, class reference was automatically updated from source,
causing xml documentation to disagree with parameter naming
description on Plane.intersects_segment().

Weirdly, it also changed the parameter for Plane.is_point_over()
from point to plane, when only the first has sense (and it is
defined on math.Plane as "const Vector3 &p_point"). Manual
mistake?

* Update begin/end to from/to on Plane.intersects_segment(...)
  docs description to match source
* Update Plane bindings to use points instread of plane for
  is_point_over(...)
* Change Plane.is_point_over(plane) to Plane.is_point_over(point)
  AND its description on docs

Fixes godotengine/godot-docs#5976
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Solve discrepancy between code and class reference for Plane jynus/godot
3 participants
@sent44 @jynus @YuriSizov