godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Variant: Sync docs with new constructors, fixups after #43403 

Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
This commit is contained in:
Rémi Verschelde 2020-11-09 17:46:03 +01:00
parent efc4d217d6
commit 0f249f5c0a
No known key found for this signature in database
GPG Key ID: C3336907360768E1
45 changed files with 764 additions and 647 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
core/math/color.h
View File

@ -209,15 +209,26 @@ struct Color {
_FORCE_INLINE_ Color() {}
/**
* RGB / RGBA construct parameters. Alpha is optional, but defaults to 1.0
* RGBA construct parameters.
* Alpha is not optional as otherwise we can't bind the RGB version for scripting.
*/
_FORCE_INLINE_ Color(float p_r, float p_g, float p_b, float p_a = 1.0) {
_FORCE_INLINE_ Color(float p_r, float p_g, float p_b, float p_a) {
r = p_r;
g = p_g;
b = p_b;
a = p_a;
}
/**
* RGB construct parameters.
*/
_FORCE_INLINE_ Color(float p_r, float p_g, float p_b) {
r = p_r;
g = p_g;
b = p_b;
a = 1.0;
}
/**
* Construct a Color from another Color, but with the specified alpha value.
*/

10
core/math/color_names.inc
View File

@ -61,9 +61,7 @@ static NamedColor named_colors[] = {
{ "gold", Color(1.00, 0.84, 0.00) },
{ "goldenrod", Color(0.85, 0.65, 0.13) },
{ "gray", Color(0.75, 0.75, 0.75) },
{ "webgray", Color(0.50, 0.50, 0.50) },
{ "green", Color(0.00, 1.00, 0.00) },
{ "webgreen", Color(0.00, 0.50, 0.00) },
{ "greenyellow", Color(0.68, 1.00, 0.18) },
{ "honeydew", Color(0.94, 1.00, 0.94) },
{ "hotpink", Color(1.00, 0.41, 0.71) },
@ -93,7 +91,6 @@ static NamedColor named_colors[] = {
{ "linen", Color(0.98, 0.94, 0.90) },
{ "magenta", Color(1.00, 0.00, 1.00) },
{ "maroon", Color(0.69, 0.19, 0.38) },
{ "webmaroon", Color(0.50, 0.00, 0.00) },
{ "mediumaquamarine", Color(0.40, 0.80, 0.67) },
{ "mediumblue", Color(0.00, 0.00, 0.80) },
{ "mediumorchid", Color(0.73, 0.33, 0.83) },
@ -126,7 +123,6 @@ static NamedColor named_colors[] = {
{ "plum", Color(0.87, 0.63, 0.87) },
{ "powderblue", Color(0.69, 0.88, 0.90) },
{ "purple", Color(0.63, 0.13, 0.94) },
{ "webpurple", Color(0.50, 0.00, 0.50) },
{ "rebeccapurple", Color(0.40, 0.20, 0.60) },
{ "red", Color(1.00, 0.00, 0.00) },
{ "rosybrown", Color(0.74, 0.56, 0.56) },
@ -148,9 +144,13 @@ static NamedColor named_colors[] = {
{ "teal", Color(0.00, 0.50, 0.50) },
{ "thistle", Color(0.85, 0.75, 0.85) },
{ "tomato", Color(1.00, 0.39, 0.28) },
{ "turquoise", Color(0.25, 0.88, 0.82) },
{ "transparent", Color(1.00, 1.00, 1.00, 0.00) },
{ "turquoise", Color(0.25, 0.88, 0.82) },
{ "violet", Color(0.93, 0.51, 0.93) },
{ "webgray", Color(0.50, 0.50, 0.50) },
{ "webgreen", Color(0.00, 0.50, 0.00) },
{ "webmaroon", Color(0.50, 0.00, 0.00) },
{ "webpurple", Color(0.50, 0.00, 0.50) },
{ "wheat", Color(0.96, 0.87, 0.70) },
{ "white", Color(1.00, 1.00, 1.00) },
{ "whitesmoke", Color(0.96, 0.96, 0.96) },

7
core/math/transform.cpp
View File

@ -200,6 +200,13 @@ Transform::Transform(const Basis &p_basis, const Vector3 &p_origin) :
origin(p_origin) {
}
Transform::Transform(const Vector3 &p_x, const Vector3 &p_y, const Vector3 &p_z, const Vector3 &p_origin) :
origin(p_origin) {
basis.set_axis(0, p_x);
basis.set_axis(1, p_y);
basis.set_axis(2, p_z);
}
Transform::Transform(real_t xx, real_t xy, real_t xz, real_t yx, real_t yy, real_t yz, real_t zx, real_t zy, real_t zz, real_t ox, real_t oy, real_t oz) {
basis = Basis(xx, xy, xz, yx, yy, yz, zx, zy, zz);
origin = Vector3(ox, oy, oz);

5
core/math/transform.h
View File

@ -106,9 +106,10 @@ public:
operator String() const;
Transform(real_t xx, real_t xy, real_t xz, real_t yx, real_t yy, real_t yz, real_t zx, real_t zy, real_t zz, real_t ox, real_t oy, real_t oz);
Transform(const Basis &p_basis, const Vector3 &p_origin = Vector3());
Transform() {}
Transform(const Basis &p_basis, const Vector3 &p_origin = Vector3());
Transform(const Vector3 &p_x, const Vector3 &p_y, const Vector3 &p_z, const Vector3 &p_origin);
Transform(real_t xx, real_t xy, real_t xz, real_t yx, real_t yy, real_t yz, real_t zx, real_t zy, real_t zz, real_t ox, real_t oy, real_t oz);
};
_FORCE_INLINE_ Vector3 Transform::xform(const Vector3 &p_vector) const {

2
core/string/ustring.h
View File

@ -433,10 +433,10 @@ public:
/**
* The constructors must not depend on other overloads
*/
/* String(char32_t p_char);*/
_FORCE_INLINE_ String() {}
_FORCE_INLINE_ String(const String &p_str) { _cowdata._ref(p_str._cowdata); }
String &operator=(const String &p_str) {
_cowdata._ref(p_str._cowdata);
return *this;

17
core/variant/variant_construct.cpp
View File

@ -292,7 +292,7 @@ public:
}
static Variant::Type get_base_type() {
return Variant::CALLABLE;
return Variant::SIGNAL;
}
};
@ -569,10 +569,12 @@ void Variant::_register_variant_constructors() {
add_constructor<VariantConstructNoArgs<int64_t>>(sarray());
add_constructor<VariantConstructor<int64_t, int64_t>>(sarray("from"));
add_constructor<VariantConstructor<int64_t, double>>(sarray("from"));
add_constructor<VariantConstructor<int64_t, bool>>(sarray("from"));
add_constructor<VariantConstructNoArgs<double>>(sarray());
add_constructor<VariantConstructor<double, double>>(sarray("from"));
add_constructor<VariantConstructor<double, int64_t>>(sarray("from"));
add_constructor<VariantConstructor<double, bool>>(sarray("from"));
add_constructor<VariantConstructNoArgs<String>>(sarray());
add_constructor<VariantConstructor<String, String>>(sarray("from"));
@ -613,13 +615,15 @@ void Variant::_register_variant_constructors() {
add_constructor<VariantConstructNoArgs<Transform2D>>(sarray());
add_constructor<VariantConstructor<Transform2D, Transform2D>>(sarray("from"));
add_constructor<VariantConstructor<Transform2D, Vector2, Vector2, Vector2>>(sarray("x", "y", "origin"));
add_constructor<VariantConstructor<Transform2D, float, Vector2>>(sarray("rotation", "position"));
add_constructor<VariantConstructor<Transform2D, Vector2, Vector2, Vector2>>(sarray("x_axis", "y_axis", "origin"));
add_constructor<VariantConstructNoArgs<Plane>>(sarray());
add_constructor<VariantConstructor<Plane, Plane>>(sarray("from"));
add_constructor<VariantConstructor<Plane, Vector3, double>>(sarray("normal", "d"));
add_constructor<VariantConstructor<Plane, Vector3, Vector3>>(sarray("point", "normal"));
add_constructor<VariantConstructor<Plane, Vector3, Vector3, Vector3>>(sarray("point1", "point2", "point3"));
add_constructor<VariantConstructor<Plane, double, double, double, double>>(sarray("a", "b", "c", "d"));
add_constructor<VariantConstructNoArgs<Quat>>(sarray());
add_constructor<VariantConstructor<Quat, Quat>>(sarray("from"));
@ -627,6 +631,7 @@ void Variant::_register_variant_constructors() {
add_constructor<VariantConstructor<Quat, Vector3>>(sarray("euler"));
add_constructor<VariantConstructor<Quat, Vector3, double>>(sarray("axis", "angle"));
add_constructor<VariantConstructor<Quat, Vector3, Vector3>>(sarray("arc_from", "arc_to"));
add_constructor<VariantConstructor<Quat, double, double, double, double>>(sarray("x", "y", "z", "w"));
add_constructor<VariantConstructNoArgs<::AABB>>(sarray());
add_constructor<VariantConstructor<::AABB, ::AABB>>(sarray("from"));
@ -635,14 +640,20 @@ void Variant::_register_variant_constructors() {
add_constructor<VariantConstructNoArgs<Basis>>(sarray());
add_constructor<VariantConstructor<Basis, Basis>>(sarray("from"));
add_constructor<VariantConstructor<Basis, Quat>>(sarray("from"));
add_constructor<VariantConstructor<Basis, Vector3, Vector3, Vector3>>(sarray("x", "y", "z"));
add_constructor<VariantConstructor<Basis, Vector3>>(sarray("euler"));
add_constructor<VariantConstructor<Basis, Vector3, double>>(sarray("axis", "phi"));
add_constructor<VariantConstructor<Basis, Vector3, Vector3, Vector3>>(sarray("x_axis", "y_axis", "z_axis"));
add_constructor<VariantConstructNoArgs<Transform>>(sarray());
add_constructor<VariantConstructor<Transform, Transform>>(sarray("from"));
add_constructor<VariantConstructor<Transform, Basis, Vector3>>(sarray("basis", "origin"));
add_constructor<VariantConstructor<Transform, Vector3, Vector3, Vector3, Vector3>>(sarray("x_axis", "y_axis", "z_axis", "origin"));
add_constructor<VariantConstructNoArgs<Color>>(sarray());
add_constructor<VariantConstructor<Color, Color>>(sarray("from"));
add_constructor<VariantConstructor<Color, Color, double>>(sarray("from", "alpha"));
add_constructor<VariantConstructor<Color, double, double, double>>(sarray("r", "g", "b"));
add_constructor<VariantConstructor<Color, double, double, double, double>>(sarray("r", "g", "b", "a"));
add_constructor<VariantConstructNoArgs<StringName>>(sarray());
add_constructor<VariantConstructor<StringName, StringName>>(sarray("from"));

27
doc/classes/@GlobalScope.xml
View File

@ -1594,43 +1594,40 @@
<constant name="OP_MODULE" value="12" enum="Variant.Operator">
Remainder/modulo operator ([code]%[/code]).
</constant>
<constant name="OP_STRING_CONCAT" value="13" enum="Variant.Operator">
String concatenation operator ([code]+[/code]).
</constant>
<constant name="OP_SHIFT_LEFT" value="14" enum="Variant.Operator">
<constant name="OP_SHIFT_LEFT" value="13" enum="Variant.Operator">
Left shift operator ([code]&lt;&lt;[/code]).
</constant>
<constant name="OP_SHIFT_RIGHT" value="15" enum="Variant.Operator">
<constant name="OP_SHIFT_RIGHT" value="14" enum="Variant.Operator">
Right shift operator ([code]&gt;&gt;[/code]).
</constant>
<constant name="OP_BIT_AND" value="16" enum="Variant.Operator">
<constant name="OP_BIT_AND" value="15" enum="Variant.Operator">
Bitwise AND operator ([code]&amp;[/code]).
</constant>
<constant name="OP_BIT_OR" value="17" enum="Variant.Operator">
<constant name="OP_BIT_OR" value="16" enum="Variant.Operator">
Bitwise OR operator ([code]|[/code]).
</constant>
<constant name="OP_BIT_XOR" value="18" enum="Variant.Operator">
<constant name="OP_BIT_XOR" value="17" enum="Variant.Operator">
Bitwise XOR operator ([code]^[/code]).
</constant>
<constant name="OP_BIT_NEGATE" value="19" enum="Variant.Operator">
<constant name="OP_BIT_NEGATE" value="18" enum="Variant.Operator">
Bitwise NOT operator ([code]~[/code]).
</constant>
<constant name="OP_AND" value="20" enum="Variant.Operator">
<constant name="OP_AND" value="19" enum="Variant.Operator">
Logical AND operator ([code]and[/code] or [code]&amp;&amp;[/code]).
</constant>
<constant name="OP_OR" value="21" enum="Variant.Operator">
<constant name="OP_OR" value="20" enum="Variant.Operator">
Logical OR operator ([code]or[/code] or [code]||[/code]).
</constant>
<constant name="OP_XOR" value="22" enum="Variant.Operator">
<constant name="OP_XOR" value="21" enum="Variant.Operator">
Logical XOR operator (not implemented in GDScript).
</constant>
<constant name="OP_NOT" value="23" enum="Variant.Operator">
<constant name="OP_NOT" value="22" enum="Variant.Operator">
Logical NOT operator ([code]not[/code] or [code]![/code]).
</constant>
<constant name="OP_IN" value="24" enum="Variant.Operator">
<constant name="OP_IN" value="23" enum="Variant.Operator">
Logical IN operator ([code]in[/code]).
</constant>
<constant name="OP_MAX" value="25" enum="Variant.Operator">
<constant name="OP_MAX" value="24" enum="Variant.Operator">
Represents the size of the [enum Variant.Operator] enum.
</constant>
</constants>

16
doc/classes/AABB.xml
View File

@ -14,6 +14,22 @@
<link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link>
</tutorials>
<methods>
<method name="AABB">
<return type="AABB">
</return>
<description>
Constructs a default-initialized [AABB] with default (zero) values of [member position] and [member size].
</description>
</method>
<method name="AABB">
<return type="AABB">
</return>
<argument index="0" name="from" type="AABB">
</argument>
<description>
Constructs an [AABB] as a copy of the given [AABB].
</description>
</method>
<method name="AABB">
<return type="AABB">
</return>

96
doc/classes/Array.xml
View File

@ -43,6 +43,31 @@
<tutorials>
</tutorials>
<methods>
<method name="Array">
<return type="Array">
</return>
<description>
Constructs an empty [Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs an [Array] as a copy of the given [Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedByteArray">
</argument>
<description>
Constructs an array from a [PackedByteArray].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
@ -52,42 +77,6 @@
Constructs an array from a [PackedColorArray].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedVector3Array">
</argument>
<description>
Constructs an array from a [PackedVector3Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedVector2Array">
</argument>
<description>
Constructs an array from a [PackedVector2Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedStringArray">
</argument>
<description>
Constructs an array from a [PackedStringArray].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedFloat64Array">
</argument>
<description>
Constructs an array from a [PackedFloat64Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
@ -100,10 +89,10 @@
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedInt64Array">
<argument index="0" name="from" type="PackedFloat64Array">
</argument>
<description>
Constructs an array from a [PackedInt64Array].
Constructs an array from a [PackedFloat64Array].
</description>
</method>
<method name="Array">
@ -118,10 +107,37 @@
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedByteArray">
<argument index="0" name="from" type="PackedInt64Array">
</argument>
<description>
Constructs an array from a [PackedByteArray].
Constructs an array from a [PackedInt64Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedStringArray">
</argument>
<description>
Constructs an array from a [PackedStringArray].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedVector2Array">
</argument>
<description>
Constructs an array from a [PackedVector2Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedVector3Array">
</argument>
<description>
Constructs an array from a [PackedVector3Array].
</description>
</method>
<method name="append">

28
doc/classes/Basis.xml
View File

@ -22,20 +22,17 @@
<method name="Basis">
<return type="Basis">
</return>
<argument index="0" name="from" type="Quat">
</argument>
<description>
Constructs a pure rotation basis matrix from the given quaternion.
Constructs a default-initialized [Basis] set to [constant IDENTITY].
</description>
</method>
<method name="Basis">
<return type="Basis">
</return>
<argument index="0" name="from" type="Vector3">
<argument index="0" name="from" type="Basis">
</argument>
<description>
Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle).
Consider using the [Quat] constructor instead, which uses a quaternion instead of Euler angles.
Constructs a [Basis] as a copy of the given [Basis].
</description>
</method>
<method name="Basis">
@ -49,6 +46,25 @@
Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector.
</description>
</method>
<method name="Basis">
<return type="Basis">
</return>
<argument index="0" name="euler" type="Vector3">
</argument>
<description>
Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle).
Consider using the [Quat] constructor instead, which uses a quaternion instead of Euler angles.
</description>
</method>
<method name="Basis">
<return type="Basis">
</return>
<argument index="0" name="from" type="Quat">
</argument>
<description>
Constructs a pure rotation basis matrix from the given quaternion.
</description>
</method>
<method name="Basis">
<return type="Basis">
</return>

24
doc/classes/Callable.xml
View File

@ -39,12 +39,28 @@
<method name="Callable">
<return type="Callable">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method_name" type="StringName">
<description>
Constructs a null [Callable] with no object nor method bound.
</description>
</method>
<method name="Callable">
<return type="Callable">
</return>
<argument index="0" name="from" type="Callable">
</argument>
<description>
Creates a new [Callable] for the method called [code]method_name[/code] in the specified [code]object[/code].
Constructs a [Callable] as a copy of the given [Callable].
</description>
</method>
<method name="Callable">
<return type="Callable">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method" type="StringName">
</argument>
<description>
Creates a new [Callable] for the method called [code]method[/code] in the specified [code]object[/code].
</description>
</method>
<method name="bind" qualifiers="vararg">

101
doc/classes/Color.xml
View File

@ -19,71 +19,28 @@
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="from" type="String">
</argument>
<description>
Constructs a color from an HTML hexadecimal color string in RGB or RGBA format. See also [method @GDScript.ColorN].
[codeblocks]
[gdscript]
# Each of the following creates the same color RGBA(178, 217, 10, 255).
var c3 = Color("#b2d90a") # RGB format with "#".
var c4 = Color("b2d90a") # RGB format.
var c1 = Color("#b2d90aff") # RGBA format with "#".
var c2 = Color("b2d90aff") # RGBA format.
[/gdscript]
[csharp]
// Each of the following creates the same color RGBA(178, 217, 10, 255).
var c3 = new Color("#b2d90a");
var c4 = new Color("b2d90a"); // RGB format.
var c1 = new Color("#b2d90aff");
var c2 = new Color("b2d90aff"); // RGBA format.
[/csharp]
[/codeblocks]
You can also use the "web color" short-hand form by only using 3 or 4 digits.
[codeblocks]
[gdscript]
# Each of the following creates the same color RGBA(17, 34, 51, 255).
var c3 = Color("#123") # RGB format with "#".
var c4 = Color("123") # RGB format.
var c1 = Color("#123f") # RGBA format with "#".
var c2 = Color("123f") # RGBA format.
[/gdscript]
[csharp]
// Each of the following creates the same color RGBA(17, 34, 51, 255).
var c3 = new Color("#123");
var c4 = new Color("123"); // RGB format.
var c1 = new Color("#123f");
var c2 = new Color("123f"); // RGBA format.
[/csharp]
[/codeblocks]
Constructs a default-initialized [Color] with all components set to [code]0[/code].
</description>
</method>
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="from" type="int">
<argument index="0" name="from" type="Color">
</argument>
<description>
Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
[codeblocks]
[gdscript]
var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18)
[/gdscript]
[csharp]
var c = new Color(274); // Equivalent to RGBA(0, 0, 1, 18)
[/csharp]
[/codeblocks]
Constructs a [Color] as a copy of the given [Color].
</description>
</method>
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="c" type="Color">
<argument index="0" name="from" type="Color">
</argument>
<argument index="1" name="a" type="float">
<argument index="1" name="alpha" type="float">
</argument>
<description>
Constructs a color from an existing color, but with a custom alpha value.
Constructs a [Color] from an existing color, but with a custom alpha value.
[codeblocks]
[gdscript]
var red = Color(Color.red, 0.5) # 50% transparent red.
@ -94,6 +51,29 @@
[/codeblocks]
</description>
</method>
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="r" type="float">
</argument>
<argument index="1" name="g" type="float">
</argument>
<argument index="2" name="b" type="float">
</argument>
<argument index="3" name="a" type="float">
</argument>
<description>
Constructs a [Color] from an RGBA profile using values between 0 and 1.
[codeblocks]
[gdscript]
var color = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204)
[/gdscript]
[csharp]
var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Equivalent to RGBA(51, 255, 178, 255, 204)
[/csharp]
[/codeblocks]
</description>
</method>
<method name="Color">
<return type="Color">
</return>
@ -115,29 +95,6 @@
[/codeblocks]
</description>
</method>
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="r" type="float">
</argument>
<argument index="1" name="g" type="float">
</argument>
<argument index="2" name="b" type="float">
</argument>
<argument index="3" name="a" type="float">
</argument>
<description>
Constructs a color from an RGBA profile using values between 0 and 1.
[codeblocks]
[gdscript]
var color = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204)
[/gdscript]
[csharp]
var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Equivalent to RGBA(51, 255, 178, 255, 204)
[/csharp]
[/codeblocks]
</description>
</method>
<method name="blend">
<return type="Color">
</return>

2
doc/classes/DTLSServer.xml
View File

@ -132,7 +132,7 @@
// Try to contact server
Dtls.PutPacket("The Answer Is..42!".ToUTF8());
}
while (Dtls.GetAvailablePacketCount() > 0)
while (Dtls.GetAvailablePacketCount() &gt; 0)
{
GD.Print("Connected: " + Dtls.GetPacket().GetStringFromUTF8());
Connected = true;

16
doc/classes/Dictionary.xml
View File

@ -171,6 +171,22 @@
<link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link>
</tutorials>
<methods>
<method name="Dictionary">
<return type="Dictionary">
</return>
<description>
Constructs an empty [Dictionary].
</description>
</method>
<method name="Dictionary">
<return type="Dictionary">
</return>
<argument index="0" name="from" type="Dictionary">
</argument>
<description>
Constructs a [Dictionary] as a copy of the given [Dictionary].
</description>
</method>
<method name="clear">
<return type="void">
</return>

53
doc/classes/FuncRef.xml
View File

@ -1,53 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="FuncRef" inherits="Reference" version="4.0">
<brief_description>
Reference to a function in an object.
</brief_description>
<description>
In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments.
However, by creating a [FuncRef] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called.
</description>
<tutorials>
</tutorials>
<methods>
<method name="call_func" qualifiers="vararg">
<return type="Variant">
</return>
<description>
Calls the referenced function previously set in [member function] or [method @GDScript.funcref].
</description>
</method>
<method name="call_funcv">
<return type="Variant">
</return>
<argument index="0" name="arg_array" type="Array">
</argument>
<description>
Calls the referenced function previously set in [member function] or [method @GDScript.funcref]. Contrarily to [method call_func], this method does not support a variable number of arguments but expects all parameters to be passed via a single [Array].
</description>
</method>
<method name="is_valid" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether the object still exists and has the function assigned.
</description>
</method>
<method name="set_instance">
<return type="void">
</return>
<argument index="0" name="instance" type="Object">
</argument>
<description>
The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary].
</description>
</method>
</methods>
<members>
<member name="function" type="StringName" setter="set_function" getter="get_function" default="@&quot;&quot;">
The name of the referenced function.
</member>
</members>
<constants>
</constants>
</class>

16
doc/classes/NodePath.xml
View File

@ -25,6 +25,22 @@
<link title="2D Role Playing Game Demo">https://godotengine.org/asset-library/asset/520</link>
</tutorials>
<methods>
<method name="NodePath">
<return type="NodePath">
</return>
<description>
Constructs an empty [NodePath].
</description>
</method>
<method name="NodePath">
<return type="NodePath">
</return>
<argument index="0" name="from" type="NodePath">
</argument>
<description>
Constructs a [NodePath] as a copy of the given [NodePath].
</description>
</method>
<method name="NodePath">
<return type="NodePath">
</return>

16
doc/classes/PackedByteArray.xml
View File

@ -10,6 +10,22 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedByteArray">
<return type="PackedByteArray">
</return>
<description>
Constructs an empty [PackedByteArray].
</description>
</method>
<method name="PackedByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="from" type="PackedByteArray">
</argument>
<description>
Constructs a [PackedByteArray] as a copy of the given [PackedByteArray].
</description>
</method>
<method name="PackedByteArray">
<return type="PackedByteArray">
</return>

16
doc/classes/PackedColorArray.xml
View File

@ -10,6 +10,22 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedColorArray">
<return type="PackedColorArray">
</return>
<description>
Constructs an empty [PackedColorArray].
</description>
</method>
<method name="PackedColorArray">
<return type="PackedColorArray">
</return>
<argument index="0" name="from" type="PackedColorArray">
</argument>
<description>
Constructs a [PackedColorArray] as a copy of the given [PackedColorArray].
</description>
</method>
<method name="PackedColorArray">
<return type="PackedColorArray">
</return>

16
doc/classes/PackedFloat32Array.xml
View File

@ -11,6 +11,22 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedFloat32Array">
<return type="PackedFloat32Array">
</return>
<description>
Constructs an empty [PackedFloat32Array].
</description>
</method>
<method name="PackedFloat32Array">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="from" type="PackedFloat32Array">
</argument>
<description>
Constructs a [PackedFloat32Array] as a copy of the given [PackedFloat32Array].
</description>
</method>
<method name="PackedFloat32Array">
<return type="PackedFloat32Array">
</return>

16
doc/classes/PackedFloat64Array.xml
View File

@ -11,6 +11,22 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedFloat64Array">
<return type="PackedFloat64Array">
</return>
<description>
Constructs an empty [PackedFloat64Array].
</description>
</method>
<method name="PackedFloat64Array">
<return type="PackedFloat64Array">
</return>
<argument index="0" name="from" type="PackedFloat64Array">
</argument>
<description>
Constructs a [PackedFloat64Array] as a copy of the given [PackedFloat64Array].
</description>
</method>
<method name="PackedFloat64Array">
<return type="PackedFloat64Array">
</return>

16
doc/classes/PackedInt32Array.xml
View File

@ -11,6 +11,22 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedInt32Array">
<return type="PackedInt32Array">
</return>
<description>
Constructs an empty [PackedInt32Array].
</description>
</method>
<method name="PackedInt32Array">
<return type="PackedInt32Array">
</return>
<argument index="0" name="from" type="PackedInt32Array">
</argument>
<description>
Constructs a [PackedInt32Array] as a copy of the given [PackedInt32Array].
</description>
</method>
<method name="PackedInt32Array">
<return type="PackedInt32Array">
</return>

16
doc/classes/PackedInt64Array.xml
View File

@ -11,6 +11,22 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedInt64Array">
<return type="PackedInt64Array">
</return>
<description>
Constructs an empty [PackedInt64Array].
</description>
</method>
<method name="PackedInt64Array">
<return type="PackedInt64Array">
</return>
<argument index="0" name="from" type="PackedInt64Array">
</argument>
<description>
Constructs a [PackedInt64Array] as a copy of the given [PackedInt64Array].
</description>
</method>
<method name="PackedInt64Array">
<return type="PackedInt64Array">
</return>

16
doc/classes/PackedStringArray.xml
View File

@ -11,6 +11,22 @@
<link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link>
</tutorials>
<methods>
<method name="PackedStringArray">
<return type="PackedStringArray">
</return>
<description>
Constructs an empty [PackedStringArray].
</description>
</method>
<method name="PackedStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="from" type="PackedStringArray">
</argument>
<description>
Constructs a [PackedStringArray] as a copy of the given [PackedStringArray].
</description>
</method>
<method name="PackedStringArray">
<return type="PackedStringArray">
</return>

16
doc/classes/PackedVector2Array.xml
View File

@ -11,6 +11,22 @@
<link title="2D Navigation Astar Demo">https://godotengine.org/asset-library/asset/519</link>
</tutorials>
<methods>
<method name="PackedVector2Array">
<return type="PackedVector2Array">
</return>
<description>
Constructs an empty [PackedVector2Array].
</description>
</method>
<method name="PackedVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="PackedVector2Array">
</argument>
<description>
Constructs a [PackedVector2Array] as a copy of the given [PackedVector2Array].
</description>
</method>
<method name="PackedVector2Array">
<return type="PackedVector2Array">
</return>

16
doc/classes/PackedVector3Array.xml
View File

@ -10,6 +10,22 @@
<tutorials>
</tutorials>
<methods>
<method name="PackedVector3Array">
<return type="PackedVector3Array">
</return>
<description>
Constructs an empty [PackedVector3Array].
</description>
</method>
<method name="PackedVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="PackedVector3Array">
</argument>
<description>
Constructs a [PackedVector3Array] as a copy of the given [PackedVector3Array].
</description>
</method>
<method name="PackedVector3Array">
<return type="PackedVector3Array">
</return>

53
doc/classes/Plane.xml
View File

@ -10,6 +10,22 @@
<link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
</tutorials>
<methods>
<method name="Plane">
<return type="Plane">
</return>
<description>
Constructs a default-initialized [Plane] with all components set to [code]0[/code].
</description>
</method>
<method name="Plane">
<return type="Plane">
</return>
<argument index="0" name="from" type="Plane">
</argument>
<description>
Constructs a [Plane] as a copy of the given [Plane].
</description>
</method>
<method name="Plane">
<return type="Plane">
</return>
@ -25,19 +41,6 @@
Creates a plane from the four parameters. The three components of the resulting plane's [member normal] are [code]a[/code], [code]b[/code] and [code]c[/code], and the plane has a distance of [code]d[/code] from the origin.
</description>
</method>
<method name="Plane">
<return type="Plane">
</return>
<argument index="0" name="v1" type="Vector3">
</argument>
<argument index="1" name="v2" type="Vector3">
</argument>
<argument index="2" name="v3" type="Vector3">
</argument>
<description>
Creates a plane from the three points, given in clockwise order.
</description>
</method>
<method name="Plane">
<return type="Plane">
</return>
@ -49,6 +52,30 @@
Creates a plane from the normal and the plane's distance to the origin.
</description>
</method>
<method name="Plane">
<return type="Plane">
</return>
<argument index="0" name="point" type="Vector3">
</argument>
<argument index="1" name="normal" type="Vector3">
</argument>
<description>
Creates a plane from the given position and a plane normal.
</description>
</method>
<method name="Plane">
<return type="Plane">
</return>
<argument index="0" name="point1" type="Vector3">
</argument>
<argument index="1" name="point2" type="Vector3">
</argument>
<argument index="2" name="point3" type="Vector3">
</argument>
<description>
Creates a plane from the three points, given in clockwise order.
</description>
</method>
<method name="center">
<return type="Vector3">
</return>

42
doc/classes/Quat.xml
View File

@ -16,16 +16,27 @@
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="x" type="float">
</argument>
<argument index="1" name="y" type="float">
</argument>
<argument index="2" name="z" type="float">
</argument>
<argument index="3" name="w" type="float">
<description>
Constructs a default-initialized quaternion with all components set to [code]0[/code].
</description>
</method>
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="from" type="Quat">
</argument>
<description>
Constructs a [Quat] as a copy of the given [Quat].
</description>
</method>
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="arc_from" type="Vector3">
</argument>
<argument index="1" name="arc_to" type="Vector3">
</argument>
<description>
Constructs a quaternion defined by the given values.
</description>
</method>
<method name="Quat">
@ -57,6 +68,21 @@
Constructs a quaternion from the given [Basis].
</description>
</method>
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="x" type="float">
</argument>
<argument index="1" name="y" type="float">
</argument>
<argument index="2" name="z" type="float">
</argument>
<argument index="3" name="w" type="float">
</argument>
<description>
Constructs a quaternion defined by the given values.
</description>
</method>
<method name="cubic_slerp">
<return type="Quat">
</return>

11
doc/classes/RID.xml
View File

@ -12,10 +12,17 @@
<method name="RID">
<return type="RID">
</return>
<argument index="0" name="from" type="Object">
<description>
Constructs an empty [RID] with the invalid ID [code]0[/code].
</description>
</method>
<method name="RID">
<return type="RID">
</return>
<argument index="0" name="from" type="RID">
</argument>
<description>
Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
Constructs a [RID] as a copy of the given [RID].
</description>
</method>
<method name="get_id">

34
doc/classes/Rect2.xml
View File

@ -14,6 +14,31 @@
<link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link>
</tutorials>
<methods>
<method name="Rect2">
<return type="Rect2">
</return>
<description>
Constructs a default-initialized [Rect2] with default (zero) values of [member position] and [member size].
</description>
</method>
<method name="Rect2">
<return type="Rect2">
</return>
<argument index="0" name="from" type="Rect2">
</argument>
<description>
Constructs a [Rect2] as a copy of the given [Rect2].
</description>
</method>
<method name="Rect2">
<return type="Rect2">
</return>
<argument index="0" name="from" type="Rect2i">
</argument>
<description>
Constructs a [Rect2] from a [Rect2i].
</description>
</method>
<method name="Rect2">
<return type="Rect2">
</return>
@ -40,15 +65,6 @@
Constructs a [Rect2] by x, y, width, and height.
</description>
</method>
<method name="Rect2">
<return type="Rect2">
</return>
<argument index="0" name="from" type="Rect2i">
</argument>
<description>
Constructs a [Rect2] from a [Rect2i].
</description>
</method>
<method name="abs">
<return type="Rect2">
</return>

34
doc/classes/Rect2i.xml
View File

@ -12,6 +12,31 @@
<link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
</tutorials>
<methods>
<method name="Rect2i">
<return type="Rect2i">
</return>
<description>
Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size].
</description>
</method>
<method name="Rect2i">
<return type="Rect2i">
</return>
<argument index="0" name="from" type="Rect2i">
</argument>
<description>
Constructs a [Rect2i] as a copy of the given [Rect2i].
</description>
</method>
<method name="Rect2i">
<return type="Rect2i">
</return>
<argument index="0" name="from" type="Rect2">
</argument>
<description>
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
</description>
</method>
<method name="Rect2i">
<return type="Rect2i">
</return>
@ -38,15 +63,6 @@
Constructs a [Rect2i] by x, y, width, and height.
</description>
</method>
<method name="Rect2i">
<return type="Rect2i">
</return>
<argument index="0" name="from" type="Rect2">
</argument>
<description>
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
</description>
</method>
<method name="abs">
<return type="Rect2i">
</return>

24
doc/classes/Signal.xml
View File

@ -11,12 +11,28 @@
<method name="Signal">
<return type="Signal">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="signal_name" type="StringName">
<description>
Constructs a null [Signal] with no object nor signal name bound.
</description>
</method>
<method name="Signal">
<return type="Signal">
</return>
<argument index="0" name="from" type="Signal">
</argument>
<description>
Creates a new signal named [code]signal_name[/code] in the given object.
Constructs a [Signal] as a copy of the given [Signal].
</description>
</method>
<method name="Signal">
<return type="Signal">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="signal" type="StringName">
</argument>
<description>
Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code].
</description>
</method>
<method name="connect">

264
doc/classes/String.xml
View File

@ -13,154 +13,17 @@
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="bool">
</argument>
<description>
Constructs a new String from the given [bool].
Constructs an empty [String] ([code]""[/code]).
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="int">
<argument index="0" name="from" type="String">
</argument>
<description>
Constructs a new String from the given [int].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="float">
</argument>
<description>
Constructs a new String from the given [float].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Vector2">
</argument>
<description>
Constructs a new String from the given [Vector2].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Vector2i">
</argument>
<description>
Constructs a new String from the given [Vector2i].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Rect2">
</argument>
<description>
Constructs a new String from the given [Rect2].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Rect2i">
</argument>
<description>
Constructs a new String from the given [Rect2i].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
<description>
Constructs a new String from the given [Vector3].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Vector3i">
</argument>
<description>
Constructs a new String from the given [Vector3i].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Transform2D">
</argument>
<description>
Constructs a new String from the given [Transform2D].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Plane">
</argument>
<description>
Constructs a new String from the given [Plane].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Quat">
</argument>
<description>
Constructs a new String from the given [Quat].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="AABB">
</argument>
<description>
Constructs a new String from the given [AABB].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Basis">
</argument>
<description>
Constructs a new String from the given [Basis].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Transform">
</argument>
<description>
Constructs a new String from the given [Transform].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Color">
</argument>
<description>
Constructs a new String from the given [Color].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="StringName">
</argument>
<description>
Constructs a new String from the given [StringName].
Constructs a [String] as a copy of the given [String].
</description>
</method>
<method name="String">
@ -175,127 +38,10 @@
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="RID">
<argument index="0" name="from" type="StringName">
</argument>
<description>
Constructs a new String from the given [RID].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Callable">
</argument>
<description>
Constructs a new String from the given [Callable].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Signal">
</argument>
<description>
Constructs a new String from the given [Signal].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Dictionary">
</argument>
<description>
Constructs a new String from the given [Dictionary].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new String from the given [Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedByteArray">
</argument>
<description>
Constructs a new String from the given [PackedByteArray].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedInt32Array">
</argument>
<description>
Constructs a new String from the given [PackedInt32Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedInt64Array">
</argument>
<description>
Constructs a new String from the given [PackedInt64Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedFloat32Array">
</argument>
<description>
Constructs a new String from the given [PackedFloat32Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedFloat64Array">
</argument>
<description>
Constructs a new String from the given [PackedFloat64Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedStringArray">
</argument>
<description>
Constructs a new String from the given [PackedStringArray].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedVector2Array">
</argument>
<description>
Constructs a new String from the given [PackedVector2Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedVector3Array">
</argument>
<description>
Constructs a new String from the given [PackedVector3Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedColorArray">
</argument>
<description>
Constructs a new String from the given [PackedColorArray].
Constructs a new String from the given [StringName].
</description>
</method>
<method name="begins_with">

16
doc/classes/StringName.xml
View File

@ -9,6 +9,22 @@
<tutorials>
</tutorials>
<methods>
<method name="StringName">
<return type="StringName">
</return>
<description>
Constructs an empty [StringName].
</description>
</method>
<method name="StringName">
<return type="StringName">
</return>
<argument index="0" name="from" type="StringName">
</argument>
<description>
Constructs a [StringName] as a copy of the given [StringName].
</description>
</method>
<method name="StringName">
<return type="StringName">
</return>

45
doc/classes/Transform.xml
View File

@ -19,16 +19,17 @@
<method name="Transform">
<return type="Transform">
</return>
<argument index="0" name="x_axis" type="Vector3">
</argument>
<argument index="1" name="y_axis" type="Vector3">
</argument>
<argument index="2" name="z_axis" type="Vector3">
</argument>
<argument index="3" name="origin" type="Vector3">
<description>
Constructs a default-initialized [Transform] set to [constant IDENTITY].
</description>
</method>
<method name="Transform">
<return type="Transform">
</return>
<argument index="0" name="from" type="Transform">
</argument>
<description>
Constructs a Transform from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled).
Constructs a [Transform] as a copy of the given [Transform].
</description>
</method>
<method name="Transform">
@ -45,28 +46,16 @@
<method name="Transform">
<return type="Transform">
</return>
<argument index="0" name="from" type="Transform2D">
<argument index="0" name="x_axis" type="Vector3">
</argument>
<argument index="1" name="y_axis" type="Vector3">
</argument>
<argument index="2" name="z_axis" type="Vector3">
</argument>
<argument index="3" name="origin" type="Vector3">
</argument>
<description>
Constructs a Transform from a [Transform2D].
</description>
</method>
<method name="Transform">
<return type="Transform">
</return>
<argument index="0" name="from" type="Quat">
</argument>
<description>
Constructs a Transform from a [Quat]. The origin will be [code]Vector3(0, 0, 0)[/code].
</description>
</method>
<method name="Transform">
<return type="Transform">
</return>
<argument index="0" name="from" type="Basis">
</argument>
<description>
Constructs the Transform from a [Basis]. The origin will be Vector3(0, 0, 0).
Constructs a Transform from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled).
</description>
</method>
<method name="affine_inverse">

25
doc/classes/Transform2D.xml
View File

@ -14,6 +14,22 @@
<link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link>
</tutorials>
<methods>
<method name="Transform2D">
<return type="Transform2D">
</return>
<description>
Constructs a default-initialized [Transform] set to [constant IDENTITY].
</description>
</method>
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="from" type="Transform2D">
</argument>
<description>
Constructs a [Transform2D] as a copy of the given [Transform2D].
</description>
</method>
<method name="Transform2D">
<return type="Transform2D">
</return>
@ -38,15 +54,6 @@
Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors).
</description>
</method>
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="from" type="Transform">
</argument>
<description>
Constructs the transform from a 3D [Transform].
</description>
</method>
<method name="affine_inverse">
<return type="Transform2D">
</return>

16
doc/classes/Vector2.xml
View File

@ -17,6 +17,22 @@
<link title="All 2D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/2d</link>
</tutorials>
<methods>
<method name="Vector2">
<return type="Vector2">
</return>
<description>
Constructs a default-initialized [Vector2] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector2">
<return type="Vector2">
</return>
<argument index="0" name="from" type="Vector2">
</argument>
<description>
Constructs a [Vector2] as a copy of the given [Vector2].
</description>
</method>
<method name="Vector2">
<return type="Vector2">
</return>

24
doc/classes/Vector2i.xml
View File

@ -17,12 +17,17 @@
<method name="Vector2i">
<return type="Vector2i">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
<description>
Constructs a default-initialized [Vector2i] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector2i">
<return type="Vector2i">
</return>
<argument index="0" name="from" type="Vector2i">
</argument>
<description>
Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code].
Constructs a [Vector2i] as a copy of the given [Vector2i].
</description>
</method>
<method name="Vector2i">
@ -34,6 +39,17 @@
Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated.
</description>
</method>
<method name="Vector2i">
<return type="Vector2i">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<description>
Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code].
</description>
</method>
<method name="abs">
<return type="Vector2i">
</return>

16
doc/classes/Vector3.xml
View File

@ -17,6 +17,22 @@
<link title="All 3D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/3d</link>
</tutorials>
<methods>
<method name="Vector3">
<return type="Vector3">
</return>
<description>
Constructs a default-initialized [Vector3] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector3">
<return type="Vector3">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
<description>
Constructs a [Vector3] as a copy of the given [Vector3].
</description>
</method>
<method name="Vector3">
<return type="Vector3">
</return>

28
doc/classes/Vector3i.xml
View File

@ -17,14 +17,17 @@
<method name="Vector3i">
<return type="Vector3i">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
<description>
Constructs a default-initialized [Vector3i] with all components set to [code]0[/code].
</description>
</method>
<method name="Vector3i">
<return type="Vector3i">
</return>
<argument index="0" name="from" type="Vector3i">
</argument>
<description>
Returns a [Vector3i] with the given components.
Constructs a [Vector3i] as a copy of the given [Vector3i].
</description>
</method>
<method name="Vector3i">
@ -36,6 +39,19 @@
Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated.
</description>
</method>
<method name="Vector3i">
<return type="Vector3i">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<description>
Returns a [Vector3i] with the given components.
</description>
</method>
<method name="abs">
<return type="Vector3i">
</return>

16
doc/classes/bool.xml
View File

@ -94,10 +94,17 @@
<method name="bool">
<return type="bool">
</return>
<argument index="0" name="from" type="int">
<description>
Constructs a default-initialized [bool] set to [code]false[/code].
</description>
</method>
<method name="bool">
<return type="bool">
</return>
<argument index="0" name="from" type="bool">
</argument>
<description>
Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints.
Constructs a [bool] as a copy of the given [bool].
</description>
</method>
<method name="bool">
@ -112,11 +119,10 @@
<method name="bool">
<return type="bool">
</return>
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="int">
</argument>
<description>
Cast a [String] value to a boolean value, this method will return [code]false[/code] if [code]""[/code] is passed in, and [code]true[/code] for all non-empty strings.
Examples: [code]bool("False")[/code] returns [code]true[/code], [code]bool("")[/code] returns [code]false[/code].
Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints.
</description>
</method>
</methods>

27
doc/classes/float.xml
View File

@ -9,6 +9,22 @@
<tutorials>
</tutorials>
<methods>
<method name="float">
<return type="float">
</return>
<description>
Constructs a default-initialized [float] set to [code]0.0[/code].
</description>
</method>
<method name="float">
<return type="float">
</return>
<argument index="0" name="from" type="float">
</argument>
<description>
Constructs a [float] as a copy of the given [float].
</description>
</method>
<method name="float">
<return type="float">
</return>
@ -24,16 +40,7 @@
<argument index="0" name="from" type="int">
</argument>
<description>
Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to 1.0.
</description>
</method>
<method name="float">
<return type="float">
</return>
<argument index="0" name="from" type="String">
</argument>
<description>
Cast a [String] value to a floating-point value. This method accepts float value strings like [code]"1.23"[/code] and exponential notation strings for its parameter so calling [code]float("1e3")[/code] will return 1000.0 and calling [code]float("1e-3")[/code] will return 0.001. Calling this method with an invalid float string will return 0. This method stops parsing at the first invalid character and will return the parsed result so far, so calling [code]float("1a3")[/code] will return 1 while calling [code]float("1e3a2")[/code] will return 1000.0.
Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to [code]1.0[/code].
</description>
</method>
</methods>

25
doc/classes/int.xml
View File

@ -23,6 +23,22 @@
<tutorials>
</tutorials>
<methods>
<method name="int">
<return type="int">
</return>
<description>
Constructs a default-initialized [int] set to [code]0[/code].
</description>
</method>
<method name="int">
<return type="int">
</return>
<argument index="0" name="from" type="int">
</argument>
<description>
Constructs an [int] as a copy of the given [int].
</description>
</method>
<method name="int">
<return type="int">
</return>
@ -41,15 +57,6 @@
Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2.
</description>
</method>
<method name="int">
<return type="int">
</return>
<argument index="0" name="from" type="String">
</argument>
<description>
Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13.
</description>
</method>
</methods>
<constants>
</constants>

17
editor/doc_data.h
View File

@ -43,6 +43,9 @@ public:
String enumeration;
String default_value;
bool operator<(const ArgumentDoc &p_arg) const {
if (name == p_arg.name) {
return type < p_arg.type;
}
return name < p_arg.name;
}
};
@ -55,6 +58,20 @@ public:
String description;
Vector<ArgumentDoc> arguments;
bool operator<(const MethodDoc &p_method) const {
if (name == p_method.name) {
// Must be a constructor since there is no overloading.
// We want this arbitrary order for a class "Foo":
// - 1. Default constructor: Foo()
// - 2. Copy constructor: Foo(Foo)
// - 3+. Other constructors Foo(Bar, ...) based on first argument's name
if (arguments.size() == 0 || p_method.arguments.size() == 0) { // 1.
return arguments.size() < p_method.arguments.size();
}
if (arguments[0].type == return_type || p_method.arguments[0].type == p_method.return_type) { // 2.
return (arguments[0].type == return_type) || (p_method.arguments[0].type != p_method.return_type);
}
return arguments[0] < p_method.arguments[0];
}
return name < p_method.name;
}
};

76
modules/gdscript/doc_classes/@GDScript.xml
View File

@ -386,24 +386,6 @@
[/codeblock]
</description>
</method>
<method name="funcref">
<return type="FuncRef">
</return>
<argument index="0" name="instance" type="Object">
</argument>
<argument index="1" name="funcname" type="String">
</argument>
<description>
Returns a reference to the specified function [code]funcname[/code] in the [code]instance[/code] node. As functions aren't first-class objects in GDscript, use [code]funcref[/code] to store a [FuncRef] in a variable and call it later.
[codeblock]
func foo():
return("bar")
a = funcref(self, "foo")
print(a.call_func()) # Prints bar
[/codeblock]
</description>
</method>
<method name="get_stack">
<return type="Array">
</return>
@ -921,35 +903,6 @@
[/codeblock]
</description>
</method>
<method name="randf_range">
<return type="float">
</return>
<argument index="0" name="from" type="float">
</argument>
<argument index="1" name="to" type="float">
</argument>
<description>
Random range, any floating point value between [code]from[/code] and [code]to[/code].
[codeblock]
prints(randf_range(-10, 10), randf_range(-10, 10)) # Prints e.g. -3.844535 7.45315
[/codeblock]
</description>
</method>
<method name="randi_range">
<return type="int">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
Random range, any 32-bit integer value between [code]from[/code] and [code]to[/code] (inclusive). If [code]to[/code] is lesser than [code]from[/code] they are swapped.
[codeblock]
print(randi_range(0, 1)) # Prints 0 or 1
print(randi_range(-10, 1000)) # Prints any number from -10 to 1000
[/codeblock]
</description>
</method>
<method name="rand_seed">
<return type="Array">
</return>
@ -969,6 +922,20 @@
[/codeblock]
</description>
</method>
<method name="randf_range">
<return type="float">
</return>
<argument index="0" name="from" type="float">
</argument>
<argument index="1" name="to" type="float">
</argument>
<description>
Random range, any floating point value between [code]from[/code] and [code]to[/code].
[codeblock]
prints(randf_range(-10, 10), randf_range(-10, 10)) # Prints e.g. -3.844535 7.45315
[/codeblock]
</description>
</method>
<method name="randi">
<return type="int">
</return>
@ -982,6 +949,21 @@
[/codeblock]
</description>
</method>
<method name="randi_range">
<return type="int">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
Random range, any 32-bit integer value between [code]from[/code] and [code]to[/code] (inclusive). If [code]to[/code] is lesser than [code]from[/code] they are swapped.
[codeblock]
print(randi_range(0, 1)) # Prints 0 or 1
print(randi_range(-10, 1000)) # Prints any number from -10 to 1000
[/codeblock]
</description>
</method>
<method name="randomize">
<return type="void">
</return>

39
modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
View File

@ -166,63 +166,60 @@
<constant name="OBJ_WEAKREF" value="50" enum="BuiltinFunc">
Create a [WeakRef] from the input.
</constant>
<constant name="FUNC_FUNCREF" value="51" enum="BuiltinFunc">
Create a [FuncRef] from the input.
</constant>
<constant name="TYPE_CONVERT" value="52" enum="BuiltinFunc">
<constant name="TYPE_CONVERT" value="51" enum="BuiltinFunc">
Convert between types.
</constant>
<constant name="TYPE_OF" value="53" enum="BuiltinFunc">
<constant name="TYPE_OF" value="52" enum="BuiltinFunc">
Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned.
</constant>
<constant name="TYPE_EXISTS" value="54" enum="BuiltinFunc">
<constant name="TYPE_EXISTS" value="53" enum="BuiltinFunc">
Checks if a type is registered in the [ClassDB].
</constant>
<constant name="TEXT_CHAR" value="55" enum="BuiltinFunc">
<constant name="TEXT_CHAR" value="54" enum="BuiltinFunc">
Return a character with the given ascii value.
</constant>
<constant name="TEXT_STR" value="56" enum="BuiltinFunc">
<constant name="TEXT_STR" value="55" enum="BuiltinFunc">
Convert the input to a string.
</constant>
<constant name="TEXT_PRINT" value="57" enum="BuiltinFunc">
<constant name="TEXT_PRINT" value="56" enum="BuiltinFunc">
Print the given string to the output window.
</constant>
<constant name="TEXT_PRINTERR" value="58" enum="BuiltinFunc">
<constant name="TEXT_PRINTERR" value="57" enum="BuiltinFunc">
Print the given string to the standard error output.
</constant>
<constant name="TEXT_PRINTRAW" value="59" enum="BuiltinFunc">
<constant name="TEXT_PRINTRAW" value="58" enum="BuiltinFunc">
Print the given string to the standard output, without adding a newline.
</constant>
<constant name="VAR_TO_STR" value="60" enum="BuiltinFunc">
<constant name="VAR_TO_STR" value="59" enum="BuiltinFunc">
Serialize a [Variant] to a string.
</constant>
<constant name="STR_TO_VAR" value="61" enum="BuiltinFunc">
<constant name="STR_TO_VAR" value="60" enum="BuiltinFunc">
Deserialize a [Variant] from a string serialized using [constant VAR_TO_STR].
</constant>
<constant name="VAR_TO_BYTES" value="62" enum="BuiltinFunc">
<constant name="VAR_TO_BYTES" value="61" enum="BuiltinFunc">
Serialize a [Variant] to a [PackedByteArray].
</constant>
<constant name="BYTES_TO_VAR" value="63" enum="BuiltinFunc">
<constant name="BYTES_TO_VAR" value="62" enum="BuiltinFunc">
Deserialize a [Variant] from a [PackedByteArray] serialized using [constant VAR_TO_BYTES].
</constant>
<constant name="COLORN" value="64" enum="BuiltinFunc">
<constant name="COLORN" value="63" enum="BuiltinFunc">
Return the [Color] with the given name and alpha ranging from 0 to 1.
[b]Note:[/b] Names are defined in [code]color_names.inc[/code].
</constant>
<constant name="MATH_SMOOTHSTEP" value="65" enum="BuiltinFunc">
<constant name="MATH_SMOOTHSTEP" value="64" enum="BuiltinFunc">
Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to [constant MATH_LERP], but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula:
[codeblock]
var t = clamp((weight - from) / (to - from), 0.0, 1.0)
return t * t * (3.0 - 2.0 * t)
[/codeblock]
</constant>
<constant name="MATH_POSMOD" value="66" enum="BuiltinFunc">
<constant name="MATH_POSMOD" value="65" enum="BuiltinFunc">
</constant>
<constant name="MATH_LERP_ANGLE" value="67" enum="BuiltinFunc">
<constant name="MATH_LERP_ANGLE" value="66" enum="BuiltinFunc">
</constant>
<constant name="TEXT_ORD" value="68" enum="BuiltinFunc">
<constant name="TEXT_ORD" value="67" enum="BuiltinFunc">
</constant>
<constant name="FUNC_MAX" value="69" enum="BuiltinFunc">
<constant name="FUNC_MAX" value="68" enum="BuiltinFunc">
Represents the size of the [enum BuiltinFunc] enum.
</constant>
</constants>