From c7b141d20aeb077035630ecf7c71f912345dcab3 Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sat, 12 May 2018 17:58:45 -0700 Subject: [PATCH] [DOCS] Vector2/Vector3/TileMap wording fixes (cherry picked from commit 8bc4882dd33a4b162b96abc4f2fda72e78ba0119) --- doc/classes/TileMap.xml | 45 +++++++++++++++++++++++------------------ doc/classes/Vector2.xml | 42 +++++++++++++++++++------------------- doc/classes/Vector3.xml | 42 +++++++++++++++++++------------------- 3 files changed, 67 insertions(+), 62 deletions(-) diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index c074b1fbcd..abe4890e47 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -16,7 +16,7 @@ - Clear all cells. + Clears all cells. @@ -27,7 +27,7 @@ - Return the tile index of the referenced cell. + Returns the tile index of the given cell. @@ -36,7 +36,7 @@ - Return the tile index of the cell referenced by a Vector2. + Returns the tile index of the cell given by a Vector2. @@ -45,6 +45,7 @@ + Returns [code]true[/code] if the given collision layer bit is set. @@ -53,13 +54,14 @@ + Returns [code]true[/code] if the given collision mask bit is set. - Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). + Returns an array of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]). @@ -68,12 +70,14 @@ + Returns an array of all cells with the given tile id. + Returns a rectangle enclosing the used (non-empty) tiles of the map. @@ -84,7 +88,7 @@ - Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). + Returns [code]true[/code] if the given cell is transposed, i.e. the x and y axes are swapped. @@ -95,7 +99,7 @@ - Return whether the referenced cell is flipped over the X axis. + Returns [code]true[/code] if the given cell is flipped in the x axis. @@ -106,7 +110,7 @@ - Return whether the referenced cell is flipped over the Y axis. + Returns [code]true[/code] if the given cell is flipped in the y axis. @@ -117,8 +121,8 @@ - Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. - Optionally, the tilemap's potential half offset can be ignored. + Returns the global position corresponding to the given tilemap (grid-based) coordinates. + Optionally, the tilemap's half offset can be ignored. @@ -139,9 +143,9 @@ - Set the tile index for the cell referenced by its grid-based X and Y coordinates. - A tile index of -1 clears the cell. - Optionally, the tile can also be flipped over the X and Y coordinates, transposed, or be given autotile coordinates. + Sets the tile index for the cell given by a Vector2. + An index of [code]-1[/code] clears the cell. + Optionally, the tile can also be flipped, transposed, or given autotile coordinates. @@ -158,9 +162,9 @@ - Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. - A tile index of -1 clears the cell. - Optionally, the tile can also be flipped over the X and Y axes or transposed. + Sets the tile index for the given cell. + An index of [code]-1[/code] clears the cell. + Optionally, the tile can also be flipped or transposed. @@ -171,7 +175,7 @@ - Set any collision layer to be [code]true[/code] or [code]false[/code]. + Sets the given collision layer bit. @@ -182,6 +186,7 @@ + Sets the given collision mask bit. @@ -190,7 +195,7 @@ - Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based X and Y coordinates. + Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based x and y coordinates. @@ -201,8 +206,8 @@ - Applies autotiling rules to the cells in the given region (specified by grid-based X and Y coordinates). - Calling with invalid (or missing) parameters applies autotiling rules for the entire TileMap. + Applies autotiling rules to the cells in the given region (specified by grid-based x and y coordinates). + Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap. @@ -211,7 +216,7 @@ - Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument. + Returns the tilemap (grid-based) coordinatescorresponding to the given global position. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 15e7061b9d..95c2a31dfb 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 @@ - 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. @@ -102,7 +102,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. @@ -111,7 +111,7 @@ - Returns the distance to vector "b". + Returns the distance to vector [code]b[/code]. @@ -120,7 +120,7 @@ - Returns the dot product with vector "b". + Returns the dot product with vector [code]b[/code]. @@ -134,21 +134,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. @@ -159,14 +159,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]. @@ -175,7 +175,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. @@ -184,7 +184,7 @@ - Rotates the vector by "phi" radians. + Returns the vector rotated by [code]phi[/code] radians. @@ -193,7 +193,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. @@ -202,7 +202,7 @@ - Snaps the vector to a grid with the given size. + Returns the vector snapped to a grid with the given size. @@ -215,10 +215,10 @@ - X component of the vector. + The vector's x component. - Y component of the vector. + The vector's y component. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 99b36285d7..b845803648 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.