Vector3.slide() needs expansion. #8286
Labels
area:class reference
Issues and PRs about the class reference, which should be addressed on the Godot engine repository
enhancement
Your Godot version:
4.1
Issue description:
I'm new to Godot and was thrown for a loop re
Vector3.project()
not doing what I expected. As per this issue it turns out I wanted the rejection vector, provided byVector3.slide()
but "slide" is a unique name for this function.Not wanting to propose breaking changes, I'd rather update the class manual to clarify these two methods.
I'm thinking something like:
Vector3.slide(n:Vector3):
Returns a new vector slid (or projected) along a plane defined by the given normal. Also known as the rejection vector. Returns component perpendicular to [ n ]. See also: [Vector3.project]
Vector3.project(b:Vector3):
Returns the result of projecting the vector onto the given vector [ b ]. Returns component parellel to [ b ]. See also: [Vector3.slide]
I am working on making a fork and changes but thought I'd start by discussing the text.
URL to the documentation page (if already existing):
Manual: Vector3 Class Manual
git: Vector3 Class xml
Changes to class xml:
The text was updated successfully, but these errors were encountered: