summaryrefslogtreecommitdiffstats
path: root/doc/classes/Vector3.xml
diff options
context:
space:
mode:
authorshak2 <shak2@users.noreply.github.com>2024-06-15 15:45:21 +0100
committerA Thousand Ships <96648715+AThousandShips@users.noreply.github.com>2024-06-15 18:21:05 +0200
commit451d0999ca4eaea52b36a7f4cf4ef306340b3928 (patch)
tree0b636186e76afb11929be1470a5a68832c951b98 /doc/classes/Vector3.xml
parent71699e08c9df78b7203fa4ef9cede28e995d6ace (diff)
downloadredot-engine-451d0999ca4eaea52b36a7f4cf4ef306340b3928.tar.gz
Fix description of `Vector2/3.dot`
A 90 degree angle is a right angle.
Diffstat (limited to 'doc/classes/Vector3.xml')
-rw-r--r--doc/classes/Vector3.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml
index 1692ba3ece..c04fcd0b24 100644
--- a/doc/classes/Vector3.xml
+++ b/doc/classes/Vector3.xml
@@ -171,7 +171,7 @@
<param index="0" name="with" type="Vector3" />
<description>
Returns the dot product of this vector and [param with]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player.
- The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees.
+ The dot product will be [code]0[/code] for a right angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees.
When using unit (normalized) vectors, the result will always be between [code]-1.0[/code] (180 degree angle) when the vectors are facing opposite directions, and [code]1.0[/code] (0 degree angle) when the vectors are aligned.
[b]Note:[/b] [code]a.dot(b)[/code] is equivalent to [code]b.dot(a)[/code].
</description>