From c7b141d20aeb077035630ecf7c71f912345dcab3 Mon Sep 17 00:00:00 2001
From: Chris Bradfield
Date: Sat, 12 May 2018 17:58:45 -0700
Subject: [DOCS] Vector2/Vector3/TileMap wording fixes
(cherry picked from commit 8bc4882dd33a4b162b96abc4f2fda72e78ba0119)
---
doc/classes/Vector3.xml | 42 +++++++++++++++++++++---------------------
1 file changed, 21 insertions(+), 21 deletions(-)
(limited to 'doc/classes/Vector3.xml')
diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml
index 99b36285d..b84580364 100644
--- a/doc/classes/Vector3.xml
+++ b/doc/classes/Vector3.xml
@@ -38,7 +38,7 @@
- Returns the vector's minimum angle to the vector [code]to[/code].
+ Returns the minimum angle to the given vector.
@@ -47,7 +47,7 @@
- Bounce returns the vector "bounced off" from the given plane, specified by its normal vector.
+ Returns the vector "bounced off" from a plane defined by the given normal.
@@ -87,7 +87,7 @@
- Returns the squared distance to [code]b[/code]. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula.
+ Returns the squared distance to [code]b[/code]. Prefer this function over [method distance_to] if you need to sort vectors or need the squared distance for some formula.
@@ -96,7 +96,7 @@
- Returns the distance to b.
+ Returns the distance to [code]b[/code].
@@ -105,7 +105,7 @@
- Returns the dot product with b.
+ Returns the dot product with [code]b[/code].
@@ -119,28 +119,28 @@
- Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )
+ Returns the inverse of the vector. This is the same as [code]Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )[/code].
- Returns whether the vector is normalized or not.
+ Returns [code]true[/code] if the vector is normalized.
- Returns the length of the vector.
+ Returns the vector's length.
- Returns the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula.
+ Returns the vector's length squared. Prefer this function over [method length] if you need to sort vectors or need the squared length for some formula.
@@ -151,28 +151,28 @@
- Linearly interpolates the vector to a given one (b), by the given amount (t). (t) should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
+ Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is.
- Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest.
+ Returns the axis of the vector's largest value. See [code]AXIS_*[/code] constants.
- Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest.
+ Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants.
- Returns a copy of the normalized vector to unit length. This is the same as v / v.length().
+ Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code].
@@ -181,7 +181,7 @@
- Returns the outer product with b.
+ Returns the outer product with [code]b[/code].
@@ -190,7 +190,7 @@
- Reflects the vector along the given plane, specified by its normal vector.
+ Returns the vector reflected from a plane defined by the given normal.
@@ -201,7 +201,7 @@
- Rotates the vector around some axis by phi radians. The axis must be a normalized vector.
+ Rotates the vector around a given axis by [code]phi[/code] radians. The axis must be a normalized vector.
@@ -210,7 +210,7 @@
- Slide returns the component of the vector along the given plane, specified by its normal vector.
+ Returns the component of the vector along a plane defined by the given normal.
@@ -232,18 +232,18 @@
- X component of the vector.
+ The vector's x component.
- Y component of the vector.
+ The vector's y component.
- Z component of the vector.
+ The vector's z component.
- Enumerated value for the X axis. Returned by functions like max_axis or min_axis.
+ Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis].
Enumerated value for the Y axis.
--
cgit v1.2.3-70-g09d2