From 5dee7161b6da20be455b9d56ddaab177e7f2c250 Mon Sep 17 00:00:00 2001 From: Rafael Gauna Trindade Date: Tue, 18 Jul 2017 05:48:20 -0300 Subject: [PATCH] Improved math functions descriptions and added many AStar descriptions --- doc/base/classes.xml | 108 +++++++++++++++++++++++++++++++++---------- 1 file changed, 83 insertions(+), 25 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index e0255c279ea..caf86bc6e8b 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -39,7 +39,7 @@ - Remove sign (works for integer and float). + Returns the absolute value of parameter s (i.e. unsigned value, works for integer and float). @@ -48,7 +48,7 @@ - Arc-cosine. + Returns the principal value of the arc cosine of s, expressed in radians. In trigonometrics, arc cosine is the inverse operation of cosine. @@ -57,7 +57,7 @@ - Arc-sine. + Returns the principal value of the arc sine of s, expressed in radians. In trigonometrics, arc sine is the inverse operation of sine. @@ -75,7 +75,7 @@ - Arc-tangent. + Returns the principal value of the arc tangent of s, expressed in radians. In trigonometrics, arc tangent is the inverse operation of tangent. Notice that because of the sign ambiguity, the function cannot determine with certainty in which quadrant the angle falls only by its tangent value. See [method atan2] for an alternative that takes a fractional argument instead. @@ -86,7 +86,7 @@ - Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range. + Returns the principal value of the arc tangent of y/x, expressed in radians. To compute the value, the function takes into account the sign of both arguments in order to determine the quadrant. @@ -104,7 +104,7 @@ - Ceiling (rounds up to nearest integer). + Rounds s upward, returning the smallest integral value that is not less than s. @@ -125,7 +125,7 @@ - Clamp both values to a range. + Clamps a value between a minimum and maximum value. @@ -145,7 +145,7 @@ - Standard cosine function. + Returns the cosine of an angle of s radians. @@ -154,7 +154,7 @@ - Hyperbolic cosine. + Returns the hyperbolic cosine of s. @@ -223,7 +223,7 @@ - Exponential logarithm. + Returns the base-e exponential function of s, which is e raised to the power s: e^s. @@ -232,7 +232,7 @@ - Floor (rounds down to nearest integer). + Rounds s downward, returning the largest integral value that is not greater than s. @@ -243,7 +243,11 @@ - Module (remainder of x/y). + Returns the floating-point remainder of x/y (rounded towards zero): + [codeblock] + fmod = x - tquot * y + [/codeblock] + Where tquot is the truncated (i.e., rounded towards zero) result of: x/y. @@ -301,6 +305,7 @@ + Returns whether s is an infinity value (either positive infinity or negative infinity). @@ -309,6 +314,7 @@ + Returns whether s is a NaN (Not-A-Number) value. @@ -539,7 +545,7 @@ - Round to nearest integer. + Returns the integral value that is nearest to s, with halfway cases rounded away from zero. @@ -566,7 +572,7 @@ - Standard sine function. + Returns the sine of an angle of s radians. @@ -575,7 +581,7 @@ - Hyperbolic sine. + Returns the hyperbolic sine of s. @@ -584,7 +590,7 @@ - Square root. + Returns the square root of s. @@ -606,7 +612,7 @@ - Convert one or more arguments to strings in the best way possible. + Convert one or more arguments to string in the best way possible. @@ -624,7 +630,7 @@ - Standard tangent function. + Returns the tangent of an angle of s radians. @@ -633,7 +639,7 @@ - Hyperbolic tangent. + Returns the hyperbolic tangent of s. @@ -668,6 +674,7 @@ + This method is used to validate the structure and data types of a piece of JSON, similar to XML Schema for XML. @@ -695,6 +702,7 @@ Return a weak reference to an object. + A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. @@ -715,8 +723,11 @@ Constant that represents how many times the diameter of a circumference fits around its perimeter. + A positive infinity. (For negative infinity, use -INF). + Macro constant that expands to an expression of type float that represents a NaN. + The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0. @@ -1960,8 +1971,11 @@ + AStar class representation that uses vectors as edges. + A* (A star) is a computer algorithm that is widely used in pathfinding and graph traversal, the process of plotting an efficiently directed path between multiple points. It enjoys widespread use due to its performance and accuracy. Godot's A* implementation make use of vectors as points. + You must add points manually with [method AStar.add_point] and create segments manually with [method AStar.connect_points]. So you can test if there is a path between two points with the [method AStar.are_points_connected] function, get the list of existing ids in the found path with [method AStar.get_id_path], or the points list with [method AStar.get_point_path]. @@ -1988,7 +2002,7 @@ - Add a new point at the given position. The [code]weight_scale[/code] has to be 1 or larger. + Add a new point at the given position [code]pos[/code] with the given identifier [code]id[/code]. The [code]weight_scale[/code] has to be 1 or larger. @@ -1999,10 +2013,12 @@ + Returns if there is a connection/segment between points [code]id[/code] and [code]from_id[/code] + Clear all the points and segments from AStar instance. @@ -2013,6 +2029,7 @@ + Create a segment between points [code]id[/code] and [code]to_id[/code]. @@ -2021,6 +2038,7 @@ + Deletes a segment between points [code]id[/code] and [code]to_id[/code]. @@ -2035,6 +2053,7 @@ + Returns the id of closest point of given point. -1 is returned if there are no points on AStar. @@ -2043,6 +2062,7 @@ + Returns the position of closest point that has segments. @@ -2053,6 +2073,7 @@ + Returns an array with the point ids of path found by AStar between two given points. @@ -2063,6 +2084,7 @@ + Returns an array with the points of path found by AStar between two given points. @@ -2071,6 +2093,7 @@ + Returns the position of point with given id. @@ -2079,6 +2102,7 @@ + Returns the weight scale of point with given id. @@ -2087,12 +2111,14 @@ + Returns if the point with given id exists on AStar; + Removes the point with given id. @@ -10737,17 +10763,17 @@ - - - + + + - + - + @@ -16254,6 +16280,8 @@ Use the Zstd compression method. + + @@ -16762,6 +16790,12 @@ + + + + + + @@ -16828,6 +16862,12 @@ + + + + + + @@ -16862,6 +16902,8 @@ + + @@ -16920,6 +16962,12 @@ + + + + + + @@ -16992,6 +17040,12 @@ + + + + + + @@ -17022,6 +17076,8 @@ + + @@ -27909,6 +27965,8 @@ + +