godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.6k stars 2.96k forks source link

Class reference methods for Generic6DOFJoint3D are incorrect #9411

Open BDixon808 opened 1 month ago

BDixon808 commented 1 month ago

Your Godot version: 4.2.2

Issue description: Class reference methods for Generic6DOFJoint3D are incorrect. The reference states there is a set/get param/flags method for each axis, but this is not the case. Set/get param/flags takes an axis as an argument. If this is a convention specific to Godot, there is nothing explaining so (at least nothing I can find). If so, a solution would be to add an explanation on the contributing to the documentation section of the contributing page or all classes page. Otherwise, the class reference should be updated.

URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/contributing/ways_to_contribute.html#contributing-to-the-documentation https://docs.godotengine.org/en/stable/classes/index.html# https://docs.godotengine.org/en/stable/classes/class_generic6dofjoint3d.html https://github.com/godotengine/godot/blob/4.2/servers/physics_3d/joints/godot_generic_6dof_joint_3d.h

AThousandShips commented 1 month ago

The reference states there is a set/get param/flags method for each axis, but this is not the case.

Where does it say that?

BDixon808 commented 1 month ago

In the Method Descriptions of the class reference.

AThousandShips commented 1 month ago

My bad missed the detail, thought you said there was one method for each flag and axis, but you're looking at the wrong file, this is the file and the methods exist: https://github.com/godotengine/godot/blob/4.2/scene/3d/joint_3d.h#L225

Where did you find that this was the file you were looking for, where does it say in the documentation?

BDixon808 commented 1 month ago

Sorry about that 😞 Would it be a bad idea to add something in the doc about were the class is located? The confusion was because that was the file that came up when using the search box in Github.

AThousandShips commented 1 month ago

That has been discussed, see:

But the correct class file turns up if you search on the github, it's here (for the 4.3 base): https://github.com/godotengine/godot/blob/master/scene/3d/physics/joints/generic_6dof_joint_3d.h

That one turns up and you can go from there, but otherwise just looking around is always best. But what are you using it for? Are you writing a module? Otherwise the c++ source is irrelevant