From 8bc4882dd33a4b162b96abc4f2fda72e78ba0119 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 --- doc/classes/Vector2.xml | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) (limited to 'doc/classes/Vector2.xml') diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 66563dc5a..ec92dcf90 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -1,10 +1,10 @@ - Vector used for 2D Math. + Vector used for 2D math. - 2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values. + 2-element structure that can be used to represent positions in 2d space or any other pair of numeric values. http://docs.godotengine.org/en/3.0/tutorials/math/index.html @@ -34,8 +34,8 @@ - Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)). - Be aware that it therefore returns an angle oriented clockwise with regard to the (0, 1) unit vector, and not an angle oriented counter-clockwise with regard to the (1, 0) unit vector (which would be the typical trigonometric representation of the angle when calling Math::atan2(y,x)). + Returns the vector's angle in radians with respect to the x-axis, or [code](1, 0)[/code] vector. + Equivalent to the result of atan2 when called with the vector's x and y as parameters: [code]atan2(x, y)[/code]. @@ -60,7 +60,7 @@ - Returns the ratio of X to Y. + Returns the ratio of x to y. @@ -69,7 +69,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. @@ -93,7 +93,7 @@ - Returns the 2-dimensional analog of the cross product with the given Vector2. + Returns the 2 dimensional analog of the cross product with the given vector. @@ -108,7 +108,7 @@ - Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Cubicly interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], or a percentage of how far along the interpolation is. @@ -117,7 +117,7 @@ - Returns the squared distance to vector "b". 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 vector [code]b[/code]. Prefer this function over [method distance_to] if you need to sort vectors or need the squared distance for some formula. @@ -126,7 +126,7 @@ - Returns the distance to vector "b". + Returns the distance to vector [code]b[/code]. @@ -135,7 +135,7 @@ - Returns the dot product with vector "b". + Returns the dot product with vector [code]b[/code]. @@ -149,21 +149,21 @@ - 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 squared length of the vector. 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 [member length] if you need to sort vectors or need the squared length for some formula. @@ -174,14 +174,14 @@ - Returns the result of the linear interpolation between this vector and "b", by 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 a normalized vector to unit length. + Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/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. @@ -199,7 +199,7 @@ - Rotates the vector by "phi" radians. + Returns the vector rotated by [code]phi[/code] radians. @@ -214,7 +214,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. @@ -223,7 +223,7 @@ - Snaps the vector to a grid with the given size. + Returns the vector snapped to a grid with the given size. @@ -236,10 +236,10 @@ - X component of the vector. + The vector's x component. - Y component of the vector. + The vector's y component. -- cgit v1.2.3-70-g09d2