doc: Sync classref with current source #43310
Conversation
| @@ -195,29 +195,6 @@ | |||
| [/codeblocks] | |||
| </description> | |||
| </method> | |||
| <method name="from_hsv"> | |||
There was a problem hiding this comment.
It's actually commented out:
// FIXME: Color is immutable, need to probably find a way to do this via constructor
//ADDFUNC4R(COLOR, COLOR, Color, from_hsv, FLOAT, "h", FLOAT, "s", FLOAT, "v", FLOAT, "a", varray(1.0));
| @@ -20,9 +20,9 @@ | |||
| </description> | |||
| </method> | |||
| <method name="append"> | |||
| <return type="void"> | |||
| <return type="bool"> | |||
There was a problem hiding this comment.
How come append and push_back now return bool? It seems to match what is defined in core/vector.h but it returns true on failure and false on error, is that a weird Unix-style error handling?
There was a problem hiding this comment.
It's not an intended change but it comes from the C++ API. We now have to make sure that the C++ API matches what we want to expose to the scripting API.
Here I'm not sure there's any C++ code that relies on those return values, so they could possibly be changed to void to preserve the previous scripting API.
| <method name="set_axis_angle"> | ||
| <return type="void"> | ||
| </return> | ||
| <argument index="0" name="axis" type="Vector3"> | ||
| </argument> | ||
| <argument index="1" name="angle" type="float"> | ||
| </argument> | ||
| <description> | ||
| Sets the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. | ||
| </description> | ||
| </method> | ||
| <method name="set_euler"> | ||
| <return type="void"> | ||
| </return> | ||
| <argument index="0" name="euler" type="Vector3"> | ||
| </argument> | ||
| <description> | ||
| Sets the quaternion to a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle). | ||
| </description> | ||
| </method> |
There was a problem hiding this comment.
Missing bindings, or removed on purpose?
There was a problem hiding this comment.
Commented out in variant_call.cpp:
// FIXME: Quat is atomic, this should be done via construcror
//ADDFUNC1(QUAT, NIL, Quat, set_euler, VECTOR3, "euler", varray());
//ADDFUNC2(QUAT, NIL, Quat, set_axis_angle, VECTOR3, "axis", FLOAT, "angle", varray());
There was a problem hiding this comment.
It seems that #30744 finally got resolved in core :)
| @@ -397,17 +405,6 @@ | |||
| Returns [code]true[/code] if the string ends with the given string. | |||
| </description> | |||
| </method> | |||
| <method name="erase"> | |||
There was a problem hiding this comment.
Missing binding, or removed on purpose?
There was a problem hiding this comment.
Commented out in variant_call.cpp:
// FIXME: String needs to be immutable when binding
//bind_method(String, erase, sarray("position", "chars"), varray());
| @@ -512,20 +512,6 @@ | |||
| [/codeblock] | |||
| </description> | |||
| </method> | |||
| <method name="humanize_size"> | |||
There was a problem hiding this comment.
Missing binding, or removed on purpose?
There was a problem hiding this comment.
Commented out in variant_call.cpp:
// FIXME: Static function, not sure how to bind
//bind_method(String, humanize_size, sarray("size"), varray());
akien-mga
force-pushed
the
doc-classref-sync
branch
from
3b52b94
to
404b030
Compare
Includes various changes triggered by the refactoring of method bindings.
akien-mga
force-pushed
the
doc-classref-sync
branch
from
404b030
to
424cd00
Compare
|
Updated with classref changes from #43297 (+ added missing bindings). |
|
I opened #43311 to keep track of the lost method bindings. |
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
Includes various changes triggered by the refactoring of method bindings in #42780.
Draft as some of the changes might be bugs that need to be addressed before we make them harder to spot.