diff options
Diffstat (limited to 'doc/base/classes.xml')
| -rw-r--r-- | doc/base/classes.xml | 128 |
1 files changed, 93 insertions, 35 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 44a7cccfe5..39b3791e84 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1603,7 +1603,7 @@ Axis-Aligned Bounding Box. </brief_description> <description> - AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position and a size, and several utility functions. It is typically used for simple (fast) overlap tests. + AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. </description> <methods> <method name="encloses"> @@ -1628,7 +1628,7 @@ <return type="float"> </return> <description> - Get the area inside the [AABB]. + Get the area of the [AABB]. </description> </method> <method name="get_endpoint"> @@ -1697,7 +1697,7 @@ <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the AABB grown a given a mount of units towards all the sides. + Return a copy of the [AABB] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> @@ -1747,7 +1747,7 @@ <argument index="0" name="plane" type="Plane"> </argument> <description> - Return true if the AABB is at both sides of a plane. + Return true if the [AABB] is at both sides of a plane. </description> </method> <method name="intersects_segment"> @@ -1766,7 +1766,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - Combine this [AABB] with another one, a larger one is returned that contains both. + Combine this [AABB] with another, a larger one is returned that contains both. </description> </method> <method name="AABB"> @@ -4371,7 +4371,7 @@ Stop a given voice. </description> </method> - <method name="free"> + <method name="free_rid"> <argument index="0" name="rid" type="RID"> </argument> <description> @@ -12551,7 +12551,7 @@ This approximation makes straight segments between each point, then subdivides t <description> 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. </description> </method> @@ -12576,9 +12576,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: http://somehost.com/index.php url would be "index.php" - + Headers are HTTP request headers - + To create a POST request with query strings to push to the server, do: var fields = {"username" : "user", "password" : "pass"} @@ -12693,10 +12693,10 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu </argument> <description> 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" </description> </method> @@ -13147,6 +13147,21 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="Image"> + <return type="Image"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="mipmaps" type="bool"> + </argument> + <argument index="3" name="format" type="int"> + </argument> + <description> + Create an empty image of a specific size and format. + </description> + </method> </methods> <constants> <constant name="COMPRESS_BC" value="0"> @@ -15038,14 +15053,13 @@ returns:= "username=user&password=pass" <description> </description> </method> - <method name="can_move_to"> + <method name="can_teleport_to"> <return type="bool"> </return> <argument index="0" name="position" type="Vector3"> </argument> - <argument index="1" name="arg1" type="bool"> - </argument> <description> + Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination. </description> </method> <method name="is_colliding" qualifiers="const"> @@ -16735,11 +16749,11 @@ returns:= "username=user&password=pass" </method> </methods> <members> - <member name="x" type="float"> + <member name="x" type="Vector2"> </member> - <member name="y" type="float"> + <member name="y" type="Vector2"> </member> - <member name="o" type="float"> + <member name="o" type="Vector2"> </member> </members> <constants> @@ -26372,12 +26386,14 @@ This method controls whether the position between two cached points is interpola <return type="String"> </return> <description> + Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). </description> </method> <method name="get_string_from_utf8"> <return type="String"> </return> <description> + Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. </description> </method> <method name="push_back"> @@ -26732,8 +26748,10 @@ This method controls whether the position between two cached points is interpola </class> <class name="Rect2" category="Built-In Types"> <brief_description> + 2D Axis-aligned bounding box. </brief_description> <description> + Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <methods> <method name="clip"> @@ -26742,6 +26760,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Returns the intersection of this [Rect2] and b. </description> </method> <method name="encloses"> @@ -26750,6 +26769,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Returns true if this [Rect2] completely encloses another one. </description> </method> <method name="expand"> @@ -26758,12 +26778,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="to" type="Vector2"> </argument> <description> + Return this [Rect2] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> + Get the area of the [Rect2]. </description> </method> <method name="grow"> @@ -26772,12 +26794,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="by" type="float"> </argument> <description> + Return a copy of the [Rect2] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> + Return true if the [Rect2] is flat or empty. </description> </method> <method name="has_point"> @@ -26786,6 +26810,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="point" type="Vector2"> </argument> <description> + Return true if the [Rect2] contains a point. </description> </method> <method name="intersects"> @@ -26794,6 +26819,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Return true if the [Rect2] overlaps with another. </description> </method> <method name="merge"> @@ -26802,6 +26828,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Combine this [Rect2] with another, a larger one is returned that contains both. </description> </method> <method name="Rect2"> @@ -26812,6 +26839,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="size" type="Vector2"> </argument> <description> + Construct a [Rect2] by position and size. </description> </method> <method name="Rect2"> @@ -26826,6 +26854,7 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="height" type="float"> </argument> <description> + Construct a [Rect2] by x, y, width and height. </description> </method> </methods> @@ -26930,7 +26959,7 @@ This method controls whether the position between two cached points is interpola Lazy (non-greedy) quantifiers [code]*?[/code] Begining [code]^[/code] and end [code]$[/code] anchors Alternation [code]|[/code] - Backreferences [code]\1[/code] to [code]\9[/code] + Backreferences [code]\1[/code] and [code]\g{1}[/code] POSIX character classes [code][[:alnum:]][/code] Lookahead [code](?=)[/code], [code](?!)[/code] and lookbehind [code](?<=)[/code], [code](?<!)[/code] ASCII [code]\xFF[/code] and Unicode [code]\uFFFF[/code] code points (in a style similar to Python) @@ -26942,9 +26971,10 @@ This method controls whether the position between two cached points is interpola </return> <argument index="0" name="pattern" type="String"> </argument> - <argument index="1" name="expanded" type="bool" default="true"> + <argument index="1" name="capture" type="int" default="9"> </argument> <description> + Compiles and assign the regular expression pattern to use. The limit on the number of capturing groups can be specified or made unlimited if negative. </description> </method> <method name="find" qualifiers="const"> @@ -27523,6 +27553,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="scroll_to_line"> + <argument index="0" name="arg0" type="int"> + </argument> + <description> + </description> + </method> <method name="set_tab_size"> <argument index="0" name="spaces" type="int"> </argument> @@ -33134,9 +33170,10 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="to_ascii"> - <return type="String"> + <return type="RawArray"> </return> <description> + Convert the String (which is a character array) to RawArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. </description> </method> <method name="to_float"> @@ -33168,9 +33205,10 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="to_utf8"> - <return type="String"> + <return type="RawArray"> </return> <description> + Convert the String (which is an array of characters) to RawArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). </description> </method> <method name="xml_escape"> @@ -37623,7 +37661,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="vec" type="Vector2"> </argument> <description> - Reflects/mirrors the vector around another vector. + Like "slide", but reflects the Vector instead of continuing along the wall. </description> </method> <method name="rotated"> @@ -37687,10 +37725,10 @@ This method controls whether the position between two cached points is interpola </class> <class name="Vector2Array" category="Built-In Types"> <brief_description> - An Array of Vector2's. + An Array of Vector2. </brief_description> <description> - An Array specifically designed to hold Vector2's. + An Array specifically designed to hold Vector2. </description> <methods> <method name="get"> @@ -37699,21 +37737,21 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="idx" type="int"> </argument> <description> - Get the Vector2 at the given index. + Returns the Vector2 at the given index. </description> </method> <method name="push_back"> <argument index="0" name="vector2" type="Vector2"> </argument> <description> - Insert a new Vector2. + Inserts a Vector2 at the end. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Sets the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -37722,7 +37760,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="vector2" type="Vector2"> </argument> <description> - Set the Vector2 at the given index. + Changes the Vector2 at the given index. </description> </method> <method name="size"> @@ -37750,19 +37788,21 @@ This method controls whether the position between two cached points is interpola Vector class, which performs basic 3D vector math operations. </brief_description> <description> - Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vecor math operations. + Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. </description> <methods> <method name="abs"> <return type="Vector3"> </return> <description> + Returns a new vector with all components in absolute values (e.g. positive). </description> </method> <method name="ceil"> <return type="Vector3"> </return> <description> + Returns a new vector with all components rounded up. </description> </method> <method name="cross"> @@ -37786,7 +37826,7 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="t" type="float"> </argument> <description> - Perform a cubic interpolation between vectors a,b,c,d (b is current), by the given amount (i). + Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t). </description> </method> <method name="distance_squared_to"> @@ -37795,7 +37835,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the squared distance (distance minus the last square root) to b. + Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. </description> </method> <method name="distance_to"> @@ -37820,13 +37860,14 @@ This method controls whether the position between two cached points is interpola <return type="Vector3"> </return> <description> + Returns a new vector with all components rounded down. </description> </method> <method name="inverse"> <return type="Vector3"> </return> <description> - 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 Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) </description> </method> <method name="length"> @@ -37840,7 +37881,7 @@ This method controls whether the position between two cached points is interpola <return type="float"> </return> <description> - Return the length of the vector, squared. + Return 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. </description> </method> <method name="linear_interpolate"> @@ -37851,26 +37892,28 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="t" type="float"> </argument> <description> - Linearly interpolates the vector to a given one (b), by the given amount (i). + Linearly interpolates the vector to a given one (b), by the given amount (t). </description> </method> <method name="max_axis"> <return type="int"> </return> <description> + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest. </description> </method> <method name="min_axis"> <return type="int"> </return> <description> + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. </description> </method> <method name="normalized"> <return type="Vector3"> </return> <description> - Return a copy of the normalized vector to unit length. This is the same as v / v.length() + Return a copy of the normalized vector to unit length. This is the same as v / v.length(). </description> </method> <method name="reflect"> @@ -37879,6 +37922,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="by" type="Vector3"> </argument> <description> + Like "slide", but reflects the Vector instead of continuing along the wall. </description> </method> <method name="rotated"> @@ -37889,6 +37933,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="phi" type="float"> </argument> <description> + Rotates the vector around some axis by phi radians. </description> </method> <method name="slide"> @@ -37897,6 +37942,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="by" type="Vector3"> </argument> <description> + Slides the vector along a wall. </description> </method> <method name="snapped"> @@ -37918,6 +37964,7 @@ This method controls whether the position between two cached points is interpola <argument index="2" name="z" type="float"> </argument> <description> + Returns a Vector3 with the given components. </description> </method> </methods> @@ -37931,17 +37978,22 @@ This method controls whether the position between two cached points is interpola </members> <constants> <constant name="AXIS_X" value="0"> + Enumerated value for the X axis. Returned by functions like max_axis or min_axis. </constant> <constant name="AXIS_Y" value="1"> + Enumerated value for the Y axis. </constant> <constant name="AXIS_Z" value="2"> + Enumerated value for the Z axis. </constant> </constants> </class> <class name="Vector3Array" category="Built-In Types"> <brief_description> + An Array of Vector3. </brief_description> <description> + An Array specifically designed to hold Vector3. </description> <methods> <method name="get"> @@ -37950,18 +38002,21 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="idx" type="int"> </argument> <description> + Returns the Vector3 at the given index. </description> </method> <method name="push_back"> <argument index="0" name="vector3" type="Vector3"> </argument> <description> + Inserts a Vector3 at the end. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> + Sets the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -37970,12 +38025,14 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="vector3" type="Vector3"> </argument> <description> + Changes the Vector3 at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> + Returns the size of the array. </description> </method> <method name="Vector3Array"> @@ -37984,6 +38041,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="from" type="Array"> </argument> <description> + Constructs a new Vector3Array. Optionally, you can pass in an Array that will be converted. </description> </method> </methods> |