From 497efa720cb53f4ddaef661739493069c102db0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 20 Nov 2015 18:39:23 +0100 Subject: [PATCH 1/2] Sync doc template with code --- doc/base/classes.xml | 221 +++++++++++++++++++++++++++---------------- 1 file changed, 138 insertions(+), 83 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 32ff75efbd..d0ea373f5c 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -3197,6 +3197,24 @@ + + + + + + + + + + + + + + + + + + @@ -5477,7 +5495,7 @@ - + Group of Buttons. @@ -5523,6 +5541,10 @@ + + + + @@ -7165,7 +7187,7 @@ - + Set whether the polygon is to be a [ConvexPolygon2D] ([code]build_mode[/code]=0), or a [ConcavePolygon2D] ([code]build_mode[/code]=1). @@ -7179,7 +7201,7 @@ - + Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). @@ -7314,7 +7336,7 @@ Color in RGBA format. - A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1. + A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1. @@ -8608,7 +8630,7 @@ - Currently, this method does nothing. + Currently, this method does nothing. @@ -8889,12 +8911,12 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and + + - - Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. @@ -8902,16 +8924,6 @@ This approximation makes straight segments between each point, then subdivides t "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. - - - - - - - - - - @@ -9096,12 +9108,12 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and + + - - Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. @@ -9109,16 +9121,6 @@ This approximation makes straight segments between each point, then subdivides t "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. - - - - - - - - - - @@ -10779,6 +10781,14 @@ This approximation makes straight segments between each point, then subdivides t + + + + + + + + @@ -12539,7 +12549,7 @@ This approximation makes straight segments between each point, then subdivides t - Connect to a host. This needs to be done before any requests are sent. + Connect to a host. This needs to be done before any requests are sent. The host should not have http:// prepended but will strip the protocol identifier if provided. verify_host will check the SSL identity of the host if set to true. @@ -12563,10 +12573,9 @@ verify_host will check the SSL identity of the host if set to true. - Sends a request to the connected host. The url is the what is normally behind the hostname, -i.e; + Sends a request to the connected host. The url is the what is normally behind the hostname, i.e: http://somehost.com/index.php -url would be "index.php" +url would be "index.php" Headers are HTTP request headers @@ -12584,8 +12593,8 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu - - Stub function + + Stub function @@ -12594,7 +12603,7 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu - Stub function + Stub function @@ -12647,14 +12656,14 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu - Sets the size of the buffer used and maximum bytes to read per iteration + Sets the size of the buffer used and maximum bytes to read per iteration - If set to true, execute will wait until all data is read from the response. + If set to true, execute will wait until all data is read from the response. @@ -12667,30 +12676,30 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu - Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates. + Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates. - - This needs to be called in order to have any request processed. Check results with [method get_status] + + This needs to be called in order to have any request processed. Check results with [method get_status] - - - - - - - Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary. + + + + + + + Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary. var fields = {"username": "user", "password": "pass"} String queryString = httpClient.query_string_from_dict(fields) returns:= "username=user&password=pass" - - + + @@ -14471,6 +14480,12 @@ returns:= "username=user&password=pass" + + + + + + @@ -15920,6 +15935,18 @@ returns:= "username=user&password=pass" LineEdit provides a single line string editor, used for text fields. + + + + + + + + + + + + Clear the [LineEdit] text. @@ -16033,6 +16060,14 @@ returns:= "username=user&password=pass" + + + + + + + + @@ -16700,11 +16735,11 @@ returns:= "username=user&password=pass" - + - + - + @@ -16751,6 +16786,8 @@ returns:= "username=user&password=pass" + + @@ -18602,6 +18639,18 @@ returns:= "username=user&password=pass" Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. + + + + + + + + + + + + @@ -21591,16 +21640,16 @@ This method controls whether the position between two cached points is interpola - Forbids the PathFollow to rotate. + Forbids the PathFollow to rotate. - Allows the PathFollow to rotate in the Y axis only. + Allows the PathFollow to rotate in the Y axis only. - Allows the PathFollow to rotate in both the X, and Y axes. + Allows the PathFollow to rotate in both the X, and Y axes. - Allows the PathFollow to rotate in any axis. + Allows the PathFollow to rotate in any axis. @@ -21715,10 +21764,6 @@ This method controls whether the position between two cached points is interpola - - - - @@ -26075,6 +26120,14 @@ This method controls whether the position between two cached points is interpola + + + + + + + + @@ -26886,27 +26939,22 @@ This method controls whether the position between two cached points is interpola - [OK] if the regular expression was valid. [FAIL] otherwise. - The string to be converted into a regular expression. + + - Once created, a RegEx object needs a regular expression to be assigned to it. This method tries to convert the string given to an usable regular expression. - The position within the string (starting with 0) where the pattern was found. It will return -1 if the pattern was not found, it was invalid, or the start or end positions were beyond the string's end. - The text to search the pattern in. - The position in the string (starting with 0) to start searching from. - The position in the string (starting with 0) to stop searching. A value less than the start position means "end of the string". This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see [method get_capture]) for further retrieval. @@ -26935,7 +26983,6 @@ This method controls whether the position between two cached points is interpola - The number of the captured group, starting with 0. Like other regular expression engines, Godot's engine takes 0 as the full expression, and 1 as the first pair of capturing parentheses. Returns a captured group. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]). @@ -26943,7 +26990,6 @@ This method controls whether the position between two cached points is interpola - A list contining all the strings captured by the regular expression. Return a list of all the captures made by the regular expression. @@ -30675,8 +30721,6 @@ This method controls whether the position between two cached points is interpola - - @@ -30689,8 +30733,6 @@ This method controls whether the position between two cached points is interpola - - @@ -34025,15 +34067,17 @@ This method controls whether the position between two cached points is interpola + + - Set the current column of the text editor. + + - Set the current line of the text editor. @@ -36289,6 +36333,18 @@ This method controls whether the position between two cached points is interpola + + + + + + + + + + + + @@ -37441,6 +37497,12 @@ This method controls whether the position between two cached points is interpola + + + + + + @@ -37459,13 +37521,6 @@ This method controls whether the position between two cached points is interpola Returns the angle in radians between the line connecting the two points and the x coordinate. - - - - - Returns the result of atan2 when called with the Vector's x and y as parameters. - - From 0c8dda80ff23859ca9faf6ed1033427c22acb4d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 20 Nov 2015 18:47:18 +0100 Subject: [PATCH 2/2] Update Vector2.angle() description --- doc/base/classes.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index d0ea373f5c..44a7cccfe5 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -37501,6 +37501,8 @@ This method controls whether the position between two cached points is interpola + 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)).