diff options
432 files changed, 10529 insertions, 10529 deletions
diff --git a/doc/class.xsd b/doc/class.xsd index 70c0323464..7681ddad3d 100644 --- a/doc/class.xsd +++ b/doc/class.xsd @@ -35,7 +35,7 @@ <xs:attribute type="xs:string" name="enum" use="optional" /> </xs:complexType> </xs:element> - <xs:element name="argument" maxOccurs="unbounded" minOccurs="0"> + <xs:element name="param" maxOccurs="unbounded" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:sequence /> @@ -79,7 +79,7 @@ <xs:attribute type="xs:byte" name="number" /> </xs:complexType> </xs:element> - <xs:element name="argument" maxOccurs="unbounded" minOccurs="0"> + <xs:element name="param" maxOccurs="unbounded" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:sequence /> @@ -127,7 +127,7 @@ <xs:element name="signal" maxOccurs="unbounded" minOccurs="0"> <xs:complexType> <xs:sequence> - <xs:element name="argument" maxOccurs="unbounded" minOccurs="0"> + <xs:element name="param" maxOccurs="unbounded" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:sequence /> @@ -178,7 +178,7 @@ <xs:attribute type="xs:string" name="enum" use="optional" /> </xs:complexType> </xs:element> - <xs:element name="argument" maxOccurs="unbounded" minOccurs="0"> + <xs:element name="param" maxOccurs="unbounded" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:sequence /> @@ -232,7 +232,7 @@ <xs:attribute type="xs:string" name="enum" use="optional" /> </xs:complexType> </xs:element> - <xs:element name="argument" maxOccurs="unbounded" minOccurs="0"> + <xs:element name="param" maxOccurs="unbounded" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:sequence /> diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 7a75823230..05e4e209d1 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -14,7 +14,7 @@ <methods> <method name="abs"> <return type="Variant" /> - <argument index="0" name="x" type="Variant" /> + <param index="0" name="x" type="Variant" /> <description> Returns the absolute value of a [Variant] parameter [code]x[/code] (i.e. non-negative value). Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. [codeblock] @@ -40,7 +40,7 @@ </method> <method name="absf"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the absolute value of float parameter [code]x[/code] (i.e. positive value). [codeblock] @@ -51,7 +51,7 @@ </method> <method name="absi"> <return type="int" /> - <argument index="0" name="x" type="int" /> + <param index="0" name="x" type="int" /> <description> Returns the absolute value of int parameter [code]x[/code] (i.e. positive value). [codeblock] @@ -62,7 +62,7 @@ </method> <method name="acos"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the arc cosine of [code]x[/code] in radians. Use to get the angle of cosine [code]x[/code]. [code]x[/code] must be between [code]-1.0[/code] and [code]1.0[/code] (inclusive), otherwise, [method acos] will return [constant @GDScript.NAN]. [codeblock] @@ -73,7 +73,7 @@ </method> <method name="asin"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the arc sine of [code]x[/code] in radians. Use to get the angle of sine [code]x[/code]. [code]x[/code] must be between [code]-1.0[/code] and [code]1.0[/code] (inclusive), otherwise, [method asin] will return [constant @GDScript.NAN]. [codeblock] @@ -84,7 +84,7 @@ </method> <method name="atan"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the arc tangent of [code]x[/code] in radians. Use it to get the angle from an angle's tangent in trigonometry. The method cannot know in which quadrant the angle should fall. See [method atan2] if you have both [code]y[/code] and [code]x[/code]. @@ -96,8 +96,8 @@ </method> <method name="atan2"> <return type="float" /> - <argument index="0" name="y" type="float" /> - <argument index="1" name="x" type="float" /> + <param index="0" name="y" type="float" /> + <param index="1" name="x" type="float" /> <description> Returns the arc tangent of [code]y/x[/code] in radians. Use to get the angle of tangent [code]y/x[/code]. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant. Important note: The Y coordinate comes first, by convention. @@ -108,18 +108,18 @@ </method> <method name="bezier_interpolate"> <return type="float" /> - <argument index="0" name="start" type="float" /> - <argument index="1" name="control_1" type="float" /> - <argument index="2" name="control_2" type="float" /> - <argument index="3" name="end" type="float" /> - <argument index="4" name="t" type="float" /> + <param index="0" name="start" type="float" /> + <param index="1" name="control_1" type="float" /> + <param index="2" name="control_2" type="float" /> + <param index="3" name="end" type="float" /> + <param index="4" name="t" type="float" /> <description> Returns the point at the given [code]t[/code] on a one-dimnesional [url=https://en.wikipedia.org/wiki/B%C3%A9zier_curve]Bezier curve[/url] defined by the given [code]control_1[/code], [code]control_2[/code], and [code]end[/code] points. </description> </method> <method name="bytes2var"> <return type="Variant" /> - <argument index="0" name="bytes" type="PackedByteArray" /> + <param index="0" name="bytes" type="PackedByteArray" /> <description> Decodes a byte array back to a [Variant] value, without decoding objects. [b]Note:[/b] If you need object deserialization, see [method bytes2var_with_objects]. @@ -127,7 +127,7 @@ </method> <method name="bytes2var_with_objects"> <return type="Variant" /> - <argument index="0" name="bytes" type="PackedByteArray" /> + <param index="0" name="bytes" type="PackedByteArray" /> <description> Decodes a byte array back to a [Variant] value. Decoding objects is allowed. [b]Warning:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). @@ -135,7 +135,7 @@ </method> <method name="ceil"> <return type="Variant" /> - <argument index="0" name="x" type="Variant" /> + <param index="0" name="x" type="Variant" /> <description> Rounds [code]x[/code] upward (towards positive infinity), returning the smallest whole number that is not less than [code]x[/code]. Supported types: [int], [float], [Vector2], [Vector3], [Vector4]. [codeblock] @@ -148,7 +148,7 @@ </method> <method name="ceilf"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Rounds [code]x[/code] upward (towards positive infinity), returning the smallest whole number that is not less than [code]x[/code]. A type-safe version of [method ceil], specialzied in floats. @@ -156,7 +156,7 @@ </method> <method name="ceili"> <return type="int" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Rounds [code]x[/code] upward (towards positive infinity), returning the smallest whole number that is not less than [code]x[/code]. A type-safe version of [method ceil] that returns integer. @@ -164,9 +164,9 @@ </method> <method name="clamp"> <return type="Variant" /> - <argument index="0" name="value" type="Variant" /> - <argument index="1" name="min" type="Variant" /> - <argument index="2" name="max" type="Variant" /> + <param index="0" name="value" type="Variant" /> + <param index="1" name="min" type="Variant" /> + <param index="2" name="max" type="Variant" /> <description> Clamps the [Variant] [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. [codeblock] @@ -192,9 +192,9 @@ </method> <method name="clampf"> <return type="float" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="min" type="float" /> - <argument index="2" name="max" type="float" /> + <param index="0" name="value" type="float" /> + <param index="1" name="min" type="float" /> + <param index="2" name="max" type="float" /> <description> Clamps the float [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. [codeblock] @@ -210,9 +210,9 @@ </method> <method name="clampi"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="min" type="int" /> - <argument index="2" name="max" type="int" /> + <param index="0" name="value" type="int" /> + <param index="1" name="min" type="int" /> + <param index="2" name="max" type="int" /> <description> Clamps the integer [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. [codeblock] @@ -228,7 +228,7 @@ </method> <method name="cos"> <return type="float" /> - <argument index="0" name="angle_rad" type="float" /> + <param index="0" name="angle_rad" type="float" /> <description> Returns the cosine of angle [code]angle_rad[/code] in radians. [codeblock] @@ -240,7 +240,7 @@ </method> <method name="cosh"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the hyperbolic cosine of [code]x[/code] in radians. [codeblock] @@ -251,25 +251,25 @@ </method> <method name="cubic_interpolate"> <return type="float" /> - <argument index="0" name="from" type="float" /> - <argument index="1" name="to" type="float" /> - <argument index="2" name="pre" type="float" /> - <argument index="3" name="post" type="float" /> - <argument index="4" name="weight" type="float" /> + <param index="0" name="from" type="float" /> + <param index="1" name="to" type="float" /> + <param index="2" name="pre" type="float" /> + <param index="3" name="post" type="float" /> + <param index="4" name="weight" type="float" /> <description> Cubic interpolates between two values by the factor defined in [code]weight[/code] with pre and post values. </description> </method> <method name="db2linear"> <return type="float" /> - <argument index="0" name="db" type="float" /> + <param index="0" name="db" type="float" /> <description> Converts from decibels to linear energy (audio). </description> </method> <method name="deg2rad"> <return type="float" /> - <argument index="0" name="deg" type="float" /> + <param index="0" name="deg" type="float" /> <description> Converts an angle expressed in degrees to radians. [codeblock] @@ -280,8 +280,8 @@ </method> <method name="ease"> <return type="float" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="curve" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="curve" type="float" /> <description> Returns an "eased" value of [code]x[/code] based on an easing function defined with [code]curve[/code]. This easing function is based on an exponent. The [code]curve[/code] can be any floating-point number, with specific values leading to the following behaviors: [codeblock] @@ -299,14 +299,14 @@ </method> <method name="error_string"> <return type="String" /> - <argument index="0" name="error" type="int" /> + <param index="0" name="error" type="int" /> <description> Returns a human-readable name for the given error code. </description> </method> <method name="exp"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> The natural exponential function. It raises the mathematical constant [b]e[/b] to the power of [code]x[/code] and returns it. [b]e[/b] has an approximate value of 2.71828, and can be obtained with [code]exp(1)[/code]. @@ -318,7 +318,7 @@ </method> <method name="floor"> <return type="Variant" /> - <argument index="0" name="x" type="Variant" /> + <param index="0" name="x" type="Variant" /> <description> Rounds [code]x[/code] downward (towards negative infinity), returning the largest whole number that is not more than [code]x[/code]. Supported types: [int], [float], [Vector2], [Vector3], [Vector4]. [codeblock] @@ -333,7 +333,7 @@ </method> <method name="floorf"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Rounds [code]x[/code] downward (towards negative infinity), returning the largest whole number that is not more than [code]x[/code]. A type-safe version of [method floor], specialzied in floats. @@ -341,7 +341,7 @@ </method> <method name="floori"> <return type="int" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Rounds [code]x[/code] downward (towards negative infinity), returning the largest whole number that is not more than [code]x[/code]. Equivalent of doing [code]int(x)[/code]. @@ -349,8 +349,8 @@ </method> <method name="fmod"> <return type="float" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> <description> Returns the floating-point remainder of [code]x/y[/code], keeping the sign of [code]x[/code]. [codeblock] @@ -362,8 +362,8 @@ </method> <method name="fposmod"> <return type="float" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> <description> Returns the floating-point modulus of [code]x/y[/code] that wraps equally in positive and negative. [codeblock] @@ -385,7 +385,7 @@ </method> <method name="hash"> <return type="int" /> - <argument index="0" name="variable" type="Variant" /> + <param index="0" name="variable" type="Variant" /> <description> Returns the integer hash of the variable passed. [codeblock] @@ -395,7 +395,7 @@ </method> <method name="instance_from_id"> <return type="Object" /> - <argument index="0" name="instance_id" type="int" /> + <param index="0" name="instance_id" type="int" /> <description> Returns the Object that corresponds to [code]instance_id[/code]. All Objects have a unique instance ID. [codeblock] @@ -409,9 +409,9 @@ </method> <method name="inverse_lerp"> <return type="float" /> - <argument index="0" name="from" type="float" /> - <argument index="1" name="to" type="float" /> - <argument index="2" name="weight" type="float" /> + <param index="0" name="from" type="float" /> + <param index="1" name="to" type="float" /> + <param index="2" name="weight" type="float" /> <description> Returns an interpolation or extrapolation factor considering the range specified in [code]from[/code] and [code]to[/code], and the interpolated value specified in [code]weight[/code]. The returned value will be between [code]0.0[/code] and [code]1.0[/code] if [code]weight[/code] is between [code]from[/code] and [code]to[/code] (inclusive). If [code]weight[/code] is located outside this range, then an extrapolation factor will be returned (return value lower than [code]0.0[/code] or greater than [code]1.0[/code]). Use [method clamp] on the result of [method inverse_lerp] if this is not desired. [codeblock] @@ -427,8 +427,8 @@ </method> <method name="is_equal_approx"> <return type="bool" /> - <argument index="0" name="a" type="float" /> - <argument index="1" name="b" type="float" /> + <param index="0" name="a" type="float" /> + <param index="1" name="b" type="float" /> <description> Returns [code]true[/code] if [code]a[/code] and [code]b[/code] are approximately equal to each other. Here, approximately equal means that [code]a[/code] and [code]b[/code] are within a small internal epsilon of each other, which scales with the magnitude of the numbers. @@ -437,35 +437,35 @@ </method> <method name="is_inf"> <return type="bool" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns whether [code]x[/code] is an infinity value (either positive infinity or negative infinity). </description> </method> <method name="is_instance_id_valid"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns [code]true[/code] if the Object that corresponds to [code]instance_id[/code] is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID. </description> </method> <method name="is_instance_valid"> <return type="bool" /> - <argument index="0" name="instance" type="Variant" /> + <param index="0" name="instance" type="Variant" /> <description> Returns whether [code]instance[/code] is a valid object (e.g. has not been deleted from memory). </description> </method> <method name="is_nan"> <return type="bool" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns whether [code]x[/code] is a NaN ("Not a Number" or invalid) value. </description> </method> <method name="is_zero_approx"> <return type="bool" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns [code]true[/code] if [code]x[/code] is zero or almost zero. This method is faster than using [method is_equal_approx] with one value as zero. @@ -473,9 +473,9 @@ </method> <method name="lerp"> <return type="Variant" /> - <argument index="0" name="from" type="Variant" /> - <argument index="1" name="to" type="Variant" /> - <argument index="2" name="weight" type="Variant" /> + <param index="0" name="from" type="Variant" /> + <param index="1" name="to" type="Variant" /> + <param index="2" name="weight" type="Variant" /> <description> Linearly interpolates between two values by the factor defined in [code]weight[/code]. To perform interpolation, [code]weight[/code] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. Use [method clamp] on the result of [method lerp] if this is not desired. Both [code]from[/code] and [code]to[/code] must have matching types. Supported types: [float], [Vector2], [Vector3], [Vector4], [Color], [Quaternion], [Basis]. @@ -488,9 +488,9 @@ </method> <method name="lerp_angle"> <return type="float" /> - <argument index="0" name="from" type="float" /> - <argument index="1" name="to" type="float" /> - <argument index="2" name="weight" type="float" /> + <param index="0" name="from" type="float" /> + <param index="1" name="to" type="float" /> + <param index="2" name="weight" type="float" /> <description> Linearly interpolates between two angles (in radians) by a normalized value. Similar to [method lerp], but interpolates correctly when the angles wrap around [constant @GDScript.TAU]. To perform eased interpolation with [method lerp_angle], combine it with [method ease] or [method smoothstep]. @@ -508,9 +508,9 @@ </method> <method name="lerpf"> <return type="float" /> - <argument index="0" name="from" type="float" /> - <argument index="1" name="to" type="float" /> - <argument index="2" name="weight" type="float" /> + <param index="0" name="from" type="float" /> + <param index="1" name="to" type="float" /> + <param index="2" name="weight" type="float" /> <description> Linearly interpolates between two values by the factor defined in [code]weight[/code]. To perform interpolation, [code]weight[/code] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. [codeblock] @@ -521,7 +521,7 @@ </method> <method name="linear2db"> <return type="float" /> - <argument index="0" name="lin" type="float" /> + <param index="0" name="lin" type="float" /> <description> Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear). Example: [codeblock] @@ -534,7 +534,7 @@ </method> <method name="log"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Natural logarithm. The amount of time needed to reach a certain level of continuous growth. [b]Note:[/b] This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. @@ -555,8 +555,8 @@ </method> <method name="maxf"> <return type="float" /> - <argument index="0" name="a" type="float" /> - <argument index="1" name="b" type="float" /> + <param index="0" name="a" type="float" /> + <param index="1" name="b" type="float" /> <description> Returns the maximum of two float values. [codeblock] @@ -567,8 +567,8 @@ </method> <method name="maxi"> <return type="int" /> - <argument index="0" name="a" type="int" /> - <argument index="1" name="b" type="int" /> + <param index="0" name="a" type="int" /> + <param index="1" name="b" type="int" /> <description> Returns the maximum of two int values. [codeblock] @@ -588,8 +588,8 @@ </method> <method name="minf"> <return type="float" /> - <argument index="0" name="a" type="float" /> - <argument index="1" name="b" type="float" /> + <param index="0" name="a" type="float" /> + <param index="1" name="b" type="float" /> <description> Returns the minimum of two float values. [codeblock] @@ -600,8 +600,8 @@ </method> <method name="mini"> <return type="int" /> - <argument index="0" name="a" type="int" /> - <argument index="1" name="b" type="int" /> + <param index="0" name="a" type="int" /> + <param index="1" name="b" type="int" /> <description> Returns the minimum of two int values. [codeblock] @@ -612,9 +612,9 @@ </method> <method name="move_toward"> <return type="float" /> - <argument index="0" name="from" type="float" /> - <argument index="1" name="to" type="float" /> - <argument index="2" name="delta" type="float" /> + <param index="0" name="from" type="float" /> + <param index="1" name="to" type="float" /> + <param index="2" name="delta" type="float" /> <description> Moves [code]from[/code] toward [code]to[/code] by the [code]delta[/code] value. Use a negative [code]delta[/code] value to move away. @@ -627,7 +627,7 @@ </method> <method name="nearest_po2"> <return type="int" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Returns the nearest equal or larger power of 2 for integer [code]value[/code]. In other words, returns the smallest value [code]a[/code] where [code]a = pow(2, n)[/code] such that [code]value <= a[/code] for some non-negative integer [code]n[/code]. @@ -644,8 +644,8 @@ </method> <method name="pingpong"> <return type="float" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="length" type="float" /> + <param index="0" name="value" type="float" /> + <param index="1" name="length" type="float" /> <description> Returns the [code]value[/code] wrapped between [code]0[/code] and the [code]length[/code]. If the limit is reached, the next value the function returned is decreased to the [code]0[/code] side or increased to the [code]length[/code] side (like a triangle wave). If [code]length[/code] is less than zero, it becomes positive. [codeblock] @@ -664,8 +664,8 @@ </method> <method name="posmod"> <return type="int" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> <description> Returns the integer modulus of [code]x/y[/code] that wraps equally in positive and negative. [codeblock] @@ -686,8 +686,8 @@ </method> <method name="pow"> <return type="float" /> - <argument index="0" name="base" type="float" /> - <argument index="1" name="exp" type="float" /> + <param index="0" name="base" type="float" /> + <param index="1" name="exp" type="float" /> <description> Returns the result of [code]base[/code] raised to the power of [code]exp[/code]. [codeblock] @@ -774,7 +774,7 @@ </method> <method name="rad2deg"> <return type="float" /> - <argument index="0" name="rad" type="float" /> + <param index="0" name="rad" type="float" /> <description> Converts an angle expressed in radians to degrees. [codeblock] @@ -784,7 +784,7 @@ </method> <method name="rand_from_seed"> <return type="PackedInt64Array" /> - <argument index="0" name="seed" type="int" /> + <param index="0" name="seed" type="int" /> <description> Random from seed: pass a [code]seed[/code], and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits. </description> @@ -800,8 +800,8 @@ </method> <method name="randf_range"> <return type="float" /> - <argument index="0" name="from" type="float" /> - <argument index="1" name="to" type="float" /> + <param index="0" name="from" type="float" /> + <param index="1" name="to" type="float" /> <description> Returns a random floating point value on the interval between [code]from[/code] and [code]to[/code] (inclusive). [codeblock] @@ -811,8 +811,8 @@ </method> <method name="randfn"> <return type="float" /> - <argument index="0" name="mean" type="float" /> - <argument index="1" name="deviation" type="float" /> + <param index="0" name="mean" type="float" /> + <param index="1" name="deviation" type="float" /> <description> Returns a normally-distributed pseudo-random floating point value using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. This is also called Gaussian distribution. </description> @@ -831,8 +831,8 @@ </method> <method name="randi_range"> <return type="int" /> - <argument index="0" name="from" type="int" /> - <argument index="1" name="to" type="int" /> + <param index="0" name="from" type="int" /> + <param index="1" name="to" type="int" /> <description> Returns a random signed 32-bit integer between [code]from[/code] and [code]to[/code] (inclusive). If [code]to[/code] is lesser than [code]from[/code], they are swapped. [codeblock] @@ -849,11 +849,11 @@ </method> <method name="range_lerp"> <return type="float" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="istart" type="float" /> - <argument index="2" name="istop" type="float" /> - <argument index="3" name="ostart" type="float" /> - <argument index="4" name="ostop" type="float" /> + <param index="0" name="value" type="float" /> + <param index="1" name="istart" type="float" /> + <param index="2" name="istop" type="float" /> + <param index="3" name="ostart" type="float" /> + <param index="4" name="ostop" type="float" /> <description> Maps a [code]value[/code] from range [code][istart, istop][/code] to [code][ostart, ostop][/code]. See also [method lerp] and [method inverse_lerp]. If [code]value[/code] is outside [code][istart, istop][/code], then the resulting value will also be outside [code][ostart, ostop][/code]. Use [method clamp] on the result of [method range_lerp] if this is not desired. [codeblock] @@ -870,14 +870,14 @@ </method> <method name="rid_from_int64"> <return type="RID" /> - <argument index="0" name="base" type="int" /> + <param index="0" name="base" type="int" /> <description> Create a RID from an int64. This is used mainly from native extensions to build servers. </description> </method> <method name="round"> <return type="Variant" /> - <argument index="0" name="x" type="Variant" /> + <param index="0" name="x" type="Variant" /> <description> Rounds [code]x[/code] to the nearest whole number, with halfway cases rounded away from zero. Supported types: [int], [float], [Vector2], [Vector3], [Vector4]. [codeblock] @@ -891,7 +891,7 @@ </method> <method name="roundf"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Rounds [code]x[/code] to the nearest whole number, with halfway cases rounded away from zero. A type-safe version of [method round], specialzied in floats. @@ -899,14 +899,14 @@ </method> <method name="roundi"> <return type="int" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Rounds [code]x[/code] to the nearest whole number, with halfway cases rounded away from zero. A type-safe version of [method round] that returns integer. </description> </method> <method name="seed"> - <argument index="0" name="base" type="int" /> + <param index="0" name="base" type="int" /> <description> Sets seed for the random number generator. [codeblock] @@ -917,7 +917,7 @@ </method> <method name="sign"> <return type="Variant" /> - <argument index="0" name="x" type="Variant" /> + <param index="0" name="x" type="Variant" /> <description> Returns the sign of [code]x[/code] as same type of [Variant] as [code]x[/code] with each component being -1, 0 and 1 for each negative, zero and positive values respectivelu. Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. [codeblock] @@ -931,7 +931,7 @@ </method> <method name="signf"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the sign of [code]x[/code] as a float: -1.0 or 1.0. Returns 0.0 if [code]x[/code] is 0. [codeblock] @@ -943,7 +943,7 @@ </method> <method name="signi"> <return type="int" /> - <argument index="0" name="x" type="int" /> + <param index="0" name="x" type="int" /> <description> Returns the sign of [code]x[/code] as an integer: -1 or 1. Returns 0 if [code]x[/code] is 0. [codeblock] @@ -955,7 +955,7 @@ </method> <method name="sin"> <return type="float" /> - <argument index="0" name="angle_rad" type="float" /> + <param index="0" name="angle_rad" type="float" /> <description> Returns the sine of angle [code]angle_rad[/code] in radians. [codeblock] @@ -966,7 +966,7 @@ </method> <method name="sinh"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the hyperbolic sine of [code]x[/code]. [codeblock] @@ -977,9 +977,9 @@ </method> <method name="smoothstep"> <return type="float" /> - <argument index="0" name="from" type="float" /> - <argument index="1" name="to" type="float" /> - <argument index="2" name="x" type="float" /> + <param index="0" name="from" type="float" /> + <param index="1" name="to" type="float" /> + <param index="2" name="x" type="float" /> <description> Returns the result of smoothly interpolating the value of [code]x[/code] between [code]0[/code] and [code]1[/code], based on the where [code]x[/code] lies with respect to the edges [code]from[/code] and [code]to[/code]. The return value is [code]0[/code] if [code]x <= from[/code], and [code]1[/code] if [code]x >= to[/code]. If [code]x[/code] lies between [code]from[/code] and [code]to[/code], the returned value follows an S-shaped curve that maps [code]x[/code] between [code]0[/code] and [code]1[/code]. @@ -996,8 +996,8 @@ </method> <method name="snapped"> <return type="float" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="step" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="step" type="float" /> <description> Snaps float value [code]x[/code] to a given [code]step[/code]. This can also be used to round a floating point number to an arbitrary number of decimals. [codeblock] @@ -1009,7 +1009,7 @@ </method> <method name="sqrt"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the square root of [code]x[/code], where [code]x[/code] is a non-negative number. [codeblock] @@ -1020,7 +1020,7 @@ </method> <method name="step_decimals"> <return type="int" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the position of the first non-zero digit, after the decimal point. Note that the maximum return value is 10, which is a design decision in the implementation. [codeblock] @@ -1041,7 +1041,7 @@ </method> <method name="str2var"> <return type="Variant" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Converts a formatted string that was returned by [method var2str] to the original value. [codeblock] @@ -1053,7 +1053,7 @@ </method> <method name="tan"> <return type="float" /> - <argument index="0" name="angle_rad" type="float" /> + <param index="0" name="angle_rad" type="float" /> <description> Returns the tangent of angle [code]angle_rad[/code] in radians. [codeblock] @@ -1063,7 +1063,7 @@ </method> <method name="tanh"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the hyperbolic tangent of [code]x[/code]. [codeblock] @@ -1074,7 +1074,7 @@ </method> <method name="typeof"> <return type="int" /> - <argument index="0" name="variable" type="Variant" /> + <param index="0" name="variable" type="Variant" /> <description> Returns the internal type of the given Variant object, using the [enum Variant.Type] values. [codeblock] @@ -1090,7 +1090,7 @@ </method> <method name="var2bytes"> <return type="PackedByteArray" /> - <argument index="0" name="variable" type="Variant" /> + <param index="0" name="variable" type="Variant" /> <description> Encodes a [Variant] value to a byte array, without encoding objects. Deserialization can be done with [method bytes2var]. [b]Note:[/b] If you need object serialization, see [method var2bytes_with_objects]. @@ -1098,14 +1098,14 @@ </method> <method name="var2bytes_with_objects"> <return type="PackedByteArray" /> - <argument index="0" name="variable" type="Variant" /> + <param index="0" name="variable" type="Variant" /> <description> Encodes a [Variant] value to a byte array. Encoding objects is allowed (and can potentially include code). Deserialization can be done with [method bytes2var_with_objects]. </description> </method> <method name="var2str"> <return type="String" /> - <argument index="0" name="variable" type="Variant" /> + <param index="0" name="variable" type="Variant" /> <description> Converts a Variant [code]variable[/code] to a formatted string that can later be parsed using [method str2var]. [codeblock] @@ -1123,7 +1123,7 @@ </method> <method name="weakref"> <return type="Variant" /> - <argument index="0" name="obj" type="Variant" /> + <param index="0" name="obj" type="Variant" /> <description> Returns a weak reference to an object, or [code]null[/code] if the argument is invalid. A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. @@ -1131,9 +1131,9 @@ </method> <method name="wrap"> <return type="Variant" /> - <argument index="0" name="value" type="Variant" /> - <argument index="1" name="min" type="Variant" /> - <argument index="2" name="max" type="Variant" /> + <param index="0" name="value" type="Variant" /> + <param index="1" name="min" type="Variant" /> + <param index="2" name="max" type="Variant" /> <description> Wraps the [Variant] [code]value[/code] between [code]min[/code] and [code]max[/code]. Usable for creating loop-alike behavior or infinite surfaces. @@ -1152,9 +1152,9 @@ </method> <method name="wrapf"> <return type="float" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="min" type="float" /> - <argument index="2" name="max" type="float" /> + <param index="0" name="value" type="float" /> + <param index="1" name="min" type="float" /> + <param index="2" name="max" type="float" /> <description> Wraps float [code]value[/code] between [code]min[/code] and [code]max[/code]. Usable for creating loop-alike behavior or infinite surfaces. @@ -1176,9 +1176,9 @@ </method> <method name="wrapi"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="min" type="int" /> - <argument index="2" name="max" type="int" /> + <param index="0" name="value" type="int" /> + <param index="1" name="min" type="int" /> + <param index="2" name="max" type="int" /> <description> Wraps integer [code]value[/code] between [code]min[/code] and [code]max[/code]. Usable for creating loop-alike behavior or infinite surfaces. diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index db880efaf2..86f0487ea9 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -23,15 +23,15 @@ </constructor> <constructor name="AABB"> <return type="AABB" /> - <argument index="0" name="from" type="AABB" /> + <param index="0" name="from" type="AABB" /> <description> Constructs an [AABB] as a copy of the given [AABB]. </description> </constructor> <constructor name="AABB"> <return type="AABB" /> - <argument index="0" name="position" type="Vector3" /> - <argument index="1" name="size" type="Vector3" /> + <param index="0" name="position" type="Vector3" /> + <param index="1" name="size" type="Vector3" /> <description> Constructs an [AABB] from a position and size. </description> @@ -46,14 +46,14 @@ </method> <method name="encloses" qualifiers="const"> <return type="bool" /> - <argument index="0" name="with" type="AABB" /> + <param index="0" name="with" type="AABB" /> <description> Returns [code]true[/code] if this [AABB] completely encloses another one. </description> </method> <method name="expand" qualifiers="const"> <return type="AABB" /> - <argument index="0" name="to_point" type="Vector3" /> + <param index="0" name="to_point" type="Vector3" /> <description> Returns a copy of this [AABB] expanded to include a given point. [b]Example:[/b] @@ -81,7 +81,7 @@ </method> <method name="get_endpoint" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Gets the position of the 8 endpoints of the [AABB] in space. </description> @@ -124,7 +124,7 @@ </method> <method name="get_support" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="dir" type="Vector3" /> + <param index="0" name="dir" type="Vector3" /> <description> Returns the support point in a given direction. This is useful for collision detection algorithms. </description> @@ -137,7 +137,7 @@ </method> <method name="grow" qualifiers="const"> <return type="AABB" /> - <argument index="0" name="by" type="float" /> + <param index="0" name="by" type="float" /> <description> Returns a copy of the [AABB] grown a given amount of units towards all the sides. </description> @@ -156,7 +156,7 @@ </method> <method name="has_point" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point" type="Vector3" /> + <param index="0" name="point" type="Vector3" /> <description> Returns [code]true[/code] if the [AABB] contains a point. Points on the faces of the AABB are considered included, though float-point precision errors may impact the accuracy of such checks. [b]Note:[/b] This method is not reliable for [AABB] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent [AABB] to check for contained points. @@ -164,50 +164,50 @@ </method> <method name="intersection" qualifiers="const"> <return type="AABB" /> - <argument index="0" name="with" type="AABB" /> + <param index="0" name="with" type="AABB" /> <description> Returns the intersection between two [AABB]. An empty AABB (size [code](0, 0, 0)[/code]) is returned on failure. </description> </method> <method name="intersects" qualifiers="const"> <return type="bool" /> - <argument index="0" name="with" type="AABB" /> + <param index="0" name="with" type="AABB" /> <description> Returns [code]true[/code] if the [AABB] overlaps with another. </description> </method> <method name="intersects_plane" qualifiers="const"> <return type="bool" /> - <argument index="0" name="plane" type="Plane" /> + <param index="0" name="plane" type="Plane" /> <description> Returns [code]true[/code] if the [AABB] is on both sides of a plane. </description> </method> <method name="intersects_ray" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="dir" type="Vector3" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="dir" type="Vector3" /> <description> </description> </method> <method name="intersects_segment" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> <description> Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code]. </description> </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="aabb" type="AABB" /> + <param index="0" name="aabb" type="AABB" /> <description> Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GlobalScope.is_equal_approx] on each component. </description> </method> <method name="merge" qualifiers="const"> <return type="AABB" /> - <argument index="0" name="with" type="AABB" /> + <param index="0" name="with" type="AABB" /> <description> Returns a larger [AABB] that contains both this [AABB] and [code]with[/code]. </description> @@ -228,7 +228,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="AABB" /> + <param index="0" name="right" type="AABB" /> <description> Returns [code]true[/code] if the vectors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -236,14 +236,14 @@ </operator> <operator name="operator *"> <return type="AABB" /> - <argument index="0" name="right" type="Transform3D" /> + <param index="0" name="right" type="Transform3D" /> <description> Inversely transforms (multiplies) the [AABB] by the given [Transform3D] transformation matrix. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="AABB" /> + <param index="0" name="right" type="AABB" /> <description> Returns [code]true[/code] if the AABBs are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/AESContext.xml b/doc/classes/AESContext.xml index 82634f8859..fe67f7de54 100644 --- a/doc/classes/AESContext.xml +++ b/doc/classes/AESContext.xml @@ -94,16 +94,16 @@ </method> <method name="start"> <return type="int" enum="Error" /> - <argument index="0" name="mode" type="int" enum="AESContext.Mode" /> - <argument index="1" name="key" type="PackedByteArray" /> - <argument index="2" name="iv" type="PackedByteArray" default="PackedByteArray()" /> + <param index="0" name="mode" type="int" enum="AESContext.Mode" /> + <param index="1" name="key" type="PackedByteArray" /> + <param index="2" name="iv" type="PackedByteArray" default="PackedByteArray()" /> <description> Start the AES context in the given [code]mode[/code]. A [code]key[/code] of either 16 or 32 bytes must always be provided, while an [code]iv[/code] (initialization vector) of exactly 16 bytes, is only needed when [code]mode[/code] is either [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT]. </description> </method> <method name="update"> <return type="PackedByteArray" /> - <argument index="0" name="src" type="PackedByteArray" /> + <param index="0" name="src" type="PackedByteArray" /> <description> Run the desired operation for this AES context. Will return a [PackedByteArray] containing the result of encrypting (or decrypting) the given [code]src[/code]. See [method start] for mode of operation. [b]Note:[/b] The size of [code]src[/code] must be a multiple of 16. Apply some padding if needed. diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index c05fb885b9..eed0dd8688 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -11,8 +11,8 @@ <methods> <method name="_compute_cost" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="from_id" type="int" /> - <argument index="1" name="to_id" type="int" /> + <param index="0" name="from_id" type="int" /> + <param index="1" name="to_id" type="int" /> <description> Called when computing the cost between two connected points. Note that this function is hidden in the default [code]AStar2D[/code] class. @@ -20,8 +20,8 @@ </method> <method name="_estimate_cost" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="from_id" type="int" /> - <argument index="1" name="to_id" type="int" /> + <param index="0" name="from_id" type="int" /> + <param index="1" name="to_id" type="int" /> <description> Called when estimating the cost between a point and the path's ending point. Note that this function is hidden in the default [code]AStar2D[/code] class. @@ -29,9 +29,9 @@ </method> <method name="add_point"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="position" type="Vector2" /> - <argument index="2" name="weight_scale" type="float" default="1.0" /> + <param index="0" name="id" type="int" /> + <param index="1" name="position" type="Vector2" /> + <param index="2" name="weight_scale" type="float" default="1.0" /> <description> Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 0.0 or greater. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. @@ -50,9 +50,9 @@ </method> <method name="are_points_connected" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="to_id" type="int" /> - <argument index="2" name="bidirectional" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="to_id" type="int" /> + <param index="2" name="bidirectional" type="bool" default="true" /> <description> Returns whether there is a connection/segment between the given points. If [code]bidirectional[/code] is [code]false[/code], returns whether movement from [code]id[/code] to [code]to_id[/code] is possible through this segment. </description> @@ -65,9 +65,9 @@ </method> <method name="connect_points"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="to_id" type="int" /> - <argument index="2" name="bidirectional" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="to_id" type="int" /> + <param index="2" name="bidirectional" type="bool" default="true" /> <description> Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction. [codeblocks] @@ -88,9 +88,9 @@ </method> <method name="disconnect_points"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="to_id" type="int" /> - <argument index="2" name="bidirectional" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="to_id" type="int" /> + <param index="2" name="bidirectional" type="bool" default="true" /> <description> Deletes the segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is prevented, and a unidirectional segment possibly remains. </description> @@ -103,8 +103,8 @@ </method> <method name="get_closest_point" qualifiers="const"> <return type="int" /> - <argument index="0" name="to_position" type="Vector2" /> - <argument index="1" name="include_disabled" type="bool" default="false" /> + <param index="0" name="to_position" type="Vector2" /> + <param index="1" name="include_disabled" type="bool" default="false" /> <description> Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool. [b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result. @@ -112,7 +112,7 @@ </method> <method name="get_closest_position_in_segment" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="to_position" type="Vector2" /> + <param index="0" name="to_position" type="Vector2" /> <description> Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblocks] @@ -136,8 +136,8 @@ </method> <method name="get_id_path"> <return type="PackedInt64Array" /> - <argument index="0" name="from_id" type="int" /> - <argument index="1" name="to_id" type="int" /> + <param index="0" name="from_id" type="int" /> + <param index="1" name="to_id" type="int" /> <description> Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. [codeblocks] @@ -180,7 +180,7 @@ </method> <method name="get_point_connections"> <return type="PackedInt64Array" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns an array with the IDs of the points that form the connection with the given point. [codeblocks] @@ -225,8 +225,8 @@ </method> <method name="get_point_path"> <return type="PackedVector2Array" /> - <argument index="0" name="from_id" type="int" /> - <argument index="1" name="to_id" type="int" /> + <param index="0" name="from_id" type="int" /> + <param index="1" name="to_id" type="int" /> <description> Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector2Array] and will print an error message. @@ -234,66 +234,66 @@ </method> <method name="get_point_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the position of the point associated with the given [code]id[/code]. </description> </method> <method name="get_point_weight_scale" qualifiers="const"> <return type="float" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the weight scale of the point associated with the given [code]id[/code]. </description> </method> <method name="has_point" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns whether a point associated with the given [code]id[/code] exists. </description> </method> <method name="is_point_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. </description> </method> <method name="remove_point"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> <method name="reserve_space"> <return type="void" /> - <argument index="0" name="num_nodes" type="int" /> + <param index="0" name="num_nodes" type="int" /> <description> Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. </description> </method> <method name="set_point_disabled"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="disabled" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="disabled" type="bool" default="true" /> <description> Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. </description> </method> <method name="set_point_position"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="id" type="int" /> + <param index="1" name="position" type="Vector2" /> <description> Sets the [code]position[/code] for the point with the given [code]id[/code]. </description> </method> <method name="set_point_weight_scale"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="weight_scale" type="float" /> + <param index="0" name="id" type="int" /> + <param index="1" name="weight_scale" type="float" /> <description> Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. </description> diff --git a/doc/classes/AStar3D.xml b/doc/classes/AStar3D.xml index ea4e49c173..dc8c62054b 100644 --- a/doc/classes/AStar3D.xml +++ b/doc/classes/AStar3D.xml @@ -40,8 +40,8 @@ <methods> <method name="_compute_cost" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="from_id" type="int" /> - <argument index="1" name="to_id" type="int" /> + <param index="0" name="from_id" type="int" /> + <param index="1" name="to_id" type="int" /> <description> Called when computing the cost between two connected points. Note that this function is hidden in the default [code]AStar3D[/code] class. @@ -49,8 +49,8 @@ </method> <method name="_estimate_cost" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="from_id" type="int" /> - <argument index="1" name="to_id" type="int" /> + <param index="0" name="from_id" type="int" /> + <param index="1" name="to_id" type="int" /> <description> Called when estimating the cost between a point and the path's ending point. Note that this function is hidden in the default [code]AStar3D[/code] class. @@ -58,9 +58,9 @@ </method> <method name="add_point"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="position" type="Vector3" /> - <argument index="2" name="weight_scale" type="float" default="1.0" /> + <param index="0" name="id" type="int" /> + <param index="1" name="position" type="Vector3" /> + <param index="2" name="weight_scale" type="float" default="1.0" /> <description> Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 0.0 or greater. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. @@ -79,9 +79,9 @@ </method> <method name="are_points_connected" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="to_id" type="int" /> - <argument index="2" name="bidirectional" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="to_id" type="int" /> + <param index="2" name="bidirectional" type="bool" default="true" /> <description> Returns whether the two given points are directly connected by a segment. If [code]bidirectional[/code] is [code]false[/code], returns whether movement from [code]id[/code] to [code]to_id[/code] is possible through this segment. </description> @@ -94,9 +94,9 @@ </method> <method name="connect_points"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="to_id" type="int" /> - <argument index="2" name="bidirectional" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="to_id" type="int" /> + <param index="2" name="bidirectional" type="bool" default="true" /> <description> Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction. [codeblocks] @@ -117,9 +117,9 @@ </method> <method name="disconnect_points"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="to_id" type="int" /> - <argument index="2" name="bidirectional" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="to_id" type="int" /> + <param index="2" name="bidirectional" type="bool" default="true" /> <description> Deletes the segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is prevented, and a unidirectional segment possibly remains. </description> @@ -132,8 +132,8 @@ </method> <method name="get_closest_point" qualifiers="const"> <return type="int" /> - <argument index="0" name="to_position" type="Vector3" /> - <argument index="1" name="include_disabled" type="bool" default="false" /> + <param index="0" name="to_position" type="Vector3" /> + <param index="1" name="include_disabled" type="bool" default="false" /> <description> Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool. [b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result. @@ -141,7 +141,7 @@ </method> <method name="get_closest_position_in_segment" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="to_position" type="Vector3" /> + <param index="0" name="to_position" type="Vector3" /> <description> Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblocks] @@ -165,8 +165,8 @@ </method> <method name="get_id_path"> <return type="PackedInt64Array" /> - <argument index="0" name="from_id" type="int" /> - <argument index="1" name="to_id" type="int" /> + <param index="0" name="from_id" type="int" /> + <param index="1" name="to_id" type="int" /> <description> Returns an array with the IDs of the points that form the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. [codeblocks] @@ -208,7 +208,7 @@ </method> <method name="get_point_connections"> <return type="PackedInt64Array" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns an array with the IDs of the points that form the connection with the given point. [codeblocks] @@ -252,8 +252,8 @@ </method> <method name="get_point_path"> <return type="PackedVector3Array" /> - <argument index="0" name="from_id" type="int" /> - <argument index="1" name="to_id" type="int" /> + <param index="0" name="from_id" type="int" /> + <param index="1" name="to_id" type="int" /> <description> Returns an array with the points that are in the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector3Array] and will print an error message. @@ -261,66 +261,66 @@ </method> <method name="get_point_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the position of the point associated with the given [code]id[/code]. </description> </method> <method name="get_point_weight_scale" qualifiers="const"> <return type="float" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the weight scale of the point associated with the given [code]id[/code]. </description> </method> <method name="has_point" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns whether a point associated with the given [code]id[/code] exists. </description> </method> <method name="is_point_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. </description> </method> <method name="remove_point"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> <method name="reserve_space"> <return type="void" /> - <argument index="0" name="num_nodes" type="int" /> + <param index="0" name="num_nodes" type="int" /> <description> Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. </description> </method> <method name="set_point_disabled"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="disabled" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="disabled" type="bool" default="true" /> <description> Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. </description> </method> <method name="set_point_position"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="id" type="int" /> + <param index="1" name="position" type="Vector3" /> <description> Sets the [code]position[/code] for the point with the given [code]id[/code]. </description> </method> <method name="set_point_weight_scale"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="weight_scale" type="float" /> + <param index="0" name="id" type="int" /> + <param index="1" name="weight_scale" type="float" /> <description> Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. </description> diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 0009c82548..3dde8664de 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -11,9 +11,9 @@ <methods> <method name="add_button"> <return type="Button" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="right" type="bool" default="false" /> - <argument index="2" name="action" type="String" default="""" /> + <param index="0" name="text" type="String" /> + <param index="1" name="right" type="bool" default="false" /> + <param index="2" name="action" type="String" default="""" /> <description> Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed. If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons. @@ -22,7 +22,7 @@ </method> <method name="add_cancel_button"> <return type="Button" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button. You can use [method remove_button] method to remove a button created with this method from the dialog. @@ -44,14 +44,14 @@ </method> <method name="register_text_enter"> <return type="void" /> - <argument index="0" name="line_edit" type="Control" /> + <param index="0" name="line_edit" type="Control" /> <description> Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. </description> </method> <method name="remove_button"> <return type="void" /> - <argument index="0" name="button" type="Control" /> + <param index="0" name="button" type="Control" /> <description> Removes the [code]button[/code] from the dialog. Does NOT free the [code]button[/code]. The [code]button[/code] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [code]button[/code] will no longer emit this dialog's [signal custom_action] or [signal cancelled] signals. </description> @@ -92,7 +92,7 @@ </description> </signal> <signal name="custom_action"> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Emitted when a custom button is pressed. See [method add_button]. </description> diff --git a/doc/classes/AnimatedSprite2D.xml b/doc/classes/AnimatedSprite2D.xml index 638d142791..39527664ed 100644 --- a/doc/classes/AnimatedSprite2D.xml +++ b/doc/classes/AnimatedSprite2D.xml @@ -14,8 +14,8 @@ <methods> <method name="play"> <return type="void" /> - <argument index="0" name="anim" type="StringName" default="&""" /> - <argument index="1" name="backwards" type="bool" default="false" /> + <param index="0" name="anim" type="StringName" default="&""" /> + <param index="1" name="backwards" type="bool" default="false" /> <description> Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. If [code]backwards[/code] is [code]true[/code], the animation will be played in reverse. </description> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 30ea2249a3..aa56e50886 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -18,7 +18,7 @@ </method> <method name="play"> <return type="void" /> - <argument index="0" name="anim" type="StringName" default="&""" /> + <param index="0" name="anim" type="StringName" default="&""" /> <description> Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. </description> diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml index c322db9c37..5ad4c4e10a 100644 --- a/doc/classes/AnimatedTexture.xml +++ b/doc/classes/AnimatedTexture.xml @@ -14,22 +14,22 @@ <methods> <method name="get_frame_delay" qualifiers="const"> <return type="float" /> - <argument index="0" name="frame" type="int" /> + <param index="0" name="frame" type="int" /> <description> Returns the given frame's delay value. </description> </method> <method name="get_frame_texture" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="frame" type="int" /> + <param index="0" name="frame" type="int" /> <description> Returns the given frame's [Texture2D]. </description> </method> <method name="set_frame_delay"> <return type="void" /> - <argument index="0" name="frame" type="int" /> - <argument index="1" name="delay" type="float" /> + <param index="0" name="frame" type="int" /> + <param index="1" name="delay" type="float" /> <description> Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by [member fps]. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be [code]1.0 / fps + delay[/code]. For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be: @@ -43,8 +43,8 @@ </method> <method name="set_frame_texture"> <return type="void" /> - <argument index="0" name="frame" type="int" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="frame" type="int" /> + <param index="1" name="texture" type="Texture2D" /> <description> Assigns a [Texture2D] to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID [member frames] - 1. You can define any number of textures up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to [member frames] - 1 will be part of the animation. diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index f40f11944d..5186cb2ea1 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -33,42 +33,42 @@ <methods> <method name="add_track"> <return type="int" /> - <argument index="0" name="type" type="int" enum="Animation.TrackType" /> - <argument index="1" name="at_position" type="int" default="-1" /> + <param index="0" name="type" type="int" enum="Animation.TrackType" /> + <param index="1" name="at_position" type="int" default="-1" /> <description> Adds a track to the Animation. </description> </method> <method name="animation_track_get_key_animation" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the animation name at the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Animation Track. </description> </method> <method name="animation_track_insert_key"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="animation" type="StringName" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="animation" type="StringName" /> <description> Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track. </description> </method> <method name="animation_track_set_key_animation"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="animation" type="StringName" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="animation" type="StringName" /> <description> Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track. </description> </method> <method name="audio_track_get_key_end_offset" qualifiers="const"> <return type="float" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the end offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. End offset is the number of seconds cut off at the ending of the audio stream. @@ -76,8 +76,8 @@ </method> <method name="audio_track_get_key_start_offset" qualifiers="const"> <return type="float" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the start offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Start offset is the number of seconds cut off at the beginning of the audio stream. @@ -85,19 +85,19 @@ </method> <method name="audio_track_get_key_stream" qualifiers="const"> <return type="Resource" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the audio stream of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. </description> </method> <method name="audio_track_insert_key"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="stream" type="Resource" /> - <argument index="3" name="start_offset" type="float" default="0" /> - <argument index="4" name="end_offset" type="float" default="0" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="stream" type="Resource" /> + <param index="3" name="start_offset" type="float" default="0" /> + <param index="4" name="end_offset" type="float" default="0" /> <description> Inserts an Audio Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of an Audio Track. [code]stream[/code] is the [AudioStream] resource to play. [code]start_offset[/code] is the number of seconds cut off at the beginning of the audio stream, while [code]end_offset[/code] is at the ending. @@ -105,71 +105,71 @@ </method> <method name="audio_track_set_key_end_offset"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="offset" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="offset" type="float" /> <description> Sets the end offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. </description> </method> <method name="audio_track_set_key_start_offset"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="offset" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="offset" type="float" /> <description> Sets the start offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. </description> </method> <method name="audio_track_set_key_stream"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="stream" type="Resource" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="stream" type="Resource" /> <description> Sets the stream of the key identified by [code]key_idx[/code] to value [code]stream[/code]. The [code]track_idx[/code] must be the index of an Audio Track. </description> </method> <method name="bezier_track_get_key_handle_mode" qualifiers="const"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the handle mode of the key identified by [code]index[/code]. See [enum HandleMode] for possible values. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="bezier_track_get_key_in_handle" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the in handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="bezier_track_get_key_out_handle" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the out handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="bezier_track_get_key_value" qualifiers="const"> <return type="float" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the value of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="bezier_track_insert_key"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="value" type="float" /> - <argument index="3" name="in_handle" type="Vector2" default="Vector2(0, 0)" /> - <argument index="4" name="out_handle" type="Vector2" default="Vector2(0, 0)" /> - <argument index="5" name="handle_mode" type="int" enum="Animation.HandleMode" default="1" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="value" type="float" /> + <param index="3" name="in_handle" type="Vector2" default="Vector2(0, 0)" /> + <param index="4" name="out_handle" type="Vector2" default="Vector2(0, 0)" /> + <param index="5" name="handle_mode" type="int" enum="Animation.HandleMode" default="1" /> <description> Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track. [code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point. @@ -177,56 +177,56 @@ </method> <method name="bezier_track_interpolate" qualifiers="const"> <return type="float" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> <description> Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="bezier_track_set_key_handle_mode"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="key_handle_mode" type="int" enum="Animation.HandleMode" /> - <argument index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="key_handle_mode" type="int" enum="Animation.HandleMode" /> + <param index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> <description> Changes the handle mode of the keyframe at the given [code]index[/code]. See [enum HandleMode] for possible values. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="bezier_track_set_key_in_handle"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="in_handle" type="Vector2" /> - <argument index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="in_handle" type="Vector2" /> + <param index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> <description> Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="bezier_track_set_key_out_handle"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="out_handle" type="Vector2" /> - <argument index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="out_handle" type="Vector2" /> + <param index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> <description> Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="bezier_track_set_key_value"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="value" type="float" /> <description> Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> <method name="blend_shape_track_insert_key"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="amount" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="amount" type="float" /> <description> </description> </method> @@ -238,24 +238,24 @@ </method> <method name="compress"> <return type="void" /> - <argument index="0" name="page_size" type="int" default="8192" /> - <argument index="1" name="fps" type="int" default="120" /> - <argument index="2" name="split_tolerance" type="float" default="4.0" /> + <param index="0" name="page_size" type="int" default="8192" /> + <param index="1" name="fps" type="int" default="120" /> + <param index="2" name="split_tolerance" type="float" default="4.0" /> <description> </description> </method> <method name="copy_track"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="to_animation" type="Animation" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="to_animation" type="Animation" /> <description> Adds a new track that is a copy of the given track from [code]to_animation[/code]. </description> </method> <method name="find_track" qualifiers="const"> <return type="int" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="type" type="int" enum="Animation.TrackType" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="type" type="int" enum="Animation.TrackType" /> <description> Returns the index of the specified track. If the track is not found, return -1. </description> @@ -268,259 +268,259 @@ </method> <method name="method_track_get_key_indices" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time_sec" type="float" /> - <argument index="2" name="delta" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time_sec" type="float" /> + <param index="2" name="delta" type="float" /> <description> Returns all the key indices of a method track, given a position and delta time. </description> </method> <method name="method_track_get_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the method name of a method track. </description> </method> <method name="method_track_get_params" qualifiers="const"> <return type="Array" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the arguments values to be called on a method track for a given key in a given track. </description> </method> <method name="position_track_insert_key"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="position" type="Vector3" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="position" type="Vector3" /> <description> </description> </method> <method name="remove_track"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Removes a track by specifying the track index. </description> </method> <method name="rotation_track_insert_key"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="rotation" type="Quaternion" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="rotation" type="Quaternion" /> <description> </description> </method> <method name="scale_track_insert_key"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="scale" type="Vector3" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="scale" type="Vector3" /> <description> </description> </method> <method name="track_find_key" qualifiers="const"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="exact" type="bool" default="false" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="exact" type="bool" default="false" /> <description> Finds the key index by time in a given track. Optionally, only find it if the exact time is given. </description> </method> <method name="track_get_interpolation_loop_wrap" qualifiers="const"> <return type="bool" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. New tracks wrap the interpolation loop by default. </description> </method> <method name="track_get_interpolation_type" qualifiers="const"> <return type="int" enum="Animation.InterpolationType" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Returns the interpolation type of a given track. </description> </method> <method name="track_get_key_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Returns the amount of keys in a given track. </description> </method> <method name="track_get_key_time" qualifiers="const"> <return type="float" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the time at which the key is located. </description> </method> <method name="track_get_key_transition" qualifiers="const"> <return type="float" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]). </description> </method> <method name="track_get_key_value" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Returns the value of a given key in a given track. </description> </method> <method name="track_get_path" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Gets the path of a track. For more information on the path format, see [method track_set_path]. </description> </method> <method name="track_get_type" qualifiers="const"> <return type="int" enum="Animation.TrackType" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Gets the type of a track. </description> </method> <method name="track_insert_key"> <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="key" type="Variant" /> - <argument index="3" name="transition" type="float" default="1" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="key" type="Variant" /> + <param index="3" name="transition" type="float" default="1" /> <description> Inserts a generic key in a given track. Returns the key index. </description> </method> <method name="track_is_compressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> </description> </method> <method name="track_is_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Returns [code]true[/code] if the track at index [code]idx[/code] is enabled. </description> </method> <method name="track_is_imported" qualifiers="const"> <return type="bool" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code]. </description> </method> <method name="track_move_down"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Moves a track down. </description> </method> <method name="track_move_to"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="to_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="to_idx" type="int" /> <description> Changes the index position of track [code]idx[/code] to the one defined in [code]to_idx[/code]. </description> </method> <method name="track_move_up"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Moves a track up. </description> </method> <method name="track_remove_key"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> <description> Removes a key by index in a given track. </description> </method> <method name="track_remove_key_at_time"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time" type="float" /> <description> Removes a key at [code]time[/code] in a given track. </description> </method> <method name="track_set_enabled"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="enabled" type="bool" /> <description> Enables/disables the given track. Tracks are enabled by default. </description> </method> <method name="track_set_imported"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="imported" type="bool" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="imported" type="bool" /> <description> Sets the given track as imported or not. </description> </method> <method name="track_set_interpolation_loop_wrap"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="interpolation" type="bool" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="interpolation" type="bool" /> <description> If [code]true[/code], the track at [code]idx[/code] wraps the interpolation loop. </description> </method> <method name="track_set_interpolation_type"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="interpolation" type="int" enum="Animation.InterpolationType" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="interpolation" type="int" enum="Animation.InterpolationType" /> <description> Sets the interpolation type of a given track. </description> </method> <method name="track_set_key_time"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="time" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="time" type="float" /> <description> Sets the time of an existing key. </description> </method> <method name="track_set_key_transition"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key_idx" type="int" /> - <argument index="2" name="transition" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key_idx" type="int" /> + <param index="2" name="transition" type="float" /> <description> Sets the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]). </description> </method> <method name="track_set_key_value"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="key" type="int" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="key" type="int" /> + <param index="2" name="value" type="Variant" /> <description> Sets the value of an existing key. </description> </method> <method name="track_set_path"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="path" type="NodePath" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="path" type="NodePath" /> <description> Sets the path of a track. Paths must be valid scene-tree paths to a node and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by [code]":"[/code]. For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. @@ -528,40 +528,40 @@ </method> <method name="track_swap"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="with_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="with_idx" type="int" /> <description> Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code]. </description> </method> <method name="value_track_get_key_indices" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time_sec" type="float" /> - <argument index="2" name="delta" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time_sec" type="float" /> + <param index="2" name="delta" type="float" /> <description> Returns all the key indices of a value track, given a position and delta time. </description> </method> <method name="value_track_get_update_mode" qualifiers="const"> <return type="int" enum="Animation.UpdateMode" /> - <argument index="0" name="track_idx" type="int" /> + <param index="0" name="track_idx" type="int" /> <description> Returns the update mode of a value track. </description> </method> <method name="value_track_interpolate" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time_sec" type="float" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="time_sec" type="float" /> <description> Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track. </description> </method> <method name="value_track_set_update_mode"> <return type="void" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="mode" type="int" enum="Animation.UpdateMode" /> + <param index="0" name="track_idx" type="int" /> + <param index="1" name="mode" type="int" enum="Animation.UpdateMode" /> <description> Sets the update mode (see [enum UpdateMode]) of a value track. </description> diff --git a/doc/classes/AnimationLibrary.xml b/doc/classes/AnimationLibrary.xml index d856c65dfc..015d306b41 100644 --- a/doc/classes/AnimationLibrary.xml +++ b/doc/classes/AnimationLibrary.xml @@ -9,14 +9,14 @@ <methods> <method name="add_animation"> <return type="int" enum="Error" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="animation" type="Animation" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="animation" type="Animation" /> <description> </description> </method> <method name="get_animation" qualifiers="const"> <return type="Animation" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> @@ -27,20 +27,20 @@ </method> <method name="has_animation" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> <method name="remove_animation"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> <method name="rename_animation"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="newname" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="newname" type="StringName" /> <description> </description> </method> @@ -51,18 +51,18 @@ </members> <signals> <signal name="animation_added"> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </signal> <signal name="animation_removed"> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </signal> <signal name="animation_renamed"> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="to_name" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="to_name" type="StringName" /> <description> </description> </signal> diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 189e30b5f2..ba20007825 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -19,7 +19,7 @@ </method> <method name="_get_child_by_name" qualifiers="virtual const"> <return type="AnimationNode" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Gets a child node by index (used by editors inheriting from [AnimationRootNode]). </description> @@ -32,7 +32,7 @@ </method> <method name="_get_parameter_default_value" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="parameter" type="StringName" /> + <param index="0" name="parameter" type="StringName" /> <description> Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. </description> @@ -51,9 +51,9 @@ </method> <method name="_process" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="time" type="float" /> - <argument index="1" name="seek" type="bool" /> - <argument index="2" name="seek_root" type="bool" /> + <param index="0" name="time" type="float" /> + <param index="1" name="seek" type="bool" /> + <param index="2" name="seek_root" type="bool" /> <description> User-defined callback called when a custom node is processed. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory. @@ -62,47 +62,47 @@ </method> <method name="add_input"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Adds an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree]. </description> </method> <method name="blend_animation"> <return type="void" /> - <argument index="0" name="animation" type="StringName" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="delta" type="float" /> - <argument index="3" name="seeked" type="bool" /> - <argument index="4" name="seek_root" type="bool" /> - <argument index="5" name="blend" type="float" /> - <argument index="6" name="pingponged" type="int" default="0" /> + <param index="0" name="animation" type="StringName" /> + <param index="1" name="time" type="float" /> + <param index="2" name="delta" type="float" /> + <param index="3" name="seeked" type="bool" /> + <param index="4" name="seek_root" type="bool" /> + <param index="5" name="blend" type="float" /> + <param index="6" name="pingponged" type="int" default="0" /> <description> Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened. </description> </method> <method name="blend_input"> <return type="float" /> - <argument index="0" name="input_index" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="seek" type="bool" /> - <argument index="3" name="seek_root" type="bool" /> - <argument index="4" name="blend" type="float" /> - <argument index="5" name="filter" type="int" enum="AnimationNode.FilterAction" default="0" /> - <argument index="6" name="sync" type="bool" default="true" /> + <param index="0" name="input_index" type="int" /> + <param index="1" name="time" type="float" /> + <param index="2" name="seek" type="bool" /> + <param index="3" name="seek_root" type="bool" /> + <param index="4" name="blend" type="float" /> + <param index="5" name="filter" type="int" enum="AnimationNode.FilterAction" default="0" /> + <param index="6" name="sync" type="bool" default="true" /> <description> Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed (see [enum FilterAction] for options). </description> </method> <method name="blend_node"> <return type="float" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="node" type="AnimationNode" /> - <argument index="2" name="time" type="float" /> - <argument index="3" name="seek" type="bool" /> - <argument index="4" name="seek_root" type="bool" /> - <argument index="5" name="blend" type="float" /> - <argument index="6" name="filter" type="int" enum="AnimationNode.FilterAction" default="0" /> - <argument index="7" name="sync" type="bool" default="true" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="node" type="AnimationNode" /> + <param index="2" name="time" type="float" /> + <param index="3" name="seek" type="bool" /> + <param index="4" name="seek_root" type="bool" /> + <param index="5" name="blend" type="float" /> + <param index="6" name="filter" type="int" enum="AnimationNode.FilterAction" default="0" /> + <param index="7" name="sync" type="bool" default="true" /> <description> Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition. </description> @@ -115,44 +115,44 @@ </method> <method name="get_input_name"> <return type="String" /> - <argument index="0" name="input" type="int" /> + <param index="0" name="input" type="int" /> <description> Gets the name of an input by index. </description> </method> <method name="get_parameter" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. </description> </method> <method name="is_path_filtered" qualifiers="const"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns whether the given path is filtered. </description> </method> <method name="remove_input"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an input, call this only when inactive. </description> </method> <method name="set_filter_path"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="enable" type="bool" /> <description> Adds or removes a path for the filter. </description> </method> <method name="set_parameter"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Sets a custom parameter. These are used as local memory, because resources can be reused across the tree or scenes. </description> diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index 7bb136308d..3279c5465e 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -15,9 +15,9 @@ <methods> <method name="add_blend_point"> <return type="void" /> - <argument index="0" name="node" type="AnimationRootNode" /> - <argument index="1" name="pos" type="float" /> - <argument index="2" name="at_index" type="int" default="-1" /> + <param index="0" name="node" type="AnimationRootNode" /> + <param index="1" name="pos" type="float" /> + <param index="2" name="at_index" type="int" default="-1" /> <description> Adds a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. </description> @@ -30,37 +30,37 @@ </method> <method name="get_blend_point_node" qualifiers="const"> <return type="AnimationRootNode" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Returns the [AnimationNode] referenced by the point at index [code]point[/code]. </description> </method> <method name="get_blend_point_position" qualifiers="const"> <return type="float" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Returns the position of the point at index [code]point[/code]. </description> </method> <method name="remove_blend_point"> <return type="void" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Removes the point at index [code]point[/code] from the blend axis. </description> </method> <method name="set_blend_point_node"> <return type="void" /> - <argument index="0" name="point" type="int" /> - <argument index="1" name="node" type="AnimationRootNode" /> + <param index="0" name="point" type="int" /> + <param index="1" name="node" type="AnimationRootNode" /> <description> Changes the [AnimationNode] referenced by the point at index [code]point[/code]. </description> </method> <method name="set_blend_point_position"> <return type="void" /> - <argument index="0" name="point" type="int" /> - <argument index="1" name="pos" type="float" /> + <param index="0" name="point" type="int" /> + <param index="1" name="pos" type="float" /> <description> Updates the position of the point at index [code]point[/code] on the blend axis. </description> diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index eb2249d2d2..9030634bac 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -15,19 +15,19 @@ <methods> <method name="add_blend_point"> <return type="void" /> - <argument index="0" name="node" type="AnimationRootNode" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="at_index" type="int" default="-1" /> + <param index="0" name="node" type="AnimationRootNode" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="at_index" type="int" default="-1" /> <description> Adds a new point that represents a [code]node[/code] at the position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. </description> </method> <method name="add_triangle"> <return type="void" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> - <argument index="2" name="z" type="int" /> - <argument index="3" name="at_index" type="int" default="-1" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> + <param index="2" name="z" type="int" /> + <param index="3" name="at_index" type="int" default="-1" /> <description> Creates a new triangle using three points [code]x[/code], [code]y[/code], and [code]z[/code]. Triangles can overlap. You can insert the triangle at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. </description> @@ -40,14 +40,14 @@ </method> <method name="get_blend_point_node" qualifiers="const"> <return type="AnimationRootNode" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Returns the [AnimationRootNode] referenced by the point at index [code]point[/code]. </description> </method> <method name="get_blend_point_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Returns the position of the point at index [code]point[/code]. </description> @@ -60,38 +60,38 @@ </method> <method name="get_triangle_point"> <return type="int" /> - <argument index="0" name="triangle" type="int" /> - <argument index="1" name="point" type="int" /> + <param index="0" name="triangle" type="int" /> + <param index="1" name="point" type="int" /> <description> Returns the position of the point at index [code]point[/code] in the triangle of index [code]triangle[/code]. </description> </method> <method name="remove_blend_point"> <return type="void" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Removes the point at index [code]point[/code] from the blend space. </description> </method> <method name="remove_triangle"> <return type="void" /> - <argument index="0" name="triangle" type="int" /> + <param index="0" name="triangle" type="int" /> <description> Removes the triangle at index [code]triangle[/code] from the blend space. </description> </method> <method name="set_blend_point_node"> <return type="void" /> - <argument index="0" name="point" type="int" /> - <argument index="1" name="node" type="AnimationRootNode" /> + <param index="0" name="point" type="int" /> + <param index="1" name="node" type="AnimationRootNode" /> <description> Changes the [AnimationNode] referenced by the point at index [code]point[/code]. </description> </method> <method name="set_blend_point_position"> <return type="void" /> - <argument index="0" name="point" type="int" /> - <argument index="1" name="pos" type="Vector2" /> + <param index="0" name="point" type="int" /> + <param index="1" name="pos" type="Vector2" /> <description> Updates the position of the point at index [code]point[/code] on the blend axis. </description> diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index fcdd09f144..b4995b90c8 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -13,70 +13,70 @@ <methods> <method name="add_node"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="node" type="AnimationNode" /> - <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="node" type="AnimationNode" /> + <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later. </description> </method> <method name="connect_node"> <return type="void" /> - <argument index="0" name="input_node" type="StringName" /> - <argument index="1" name="input_index" type="int" /> - <argument index="2" name="output_node" type="StringName" /> + <param index="0" name="input_node" type="StringName" /> + <param index="1" name="input_index" type="int" /> + <param index="2" name="output_node" type="StringName" /> <description> Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code]. </description> </method> <method name="disconnect_node"> <return type="void" /> - <argument index="0" name="input_node" type="StringName" /> - <argument index="1" name="input_index" type="int" /> + <param index="0" name="input_node" type="StringName" /> + <param index="1" name="input_index" type="int" /> <description> Disconnects the node connected to the specified input. </description> </method> <method name="get_node" qualifiers="const"> <return type="AnimationNode" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the sub-node with the specified [code]name[/code]. </description> </method> <method name="get_node_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the position of the sub-node with the specified [code]name[/code]. </description> </method> <method name="has_node" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists. </description> </method> <method name="remove_node"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes a sub-node. </description> </method> <method name="rename_node"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="new_name" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="new_name" type="StringName" /> <description> Changes the name of a sub-node. </description> </method> <method name="set_node_position"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="position" type="Vector2" /> <description> Modifies the position of a sub-node. </description> diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index 6140dd799f..1fa05fa8f1 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -23,18 +23,18 @@ <methods> <method name="add_node"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="node" type="AnimationNode" /> - <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="node" type="AnimationNode" /> + <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Adds a new node to the graph. The [code]position[/code] is used for display in the editor. </description> </method> <method name="add_transition"> <return type="void" /> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="to" type="StringName" /> - <argument index="2" name="transition" type="AnimationNodeStateMachineTransition" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="to" type="StringName" /> + <param index="2" name="transition" type="AnimationNodeStateMachineTransition" /> <description> Adds a transition between the given nodes. </description> @@ -47,28 +47,28 @@ </method> <method name="get_node" qualifiers="const"> <return type="AnimationNode" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the animation node with the given name. </description> </method> <method name="get_node_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="node" type="AnimationNode" /> + <param index="0" name="node" type="AnimationNode" /> <description> Returns the given animation node's name. </description> </method> <method name="get_node_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the given node's coordinates. Used for display in the editor. </description> </method> <method name="get_transition" qualifiers="const"> <return type="AnimationNodeStateMachineTransition" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the given transition. </description> @@ -81,81 +81,81 @@ </method> <method name="get_transition_from" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the given transition's start node. </description> </method> <method name="get_transition_to" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the given transition's end node. </description> </method> <method name="has_node" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the graph contains the given node. </description> </method> <method name="has_transition" qualifiers="const"> <return type="bool" /> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="to" type="StringName" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="to" type="StringName" /> <description> Returns [code]true[/code] if there is a transition between the given nodes. </description> </method> <method name="remove_node"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Deletes the given node from the graph. </description> </method> <method name="remove_transition"> <return type="void" /> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="to" type="StringName" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="to" type="StringName" /> <description> Deletes the transition between the two specified nodes. </description> </method> <method name="remove_transition_by_index"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Deletes the given transition by index. </description> </method> <method name="rename_node"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="new_name" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="new_name" type="StringName" /> <description> Renames the given node. </description> </method> <method name="replace_node"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="node" type="AnimationNode" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="node" type="AnimationNode" /> <description> </description> </method> <method name="set_graph_offset"> <return type="void" /> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> <description> Sets the draw offset of the graph. Used for display in the editor. </description> </method> <method name="set_node_position"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="position" type="Vector2" /> <description> Sets the node's coordinates. Used for display in the editor. </description> diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index 901ab569c8..8f53ef0dcf 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -52,7 +52,7 @@ </method> <method name="start"> <return type="void" /> - <argument index="0" name="node" type="StringName" /> + <param index="0" name="node" type="StringName" /> <description> Starts playing the given animation. </description> @@ -65,7 +65,7 @@ </method> <method name="travel"> <return type="void" /> - <argument index="0" name="to_node" type="StringName" /> + <param index="0" name="to_node" type="StringName" /> <description> Transitions from the current state to another one, following the shortest path. </description> diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index 7e757d4640..a5de170ccd 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -14,27 +14,27 @@ <methods> <method name="get_input_caption" qualifiers="const"> <return type="String" /> - <argument index="0" name="input" type="int" /> + <param index="0" name="input" type="int" /> <description> </description> </method> <method name="is_input_set_as_auto_advance" qualifiers="const"> <return type="bool" /> - <argument index="0" name="input" type="int" /> + <param index="0" name="input" type="int" /> <description> </description> </method> <method name="set_input_as_auto_advance"> <return type="void" /> - <argument index="0" name="input" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="input" type="int" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="set_input_caption"> <return type="void" /> - <argument index="0" name="input" type="int" /> - <argument index="1" name="caption" type="String" /> + <param index="0" name="input" type="int" /> + <param index="1" name="caption" type="String" /> <description> </description> </method> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index d3c8bdac3a..7b59051f49 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -17,30 +17,30 @@ <methods> <method name="add_animation_library"> <return type="int" enum="Error" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="library" type="AnimationLibrary" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="library" type="AnimationLibrary" /> <description> Adds [code]library[/code] to the animation player, under the key [code]name[/code]. </description> </method> <method name="advance"> <return type="void" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Shifts position in the animation timeline and immediately updates the animation. [code]delta[/code] is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled. </description> </method> <method name="animation_get_next" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="anim_from" type="StringName" /> + <param index="0" name="anim_from" type="StringName" /> <description> Returns the key of the animation which is queued to play after the [code]anim_from[/code] animation. </description> </method> <method name="animation_set_next"> <return type="void" /> - <argument index="0" name="anim_from" type="StringName" /> - <argument index="1" name="anim_to" type="StringName" /> + <param index="0" name="anim_from" type="StringName" /> + <param index="1" name="anim_to" type="StringName" /> <description> Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. </description> @@ -59,28 +59,28 @@ </method> <method name="find_animation" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="animation" type="Animation" /> + <param index="0" name="animation" type="Animation" /> <description> Returns the key of [code]animation[/code] or an empty [StringName] if not found. </description> </method> <method name="find_animation_library" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="animation" type="Animation" /> + <param index="0" name="animation" type="Animation" /> <description> Returns the key for the [AnimationLibrary] that contains [code]animation[/code] or an empty [StringName] if not found. </description> </method> <method name="get_animation" qualifiers="const"> <return type="Animation" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found. </description> </method> <method name="get_animation_library" qualifiers="const"> <return type="AnimationLibrary" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the first [AnimationLibrary] with key [code]name[/code] or [code]null[/code] if not found. </description> @@ -99,8 +99,8 @@ </method> <method name="get_blend_time" qualifiers="const"> <return type="float" /> - <argument index="0" name="anim_from" type="StringName" /> - <argument index="1" name="anim_to" type="StringName" /> + <param index="0" name="anim_from" type="StringName" /> + <param index="1" name="anim_to" type="StringName" /> <description> Gets the blend time (in seconds) between two animations, referenced by their keys. </description> @@ -119,14 +119,14 @@ </method> <method name="has_animation" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code]. </description> </method> <method name="has_animation_library" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the [AnimationPlayer] stores an [AnimationLibrary] with key [code]name[/code]. </description> @@ -139,10 +139,10 @@ </method> <method name="play"> <return type="void" /> - <argument index="0" name="name" type="StringName" default="""" /> - <argument index="1" name="custom_blend" type="float" default="-1" /> - <argument index="2" name="custom_speed" type="float" default="1.0" /> - <argument index="3" name="from_end" type="bool" default="false" /> + <param index="0" name="name" type="StringName" default="""" /> + <param index="1" name="custom_blend" type="float" default="-1" /> + <param index="2" name="custom_speed" type="float" default="1.0" /> + <param index="3" name="from_end" type="bool" default="false" /> <description> Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]). The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing. @@ -151,8 +151,8 @@ </method> <method name="play_backwards"> <return type="void" /> - <argument index="0" name="name" type="StringName" default="""" /> - <argument index="1" name="custom_blend" type="float" default="-1" /> + <param index="0" name="name" type="StringName" default="""" /> + <param index="1" name="custom_blend" type="float" default="-1" /> <description> Plays the animation with key [code]name[/code] in reverse. This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information. @@ -160,7 +160,7 @@ </method> <method name="queue"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Queues an animation for playback once the current one is done. [b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow. @@ -168,23 +168,23 @@ </method> <method name="remove_animation_library"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes the [AnimationLibrary] assosiated with the key [code]name[/code]. </description> </method> <method name="rename_animation_library"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="newname" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="newname" type="StringName" /> <description> Moves the [AnimationLibrary] associated with the key [code]name[/code] to the key [code]newname[/code]. </description> </method> <method name="seek"> <return type="void" /> - <argument index="0" name="seconds" type="float" /> - <argument index="1" name="update" type="bool" default="false" /> + <param index="0" name="seconds" type="float" /> + <param index="1" name="update" type="bool" default="false" /> <description> Seeks the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped. [b]Note:[/b] Seeking to the end of the animation doesn't emit [signal animation_finished]. If you want to skip animation and emit the signal, use [method advance]. @@ -192,16 +192,16 @@ </method> <method name="set_blend_time"> <return type="void" /> - <argument index="0" name="anim_from" type="StringName" /> - <argument index="1" name="anim_to" type="StringName" /> - <argument index="2" name="sec" type="float" /> + <param index="0" name="anim_from" type="StringName" /> + <param index="1" name="anim_to" type="StringName" /> + <param index="2" name="sec" type="float" /> <description> Specifies a blend time (in seconds) between two animations, referenced by their keys. </description> </method> <method name="stop"> <return type="void" /> - <argument index="0" name="reset" type="bool" default="true" /> + <param index="0" name="reset" type="bool" default="true" /> <description> Stops or pauses the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. If [code]reset[/code] is [code]false[/code], the [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation. @@ -254,22 +254,22 @@ </members> <signals> <signal name="animation_changed"> - <argument index="0" name="old_name" type="StringName" /> - <argument index="1" name="new_name" type="StringName" /> + <param index="0" name="old_name" type="StringName" /> + <param index="1" name="new_name" type="StringName" /> <description> Emitted when a queued animation plays after the previous animation finished. See [method queue]. [b]Note:[/b] The signal is not emitted when the animation is changed via [method play] or by an [AnimationTree]. </description> </signal> <signal name="animation_finished"> - <argument index="0" name="anim_name" type="StringName" /> + <param index="0" name="anim_name" type="StringName" /> <description> Notifies when an animation finished playing. [b]Note:[/b] This signal is not emitted if an animation is looping. </description> </signal> <signal name="animation_started"> - <argument index="0" name="anim_name" type="StringName" /> + <param index="0" name="anim_name" type="StringName" /> <description> Notifies when an animation starts playing. </description> diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 45d9152564..f2bf74f495 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -14,7 +14,7 @@ <methods> <method name="advance"> <return type="void" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Manually advance the animations by the specified time (in seconds). </description> @@ -27,8 +27,8 @@ </method> <method name="rename_parameter"> <return type="void" /> - <argument index="0" name="old_name" type="String" /> - <argument index="1" name="new_name" type="String" /> + <param index="0" name="old_name" type="String" /> + <param index="1" name="new_name" type="String" /> <description> </description> </method> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 1eb74768f5..034140ff52 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -29,7 +29,7 @@ </method> <method name="overlaps_area" qualifiers="const"> <return type="bool" /> - <argument index="0" name="area" type="Node" /> + <param index="0" name="area" type="Node" /> <description> Returns [code]true[/code] if the given [Area2D] intersects or overlaps this [Area2D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -37,7 +37,7 @@ </method> <method name="overlaps_body" qualifiers="const"> <return type="bool" /> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Returns [code]true[/code] if the given physics body intersects or overlaps this [Area2D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -96,24 +96,24 @@ </members> <signals> <signal name="area_entered"> - <argument index="0" name="area" type="Area2D" /> + <param index="0" name="area" type="Area2D" /> <description> Emitted when another Area2D enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area2D. </description> </signal> <signal name="area_exited"> - <argument index="0" name="area" type="Area2D" /> + <param index="0" name="area" type="Area2D" /> <description> Emitted when another Area2D exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area2D. </description> </signal> <signal name="area_shape_entered"> - <argument index="0" name="area_rid" type="RID" /> - <argument index="1" name="area" type="Area2D" /> - <argument index="2" name="area_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="area_rid" type="RID" /> + <param index="1" name="area" type="Area2D" /> + <param index="2" name="area_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. @@ -123,10 +123,10 @@ </description> </signal> <signal name="area_shape_exited"> - <argument index="0" name="area_rid" type="RID" /> - <argument index="1" name="area" type="Area2D" /> - <argument index="2" name="area_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="area_rid" type="RID" /> + <param index="1" name="area" type="Area2D" /> + <param index="2" name="area_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. @@ -136,24 +136,24 @@ </description> </signal> <signal name="body_entered"> - <argument index="0" name="body" type="Node2D" /> + <param index="0" name="body" type="Node2D" /> <description> Emitted when a [PhysicsBody2D] or [TileMap] enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. </description> </signal> <signal name="body_exited"> - <argument index="0" name="body" type="Node2D" /> + <param index="0" name="body" type="Node2D" /> <description> Emitted when a [PhysicsBody2D] or [TileMap] exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. </description> </signal> <signal name="body_shape_entered"> - <argument index="0" name="body_rid" type="RID" /> - <argument index="1" name="body" type="Node2D" /> - <argument index="2" name="body_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="body_rid" type="RID" /> + <param index="1" name="body" type="Node2D" /> + <param index="2" name="body_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. @@ -163,10 +163,10 @@ </description> </signal> <signal name="body_shape_exited"> - <argument index="0" name="body_rid" type="RID" /> - <argument index="1" name="body" type="Node2D" /> - <argument index="2" name="body_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="body_rid" type="RID" /> + <param index="1" name="body" type="Node2D" /> + <param index="2" name="body_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index 7d14fd825b..0313e8f679 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -27,7 +27,7 @@ </method> <method name="overlaps_area" qualifiers="const"> <return type="bool" /> - <argument index="0" name="area" type="Node" /> + <param index="0" name="area" type="Node" /> <description> Returns [code]true[/code] if the given [Area3D] intersects or overlaps this [Area3D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -35,7 +35,7 @@ </method> <method name="overlaps_body" qualifiers="const"> <return type="bool" /> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Returns [code]true[/code] if the given physics body intersects or overlaps this [Area3D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -115,24 +115,24 @@ </members> <signals> <signal name="area_entered"> - <argument index="0" name="area" type="Area3D" /> + <param index="0" name="area" type="Area3D" /> <description> Emitted when another Area3D enters this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area3D. </description> </signal> <signal name="area_exited"> - <argument index="0" name="area" type="Area3D" /> + <param index="0" name="area" type="Area3D" /> <description> Emitted when another Area3D exits this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area3D. </description> </signal> <signal name="area_shape_entered"> - <argument index="0" name="area_rid" type="RID" /> - <argument index="1" name="area" type="Area3D" /> - <argument index="2" name="area_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="area_rid" type="RID" /> + <param index="1" name="area" type="Area3D" /> + <param index="2" name="area_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_rid[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. @@ -142,10 +142,10 @@ </description> </signal> <signal name="area_shape_exited"> - <argument index="0" name="area_rid" type="RID" /> - <argument index="1" name="area" type="Area3D" /> - <argument index="2" name="area_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="area_rid" type="RID" /> + <param index="1" name="area" type="Area3D" /> + <param index="2" name="area_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area3D's [Shape3D]s exits one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_rid[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. @@ -155,24 +155,24 @@ </description> </signal> <signal name="body_entered"> - <argument index="0" name="body" type="Node3D" /> + <param index="0" name="body" type="Node3D" /> <description> Emitted when a [PhysicsBody3D] or [GridMap] enters this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. </description> </signal> <signal name="body_exited"> - <argument index="0" name="body" type="Node3D" /> + <param index="0" name="body" type="Node3D" /> <description> Emitted when a [PhysicsBody3D] or [GridMap] exits this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. </description> </signal> <signal name="body_shape_entered"> - <argument index="0" name="body_rid" type="RID" /> - <argument index="1" name="body" type="Node3D" /> - <argument index="2" name="body_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="body_rid" type="RID" /> + <param index="1" name="body" type="Node3D" /> + <param index="2" name="body_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body_rid[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. @@ -182,10 +182,10 @@ </description> </signal> <signal name="body_shape_exited"> - <argument index="0" name="body_rid" type="RID" /> - <argument index="1" name="body" type="Node3D" /> - <argument index="2" name="body_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="body_rid" type="RID" /> + <param index="1" name="body" type="Node3D" /> + <param index="2" name="body_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body_rid[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index c149cdc0e4..ac8d09be43 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -53,70 +53,70 @@ </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs an [Array] as a copy of the given [Array]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedByteArray" /> + <param index="0" name="from" type="PackedByteArray" /> <description> Constructs an array from a [PackedByteArray]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedColorArray" /> + <param index="0" name="from" type="PackedColorArray" /> <description> Constructs an array from a [PackedColorArray]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedFloat32Array" /> + <param index="0" name="from" type="PackedFloat32Array" /> <description> Constructs an array from a [PackedFloat32Array]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedFloat64Array" /> + <param index="0" name="from" type="PackedFloat64Array" /> <description> Constructs an array from a [PackedFloat64Array]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedInt32Array" /> + <param index="0" name="from" type="PackedInt32Array" /> <description> Constructs an array from a [PackedInt32Array]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedInt64Array" /> + <param index="0" name="from" type="PackedInt64Array" /> <description> Constructs an array from a [PackedInt64Array]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedStringArray" /> + <param index="0" name="from" type="PackedStringArray" /> <description> Constructs an array from a [PackedStringArray]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedVector2Array" /> + <param index="0" name="from" type="PackedVector2Array" /> <description> Constructs an array from a [PackedVector2Array]. </description> </constructor> <constructor name="Array"> <return type="Array" /> - <argument index="0" name="from" type="PackedVector3Array" /> + <param index="0" name="from" type="PackedVector3Array" /> <description> Constructs an array from a [PackedVector3Array]. </description> @@ -125,7 +125,7 @@ <methods> <method name="all" qualifiers="const"> <return type="bool" /> - <argument index="0" name="method" type="Callable" /> + <param index="0" name="method" type="Callable" /> <description> Calls the provided [Callable] on each element in the array and returns [code]true[/code] if the [Callable] returns [code]true[/code] for [i]all[/i] elements in the array. If the [Callable] returns [code]false[/code] for one array element or more, this method returns [code]false[/code]. The callable's method should take one [Variant] parameter (the current array element) and return a boolean value. @@ -148,7 +148,7 @@ </method> <method name="any" qualifiers="const"> <return type="bool" /> - <argument index="0" name="method" type="Callable" /> + <param index="0" name="method" type="Callable" /> <description> Calls the provided [Callable] on each element in the array and returns [code]true[/code] if the [Callable] returns [code]true[/code] for [i]one or more[/i] elements in the array. If the [Callable] returns [code]false[/code] for all elements in the array, this method returns [code]false[/code]. The callable's method should take one [Variant] parameter (the current array element) and return a boolean value. @@ -171,14 +171,14 @@ </method> <method name="append"> <return type="void" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="Array" /> + <param index="0" name="array" type="Array" /> <description> Appends another array at the end of this array. [codeblock] @@ -198,8 +198,8 @@ </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="Variant" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="Variant" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -207,9 +207,9 @@ </method> <method name="bsearch_custom"> <return type="int" /> - <argument index="0" name="value" type="Variant" /> - <argument index="1" name="func" type="Callable" /> - <argument index="2" name="before" type="bool" default="true" /> + <param index="0" name="value" type="Variant" /> + <param index="1" name="func" type="Callable" /> + <param index="2" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise. [b]Note:[/b] Calling [method bsearch_custom] on an unsorted array results in unexpected behavior. @@ -223,14 +223,14 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Returns the number of times an element is in the array. </description> </method> <method name="duplicate" qualifiers="const"> <return type="Array" /> - <argument index="0" name="deep" type="bool" default="false" /> + <param index="0" name="deep" type="bool" default="false" /> <description> Returns a copy of the array. If [code]deep[/code] is [code]true[/code], a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If [code]false[/code], a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. @@ -238,7 +238,7 @@ </method> <method name="erase"> <return type="void" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Removes the first occurrence of a value from the array. If the value does not exist in the array, nothing happens. To remove an element by index, use [method remove_at] instead. [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -247,7 +247,7 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements: [codeblocks] @@ -266,7 +266,7 @@ </method> <method name="filter" qualifiers="const"> <return type="Array" /> - <argument index="0" name="method" type="Callable" /> + <param index="0" name="method" type="Callable" /> <description> Calls the provided [Callable] on each element in the array and returns a new array with the elements for which the method returned [code]true[/code]. The callable's method should take one [Variant] parameter (the current array element) and return a boolean value. @@ -283,15 +283,15 @@ </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="what" type="Variant" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="what" type="Variant" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="find_last" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Searches the array in reverse order for a value and returns its index or [code]-1[/code] if not found. </description> @@ -305,7 +305,7 @@ </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Returns [code]true[/code] if the array contains the given value. [codeblocks] @@ -352,8 +352,8 @@ </method> <method name="insert"> <return type="int" /> - <argument index="0" name="position" type="int" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="position" type="int" /> + <param index="1" name="value" type="Variant" /> <description> Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]pos == size()[/code]). [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -368,7 +368,7 @@ </method> <method name="map" qualifiers="const"> <return type="Array" /> - <argument index="0" name="method" type="Callable" /> + <param index="0" name="method" type="Callable" /> <description> Calls the provided [Callable] for each element in the array and returns a new array filled with values returned by the method. The callable's method should take one [Variant] parameter (the current array element) and can return any [Variant]. @@ -397,7 +397,7 @@ </method> <method name="pop_at"> <return type="Variant" /> - <argument index="0" name="position" type="int" /> + <param index="0" name="position" type="int" /> <description> Removes and returns the element of the array at index [code]position[/code]. If negative, [code]position[/code] is considered relative to the end of the array. Leaves the array untouched and returns [code]null[/code] if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty. [b]Note:[/b] On large arrays, this method can be slower than [method pop_back] as it will reindex the array's elements that are located after the removed element. The larger the array and the lower the index of the removed element, the slower [method pop_at] will be. @@ -418,14 +418,14 @@ </method> <method name="push_back"> <return type="void" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Appends an element at the end of the array. See also [method push_front]. </description> </method> <method name="push_front"> <return type="void" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Adds an element at the beginning of the array. See also [method push_back]. [b]Note:[/b] On large arrays, this method is much slower than [method push_back] as it will reindex all the array's elements every time it's called. The larger the array, the slower [method push_front] will be. @@ -433,8 +433,8 @@ </method> <method name="reduce" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="method" type="Callable" /> - <argument index="1" name="accum" type="Variant" default="null" /> + <param index="0" name="method" type="Callable" /> + <param index="1" name="accum" type="Variant" default="null" /> <description> Calls the provided [Callable] for each element in array and accumulates the result in [code]accum[/code]. The callable's method takes two arguments: the current value of [code]accum[/code] and the current array element. If [code]accum[/code] is [code]null[/code] (default value), the iteration will start from the second element, with the first one used as initial value of [code]accum[/code]. @@ -451,7 +451,7 @@ </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="position" type="int" /> + <param index="0" name="position" type="int" /> <description> Removes an element from the array by index. If the index does not exist in the array, nothing happens. To remove an element by searching for its value, use [method erase] instead. [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -460,7 +460,7 @@ </method> <method name="resize"> <return type="int" /> - <argument index="0" name="size" type="int" /> + <param index="0" name="size" type="int" /> <description> Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are [code]null[/code]. </description> @@ -473,8 +473,8 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="what" type="Variant" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="what" type="Variant" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> @@ -493,10 +493,10 @@ </method> <method name="slice" qualifiers="const"> <return type="Array" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> - <argument index="2" name="step" type="int" default="1" /> - <argument index="3" name="deep" type="bool" default="false" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> + <param index="2" name="step" type="int" default="1" /> + <param index="3" name="deep" type="bool" default="false" /> <description> Returns the slice of the [Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -530,7 +530,7 @@ </method> <method name="sort_custom"> <return type="void" /> - <argument index="0" name="func" type="Callable" /> + <param index="0" name="func" type="Callable" /> <description> Sorts the array using a custom method. The custom method receives two arguments (a pair of elements from the array) and must return either [code]true[/code] or [code]false[/code]. For two elements [code]a[/code] and [code]b[/code], if the given method returns [code]true[/code], element [code]b[/code] will be after element [code]a[/code] in the array. [b]Note:[/b] You cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. @@ -560,56 +560,56 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Array" /> + <param index="0" name="right" type="Array" /> <description> Compares the left operand [Array] against the [code]right[/code] [Array]. Returns [code]true[/code] if the sizes or contents of the arrays are [i]not[/i] equal, [code]false[/code] otherwise. </description> </operator> <operator name="operator +"> <return type="Array" /> - <argument index="0" name="right" type="Array" /> + <param index="0" name="right" type="Array" /> <description> Concatenates two [Array]s together, with the [code]right[/code] [Array] being added to the end of the [Array] specified in the left operand. For example, [code][1, 2] + [3, 4][/code] results in [code][1, 2, 3, 4][/code]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="Array" /> + <param index="0" name="right" type="Array" /> <description> Performs a comparison for each index between the left operand [Array] and the [code]right[/code] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is less, or [code]false[/code] if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]false[/code] if the left operand [Array] has less elements, otherwise it returns [code]true[/code]. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="Array" /> + <param index="0" name="right" type="Array" /> <description> Performs a comparison for each index between the left operand [Array] and the [code]right[/code] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is less, or [code]false[/code] if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the left operand [Array] has less or the same number of elements, otherwise it returns [code]false[/code]. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Array" /> + <param index="0" name="right" type="Array" /> <description> Compares the left operand [Array] against the [code]right[/code] [Array]. Returns [code]true[/code] if the sizes and contents of the arrays are equal, [code]false[/code] otherwise. </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="Array" /> + <param index="0" name="right" type="Array" /> <description> Performs a comparison for each index between the left operand [Array] and the [code]right[/code] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is greater, or [code]false[/code] if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the [code]right[/code] [Array] has more elements, otherwise it returns [code]false[/code]. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="Array" /> + <param index="0" name="right" type="Array" /> <description> Performs a comparison for each index between the left operand [Array] and the [code]right[/code] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is greater, or [code]false[/code] if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the [code]right[/code] [Array] has more or the same number of elements, otherwise it returns [code]false[/code]. </description> </operator> <operator name="operator []"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns a reference to the element of type [Variant] at the specified location. Arrays start at index 0. [code]index[/code] can be a zero or positive value to start from the beginning, or a negative value to start from the end. Out-of-bounds array access causes a run-time error, which will result in an error being printed and the project execution pausing if run from the editor. </description> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index f5c799d4de..500cf342c0 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -52,18 +52,18 @@ <methods> <method name="add_blend_shape"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added. </description> </method> <method name="add_surface_from_arrays"> <return type="void" /> - <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" /> - <argument index="1" name="arrays" type="Array" /> - <argument index="2" name="blend_shapes" type="Array" default="[]" /> - <argument index="3" name="lods" type="Dictionary" default="{}" /> - <argument index="4" name="compress_flags" type="int" default="0" /> + <param index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" /> + <param index="1" name="arrays" type="Array" /> + <param index="2" name="blend_shapes" type="Array" default="[]" /> + <param index="3" name="lods" type="Dictionary" default="{}" /> + <param index="4" name="compress_flags" type="int" default="0" /> <description> Creates a new surface. Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. @@ -90,15 +90,15 @@ </method> <method name="get_blend_shape_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the name of the blend shape at this index. </description> </method> <method name="lightmap_unwrap"> <return type="int" enum="Error" /> - <argument index="0" name="transform" type="Transform3D" /> - <argument index="1" name="texel_size" type="float" /> + <param index="0" name="transform" type="Transform3D" /> + <param index="1" name="texel_size" type="float" /> <description> Will perform a UV unwrap on the [ArrayMesh] to prepare the mesh for lightmapping. </description> @@ -111,83 +111,83 @@ </method> <method name="set_blend_shape_name"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="name" type="StringName" /> + <param index="0" name="index" type="int" /> + <param index="1" name="name" type="StringName" /> <description> Sets the name of the blend shape at this index. </description> </method> <method name="surface_find_by_name" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned. </description> </method> <method name="surface_get_array_index_len" qualifiers="const"> <return type="int" /> - <argument index="0" name="surf_idx" type="int" /> + <param index="0" name="surf_idx" type="int" /> <description> Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_array_len" qualifiers="const"> <return type="int" /> - <argument index="0" name="surf_idx" type="int" /> + <param index="0" name="surf_idx" type="int" /> <description> Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_format" qualifiers="const"> <return type="int" /> - <argument index="0" name="surf_idx" type="int" /> + <param index="0" name="surf_idx" type="int" /> <description> Returns the format mask of the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="surf_idx" type="int" /> + <param index="0" name="surf_idx" type="int" /> <description> Gets the name assigned to this surface. </description> </method> <method name="surface_get_primitive_type" qualifiers="const"> <return type="int" enum="Mesh.PrimitiveType" /> - <argument index="0" name="surf_idx" type="int" /> + <param index="0" name="surf_idx" type="int" /> <description> Returns the primitive type of the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_set_name"> <return type="void" /> - <argument index="0" name="surf_idx" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="surf_idx" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets a name for a given surface. </description> </method> <method name="surface_update_attribute_region"> <return type="void" /> - <argument index="0" name="surf_idx" type="int" /> - <argument index="1" name="offset" type="int" /> - <argument index="2" name="data" type="PackedByteArray" /> + <param index="0" name="surf_idx" type="int" /> + <param index="1" name="offset" type="int" /> + <param index="2" name="data" type="PackedByteArray" /> <description> </description> </method> <method name="surface_update_skin_region"> <return type="void" /> - <argument index="0" name="surf_idx" type="int" /> - <argument index="1" name="offset" type="int" /> - <argument index="2" name="data" type="PackedByteArray" /> + <param index="0" name="surf_idx" type="int" /> + <param index="1" name="offset" type="int" /> + <param index="2" name="data" type="PackedByteArray" /> <description> </description> </method> <method name="surface_update_vertex_region"> <return type="void" /> - <argument index="0" name="surf_idx" type="int" /> - <argument index="1" name="offset" type="int" /> - <argument index="2" name="data" type="PackedByteArray" /> + <param index="0" name="surf_idx" type="int" /> + <param index="1" name="offset" type="int" /> + <param index="2" name="data" type="PackedByteArray" /> <description> </description> </method> diff --git a/doc/classes/ArrayOccluder3D.xml b/doc/classes/ArrayOccluder3D.xml index 7f6bf93c8f..866427beeb 100644 --- a/doc/classes/ArrayOccluder3D.xml +++ b/doc/classes/ArrayOccluder3D.xml @@ -12,8 +12,8 @@ <methods> <method name="set_arrays"> <return type="void" /> - <argument index="0" name="vertices" type="PackedVector3Array" /> - <argument index="1" name="indices" type="PackedInt32Array" /> + <param index="0" name="vertices" type="PackedVector3Array" /> + <param index="1" name="indices" type="PackedInt32Array" /> <description> </description> </method> diff --git a/doc/classes/AudioEffectCapture.xml b/doc/classes/AudioEffectCapture.xml index 8e02056456..016c71bf27 100644 --- a/doc/classes/AudioEffectCapture.xml +++ b/doc/classes/AudioEffectCapture.xml @@ -13,7 +13,7 @@ <methods> <method name="can_get_buffer" qualifiers="const"> <return type="bool" /> - <argument index="0" name="frames" type="int" /> + <param index="0" name="frames" type="int" /> <description> Returns [code]true[/code] if at least [code]frames[/code] audio frames are available to read in the internal ring buffer. </description> @@ -26,7 +26,7 @@ </method> <method name="get_buffer"> <return type="PackedVector2Array" /> - <argument index="0" name="frames" type="int" /> + <param index="0" name="frames" type="int" /> <description> Gets the next [code]frames[/code] audio samples from the internal ring buffer. Returns a [PackedVector2Array] containing exactly [code]frames[/code] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available. diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 5efba17e6a..83cbcff70c 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -12,79 +12,79 @@ <methods> <method name="get_voice_cutoff_hz" qualifiers="const"> <return type="float" /> - <argument index="0" name="voice_idx" type="int" /> + <param index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_delay_ms" qualifiers="const"> <return type="float" /> - <argument index="0" name="voice_idx" type="int" /> + <param index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_depth_ms" qualifiers="const"> <return type="float" /> - <argument index="0" name="voice_idx" type="int" /> + <param index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_level_db" qualifiers="const"> <return type="float" /> - <argument index="0" name="voice_idx" type="int" /> + <param index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_pan" qualifiers="const"> <return type="float" /> - <argument index="0" name="voice_idx" type="int" /> + <param index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_rate_hz" qualifiers="const"> <return type="float" /> - <argument index="0" name="voice_idx" type="int" /> + <param index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="set_voice_cutoff_hz"> <return type="void" /> - <argument index="0" name="voice_idx" type="int" /> - <argument index="1" name="cutoff_hz" type="float" /> + <param index="0" name="voice_idx" type="int" /> + <param index="1" name="cutoff_hz" type="float" /> <description> </description> </method> <method name="set_voice_delay_ms"> <return type="void" /> - <argument index="0" name="voice_idx" type="int" /> - <argument index="1" name="delay_ms" type="float" /> + <param index="0" name="voice_idx" type="int" /> + <param index="1" name="delay_ms" type="float" /> <description> </description> </method> <method name="set_voice_depth_ms"> <return type="void" /> - <argument index="0" name="voice_idx" type="int" /> - <argument index="1" name="depth_ms" type="float" /> + <param index="0" name="voice_idx" type="int" /> + <param index="1" name="depth_ms" type="float" /> <description> </description> </method> <method name="set_voice_level_db"> <return type="void" /> - <argument index="0" name="voice_idx" type="int" /> - <argument index="1" name="level_db" type="float" /> + <param index="0" name="voice_idx" type="int" /> + <param index="1" name="level_db" type="float" /> <description> </description> </method> <method name="set_voice_pan"> <return type="void" /> - <argument index="0" name="voice_idx" type="int" /> - <argument index="1" name="pan" type="float" /> + <param index="0" name="voice_idx" type="int" /> + <param index="1" name="pan" type="float" /> <description> </description> </method> <method name="set_voice_rate_hz"> <return type="void" /> - <argument index="0" name="voice_idx" type="int" /> - <argument index="1" name="rate_hz" type="float" /> + <param index="0" name="voice_idx" type="int" /> + <param index="1" name="rate_hz" type="float" /> <description> </description> </method> diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml index ce5b6de3be..6e4040c16e 100644 --- a/doc/classes/AudioEffectEQ.xml +++ b/doc/classes/AudioEffectEQ.xml @@ -19,15 +19,15 @@ </method> <method name="get_band_gain_db" qualifiers="const"> <return type="float" /> - <argument index="0" name="band_idx" type="int" /> + <param index="0" name="band_idx" type="int" /> <description> Returns the band's gain at the specified index, in dB. </description> </method> <method name="set_band_gain_db"> <return type="void" /> - <argument index="0" name="band_idx" type="int" /> - <argument index="1" name="volume_db" type="float" /> + <param index="0" name="band_idx" type="int" /> + <param index="1" name="volume_db" type="float" /> <description> Sets band's gain at the specified index, in dB. </description> diff --git a/doc/classes/AudioEffectInstance.xml b/doc/classes/AudioEffectInstance.xml index f50246d6ca..bc3d579f36 100644 --- a/doc/classes/AudioEffectInstance.xml +++ b/doc/classes/AudioEffectInstance.xml @@ -9,9 +9,9 @@ <methods> <method name="_process" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="src_buffer" type="const void*" /> - <argument index="1" name="dst_buffer" type="AudioFrame*" /> - <argument index="2" name="frame_count" type="int" /> + <param index="0" name="src_buffer" type="const void*" /> + <param index="1" name="dst_buffer" type="AudioFrame*" /> + <param index="2" name="frame_count" type="int" /> <description> </description> </method> diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml index 32a6aea340..ff034389fc 100644 --- a/doc/classes/AudioEffectRecord.xml +++ b/doc/classes/AudioEffectRecord.xml @@ -27,7 +27,7 @@ </method> <method name="set_recording_active"> <return type="void" /> - <argument index="0" name="record" type="bool" /> + <param index="0" name="record" type="bool" /> <description> If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. </description> diff --git a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml index 08dd5a5d69..55ac78f197 100644 --- a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml +++ b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml @@ -9,9 +9,9 @@ <methods> <method name="get_magnitude_for_frequency_range" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="from_hz" type="float" /> - <argument index="1" name="to_hz" type="float" /> - <argument index="2" name="mode" type="int" enum="AudioEffectSpectrumAnalyzerInstance.MagnitudeMode" default="1" /> + <param index="0" name="from_hz" type="float" /> + <param index="1" name="to_hz" type="float" /> + <param index="2" name="mode" type="int" enum="AudioEffectSpectrumAnalyzerInstance.MagnitudeMode" default="1" /> <description> </description> </method> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 28dcd2794e..98b28ae504 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -15,16 +15,16 @@ <methods> <method name="add_bus"> <return type="void" /> - <argument index="0" name="at_position" type="int" default="-1" /> + <param index="0" name="at_position" type="int" default="-1" /> <description> Adds a bus at [code]at_position[/code]. </description> </method> <method name="add_bus_effect"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="effect" type="AudioEffect" /> - <argument index="2" name="at_position" type="int" default="-1" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="effect" type="AudioEffect" /> + <param index="2" name="at_position" type="int" default="-1" /> <description> Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code]. </description> @@ -43,75 +43,75 @@ </method> <method name="get_bus_channels" qualifiers="const"> <return type="int" /> - <argument index="0" name="bus_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> <description> Returns the amount of channels of the bus at index [code]bus_idx[/code]. </description> </method> <method name="get_bus_effect"> <return type="AudioEffect" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="effect_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="effect_idx" type="int" /> <description> Returns the [AudioEffect] at position [code]effect_idx[/code] in bus [code]bus_idx[/code]. </description> </method> <method name="get_bus_effect_count"> <return type="int" /> - <argument index="0" name="bus_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> <description> Returns the number of effects on the bus at [code]bus_idx[/code]. </description> </method> <method name="get_bus_effect_instance"> <return type="AudioEffectInstance" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="effect_idx" type="int" /> - <argument index="2" name="channel" type="int" default="0" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="effect_idx" type="int" /> + <param index="2" name="channel" type="int" default="0" /> <description> Returns the [AudioEffectInstance] assigned to the given bus and effect indices (and optionally channel). </description> </method> <method name="get_bus_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="bus_name" type="StringName" /> + <param index="0" name="bus_name" type="StringName" /> <description> Returns the index of the bus with the name [code]bus_name[/code]. </description> </method> <method name="get_bus_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="bus_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> <description> Returns the name of the bus with the index [code]bus_idx[/code]. </description> </method> <method name="get_bus_peak_volume_left_db" qualifiers="const"> <return type="float" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="channel" type="int" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="channel" type="int" /> <description> Returns the peak volume of the left speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code]. </description> </method> <method name="get_bus_peak_volume_right_db" qualifiers="const"> <return type="float" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="channel" type="int" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="channel" type="int" /> <description> Returns the peak volume of the right speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code]. </description> </method> <method name="get_bus_send" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="bus_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> <description> Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to. </description> </method> <method name="get_bus_volume_db" qualifiers="const"> <return type="float" /> - <argument index="0" name="bus_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> <description> Returns the volume of the bus at index [code]bus_idx[/code] in dB. </description> @@ -154,29 +154,29 @@ </method> <method name="is_bus_bypassing_effects" qualifiers="const"> <return type="bool" /> - <argument index="0" name="bus_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> <description> If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. </description> </method> <method name="is_bus_effect_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="effect_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="effect_idx" type="int" /> <description> If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled. </description> </method> <method name="is_bus_mute" qualifiers="const"> <return type="bool" /> - <argument index="0" name="bus_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> <description> If [code]true[/code], the bus at index [code]bus_idx[/code] is muted. </description> </method> <method name="is_bus_solo" qualifiers="const"> <return type="bool" /> - <argument index="0" name="bus_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> <description> If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode. </description> @@ -190,102 +190,102 @@ </method> <method name="move_bus"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="to_index" type="int" /> + <param index="0" name="index" type="int" /> + <param index="1" name="to_index" type="int" /> <description> Moves the bus from index [code]index[/code] to index [code]to_index[/code]. </description> </method> <method name="remove_bus"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes the bus at index [code]index[/code]. </description> </method> <method name="remove_bus_effect"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="effect_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="effect_idx" type="int" /> <description> Removes the effect at index [code]effect_idx[/code] from the bus at index [code]bus_idx[/code]. </description> </method> <method name="set_bus_bypass_effects"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. </description> </method> <method name="set_bus_effect_enabled"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="effect_idx" type="int" /> - <argument index="2" name="enabled" type="bool" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="effect_idx" type="int" /> + <param index="2" name="enabled" type="bool" /> <description> If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled. </description> </method> <method name="set_bus_layout"> <return type="void" /> - <argument index="0" name="bus_layout" type="AudioBusLayout" /> + <param index="0" name="bus_layout" type="AudioBusLayout" /> <description> Overwrites the currently used [AudioBusLayout]. </description> </method> <method name="set_bus_mute"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], the bus at index [code]bus_idx[/code] is muted. </description> </method> <method name="set_bus_name"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets the name of the bus at index [code]bus_idx[/code] to [code]name[/code]. </description> </method> <method name="set_bus_send"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="send" type="StringName" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="send" type="StringName" /> <description> Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code]. </description> </method> <method name="set_bus_solo"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode. </description> </method> <method name="set_bus_volume_db"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="volume_db" type="float" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="volume_db" type="float" /> <description> Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. </description> </method> <method name="set_enable_tagging_used_audio_streams"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> </description> </method> <method name="swap_bus_effects"> <return type="void" /> - <argument index="0" name="bus_idx" type="int" /> - <argument index="1" name="effect_idx" type="int" /> - <argument index="2" name="by_effect_idx" type="int" /> + <param index="0" name="bus_idx" type="int" /> + <param index="1" name="effect_idx" type="int" /> + <param index="2" name="by_effect_idx" type="int" /> <description> Swaps the position of two effects in bus [code]bus_idx[/code]. </description> diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 06c285bff7..8bc8e61869 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -13,7 +13,7 @@ <methods> <method name="can_push_buffer" qualifiers="const"> <return type="bool" /> - <argument index="0" name="amount" type="int" /> + <param index="0" name="amount" type="int" /> <description> Returns [code]true[/code] if a buffer of the size [code]amount[/code] can be pushed to the audio sample data buffer without overflowing it, [code]false[/code] otherwise. </description> @@ -37,14 +37,14 @@ </method> <method name="push_buffer"> <return type="bool" /> - <argument index="0" name="frames" type="PackedVector2Array" /> + <param index="0" name="frames" type="PackedVector2Array" /> <description> Pushes several audio data frames to the buffer. This is usually more efficient than [method push_frame] in C# and compiled languages via GDExtension, but [method push_buffer] may be [i]less[/i] efficient in GDScript. </description> </method> <method name="push_frame"> <return type="bool" /> - <argument index="0" name="frame" type="Vector2" /> + <param index="0" name="frame" type="Vector2" /> <description> Pushes a single audio data frame to the buffer. This is usually less efficient than [method push_buffer] in C# and compiled languages via GDExtension, but [method push_frame] may be [i]more[/i] efficient in GDScript. </description> diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml index f1a1c18c1c..e80c112f16 100644 --- a/doc/classes/AudioStreamPlayback.xml +++ b/doc/classes/AudioStreamPlayback.xml @@ -27,21 +27,21 @@ </method> <method name="_mix" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="buffer" type="AudioFrame*" /> - <argument index="1" name="rate_scale" type="float" /> - <argument index="2" name="frames" type="int" /> + <param index="0" name="buffer" type="AudioFrame*" /> + <param index="1" name="rate_scale" type="float" /> + <param index="2" name="frames" type="int" /> <description> </description> </method> <method name="_seek" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="position" type="float" /> + <param index="0" name="position" type="float" /> <description> </description> </method> <method name="_start" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="from_pos" type="float" /> + <param index="0" name="from_pos" type="float" /> <description> </description> </method> diff --git a/doc/classes/AudioStreamPlaybackResampled.xml b/doc/classes/AudioStreamPlaybackResampled.xml index eb41e4256e..cc2268f145 100644 --- a/doc/classes/AudioStreamPlaybackResampled.xml +++ b/doc/classes/AudioStreamPlaybackResampled.xml @@ -14,8 +14,8 @@ </method> <method name="_mix_resampled" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="dst_buffer" type="AudioFrame*" /> - <argument index="1" name="frame_count" type="int" /> + <param index="0" name="dst_buffer" type="AudioFrame*" /> + <param index="1" name="frame_count" type="int" /> <description> </description> </method> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index e0bc98e208..29dbb1c1c9 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -30,14 +30,14 @@ </method> <method name="play"> <return type="void" /> - <argument index="0" name="from_position" type="float" default="0.0" /> + <param index="0" name="from_position" type="float" default="0.0" /> <description> Plays the audio from the given [code]from_position[/code], in seconds. </description> </method> <method name="seek"> <return type="void" /> - <argument index="0" name="to_position" type="float" /> + <param index="0" name="to_position" type="float" /> <description> Sets the position from which audio will be played, in seconds. </description> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index f04f95bd72..4c3e675c41 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -26,14 +26,14 @@ </method> <method name="play"> <return type="void" /> - <argument index="0" name="from_position" type="float" default="0.0" /> + <param index="0" name="from_position" type="float" default="0.0" /> <description> Plays the audio from the given position [code]from_position[/code], in seconds. </description> </method> <method name="seek"> <return type="void" /> - <argument index="0" name="to_position" type="float" /> + <param index="0" name="to_position" type="float" /> <description> Sets the position from which audio will be played, in seconds. </description> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 72febf7006..9b86a93e74 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -27,14 +27,14 @@ </method> <method name="play"> <return type="void" /> - <argument index="0" name="from_position" type="float" default="0.0" /> + <param index="0" name="from_position" type="float" default="0.0" /> <description> Plays the audio from the given position [code]from_position[/code], in seconds. </description> </method> <method name="seek"> <return type="void" /> - <argument index="0" name="to_position" type="float" /> + <param index="0" name="to_position" type="float" /> <description> Sets the position from which audio will be played, in seconds. </description> diff --git a/doc/classes/AudioStreamRandomizer.xml b/doc/classes/AudioStreamRandomizer.xml index 0eb733582a..5490770b7d 100644 --- a/doc/classes/AudioStreamRandomizer.xml +++ b/doc/classes/AudioStreamRandomizer.xml @@ -11,52 +11,52 @@ <methods> <method name="add_stream"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Insert a stream at the specified index. </description> </method> <method name="get_stream" qualifiers="const"> <return type="AudioStream" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the stream at the specified index. </description> </method> <method name="get_stream_probability_weight" qualifiers="const"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the probability weight associated with the stream at the given index. </description> </method> <method name="move_stream"> <return type="void" /> - <argument index="0" name="index_from" type="int" /> - <argument index="1" name="index_to" type="int" /> + <param index="0" name="index_from" type="int" /> + <param index="1" name="index_to" type="int" /> <description> Move a stream from one index to another. </description> </method> <method name="remove_stream"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Remove the stream at the specified index. </description> </method> <method name="set_stream"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="stream" type="AudioStream" /> + <param index="0" name="index" type="int" /> + <param index="1" name="stream" type="AudioStream" /> <description> Set the AudioStream at the specified index. </description> </method> <method name="set_stream_probability_weight"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="index" type="int" /> + <param index="1" name="weight" type="float" /> <description> Set the probability weight of the stream at the specified index. The higher this value, the more likely that the randomizer will choose this stream during random playback modes. </description> diff --git a/doc/classes/AudioStreamWAV.xml b/doc/classes/AudioStreamWAV.xml index 17595aec2f..1055fe053e 100644 --- a/doc/classes/AudioStreamWAV.xml +++ b/doc/classes/AudioStreamWAV.xml @@ -12,7 +12,7 @@ <methods> <method name="save_to_wav"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Saves the AudioStreamWAV as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved. [b]Note:[/b] A [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing. diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 13fe75a3e3..0d934f861d 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -17,7 +17,7 @@ </method> <method name="_toggled" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="button_pressed" type="bool" /> + <param index="0" name="button_pressed" type="bool" /> <description> Called when the button is toggled (only if [member toggle_mode] is active). </description> @@ -36,7 +36,7 @@ </method> <method name="set_pressed_no_signal"> <return type="void" /> - <argument index="0" name="pressed" type="bool" /> + <param index="0" name="pressed" type="bool" /> <description> Changes the [member button_pressed] state of the button, without emitting [signal toggled]. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if [member toggle_mode] is [code]true[/code]. [b]Note:[/b] This method doesn't unpress other buttons in [member button_group]. @@ -96,7 +96,7 @@ </description> </signal> <signal name="toggled"> - <argument index="0" name="button_pressed" type="bool" /> + <param index="0" name="button_pressed" type="bool" /> <description> Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [code]button_pressed[/code] argument. </description> diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index d0290ff5fd..93818e6cfc 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -12,45 +12,45 @@ <methods> <method name="get_feature" qualifiers="const"> <return type="bool" /> - <argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" /> + <param index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" /> <description> Returns [code]true[/code], if the specified [enum Feature] is enabled. </description> </method> <method name="get_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" /> + <param index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" /> <description> Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options. </description> </method> <method name="get_texture" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" /> + <param index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" /> <description> Returns the [Texture] associated with the specified [enum TextureParam]. </description> </method> <method name="set_feature"> <return type="void" /> - <argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [BaseMaterial3D]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code]. </description> </method> <method name="set_flag"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options. </description> </method> <method name="set_texture"> <return type="void" /> - <argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" /> + <param index="1" name="texture" type="Texture2D" /> <description> Sets the texture for the slot specified by [code]param[/code]. See [enum TextureParam] for available slots. </description> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 0af482d654..36242a4402 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -27,31 +27,31 @@ </constructor> <constructor name="Basis"> <return type="Basis" /> - <argument index="0" name="from" type="Basis" /> + <param index="0" name="from" type="Basis" /> <description> Constructs a [Basis] as a copy of the given [Basis]. </description> </constructor> <constructor name="Basis"> <return type="Basis" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]angle[/code] (in radians). The axis must be a normalized vector. </description> </constructor> <constructor name="Basis"> <return type="Basis" /> - <argument index="0" name="from" type="Quaternion" /> + <param index="0" name="from" type="Quaternion" /> <description> Constructs a pure rotation basis matrix from the given quaternion. </description> </constructor> <constructor name="Basis"> <return type="Basis" /> - <argument index="0" name="x_axis" type="Vector3" /> - <argument index="1" name="y_axis" type="Vector3" /> - <argument index="2" name="z_axis" type="Vector3" /> + <param index="0" name="x_axis" type="Vector3" /> + <param index="1" name="y_axis" type="Vector3" /> + <param index="2" name="z_axis" type="Vector3" /> <description> Constructs a basis matrix from 3 axis vectors (matrix columns). </description> @@ -67,21 +67,21 @@ </method> <method name="from_euler" qualifiers="static"> <return type="Basis" /> - <argument index="0" name="euler" type="Vector3" /> - <argument index="1" name="order" type="int" default="2" /> + <param index="0" name="euler" type="Vector3" /> + <param index="1" name="order" type="int" default="2" /> <description> </description> </method> <method name="from_scale" qualifiers="static"> <return type="Basis" /> - <argument index="0" name="scale" type="Vector3" /> + <param index="0" name="scale" type="Vector3" /> <description> Constructs a pure scale basis matrix with no rotation or shearing. The scale values are set as the diagonal of the matrix, and the other parts of the matrix are zero. </description> </method> <method name="get_euler" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="order" type="int" default="2" /> + <param index="0" name="order" type="int" default="2" /> <description> Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). Consider using the [method get_rotation_quaternion] method instead, which returns a [Quaternion] quaternion instead of Euler angles. @@ -113,15 +113,15 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="b" type="Basis" /> + <param index="0" name="b" type="Basis" /> <description> Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. </description> </method> <method name="looking_at" qualifiers="static"> <return type="Basis" /> - <argument index="0" name="target" type="Vector3" /> - <argument index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" /> + <param index="0" name="target" type="Vector3" /> + <param index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" /> <description> Creates a Basis with a rotation such that the forward axis (-Z) points towards the [code]target[/code] position. The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The [code]target[/code] and [code]up[/code] vectors cannot be zero, and cannot be parallel to each other. @@ -135,44 +135,44 @@ </method> <method name="rotated" qualifiers="const"> <return type="Basis" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Introduce an additional rotation around the given axis by [code]angle[/code] (in radians). The axis must be a normalized vector. </description> </method> <method name="scaled" qualifiers="const"> <return type="Basis" /> - <argument index="0" name="scale" type="Vector3" /> + <param index="0" name="scale" type="Vector3" /> <description> Introduce an additional scaling specified by the given 3D scaling factor. </description> </method> <method name="slerp" qualifiers="const"> <return type="Basis" /> - <argument index="0" name="to" type="Basis" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Basis" /> + <param index="1" name="weight" type="float" /> <description> Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. </description> </method> <method name="tdotx" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Vector3" /> + <param index="0" name="with" type="Vector3" /> <description> Transposed dot product with the X axis of the matrix. </description> </method> <method name="tdoty" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Vector3" /> + <param index="0" name="with" type="Vector3" /> <description> Transposed dot product with the Y axis of the matrix. </description> </method> <method name="tdotz" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Vector3" /> + <param index="0" name="with" type="Vector3" /> <description> Transposed dot product with the Z axis of the matrix. </description> @@ -225,7 +225,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Basis" /> + <param index="0" name="right" type="Basis" /> <description> Returns [code]true[/code] if the [Basis] matrices are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -233,35 +233,35 @@ </operator> <operator name="operator *"> <return type="Basis" /> - <argument index="0" name="right" type="Basis" /> + <param index="0" name="right" type="Basis" /> <description> Composes these two basis matrices by multiplying them together. This has the effect of transforming the second basis (the child) by the first basis (the parent). </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Transforms (multiplies) the [Vector3] by the given [Basis] matrix. </description> </operator> <operator name="operator *"> <return type="Basis" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> This operator multiplies all components of the [Basis], which scales it uniformly. </description> </operator> <operator name="operator *"> <return type="Basis" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> This operator multiplies all components of the [Basis], which scales it uniformly. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Basis" /> + <param index="0" name="right" type="Basis" /> <description> Returns [code]true[/code] if the [Basis] matrices are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -269,7 +269,7 @@ </operator> <operator name="operator []"> <return type="Vector3" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access basis components using their index. [code]b[0][/code] is equivalent to [code]b.x[/code], [code]b[1][/code] is equivalent to [code]b.y[/code], and [code]b[2][/code] is equivalent to [code]b.z[/code]. </description> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index f248bec15f..402fc18373 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -17,22 +17,22 @@ </method> <method name="create"> <return type="void" /> - <argument index="0" name="size" type="Vector2" /> + <param index="0" name="size" type="Vector2" /> <description> Creates a bitmap with the specified size, filled with [code]false[/code]. </description> </method> <method name="create_from_image_alpha"> <return type="void" /> - <argument index="0" name="image" type="Image" /> - <argument index="1" name="threshold" type="float" default="0.1" /> + <param index="0" name="image" type="Image" /> + <param index="1" name="threshold" type="float" default="0.1" /> <description> Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to [code]false[/code] if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and [code]true[/code] in other case. </description> </method> <method name="get_bit" qualifiers="const"> <return type="bool" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Returns bitmap's value at the specified position. </description> @@ -51,16 +51,16 @@ </method> <method name="grow_mask"> <return type="void" /> - <argument index="0" name="pixels" type="int" /> - <argument index="1" name="rect" type="Rect2" /> + <param index="0" name="pixels" type="int" /> + <param index="1" name="rect" type="Rect2" /> <description> Applies morphological dilation or erosion to the bitmap. If [code]pixels[/code] is positive, dilation is applied to the bitmap. If [code]pixels[/code] is negative, erosion is applied to the bitmap. [code]rect[/code] defines the area where the morphological operation is applied. Pixels located outside the [code]rect[/code] are unaffected by [method grow_mask]. </description> </method> <method name="opaque_to_polygons" qualifiers="const"> <return type="Array" /> - <argument index="0" name="rect" type="Rect2" /> - <argument index="1" name="epsilon" type="float" default="2.0" /> + <param index="0" name="rect" type="Rect2" /> + <param index="1" name="epsilon" type="float" default="2.0" /> <description> Creates an [Array] of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a [PackedVector2Array] of its vertices. To get polygons covering the whole bitmap, pass: @@ -72,23 +72,23 @@ </method> <method name="resize"> <return type="void" /> - <argument index="0" name="new_size" type="Vector2" /> + <param index="0" name="new_size" type="Vector2" /> <description> Resizes the image to [code]new_size[/code]. </description> </method> <method name="set_bit"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="bit" type="bool" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="bit" type="bool" /> <description> Sets the bitmap's element at the specified position, to the specified value. </description> </method> <method name="set_bit_rect"> <return type="void" /> - <argument index="0" name="rect" type="Rect2" /> - <argument index="1" name="bit" type="bool" /> + <param index="0" name="rect" type="Rect2" /> + <param index="1" name="bit" type="bool" /> <description> Sets a rectangular portion of the bitmap to the specified value. </description> diff --git a/doc/classes/Bone2D.xml b/doc/classes/Bone2D.xml index 1e09e90d4a..d452edd1aa 100644 --- a/doc/classes/Bone2D.xml +++ b/doc/classes/Bone2D.xml @@ -57,14 +57,14 @@ </method> <method name="set_autocalculate_length_and_angle"> <return type="void" /> - <argument index="0" name="auto_calculate" type="bool" /> + <param index="0" name="auto_calculate" type="bool" /> <description> When set to [code]true[/code], the [code]Bone2D[/code] node will attempt to automatically calculate the bone angle and length using the first child [code]Bone2D[/code] node, if one exists. If none exist, the [code]Bone2D[/code] cannot automatically calculate these values and will print a warning. </description> </method> <method name="set_bone_angle"> <return type="void" /> - <argument index="0" name="angle" type="float" /> + <param index="0" name="angle" type="float" /> <description> Sets the bone angle for the [code]Bone2D[/code] node. This is typically set to the rotation from the [code]Bone2D[/code] node to a child [code]Bone2D[/code] node. [b]Note:[/b] This is different from the [code]Bone2D[/code]'s rotation. The bone angle is the rotation of the bone shown by the [code]Bone2D[/code] gizmo, and because [code]Bone2D[/code] bones are based on positions, this can vary from the actual rotation of the [code]Bone2D[/code] node. @@ -72,14 +72,14 @@ </method> <method name="set_default_length"> <return type="void" /> - <argument index="0" name="default_length" type="float" /> + <param index="0" name="default_length" type="float" /> <description> Deprecated. Please use [code]set_length[/code] instead. </description> </method> <method name="set_length"> <return type="void" /> - <argument index="0" name="length" type="float" /> + <param index="0" name="length" type="float" /> <description> Sets the length of the bone in the [code]Bone2D[/code] node. </description> diff --git a/doc/classes/BoneAttachment3D.xml b/doc/classes/BoneAttachment3D.xml index bb4b45cd48..dc3d448621 100644 --- a/doc/classes/BoneAttachment3D.xml +++ b/doc/classes/BoneAttachment3D.xml @@ -36,35 +36,35 @@ </method> <method name="on_bone_pose_update"> <return type="void" /> - <argument index="0" name="bone_index" type="int" /> + <param index="0" name="bone_index" type="int" /> <description> A function that is called automatically when the [Skeleton3D] the BoneAttachment3D node is using has a bone that has changed its pose. This function is where the BoneAttachment3D node updates its position so it is correctly bound when it is [i]not[/i] set to override the bone pose. </description> </method> <method name="set_external_skeleton"> <return type="void" /> - <argument index="0" name="external_skeleton" type="NodePath" /> + <param index="0" name="external_skeleton" type="NodePath" /> <description> Sets the [NodePath] to the external skeleton that the BoneAttachment3D node should use. The external [Skeleton3D] node is only used when [code]use_external_skeleton[/code] is set to [code]true[/code]. </description> </method> <method name="set_override_mode"> <return type="void" /> - <argument index="0" name="override_mode" type="int" /> + <param index="0" name="override_mode" type="int" /> <description> Sets the override mode for the BoneAttachment3D node. The override mode defines which of the bone poses the BoneAttachment3D node will override. </description> </method> <method name="set_override_pose"> <return type="void" /> - <argument index="0" name="override_pose" type="bool" /> + <param index="0" name="override_pose" type="bool" /> <description> Sets whether the BoneAttachment3D node will override the bone pose of the bone it is attached to. When set to [code]true[/code], the BoneAttachment3D node can change the pose of the bone. </description> </method> <method name="set_use_external_skeleton"> <return type="void" /> - <argument index="0" name="use_external_skeleton" type="bool" /> + <param index="0" name="use_external_skeleton" type="bool" /> <description> Sets whether the BoneAttachment3D node will use an extenral [Skeleton3D] node rather than attenpting to use its parent node as the [Skeleton3D]. When set to [code]true[/code], the BoneAttachment3D node will use the external [Skeleton3D] node set in [code]set_external_skeleton[/code]. </description> diff --git a/doc/classes/BoneMap.xml b/doc/classes/BoneMap.xml index 371cb4fa93..e9142e2c4b 100644 --- a/doc/classes/BoneMap.xml +++ b/doc/classes/BoneMap.xml @@ -12,7 +12,7 @@ <methods> <method name="find_profile_bone_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="skeleton_bone_name" type="StringName" /> + <param index="0" name="skeleton_bone_name" type="StringName" /> <description> Returns a profile bone name having [code]skeleton_bone_name[/code]. If not found, an empty [StringName] will be returned. In the retargeting process, the returned bone name is the bone name of the target skeleton. @@ -20,7 +20,7 @@ </method> <method name="get_skeleton_bone_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="profile_bone_name" type="StringName" /> + <param index="0" name="profile_bone_name" type="StringName" /> <description> Returns a skeleton bone name is mapped to [code]profile_bone_name[/code]. In the retargeting process, the returned bone name is the bone name of the source skeleton. @@ -28,8 +28,8 @@ </method> <method name="set_skeleton_bone_name"> <return type="void" /> - <argument index="0" name="profile_bone_name" type="StringName" /> - <argument index="1" name="skeleton_bone_name" type="StringName" /> + <param index="0" name="profile_bone_name" type="StringName" /> + <param index="1" name="skeleton_bone_name" type="StringName" /> <description> Maps a skeleton bone name to [code]profile_bone_name[/code]. In the retargeting process, the setting bone name is the bone name of the source skeleton. diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index c76a178368..d7eac40505 100644 --- a/doc/classes/BoxContainer.xml +++ b/doc/classes/BoxContainer.xml @@ -12,7 +12,7 @@ <methods> <method name="add_spacer"> <return type="Control" /> - <argument index="0" name="begin" type="bool" /> + <param index="0" name="begin" type="bool" /> <description> Adds a [Control] node to the box as a spacer. If [code]begin[/code] is [code]true[/code], it will insert the [Control] node in front of all other children. </description> diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml index a887404932..8bedb5a1ac 100644 --- a/doc/classes/ButtonGroup.xml +++ b/doc/classes/ButtonGroup.xml @@ -28,7 +28,7 @@ </members> <signals> <signal name="pressed"> - <argument index="0" name="button" type="BaseButton" /> + <param index="0" name="button" type="BaseButton" /> <description> Emitted when one of the buttons of the group is pressed. </description> diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index b0282e4107..64e9310181 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -13,33 +13,33 @@ <methods> <method name="convert_from_particles"> <return type="void" /> - <argument index="0" name="particles" type="Node" /> + <param index="0" name="particles" type="Node" /> <description> Sets this node's properties to match a given [GPUParticles2D] node with an assigned [ParticlesMaterial]. </description> </method> <method name="get_param_curve" qualifiers="const"> <return type="Curve" /> - <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> + <param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> <description> Returns the [Curve] of the parameter specified by [enum Parameter]. </description> </method> <method name="get_param_max" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> + <param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> <description> </description> </method> <method name="get_param_min" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> + <param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> <description> </description> </method> <method name="get_particle_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" /> + <param index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" /> <description> Returns the enabled state of the given flag (see [enum ParticleFlags] for options). </description> @@ -52,30 +52,30 @@ </method> <method name="set_param_curve"> <return type="void" /> - <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> - <argument index="1" name="curve" type="Curve" /> + <param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> + <param index="1" name="curve" type="Curve" /> <description> Sets the [Curve] of the parameter specified by [enum Parameter]. </description> </method> <method name="set_param_max"> <return type="void" /> - <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> + <param index="1" name="value" type="float" /> <description> </description> </method> <method name="set_param_min"> <return type="void" /> - <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" /> + <param index="1" name="value" type="float" /> <description> </description> </method> <method name="set_particle_flag"> <return type="void" /> - <argument index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" /> + <param index="1" name="enable" type="bool" /> <description> Enables or disables the given flag (see [enum ParticleFlags] for options). </description> diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index d8faf8e91d..bb1dcd322f 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -12,33 +12,33 @@ <methods> <method name="convert_from_particles"> <return type="void" /> - <argument index="0" name="particles" type="Node" /> + <param index="0" name="particles" type="Node" /> <description> Sets this node's properties to match a given [GPUParticles3D] node with an assigned [ParticlesMaterial]. </description> </method> <method name="get_param_curve" qualifiers="const"> <return type="Curve" /> - <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> + <param index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> <description> Returns the [Curve] of the parameter specified by [enum Parameter]. </description> </method> <method name="get_param_max" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> + <param index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> <description> </description> </method> <method name="get_param_min" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> + <param index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> <description> </description> </method> <method name="get_particle_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="particle_flag" type="int" enum="CPUParticles3D.ParticleFlags" /> + <param index="0" name="particle_flag" type="int" enum="CPUParticles3D.ParticleFlags" /> <description> Returns the enabled state of the given particle flag (see [enum ParticleFlags] for options). </description> @@ -51,32 +51,32 @@ </method> <method name="set_param_curve"> <return type="void" /> - <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> - <argument index="1" name="curve" type="Curve" /> + <param index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> + <param index="1" name="curve" type="Curve" /> <description> Sets the [Curve] of the parameter specified by [enum Parameter]. </description> </method> <method name="set_param_max"> <return type="void" /> - <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> + <param index="1" name="value" type="float" /> <description> Sets the maximum value for the given parameter </description> </method> <method name="set_param_min"> <return type="void" /> - <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="CPUParticles3D.Parameter" /> + <param index="1" name="value" type="float" /> <description> Sets the minimum value for the given parameter </description> </method> <method name="set_particle_flag"> <return type="void" /> - <argument index="0" name="particle_flag" type="int" enum="CPUParticles3D.ParticleFlags" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="particle_flag" type="int" enum="CPUParticles3D.ParticleFlags" /> + <param index="1" name="enable" type="bool" /> <description> Enables or disables the given particle flag (see [enum ParticleFlags] for options). </description> diff --git a/doc/classes/Callable.xml b/doc/classes/Callable.xml index efe3e3d091..48c1b30d8e 100644 --- a/doc/classes/Callable.xml +++ b/doc/classes/Callable.xml @@ -44,15 +44,15 @@ </constructor> <constructor name="Callable"> <return type="Callable" /> - <argument index="0" name="from" type="Callable" /> + <param index="0" name="from" type="Callable" /> <description> Constructs a [Callable] as a copy of the given [Callable]. </description> </constructor> <constructor name="Callable"> <return type="Callable" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="method" type="StringName" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="method" type="StringName" /> <description> Creates a new [Callable] for the method called [code]method[/code] in the specified [code]object[/code]. </description> @@ -134,14 +134,14 @@ </method> <method name="rpc_id" qualifiers="vararg const"> <return type="void" /> - <argument index="0" name="peer_id" type="int" /> + <param index="0" name="peer_id" type="int" /> <description> Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as [i]RPC[/i]. Calling it on unsupported functions will result in an error. </description> </method> <method name="unbind" qualifiers="const"> <return type="Callable" /> - <argument index="0" name="argcount" type="int" /> + <param index="0" name="argcount" type="int" /> <description> Returns a copy of this [Callable] with the arguments unbound. Calling the returned [Callable] will call the method without the extra arguments that are supplied in the [Callable] on which you are calling this method. </description> @@ -150,14 +150,14 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Callable" /> + <param index="0" name="right" type="Callable" /> <description> Returns [code]true[/code] if both [Callable]s invoke different targets. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Callable" /> + <param index="0" name="right" type="Callable" /> <description> Returns [code]true[/code] if both [Callable]s invoke the same custom target. </description> diff --git a/doc/classes/CallbackTweener.xml b/doc/classes/CallbackTweener.xml index 3d80d8f3ab..6e4ee0380e 100644 --- a/doc/classes/CallbackTweener.xml +++ b/doc/classes/CallbackTweener.xml @@ -12,7 +12,7 @@ <methods> <method name="set_delay"> <return type="CallbackTweener" /> - <argument index="0" name="delay" type="float" /> + <param index="0" name="delay" type="float" /> <description> Makes the callback call delayed by given time in seconds. Example: [codeblock] diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index b9373676e2..edb5235b75 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -43,14 +43,14 @@ </method> <method name="get_drag_margin" qualifiers="const"> <return type="float" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin]. </description> </method> <method name="get_limit" qualifiers="const"> <return type="int" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. </description> @@ -64,16 +64,16 @@ </method> <method name="set_drag_margin"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="drag_margin" type="float" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="drag_margin" type="float" /> <description> Sets the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin]. </description> </method> <method name="set_limit"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="limit" type="int" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="limit" type="int" /> <description> Sets the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. </description> diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index 643351efc0..71d16b5791 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -12,7 +12,7 @@ <methods> <method name="clear_current"> <return type="void" /> - <argument index="0" name="enable_next" type="bool" default="true" /> + <param index="0" name="enable_next" type="bool" default="true" /> <description> If this is the current camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next camera current, if any. </description> @@ -31,7 +31,7 @@ </method> <method name="get_cull_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member cull_mask] is enabled, given a [code]layer_number[/code] between 1 and 20. </description> @@ -50,7 +50,7 @@ </method> <method name="is_position_behind" qualifiers="const"> <return type="bool" /> - <argument index="0" name="world_point" type="Vector3" /> + <param index="0" name="world_point" type="Vector3" /> <description> Returns [code]true[/code] if the given position is behind the camera (the blue part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods. [b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view. @@ -58,7 +58,7 @@ </method> <method name="is_position_in_frustum" qualifiers="const"> <return type="bool" /> - <argument index="0" name="world_point" type="Vector3" /> + <param index="0" name="world_point" type="Vector3" /> <description> Returns [code]true[/code] if the given position is inside the camera's frustum (the green part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods. </description> @@ -71,72 +71,72 @@ </method> <method name="project_local_ray_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="screen_point" type="Vector2" /> + <param index="0" name="screen_point" type="Vector2" /> <description> Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. </description> </method> <method name="project_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="screen_point" type="Vector2" /> - <argument index="1" name="z_depth" type="float" /> + <param index="0" name="screen_point" type="Vector2" /> + <param index="1" name="z_depth" type="float" /> <description> Returns the 3D point in world space that maps to the given 2D coordinate in the [Viewport] rectangle on a plane that is the given [code]z_depth[/code] distance into the scene away from the camera. </description> </method> <method name="project_ray_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="screen_point" type="Vector2" /> + <param index="0" name="screen_point" type="Vector2" /> <description> Returns a normal vector in world space, that is the result of projecting a point on the [Viewport] rectangle by the inverse camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. </description> </method> <method name="project_ray_origin" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="screen_point" type="Vector2" /> + <param index="0" name="screen_point" type="Vector2" /> <description> Returns a 3D position in world space, that is the result of projecting a point on the [Viewport] rectangle by the inverse camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. </description> </method> <method name="set_cull_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member cull_mask], given a [code]layer_number[/code] between 1 and 20. </description> </method> <method name="set_frustum"> <return type="void" /> - <argument index="0" name="size" type="float" /> - <argument index="1" name="offset" type="Vector2" /> - <argument index="2" name="z_near" type="float" /> - <argument index="3" name="z_far" type="float" /> + <param index="0" name="size" type="float" /> + <param index="1" name="offset" type="Vector2" /> + <param index="2" name="z_near" type="float" /> + <param index="3" name="z_far" type="float" /> <description> Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [code]size[/code], an [code]offset[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. See also [member frustum_offset]. </description> </method> <method name="set_orthogonal"> <return type="void" /> - <argument index="0" name="size" type="float" /> - <argument index="1" name="z_near" type="float" /> - <argument index="2" name="z_far" type="float" /> + <param index="0" name="size" type="float" /> + <param index="1" name="z_near" type="float" /> + <param index="2" name="z_far" type="float" /> <description> Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [code]size[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.) </description> </method> <method name="set_perspective"> <return type="void" /> - <argument index="0" name="fov" type="float" /> - <argument index="1" name="z_near" type="float" /> - <argument index="2" name="z_far" type="float" /> + <param index="0" name="fov" type="float" /> + <param index="1" name="z_near" type="float" /> + <param index="2" name="z_far" type="float" /> <description> Sets the camera projection to perspective mode (see [constant PROJECTION_PERSPECTIVE]), by specifying a [code]fov[/code] (field of view) angle in degrees, and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. </description> </method> <method name="unproject_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="world_point" type="Vector3" /> + <param index="0" name="world_point" type="Vector3" /> <description> Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in world space. [b]Note:[/b] When using this to position GUI elements over a 3D viewport, use [method is_position_behind] to prevent them from appearing if the 3D point is behind the camera: diff --git a/doc/classes/CameraServer.xml b/doc/classes/CameraServer.xml index 1ccdee58f7..7ec49c7df4 100644 --- a/doc/classes/CameraServer.xml +++ b/doc/classes/CameraServer.xml @@ -13,7 +13,7 @@ <methods> <method name="add_feed"> <return type="void" /> - <argument index="0" name="feed" type="CameraFeed" /> + <param index="0" name="feed" type="CameraFeed" /> <description> Adds the camera [code]feed[/code] to the camera server. </description> @@ -26,7 +26,7 @@ </method> <method name="get_feed"> <return type="CameraFeed" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the [CameraFeed] corresponding to the camera with the given [code]index[/code]. </description> @@ -39,7 +39,7 @@ </method> <method name="remove_feed"> <return type="void" /> - <argument index="0" name="feed" type="CameraFeed" /> + <param index="0" name="feed" type="CameraFeed" /> <description> Removes the specified camera [code]feed[/code]. </description> @@ -47,13 +47,13 @@ </methods> <signals> <signal name="camera_feed_added"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when a [CameraFeed] is added (e.g. a webcam is plugged in). </description> </signal> <signal name="camera_feed_removed"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when a [CameraFeed] is removed (e.g. a webcam is unplugged). </description> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 2d68ae6902..391ff1efb1 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -25,77 +25,77 @@ </method> <method name="draw_animation_slice"> <return type="void" /> - <argument index="0" name="animation_length" type="float" /> - <argument index="1" name="slice_begin" type="float" /> - <argument index="2" name="slice_end" type="float" /> - <argument index="3" name="offset" type="float" default="0.0" /> + <param index="0" name="animation_length" type="float" /> + <param index="1" name="slice_begin" type="float" /> + <param index="2" name="slice_end" type="float" /> + <param index="3" name="offset" type="float" default="0.0" /> <description> Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. </description> </method> <method name="draw_arc"> <return type="void" /> - <argument index="0" name="center" type="Vector2" /> - <argument index="1" name="radius" type="float" /> - <argument index="2" name="start_angle" type="float" /> - <argument index="3" name="end_angle" type="float" /> - <argument index="4" name="point_count" type="int" /> - <argument index="5" name="color" type="Color" /> - <argument index="6" name="width" type="float" default="1.0" /> - <argument index="7" name="antialiased" type="bool" default="false" /> + <param index="0" name="center" type="Vector2" /> + <param index="1" name="radius" type="float" /> + <param index="2" name="start_angle" type="float" /> + <param index="3" name="end_angle" type="float" /> + <param index="4" name="point_count" type="int" /> + <param index="5" name="color" type="Color" /> + <param index="6" name="width" type="float" default="1.0" /> + <param index="7" name="antialiased" type="bool" default="false" /> <description> Draws a unfilled arc between the given angles. The larger the value of [code]point_count[/code], the smoother the curve. See also [method draw_circle]. </description> </method> <method name="draw_char" qualifiers="const"> <return type="void" /> - <argument index="0" name="font" type="Font" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="char" type="String" /> - <argument index="3" name="font_size" type="int" default="16" /> - <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="font" type="Font" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="char" type="String" /> + <param index="3" name="font_size" type="int" default="16" /> + <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draws a string first character using a custom font. </description> </method> <method name="draw_char_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="font" type="Font" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="char" type="String" /> - <argument index="3" name="font_size" type="int" default="16" /> - <argument index="4" name="size" type="int" default="-1" /> - <argument index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="font" type="Font" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="char" type="String" /> + <param index="3" name="font_size" type="int" default="16" /> + <param index="4" name="size" type="int" default="-1" /> + <param index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draws a string first character outline using a custom font. </description> </method> <method name="draw_circle"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="radius" type="float" /> - <argument index="2" name="color" type="Color" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="radius" type="float" /> + <param index="2" name="color" type="Color" /> <description> Draws a colored, filled circle. See also [method draw_arc], [method draw_polyline] and [method draw_polygon]. </description> </method> <method name="draw_colored_polygon"> <return type="void" /> - <argument index="0" name="points" type="PackedVector2Array" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> - <argument index="3" name="texture" type="Texture2D" default="null" /> + <param index="0" name="points" type="PackedVector2Array" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> + <param index="3" name="texture" type="Texture2D" default="null" /> <description> Draws a colored polygon of any amount of points, convex or concave. Unlike [method draw_polygon], a single color must be specified for the whole polygon. </description> </method> <method name="draw_dashed_line"> <return type="void" /> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> - <argument index="2" name="color" type="Color" /> - <argument index="3" name="width" type="float" default="1.0" /> - <argument index="4" name="dash" type="float" default="2.0" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> + <param index="2" name="color" type="Color" /> + <param index="3" name="width" type="float" default="1.0" /> + <param index="4" name="dash" type="float" default="2.0" /> <description> Draws a dashed line from a 2D point to another, with a given color and width. See also [method draw_multiline] and [method draw_polyline]. </description> @@ -108,33 +108,33 @@ </method> <method name="draw_line"> <return type="void" /> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> - <argument index="2" name="color" type="Color" /> - <argument index="3" name="width" type="float" default="1.0" /> - <argument index="4" name="antialiased" type="bool" default="false" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> + <param index="2" name="color" type="Color" /> + <param index="3" name="width" type="float" default="1.0" /> + <param index="4" name="antialiased" type="bool" default="false" /> <description> Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. See also [method draw_multiline] and [method draw_polyline]. </description> </method> <method name="draw_mesh"> <return type="void" /> - <argument index="0" name="mesh" type="Mesh" /> - <argument index="1" name="texture" type="Texture2D" /> - <argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> - <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="mesh" type="Mesh" /> + <param index="1" name="texture" type="Texture2D" /> + <param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> + <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draws a [Mesh] in 2D, using the provided texture. See [MeshInstance2D] for related documentation. </description> </method> <method name="draw_msdf_texture_rect_region"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="src_rect" type="Rect2" /> - <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="outline" type="float" default="0.0" /> - <argument index="5" name="pixel_range" type="float" default="4.0" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="src_rect" type="Rect2" /> + <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="outline" type="float" default="0.0" /> + <param index="5" name="pixel_range" type="float" default="4.0" /> <description> Draws a textured rectangle region of the multi-channel signed distance field texture at a given position, optionally modulated by a color. See [member FontFile.multichannel_signed_distance_field] for more information and caveats about MSDF font rendering. If [code]outline[/code] is positive, each alpha channel value of pixel in region is set to maximum value of true distance in the [code]outline[/code] radius. @@ -143,114 +143,114 @@ </method> <method name="draw_multiline"> <return type="void" /> - <argument index="0" name="points" type="PackedVector2Array" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="width" type="float" default="1.0" /> + <param index="0" name="points" type="PackedVector2Array" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="width" type="float" default="1.0" /> <description> Draws multiple disconnected lines with a uniform [code]color[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw interconnected lines, use [method draw_polyline] instead. </description> </method> <method name="draw_multiline_colors"> <return type="void" /> - <argument index="0" name="points" type="PackedVector2Array" /> - <argument index="1" name="colors" type="PackedColorArray" /> - <argument index="2" name="width" type="float" default="1.0" /> + <param index="0" name="points" type="PackedVector2Array" /> + <param index="1" name="colors" type="PackedColorArray" /> + <param index="2" name="width" type="float" default="1.0" /> <description> Draws multiple disconnected lines with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw interconnected lines, use [method draw_polyline_colors] instead. </description> </method> <method name="draw_multiline_string" qualifiers="const"> <return type="void" /> - <argument index="0" name="font" type="Font" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="text" type="String" /> - <argument index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="font_size" type="int" default="16" /> - <argument index="6" name="max_lines" type="int" default="-1" /> - <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="8" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> - <argument index="9" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="10" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="11" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="font" type="Font" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="text" type="String" /> + <param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="4" name="width" type="float" default="-1" /> + <param index="5" name="font_size" type="int" default="16" /> + <param index="6" name="max_lines" type="int" default="-1" /> + <param index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="8" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> + <param index="9" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="10" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="11" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Breaks [code]text[/code] to the lines and draws it using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. </description> </method> <method name="draw_multiline_string_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="font" type="Font" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="text" type="String" /> - <argument index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="font_size" type="int" default="16" /> - <argument index="6" name="max_lines" type="int" default="-1" /> - <argument index="7" name="size" type="int" default="1" /> - <argument index="8" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="9" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> - <argument index="10" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="11" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="12" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="font" type="Font" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="text" type="String" /> + <param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="4" name="width" type="float" default="-1" /> + <param index="5" name="font_size" type="int" default="16" /> + <param index="6" name="max_lines" type="int" default="-1" /> + <param index="7" name="size" type="int" default="1" /> + <param index="8" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="9" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> + <param index="10" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="11" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="12" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Breaks [code]text[/code] to the lines and draws text outline using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. </description> </method> <method name="draw_multimesh"> <return type="void" /> - <argument index="0" name="multimesh" type="MultiMesh" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="multimesh" type="MultiMesh" /> + <param index="1" name="texture" type="Texture2D" /> <description> Draws a [MultiMesh] in 2D with the provided texture. See [MultiMeshInstance2D] for related documentation. </description> </method> <method name="draw_polygon"> <return type="void" /> - <argument index="0" name="points" type="PackedVector2Array" /> - <argument index="1" name="colors" type="PackedColorArray" /> - <argument index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> - <argument index="3" name="texture" type="Texture2D" default="null" /> + <param index="0" name="points" type="PackedVector2Array" /> + <param index="1" name="colors" type="PackedColorArray" /> + <param index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> + <param index="3" name="texture" type="Texture2D" default="null" /> <description> Draws a solid polygon of any amount of points, convex or concave. Unlike [method draw_colored_polygon], each point's color can be changed individually. See also [method draw_polyline] and [method draw_polyline_colors]. </description> </method> <method name="draw_polyline"> <return type="void" /> - <argument index="0" name="points" type="PackedVector2Array" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="width" type="float" default="1.0" /> - <argument index="3" name="antialiased" type="bool" default="false" /> + <param index="0" name="points" type="PackedVector2Array" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="width" type="float" default="1.0" /> + <param index="3" name="antialiased" type="bool" default="false" /> <description> Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw disconnected lines, use [method draw_multiline] instead. See also [method draw_polygon]. </description> </method> <method name="draw_polyline_colors"> <return type="void" /> - <argument index="0" name="points" type="PackedVector2Array" /> - <argument index="1" name="colors" type="PackedColorArray" /> - <argument index="2" name="width" type="float" default="1.0" /> - <argument index="3" name="antialiased" type="bool" default="false" /> + <param index="0" name="points" type="PackedVector2Array" /> + <param index="1" name="colors" type="PackedColorArray" /> + <param index="2" name="width" type="float" default="1.0" /> + <param index="3" name="antialiased" type="bool" default="false" /> <description> Draws interconnected line segments with a uniform [code]width[/code] and segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw disconnected lines, use [method draw_multiline_colors] instead. See also [method draw_polygon]. </description> </method> <method name="draw_primitive"> <return type="void" /> - <argument index="0" name="points" type="PackedVector2Array" /> - <argument index="1" name="colors" type="PackedColorArray" /> - <argument index="2" name="uvs" type="PackedVector2Array" /> - <argument index="3" name="texture" type="Texture2D" default="null" /> - <argument index="4" name="width" type="float" default="1.0" /> + <param index="0" name="points" type="PackedVector2Array" /> + <param index="1" name="colors" type="PackedColorArray" /> + <param index="2" name="uvs" type="PackedVector2Array" /> + <param index="3" name="texture" type="Texture2D" default="null" /> + <param index="4" name="width" type="float" default="1.0" /> <description> Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. If 0 points or more than 4 points are specified, nothing will be drawn and an error message will be printed. See also [method draw_line], [method draw_polyline], [method draw_polygon], and [method draw_rect]. </description> </method> <method name="draw_rect"> <return type="void" /> - <argument index="0" name="rect" type="Rect2" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="filled" type="bool" default="true" /> - <argument index="3" name="width" type="float" default="1.0" /> + <param index="0" name="rect" type="Rect2" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="filled" type="bool" default="true" /> + <param index="3" name="width" type="float" default="1.0" /> <description> Draws a rectangle. If [code]filled[/code] is [code]true[/code], the rectangle will be filled with the [code]color[/code] specified. If [code]filled[/code] is [code]false[/code], the rectangle will be drawn as a stroke with the [code]color[/code] and [code]width[/code] specified. [b]Note:[/b] [code]width[/code] is only effective if [code]filled[/code] is [code]false[/code]. @@ -258,32 +258,32 @@ </method> <method name="draw_set_transform"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="rotation" type="float" default="0.0" /> - <argument index="2" name="scale" type="Vector2" default="Vector2(1, 1)" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="rotation" type="float" default="0.0" /> + <param index="2" name="scale" type="Vector2" default="Vector2(1, 1)" /> <description> Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. </description> </method> <method name="draw_set_transform_matrix"> <return type="void" /> - <argument index="0" name="xform" type="Transform2D" /> + <param index="0" name="xform" type="Transform2D" /> <description> Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. </description> </method> <method name="draw_string" qualifiers="const"> <return type="void" /> - <argument index="0" name="font" type="Font" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="text" type="String" /> - <argument index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="font_size" type="int" default="16" /> - <argument index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="7" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="8" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="9" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="font" type="Font" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="text" type="String" /> + <param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="4" name="width" type="float" default="-1" /> + <param index="5" name="font_size" type="int" default="16" /> + <param index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="7" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="8" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="9" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. [b]Example using the default project font:[/b] @@ -310,57 +310,57 @@ </method> <method name="draw_string_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="font" type="Font" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="text" type="String" /> - <argument index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="font_size" type="int" default="16" /> - <argument index="6" name="size" type="int" default="1" /> - <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="8" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="9" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="10" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="font" type="Font" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="text" type="String" /> + <param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="4" name="width" type="float" default="-1" /> + <param index="5" name="font_size" type="int" default="16" /> + <param index="6" name="size" type="int" default="1" /> + <param index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="8" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="9" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="10" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Draws [code]text[/code] outline using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. </description> </method> <method name="draw_style_box"> <return type="void" /> - <argument index="0" name="style_box" type="StyleBox" /> - <argument index="1" name="rect" type="Rect2" /> + <param index="0" name="style_box" type="StyleBox" /> + <param index="1" name="rect" type="Rect2" /> <description> Draws a styled rectangle. </description> </method> <method name="draw_texture"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="position" type="Vector2" /> - <argument index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="position" type="Vector2" /> + <param index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draws a texture at a given position. </description> </method> <method name="draw_texture_rect"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="tile" type="bool" /> - <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="transpose" type="bool" default="false" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="tile" type="bool" /> + <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="transpose" type="bool" default="false" /> <description> Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. </description> </method> <method name="draw_texture_rect_region"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="src_rect" type="Rect2" /> - <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="transpose" type="bool" default="false" /> - <argument index="5" name="clip_uv" type="bool" default="true" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="src_rect" type="Rect2" /> + <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="transpose" type="bool" default="false" /> + <param index="5" name="clip_uv" type="bool" default="true" /> <description> Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. </description> @@ -470,28 +470,28 @@ </method> <method name="make_canvas_position_local" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="screen_point" type="Vector2" /> + <param index="0" name="screen_point" type="Vector2" /> <description> Assigns [code]screen_point[/code] as this node's new local transform. </description> </method> <method name="make_input_local" qualifiers="const"> <return type="InputEvent" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. </description> </method> <method name="set_notify_local_transform"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> If [code]enable[/code] is [code]true[/code], this node will receive [constant NOTIFICATION_LOCAL_TRANSFORM_CHANGED] when its local transform changes. </description> </method> <method name="set_notify_transform"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> If [code]enable[/code] is [code]true[/code], this node will receive [constant NOTIFICATION_TRANSFORM_CHANGED] when its global transform changes. </description> diff --git a/doc/classes/CharacterBody2D.xml b/doc/classes/CharacterBody2D.xml index 63d493248f..4a95e18575 100644 --- a/doc/classes/CharacterBody2D.xml +++ b/doc/classes/CharacterBody2D.xml @@ -17,7 +17,7 @@ <methods> <method name="get_floor_angle" qualifiers="const"> <return type="float" /> - <argument index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" /> + <param index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" /> <description> Returns the floor's collision angle at the last collision point according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive and only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code]. </description> @@ -60,7 +60,7 @@ </method> <method name="get_slide_collision"> <return type="KinematicCollision2D" /> - <argument index="0" name="slide_idx" type="int" /> + <param index="0" name="slide_idx" type="int" /> <description> Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last call to [method move_and_slide]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_collision_count] - 1). [b]Example usage:[/b] diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml index 795bd7a429..73f4e1c82e 100644 --- a/doc/classes/CharacterBody3D.xml +++ b/doc/classes/CharacterBody3D.xml @@ -18,7 +18,7 @@ <methods> <method name="get_floor_angle" qualifiers="const"> <return type="float" /> - <argument index="0" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" /> + <param index="0" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" /> <description> Returns the floor's collision angle at the last collision point according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive and only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code]. </description> @@ -61,7 +61,7 @@ </method> <method name="get_slide_collision"> <return type="KinematicCollision3D" /> - <argument index="0" name="slide_idx" type="int" /> + <param index="0" name="slide_idx" type="int" /> <description> Returns a [KinematicCollision3D], which contains information about a collision that occurred during the last call to [method move_and_slide]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_collision_count] - 1). </description> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 43210de686..151b34c430 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -11,64 +11,64 @@ <methods> <method name="can_instantiate" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="StringName" /> + <param index="0" name="class" type="StringName" /> <description> Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case. </description> </method> <method name="class_exists" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="StringName" /> + <param index="0" name="class" type="StringName" /> <description> Returns whether the specified [code]class[/code] is available or not. </description> </method> <method name="class_get_enum_constants" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="enum" type="StringName" /> - <argument index="2" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="enum" type="StringName" /> + <param index="2" name="no_inheritance" type="bool" default="false" /> <description> Returns an array with all the keys in [code]enum[/code] of [code]class[/code] or its ancestry. </description> </method> <method name="class_get_enum_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="no_inheritance" type="bool" default="false" /> <description> Returns an array with all the enums of [code]class[/code] or its ancestry. </description> </method> <method name="class_get_integer_constant" qualifiers="const"> <return type="int" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="name" type="StringName" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="name" type="StringName" /> <description> Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found. </description> </method> <method name="class_get_integer_constant_enum" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="no_inheritance" type="bool" default="false" /> <description> Returns which enum the integer constant [code]name[/code] of [code]class[/code] or its ancestry belongs to. </description> </method> <method name="class_get_integer_constant_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="no_inheritance" type="bool" default="false" /> <description> Returns an array with the names all the integer constants of [code]class[/code] or its ancestry. </description> </method> <method name="class_get_method_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="no_inheritance" type="bool" default="false" /> <description> Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. [b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names. @@ -76,75 +76,75 @@ </method> <method name="class_get_property" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="property" type="StringName" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="property" type="StringName" /> <description> Returns the value of [code]property[/code] of [code]class[/code] or its ancestry. </description> </method> <method name="class_get_property_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="no_inheritance" type="bool" default="false" /> <description> Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. </description> </method> <method name="class_get_signal" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="signal" type="StringName" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="signal" type="StringName" /> <description> Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. </description> </method> <method name="class_get_signal_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="no_inheritance" type="bool" default="false" /> <description> Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal]. </description> </method> <method name="class_has_enum" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="no_inheritance" type="bool" default="false" /> <description> Returns whether [code]class[/code] or its ancestry has an enum called [code]name[/code] or not. </description> </method> <method name="class_has_integer_constant" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="name" type="StringName" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="name" type="StringName" /> <description> Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not. </description> </method> <method name="class_has_method" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="method" type="StringName" /> - <argument index="2" name="no_inheritance" type="bool" default="false" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="method" type="StringName" /> + <param index="2" name="no_inheritance" type="bool" default="false" /> <description> Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not. </description> </method> <method name="class_has_signal" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="signal" type="StringName" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="signal" type="StringName" /> <description> Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not. </description> </method> <method name="class_set_property" qualifiers="const"> <return type="int" enum="Error" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="property" type="StringName" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="property" type="StringName" /> + <param index="2" name="value" type="Variant" /> <description> Sets [code]property[/code] value of [code]class[/code] to [code]value[/code]. </description> @@ -157,36 +157,36 @@ </method> <method name="get_inheriters_from_class" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="class" type="StringName" /> + <param index="0" name="class" type="StringName" /> <description> Returns the names of all the classes that directly or indirectly inherit from [code]class[/code]. </description> </method> <method name="get_parent_class" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="class" type="StringName" /> + <param index="0" name="class" type="StringName" /> <description> Returns the parent class of [code]class[/code]. </description> </method> <method name="instantiate" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="class" type="StringName" /> + <param index="0" name="class" type="StringName" /> <description> Creates an instance of [code]class[/code]. </description> </method> <method name="is_class_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="StringName" /> + <param index="0" name="class" type="StringName" /> <description> Returns whether this [code]class[/code] is enabled or not. </description> </method> <method name="is_parent_class" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="StringName" /> - <argument index="1" name="inherits" type="StringName" /> + <param index="0" name="class" type="StringName" /> + <param index="1" name="inherits" type="StringName" /> <description> Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not. </description> diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index 4994ef352e..d9f8e17145 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -12,14 +12,14 @@ <methods> <method name="_confirm_code_completion" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="replace" type="bool" /> + <param index="0" name="replace" type="bool" /> <description> Override this method to define how the selected entry should be inserted. If [code]replace[/code] is true, any existing text should be replaced. </description> </method> <method name="_filter_code_completion_candidates" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="candidates" type="Dictionary[]" /> + <param index="0" name="candidates" type="Dictionary[]" /> <description> Override this method to define what items in [code]candidates[/code] should be displayed. Both [code]candidates[/code] and the return is a [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content. @@ -27,15 +27,15 @@ </method> <method name="_request_code_completion" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="force" type="bool" /> + <param index="0" name="force" type="bool" /> <description> Override this method to define what happens when the user requests code completion. If [code]force[/code] is true, any checks should be bypassed. </description> </method> <method name="add_auto_brace_completion_pair"> <return type="void" /> - <argument index="0" name="start_key" type="String" /> - <argument index="1" name="end_key" type="String" /> + <param index="0" name="start_key" type="String" /> + <param index="1" name="end_key" type="String" /> <description> Adds a brace pair. Both the start and end keys must be symbols. Only the start key has to be unique. @@ -43,12 +43,12 @@ </method> <method name="add_code_completion_option"> <return type="void" /> - <argument index="0" name="type" type="int" enum="CodeEdit.CodeCompletionKind" /> - <argument index="1" name="display_text" type="String" /> - <argument index="2" name="insert_text" type="String" /> - <argument index="3" name="text_color" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="icon" type="Resource" default="null" /> - <argument index="5" name="value" type="Variant" default="0" /> + <param index="0" name="type" type="int" enum="CodeEdit.CodeCompletionKind" /> + <param index="1" name="display_text" type="String" /> + <param index="2" name="insert_text" type="String" /> + <param index="3" name="text_color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="icon" type="Resource" default="null" /> + <param index="5" name="value" type="Variant" default="0" /> <description> Submits an item to the queue of potential candidates for the autocomplete menu. Call [method update_code_completion_options] to update the list. [b]Note:[/b] This list will replace all current candidates. @@ -56,9 +56,9 @@ </method> <method name="add_comment_delimiter"> <return type="void" /> - <argument index="0" name="start_key" type="String" /> - <argument index="1" name="end_key" type="String" /> - <argument index="2" name="line_only" type="bool" default="false" /> + <param index="0" name="start_key" type="String" /> + <param index="1" name="end_key" type="String" /> + <param index="2" name="line_only" type="bool" default="false" /> <description> Adds a comment delimiter. Both the start and end keys must be symbols. Only the start key has to be unique. @@ -67,9 +67,9 @@ </method> <method name="add_string_delimiter"> <return type="void" /> - <argument index="0" name="start_key" type="String" /> - <argument index="1" name="end_key" type="String" /> - <argument index="2" name="line_only" type="bool" default="false" /> + <param index="0" name="start_key" type="String" /> + <param index="1" name="end_key" type="String" /> + <param index="2" name="line_only" type="bool" default="false" /> <description> Adds a string delimiter. Both the start and end keys must be symbols. Only the start key has to be unique. @@ -78,7 +78,7 @@ </method> <method name="can_fold_line" qualifiers="const"> <return type="bool" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block. </description> @@ -121,7 +121,7 @@ </method> <method name="confirm_code_completion"> <return type="void" /> - <argument index="0" name="replace" type="bool" default="false" /> + <param index="0" name="replace" type="bool" default="false" /> <description> Inserts the selected entry into the text. If [code]replace[/code] is true, any existing text is replaced rather then merged. </description> @@ -146,14 +146,14 @@ </method> <method name="fold_line"> <return type="void" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Folds the given line, if possible (see [method can_fold_line]). </description> </method> <method name="get_auto_brace_completion_close_key" qualifiers="const"> <return type="String" /> - <argument index="0" name="open_key" type="String" /> + <param index="0" name="open_key" type="String" /> <description> Gets the matching auto brace close key for [code]open_key[/code]. </description> @@ -172,7 +172,7 @@ </method> <method name="get_code_completion_option" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Gets the completion option at [code]index[/code]. The return [Dictionary] has the following key-values: [code]kind[/code]: [enum CodeCompletionKind] @@ -197,30 +197,30 @@ </method> <method name="get_delimiter_end_key" qualifiers="const"> <return type="String" /> - <argument index="0" name="delimiter_index" type="int" /> + <param index="0" name="delimiter_index" type="int" /> <description> Gets the end key for a string or comment region index. </description> </method> <method name="get_delimiter_end_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="column" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="column" type="int" /> <description> If [code]line[/code] [code]column[/code] is in a string or comment, returns the end position of the region. If not or no end could be found, both [Vector2] values will be [code]-1[/code]. </description> </method> <method name="get_delimiter_start_key" qualifiers="const"> <return type="String" /> - <argument index="0" name="delimiter_index" type="int" /> + <param index="0" name="delimiter_index" type="int" /> <description> Gets the start key for a string or comment region index. </description> </method> <method name="get_delimiter_start_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="column" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="column" type="int" /> <description> If [code]line[/code] [code]column[/code] is in a string or comment, returns the start position of the region. If not or no start could be found, both [Vector2] values will be [code]-1[/code]. </description> @@ -251,28 +251,28 @@ </method> <method name="has_auto_brace_completion_close_key" qualifiers="const"> <return type="bool" /> - <argument index="0" name="close_key" type="String" /> + <param index="0" name="close_key" type="String" /> <description> Returns [code]true[/code] if close key [code]close_key[/code] exists. </description> </method> <method name="has_auto_brace_completion_open_key" qualifiers="const"> <return type="bool" /> - <argument index="0" name="open_key" type="String" /> + <param index="0" name="open_key" type="String" /> <description> Returns [code]true[/code] if open key [code]open_key[/code] exists. </description> </method> <method name="has_comment_delimiter" qualifiers="const"> <return type="bool" /> - <argument index="0" name="start_key" type="String" /> + <param index="0" name="start_key" type="String" /> <description> Returns [code]true[/code] if comment [code]start_key[/code] exists. </description> </method> <method name="has_string_delimiter" qualifiers="const"> <return type="bool" /> - <argument index="0" name="start_key" type="String" /> + <param index="0" name="start_key" type="String" /> <description> Returns [code]true[/code] if string [code]start_key[/code] exists. </description> @@ -285,124 +285,124 @@ </method> <method name="is_in_comment" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="column" type="int" default="-1" /> + <param index="0" name="line" type="int" /> + <param index="1" name="column" type="int" default="-1" /> <description> Returns delimiter index if [code]line[/code] [code]column[/code] is in a comment. If [code]column[/code] is not provided, will return delimiter index if the entire [code]line[/code] is a comment. Otherwise [code]-1[/code]. </description> </method> <method name="is_in_string" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="column" type="int" default="-1" /> + <param index="0" name="line" type="int" /> + <param index="1" name="column" type="int" default="-1" /> <description> Returns the delimiter index if [code]line[/code] [code]column[/code] is in a string. If [code]column[/code] is not provided, will return the delimiter index if the entire [code]line[/code] is a string. Otherwise [code]-1[/code]. </description> </method> <method name="is_line_bookmarked" qualifiers="const"> <return type="bool" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns whether the line at the specified index is bookmarked or not. </description> </method> <method name="is_line_breakpointed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns whether the line at the specified index is breakpointed or not. </description> </method> <method name="is_line_executing" qualifiers="const"> <return type="bool" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns whether the line at the specified index is marked as executing or not. </description> </method> <method name="is_line_folded" qualifiers="const"> <return type="bool" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns whether the line at the specified index is folded or not. </description> </method> <method name="remove_comment_delimiter"> <return type="void" /> - <argument index="0" name="start_key" type="String" /> + <param index="0" name="start_key" type="String" /> <description> Removes the comment delimiter with [code]start_key[/code]. </description> </method> <method name="remove_string_delimiter"> <return type="void" /> - <argument index="0" name="start_key" type="String" /> + <param index="0" name="start_key" type="String" /> <description> Removes the string delimiter with [code]start_key[/code]. </description> </method> <method name="request_code_completion"> <return type="void" /> - <argument index="0" name="force" type="bool" default="false" /> + <param index="0" name="force" type="bool" default="false" /> <description> Emits [signal code_completion_requested], if [code]force[/code] is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal. </description> </method> <method name="set_code_completion_selected_index"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Sets the current selected completion option. </description> </method> <method name="set_code_hint"> <return type="void" /> - <argument index="0" name="code_hint" type="String" /> + <param index="0" name="code_hint" type="String" /> <description> Sets the code hint text. Pass an empty string to clear. </description> </method> <method name="set_code_hint_draw_below"> <return type="void" /> - <argument index="0" name="draw_below" type="bool" /> + <param index="0" name="draw_below" type="bool" /> <description> Sets if the code hint should draw below the text. </description> </method> <method name="set_line_as_bookmarked"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="bookmarked" type="bool" /> + <param index="0" name="line" type="int" /> + <param index="1" name="bookmarked" type="bool" /> <description> Sets the line as bookmarked. </description> </method> <method name="set_line_as_breakpoint"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="breakpointed" type="bool" /> + <param index="0" name="line" type="int" /> + <param index="1" name="breakpointed" type="bool" /> <description> Sets the line as breakpointed. </description> </method> <method name="set_line_as_executing"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="executing" type="bool" /> + <param index="0" name="line" type="int" /> + <param index="1" name="executing" type="bool" /> <description> Sets the line as executing. </description> </method> <method name="set_symbol_lookup_word_as_valid"> <return type="void" /> - <argument index="0" name="valid" type="bool" /> + <param index="0" name="valid" type="bool" /> <description> Sets the symbol emitted by [signal symbol_validate] as a valid lookup. </description> </method> <method name="toggle_foldable_line"> <return type="void" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Toggle the folding of the code block at the given line. </description> @@ -415,7 +415,7 @@ </method> <method name="unfold_line"> <return type="void" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Unfolds all lines that were previously folded. </description> @@ -428,7 +428,7 @@ </method> <method name="update_code_completion_options"> <return type="void" /> - <argument index="0" name="force" type="bool" /> + <param index="0" name="force" type="bool" /> <description> Submits all completion options added with [method add_code_completion_option]. Will try to force the autoccomplete menu to popup, if [code]force[/code] is [code]true[/code]. [b]Note:[/b] This will replace all current candidates. @@ -501,7 +501,7 @@ </members> <signals> <signal name="breakpoint_toggled"> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line. </description> @@ -512,15 +512,15 @@ </description> </signal> <signal name="symbol_lookup"> - <argument index="0" name="symbol" type="String" /> - <argument index="1" name="line" type="int" /> - <argument index="2" name="column" type="int" /> + <param index="0" name="symbol" type="String" /> + <param index="1" name="line" type="int" /> + <param index="2" name="column" type="int" /> <description> Emitted when the user has clicked on a valid symbol. </description> </signal> <signal name="symbol_validate"> - <argument index="0" name="symbol" type="String" /> + <param index="0" name="symbol" type="String" /> <description> Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling [method set_symbol_lookup_word_as_valid]. </description> diff --git a/doc/classes/CodeHighlighter.xml b/doc/classes/CodeHighlighter.xml index b4bde1d00b..fd1f595fc6 100644 --- a/doc/classes/CodeHighlighter.xml +++ b/doc/classes/CodeHighlighter.xml @@ -11,10 +11,10 @@ <methods> <method name="add_color_region"> <return type="void" /> - <argument index="0" name="start_key" type="String" /> - <argument index="1" name="end_key" type="String" /> - <argument index="2" name="color" type="Color" /> - <argument index="3" name="line_only" type="bool" default="false" /> + <param index="0" name="start_key" type="String" /> + <param index="1" name="end_key" type="String" /> + <param index="2" name="color" type="Color" /> + <param index="3" name="line_only" type="bool" default="false" /> <description> Adds a color region such as comments or strings. Both the start and end keys must be symbols. Only the start key has to be unique. @@ -23,8 +23,8 @@ </method> <method name="add_keyword_color"> <return type="void" /> - <argument index="0" name="keyword" type="String" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="keyword" type="String" /> + <param index="1" name="color" type="Color" /> <description> Sets the color for a keyword. The keyword cannot contain any symbols except '_'. @@ -32,8 +32,8 @@ </method> <method name="add_member_keyword_color"> <return type="void" /> - <argument index="0" name="member_keyword" type="String" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="member_keyword" type="String" /> + <param index="1" name="color" type="Color" /> <description> Sets the color for a member keyword. The member keyword cannot contain any symbols except '_'. @@ -60,56 +60,56 @@ </method> <method name="get_keyword_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="keyword" type="String" /> + <param index="0" name="keyword" type="String" /> <description> Returns the color for a keyword. </description> </method> <method name="get_member_keyword_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="member_keyword" type="String" /> + <param index="0" name="member_keyword" type="String" /> <description> Returns the color for a member keyword. </description> </method> <method name="has_color_region" qualifiers="const"> <return type="bool" /> - <argument index="0" name="start_key" type="String" /> + <param index="0" name="start_key" type="String" /> <description> Returns [code]true[/code] if the start key exists, else [code]false[/code]. </description> </method> <method name="has_keyword_color" qualifiers="const"> <return type="bool" /> - <argument index="0" name="keyword" type="String" /> + <param index="0" name="keyword" type="String" /> <description> Returns [code]true[/code] if the keyword exists, else [code]false[/code]. </description> </method> <method name="has_member_keyword_color" qualifiers="const"> <return type="bool" /> - <argument index="0" name="member_keyword" type="String" /> + <param index="0" name="member_keyword" type="String" /> <description> Returns [code]true[/code] if the member keyword exists, else [code]false[/code]. </description> </method> <method name="remove_color_region"> <return type="void" /> - <argument index="0" name="start_key" type="String" /> + <param index="0" name="start_key" type="String" /> <description> Removes the color region that uses that start key. </description> </method> <method name="remove_keyword_color"> <return type="void" /> - <argument index="0" name="keyword" type="String" /> + <param index="0" name="keyword" type="String" /> <description> Removes the keyword. </description> </method> <method name="remove_member_keyword_color"> <return type="void" /> - <argument index="0" name="member_keyword" type="String" /> + <param index="0" name="member_keyword" type="String" /> <description> Removes the member keyword. </description> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 95d99855f6..31858bf080 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -12,9 +12,9 @@ <methods> <method name="_input_event" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport" type="Viewport" /> - <argument index="1" name="event" type="InputEvent" /> - <argument index="2" name="shape_idx" type="int" /> + <param index="0" name="viewport" type="Viewport" /> + <param index="1" name="event" type="InputEvent" /> + <param index="2" name="shape_idx" type="int" /> <description> Accepts unhandled [InputEvent]s. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events. [b]Note:[/b] [method _input_event] requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. @@ -22,21 +22,21 @@ </method> <method name="create_shape_owner"> <return type="int" /> - <argument index="0" name="owner" type="Object" /> + <param index="0" name="owner" type="Object" /> <description> Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. </description> </method> <method name="get_collision_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -49,7 +49,7 @@ </method> <method name="get_shape_owner_one_way_collision_margin" qualifiers="const"> <return type="float" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code]. </description> @@ -62,136 +62,136 @@ </method> <method name="is_shape_owner_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> If [code]true[/code], the shape owner and its shapes are disabled. </description> </method> <method name="is_shape_owner_one_way_collision_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Returns [code]true[/code] if collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s. </description> </method> <method name="remove_shape_owner"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Removes the given shape owner. </description> </method> <method name="set_collision_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="shape_find_owner" qualifiers="const"> <return type="int" /> - <argument index="0" name="shape_index" type="int" /> + <param index="0" name="shape_index" type="int" /> <description> Returns the [code]owner_id[/code] of the given shape. </description> </method> <method name="shape_owner_add_shape"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="shape" type="Shape2D" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="shape" type="Shape2D" /> <description> Adds a [Shape2D] to the shape owner. </description> </method> <method name="shape_owner_clear_shapes"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Removes all shapes from the shape owner. </description> </method> <method name="shape_owner_get_owner" qualifiers="const"> <return type="Object" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Returns the parent object of the given shape owner. </description> </method> <method name="shape_owner_get_shape" qualifiers="const"> <return type="Shape2D" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="shape_id" type="int" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="shape_id" type="int" /> <description> Returns the [Shape2D] with the given id from the given shape owner. </description> </method> <method name="shape_owner_get_shape_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Returns the number of shapes the given shape owner contains. </description> </method> <method name="shape_owner_get_shape_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="shape_id" type="int" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="shape_id" type="int" /> <description> Returns the child index of the [Shape2D] with the given id from the given shape owner. </description> </method> <method name="shape_owner_get_transform" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Returns the shape owner's [Transform2D]. </description> </method> <method name="shape_owner_remove_shape"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="shape_id" type="int" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="shape_id" type="int" /> <description> Removes a shape from the given shape owner. </description> </method> <method name="shape_owner_set_disabled"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="disabled" type="bool" /> <description> If [code]true[/code], disables the given shape owner. </description> </method> <method name="shape_owner_set_one_way_collision"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="enable" type="bool" /> <description> If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s. </description> </method> <method name="shape_owner_set_one_way_collision_margin"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="margin" type="float" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="margin" type="float" /> <description> Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels. </description> </method> <method name="shape_owner_set_transform"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets the [Transform2D] of the given shape owner. </description> @@ -215,9 +215,9 @@ </members> <signals> <signal name="input_event"> - <argument index="0" name="viewport" type="Node" /> - <argument index="1" name="event" type="InputEvent" /> - <argument index="2" name="shape_idx" type="int" /> + <param index="0" name="viewport" type="Node" /> + <param index="1" name="event" type="InputEvent" /> + <param index="2" name="shape_idx" type="int" /> <description> Emitted when an input event occurs. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. See [method _input_event] for details. </description> @@ -235,13 +235,13 @@ </description> </signal> <signal name="mouse_shape_entered"> - <argument index="0" name="shape_idx" type="int" /> + <param index="0" name="shape_idx" type="int" /> <description> Emitted when the mouse pointer enters any of this object's shapes or moves from one shape to another. [code]shape_idx[/code] is the child index of the newly entered [Shape2D]. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. </description> </signal> <signal name="mouse_shape_exited"> - <argument index="0" name="shape_idx" type="int" /> + <param index="0" name="shape_idx" type="int" /> <description> Emitted when the mouse pointer exits any of this object's shapes. [code]shape_idx[/code] is the child index of the exited [Shape2D]. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. </description> diff --git a/doc/classes/CollisionObject3D.xml b/doc/classes/CollisionObject3D.xml index 7284a7e341..1319274920 100644 --- a/doc/classes/CollisionObject3D.xml +++ b/doc/classes/CollisionObject3D.xml @@ -11,11 +11,11 @@ <methods> <method name="_input_event" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="camera" type="Camera3D" /> - <argument index="1" name="event" type="InputEvent" /> - <argument index="2" name="position" type="Vector3" /> - <argument index="3" name="normal" type="Vector3" /> - <argument index="4" name="shape_idx" type="int" /> + <param index="0" name="camera" type="Camera3D" /> + <param index="1" name="event" type="InputEvent" /> + <param index="2" name="position" type="Vector3" /> + <param index="3" name="normal" type="Vector3" /> + <param index="4" name="shape_idx" type="int" /> <description> Receives unhandled [InputEvent]s. [code]position[/code] is the location in world space of the mouse pointer on the surface of the shape with index [code]shape_idx[/code] and [code]normal[/code] is the normal vector of the surface at that point. Connect to the [signal input_event] signal to easily pick up these events. [b]Note:[/b] [method _input_event] requires [member input_ray_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. @@ -23,21 +23,21 @@ </method> <method name="create_shape_owner"> <return type="int" /> - <argument index="0" name="owner" type="Object" /> + <param index="0" name="owner" type="Object" /> <description> Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. </description> </method> <method name="get_collision_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -56,113 +56,113 @@ </method> <method name="is_shape_owner_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> If [code]true[/code], the shape owner and its shapes are disabled. </description> </method> <method name="remove_shape_owner"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Removes the given shape owner. </description> </method> <method name="set_collision_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="shape_find_owner" qualifiers="const"> <return type="int" /> - <argument index="0" name="shape_index" type="int" /> + <param index="0" name="shape_index" type="int" /> <description> Returns the [code]owner_id[/code] of the given shape. </description> </method> <method name="shape_owner_add_shape"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="shape" type="Shape3D" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="shape" type="Shape3D" /> <description> Adds a [Shape3D] to the shape owner. </description> </method> <method name="shape_owner_clear_shapes"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Removes all shapes from the shape owner. </description> </method> <method name="shape_owner_get_owner" qualifiers="const"> <return type="Object" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Returns the parent object of the given shape owner. </description> </method> <method name="shape_owner_get_shape" qualifiers="const"> <return type="Shape3D" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="shape_id" type="int" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="shape_id" type="int" /> <description> Returns the [Shape3D] with the given id from the given shape owner. </description> </method> <method name="shape_owner_get_shape_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Returns the number of shapes the given shape owner contains. </description> </method> <method name="shape_owner_get_shape_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="shape_id" type="int" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="shape_id" type="int" /> <description> Returns the child index of the [Shape3D] with the given id from the given shape owner. </description> </method> <method name="shape_owner_get_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="owner_id" type="int" /> + <param index="0" name="owner_id" type="int" /> <description> Returns the shape owner's [Transform3D]. </description> </method> <method name="shape_owner_remove_shape"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="shape_id" type="int" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="shape_id" type="int" /> <description> Removes a shape from the given shape owner. </description> </method> <method name="shape_owner_set_disabled"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="disabled" type="bool" /> <description> If [code]true[/code], disables the given shape owner. </description> </method> <method name="shape_owner_set_transform"> <return type="void" /> - <argument index="0" name="owner_id" type="int" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="owner_id" type="int" /> + <param index="1" name="transform" type="Transform3D" /> <description> Sets the [Transform3D] of the given shape owner. </description> @@ -189,11 +189,11 @@ </members> <signals> <signal name="input_event"> - <argument index="0" name="camera" type="Node" /> - <argument index="1" name="event" type="InputEvent" /> - <argument index="2" name="position" type="Vector3" /> - <argument index="3" name="normal" type="Vector3" /> - <argument index="4" name="shape_idx" type="int" /> + <param index="0" name="camera" type="Node" /> + <param index="1" name="event" type="InputEvent" /> + <param index="2" name="position" type="Vector3" /> + <param index="3" name="normal" type="Vector3" /> + <param index="4" name="shape_idx" type="int" /> <description> Emitted when the object receives an unhandled [InputEvent]. [code]position[/code] is the location in world space of the mouse pointer on the surface of the shape with index [code]shape_idx[/code] and [code]normal[/code] is the normal vector of the surface at that point. </description> diff --git a/doc/classes/CollisionShape3D.xml b/doc/classes/CollisionShape3D.xml index 521a11effd..c8423dac9e 100644 --- a/doc/classes/CollisionShape3D.xml +++ b/doc/classes/CollisionShape3D.xml @@ -21,7 +21,7 @@ </method> <method name="resource_changed"> <return type="void" /> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> If this method exists within a script it will be called whenever the shape resource has been modified. </description> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 59ad104ad1..0ed623e0bc 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -24,8 +24,8 @@ </constructor> <constructor name="Color"> <return type="Color" /> - <argument index="0" name="from" type="Color" /> - <argument index="1" name="alpha" type="float" /> + <param index="0" name="from" type="Color" /> + <param index="1" name="alpha" type="float" /> <description> Constructs a [Color] from an existing color, but with a custom alpha value. [codeblocks] @@ -40,31 +40,31 @@ </constructor> <constructor name="Color"> <return type="Color" /> - <argument index="0" name="from" type="Color" /> + <param index="0" name="from" type="Color" /> <description> Constructs a [Color] as a copy of the given [Color]. </description> </constructor> <constructor name="Color"> <return type="Color" /> - <argument index="0" name="code" type="String" /> + <param index="0" name="code" type="String" /> <description> Constructs a [Color] either from an HTML color code or from a standardized color name. Supported color names are the same as the constants. </description> </constructor> <constructor name="Color"> <return type="Color" /> - <argument index="0" name="code" type="String" /> - <argument index="1" name="alpha" type="float" /> + <param index="0" name="code" type="String" /> + <param index="1" name="alpha" type="float" /> <description> Constructs a [Color] either from an HTML color code or from a standardized color name, with [code]alpha[/code] on the range of 0 to 1. Supported color names are the same as the constants. </description> </constructor> <constructor name="Color"> <return type="Color" /> - <argument index="0" name="r" type="float" /> - <argument index="1" name="g" type="float" /> - <argument index="2" name="b" type="float" /> + <param index="0" name="r" type="float" /> + <param index="1" name="g" type="float" /> + <param index="2" name="b" type="float" /> <description> Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1. [codeblocks] @@ -79,10 +79,10 @@ </constructor> <constructor name="Color"> <return type="Color" /> - <argument index="0" name="r" type="float" /> - <argument index="1" name="g" type="float" /> - <argument index="2" name="b" type="float" /> - <argument index="3" name="a" type="float" /> + <param index="0" name="r" type="float" /> + <param index="1" name="g" type="float" /> + <param index="2" name="b" type="float" /> + <param index="3" name="a" type="float" /> <description> Constructs a [Color] from RGBA values, typically between 0 and 1. [codeblocks] @@ -99,7 +99,7 @@ <methods> <method name="blend" qualifiers="const"> <return type="Color" /> - <argument index="0" name="over" type="Color" /> + <param index="0" name="over" type="Color" /> <description> Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values. [codeblocks] @@ -118,15 +118,15 @@ </method> <method name="clamp" qualifiers="const"> <return type="Color" /> - <argument index="0" name="min" type="Color" default="Color(0, 0, 0, 0)" /> - <argument index="1" name="max" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="min" type="Color" default="Color(0, 0, 0, 0)" /> + <param index="1" name="max" type="Color" default="Color(1, 1, 1, 1)" /> <description> Returns a new color with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> </method> <method name="darkened" qualifiers="const"> <return type="Color" /> - <argument index="0" name="amount" type="float" /> + <param index="0" name="amount" type="float" /> <description> Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1). [codeblocks] @@ -143,16 +143,16 @@ </method> <method name="find_named_color" qualifiers="static"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> </description> </method> <method name="from_hsv" qualifiers="static"> <return type="Color" /> - <argument index="0" name="h" type="float" /> - <argument index="1" name="s" type="float" /> - <argument index="2" name="v" type="float" /> - <argument index="3" name="alpha" type="float" default="1.0" /> + <param index="0" name="h" type="float" /> + <param index="1" name="s" type="float" /> + <param index="2" name="v" type="float" /> + <param index="3" name="alpha" type="float" default="1.0" /> <description> Constructs a color from an [url=https://en.wikipedia.org/wiki/HSL_and_HSV]HSV profile[/url]. [code]h[/code] (hue), [code]s[/code] (saturation), and [code]v[/code] (value) are typically between 0 and 1. [codeblocks] @@ -167,10 +167,10 @@ </method> <method name="from_ok_hsl" qualifiers="static"> <return type="Color" /> - <argument index="0" name="h" type="float" /> - <argument index="1" name="s" type="float" /> - <argument index="2" name="l" type="float" /> - <argument index="3" name="alpha" type="float" default="1.0" /> + <param index="0" name="h" type="float" /> + <param index="1" name="s" type="float" /> + <param index="2" name="l" type="float" /> + <param index="3" name="alpha" type="float" default="1.0" /> <description> Constructs a color from an [url=https://bottosson.github.io/posts/colorpicker/]OK HSL profile[/url]. [code]h[/code] (hue), [code]s[/code] (saturation), and [code]v[/code] (value) are typically between 0 and 1. [codeblocks] @@ -185,14 +185,14 @@ </method> <method name="from_rgbe9995" qualifiers="static"> <return type="Color" /> - <argument index="0" name="rgbe" type="int" /> + <param index="0" name="rgbe" type="int" /> <description> </description> </method> <method name="from_string" qualifiers="static"> <return type="Color" /> - <argument index="0" name="str" type="String" /> - <argument index="1" name="default" type="Color" /> + <param index="0" name="str" type="String" /> + <param index="1" name="default" type="Color" /> <description> </description> </method> @@ -206,7 +206,7 @@ </method> <method name="get_named_color" qualifiers="static"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> @@ -217,25 +217,25 @@ </method> <method name="get_named_color_name" qualifiers="static"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> <method name="hex" qualifiers="static"> <return type="Color" /> - <argument index="0" name="hex" type="int" /> + <param index="0" name="hex" type="int" /> <description> </description> </method> <method name="hex64" qualifiers="static"> <return type="Color" /> - <argument index="0" name="hex" type="int" /> + <param index="0" name="hex" type="int" /> <description> </description> </method> <method name="html" qualifiers="static"> <return type="Color" /> - <argument index="0" name="rgba" type="String" /> + <param index="0" name="rgba" type="String" /> <description> Returns a new color from [code]rgba[/code], an HTML hexadecimal color string. [code]rgba[/code] is not case sensitive, and may be prefixed with a '#' character. [code]rgba[/code] must be a valid three-digit or six-digit hexadecimal color string, and may contain an alpha channel value. If [code]rgba[/code] does not contain an alpha channel value, an alpha channel value of 1.0 is applied. @@ -255,7 +255,7 @@ </method> <method name="html_is_valid" qualifiers="static"> <return type="bool" /> - <argument index="0" name="color" type="String" /> + <param index="0" name="color" type="String" /> <description> Returns [code]true[/code] if [code]color[/code] is a valid HTML hexadecimal color string. [code]color[/code] is not case sensitive, and may be prefixed with a '#' character. For a string to be valid it must be three-digit or six-digit hexadecimal, and may contain an alpha channel value. @@ -297,15 +297,15 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="to" type="Color" /> + <param index="0" name="to" type="Color" /> <description> Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> </method> <method name="lerp" qualifiers="const"> <return type="Color" /> - <argument index="0" name="to" type="Color" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Color" /> + <param index="1" name="weight" type="float" /> <description> Returns the linear interpolation with another color. The interpolation factor [code]weight[/code] is between 0 and 1. [codeblocks] @@ -324,7 +324,7 @@ </method> <method name="lightened" qualifiers="const"> <return type="Color" /> - <argument index="0" name="amount" type="float" /> + <param index="0" name="amount" type="float" /> <description> Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1). [codeblocks] @@ -417,7 +417,7 @@ </method> <method name="to_html" qualifiers="const"> <return type="String" /> - <argument index="0" name="with_alpha" type="bool" default="true" /> + <param index="0" name="with_alpha" type="bool" default="true" /> <description> Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: [code]ff34f822[/code]). Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format). @@ -946,7 +946,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Color" /> + <param index="0" name="right" type="Color" /> <description> Returns [code]true[/code] if the colors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -954,63 +954,63 @@ </operator> <operator name="operator *"> <return type="Color" /> - <argument index="0" name="right" type="Color" /> + <param index="0" name="right" type="Color" /> <description> Multiplies each component of the [Color] by the components of the given [Color]. </description> </operator> <operator name="operator *"> <return type="Color" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies each component of the [Color] by the given [float]. </description> </operator> <operator name="operator *"> <return type="Color" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies each component of the [Color] by the given [int]. </description> </operator> <operator name="operator +"> <return type="Color" /> - <argument index="0" name="right" type="Color" /> + <param index="0" name="right" type="Color" /> <description> Adds each component of the [Color] with the components of the given [Color]. </description> </operator> <operator name="operator -"> <return type="Color" /> - <argument index="0" name="right" type="Color" /> + <param index="0" name="right" type="Color" /> <description> Subtracts each component of the [Color] by the components of the given [Color]. </description> </operator> <operator name="operator /"> <return type="Color" /> - <argument index="0" name="right" type="Color" /> + <param index="0" name="right" type="Color" /> <description> Divides each component of the [Color] by the components of the given [Color]. </description> </operator> <operator name="operator /"> <return type="Color" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides each component of the [Color] by the given [float]. </description> </operator> <operator name="operator /"> <return type="Color" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides each component of the [Color] by the given [int]. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Color" /> + <param index="0" name="right" type="Color" /> <description> Returns [code]true[/code] if the colors are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -1018,7 +1018,7 @@ </operator> <operator name="operator []"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access color components using their index. [code]c[0][/code] is equivalent to [code]c.r[/code], [code]c[1][/code] is equivalent to [code]c.g[/code], [code]c[2][/code] is equivalent to [code]c.b[/code], and [code]c[3][/code] is equivalent to [code]c.a[/code]. </description> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index cc9c5877c5..705d2282c1 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -13,7 +13,7 @@ <methods> <method name="add_preset"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. [b]Note:[/b] The presets list is only for [i]this[/i] color picker. @@ -21,7 +21,7 @@ </method> <method name="erase_preset"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Removes the given color from the list of color presets of this color picker. </description> @@ -58,19 +58,19 @@ </members> <signals> <signal name="color_changed"> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Emitted when the color is changed. </description> </signal> <signal name="preset_added"> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Emitted when a preset is added. </description> </signal> <signal name="preset_removed"> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Emitted when a preset is removed. </description> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 75a715789c..b7a0bdfb0c 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -39,7 +39,7 @@ </members> <signals> <signal name="color_changed"> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Emitted when the color changes. </description> diff --git a/doc/classes/CompressedTexture2D.xml b/doc/classes/CompressedTexture2D.xml index 5f73b55f69..f74265b8d5 100644 --- a/doc/classes/CompressedTexture2D.xml +++ b/doc/classes/CompressedTexture2D.xml @@ -11,7 +11,7 @@ <methods> <method name="load"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Loads the texture from the given path. </description> diff --git a/doc/classes/CompressedTexture3D.xml b/doc/classes/CompressedTexture3D.xml index de7a93d788..50bd025861 100644 --- a/doc/classes/CompressedTexture3D.xml +++ b/doc/classes/CompressedTexture3D.xml @@ -9,7 +9,7 @@ <methods> <method name="load"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> diff --git a/doc/classes/CompressedTextureLayered.xml b/doc/classes/CompressedTextureLayered.xml index 03bea84ba4..547679c0f0 100644 --- a/doc/classes/CompressedTextureLayered.xml +++ b/doc/classes/CompressedTextureLayered.xml @@ -9,7 +9,7 @@ <methods> <method name="load"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> diff --git a/doc/classes/ConcavePolygonShape3D.xml b/doc/classes/ConcavePolygonShape3D.xml index 60d7e32492..6a54b4bda7 100644 --- a/doc/classes/ConcavePolygonShape3D.xml +++ b/doc/classes/ConcavePolygonShape3D.xml @@ -20,7 +20,7 @@ </method> <method name="set_faces"> <return type="void" /> - <argument index="0" name="faces" type="PackedVector3Array" /> + <param index="0" name="faces" type="PackedVector3Array" /> <description> Sets the faces (an array of triangles). </description> diff --git a/doc/classes/ConeTwistJoint3D.xml b/doc/classes/ConeTwistJoint3D.xml index f78a5b5332..5f2ad109f2 100644 --- a/doc/classes/ConeTwistJoint3D.xml +++ b/doc/classes/ConeTwistJoint3D.xml @@ -13,14 +13,14 @@ <methods> <method name="get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" /> + <param index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" /> <description> </description> </method> <method name="set_param"> <return type="void" /> - <argument index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" /> + <param index="1" name="value" type="float" /> <description> </description> </method> diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index b766981f1e..ecd317e064 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -100,22 +100,22 @@ </method> <method name="erase_section"> <return type="void" /> - <argument index="0" name="section" type="String" /> + <param index="0" name="section" type="String" /> <description> Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist. </description> </method> <method name="erase_section_key"> <return type="void" /> - <argument index="0" name="section" type="String" /> - <argument index="1" name="key" type="String" /> + <param index="0" name="section" type="String" /> + <param index="1" name="key" type="String" /> <description> Deletes the specified key in a section. Raises an error if either the section or the key do not exist. </description> </method> <method name="get_section_keys" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="section" type="String" /> + <param index="0" name="section" type="String" /> <description> Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist. </description> @@ -128,24 +128,24 @@ </method> <method name="get_value" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="section" type="String" /> - <argument index="1" name="key" type="String" /> - <argument index="2" name="default" type="Variant" default="null" /> + <param index="0" name="section" type="String" /> + <param index="1" name="key" type="String" /> + <param index="2" name="default" type="Variant" default="null" /> <description> Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback [code]default[/code] value. If [code]default[/code] is not specified or set to [code]null[/code], an error is also raised. </description> </method> <method name="has_section" qualifiers="const"> <return type="bool" /> - <argument index="0" name="section" type="String" /> + <param index="0" name="section" type="String" /> <description> Returns [code]true[/code] if the specified section exists. </description> </method> <method name="has_section_key" qualifiers="const"> <return type="bool" /> - <argument index="0" name="section" type="String" /> - <argument index="1" name="key" type="String" /> + <param index="0" name="section" type="String" /> + <param index="1" name="key" type="String" /> <description> Returns [code]true[/code] if the specified section-key pair exists. </description> @@ -154,7 +154,7 @@ <return type="int" enum="Error" /> <returns_error number="0"/> <returns_error number="12"/> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -162,8 +162,8 @@ </method> <method name="load_encrypted"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="key" type="PackedByteArray" /> + <param index="0" name="path" type="String" /> + <param index="1" name="key" type="PackedByteArray" /> <description> Loads the encrypted config file specified as a parameter, using the provided [code]key[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -171,8 +171,8 @@ </method> <method name="load_encrypted_pass"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="password" type="String" /> + <param index="0" name="path" type="String" /> + <param index="1" name="password" type="String" /> <description> Loads the encrypted config file specified as a parameter, using the provided [code]password[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -180,7 +180,7 @@ </method> <method name="parse"> <return type="int" enum="Error" /> - <argument index="0" name="data" type="String" /> + <param index="0" name="data" type="String" /> <description> Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -188,7 +188,7 @@ </method> <method name="save"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Saves the contents of the [ConfigFile] object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -196,8 +196,8 @@ </method> <method name="save_encrypted"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="key" type="PackedByteArray" /> + <param index="0" name="path" type="String" /> + <param index="1" name="key" type="PackedByteArray" /> <description> Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]key[/code] to encrypt it. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -205,8 +205,8 @@ </method> <method name="save_encrypted_pass"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="password" type="String" /> + <param index="0" name="path" type="String" /> + <param index="1" name="password" type="String" /> <description> Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]password[/code] to encrypt it. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -214,9 +214,9 @@ </method> <method name="set_value"> <return type="void" /> - <argument index="0" name="section" type="String" /> - <argument index="1" name="key" type="String" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="section" type="String" /> + <param index="1" name="key" type="String" /> + <param index="2" name="value" type="Variant" /> <description> Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. </description> diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index 900997d119..a13e1598b2 100644 --- a/doc/classes/Container.xml +++ b/doc/classes/Container.xml @@ -27,8 +27,8 @@ </method> <method name="fit_child_in_rect"> <return type="void" /> - <argument index="0" name="child" type="Control" /> - <argument index="1" name="rect" type="Rect2" /> + <param index="0" name="child" type="Control" /> + <param index="1" name="rect" type="Rect2" /> <description> Fit a child control in a given rect. This is mainly a helper for creating custom container classes. </description> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 9fc80e1aab..ad5dcdfc45 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -24,8 +24,8 @@ <methods> <method name="_can_drop_data" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="at_position" type="Vector2" /> - <argument index="1" name="data" type="Variant" /> + <param index="0" name="at_position" type="Vector2" /> + <param index="1" name="data" type="Variant" /> <description> Godot calls this method to test if [code]data[/code] from a control's [method _get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control. This method should only be used to test the data. Process the data in [method _drop_data]. @@ -49,8 +49,8 @@ </method> <method name="_drop_data" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="at_position" type="Vector2" /> - <argument index="1" name="data" type="Variant" /> + <param index="0" name="at_position" type="Vector2" /> + <param index="1" name="data" type="Variant" /> <description> Godot calls this method to pass you the [code]data[/code] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. [codeblocks] @@ -75,7 +75,7 @@ </method> <method name="_get_drag_data" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="at_position" type="Vector2" /> + <param index="0" name="at_position" type="Vector2" /> <description> Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. @@ -107,7 +107,7 @@ </method> <method name="_gui_input" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See [method accept_event]. Example: clicking a control. @@ -143,7 +143,7 @@ </method> <method name="_has_point" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control. If not overridden, default behavior is checking if the point is within control's Rect. @@ -152,7 +152,7 @@ </method> <method name="_make_custom_tooltip" qualifiers="virtual const"> <return type="Object" /> - <argument index="0" name="for_text" type="String" /> + <param index="0" name="for_text" type="String" /> <description> Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [code]for_text[/code] includes the contents of the [member hint_tooltip] property. The returned node must be of type [Control] or Control-derived. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance (if you want to use a pre-existing node from your scene tree, you can duplicate it and pass the duplicated instance). When [code]null[/code] or a non-Control node is returned, the default tooltip will be used instead. @@ -197,8 +197,8 @@ </method> <method name="_structured_text_parser" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="args" type="Array" /> - <argument index="1" name="text" type="String" /> + <param index="0" name="args" type="Array" /> + <param index="1" name="text" type="String" /> <description> User defined BiDi algorithm override function. Returns [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [code]text[/code] without overlaps. BiDi algorithm will be used on each range separately. @@ -212,8 +212,8 @@ </method> <method name="add_theme_color_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="color" type="Color" /> <description> Creates a local override for a theme [Color] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_color_override]. See also [method get_theme_color]. @@ -240,8 +240,8 @@ </method> <method name="add_theme_constant_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="constant" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="constant" type="int" /> <description> Creates a local override for a theme constant with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_constant_override]. See also [method get_theme_constant]. @@ -249,8 +249,8 @@ </method> <method name="add_theme_font_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="font" type="Font" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="font" type="Font" /> <description> Creates a local override for a theme [Font] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_override]. See also [method get_theme_font]. @@ -258,8 +258,8 @@ </method> <method name="add_theme_font_size_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="font_size" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="font_size" type="int" /> <description> Creates a local override for a theme font size with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_size_override]. See also [method get_theme_font_size]. @@ -267,8 +267,8 @@ </method> <method name="add_theme_icon_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="texture" type="Texture2D" /> <description> Creates a local override for a theme icon with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_icon_override]. See also [method get_theme_icon]. @@ -276,8 +276,8 @@ </method> <method name="add_theme_stylebox_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="stylebox" type="StyleBox" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="stylebox" type="StyleBox" /> <description> Creates a local override for a theme [StyleBox] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_stylebox_override]. See also [method get_theme_stylebox]. @@ -334,8 +334,8 @@ </method> <method name="force_drag"> <return type="void" /> - <argument index="0" name="data" type="Variant" /> - <argument index="1" name="preview" type="Control" /> + <param index="0" name="data" type="Variant" /> + <param index="1" name="preview" type="Control" /> <description> Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control. The methods [method _can_drop_data] and [method _drop_data] must be implemented on controls that want to receive drop data. @@ -343,7 +343,7 @@ </method> <method name="get_anchor" qualifiers="const"> <return type="float" /> - <argument index="0" name="side" type="int" enum="Side" /> + <param index="0" name="side" type="int" enum="Side" /> <description> Returns the anchor for the specified [enum Side]. A getter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. </description> @@ -362,7 +362,7 @@ </method> <method name="get_cursor_shape" qualifiers="const"> <return type="int" enum="Control.CursorShape" /> - <argument index="0" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape]. </description> @@ -375,7 +375,7 @@ </method> <method name="get_focus_neighbor" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="side" type="int" enum="Side" /> + <param index="0" name="side" type="int" enum="Side" /> <description> Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. </description> @@ -394,7 +394,7 @@ </method> <method name="get_offset" qualifiers="const"> <return type="float" /> - <argument index="0" name="offset" type="int" enum="Side" /> + <param index="0" name="offset" type="int" enum="Side" /> <description> Returns the anchor for the specified [enum Side]. A getter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. </description> @@ -432,8 +432,8 @@ </method> <method name="get_theme_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [code]name[/code] and [code]theme_type[/code]. If [code]theme_type[/code] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked. For the current control its local overrides are considered first (see [method add_theme_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, a custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used. @@ -459,8 +459,8 @@ </method> <method name="get_theme_constant" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -489,8 +489,8 @@ </method> <method name="get_theme_font" qualifiers="const"> <return type="Font" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -498,8 +498,8 @@ </method> <method name="get_theme_font_size" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns a font size from the first matching [Theme] in the tree if that [Theme] has a font size item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -507,8 +507,8 @@ </method> <method name="get_theme_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -516,8 +516,8 @@ </method> <method name="get_theme_stylebox" qualifiers="const"> <return type="StyleBox" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -525,7 +525,7 @@ </method> <method name="get_tooltip" qualifiers="const"> <return type="String" /> - <argument index="0" name="at_position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="at_position" type="Vector2" default="Vector2(0, 0)" /> <description> Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip]. </description> @@ -562,8 +562,8 @@ </method> <method name="has_theme_color" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -571,7 +571,7 @@ </method> <method name="has_theme_color_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [code]name[/code] in this [Control] node. See [method add_theme_color_override]. @@ -579,8 +579,8 @@ </method> <method name="has_theme_constant" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -588,7 +588,7 @@ </method> <method name="has_theme_constant_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if there is a local override for a theme constant with the specified [code]name[/code] in this [Control] node. See [method add_theme_constant_override]. @@ -596,8 +596,8 @@ </method> <method name="has_theme_font" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -605,7 +605,7 @@ </method> <method name="has_theme_font_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [code]name[/code] in this [Control] node. See [method add_theme_font_override]. @@ -613,8 +613,8 @@ </method> <method name="has_theme_font_size" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font size item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -622,7 +622,7 @@ </method> <method name="has_theme_font_size_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if there is a local override for a theme font size with the specified [code]name[/code] in this [Control] node. See [method add_theme_font_size_override]. @@ -630,8 +630,8 @@ </method> <method name="has_theme_icon" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -639,7 +639,7 @@ </method> <method name="has_theme_icon_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if there is a local override for a theme icon with the specified [code]name[/code] in this [Control] node. See [method add_theme_icon_override]. @@ -647,8 +647,8 @@ </method> <method name="has_theme_stylebox" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -656,7 +656,7 @@ </method> <method name="has_theme_stylebox_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [code]name[/code] in this [Control] node. See [method add_theme_stylebox_override]. @@ -683,42 +683,42 @@ </method> <method name="remove_theme_color_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes a local override for a theme [Color] with the specified [code]name[/code] previously added by [method add_theme_color_override] or via the Inspector dock. </description> </method> <method name="remove_theme_constant_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes a local override for a theme constant with the specified [code]name[/code] previously added by [method add_theme_constant_override] or via the Inspector dock. </description> </method> <method name="remove_theme_font_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes a local override for a theme [Font] with the specified [code]name[/code] previously added by [method add_theme_font_override] or via the Inspector dock. </description> </method> <method name="remove_theme_font_size_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes a local override for a theme font size with the specified [code]name[/code] previously added by [method add_theme_font_size_override] or via the Inspector dock. </description> </method> <method name="remove_theme_icon_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes a local override for a theme icon with the specified [code]name[/code] previously added by [method add_theme_icon_override] or via the Inspector dock. </description> </method> <method name="remove_theme_stylebox_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes a local override for a theme [StyleBox] with the specified [code]name[/code] previously added by [method add_theme_stylebox_override] or via the Inspector dock. </description> @@ -731,10 +731,10 @@ </method> <method name="set_anchor"> <return type="void" /> - <argument index="0" name="side" type="int" enum="Side" /> - <argument index="1" name="anchor" type="float" /> - <argument index="2" name="keep_offset" type="bool" default="false" /> - <argument index="3" name="push_opposite_anchor" type="bool" default="true" /> + <param index="0" name="side" type="int" enum="Side" /> + <param index="1" name="anchor" type="float" /> + <param index="2" name="keep_offset" type="bool" default="false" /> + <param index="3" name="push_opposite_anchor" type="bool" default="true" /> <description> Sets the anchor for the specified [enum Side] to [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. If [code]keep_offset[/code] is [code]true[/code], offsets aren't updated after this operation. @@ -743,27 +743,27 @@ </method> <method name="set_anchor_and_offset"> <return type="void" /> - <argument index="0" name="side" type="int" enum="Side" /> - <argument index="1" name="anchor" type="float" /> - <argument index="2" name="offset" type="float" /> - <argument index="3" name="push_opposite_anchor" type="bool" default="false" /> + <param index="0" name="side" type="int" enum="Side" /> + <param index="1" name="anchor" type="float" /> + <param index="2" name="offset" type="float" /> + <param index="3" name="push_opposite_anchor" type="bool" default="false" /> <description> Works the same as [method set_anchor], but instead of [code]keep_offset[/code] argument and automatic update of offset, it allows to set the offset yourself (see [method set_offset]). </description> </method> <method name="set_anchors_and_offsets_preset"> <return type="void" /> - <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" /> - <argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" /> - <argument index="2" name="margin" type="int" default="0" /> + <param index="0" name="preset" type="int" enum="Control.LayoutPreset" /> + <param index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" /> + <param index="2" name="margin" type="int" default="0" /> <description> Sets both anchor preset and offset preset. See [method set_anchors_preset] and [method set_offsets_preset]. </description> </method> <method name="set_anchors_preset"> <return type="void" /> - <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" /> - <argument index="1" name="keep_offsets" type="bool" default="false" /> + <param index="0" name="preset" type="int" enum="Control.LayoutPreset" /> + <param index="1" name="keep_offsets" type="bool" default="false" /> <description> Sets the anchors to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. If [code]keep_offsets[/code] is [code]true[/code], control's position will also be updated. @@ -771,14 +771,14 @@ </method> <method name="set_begin"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Sets [member offset_left] and [member offset_top] at the same time. Equivalent of changing [member position]. </description> </method> <method name="set_drag_forwarding"> <return type="void" /> - <argument index="0" name="target" type="Object" /> + <param index="0" name="target" type="Object" /> <description> Forwards the handling of this control's drag and drop to [code]target[/code] object. Forwarding can be implemented in the target object similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: @@ -843,7 +843,7 @@ </method> <method name="set_drag_preview"> <return type="void" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <description> Shows the given control at the mouse pointer. A good time to call this method is in [method _get_drag_data]. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. [codeblocks] @@ -877,23 +877,23 @@ </method> <method name="set_end"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Sets [member offset_right] and [member offset_bottom] at the same time. </description> </method> <method name="set_focus_neighbor"> <return type="void" /> - <argument index="0" name="side" type="int" enum="Side" /> - <argument index="1" name="neighbor" type="NodePath" /> + <param index="0" name="side" type="int" enum="Side" /> + <param index="1" name="neighbor" type="NodePath" /> <description> Sets the anchor for the specified [enum Side] to the [Control] at [code]neighbor[/code] node path. A setter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. </description> </method> <method name="set_global_position"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="keep_offsets" type="bool" default="false" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="keep_offsets" type="bool" default="false" /> <description> Sets the [member global_position] to given [code]position[/code]. If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. @@ -901,17 +901,17 @@ </method> <method name="set_offset"> <return type="void" /> - <argument index="0" name="side" type="int" enum="Side" /> - <argument index="1" name="offset" type="float" /> + <param index="0" name="side" type="int" enum="Side" /> + <param index="1" name="offset" type="float" /> <description> Sets the offset for the specified [enum Side] to [code]offset[/code]. A setter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. </description> </method> <method name="set_offsets_preset"> <return type="void" /> - <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" /> - <argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" /> - <argument index="2" name="margin" type="int" default="0" /> + <param index="0" name="preset" type="int" enum="Control.LayoutPreset" /> + <param index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" /> + <param index="2" name="margin" type="int" default="0" /> <description> Sets the offsets to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. Use parameter [code]resize_mode[/code] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code]. @@ -920,8 +920,8 @@ </method> <method name="set_position"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="keep_offsets" type="bool" default="false" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="keep_offsets" type="bool" default="false" /> <description> Sets the [member position] to given [code]position[/code]. If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. @@ -929,8 +929,8 @@ </method> <method name="set_size"> <return type="void" /> - <argument index="0" name="size" type="Vector2" /> - <argument index="1" name="keep_offsets" type="bool" default="false" /> + <param index="0" name="size" type="Vector2" /> + <param index="1" name="keep_offsets" type="bool" default="false" /> <description> Sets the size (see [member size]). If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. @@ -944,7 +944,7 @@ </method> <method name="warp_mouse"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Moves the mouse cursor to [code]position[/code], relative to [member position] of this [Control]. </description> @@ -1105,7 +1105,7 @@ </description> </signal> <signal name="gui_input"> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Emitted when the node receives an [InputEvent]. </description> diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index df96b50fc1..862626d9b6 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -13,7 +13,7 @@ <methods> <method name="set_point_cloud"> <return type="void" /> - <argument index="0" name="point_cloud" type="PackedVector2Array" /> + <param index="0" name="point_cloud" type="PackedVector2Array" /> <description> Based on the set of points provided, this creates and assigns the [member points] property using the convex hull algorithm. Removing all unneeded points. See [method Geometry2D.convex_hull] for details. </description> diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml index 4936fc1d85..ed5b642f90 100644 --- a/doc/classes/Crypto.xml +++ b/doc/classes/Crypto.xml @@ -74,8 +74,8 @@ <methods> <method name="constant_time_compare"> <return type="bool" /> - <argument index="0" name="trusted" type="PackedByteArray" /> - <argument index="1" name="received" type="PackedByteArray" /> + <param index="0" name="trusted" type="PackedByteArray" /> + <param index="1" name="received" type="PackedByteArray" /> <description> Compares two [PackedByteArray]s for equality without leaking timing information in order to prevent timing attacks. See [url=https://paragonie.com/blog/2015/11/preventing-timing-attacks-on-string-comparison-with-double-hmac-strategy]this blog post[/url] for more information. @@ -83,8 +83,8 @@ </method> <method name="decrypt"> <return type="PackedByteArray" /> - <argument index="0" name="key" type="CryptoKey" /> - <argument index="1" name="ciphertext" type="PackedByteArray" /> + <param index="0" name="key" type="CryptoKey" /> + <param index="1" name="ciphertext" type="PackedByteArray" /> <description> Decrypt the given [code]ciphertext[/code] with the provided private [code]key[/code]. [b]Note:[/b] The maximum size of accepted ciphertext is limited by the key size. @@ -92,8 +92,8 @@ </method> <method name="encrypt"> <return type="PackedByteArray" /> - <argument index="0" name="key" type="CryptoKey" /> - <argument index="1" name="plaintext" type="PackedByteArray" /> + <param index="0" name="key" type="CryptoKey" /> + <param index="1" name="plaintext" type="PackedByteArray" /> <description> Encrypt the given [code]plaintext[/code] with the provided public [code]key[/code]. [b]Note:[/b] The maximum size of accepted plaintext is limited by the key size. @@ -101,24 +101,24 @@ </method> <method name="generate_random_bytes"> <return type="PackedByteArray" /> - <argument index="0" name="size" type="int" /> + <param index="0" name="size" type="int" /> <description> Generates a [PackedByteArray] of cryptographically secure random bytes with given [code]size[/code]. </description> </method> <method name="generate_rsa"> <return type="CryptoKey" /> - <argument index="0" name="size" type="int" /> + <param index="0" name="size" type="int" /> <description> Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream]. </description> </method> <method name="generate_self_signed_certificate"> <return type="X509Certificate" /> - <argument index="0" name="key" type="CryptoKey" /> - <argument index="1" name="issuer_name" type="String" default=""CN=myserver,O=myorganisation,C=IT"" /> - <argument index="2" name="not_before" type="String" default=""20140101000000"" /> - <argument index="3" name="not_after" type="String" default=""20340101000000"" /> + <param index="0" name="key" type="CryptoKey" /> + <param index="1" name="issuer_name" type="String" default=""CN=myserver,O=myorganisation,C=IT"" /> + <param index="2" name="not_before" type="String" default=""20140101000000"" /> + <param index="3" name="not_after" type="String" default=""20340101000000"" /> <description> Generates a self-signed [X509Certificate] from the given [CryptoKey] and [code]issuer_name[/code]. The certificate validity will be defined by [code]not_before[/code] and [code]not_after[/code] (first valid date and last valid date). The [code]issuer_name[/code] must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in). A small example to generate an RSA key and a X509 self-signed certificate. @@ -142,9 +142,9 @@ </method> <method name="hmac_digest"> <return type="PackedByteArray" /> - <argument index="0" name="hash_type" type="int" enum="HashingContext.HashType" /> - <argument index="1" name="key" type="PackedByteArray" /> - <argument index="2" name="msg" type="PackedByteArray" /> + <param index="0" name="hash_type" type="int" enum="HashingContext.HashType" /> + <param index="1" name="key" type="PackedByteArray" /> + <param index="2" name="msg" type="PackedByteArray" /> <description> Generates an [url=https://en.wikipedia.org/wiki/HMAC]HMAC[/url] digest of [code]msg[/code] using [code]key[/code]. The [code]hash_type[/code] parameter is the hashing algorithm that is used for the inner and outer hashes. Currently, only [constant HashingContext.HASH_SHA256] and [constant HashingContext.HASH_SHA1] are supported. @@ -152,19 +152,19 @@ </method> <method name="sign"> <return type="PackedByteArray" /> - <argument index="0" name="hash_type" type="int" enum="HashingContext.HashType" /> - <argument index="1" name="hash" type="PackedByteArray" /> - <argument index="2" name="key" type="CryptoKey" /> + <param index="0" name="hash_type" type="int" enum="HashingContext.HashType" /> + <param index="1" name="hash" type="PackedByteArray" /> + <param index="2" name="key" type="CryptoKey" /> <description> Sign a given [code]hash[/code] of type [code]hash_type[/code] with the provided private [code]key[/code]. </description> </method> <method name="verify"> <return type="bool" /> - <argument index="0" name="hash_type" type="int" enum="HashingContext.HashType" /> - <argument index="1" name="hash" type="PackedByteArray" /> - <argument index="2" name="signature" type="PackedByteArray" /> - <argument index="3" name="key" type="CryptoKey" /> + <param index="0" name="hash_type" type="int" enum="HashingContext.HashType" /> + <param index="1" name="hash" type="PackedByteArray" /> + <param index="2" name="signature" type="PackedByteArray" /> + <param index="3" name="key" type="CryptoKey" /> <description> Verify that a given [code]signature[/code] for [code]hash[/code] of type [code]hash_type[/code] against the provided public [code]key[/code]. </description> diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml index 8496c6dec1..4859e182fe 100644 --- a/doc/classes/CryptoKey.xml +++ b/doc/classes/CryptoKey.xml @@ -18,8 +18,8 @@ </method> <method name="load"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="public_only" type="bool" default="false" /> + <param index="0" name="path" type="String" /> + <param index="1" name="public_only" type="bool" default="false" /> <description> Loads a key from [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded. [b]Note:[/b] [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. @@ -27,16 +27,16 @@ </method> <method name="load_from_string"> <return type="int" enum="Error" /> - <argument index="0" name="string_key" type="String" /> - <argument index="1" name="public_only" type="bool" default="false" /> + <param index="0" name="string_key" type="String" /> + <param index="1" name="public_only" type="bool" default="false" /> <description> Loads a key from the given [code]string[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded. </description> </method> <method name="save"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="public_only" type="bool" default="false" /> + <param index="0" name="path" type="String" /> + <param index="1" name="public_only" type="bool" default="false" /> <description> Saves a key to the given [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be saved. [b]Note:[/b] [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. @@ -44,7 +44,7 @@ </method> <method name="save_to_string"> <return type="String" /> - <argument index="0" name="public_only" type="bool" default="false" /> + <param index="0" name="public_only" type="bool" default="false" /> <description> Returns a string containing the key in PEM format. If [code]public_only[/code] is [code]true[/code], only the public key will be included. </description> diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 179b0344c2..ca6c92f2aa 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -12,11 +12,11 @@ <methods> <method name="add_point"> <return type="int" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="left_tangent" type="float" default="0" /> - <argument index="2" name="right_tangent" type="float" default="0" /> - <argument index="3" name="left_mode" type="int" enum="Curve.TangentMode" default="0" /> - <argument index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="0" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="left_tangent" type="float" default="0" /> + <param index="2" name="right_tangent" type="float" default="0" /> + <param index="3" name="left_mode" type="int" enum="Curve.TangentMode" default="0" /> + <param index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="0" /> <description> Adds a point to the curve. For each side, if the [code]*_mode[/code] is [constant TANGENT_LINEAR], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [constant TANGENT_FREE]. </description> @@ -41,104 +41,104 @@ </method> <method name="get_point_left_mode" qualifiers="const"> <return type="int" enum="Curve.TangentMode" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the left [enum TangentMode] for the point at [code]index[/code]. </description> </method> <method name="get_point_left_tangent" qualifiers="const"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the left tangent angle (in degrees) for the point at [code]index[/code]. </description> </method> <method name="get_point_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the curve coordinates for the point at [code]index[/code]. </description> </method> <method name="get_point_right_mode" qualifiers="const"> <return type="int" enum="Curve.TangentMode" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the right [enum TangentMode] for the point at [code]index[/code]. </description> </method> <method name="get_point_right_tangent" qualifiers="const"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the right tangent angle (in degrees) for the point at [code]index[/code]. </description> </method> <method name="interpolate" qualifiers="const"> <return type="float" /> - <argument index="0" name="offset" type="float" /> + <param index="0" name="offset" type="float" /> <description> Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve. </description> </method> <method name="interpolate_baked" qualifiers="const"> <return type="float" /> - <argument index="0" name="offset" type="float" /> + <param index="0" name="offset" type="float" /> <description> Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked. </description> </method> <method name="remove_point"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes the point at [code]index[/code] from the curve. </description> </method> <method name="set_point_left_mode"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="mode" type="int" enum="Curve.TangentMode" /> + <param index="0" name="index" type="int" /> + <param index="1" name="mode" type="int" enum="Curve.TangentMode" /> <description> Sets the left [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. </description> </method> <method name="set_point_left_tangent"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="tangent" type="float" /> + <param index="0" name="index" type="int" /> + <param index="1" name="tangent" type="float" /> <description> Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code]. </description> </method> <method name="set_point_offset"> <return type="int" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="offset" type="float" /> + <param index="0" name="index" type="int" /> + <param index="1" name="offset" type="float" /> <description> Sets the offset from [code]0.5[/code]. </description> </method> <method name="set_point_right_mode"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="mode" type="int" enum="Curve.TangentMode" /> + <param index="0" name="index" type="int" /> + <param index="1" name="mode" type="int" enum="Curve.TangentMode" /> <description> Sets the right [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. </description> </method> <method name="set_point_right_tangent"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="tangent" type="float" /> + <param index="0" name="index" type="int" /> + <param index="1" name="tangent" type="float" /> <description> Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code]. </description> </method> <method name="set_point_value"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="y" type="float" /> + <param index="0" name="index" type="int" /> + <param index="1" name="y" type="float" /> <description> Assigns the vertical position [code]y[/code] to the point at [code]index[/code]. </description> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 3bba825aaa..09e6e23410 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -12,10 +12,10 @@ <methods> <method name="add_point"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="in" type="Vector2" default="Vector2(0, 0)" /> - <argument index="2" name="out" type="Vector2" default="Vector2(0, 0)" /> - <argument index="3" name="at_position" type="int" default="-1" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="in" type="Vector2" default="Vector2(0, 0)" /> + <param index="2" name="out" type="Vector2" default="Vector2(0, 0)" /> + <param index="3" name="at_position" type="int" default="-1" /> <description> Adds a point to a curve at [code]position[/code] relative to the [Curve2D]'s position, with control points [code]in[/code] and [code]out[/code]. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. @@ -41,7 +41,7 @@ </method> <method name="get_closest_offset" qualifiers="const"> <return type="float" /> - <argument index="0" name="to_point" type="Vector2" /> + <param index="0" name="to_point" type="Vector2" /> <description> Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked]. [code]to_point[/code] must be in this curve's local space. @@ -49,7 +49,7 @@ </method> <method name="get_closest_point" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="to_point" type="Vector2" /> + <param index="0" name="to_point" type="Vector2" /> <description> Returns the closest baked point (in curve's local space) to [code]to_point[/code]. [code]to_point[/code] must be in this curve's local space. @@ -57,29 +57,29 @@ </method> <method name="get_point_in" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. </description> </method> <method name="get_point_out" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. </description> </method> <method name="get_point_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. </description> </method> <method name="interpolate" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="t" type="float" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="t" type="float" /> <description> Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 >= t <=1[/code]) give strange, but predictable results. If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0)[/code]. @@ -87,8 +87,8 @@ </method> <method name="interpolate_baked" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="offset" type="float" /> - <argument index="1" name="cubic" type="bool" default="false" /> + <param index="0" name="offset" type="float" /> + <param index="1" name="cubic" type="bool" default="false" /> <description> Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve. To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. @@ -97,46 +97,46 @@ </method> <method name="interpolatef" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="fofs" type="float" /> + <param index="0" name="fofs" type="float" /> <description> Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code]. </description> </method> <method name="remove_point"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. </description> </method> <method name="set_point_in"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="position" type="Vector2" /> <description> Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. </description> </method> <method name="set_point_out"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="position" type="Vector2" /> <description> Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. </description> </method> <method name="set_point_position"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="position" type="Vector2" /> <description> Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="tessellate" qualifiers="const"> <return type="PackedVector2Array" /> - <argument index="0" name="max_stages" type="int" default="5" /> - <argument index="1" name="tolerance_degrees" type="float" default="4" /> + <param index="0" name="max_stages" type="int" default="5" /> + <param index="1" name="tolerance_degrees" type="float" default="4" /> <description> 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. diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 6457d9681e..7115da8543 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -12,10 +12,10 @@ <methods> <method name="add_point"> <return type="void" /> - <argument index="0" name="position" type="Vector3" /> - <argument index="1" name="in" type="Vector3" default="Vector3(0, 0, 0)" /> - <argument index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)" /> - <argument index="3" name="at_position" type="int" default="-1" /> + <param index="0" name="position" type="Vector3" /> + <param index="1" name="in" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="3" name="at_position" type="int" default="-1" /> <description> Adds a point to a curve at [code]position[/code] relative to the [Curve3D]'s position, with control points [code]in[/code] and [code]out[/code]. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. @@ -54,7 +54,7 @@ </method> <method name="get_closest_offset" qualifiers="const"> <return type="float" /> - <argument index="0" name="to_point" type="Vector3" /> + <param index="0" name="to_point" type="Vector3" /> <description> Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked] or [method interpolate_baked_up_vector]. [code]to_point[/code] must be in this curve's local space. @@ -62,7 +62,7 @@ </method> <method name="get_closest_point" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="to_point" type="Vector3" /> + <param index="0" name="to_point" type="Vector3" /> <description> Returns the closest baked point (in curve's local space) to [code]to_point[/code]. [code]to_point[/code] must be in this curve's local space. @@ -70,36 +70,36 @@ </method> <method name="get_point_in" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. </description> </method> <method name="get_point_out" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. </description> </method> <method name="get_point_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. </description> </method> <method name="get_point_tilt" qualifiers="const"> <return type="float" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code]0[/code]. </description> </method> <method name="interpolate" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="t" type="float" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="t" type="float" /> <description> Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 >= t <=1[/code]) give strange, but predictable results. If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. @@ -107,8 +107,8 @@ </method> <method name="interpolate_baked" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="offset" type="float" /> - <argument index="1" name="cubic" type="bool" default="false" /> + <param index="0" name="offset" type="float" /> + <param index="1" name="cubic" type="bool" default="false" /> <description> Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. @@ -117,8 +117,8 @@ </method> <method name="interpolate_baked_up_vector" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="offset" type="float" /> - <argument index="1" name="apply_tilt" type="bool" default="false" /> + <param index="0" name="offset" type="float" /> + <param index="1" name="apply_tilt" type="bool" default="false" /> <description> Returns an up vector within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. To do that, it finds the two cached up vectors where the [code]offset[/code] lies between, then interpolates the values. If [code]apply_tilt[/code] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector. @@ -127,46 +127,46 @@ </method> <method name="interpolatef" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="fofs" type="float" /> + <param index="0" name="fofs" type="float" /> <description> Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code]. </description> </method> <method name="remove_point"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. </description> </method> <method name="set_point_in"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="position" type="Vector3" /> <description> Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. </description> </method> <method name="set_point_out"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="position" type="Vector3" /> <description> Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. </description> </method> <method name="set_point_position"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="position" type="Vector3" /> <description> Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="set_point_tilt"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="tilt" type="float" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="tilt" type="float" /> <description> Sets the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow3D], this tilt is an offset over the natural tilt the [PathFollow3D] calculates. @@ -174,8 +174,8 @@ </method> <method name="tessellate" qualifiers="const"> <return type="PackedVector3Array" /> - <argument index="0" name="max_stages" type="int" default="5" /> - <argument index="1" name="tolerance_degrees" type="float" default="4" /> + <param index="0" name="max_stages" type="int" default="5" /> + <param index="1" name="tolerance_degrees" type="float" default="4" /> <description> 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. diff --git a/doc/classes/DTLSServer.xml b/doc/classes/DTLSServer.xml index 5d8a2bc16d..562d16fec7 100644 --- a/doc/classes/DTLSServer.xml +++ b/doc/classes/DTLSServer.xml @@ -148,16 +148,16 @@ <methods> <method name="setup"> <return type="int" enum="Error" /> - <argument index="0" name="key" type="CryptoKey" /> - <argument index="1" name="certificate" type="X509Certificate" /> - <argument index="2" name="chain" type="X509Certificate" default="null" /> + <param index="0" name="key" type="CryptoKey" /> + <param index="1" name="certificate" type="X509Certificate" /> + <param index="2" name="chain" type="X509Certificate" default="null" /> <description> Setup the DTLS server to use the given [code]private_key[/code] and provide the given [code]certificate[/code] to clients. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. </description> </method> <method name="take_connection"> <return type="PacketPeerDTLS" /> - <argument index="0" name="udp_peer" type="PacketPeerUDP" /> + <param index="0" name="udp_peer" type="PacketPeerUDP" /> <description> Try to initiate the DTLS handshake with the given [code]udp_peer[/code] which must be already connected (see [method PacketPeerUDP.connect_to_host]). [b]Note:[/b] You must check that the state of the return PacketPeerUDP is [constant PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange. diff --git a/doc/classes/Decal.xml b/doc/classes/Decal.xml index 3322ab4c66..b9d3f1d81e 100644 --- a/doc/classes/Decal.xml +++ b/doc/classes/Decal.xml @@ -14,7 +14,7 @@ <methods> <method name="get_texture" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="type" type="int" enum="Decal.DecalTexture" /> + <param index="0" name="type" type="int" enum="Decal.DecalTexture" /> <description> Returns the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly. For example, instead of [code]albedo_tex = $Decal.get_texture(Decal.TEXTURE_ALBEDO)[/code], use [code]albedo_tex = $Decal.texture_albedo[/code]. @@ -35,8 +35,8 @@ </method> <method name="set_texture"> <return type="void" /> - <argument index="0" name="type" type="int" enum="Decal.DecalTexture" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="type" type="int" enum="Decal.DecalTexture" /> + <param index="1" name="texture" type="Texture2D" /> <description> Sets the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly. For example, instead of [code]$Decal.set_texture(Decal.TEXTURE_ALBEDO, albedo_tex)[/code], use [code]$Decal.texture_albedo = albedo_tex[/code]. diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 6f2ad5205c..68fa069618 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -190,7 +190,7 @@ </constructor> <constructor name="Dictionary"> <return type="Dictionary" /> - <argument index="0" name="from" type="Dictionary" /> + <param index="0" name="from" type="Dictionary" /> <description> Constructs a [Dictionary] as a copy of the given [Dictionary]. </description> @@ -205,14 +205,14 @@ </method> <method name="duplicate" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="deep" type="bool" default="false" /> + <param index="0" name="deep" type="bool" default="false" /> <description> Creates a copy of the dictionary, and returns it. The [code]deep[/code] parameter causes inner dictionaries and arrays to be copied recursively, but does not apply to objects. </description> </method> <method name="erase"> <return type="bool" /> - <argument index="0" name="key" type="Variant" /> + <param index="0" name="key" type="Variant" /> <description> Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. [b]Note:[/b] Don't erase elements while iterating over the dictionary. You can iterate over the [method keys] array instead. @@ -220,15 +220,15 @@ </method> <method name="get" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="key" type="Variant" /> - <argument index="1" name="default" type="Variant" default="null" /> + <param index="0" name="key" type="Variant" /> + <param index="1" name="default" type="Variant" default="null" /> <description> Returns the current value for the specified key in the [Dictionary]. If the key does not exist, the method returns the value of the optional default argument, or [code]null[/code] if it is omitted. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="key" type="Variant" /> + <param index="0" name="key" type="Variant" /> <description> Returns [code]true[/code] if the dictionary has a given key. [b]Note:[/b] This is equivalent to using the [code]in[/code] operator as follows: @@ -251,7 +251,7 @@ </method> <method name="has_all" qualifiers="const"> <return type="bool" /> - <argument index="0" name="keys" type="Array" /> + <param index="0" name="keys" type="Array" /> <description> Returns [code]true[/code] if the dictionary has all the keys in the given array. </description> @@ -293,8 +293,8 @@ </method> <method name="merge"> <return type="void" /> - <argument index="0" name="dictionary" type="Dictionary" /> - <argument index="1" name="overwrite" type="bool" default="false" /> + <param index="0" name="dictionary" type="Dictionary" /> + <param index="1" name="overwrite" type="bool" default="false" /> <description> Adds elements from [code]dictionary[/code] to this [Dictionary]. By default, duplicate keys will not be copied over, unless [code]overwrite[/code] is [code]true[/code]. </description> @@ -315,19 +315,19 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Dictionary" /> + <param index="0" name="right" type="Dictionary" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Dictionary" /> + <param index="0" name="right" type="Dictionary" /> <description> </description> </operator> <operator name="operator []"> <return type="Variant" /> - <argument index="0" name="key" type="Variant" /> + <param index="0" name="key" type="Variant" /> <description> </description> </operator> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index bd16fd3936..c3eb469934 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -59,7 +59,7 @@ <methods> <method name="change_dir"> <return type="int" enum="Error" /> - <argument index="0" name="todir" type="String" /> + <param index="0" name="todir" type="String" /> <description> Changes the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -67,8 +67,8 @@ </method> <method name="copy"> <return type="int" enum="Error" /> - <argument index="0" name="from" type="String" /> - <argument index="1" name="to" type="String" /> + <param index="0" name="from" type="String" /> + <param index="1" name="to" type="String" /> <description> Copies the [code]from[/code] file to the [code]to[/code] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -82,7 +82,7 @@ </method> <method name="dir_exists"> <return type="bool" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. If the [Directory] is not open, the path is relative to [code]res://[/code]. @@ -90,7 +90,7 @@ </method> <method name="file_exists"> <return type="bool" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. If the [Directory] is not open, the path is relative to [code]res://[/code]. @@ -117,7 +117,7 @@ </method> <method name="get_drive"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> On Windows, returns the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On macOS, returns the path to the mounted volume passed as an argument. @@ -170,7 +170,7 @@ </method> <method name="make_dir"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -178,7 +178,7 @@ </method> <method name="make_dir_recursive"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Creates a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -186,7 +186,7 @@ </method> <method name="open"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Opens an existing directory of the filesystem. The [code]path[/code] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -194,7 +194,7 @@ </method> <method name="remove"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Permanently deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. If you don't want to delete the file/directory permanently, use [method OS.move_to_trash] instead. @@ -203,8 +203,8 @@ </method> <method name="rename"> <return type="int" enum="Error" /> - <argument index="0" name="from" type="String" /> - <argument index="1" name="to" type="String" /> + <param index="0" name="from" type="String" /> + <param index="1" name="to" type="String" /> <description> Renames (move) the [code]from[/code] file or directory to the [code]to[/code] destination. Both arguments should be paths to files or directories, either relative or absolute. If the destination file or directory exists and is not access-protected, it will be overwritten. Returns one of the [enum Error] code constants ([code]OK[/code] on success). diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index bc6cd88fa5..e642bc7b73 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -28,14 +28,14 @@ </method> <method name="clipboard_set"> <return type="void" /> - <argument index="0" name="clipboard" type="String" /> + <param index="0" name="clipboard" type="String" /> <description> Sets the user's clipboard content to the given string. </description> </method> <method name="clipboard_set_primary"> <return type="void" /> - <argument index="0" name="clipboard_primary" type="String" /> + <param index="0" name="clipboard_primary" type="String" /> <description> Sets the user's primary clipboard content to the given string. [b]Note:[/b] This method is only implemented on Linux. @@ -43,10 +43,10 @@ </method> <method name="create_sub_window"> <return type="int" /> - <argument index="0" name="mode" type="int" enum="DisplayServer.WindowMode" /> - <argument index="1" name="vsync_mode" type="int" enum="DisplayServer.VSyncMode" /> - <argument index="2" name="flags" type="int" /> - <argument index="3" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" /> + <param index="0" name="mode" type="int" enum="DisplayServer.WindowMode" /> + <param index="1" name="vsync_mode" type="int" enum="DisplayServer.VSyncMode" /> + <param index="2" name="flags" type="int" /> + <param index="3" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" /> <description> </description> </method> @@ -57,45 +57,45 @@ </method> <method name="cursor_set_custom_image"> <return type="void" /> - <argument index="0" name="cursor" type="Resource" /> - <argument index="1" name="shape" type="int" enum="DisplayServer.CursorShape" default="0" /> - <argument index="2" name="hotspot" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="cursor" type="Resource" /> + <param index="1" name="shape" type="int" enum="DisplayServer.CursorShape" default="0" /> + <param index="2" name="hotspot" type="Vector2" default="Vector2(0, 0)" /> <description> </description> </method> <method name="cursor_set_shape"> <return type="void" /> - <argument index="0" name="shape" type="int" enum="DisplayServer.CursorShape" /> + <param index="0" name="shape" type="int" enum="DisplayServer.CursorShape" /> <description> </description> </method> <method name="delete_sub_window"> <return type="void" /> - <argument index="0" name="window_id" type="int" /> + <param index="0" name="window_id" type="int" /> <description> </description> </method> <method name="dialog_input_text"> <return type="int" enum="Error" /> - <argument index="0" name="title" type="String" /> - <argument index="1" name="description" type="String" /> - <argument index="2" name="existing_text" type="String" /> - <argument index="3" name="callback" type="Callable" /> + <param index="0" name="title" type="String" /> + <param index="1" name="description" type="String" /> + <param index="2" name="existing_text" type="String" /> + <param index="3" name="callback" type="Callable" /> <description> </description> </method> <method name="dialog_show"> <return type="int" enum="Error" /> - <argument index="0" name="title" type="String" /> - <argument index="1" name="description" type="String" /> - <argument index="2" name="buttons" type="PackedStringArray" /> - <argument index="3" name="callback" type="Callable" /> + <param index="0" name="title" type="String" /> + <param index="1" name="description" type="String" /> + <param index="2" name="buttons" type="PackedStringArray" /> + <param index="3" name="callback" type="Callable" /> <description> </description> </method> <method name="enable_for_stealing_focus"> <return type="void" /> - <argument index="0" name="process_id" type="int" /> + <param index="0" name="process_id" type="int" /> <description> </description> </method> @@ -134,7 +134,7 @@ </method> <method name="get_window_at_screen_position" qualifiers="const"> <return type="int" /> - <argument index="0" name="position" type="Vector2i" /> + <param index="0" name="position" type="Vector2i" /> <description> </description> </method> @@ -145,12 +145,12 @@ </method> <method name="global_menu_add_check_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="label" type="String" /> - <argument index="2" name="callback" type="Callable" /> - <argument index="3" name="tag" type="Variant" default="null" /> - <argument index="4" name="accelerator" type="int" enum="Key" default="0" /> - <argument index="5" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="label" type="String" /> + <param index="2" name="callback" type="Callable" /> + <param index="3" name="tag" type="Variant" default="null" /> + <param index="4" name="accelerator" type="int" enum="Key" default="0" /> + <param index="5" name="index" type="int" default="-1" /> <description> Adds a new checkable item with text [code]label[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -163,13 +163,13 @@ </method> <method name="global_menu_add_icon_check_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="icon" type="Texture2D" /> - <argument index="2" name="label" type="String" /> - <argument index="3" name="callback" type="Callable" /> - <argument index="4" name="tag" type="Variant" default="null" /> - <argument index="5" name="accelerator" type="int" enum="Key" default="0" /> - <argument index="6" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="icon" type="Texture2D" /> + <param index="2" name="label" type="String" /> + <param index="3" name="callback" type="Callable" /> + <param index="4" name="tag" type="Variant" default="null" /> + <param index="5" name="accelerator" type="int" enum="Key" default="0" /> + <param index="6" name="index" type="int" default="-1" /> <description> Adds a new checkable item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -182,13 +182,13 @@ </method> <method name="global_menu_add_icon_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="icon" type="Texture2D" /> - <argument index="2" name="label" type="String" /> - <argument index="3" name="callback" type="Callable" /> - <argument index="4" name="tag" type="Variant" default="null" /> - <argument index="5" name="accelerator" type="int" enum="Key" default="0" /> - <argument index="6" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="icon" type="Texture2D" /> + <param index="2" name="label" type="String" /> + <param index="3" name="callback" type="Callable" /> + <param index="4" name="tag" type="Variant" default="null" /> + <param index="5" name="accelerator" type="int" enum="Key" default="0" /> + <param index="6" name="index" type="int" default="-1" /> <description> Adds a new item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -201,13 +201,13 @@ </method> <method name="global_menu_add_icon_radio_check_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="icon" type="Texture2D" /> - <argument index="2" name="label" type="String" /> - <argument index="3" name="callback" type="Callable" /> - <argument index="4" name="tag" type="Variant" default="null" /> - <argument index="5" name="accelerator" type="int" enum="Key" default="0" /> - <argument index="6" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="icon" type="Texture2D" /> + <param index="2" name="label" type="String" /> + <param index="3" name="callback" type="Callable" /> + <param index="4" name="tag" type="Variant" default="null" /> + <param index="5" name="accelerator" type="int" enum="Key" default="0" /> + <param index="6" name="index" type="int" default="-1" /> <description> Adds a new radio-checkable item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method global_menu_set_item_checked] for more info on how to control it. @@ -221,12 +221,12 @@ </method> <method name="global_menu_add_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="label" type="String" /> - <argument index="2" name="callback" type="Callable" /> - <argument index="3" name="tag" type="Variant" default="null" /> - <argument index="4" name="accelerator" type="int" enum="Key" default="0" /> - <argument index="5" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="label" type="String" /> + <param index="2" name="callback" type="Callable" /> + <param index="3" name="tag" type="Variant" default="null" /> + <param index="4" name="accelerator" type="int" enum="Key" default="0" /> + <param index="5" name="index" type="int" default="-1" /> <description> Adds a new item with text [code]label[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -239,14 +239,14 @@ </method> <method name="global_menu_add_multistate_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="labe" type="String" /> - <argument index="2" name="max_states" type="int" /> - <argument index="3" name="default_state" type="int" /> - <argument index="4" name="callback" type="Callable" /> - <argument index="5" name="tag" type="Variant" default="null" /> - <argument index="6" name="accelerator" type="int" enum="Key" default="0" /> - <argument index="7" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="labe" type="String" /> + <param index="2" name="max_states" type="int" /> + <param index="3" name="default_state" type="int" /> + <param index="4" name="callback" type="Callable" /> + <param index="5" name="tag" type="Variant" default="null" /> + <param index="6" name="accelerator" type="int" enum="Key" default="0" /> + <param index="7" name="index" type="int" default="-1" /> <description> Adds a new item with text [code]label[/code] to the global menu with ID [code]menu_root[/code]. Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code]. @@ -260,12 +260,12 @@ </method> <method name="global_menu_add_radio_check_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="label" type="String" /> - <argument index="2" name="callback" type="Callable" /> - <argument index="3" name="tag" type="Variant" default="null" /> - <argument index="4" name="accelerator" type="int" enum="Key" default="0" /> - <argument index="5" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="label" type="String" /> + <param index="2" name="callback" type="Callable" /> + <param index="3" name="tag" type="Variant" default="null" /> + <param index="4" name="accelerator" type="int" enum="Key" default="0" /> + <param index="5" name="index" type="int" default="-1" /> <description> Adds a new radio-checkable item with text [code]label[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method global_menu_set_item_checked] for more info on how to control it. @@ -279,8 +279,8 @@ </method> <method name="global_menu_add_separator"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="index" type="int" default="-1" /> <description> Adds a separator between items to the global menu with ID [code]menu_root[/code]. Separators also occupy an index. [b]Note:[/b] This method is implemented on macOS. @@ -293,10 +293,10 @@ </method> <method name="global_menu_add_submenu_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="label" type="String" /> - <argument index="2" name="submenu" type="String" /> - <argument index="3" name="index" type="int" default="-1" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="label" type="String" /> + <param index="2" name="submenu" type="String" /> + <param index="3" name="index" type="int" default="-1" /> <description> Adds an item that will act as a submenu of the global menu [code]menu_root[/code]. The [code]submenu[/code] argument is the ID of the global menu root that will be shown when the item is clicked. [b]Note:[/b] This method is implemented on macOS. @@ -309,7 +309,7 @@ </method> <method name="global_menu_clear"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> + <param index="0" name="menu_root" type="String" /> <description> Removes all items from the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -322,8 +322,8 @@ </method> <method name="global_menu_get_item_accelerator" qualifiers="const"> <return type="int" enum="Key" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. [b]Note:[/b] This method is implemented on macOS. @@ -331,8 +331,8 @@ </method> <method name="global_menu_get_item_callback" qualifiers="const"> <return type="Callable" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns the callback of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -340,8 +340,8 @@ </method> <method name="global_menu_get_item_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns the icon of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -349,8 +349,8 @@ </method> <method name="global_menu_get_item_index_from_tag" qualifiers="const"> <return type="int" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="tag" type="Variant" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="tag" type="Variant" /> <description> Returns the index of the item with the specified [code]tag[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually. [b]Note:[/b] This method is implemented on macOS. @@ -358,8 +358,8 @@ </method> <method name="global_menu_get_item_index_from_text" qualifiers="const"> <return type="int" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="text" type="String" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="text" type="String" /> <description> Returns the index of the item with the specified [code]text[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually. [b]Note:[/b] This method is implemented on macOS. @@ -367,8 +367,8 @@ </method> <method name="global_menu_get_item_max_states" qualifiers="const"> <return type="int" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns number of states of an multistate item. See [method global_menu_add_multistate_item] for details. [b]Note:[/b] This method is implemented on macOS. @@ -376,8 +376,8 @@ </method> <method name="global_menu_get_item_state" qualifiers="const"> <return type="int" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns the state of an multistate item. See [method global_menu_add_multistate_item] for details. [b]Note:[/b] This method is implemented on macOS. @@ -385,8 +385,8 @@ </method> <method name="global_menu_get_item_submenu" qualifiers="const"> <return type="String" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns the submenu ID of the item at index [code]idx[/code]. See [method global_menu_add_submenu_item] for more info on how to add a submenu. [b]Note:[/b] This method is implemented on macOS. @@ -394,8 +394,8 @@ </method> <method name="global_menu_get_item_tag" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns the metadata of the specified item, which might be of any type. You can set it with [method global_menu_set_item_tag], which provides a simple way of assigning context data to items. [b]Note:[/b] This method is implemented on macOS. @@ -403,8 +403,8 @@ </method> <method name="global_menu_get_item_text" qualifiers="const"> <return type="String" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns the text of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -412,8 +412,8 @@ </method> <method name="global_menu_get_item_tooltip" qualifiers="const"> <return type="String" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns the tooltip associated with the specified index index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -421,8 +421,8 @@ </method> <method name="global_menu_is_item_checkable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns [code]true[/code] if the item at index [code]idx[/code] is checkable in some way, i.e. if it has a checkbox or radio button. [b]Note:[/b] This method is implemented on macOS. @@ -430,8 +430,8 @@ </method> <method name="global_menu_is_item_checked" qualifiers="const"> <return type="bool" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns [code]true[/code] if the item at index [code]idx[/code] is checked. [b]Note:[/b] This method is implemented on macOS. @@ -439,8 +439,8 @@ </method> <method name="global_menu_is_item_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. When it is disabled it can't be selected, or its action invoked. See [method global_menu_set_item_disabled] for more info on how to disable an item. @@ -449,8 +449,8 @@ </method> <method name="global_menu_is_item_radio_checkable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Returns [code]true[/code] if the item at index [code]idx[/code] has radio button-style checkability. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. @@ -459,8 +459,8 @@ </method> <method name="global_menu_remove_item"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> <description> Removes the item at index [code]idx[/code] from the global menu [code]menu_root[/code]. [b]Note:[/b] The indices of items after the removed item will be shifted by one. @@ -469,9 +469,9 @@ </method> <method name="global_menu_set_item_accelerator"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="keycode" type="int" enum="Key" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="keycode" type="int" enum="Key" /> <description> Sets the accelerator of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -479,9 +479,9 @@ </method> <method name="global_menu_set_item_callback"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="callback" type="Callable" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="callback" type="Callable" /> <description> Sets the callback of the item at index [code]idx[/code]. Callback is emitted when an item is pressed or its accelerator is activated. [b]Note:[/b] This method is implemented on macOS. @@ -489,9 +489,9 @@ </method> <method name="global_menu_set_item_checkable"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="checkable" type="bool" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="checkable" type="bool" /> <description> Sets whether the item at index [code]idx[/code] has a checkbox. If [code]false[/code], sets the type of the item to plain text. [b]Note:[/b] This method is implemented on macOS. @@ -499,9 +499,9 @@ </method> <method name="global_menu_set_item_checked"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="checked" type="bool" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="checked" type="bool" /> <description> Sets the checkstate status of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -509,9 +509,9 @@ </method> <method name="global_menu_set_item_disabled"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="disabled" type="bool" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="disabled" type="bool" /> <description> Enables/disables the item at index [code]idx[/code]. When it is disabled, it can't be selected and its action can't be invoked. [b]Note:[/b] This method is implemented on macOS. @@ -519,9 +519,9 @@ </method> <method name="global_menu_set_item_icon"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="icon" type="Texture2D" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="icon" type="Texture2D" /> <description> Replaces the [Texture2D] icon of the specified [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -530,9 +530,9 @@ </method> <method name="global_menu_set_item_max_states"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="max_states" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="max_states" type="int" /> <description> Sets number of state of an multistate item. See [method global_menu_add_multistate_item] for details. [b]Note:[/b] This method is implemented on macOS. @@ -540,9 +540,9 @@ </method> <method name="global_menu_set_item_radio_checkable"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="checkable" type="bool" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="checkable" type="bool" /> <description> Sets the type of the item at the specified index [code]idx[/code] to radio button. If [code]false[/code], sets the type of the item to plain text [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. @@ -551,9 +551,9 @@ </method> <method name="global_menu_set_item_state"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="state" type="int" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="state" type="int" /> <description> Sets the state of an multistate item. See [method global_menu_add_multistate_item] for details. [b]Note:[/b] This method is implemented on macOS. @@ -561,9 +561,9 @@ </method> <method name="global_menu_set_item_submenu"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="submenu" type="String" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="submenu" type="String" /> <description> Sets the submenu of the item at index [code]idx[/code]. The submenu is the ID of a global menu root that would be shown when the item is clicked. [b]Note:[/b] This method is implemented on macOS. @@ -571,9 +571,9 @@ </method> <method name="global_menu_set_item_tag"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="tag" type="Variant" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="tag" type="Variant" /> <description> Sets the metadata of an item, which may be of any type. You can later get it with [method global_menu_get_item_tag], which provides a simple way of assigning context data to items. [b]Note:[/b] This method is implemented on macOS. @@ -581,9 +581,9 @@ </method> <method name="global_menu_set_item_text"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="text" type="String" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="text" type="String" /> <description> Sets the text of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -591,9 +591,9 @@ </method> <method name="global_menu_set_item_tooltip"> <return type="void" /> - <argument index="0" name="menu_root" type="String" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="tooltip" type="String" /> + <param index="0" name="menu_root" type="String" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="tooltip" type="String" /> <description> Sets the [String] tooltip of the item at the specified index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -601,7 +601,7 @@ </method> <method name="has_feature" qualifiers="const"> <return type="bool" /> - <argument index="0" name="feature" type="int" enum="DisplayServer.Feature" /> + <param index="0" name="feature" type="int" enum="DisplayServer.Feature" /> <description> </description> </method> @@ -624,7 +624,7 @@ </method> <method name="keyboard_get_keycode_from_physical" qualifiers="const"> <return type="int" enum="Key" /> - <argument index="0" name="keycode" type="int" enum="Key" /> + <param index="0" name="keycode" type="int" enum="Key" /> <description> Converts a physical (US QWERTY) [code]keycode[/code] to one in the active keyboard layout. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. @@ -639,7 +639,7 @@ </method> <method name="keyboard_get_layout_language" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the ISO-639/BCP-47 language code of the keyboard layout at position [code]index[/code]. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. @@ -647,7 +647,7 @@ </method> <method name="keyboard_get_layout_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the localized name of the keyboard layout at position [code]index[/code]. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. @@ -655,7 +655,7 @@ </method> <method name="keyboard_set_current_layout"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Sets active keyboard layout. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. @@ -679,7 +679,7 @@ </method> <method name="mouse_set_mode"> <return type="void" /> - <argument index="0" name="mouse_mode" type="int" enum="DisplayServer.MouseMode" /> + <param index="0" name="mouse_mode" type="int" enum="DisplayServer.MouseMode" /> <description> </description> </method> @@ -690,7 +690,7 @@ </method> <method name="screen_get_dpi" qualifiers="const"> <return type="int" /> - <argument index="0" name="screen" type="int" default="-1" /> + <param index="0" name="screen" type="int" default="-1" /> <description> Returns the dots per inch density of the specified screen. If [code]screen[/code] is [/code]SCREEN_OF_MAIN_WINDOW[/code] (the default value), a screen with the main window will be used. [b]Note:[/b] On macOS, returned value is inaccurate if fractional display scaling mode is used. @@ -716,19 +716,19 @@ </method> <method name="screen_get_orientation" qualifiers="const"> <return type="int" enum="DisplayServer.ScreenOrientation" /> - <argument index="0" name="screen" type="int" default="-1" /> + <param index="0" name="screen" type="int" default="-1" /> <description> </description> </method> <method name="screen_get_position" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="screen" type="int" default="-1" /> + <param index="0" name="screen" type="int" default="-1" /> <description> </description> </method> <method name="screen_get_refresh_rate" qualifiers="const"> <return type="float" /> - <argument index="0" name="screen" type="int" default="-1" /> + <param index="0" name="screen" type="int" default="-1" /> <description> Returns the current refresh rate of the specified screen. If [code]screen[/code] is [constant SCREEN_OF_MAIN_WINDOW] (the default value), a screen with the main window will be used. [b]Note:[/b] Returns [code]-1.0[/code] if the DisplayServer fails to find the refresh rate for the specified screen. On HTML5, [method screen_get_refresh_rate] will always return [code]-1.0[/code] as there is no way to retrieve the refresh rate on that platform. @@ -742,7 +742,7 @@ </method> <method name="screen_get_scale" qualifiers="const"> <return type="float" /> - <argument index="0" name="screen" type="int" default="-1" /> + <param index="0" name="screen" type="int" default="-1" /> <description> Returns the scale factor of the specified screen by index. [b]Note:[/b] On macOS returned value is [code]2.0[/code] for hiDPI (Retina) screen, and [code]1.0[/code] for all other cases. @@ -751,13 +751,13 @@ </method> <method name="screen_get_size" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="screen" type="int" default="-1" /> + <param index="0" name="screen" type="int" default="-1" /> <description> </description> </method> <method name="screen_get_usable_rect" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="screen" type="int" default="-1" /> + <param index="0" name="screen" type="int" default="-1" /> <description> </description> </method> @@ -768,32 +768,32 @@ </method> <method name="screen_is_touchscreen" qualifiers="const"> <return type="bool" /> - <argument index="0" name="screen" type="int" default="-1" /> + <param index="0" name="screen" type="int" default="-1" /> <description> </description> </method> <method name="screen_set_keep_on"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> </description> </method> <method name="screen_set_orientation"> <return type="void" /> - <argument index="0" name="orientation" type="int" enum="DisplayServer.ScreenOrientation" /> - <argument index="1" name="screen" type="int" default="-1" /> + <param index="0" name="orientation" type="int" enum="DisplayServer.ScreenOrientation" /> + <param index="1" name="screen" type="int" default="-1" /> <description> </description> </method> <method name="set_icon"> <return type="void" /> - <argument index="0" name="image" type="Image" /> + <param index="0" name="image" type="Image" /> <description> </description> </method> <method name="set_native_icon"> <return type="void" /> - <argument index="0" name="filename" type="String" /> + <param index="0" name="filename" type="String" /> <description> </description> </method> @@ -813,7 +813,7 @@ </method> <method name="tablet_get_driver_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the tablet driver name for the given index. [b]Note:[/b] This method is implemented on Windows. @@ -821,7 +821,7 @@ </method> <method name="tablet_set_current_driver"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Set active tablet driver name. [b]Note:[/b] This method is implemented on Windows. @@ -840,7 +840,7 @@ </method> <method name="tts_get_voices_for_language" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="language" type="String" /> + <param index="0" name="language" type="String" /> <description> Returns an [PackedStringArray] of voice identifiers for the [code]language[/code]. [b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. @@ -876,8 +876,8 @@ </method> <method name="tts_set_utterance_callback"> <return type="void" /> - <argument index="0" name="event" type="int" enum="DisplayServer.TTSUtteranceEvent" /> - <argument index="1" name="callable" type="Callable" /> + <param index="0" name="event" type="int" enum="DisplayServer.TTSUtteranceEvent" /> + <param index="1" name="callable" type="Callable" /> <description> Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary. - [code]TTS_UTTERANCE_STARTED[/code], [code]TTS_UTTERANCE_ENDED[/code], and [code]TTS_UTTERANCE_CANCELED[/code] callable's method should take one [int] parameter, the utterance id. @@ -888,13 +888,13 @@ </method> <method name="tts_speak"> <return type="void" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="voice" type="String" /> - <argument index="2" name="volume" type="int" default="50" /> - <argument index="3" name="pitch" type="float" default="1.0" /> - <argument index="4" name="rate" type="float" default="1.0" /> - <argument index="5" name="utterance_id" type="int" default="0" /> - <argument index="6" name="interrupt" type="bool" default="false" /> + <param index="0" name="text" type="String" /> + <param index="1" name="voice" type="String" /> + <param index="2" name="volume" type="int" default="50" /> + <param index="3" name="pitch" type="float" default="1.0" /> + <param index="4" name="rate" type="float" default="1.0" /> + <param index="5" name="utterance_id" type="int" default="0" /> + <param index="6" name="interrupt" type="bool" default="false" /> <description> Adds an utterance to the queue. If [code]interrupt[/code] is [code]true[/code], the queue is cleared first. - [code]voice[/code] identifier is one of the [code]"id"[/code] values returned by [method tts_get_voices] or one of the values returned by [method tts_get_voices_for_language]. @@ -928,12 +928,12 @@ </method> <method name="virtual_keyboard_show"> <return type="void" /> - <argument index="0" name="existing_text" type="String" /> - <argument index="1" name="position" type="Rect2" default="Rect2(0, 0, 0, 0)" /> - <argument index="2" name="type" type="int" enum="DisplayServer.VirtualKeyboardType" default="0" /> - <argument index="3" name="max_length" type="int" default="-1" /> - <argument index="4" name="cursor_start" type="int" default="-1" /> - <argument index="5" name="cursor_end" type="int" default="-1" /> + <param index="0" name="existing_text" type="String" /> + <param index="1" name="position" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="2" name="type" type="int" enum="DisplayServer.VirtualKeyboardType" default="0" /> + <param index="3" name="max_length" type="int" default="-1" /> + <param index="4" name="cursor_start" type="int" default="-1" /> + <param index="5" name="cursor_end" type="int" default="-1" /> <description> Shows the virtual keyboard if the platform has one. [code]existing_text[/code] parameter is useful for implementing your own [LineEdit] or [TextEdit], as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). @@ -947,21 +947,21 @@ </method> <method name="warp_mouse"> <return type="void" /> - <argument index="0" name="position" type="Vector2i" /> + <param index="0" name="position" type="Vector2i" /> <description> Sets the mouse cursor position to the given [code]position[/code] relative to an origin at the upper left corner of the currently focused game Window Manager window. </description> </method> <method name="window_attach_instance_id"> <return type="void" /> - <argument index="0" name="instance_id" type="int" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="instance_id" type="int" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_can_draw" qualifiers="const"> <return type="bool" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> @@ -973,47 +973,47 @@ </method> <method name="window_get_attached_instance_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_get_current_screen" qualifiers="const"> <return type="int" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_get_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="DisplayServer.WindowFlags" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="flag" type="int" enum="DisplayServer.WindowFlags" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Returns the current value of the given window's [code]flag[/code]. </description> </method> <method name="window_get_max_size" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_get_min_size" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_get_mode" qualifiers="const"> <return type="int" enum="DisplayServer.WindowMode" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> Returns the mode of the given window. </description> </method> <method name="window_get_native_handle" qualifiers="const"> <return type="int" /> - <argument index="0" name="handle_type" type="int" enum="DisplayServer.HandleType" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="handle_type" type="int" enum="DisplayServer.HandleType" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Returns internal structure pointers for use in plugins. [b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows. @@ -1021,67 +1021,67 @@ </method> <method name="window_get_popup_safe_rect" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="window" type="int" /> + <param index="0" name="window" type="int" /> <description> Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. </description> </method> <method name="window_get_position" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> Returns the position of the given window to on the screen. </description> </method> <method name="window_get_real_size" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_get_size" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_get_vsync_mode" qualifiers="const"> <return type="int" enum="DisplayServer.VSyncMode" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> Returns the V-Sync mode of the given window. </description> </method> <method name="window_move_to_foreground"> <return type="void" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_request_attention"> <return type="void" /> - <argument index="0" name="window_id" type="int" default="0" /> + <param index="0" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_current_screen"> <return type="void" /> - <argument index="0" name="screen" type="int" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="screen" type="int" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_drop_files_callback"> <return type="void" /> - <argument index="0" name="callback" type="Callable" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="callback" type="Callable" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_exclusive"> <return type="void" /> - <argument index="0" name="window_id" type="int" /> - <argument index="1" name="exclusive" type="bool" /> + <param index="0" name="window_id" type="int" /> + <param index="1" name="exclusive" type="bool" /> <description> If set to [code]true[/code], this window will always stay on top of its parent window, parent window will ignore input while this window is opened. [b]Note:[/b] On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window. @@ -1090,52 +1090,52 @@ </method> <method name="window_set_flag"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="DisplayServer.WindowFlags" /> - <argument index="1" name="enabled" type="bool" /> - <argument index="2" name="window_id" type="int" default="0" /> + <param index="0" name="flag" type="int" enum="DisplayServer.WindowFlags" /> + <param index="1" name="enabled" type="bool" /> + <param index="2" name="window_id" type="int" default="0" /> <description> Enables or disables the given window's given [code]flag[/code]. See [enum WindowFlags] for possible values and their behavior. </description> </method> <method name="window_set_ime_active"> <return type="void" /> - <argument index="0" name="active" type="bool" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="active" type="bool" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_ime_position"> <return type="void" /> - <argument index="0" name="position" type="Vector2i" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="position" type="Vector2i" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_input_event_callback"> <return type="void" /> - <argument index="0" name="callback" type="Callable" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="callback" type="Callable" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_input_text_callback"> <return type="void" /> - <argument index="0" name="callback" type="Callable" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="callback" type="Callable" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_max_size"> <return type="void" /> - <argument index="0" name="max_size" type="Vector2i" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="max_size" type="Vector2i" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_min_size"> <return type="void" /> - <argument index="0" name="min_size" type="Vector2i" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="min_size" type="Vector2i" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Sets the minimum size for the given window to [code]min_size[/code] (in pixels). [b]Note:[/b] By default, the main window has a minimum size of [code]Vector2i(64, 64)[/code]. This prevents issues that can arise when the window is resized to a near-zero size. @@ -1143,8 +1143,8 @@ </method> <method name="window_set_mode"> <return type="void" /> - <argument index="0" name="mode" type="int" enum="DisplayServer.WindowMode" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="mode" type="int" enum="DisplayServer.WindowMode" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Sets window mode for the given window to [code]mode[/code]. See [enum WindowMode] for possible values and how each mode behaves. [b]Note:[/b] Setting the window to fullscreen forcibly sets the borderless flag to [code]true[/code], so make sure to set it back to [code]false[/code] when not wanted. @@ -1152,8 +1152,8 @@ </method> <method name="window_set_mouse_passthrough"> <return type="void" /> - <argument index="0" name="region" type="PackedVector2Array" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="region" type="PackedVector2Array" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior). @@ -1185,54 +1185,54 @@ </method> <method name="window_set_popup_safe_rect"> <return type="void" /> - <argument index="0" name="window" type="int" /> - <argument index="1" name="rect" type="Rect2i" /> + <param index="0" name="window" type="int" /> + <param index="1" name="rect" type="Rect2i" /> <description> Sets the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. Clicking this area will not auto-close this popup. </description> </method> <method name="window_set_position"> <return type="void" /> - <argument index="0" name="position" type="Vector2i" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="position" type="Vector2i" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Sets the position of the given window to [code]position[/code]. </description> </method> <method name="window_set_rect_changed_callback"> <return type="void" /> - <argument index="0" name="callback" type="Callable" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="callback" type="Callable" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> <method name="window_set_size"> <return type="void" /> - <argument index="0" name="size" type="Vector2i" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="size" type="Vector2i" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Sets the size of the given window to [code]size[/code]. </description> </method> <method name="window_set_title"> <return type="void" /> - <argument index="0" name="title" type="String" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="title" type="String" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Sets the title of the given window to [code]title[/code]. </description> </method> <method name="window_set_transient"> <return type="void" /> - <argument index="0" name="window_id" type="int" /> - <argument index="1" name="parent_window_id" type="int" /> + <param index="0" name="window_id" type="int" /> + <param index="1" name="parent_window_id" type="int" /> <description> </description> </method> <method name="window_set_vsync_mode"> <return type="void" /> - <argument index="0" name="vsync_mode" type="int" enum="DisplayServer.VSyncMode" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="vsync_mode" type="int" enum="DisplayServer.VSyncMode" /> + <param index="1" name="window_id" type="int" default="0" /> <description> Sets the V-Sync mode of the given window. See [enum DisplayServer.VSyncMode] for possible values and how they affect the behavior of your application. @@ -1241,8 +1241,8 @@ </method> <method name="window_set_window_event_callback"> <return type="void" /> - <argument index="0" name="callback" type="Callable" /> - <argument index="1" name="window_id" type="int" default="0" /> + <param index="0" name="callback" type="Callable" /> + <param index="1" name="window_id" type="int" default="0" /> <description> </description> </method> diff --git a/doc/classes/EditorCommandPalette.xml b/doc/classes/EditorCommandPalette.xml index 2cc07c7f1b..23e9349cb5 100644 --- a/doc/classes/EditorCommandPalette.xml +++ b/doc/classes/EditorCommandPalette.xml @@ -27,10 +27,10 @@ <methods> <method name="add_command"> <return type="void" /> - <argument index="0" name="command_name" type="String" /> - <argument index="1" name="key_name" type="String" /> - <argument index="2" name="binded_callable" type="Callable" /> - <argument index="3" name="shortcut_text" type="String" default=""None"" /> + <param index="0" name="command_name" type="String" /> + <param index="1" name="key_name" type="String" /> + <param index="2" name="binded_callable" type="Callable" /> + <param index="3" name="shortcut_text" type="String" default=""None"" /> <description> Adds a custom command to EditorCommandPalette. - [code]command_name[/code]: [String] (Name of the [b]Command[/b]. This is displayed to the user.) @@ -41,7 +41,7 @@ </method> <method name="remove_command"> <return type="void" /> - <argument index="0" name="key_name" type="String" /> + <param index="0" name="key_name" type="String" /> <description> Removes the custom command from EditorCommandPalette. - [code]key_name[/code]: [String] (Name of the key for a particular [b]Command[/b].) diff --git a/doc/classes/EditorDebuggerPlugin.xml b/doc/classes/EditorDebuggerPlugin.xml index ba0a479fa7..0b208fb921 100644 --- a/doc/classes/EditorDebuggerPlugin.xml +++ b/doc/classes/EditorDebuggerPlugin.xml @@ -14,7 +14,7 @@ <methods> <method name="has_capture"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if a message capture with given name is present otherwise [code]false[/code]. </description> @@ -39,8 +39,8 @@ </method> <method name="register_message_capture"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="callable" type="Callable" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="callable" type="Callable" /> <description> Registers a message capture with given [code]name[/code]. If [code]name[/code] is "my_message" then messages starting with "my_message:" will be called with the given callable. Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code]. @@ -48,15 +48,15 @@ </method> <method name="send_message"> <return type="void" /> - <argument index="0" name="message" type="String" /> - <argument index="1" name="data" type="Array" /> + <param index="0" name="message" type="String" /> + <param index="1" name="data" type="Array" /> <description> Sends a message with given [code]message[/code] and [code]data[/code] array. </description> </method> <method name="unregister_message_capture"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Unregisters the message capture with given name. </description> @@ -64,7 +64,7 @@ </methods> <signals> <signal name="breaked"> - <argument index="0" name="can_debug" type="bool" /> + <param index="0" name="can_debug" type="bool" /> <description> Emitted when the game enters a break state. </description> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index f217fbaf48..17697cb20b 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -12,10 +12,10 @@ <methods> <method name="_export_begin" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="features" type="PackedStringArray" /> - <argument index="1" name="is_debug" type="bool" /> - <argument index="2" name="path" type="String" /> - <argument index="3" name="flags" type="int" /> + <param index="0" name="features" type="PackedStringArray" /> + <param index="1" name="is_debug" type="bool" /> + <param index="2" name="path" type="String" /> + <param index="3" name="flags" type="int" /> <description> Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. [code]features[/code] is the list of features for the export, [code]is_debug[/code] is [code]true[/code] for debug builds, [code]path[/code] is the target path for the exported project. [code]flags[/code] is only used when running a runnable profile, e.g. when using native run on Android. </description> @@ -28,9 +28,9 @@ </method> <method name="_export_file" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="type" type="String" /> - <argument index="2" name="features" type="PackedStringArray" /> + <param index="0" name="path" type="String" /> + <param index="1" name="type" type="String" /> + <param index="2" name="features" type="PackedStringArray" /> <description> Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. [code]path[/code] is the path of the file, [code]type[/code] is the [Resource] represented by the file (e.g. [PackedScene]) and [code]features[/code] is the list of features for the export. Calling [method skip] inside this callback will make the file not included in the export. @@ -38,30 +38,30 @@ </method> <method name="add_file"> <return type="void" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="file" type="PackedByteArray" /> - <argument index="2" name="remap" type="bool" /> + <param index="0" name="path" type="String" /> + <param index="1" name="file" type="PackedByteArray" /> + <param index="2" name="remap" type="bool" /> <description> Adds a custom file to be exported. [code]path[/code] is the virtual path that can be used to load the file, [code]file[/code] is the binary data of the file. If [code]remap[/code] is [code]true[/code], file will not be exported, but instead remapped to the given [code]path[/code]. </description> </method> <method name="add_ios_bundle_file"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Adds an iOS bundle file from the given [code]path[/code] to the exported project. </description> </method> <method name="add_ios_cpp_code"> <return type="void" /> - <argument index="0" name="code" type="String" /> + <param index="0" name="code" type="String" /> <description> Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin. </description> </method> <method name="add_ios_embedded_framework"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary. [b]Note:[/b] For static libraries (*.a) works in same way as [code]add_ios_framework[/code]. @@ -70,35 +70,35 @@ </method> <method name="add_ios_framework"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project. </description> </method> <method name="add_ios_linker_flags"> <return type="void" /> - <argument index="0" name="flags" type="String" /> + <param index="0" name="flags" type="String" /> <description> Adds linker flags for the iOS export. </description> </method> <method name="add_ios_plist_content"> <return type="void" /> - <argument index="0" name="plist_content" type="String" /> + <param index="0" name="plist_content" type="String" /> <description> Adds content for iOS Property List files. </description> </method> <method name="add_ios_project_static_lib"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Adds a static lib from the given [code]path[/code] to the iOS project. </description> </method> <method name="add_macos_plugin_file"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Adds file or directory matching [code]path[/code] to [code]PlugIns[/code] directory of macOS app bundle. [b]Note:[/b] This is useful only for macOS exports. @@ -106,9 +106,9 @@ </method> <method name="add_shared_object"> <return type="void" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="tags" type="PackedStringArray" /> - <argument index="2" name="target" type="String" /> + <param index="0" name="path" type="String" /> + <param index="1" name="tags" type="PackedStringArray" /> + <param index="2" name="target" type="String" /> <description> Adds a shared object or a directory containing only shared objects with the given [code]tags[/code] and destination [code]path[/code]. [b]Note:[/b] In case of macOS exports, those shared objects will be added to [code]Frameworks[/code] directory of app bundle. diff --git a/doc/classes/EditorFeatureProfile.xml b/doc/classes/EditorFeatureProfile.xml index a6bdc294ac..f5d6763bce 100644 --- a/doc/classes/EditorFeatureProfile.xml +++ b/doc/classes/EditorFeatureProfile.xml @@ -12,83 +12,83 @@ <methods> <method name="get_feature_name"> <return type="String" /> - <argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" /> + <param index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" /> <description> Returns the specified [code]feature[/code]'s human-readable name. </description> </method> <method name="is_class_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class_name" type="StringName" /> + <param index="0" name="class_name" type="StringName" /> <description> Returns [code]true[/code] if the class specified by [code]class_name[/code] is disabled. When disabled, the class won't appear in the Create New Node dialog. </description> </method> <method name="is_class_editor_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class_name" type="StringName" /> + <param index="0" name="class_name" type="StringName" /> <description> Returns [code]true[/code] if editing for the class specified by [code]class_name[/code] is disabled. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. </description> </method> <method name="is_class_property_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class_name" type="StringName" /> - <argument index="1" name="property" type="StringName" /> + <param index="0" name="class_name" type="StringName" /> + <param index="1" name="property" type="StringName" /> <description> Returns [code]true[/code] if [code]property[/code] is disabled in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code]. </description> </method> <method name="is_feature_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" /> + <param index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" /> <description> Returns [code]true[/code] if the [code]feature[/code] is disabled. When a feature is disabled, it will disappear from the editor entirely. </description> </method> <method name="load_from_file"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's [b]Export[/b] button or the [method save_to_file] method. </description> </method> <method name="save_to_file"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's [b]Import[/b] button or the [method load_from_file] method. </description> </method> <method name="set_disable_class"> <return type="void" /> - <argument index="0" name="class_name" type="StringName" /> - <argument index="1" name="disable" type="bool" /> + <param index="0" name="class_name" type="StringName" /> + <param index="1" name="disable" type="bool" /> <description> If [code]disable[/code] is [code]true[/code], disables the class specified by [code]class_name[/code]. When disabled, the class won't appear in the Create New Node dialog. </description> </method> <method name="set_disable_class_editor"> <return type="void" /> - <argument index="0" name="class_name" type="StringName" /> - <argument index="1" name="disable" type="bool" /> + <param index="0" name="class_name" type="StringName" /> + <param index="1" name="disable" type="bool" /> <description> If [code]disable[/code] is [code]true[/code], disables editing for the class specified by [code]class_name[/code]. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. </description> </method> <method name="set_disable_class_property"> <return type="void" /> - <argument index="0" name="class_name" type="StringName" /> - <argument index="1" name="property" type="StringName" /> - <argument index="2" name="disable" type="bool" /> + <param index="0" name="class_name" type="StringName" /> + <param index="1" name="property" type="StringName" /> + <param index="2" name="disable" type="bool" /> <description> If [code]disable[/code] is [code]true[/code], disables editing for [code]property[/code] in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code]. </description> </method> <method name="set_disable_feature"> <return type="void" /> - <argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" /> - <argument index="1" name="disable" type="bool" /> + <param index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" /> + <param index="1" name="disable" type="bool" /> <description> If [code]disable[/code] is [code]true[/code], disables the editor feature specified in [code]feature[/code]. When a feature is disabled, it will disappear from the editor entirely. </description> diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 6fd5abe369..0b1a85ebd1 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -10,8 +10,8 @@ <methods> <method name="add_filter"> <return type="void" /> - <argument index="0" name="filter" type="String" /> - <argument index="1" name="description" type="String" default="""" /> + <param index="0" name="filter" type="String" /> + <param index="1" name="description" type="String" default="""" /> <description> Adds a comma-delimited file name [code]filter[/code] option to the [EditorFileDialog] with an optional [code]description[/code], which restricts what files can be picked. A [code]filter[/code] should be of the form [code]"filename.extension"[/code], where filename and extension can be [code]*[/code] to match any string. Filters starting with [code].[/code] (i.e. empty filenames) are not allowed. @@ -68,19 +68,19 @@ </members> <signals> <signal name="dir_selected"> - <argument index="0" name="dir" type="String" /> + <param index="0" name="dir" type="String" /> <description> Emitted when a directory is selected. </description> </signal> <signal name="file_selected"> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Emitted when a file is selected. </description> </signal> <signal name="files_selected"> - <argument index="0" name="paths" type="PackedStringArray" /> + <param index="0" name="paths" type="PackedStringArray" /> <description> Emitted when multiple files are selected. </description> diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index 402efba34a..5a14dd0672 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -12,7 +12,7 @@ <methods> <method name="get_file_type" qualifiers="const"> <return type="String" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns the resource type of the file, given the full path. This returns a string such as [code]"Resource"[/code] or [code]"GDScript"[/code], [i]not[/i] a file extension such as [code]".gd"[/code]. </description> @@ -25,7 +25,7 @@ </method> <method name="get_filesystem_path"> <return type="EditorFileSystemDirectory" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns a view into the filesystem at [code]path[/code]. </description> @@ -44,7 +44,7 @@ </method> <method name="reimport_files"> <return type="void" /> - <argument index="0" name="files" type="PackedStringArray" /> + <param index="0" name="files" type="PackedStringArray" /> <description> Reimports a set of files. Call this if these files or their [code].import[/code] files were directly edited by script or an external program. If the file type changed or the file was newly created, use [method update_file] or [method scan]. @@ -65,7 +65,7 @@ </method> <method name="update_file"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program. This will not import the file. To reimport, call [method reimport_files] or [method scan] methods. @@ -85,19 +85,19 @@ </description> </signal> <signal name="resources_reimported"> - <argument index="0" name="resources" type="PackedStringArray" /> + <param index="0" name="resources" type="PackedStringArray" /> <description> Emitted if a resource is reimported. </description> </signal> <signal name="resources_reload"> - <argument index="0" name="resources" type="PackedStringArray" /> + <param index="0" name="resources" type="PackedStringArray" /> <description> Emitted if at least one resource is reloaded when the filesystem is scanned. </description> </signal> <signal name="sources_changed"> - <argument index="0" name="exist" type="bool" /> + <param index="0" name="exist" type="bool" /> <description> Emitted if the source of any imported file changed. </description> diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 98fea40a50..3bc004e522 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -11,21 +11,21 @@ <methods> <method name="find_dir_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found. </description> </method> <method name="find_file_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found. </description> </method> <method name="get_file" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the name of the file at index [code]idx[/code]. </description> @@ -38,35 +38,35 @@ </method> <method name="get_file_import_is_valid" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if the file at index [code]idx[/code] imported properly. </description> </method> <method name="get_file_path" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the path to the file at index [code]idx[/code]. </description> </method> <method name="get_file_script_class_extends" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the base class of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. </description> </method> <method name="get_file_script_class_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the name of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. </description> </method> <method name="get_file_type" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the resource type of the file at index [code]idx[/code]. This returns a string such as [code]"Resource"[/code] or [code]"GDScript"[/code], [i]not[/i] a file extension such as [code]".gd"[/code]. </description> @@ -91,7 +91,7 @@ </method> <method name="get_subdir"> <return type="EditorFileSystemDirectory" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the subdirectory at index [code]idx[/code]. </description> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 2e84d3094f..d3af6c1269 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -116,8 +116,8 @@ <methods> <method name="_get_import_options" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="preset_index" type="int" /> + <param index="0" name="path" type="String" /> + <param index="1" name="preset_index" type="int" /> <description> Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional). </description> @@ -136,9 +136,9 @@ </method> <method name="_get_option_visibility" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="option_name" type="StringName" /> - <argument index="2" name="options" type="Dictionary" /> + <param index="0" name="path" type="String" /> + <param index="1" name="option_name" type="StringName" /> + <param index="2" name="options" type="Dictionary" /> <description> This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: [codeblocks] @@ -174,7 +174,7 @@ </method> <method name="_get_preset_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="preset_index" type="int" /> + <param index="0" name="preset_index" type="int" /> <description> Gets the name of the options preset at this index. </description> @@ -211,11 +211,11 @@ </method> <method name="_import" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="source_file" type="String" /> - <argument index="1" name="save_path" type="String" /> - <argument index="2" name="options" type="Dictionary" /> - <argument index="3" name="platform_variants" type="Array" /> - <argument index="4" name="gen_files" type="Array" /> + <param index="0" name="source_file" type="String" /> + <param index="1" name="save_path" type="String" /> + <param index="2" name="options" type="Dictionary" /> + <param index="3" name="platform_variants" type="Array" /> + <param index="4" name="gen_files" type="Array" /> <description> Imports [code]source_file[/code] into [code]save_path[/code] with the import [code]options[/code] specified. The [code]platform_variants[/code] and [code]gen_files[/code] arrays will be modified by this function. This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method. diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml index 365e1f13a9..280a7bf34a 100644 --- a/doc/classes/EditorInspector.xml +++ b/doc/classes/EditorInspector.xml @@ -23,48 +23,48 @@ </description> </signal> <signal name="object_id_selected"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when the Edit button of an [Object] has been pressed in the inspector. This is mainly used in the remote scene tree inspector. </description> </signal> <signal name="property_deleted"> - <argument index="0" name="property" type="String" /> + <param index="0" name="property" type="String" /> <description> Emitted when a property is removed from the inspector. </description> </signal> <signal name="property_edited"> - <argument index="0" name="property" type="String" /> + <param index="0" name="property" type="String" /> <description> Emitted when a property is edited in the inspector. </description> </signal> <signal name="property_keyed"> - <argument index="0" name="property" type="String" /> - <argument index="1" name="value" type="Variant" /> - <argument index="2" name="advance" type="bool" /> + <param index="0" name="property" type="String" /> + <param index="1" name="value" type="Variant" /> + <param index="2" name="advance" type="bool" /> <description> Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled. </description> </signal> <signal name="property_selected"> - <argument index="0" name="property" type="String" /> + <param index="0" name="property" type="String" /> <description> Emitted when a property is selected in the inspector. </description> </signal> <signal name="property_toggled"> - <argument index="0" name="property" type="String" /> - <argument index="1" name="checked" type="bool" /> + <param index="0" name="property" type="String" /> + <param index="1" name="checked" type="bool" /> <description> Emitted when a boolean property is toggled in the inspector. [b]Note:[/b] This signal is never emitted if the internal [code]autoclear[/code] property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself. </description> </signal> <signal name="resource_selected"> - <argument index="0" name="resource" type="Resource" /> - <argument index="1" name="path" type="String" /> + <param index="0" name="resource" type="Resource" /> + <param index="1" name="path" type="String" /> <description> Emitted when a resource is selected in the inspector. </description> diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index 572d5d9d84..e52046f8c2 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -18,75 +18,75 @@ <methods> <method name="_can_handle" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="object" type="Variant" /> + <param index="0" name="object" type="Variant" /> <description> Returns [code]true[/code] if this object can be handled by this plugin. </description> </method> <method name="_parse_begin" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="object" type="Object" /> + <param index="0" name="object" type="Object" /> <description> Called to allow adding controls at the beginning of the property list for [code]object[/code]. </description> </method> <method name="_parse_category" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="category" type="String" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="category" type="String" /> <description> Called to allow adding controls at the beginning of a category in the property list for [code]object[/code]. </description> </method> <method name="_parse_end" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="object" type="Object" /> + <param index="0" name="object" type="Object" /> <description> Called to allow adding controls at the end of the property list for [code]object[/code]. </description> </method> <method name="_parse_group" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="group" type="String" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="group" type="String" /> <description> Called to allow adding controls at the beginning of a group or a sub-group in the property list for [code]object[/code]. </description> </method> <method name="_parse_property" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="type" type="int" /> - <argument index="2" name="name" type="String" /> - <argument index="3" name="hint_type" type="int" /> - <argument index="4" name="hint_string" type="String" /> - <argument index="5" name="usage_flags" type="int" /> - <argument index="6" name="wide" type="bool" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="type" type="int" /> + <param index="2" name="name" type="String" /> + <param index="3" name="hint_type" type="int" /> + <param index="4" name="hint_string" type="String" /> + <param index="5" name="usage_flags" type="int" /> + <param index="6" name="wide" type="bool" /> <description> Called to allow adding property-specific editors to the property list for [code]object[/code]. The added editor control must extend [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. </description> </method> <method name="add_custom_control"> <return type="void" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <description> Adds a custom control, which is not necessarily a property editor. </description> </method> <method name="add_property_editor"> <return type="void" /> - <argument index="0" name="property" type="String" /> - <argument index="1" name="editor" type="Control" /> - <argument index="2" name="add_to_end" type="bool" default="false" /> + <param index="0" name="property" type="String" /> + <param index="1" name="editor" type="Control" /> + <param index="2" name="add_to_end" type="bool" default="false" /> <description> Adds a property editor for an individual property. The [code]editor[/code] control must extend [EditorProperty]. </description> </method> <method name="add_property_editor_for_multiple_properties"> <return type="void" /> - <argument index="0" name="label" type="String" /> - <argument index="1" name="properties" type="PackedStringArray" /> - <argument index="2" name="editor" type="Control" /> + <param index="0" name="label" type="String" /> + <param index="1" name="properties" type="PackedStringArray" /> + <param index="2" name="editor" type="Control" /> <description> Adds an editor that allows modifying multiple properties. The [code]editor[/code] control must extend [EditorProperty]. </description> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index cc2f33ce89..bdd5b87cd8 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -12,24 +12,24 @@ <methods> <method name="edit_node"> <return type="void" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Edits the given [Node]. The node will be also selected if it's inside the scene tree. </description> </method> <method name="edit_resource"> <return type="void" /> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> Edits the given [Resource]. If the resource is a [Script] you can also edit it with [method edit_script] to specify the line and column position. </description> </method> <method name="edit_script"> <return type="void" /> - <argument index="0" name="script" type="Script" /> - <argument index="1" name="line" type="int" default="-1" /> - <argument index="2" name="column" type="int" default="0" /> - <argument index="3" name="grab_focus" type="bool" default="true" /> + <param index="0" name="script" type="Script" /> + <param index="1" name="line" type="int" default="-1" /> + <param index="2" name="column" type="int" default="0" /> + <param index="3" name="grab_focus" type="bool" default="true" /> <description> Edits the given [Script]. The line and column on which to open the script can also be specified. The script will be open with the user-configured editor for the script's language which may be an external editor. </description> @@ -145,9 +145,9 @@ </method> <method name="inspect_object"> <return type="void" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="for_property" type="String" default="""" /> - <argument index="2" name="inspector_only" type="bool" default="false" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="for_property" type="String" default="""" /> + <param index="2" name="inspector_only" type="bool" default="false" /> <description> Shows the given property on the given [code]object[/code] in the editor's Inspector dock. If [code]inspector_only[/code] is [code]true[/code], plugins will not attempt to edit [code]object[/code]. </description> @@ -160,22 +160,22 @@ </method> <method name="is_plugin_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="plugin" type="String" /> + <param index="0" name="plugin" type="String" /> <description> Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name. </description> </method> <method name="make_mesh_previews"> <return type="Array" /> - <argument index="0" name="meshes" type="Array" /> - <argument index="1" name="preview_size" type="int" /> + <param index="0" name="meshes" type="Array" /> + <param index="1" name="preview_size" type="int" /> <description> Returns mesh previews rendered at the given size as an [Array] of [Texture2D]s. </description> </method> <method name="open_scene_from_path"> <return type="void" /> - <argument index="0" name="scene_filepath" type="String" /> + <param index="0" name="scene_filepath" type="String" /> <description> Opens the scene at the given path. </description> @@ -188,7 +188,7 @@ </method> <method name="play_custom_scene"> <return type="void" /> - <argument index="0" name="scene_filepath" type="String" /> + <param index="0" name="scene_filepath" type="String" /> <description> Plays the scene specified by its filepath. </description> @@ -201,7 +201,7 @@ </method> <method name="reload_scene_from_path"> <return type="void" /> - <argument index="0" name="scene_filepath" type="String" /> + <param index="0" name="scene_filepath" type="String" /> <description> Reloads the scene at the given path. </description> @@ -214,30 +214,30 @@ </method> <method name="save_scene_as"> <return type="void" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="with_preview" type="bool" default="true" /> + <param index="0" name="path" type="String" /> + <param index="1" name="with_preview" type="bool" default="true" /> <description> Saves the scene as a file at [code]path[/code]. </description> </method> <method name="select_file"> <return type="void" /> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> Selects the file, with the path provided by [code]file[/code], in the FileSystem dock. </description> </method> <method name="set_main_screen_editor"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Sets the editor's current main screen to the one specified in [code]name[/code]. [code]name[/code] must match the text of the tab in question exactly ([code]2D[/code], [code]3D[/code], [code]Script[/code], [code]AssetLib[/code]). </description> </method> <method name="set_plugin_enabled"> <return type="void" /> - <argument index="0" name="plugin" type="String" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="plugin" type="String" /> + <param index="1" name="enabled" type="bool" /> <description> Sets the enabled status of a plugin. The plugin name is the same as its directory name. </description> diff --git a/doc/classes/EditorNode3DGizmo.xml b/doc/classes/EditorNode3DGizmo.xml index 2eec5310dc..13bf9e3028 100644 --- a/doc/classes/EditorNode3DGizmo.xml +++ b/doc/classes/EditorNode3DGizmo.xml @@ -11,10 +11,10 @@ <methods> <method name="_commit_handle" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="secondary" type="bool" /> - <argument index="2" name="restore" type="Variant" /> - <argument index="3" name="cancel" type="bool" /> + <param index="0" name="id" type="int" /> + <param index="1" name="secondary" type="bool" /> + <param index="2" name="restore" type="Variant" /> + <param index="3" name="cancel" type="bool" /> <description> Override this method to commit a handle being edited (handles must have been previously added by [method add_handles]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [code]restore[/code] argument as "undo". If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] value should be directly set, without any [UndoRedo] action. @@ -23,9 +23,9 @@ </method> <method name="_commit_subgizmos" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="ids" type="PackedInt32Array" /> - <argument index="1" name="restores" type="Transform3D[]" /> - <argument index="2" name="cancel" type="bool" /> + <param index="0" name="ids" type="PackedInt32Array" /> + <param index="1" name="restores" type="Transform3D[]" /> + <param index="2" name="cancel" type="bool" /> <description> Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo". If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. @@ -33,8 +33,8 @@ </method> <method name="_get_handle_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="secondary" type="bool" /> + <param index="0" name="id" type="int" /> + <param index="1" name="secondary" type="bool" /> <description> Override this method to return the name of an edited handle (handles must have been previously added by [method add_handles]). Handles can be named for reference to the user when editing. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method add_handles] for more information). @@ -42,8 +42,8 @@ </method> <method name="_get_handle_value" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="secondary" type="bool" /> + <param index="0" name="id" type="int" /> + <param index="1" name="secondary" type="bool" /> <description> Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_handle]. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method add_handles] for more information). @@ -51,15 +51,15 @@ </method> <method name="_get_subgizmo_transform" qualifiers="virtual const"> <return type="Transform3D" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_subgizmos]. </description> </method> <method name="_is_handle_highlighted" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="secondary" type="bool" /> + <param index="0" name="id" type="int" /> + <param index="1" name="secondary" type="bool" /> <description> Override this method to return [code]true[/code] whenever the given handle should be highlighted in the editor. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method add_handles] for more information). @@ -73,10 +73,10 @@ </method> <method name="_set_handle" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="secondary" type="bool" /> - <argument index="2" name="camera" type="Camera3D" /> - <argument index="3" name="point" type="Vector2" /> + <param index="0" name="id" type="int" /> + <param index="1" name="secondary" type="bool" /> + <param index="2" name="camera" type="Camera3D" /> + <param index="3" name="point" type="Vector2" /> <description> Override this method to update the node properties when the user drags a gizmo handle (previously added with [method add_handles]). The provided [code]point[/code] is the mouse position in screen coordinates and the [code]camera[/code] can be used to convert it to raycasts. The [code]secondary[/code] argument is [code]true[/code] when the edited handle is secondary (see [method add_handles] for more information). @@ -84,49 +84,49 @@ </method> <method name="_set_subgizmo_transform" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="id" type="int" /> + <param index="1" name="transform" type="Transform3D" /> <description> Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [code]transform[/code] is given in the Node3D's local coordinate system. </description> </method> <method name="_subgizmos_intersect_frustum" qualifiers="virtual const"> <return type="PackedInt32Array" /> - <argument index="0" name="camera" type="Camera3D" /> - <argument index="1" name="frustum" type="Plane[]" /> + <param index="0" name="camera" type="Camera3D" /> + <param index="1" name="frustum" type="Plane[]" /> <description> Override this method to allow selecting subgizmos using mouse drag box selection. Given a [code]camera[/code] and a [code]frustum[/code], this method should return which subgizmos are contained within the frustum. The [code]frustum[/code] argument consists of an [code]Array[/code] with all the [code]Plane[/code]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. </description> </method> <method name="_subgizmos_intersect_ray" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="camera" type="Camera3D" /> - <argument index="1" name="point" type="Vector2" /> + <param index="0" name="camera" type="Camera3D" /> + <param index="1" name="point" type="Vector2" /> <description> Override this method to allow selecting subgizmos using mouse clicks. Given a [code]camera[/code] and a [code]point[/code] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. </description> </method> <method name="add_collision_segments"> <return type="void" /> - <argument index="0" name="segments" type="PackedVector3Array" /> + <param index="0" name="segments" type="PackedVector3Array" /> <description> Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this method during [method _redraw]. </description> </method> <method name="add_collision_triangles"> <return type="void" /> - <argument index="0" name="triangles" type="TriangleMesh" /> + <param index="0" name="triangles" type="TriangleMesh" /> <description> Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this method during [method _redraw]. </description> </method> <method name="add_handles"> <return type="void" /> - <argument index="0" name="handles" type="PackedVector3Array" /> - <argument index="1" name="material" type="Material" /> - <argument index="2" name="ids" type="PackedInt32Array" /> - <argument index="3" name="billboard" type="bool" default="false" /> - <argument index="4" name="secondary" type="bool" default="false" /> + <param index="0" name="handles" type="PackedVector3Array" /> + <param index="1" name="material" type="Material" /> + <param index="2" name="ids" type="PackedInt32Array" /> + <param index="3" name="billboard" type="bool" default="false" /> + <param index="4" name="secondary" type="bool" default="false" /> <description> Adds a list of handles (points) which can be used to edit the properties of the gizmo's Node3D. The [code]ids[/code] argument can be used to specify a custom identifier for each handle, if an empty [code]Array[/code] is passed, the ids will be assigned automatically from the [code]handles[/code] argument order. The [code]secondary[/code] argument marks the added handles as secondary, meaning they will normally have less selection priority than regular handles. When the user is holding the shift key secondary handles will switch to have higher priority than regular handles. This change in priority can be used to place multiple handles at the same point while still giving the user control on their selection. @@ -135,29 +135,29 @@ </method> <method name="add_lines"> <return type="void" /> - <argument index="0" name="lines" type="PackedVector3Array" /> - <argument index="1" name="material" type="Material" /> - <argument index="2" name="billboard" type="bool" default="false" /> - <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="lines" type="PackedVector3Array" /> + <param index="1" name="material" type="Material" /> + <param index="2" name="billboard" type="bool" default="false" /> + <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during [method _redraw]. </description> </method> <method name="add_mesh"> <return type="void" /> - <argument index="0" name="mesh" type="Mesh" /> - <argument index="1" name="material" type="Material" default="null" /> - <argument index="2" name="transform" type="Transform3D" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" /> - <argument index="3" name="skeleton" type="SkinReference" default="null" /> + <param index="0" name="mesh" type="Mesh" /> + <param index="1" name="material" type="Material" default="null" /> + <param index="2" name="transform" type="Transform3D" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" /> + <param index="3" name="skeleton" type="SkinReference" default="null" /> <description> Adds a mesh to the gizmo with the specified [code]material[/code], local [code]transform[/code] and [code]skeleton[/code]. Call this method during [method _redraw]. </description> </method> <method name="add_unscaled_billboard"> <return type="void" /> - <argument index="0" name="material" type="Material" /> - <argument index="1" name="default_scale" type="float" default="1" /> - <argument index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="material" type="Material" /> + <param index="1" name="default_scale" type="float" default="1" /> + <param index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> Adds an unscaled billboard for visualization and selection. Call this method during [method _redraw]. </description> @@ -188,21 +188,21 @@ </method> <method name="is_subgizmo_selected" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns [code]true[/code] if the given subgizmo is currently selected. Can be used to highlight selected elements during [method _redraw]. </description> </method> <method name="set_hidden"> <return type="void" /> - <argument index="0" name="hidden" type="bool" /> + <param index="0" name="hidden" type="bool" /> <description> Sets the gizmo's hidden state. If [code]true[/code], the gizmo will be hidden. If [code]false[/code], it will be shown. </description> </method> <method name="set_spatial_node"> <return type="void" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Sets the reference [Node3D] node for the gizmo. [code]node[/code] must inherit from [Node3D]. </description> diff --git a/doc/classes/EditorNode3DGizmoPlugin.xml b/doc/classes/EditorNode3DGizmoPlugin.xml index d194786131..a6f4a3a0f5 100644 --- a/doc/classes/EditorNode3DGizmoPlugin.xml +++ b/doc/classes/EditorNode3DGizmoPlugin.xml @@ -19,11 +19,11 @@ </method> <method name="_commit_handle" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="handle_id" type="int" /> - <argument index="2" name="secondary" type="bool" /> - <argument index="3" name="restore" type="Variant" /> - <argument index="4" name="cancel" type="bool" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="handle_id" type="int" /> + <param index="2" name="secondary" type="bool" /> + <param index="3" name="restore" type="Variant" /> + <param index="4" name="cancel" type="bool" /> <description> Override this method to commit a handle being edited (handles must have been previously added by [method EditorNode3DGizmo.add_handles] during [method _redraw]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [code]restore[/code] argument as "undo". If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] value should be directly set, without any [UndoRedo] action. @@ -33,10 +33,10 @@ </method> <method name="_commit_subgizmos" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="ids" type="PackedInt32Array" /> - <argument index="2" name="restores" type="Transform3D[]" /> - <argument index="3" name="cancel" type="bool" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="ids" type="PackedInt32Array" /> + <param index="2" name="restores" type="Transform3D[]" /> + <param index="3" name="cancel" type="bool" /> <description> Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo". If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. As with all subgizmo methods, transforms are given in local space respect to the gizmo's Node3D. Called for this plugin's active gizmos. @@ -44,7 +44,7 @@ </method> <method name="_create_gizmo" qualifiers="virtual const"> <return type="EditorNode3DGizmo" /> - <argument index="0" name="for_node_3d" type="Node3D" /> + <param index="0" name="for_node_3d" type="Node3D" /> <description> Override this method to return a custom [EditorNode3DGizmo] for the spatial nodes of your choice, return [code]null[/code] for the rest of nodes. See also [method _has_gizmo]. </description> @@ -57,18 +57,18 @@ </method> <method name="_get_handle_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="handle_id" type="int" /> - <argument index="2" name="secondary" type="bool" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="handle_id" type="int" /> + <param index="2" name="secondary" type="bool" /> <description> Override this method to provide gizmo's handle names. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). Called for this plugin's active gizmos. </description> </method> <method name="_get_handle_value" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="handle_id" type="int" /> - <argument index="2" name="secondary" type="bool" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="handle_id" type="int" /> + <param index="2" name="secondary" type="bool" /> <description> Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_handle]. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). @@ -84,24 +84,24 @@ </method> <method name="_get_subgizmo_transform" qualifiers="virtual const"> <return type="Transform3D" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="subgizmo_id" type="int" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="subgizmo_id" type="int" /> <description> Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the [code]restore[/code] argument in [method _commit_subgizmos]. Called for this plugin's active gizmos. </description> </method> <method name="_has_gizmo" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="for_node_3d" type="Node3D" /> + <param index="0" name="for_node_3d" type="Node3D" /> <description> Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a [Node3D] node is added to a scene this method is called, if it returns [code]true[/code] the node gets a generic [EditorNode3DGizmo] assigned and is added to this plugin's list of active gizmos. </description> </method> <method name="_is_handle_highlighted" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="handle_id" type="int" /> - <argument index="2" name="secondary" type="bool" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="handle_id" type="int" /> + <param index="2" name="secondary" type="bool" /> <description> Override this method to return [code]true[/code] whenever to given handle should be highlighted in the editor. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). Called for this plugin's active gizmos. </description> @@ -114,18 +114,18 @@ </method> <method name="_redraw" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> <description> Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [method EditorNode3DGizmo.clear] at the beginning of this method and then add visual elements depending on the node's properties. </description> </method> <method name="_set_handle" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="handle_id" type="int" /> - <argument index="2" name="secondary" type="bool" /> - <argument index="3" name="camera" type="Camera3D" /> - <argument index="4" name="screen_pos" type="Vector2" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="handle_id" type="int" /> + <param index="2" name="secondary" type="bool" /> + <param index="3" name="camera" type="Camera3D" /> + <param index="4" name="screen_pos" type="Vector2" /> <description> Override this method to update the node's properties when the user drags a gizmo handle (previously added with [method EditorNode3DGizmo.add_handles]). The provided [code]point[/code] is the mouse position in screen coordinates and the [code]camera[/code] can be used to convert it to raycasts. The [code]secondary[/code] argument is [code]true[/code] when the edited handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). @@ -134,44 +134,44 @@ </method> <method name="_set_subgizmo_transform" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="subgizmo_id" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="subgizmo_id" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [code]transform[/code] is given in the Node3D's local coordinate system. Called for this plugin's active gizmos. </description> </method> <method name="_subgizmos_intersect_frustum" qualifiers="virtual const"> <return type="PackedInt32Array" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="camera" type="Camera3D" /> - <argument index="2" name="frustum_planes" type="Plane[]" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="camera" type="Camera3D" /> + <param index="2" name="frustum_planes" type="Plane[]" /> <description> Override this method to allow selecting subgizmos using mouse drag box selection. Given a [code]camera[/code] and a [code]frustum[/code], this method should return which subgizmos are contained within the frustum. The [code]frustum[/code] argument consists of an [code]Array[/code] with all the [code]Plane[/code]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, these identifiers can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos. </description> </method> <method name="_subgizmos_intersect_ray" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="gizmo" type="EditorNode3DGizmo" /> - <argument index="1" name="camera" type="Camera3D" /> - <argument index="2" name="screen_pos" type="Vector2" /> + <param index="0" name="gizmo" type="EditorNode3DGizmo" /> + <param index="1" name="camera" type="Camera3D" /> + <param index="2" name="screen_pos" type="Vector2" /> <description> Override this method to allow selecting subgizmos using mouse clicks. Given a [code]camera[/code] and a [code]point[/code] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos. </description> </method> <method name="add_material"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="material" type="StandardMaterial3D" /> + <param index="0" name="name" type="String" /> + <param index="1" name="material" type="StandardMaterial3D" /> <description> Adds a new material to the internal material list for the plugin. It can then be accessed with [method get_material]. Should not be overridden. </description> </method> <method name="create_handle_material"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="billboard" type="bool" default="false" /> - <argument index="2" name="texture" type="Texture2D" default="null" /> + <param index="0" name="name" type="String" /> + <param index="1" name="billboard" type="bool" default="false" /> + <param index="2" name="texture" type="Texture2D" default="null" /> <description> Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_handles]. Should not be overridden. You can optionally provide a texture to use instead of the default icon. @@ -179,29 +179,29 @@ </method> <method name="create_icon_material"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="texture" type="Texture2D" /> - <argument index="2" name="on_top" type="bool" default="false" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="name" type="String" /> + <param index="1" name="texture" type="Texture2D" /> + <param index="2" name="on_top" type="bool" default="false" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_unscaled_billboard]. Should not be overridden. </description> </method> <method name="create_material"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="billboard" type="bool" default="false" /> - <argument index="3" name="on_top" type="bool" default="false" /> - <argument index="4" name="use_vertex_color" type="bool" default="false" /> + <param index="0" name="name" type="String" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="billboard" type="bool" default="false" /> + <param index="3" name="on_top" type="bool" default="false" /> + <param index="4" name="use_vertex_color" type="bool" default="false" /> <description> Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_mesh] and [method EditorNode3DGizmo.add_lines]. Should not be overridden. </description> </method> <method name="get_material"> <return type="StandardMaterial3D" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="gizmo" type="EditorNode3DGizmo" default="null" /> + <param index="0" name="name" type="String" /> + <param index="1" name="gizmo" type="EditorNode3DGizmo" default="null" /> <description> Gets material from the internal list of materials. If an [EditorNode3DGizmo] is provided, it will try to get the corresponding variant (selected and/or editable). </description> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 2930c2ec22..ab41c1c493 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -38,7 +38,7 @@ </method> <method name="_edit" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="object" type="Variant" /> + <param index="0" name="object" type="Variant" /> <description> This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. </description> @@ -51,7 +51,7 @@ </method> <method name="_forward_3d_draw_over_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport_control" type="Control" /> + <param index="0" name="viewport_control" type="Control" /> <description> Called by the engine when the 3D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. [codeblocks] @@ -89,7 +89,7 @@ </method> <method name="_forward_3d_force_draw_over_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport_control" type="Control" /> + <param index="0" name="viewport_control" type="Control" /> <description> This method is the same as [method _forward_3d_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. @@ -97,8 +97,8 @@ </method> <method name="_forward_3d_gui_input" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="viewport_camera" type="Camera3D" /> - <argument index="1" name="event" type="InputEvent" /> + <param index="0" name="viewport_camera" type="Camera3D" /> + <param index="1" name="event" type="InputEvent" /> <description> Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 3D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: [codeblocks] @@ -134,7 +134,7 @@ </method> <method name="_forward_canvas_draw_over_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport_control" type="Control" /> + <param index="0" name="viewport_control" type="Control" /> <description> Called by the engine when the 2D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. [codeblocks] @@ -172,7 +172,7 @@ </method> <method name="_forward_canvas_force_draw_over_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport_control" type="Control" /> + <param index="0" name="viewport_control" type="Control" /> <description> This method is the same as [method _forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. @@ -180,7 +180,7 @@ </method> <method name="_forward_canvas_gui_input" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 2D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: [codeblocks] @@ -274,7 +274,7 @@ </method> <method name="_get_window_layout" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="configuration" type="ConfigFile" /> + <param index="0" name="configuration" type="ConfigFile" /> <description> Override this method to provide the GUI layout of the plugin or any other data you want to be stored. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed (for example changing the position of a dock). The data is stored in the [code]editor_layout.cfg[/code] file in the editor metadata directory. Use [method _set_window_layout] to restore your saved layout. @@ -287,7 +287,7 @@ </method> <method name="_handles" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="object" type="Variant" /> + <param index="0" name="object" type="Variant" /> <description> Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method _edit] and [method _make_visible] called when the editor requests them. If you have declared the methods [method _forward_canvas_gui_input] and [method _forward_3d_gui_input] these will be called too. </description> @@ -322,7 +322,7 @@ </method> <method name="_make_visible" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="visible" type="bool" /> + <param index="0" name="visible" type="bool" /> <description> This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. Remember that you have to manage the visibility of all your editor controls manually. @@ -336,7 +336,7 @@ </method> <method name="_set_state" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="state" type="Dictionary" /> + <param index="0" name="state" type="Dictionary" /> <description> Restore the state saved by [method _get_state]. This method is called when the current scene tab is changed in the editor. [b]Note:[/b] Your plugin must implement [method _get_plugin_name], otherwise it will not be recognized and this method will not be called. @@ -349,7 +349,7 @@ </method> <method name="_set_window_layout" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="configuration" type="ConfigFile" /> + <param index="0" name="configuration" type="ConfigFile" /> <description> Restore the plugin GUI layout and data saved by [method _get_window_layout]. This method is called for every plugin on editor startup. Use the provided [code]configuration[/code] file to read your saved data. [codeblock] @@ -361,24 +361,24 @@ </method> <method name="add_autoload_singleton"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="path" type="String" /> + <param index="0" name="name" type="String" /> + <param index="1" name="path" type="String" /> <description> Adds a script at [code]path[/code] to the Autoload list as [code]name[/code]. </description> </method> <method name="add_control_to_bottom_panel"> <return type="Button" /> - <argument index="0" name="control" type="Control" /> - <argument index="1" name="title" type="String" /> + <param index="0" name="control" type="Control" /> + <param index="1" name="title" type="String" /> <description> Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. </description> </method> <method name="add_control_to_container"> <return type="void" /> - <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" /> - <argument index="1" name="control" type="Control" /> + <param index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" /> + <param index="1" name="control" type="Control" /> <description> Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI. Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). @@ -387,8 +387,8 @@ </method> <method name="add_control_to_dock"> <return type="void" /> - <argument index="0" name="slot" type="int" enum="EditorPlugin.DockSlot" /> - <argument index="1" name="control" type="Control" /> + <param index="0" name="slot" type="int" enum="EditorPlugin.DockSlot" /> + <param index="1" name="control" type="Control" /> <description> Adds the control to a specific dock slot (see [enum DockSlot] for options). If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. @@ -397,10 +397,10 @@ </method> <method name="add_custom_type"> <return type="void" /> - <argument index="0" name="type" type="String" /> - <argument index="1" name="base" type="String" /> - <argument index="2" name="script" type="Script" /> - <argument index="3" name="icon" type="Texture2D" /> + <param index="0" name="type" type="String" /> + <param index="1" name="base" type="String" /> + <param index="2" name="script" type="Script" /> + <param index="3" name="icon" type="Texture2D" /> <description> Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object. @@ -410,14 +410,14 @@ </method> <method name="add_debugger_plugin"> <return type="void" /> - <argument index="0" name="script" type="Script" /> + <param index="0" name="script" type="Script" /> <description> Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin]. </description> </method> <method name="add_export_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorExportPlugin" /> + <param index="0" name="plugin" type="EditorExportPlugin" /> <description> Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported. See [method add_inspector_plugin] for an example of how to register a plugin. @@ -425,8 +425,8 @@ </method> <method name="add_import_plugin"> <return type="void" /> - <argument index="0" name="importer" type="EditorImportPlugin" /> - <argument index="1" name="first_priority" type="bool" default="false" /> + <param index="0" name="importer" type="EditorImportPlugin" /> + <param index="1" name="first_priority" type="bool" default="false" /> <description> Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type. If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. @@ -436,7 +436,7 @@ </method> <method name="add_inspector_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorInspectorPlugin" /> + <param index="0" name="plugin" type="EditorInspectorPlugin" /> <description> Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties. [b]Note:[/b] Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior. @@ -456,8 +456,8 @@ </method> <method name="add_scene_format_importer_plugin"> <return type="void" /> - <argument index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> - <argument index="1" name="first_priority" type="bool" default="false" /> + <param index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> + <param index="1" name="first_priority" type="bool" default="false" /> <description> Registers a new [EditorSceneFormatImporter]. Scene importers are used to import custom 3D asset formats as scenes. If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. @@ -465,8 +465,8 @@ </method> <method name="add_scene_post_import_plugin"> <return type="void" /> - <argument index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> - <argument index="1" name="first_priority" type="bool" default="false" /> + <param index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> + <param index="1" name="first_priority" type="bool" default="false" /> <description> Add a [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. @@ -474,7 +474,7 @@ </method> <method name="add_spatial_gizmo_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorNode3DGizmoPlugin" /> + <param index="0" name="plugin" type="EditorNode3DGizmoPlugin" /> <description> Registers a new [EditorNode3DGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Node3D]. See [method add_inspector_plugin] for an example of how to register a plugin. @@ -482,30 +482,30 @@ </method> <method name="add_tool_menu_item"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="callable" type="Callable" /> + <param index="0" name="name" type="String" /> + <param index="1" name="callable" type="Callable" /> <description> Adds a custom menu item to [b]Project > Tools[/b] named [code]name[/code]. When clicked, the provided [code]callable[/code] will be called. </description> </method> <method name="add_tool_submenu_item"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="submenu" type="PopupMenu" /> + <param index="0" name="name" type="String" /> + <param index="1" name="submenu" type="PopupMenu" /> <description> Adds a custom [PopupMenu] submenu under [b]Project > Tools >[/b] [code]name[/code]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu. </description> </method> <method name="add_translation_parser_plugin"> <return type="void" /> - <argument index="0" name="parser" type="EditorTranslationParserPlugin" /> + <param index="0" name="parser" type="EditorTranslationParserPlugin" /> <description> Registers a custom translation parser plugin for extracting translatable strings from custom files. </description> </method> <method name="add_undo_redo_inspector_hook_callback"> <return type="void" /> - <argument index="0" name="callable" type="Callable" /> + <param index="0" name="callable" type="Callable" /> <description> Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified. The callback should have 4 arguments: [Object] [code]undo_redo[/code], [Object] [code]modified_object[/code], [String] [code]property[/code] and [Variant] [code]new_value[/code]. They are, respectively, the [UndoRedo] object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take. @@ -545,7 +545,7 @@ </method> <method name="make_bottom_panel_item_visible"> <return type="void" /> - <argument index="0" name="item" type="Control" /> + <param index="0" name="item" type="Control" /> <description> Makes a specific item in the bottom panel visible. </description> @@ -558,106 +558,106 @@ </method> <method name="remove_autoload_singleton"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Removes an Autoload [code]name[/code] from the list. </description> </method> <method name="remove_control_from_bottom_panel"> <return type="void" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <description> Removes the control from the bottom panel. You have to manually [method Node.queue_free] the control. </description> </method> <method name="remove_control_from_container"> <return type="void" /> - <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" /> - <argument index="1" name="control" type="Control" /> + <param index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" /> + <param index="1" name="control" type="Control" /> <description> Removes the control from the specified container. You have to manually [method Node.queue_free] the control. </description> </method> <method name="remove_control_from_docks"> <return type="void" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <description> Removes the control from the dock. You have to manually [method Node.queue_free] the control. </description> </method> <method name="remove_custom_type"> <return type="void" /> - <argument index="0" name="type" type="String" /> + <param index="0" name="type" type="String" /> <description> Removes a custom type added by [method add_custom_type]. </description> </method> <method name="remove_debugger_plugin"> <return type="void" /> - <argument index="0" name="script" type="Script" /> + <param index="0" name="script" type="Script" /> <description> Removes the debugger plugin with given script from the Debugger. </description> </method> <method name="remove_export_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorExportPlugin" /> + <param index="0" name="plugin" type="EditorExportPlugin" /> <description> Removes an export plugin registered by [method add_export_plugin]. </description> </method> <method name="remove_import_plugin"> <return type="void" /> - <argument index="0" name="importer" type="EditorImportPlugin" /> + <param index="0" name="importer" type="EditorImportPlugin" /> <description> Removes an import plugin registered by [method add_import_plugin]. </description> </method> <method name="remove_inspector_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorInspectorPlugin" /> + <param index="0" name="plugin" type="EditorInspectorPlugin" /> <description> Removes an inspector plugin registered by [method add_import_plugin] </description> </method> <method name="remove_scene_format_importer_plugin"> <return type="void" /> - <argument index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> + <param index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> <description> Removes a scene format importer registered by [method add_scene_format_importer_plugin]. </description> </method> <method name="remove_scene_post_import_plugin"> <return type="void" /> - <argument index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> + <param index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> <description> Remove the [EditorScenePostImportPlugin], added with [method add_scene_post_import_plugin]. </description> </method> <method name="remove_spatial_gizmo_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorNode3DGizmoPlugin" /> + <param index="0" name="plugin" type="EditorNode3DGizmoPlugin" /> <description> Removes a gizmo plugin registered by [method add_spatial_gizmo_plugin]. </description> </method> <method name="remove_tool_menu_item"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Removes a menu [code]name[/code] from [b]Project > Tools[/b]. </description> </method> <method name="remove_translation_parser_plugin"> <return type="void" /> - <argument index="0" name="parser" type="EditorTranslationParserPlugin" /> + <param index="0" name="parser" type="EditorTranslationParserPlugin" /> <description> Removes a custom translation parser plugin registered by [method add_translation_parser_plugin]. </description> </method> <method name="remove_undo_redo_inspector_hook_callback"> <return type="void" /> - <argument index="0" name="callable" type="Callable" /> + <param index="0" name="callable" type="Callable" /> <description> Removes a callback previsously added by [method add_undo_redo_inspector_hook_callback]. </description> @@ -683,7 +683,7 @@ </methods> <signals> <signal name="main_screen_changed"> - <argument index="0" name="screen_name" type="String" /> + <param index="0" name="screen_name" type="String" /> <description> Emitted when user changes the workspace ([b]2D[/b], [b]3D[/b], [b]Script[/b], [b]AssetLib[/b]). Also works with custom screens defined by plugins. </description> @@ -693,18 +693,18 @@ </description> </signal> <signal name="resource_saved"> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> </description> </signal> <signal name="scene_changed"> - <argument index="0" name="scene_root" type="Node" /> + <param index="0" name="scene_root" type="Node" /> <description> Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be [code]null[/code]. </description> </signal> <signal name="scene_closed"> - <argument index="0" name="filepath" type="String" /> + <param index="0" name="filepath" type="String" /> <description> Emitted when user closes a scene. The argument is file path to a closed scene. </description> diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 586458bd28..0badcf1639 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -17,17 +17,17 @@ </method> <method name="add_focusable"> <return type="void" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <description> If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. </description> </method> <method name="emit_changed"> <return type="void" /> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="value" type="Variant" /> - <argument index="2" name="field" type="StringName" default="&""" /> - <argument index="3" name="changing" type="bool" default="false" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="value" type="Variant" /> + <param index="2" name="field" type="StringName" default="&""" /> + <param index="3" name="changing" type="bool" default="false" /> <description> If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure). </description> @@ -52,7 +52,7 @@ </method> <method name="set_bottom_editor"> <return type="void" /> - <argument index="0" name="editor" type="Control" /> + <param index="0" name="editor" type="Control" /> <description> Puts the [code]editor[/code] control below the property label. The control must be previously added using [method Node.add_child]. </description> @@ -88,77 +88,77 @@ </members> <signals> <signal name="multiple_properties_changed"> - <argument index="0" name="properties" type="PackedStringArray" /> - <argument index="1" name="value" type="Array" /> + <param index="0" name="properties" type="PackedStringArray" /> + <param index="1" name="value" type="Array" /> <description> Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin._parse_property]. </description> </signal> <signal name="object_id_selected"> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="id" type="int" /> <description> Used by sub-inspectors. Emit it if what was selected was an Object ID. </description> </signal> <signal name="property_can_revert_changed"> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="can_revert" type="bool" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="can_revert" type="bool" /> <description> Emitted when the revertability (i.e., whether it has a non-default value and thus is displayed with a revert icon) of a property has changed. </description> </signal> <signal name="property_changed"> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Do not emit this manually, use the [method emit_changed] method instead. </description> </signal> <signal name="property_checked"> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="checked" type="bool" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="checked" type="bool" /> <description> Emitted when a property was checked. Used internally. </description> </signal> <signal name="property_deleted"> - <argument index="0" name="property" type="StringName" /> + <param index="0" name="property" type="StringName" /> <description> Emitted when a property was deleted. Used internally. </description> </signal> <signal name="property_keyed"> - <argument index="0" name="property" type="StringName" /> + <param index="0" name="property" type="StringName" /> <description> Emit it if you want to add this value as an animation key (check for keying being enabled first). </description> </signal> <signal name="property_keyed_with_value"> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Emit it if you want to key a property with a single value. </description> </signal> <signal name="property_pinned"> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="pinned" type="bool" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="pinned" type="bool" /> <description> Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value. The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instancing chain, a script or a builtin class. </description> </signal> <signal name="resource_selected"> - <argument index="0" name="path" type="String" /> - <argument index="1" name="resource" type="Resource" /> + <param index="0" name="path" type="String" /> + <param index="1" name="resource" type="Resource" /> <description> If you want a sub-resource to be edited, emit this signal with the resource. </description> </signal> <signal name="selected"> - <argument index="0" name="path" type="String" /> - <argument index="1" name="focusable_idx" type="int" /> + <param index="0" name="path" type="String" /> + <param index="1" name="focusable_idx" type="int" /> <description> Emitted when selected. Used internally. </description> diff --git a/doc/classes/EditorResourceConversionPlugin.xml b/doc/classes/EditorResourceConversionPlugin.xml index 8a4aee0eef..c40bb1d91e 100644 --- a/doc/classes/EditorResourceConversionPlugin.xml +++ b/doc/classes/EditorResourceConversionPlugin.xml @@ -9,7 +9,7 @@ <methods> <method name="_convert" qualifiers="virtual const"> <return type="Resource" /> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> </description> </method> @@ -20,7 +20,7 @@ </method> <method name="_handles" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> </description> </method> diff --git a/doc/classes/EditorResourcePicker.xml b/doc/classes/EditorResourcePicker.xml index aa8f75d764..f531037f59 100644 --- a/doc/classes/EditorResourcePicker.xml +++ b/doc/classes/EditorResourcePicker.xml @@ -12,14 +12,14 @@ <methods> <method name="_handle_menu_selected" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> This virtual method can be implemented to handle context menu items not handled by default. See [method _set_create_options]. </description> </method> <method name="_set_create_options" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="menu_node" type="Object" /> + <param index="0" name="menu_node" type="Object" /> <description> This virtual method is called when updating the context menu of [EditorResourcePicker]. Implement this method to override the "New ..." items with your own options. [code]menu_node[/code] is a reference to the [PopupMenu] node. [b]Note:[/b] Implement [method _handle_menu_selected] to handle these custom items. @@ -33,7 +33,7 @@ </method> <method name="set_toggle_pressed"> <return type="void" /> - <argument index="0" name="pressed" type="bool" /> + <param index="0" name="pressed" type="bool" /> <description> Sets the toggle mode state for the main button. Works only if [member toggle_mode] is set to [code]true[/code]. </description> @@ -55,14 +55,14 @@ </members> <signals> <signal name="resource_changed"> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> Emitted when the value of the edited resource was changed. </description> </signal> <signal name="resource_selected"> - <argument index="0" name="resource" type="Resource" /> - <argument index="1" name="edit" type="bool" /> + <param index="0" name="resource" type="Resource" /> + <param index="1" name="edit" type="bool" /> <description> Emitted when the resource value was set and user clicked to edit it. When [code]edit[/code] is [code]true[/code], the signal was caused by the context menu "Edit" option. </description> diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 5df797f516..2953c19761 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -12,24 +12,24 @@ <methods> <method name="add_preview_generator"> <return type="void" /> - <argument index="0" name="generator" type="EditorResourcePreviewGenerator" /> + <param index="0" name="generator" type="EditorResourcePreviewGenerator" /> <description> Create an own, custom preview generator. </description> </method> <method name="check_for_invalidation"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. </description> </method> <method name="queue_edited_resource_preview"> <return type="void" /> - <argument index="0" name="resource" type="Resource" /> - <argument index="1" name="receiver" type="Object" /> - <argument index="2" name="receiver_func" type="StringName" /> - <argument index="3" name="userdata" type="Variant" /> + <param index="0" name="resource" type="Resource" /> + <param index="1" name="receiver" type="Object" /> + <param index="2" name="receiver_func" type="StringName" /> + <param index="3" name="userdata" type="Variant" /> <description> Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. [b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. @@ -37,10 +37,10 @@ </method> <method name="queue_resource_preview"> <return type="void" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="receiver" type="Object" /> - <argument index="2" name="receiver_func" type="StringName" /> - <argument index="3" name="userdata" type="Variant" /> + <param index="0" name="path" type="String" /> + <param index="1" name="receiver" type="Object" /> + <param index="2" name="receiver_func" type="StringName" /> + <param index="3" name="userdata" type="Variant" /> <description> Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. [b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. @@ -48,7 +48,7 @@ </method> <method name="remove_preview_generator"> <return type="void" /> - <argument index="0" name="generator" type="EditorResourcePreviewGenerator" /> + <param index="0" name="generator" type="EditorResourcePreviewGenerator" /> <description> Removes a custom preview generator. </description> @@ -56,7 +56,7 @@ </methods> <signals> <signal name="preview_invalidated"> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview. </description> diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index d8b4a86a97..f24260cd1b 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -18,8 +18,8 @@ </method> <method name="_generate" qualifiers="virtual const"> <return type="Texture2D" /> - <argument index="0" name="resource" type="Resource" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="resource" type="Resource" /> + <param index="1" name="size" type="Vector2i" /> <description> Generate a preview from a given resource with the specified size. This must always be implemented. Returning an empty texture is an OK way to fail and let another generator take care. @@ -28,8 +28,8 @@ </method> <method name="_generate_from_path" qualifiers="virtual const"> <return type="Texture2D" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="path" type="String" /> + <param index="1" name="size" type="Vector2i" /> <description> Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _generate]. Returning an empty texture is an OK way to fail and let another generator take care. @@ -45,7 +45,7 @@ </method> <method name="_handles" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="type" type="String" /> + <param index="0" name="type" type="String" /> <description> Returns [code]true[/code] if your generator supports the resource of type [code]type[/code]. </description> diff --git a/doc/classes/EditorSceneFormatImporter.xml b/doc/classes/EditorSceneFormatImporter.xml index 0290d7207d..6de9c2c5dc 100644 --- a/doc/classes/EditorSceneFormatImporter.xml +++ b/doc/classes/EditorSceneFormatImporter.xml @@ -22,24 +22,24 @@ </method> <method name="_get_import_options" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> <method name="_get_option_visibility" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="for_animation" type="bool" /> - <argument index="2" name="option" type="String" /> + <param index="0" name="path" type="String" /> + <param index="1" name="for_animation" type="bool" /> + <param index="2" name="option" type="String" /> <description> </description> </method> <method name="_import_scene" qualifiers="virtual"> <return type="Object" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="flags" type="int" /> - <argument index="2" name="options" type="Dictionary" /> - <argument index="3" name="bake_fps" type="int" /> + <param index="0" name="path" type="String" /> + <param index="1" name="flags" type="int" /> + <param index="2" name="options" type="Dictionary" /> + <param index="3" name="bake_fps" type="int" /> <description> </description> </method> diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml index 3adf814947..395b094bf2 100644 --- a/doc/classes/EditorScenePostImport.xml +++ b/doc/classes/EditorScenePostImport.xml @@ -57,7 +57,7 @@ <methods> <method name="_post_import" qualifiers="virtual"> <return type="Object" /> - <argument index="0" name="scene" type="Node" /> + <param index="0" name="scene" type="Node" /> <description> Called after the scene was imported. This method must return the modified version of the scene. </description> diff --git a/doc/classes/EditorScenePostImportPlugin.xml b/doc/classes/EditorScenePostImportPlugin.xml index 44d644411d..3ea0e53c01 100644 --- a/doc/classes/EditorScenePostImportPlugin.xml +++ b/doc/classes/EditorScenePostImportPlugin.xml @@ -11,91 +11,91 @@ <methods> <method name="_get_import_options" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Override to add general import options. These will appear in the main import dock on the editor. Add options via [method add_import_option] and [method add_import_option_advanced]. </description> </method> <method name="_get_internal_import_options" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="category" type="int" /> + <param index="0" name="category" type="int" /> <description> Override to add internal import options. These will appear in the 3D scene import dialog. Add options via [method add_import_option] and [method add_import_option_advanced]. </description> </method> <method name="_get_internal_option_update_view_required" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="category" type="int" /> - <argument index="1" name="option" type="String" /> + <param index="0" name="category" type="int" /> + <param index="1" name="option" type="String" /> <description> Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed. </description> </method> <method name="_get_internal_option_visibility" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="category" type="int" /> - <argument index="1" name="for_animation" type="bool" /> - <argument index="2" name="option" type="String" /> + <param index="0" name="category" type="int" /> + <param index="1" name="for_animation" type="bool" /> + <param index="2" name="option" type="String" /> <description> Return true or false whether a given option should be visible. Return null to ignore. </description> </method> <method name="_get_option_visibility" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="for_animation" type="bool" /> - <argument index="2" name="option" type="String" /> + <param index="0" name="path" type="String" /> + <param index="1" name="for_animation" type="bool" /> + <param index="2" name="option" type="String" /> <description> Return true or false whether a given option should be visible. Return null to ignore. </description> </method> <method name="_internal_process" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="category" type="int" /> - <argument index="1" name="base_node" type="Node" /> - <argument index="2" name="node" type="Node" /> - <argument index="3" name="resource" type="Resource" /> + <param index="0" name="category" type="int" /> + <param index="1" name="base_node" type="Node" /> + <param index="2" name="node" type="Node" /> + <param index="3" name="resource" type="Resource" /> <description> Process a specific node or resource for a given category. </description> </method> <method name="_post_process" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="scene" type="Node" /> + <param index="0" name="scene" type="Node" /> <description> Post process the scene. This function is called after the final scene has been configured. </description> </method> <method name="_pre_process" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="scene" type="Node" /> + <param index="0" name="scene" type="Node" /> <description> Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. </description> </method> <method name="add_import_option"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="String" /> + <param index="1" name="value" type="Variant" /> <description> Add a specific import option (name and default value only). This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. </description> </method> <method name="add_import_option_advanced"> <return type="void" /> - <argument index="0" name="type" type="int" enum="Variant.Type" /> - <argument index="1" name="name" type="String" /> - <argument index="2" name="default_value" type="Variant" /> - <argument index="3" name="hint" type="int" enum="PropertyHint" default="0" /> - <argument index="4" name="hint_string" type="String" default="""" /> - <argument index="5" name="usage_flags" type="int" default="6" /> + <param index="0" name="type" type="int" enum="Variant.Type" /> + <param index="1" name="name" type="String" /> + <param index="2" name="default_value" type="Variant" /> + <param index="3" name="hint" type="int" enum="PropertyHint" default="0" /> + <param index="4" name="hint_string" type="String" default="""" /> + <param index="5" name="usage_flags" type="int" default="6" /> <description> Add a specific import option. This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. </description> </method> <method name="get_option_value" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Query the value of an option. This function can only be called from those querying visibility, or processing. </description> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 68ee939370..b39972694b 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -42,7 +42,7 @@ </method> <method name="add_root_node"> <return type="void" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Adds [code]node[/code] as a child of the root node in the editor context. [b]Warning:[/b] The implementation of this method is currently disabled. diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index ff6f5f9206..9c3e87ddb0 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -12,7 +12,7 @@ <methods> <method name="add_node"> <return type="void" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Adds a node to the selection. [b]Note:[/b] The newly selected node will not be automatically edited in the inspector. If you want to edit a node, use [method EditorInterface.edit_node]. @@ -38,7 +38,7 @@ </method> <method name="remove_node"> <return type="void" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Removes a node from the selection. </description> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index ade7bc1256..2362213109 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -32,7 +32,7 @@ <methods> <method name="add_property_info"> <return type="void" /> - <argument index="0" name="info" type="Dictionary" /> + <param index="0" name="info" type="Dictionary" /> <description> Adds a custom property info to a property. The dictionary must contain: - [code]name[/code]: [String] (the name of the property) @@ -72,14 +72,14 @@ </method> <method name="check_changed_settings_in_group" qualifiers="const"> <return type="bool" /> - <argument index="0" name="setting_prefix" type="String" /> + <param index="0" name="setting_prefix" type="String" /> <description> Checks if any settings with the prefix [code]setting_prefix[/code] exist in the set of changed settings. See also [method get_changed_settings]. </description> </method> <method name="erase"> <return type="void" /> - <argument index="0" name="property" type="String" /> + <param index="0" name="property" type="String" /> <description> Erases the setting whose name is specified by [code]property[/code]. </description> @@ -98,9 +98,9 @@ </method> <method name="get_project_metadata" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="section" type="String" /> - <argument index="1" name="key" type="String" /> - <argument index="2" name="default" type="Variant" default="null" /> + <param index="0" name="section" type="String" /> + <param index="1" name="key" type="String" /> + <param index="2" name="default" type="Variant" default="null" /> <description> Returns project-specific metadata for the [code]section[/code] and [code]key[/code] specified. If the metadata doesn't exist, [code]default[/code] will be returned instead. See also [method set_project_metadata]. </description> @@ -113,83 +113,83 @@ </method> <method name="get_setting" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the value of the setting specified by [code]name[/code]. This is equivalent to using [method Object.get] on the EditorSettings instance. </description> </method> <method name="has_setting" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns [code]true[/code] if the setting specified by [code]name[/code] exists, [code]false[/code] otherwise. </description> </method> <method name="mark_setting_changed"> <return type="void" /> - <argument index="0" name="setting" type="String" /> + <param index="0" name="setting" type="String" /> <description> Marks the passed editor setting as being changed, see [method get_changed_settings]. Only settings which exist (see [method has_setting]) will be accepted. </description> </method> <method name="property_can_revert"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns [code]true[/code] if the setting specified by [code]name[/code] can have its value reverted to the default value, [code]false[/code] otherwise. When this method returns [code]true[/code], a Revert button will display next to the setting in the Editor Settings. </description> </method> <method name="property_get_revert"> <return type="Variant" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the default value of the setting specified by [code]name[/code]. This is the value that would be applied when clicking the Revert button in the Editor Settings. </description> </method> <method name="set_builtin_action_override"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="actions_list" type="Array" /> + <param index="0" name="name" type="String" /> + <param index="1" name="actions_list" type="Array" /> <description> Overrides the built-in editor action [code]name[/code] with the input actions defined in [code]actions_list[/code]. </description> </method> <method name="set_favorites"> <return type="void" /> - <argument index="0" name="dirs" type="PackedStringArray" /> + <param index="0" name="dirs" type="PackedStringArray" /> <description> Sets the list of favorite files and directories for this project. </description> </method> <method name="set_initial_value"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> - <argument index="2" name="update_current" type="bool" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> + <param index="2" name="update_current" type="bool" /> <description> Sets the initial value of the setting specified by [code]name[/code] to [code]value[/code]. This is used to provide a value for the Revert button in the Editor Settings. If [code]update_current[/code] is true, the current value of the setting will be set to [code]value[/code] as well. </description> </method> <method name="set_project_metadata"> <return type="void" /> - <argument index="0" name="section" type="String" /> - <argument index="1" name="key" type="String" /> - <argument index="2" name="data" type="Variant" /> + <param index="0" name="section" type="String" /> + <param index="1" name="key" type="String" /> + <param index="2" name="data" type="Variant" /> <description> Sets project-specific metadata with the [code]section[/code], [code]key[/code] and [code]data[/code] specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also [method get_project_metadata]. </description> </method> <method name="set_recent_dirs"> <return type="void" /> - <argument index="0" name="dirs" type="PackedStringArray" /> + <param index="0" name="dirs" type="PackedStringArray" /> <description> Sets the list of recently visited folders in the file dialog for this project. </description> </method> <method name="set_setting"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="String" /> + <param index="1" name="value" type="Variant" /> <description> Sets the [code]value[/code] of the setting specified by [code]name[/code]. This is equivalent to using [method Object.set] on the EditorSettings instance. </description> diff --git a/doc/classes/EditorTranslationParserPlugin.xml b/doc/classes/EditorTranslationParserPlugin.xml index 84a671a93c..bbae06899c 100644 --- a/doc/classes/EditorTranslationParserPlugin.xml +++ b/doc/classes/EditorTranslationParserPlugin.xml @@ -111,9 +111,9 @@ </method> <method name="_parse_file" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="msgids" type="Array" /> - <argument index="2" name="msgids_context_plural" type="Array" /> + <param index="0" name="path" type="String" /> + <param index="1" name="msgids" type="Array" /> + <param index="2" name="msgids_context_plural" type="Array" /> <description> Override this method to define a custom parsing logic to extract the translatable strings. </description> diff --git a/doc/classes/EditorVCSInterface.xml b/doc/classes/EditorVCSInterface.xml index 0215d81a4e..cc75861130 100644 --- a/doc/classes/EditorVCSInterface.xml +++ b/doc/classes/EditorVCSInterface.xml @@ -11,14 +11,14 @@ <methods> <method name="commit"> <return type="void" /> - <argument index="0" name="msg" type="String" /> + <param index="0" name="msg" type="String" /> <description> Creates a version commit if the addon is initialized, else returns without doing anything. Uses the files which have been staged previously, with the commit message set to a value as provided as in the argument. </description> </method> <method name="get_file_diff"> <return type="Array" /> - <argument index="0" name="file_path" type="String" /> + <param index="0" name="file_path" type="String" /> <description> Returns an [Array] of [Dictionary] objects containing the diff output from the VCS in use, if a VCS addon is initialized, else returns an empty [Array] object. The diff contents also consist of some contextual lines which provide context to the observed line change in the file. Each [Dictionary] object has the line diff contents under the keys: @@ -56,7 +56,7 @@ </method> <method name="initialize"> <return type="bool" /> - <argument index="0" name="project_root_path" type="String" /> + <param index="0" name="project_root_path" type="String" /> <description> Initializes the VCS addon if not already. Uses the argument value as the path to the working directory of the project. Creates the initial commit if required. Returns [code]true[/code] if no failure occurs, else returns [code]false[/code]. </description> @@ -81,14 +81,14 @@ </method> <method name="stage_file"> <return type="void" /> - <argument index="0" name="file_path" type="String" /> + <param index="0" name="file_path" type="String" /> <description> Stages the file which should be committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path. </description> </method> <method name="unstage_file"> <return type="void" /> - <argument index="0" name="file_path" type="String" /> + <param index="0" name="file_path" type="String" /> <description> Unstages the file which was staged previously to be committed, so that it is no longer committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path. </description> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 36dfee833b..a54997b52b 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -96,7 +96,7 @@ </method> <method name="get_script_language" qualifiers="const"> <return type="ScriptLanguage" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> @@ -107,7 +107,7 @@ </method> <method name="get_singleton" qualifiers="const"> <return type="Object" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns a global singleton with given [code]name[/code]. Often used for plugins, e.g. GodotPayments. </description> @@ -159,7 +159,7 @@ </method> <method name="has_singleton" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if a singleton with given [code]name[/code] exists in global scope. </description> @@ -186,20 +186,20 @@ </method> <method name="register_script_language"> <return type="void" /> - <argument index="0" name="language" type="ScriptLanguage" /> + <param index="0" name="language" type="ScriptLanguage" /> <description> </description> </method> <method name="register_singleton"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="instance" type="Object" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="instance" type="Object" /> <description> </description> </method> <method name="unregister_singleton"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> diff --git a/doc/classes/EngineDebugger.xml b/doc/classes/EngineDebugger.xml index cd502dce81..c3e76b8cad 100644 --- a/doc/classes/EngineDebugger.xml +++ b/doc/classes/EngineDebugger.xml @@ -11,14 +11,14 @@ <methods> <method name="has_capture"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if a capture with the given name is present otherwise [code]false[/code]. </description> </method> <method name="has_profiler"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if a profiler with the given name is present otherwise [code]false[/code]. </description> @@ -31,32 +31,32 @@ </method> <method name="is_profiling"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if a profiler with the given name is present and active otherwise [code]false[/code]. </description> </method> <method name="profiler_add_frame_data"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="data" type="Array" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="data" type="Array" /> <description> Calls the [code]add[/code] callable of the profiler with given [code]name[/code] and [code]data[/code]. </description> </method> <method name="profiler_enable"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="arguments" type="Array" default="[]" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="arguments" type="Array" default="[]" /> <description> Calls the [code]toggle[/code] callable of the profiler with given [code]name[/code] and [code]arguments[/code]. Enables/Disables the same profiler depending on [code]enable[/code] argument. </description> </method> <method name="register_message_capture"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="callable" type="Callable" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="callable" type="Callable" /> <description> Registers a message capture with given [code]name[/code]. If [code]name[/code] is "my_message" then messages starting with "my_message:" will be called with the given callable. Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code]. @@ -64,30 +64,30 @@ </method> <method name="register_profiler"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="profiler" type="EngineProfiler" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="profiler" type="EngineProfiler" /> <description> Registers a profiler with the given [code]name[/code]. See [EngineProfiler] for more information. </description> </method> <method name="send_message"> <return type="void" /> - <argument index="0" name="message" type="String" /> - <argument index="1" name="data" type="Array" /> + <param index="0" name="message" type="String" /> + <param index="1" name="data" type="Array" /> <description> Sends a message with given [code]message[/code] and [code]data[/code] array. </description> </method> <method name="unregister_message_capture"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Unregisters the message capture with given [code]name[/code]. </description> </method> <method name="unregister_profiler"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Unregisters a profiler with given [code]name[/code]. </description> diff --git a/doc/classes/EngineProfiler.xml b/doc/classes/EngineProfiler.xml index 752ecda867..d8fb193761 100644 --- a/doc/classes/EngineProfiler.xml +++ b/doc/classes/EngineProfiler.xml @@ -12,25 +12,25 @@ <methods> <method name="_add_frame" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="data" type="Array" /> + <param index="0" name="data" type="Array" /> <description> Called when data is added to profiler using [method EngineDebugger.profiler_add_frame_data]. </description> </method> <method name="_tick" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="frame_time" type="float" /> - <argument index="1" name="process_time" type="float" /> - <argument index="2" name="physics_time" type="float" /> - <argument index="3" name="physics_frame_time" type="float" /> + <param index="0" name="frame_time" type="float" /> + <param index="1" name="process_time" type="float" /> + <param index="2" name="physics_time" type="float" /> + <param index="3" name="physics_frame_time" type="float" /> <description> Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better. </description> </method> <method name="_toggle" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> - <argument index="1" name="options" type="Array" /> + <param index="0" name="enable" type="bool" /> + <param index="1" name="options" type="Array" /> <description> Called when the profiler is enabled/disabled, along with a set of [code]options[/code]. </description> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index f662a07825..fce12b3602 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -20,15 +20,15 @@ <methods> <method name="get_glow_level" qualifiers="const"> <return type="float" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the intensity of the glow level [code]idx[/code]. </description> </method> <method name="set_glow_level"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="intensity" type="float" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="intensity" type="float" /> <description> Sets the intensity of the glow level [code]idx[/code]. A value above [code]0.0[/code] enables the level. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled. </description> diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml index 50979c9b68..130f2f2272 100644 --- a/doc/classes/Expression.xml +++ b/doc/classes/Expression.xml @@ -53,10 +53,10 @@ <methods> <method name="execute"> <return type="Variant" /> - <argument index="0" name="inputs" type="Array" default="[]" /> - <argument index="1" name="base_instance" type="Object" default="null" /> - <argument index="2" name="show_error" type="bool" default="true" /> - <argument index="3" name="const_calls_only" type="bool" default="false" /> + <param index="0" name="inputs" type="Array" default="[]" /> + <param index="1" name="base_instance" type="Object" default="null" /> + <param index="2" name="show_error" type="bool" default="true" /> + <param index="3" name="const_calls_only" type="bool" default="false" /> <description> Executes the expression that was previously parsed by [method parse] and returns the result. Before you use the returned object, you should check if the method failed by calling [method has_execute_failed]. If you defined input variables in [method parse], you can specify their values in the inputs array, in the same order. @@ -76,8 +76,8 @@ </method> <method name="parse"> <return type="int" enum="Error" /> - <argument index="0" name="expression" type="String" /> - <argument index="1" name="input_names" type="PackedStringArray" default="PackedStringArray()" /> + <param index="0" name="expression" type="String" /> + <param index="1" name="input_names" type="PackedStringArray" default="PackedStringArray()" /> <description> Parses the expression and returns an [enum Error] code. You can optionally specify names of variables that may appear in the expression with [code]input_names[/code], so that you can bind them when it gets executed. diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 3a2776ff21..0c6310c09f 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -76,7 +76,7 @@ </method> <method name="file_exists" qualifiers="static"> <return type="bool" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns [code]true[/code] if the file exists in the given path. [b]Note:[/b] Many resources types are imported (e.g. textures or sound files), and their source asset will not be included in the exported game, as only the imported version is used. See [method ResourceLoader.exists] for an alternative approach that takes resource remapping into account. @@ -115,7 +115,7 @@ </method> <method name="get_as_text" qualifiers="const"> <return type="String" /> - <argument index="0" name="skip_cr" type="bool" default="false" /> + <param index="0" name="skip_cr" type="bool" default="false" /> <description> Returns the whole file as a [String]. Text is interpreted as being UTF-8 encoded. If [code]skip_cr[/code] is [code]true[/code], carriage return characters ([code]\r[/code], CR) will be ignored when parsing the UTF-8, so that only line feed characters ([code]\n[/code], LF) represent a new line (Unix convention). @@ -123,14 +123,14 @@ </method> <method name="get_buffer" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="length" type="int" /> + <param index="0" name="length" type="int" /> <description> Returns next [code]length[/code] bytes of the file as a [PackedByteArray]. </description> </method> <method name="get_csv_line" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="delim" type="String" default="","" /> + <param index="0" name="delim" type="String" default="","" /> <description> Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long, and cannot be a double quotation mark. Text is interpreted as being UTF-8 encoded. Text values must be enclosed in double quotes if they include the delimiter character. Double quotes within a text value can be escaped by doubling their occurrence. @@ -176,14 +176,14 @@ </method> <method name="get_md5" qualifiers="const"> <return type="String" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns an MD5 String representing the file at the given path or an empty [String] on failure. </description> </method> <method name="get_modified_time" qualifiers="const"> <return type="int" /> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> Returns the last time the [code]file[/code] was modified in Unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This Unix timestamp can be converted to another format using the [Time] singleton. </description> @@ -221,14 +221,14 @@ </method> <method name="get_sha256" qualifiers="const"> <return type="String" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns a SHA-256 [String] representing the file at the given path or an empty [String] on failure. </description> </method> <method name="get_var" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="allow_objects" type="bool" default="false" /> + <param index="0" name="allow_objects" type="bool" default="false" /> <description> Returns the next [Variant] value from the file. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -242,17 +242,17 @@ </method> <method name="open"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="flags" type="int" enum="File.ModeFlags" /> + <param index="0" name="path" type="String" /> + <param index="1" name="flags" type="int" enum="File.ModeFlags" /> <description> Opens the file for writing or reading, depending on the flags. </description> </method> <method name="open_compressed"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="mode_flags" type="int" enum="File.ModeFlags" /> - <argument index="2" name="compression_mode" type="int" enum="File.CompressionMode" default="0" /> + <param index="0" name="path" type="String" /> + <param index="1" name="mode_flags" type="int" enum="File.ModeFlags" /> + <param index="2" name="compression_mode" type="int" enum="File.CompressionMode" default="0" /> <description> Opens a compressed file for reading or writing. [b]Note:[/b] [method open_compressed] can only read files that were saved by Godot, not third-party compression formats. See [url=https://github.com/godotengine/godot/issues/28999]GitHub issue #28999[/url] for a workaround. @@ -260,9 +260,9 @@ </method> <method name="open_encrypted"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="mode_flags" type="int" enum="File.ModeFlags" /> - <argument index="2" name="key" type="PackedByteArray" /> + <param index="0" name="path" type="String" /> + <param index="1" name="mode_flags" type="int" enum="File.ModeFlags" /> + <param index="2" name="key" type="PackedByteArray" /> <description> Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. [b]Note:[/b] The provided key must be 32 bytes long. @@ -270,23 +270,23 @@ </method> <method name="open_encrypted_with_pass"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="mode_flags" type="int" enum="File.ModeFlags" /> - <argument index="2" name="pass" type="String" /> + <param index="0" name="path" type="String" /> + <param index="1" name="mode_flags" type="int" enum="File.ModeFlags" /> + <param index="2" name="pass" type="String" /> <description> Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. </description> </method> <method name="seek"> <return type="void" /> - <argument index="0" name="position" type="int" /> + <param index="0" name="position" type="int" /> <description> Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). </description> </method> <method name="seek_end"> <return type="void" /> - <argument index="0" name="position" type="int" default="0" /> + <param index="0" name="position" type="int" default="0" /> <description> Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). [b]Note:[/b] This is an offset, so you should use negative numbers or the cursor will be at the end of the file. @@ -294,7 +294,7 @@ </method> <method name="store_16"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Stores an integer as 16 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^16 - 1][/code]. Any other value will overflow and wrap around. @@ -337,7 +337,7 @@ </method> <method name="store_32"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Stores an integer as 32 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^32 - 1][/code]. Any other value will overflow and wrap around. @@ -346,7 +346,7 @@ </method> <method name="store_64"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Stores an integer as 64 bits in the file. [b]Note:[/b] The [code]value[/code] must lie in the interval [code][-2^63, 2^63 - 1][/code] (i.e. be a valid [int] value). @@ -354,7 +354,7 @@ </method> <method name="store_8"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Stores an integer as 8 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 255][/code]. Any other value will overflow and wrap around. @@ -363,15 +363,15 @@ </method> <method name="store_buffer"> <return type="void" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Stores the given array of bytes in the file. </description> </method> <method name="store_csv_line"> <return type="void" /> - <argument index="0" name="values" type="PackedStringArray" /> - <argument index="1" name="delim" type="String" default="","" /> + <param index="0" name="values" type="PackedStringArray" /> + <param index="1" name="delim" type="String" default="","" /> <description> Store the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. Text will be encoded as UTF-8. @@ -379,28 +379,28 @@ </method> <method name="store_double"> <return type="void" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Stores a floating-point number as 64 bits in the file. </description> </method> <method name="store_float"> <return type="void" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Stores a floating-point number as 32 bits in the file. </description> </method> <method name="store_line"> <return type="void" /> - <argument index="0" name="line" type="String" /> + <param index="0" name="line" type="String" /> <description> Appends [code]line[/code] to the file followed by a line return character ([code]\n[/code]), encoding the text as UTF-8. </description> </method> <method name="store_pascal_string"> <return type="void" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). Text will be encoded as UTF-8. @@ -408,14 +408,14 @@ </method> <method name="store_real"> <return type="void" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Stores a floating-point number in the file. </description> </method> <method name="store_string"> <return type="void" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Appends [code]string[/code] to the file without a line return, encoding the text as UTF-8. [b]Note:[/b] This method is intended to be used to write text files. The string is stored as a UTF-8 encoded buffer without string length or terminating zero, which means that it can't be loaded back easily. If you want to store a retrievable string in a binary file, consider using [method store_pascal_string] instead. For retrieving strings from a text file, you can use [code]get_buffer(length).get_string_from_utf8()[/code] (if you know the length) or [method get_as_text]. @@ -423,8 +423,8 @@ </method> <method name="store_var"> <return type="void" /> - <argument index="0" name="value" type="Variant" /> - <argument index="1" name="full_objects" type="bool" default="false" /> + <param index="0" name="value" type="Variant" /> + <param index="1" name="full_objects" type="bool" default="false" /> <description> Stores any Variant value in the file. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). [b]Note:[/b] Not all properties are included. Only properties that are configured with the [constant PROPERTY_USAGE_STORAGE] flag set will be serialized. You can add a new usage flag to a property by overriding the [method Object._get_property_list] method in your class. You can also check how property usage is configured by calling [method Object._get_property_list]. See [enum PropertyUsageFlags] for the possible usage flags. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index f45031cea8..00a1028c5e 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -11,8 +11,8 @@ <methods> <method name="add_filter"> <return type="void" /> - <argument index="0" name="filter" type="String" /> - <argument index="1" name="description" type="String" default="""" /> + <param index="0" name="filter" type="String" /> + <param index="1" name="description" type="String" default="""" /> <description> Adds a comma-delimited file name [code]filter[/code] option to the [FileDialog] with an optional [code]description[/code], which restricts what files can be picked. A [code]filter[/code] should be of the form [code]"filename.extension"[/code], where filename and extension can be [code]*[/code] to match any string. Filters starting with [code].[/code] (i.e. empty filenames) are not allowed. @@ -86,19 +86,19 @@ </members> <signals> <signal name="dir_selected"> - <argument index="0" name="dir" type="String" /> + <param index="0" name="dir" type="String" /> <description> Emitted when the user selects a directory. </description> </signal> <signal name="file_selected"> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Emitted when the user selects a file by double-clicking it or pressing the [b]OK[/b] button. </description> </signal> <signal name="files_selected"> - <argument index="0" name="paths" type="PackedStringArray" /> + <param index="0" name="paths" type="PackedStringArray" /> <description> Emitted when the user selects multiple files. </description> diff --git a/doc/classes/FileSystemDock.xml b/doc/classes/FileSystemDock.xml index 31299deb7d..22048c6761 100644 --- a/doc/classes/FileSystemDock.xml +++ b/doc/classes/FileSystemDock.xml @@ -9,7 +9,7 @@ <methods> <method name="navigate_to_path"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> @@ -20,34 +20,34 @@ </description> </signal> <signal name="file_removed"> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> </description> </signal> <signal name="files_moved"> - <argument index="0" name="old_file" type="String" /> - <argument index="1" name="new_file" type="String" /> + <param index="0" name="old_file" type="String" /> + <param index="1" name="new_file" type="String" /> <description> </description> </signal> <signal name="folder_moved"> - <argument index="0" name="old_folder" type="String" /> - <argument index="1" name="new_file" type="String" /> + <param index="0" name="old_folder" type="String" /> + <param index="1" name="new_file" type="String" /> <description> </description> </signal> <signal name="folder_removed"> - <argument index="0" name="folder" type="String" /> + <param index="0" name="folder" type="String" /> <description> </description> </signal> <signal name="inherit"> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> </description> </signal> <signal name="instance"> - <argument index="0" name="files" type="PackedStringArray" /> + <param index="0" name="files" type="PackedStringArray" /> <description> </description> </signal> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index ec2776f636..9e9c592400 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -11,11 +11,11 @@ <methods> <method name="draw_char" qualifiers="const"> <return type="float" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="char" type="int" /> - <argument index="3" name="font_size" type="int" /> - <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="char" type="int" /> + <param index="3" name="font_size" type="int" /> + <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw a single Unicode character [code]char[/code] into a canvas item using the font, at a given position, with [code]modulate[/code] color. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. [b]Note:[/b] Do not use this function to draw strings character by character, use [method draw_string] or [TextLine] instead. @@ -23,12 +23,12 @@ </method> <method name="draw_char_outline" qualifiers="const"> <return type="float" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="char" type="int" /> - <argument index="3" name="font_size" type="int" /> - <argument index="4" name="size" type="int" default="-1" /> - <argument index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="char" type="int" /> + <param index="3" name="font_size" type="int" /> + <param index="4" name="size" type="int" default="-1" /> + <param index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw a single Unicode character [code]char[/code] outline into a canvas item using the font, at a given position, with [code]modulate[/code] color and [code]size[/code] outline size. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. [b]Note:[/b] Do not use this function to draw strings character by character, use [method draw_string] or [TextLine] instead. @@ -36,18 +36,18 @@ </method> <method name="draw_multiline_string" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="text" type="String" /> - <argument index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="font_size" type="int" default="16" /> - <argument index="6" name="max_lines" type="int" default="-1" /> - <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="8" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> - <argument index="9" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="10" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="11" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="text" type="String" /> + <param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="4" name="width" type="float" default="-1" /> + <param index="5" name="font_size" type="int" default="16" /> + <param index="6" name="max_lines" type="int" default="-1" /> + <param index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="8" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> + <param index="9" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="10" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="11" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Breaks [code]text[/code] to the lines using rules specified by [code]flags[/code] and draws it into a canvas item using the font, at a given position, with [code]modulate[/code] color, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline of the first line, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_multiline_string]. @@ -55,19 +55,19 @@ </method> <method name="draw_multiline_string_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="text" type="String" /> - <argument index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="font_size" type="int" default="16" /> - <argument index="6" name="max_lines" type="int" default="-1" /> - <argument index="7" name="size" type="int" default="1" /> - <argument index="8" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="9" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> - <argument index="10" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="11" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="12" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="text" type="String" /> + <param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="4" name="width" type="float" default="-1" /> + <param index="5" name="font_size" type="int" default="16" /> + <param index="6" name="max_lines" type="int" default="-1" /> + <param index="7" name="size" type="int" default="1" /> + <param index="8" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="9" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> + <param index="10" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="11" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="12" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Breaks [code]text[/code] to the lines using rules specified by [code]flags[/code] and draws text outline into a canvas item using the font, at a given position, with [code]modulate[/code] color and [code]size[/code] outline size, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline of the first line, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_multiline_string_outline]. @@ -75,16 +75,16 @@ </method> <method name="draw_string" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="text" type="String" /> - <argument index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="font_size" type="int" default="16" /> - <argument index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="7" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="8" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="9" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="text" type="String" /> + <param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="4" name="width" type="float" default="-1" /> + <param index="5" name="font_size" type="int" default="16" /> + <param index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="7" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="8" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="9" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Draw [code]text[/code] into a canvas item using the font, at a given position, with [code]modulate[/code] color, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_string]. @@ -92,17 +92,17 @@ </method> <method name="draw_string_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="text" type="String" /> - <argument index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="font_size" type="int" default="16" /> - <argument index="6" name="size" type="int" default="1" /> - <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="8" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="9" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="10" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="text" type="String" /> + <param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="4" name="width" type="float" default="-1" /> + <param index="5" name="font_size" type="int" default="16" /> + <param index="6" name="size" type="int" default="1" /> + <param index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="8" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="9" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="10" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Draw [code]text[/code] outline into a canvas item using the font, at a given position, with [code]modulate[/code] color and [code]size[/code] outline size, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_string_outline]. @@ -110,17 +110,17 @@ </method> <method name="find_variation" qualifiers="const"> <return type="RID" /> - <argument index="0" name="variation_coordinates" type="Dictionary" /> - <argument index="1" name="face_index" type="int" default="0" /> - <argument index="2" name="strength" type="float" default="0.0" /> - <argument index="3" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> + <param index="0" name="variation_coordinates" type="Dictionary" /> + <param index="1" name="face_index" type="int" default="0" /> + <param index="2" name="strength" type="float" default="0.0" /> + <param index="3" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> <description> Returns [TextServer] RID of the font cache for specific variation. </description> </method> <method name="get_ascent" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_size" type="int" default="16" /> + <param index="0" name="font_size" type="int" default="16" /> <description> Returns the average font ascent (number of pixels above the baseline). [b]Note:[/b] Real ascent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the ascent of empty line). @@ -128,8 +128,8 @@ </method> <method name="get_char_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="char" type="int" /> - <argument index="1" name="font_size" type="int" /> + <param index="0" name="char" type="int" /> + <param index="1" name="font_size" type="int" /> <description> Returns the size of a character, optionally taking kerning into account if the next character is provided. [b]Note:[/b] Do not use this function to calculate width of the string character by character, use [method get_string_size] or [TextLine] instead. The height returned is the font height (see also [method get_height]) and has no relation to the glyph height. @@ -137,7 +137,7 @@ </method> <method name="get_descent" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_size" type="int" default="16" /> + <param index="0" name="font_size" type="int" default="16" /> <description> Returns the average font descent (number of pixels below the baseline). [b]Note:[/b] Real descent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the descent of empty line). @@ -175,7 +175,7 @@ </method> <method name="get_height" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_size" type="int" default="16" /> + <param index="0" name="font_size" type="int" default="16" /> <description> Returns the total average font height (ascent plus descent) in pixels. [b]Note:[/b] Real height of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the height of empty line). @@ -183,15 +183,15 @@ </method> <method name="get_multiline_string_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="2" name="width" type="float" default="-1" /> - <argument index="3" name="font_size" type="int" default="16" /> - <argument index="4" name="max_lines" type="int" default="-1" /> - <argument index="5" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> - <argument index="6" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="7" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="8" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="text" type="String" /> + <param index="1" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="2" name="width" type="float" default="-1" /> + <param index="3" name="font_size" type="int" default="16" /> + <param index="4" name="max_lines" type="int" default="-1" /> + <param index="5" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> + <param index="6" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="7" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="8" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account. See also [method draw_multiline_string]. @@ -211,20 +211,20 @@ </method> <method name="get_spacing" qualifiers="const"> <return type="int" /> - <argument index="0" name="spacing" type="int" enum="TextServer.SpacingType" /> + <param index="0" name="spacing" type="int" enum="TextServer.SpacingType" /> <description> Returns the spacing for the given [code]type[/code] (see [enum TextServer.SpacingType]). </description> </method> <method name="get_string_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> - <argument index="2" name="width" type="float" default="-1" /> - <argument index="3" name="font_size" type="int" default="16" /> - <argument index="4" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> - <argument index="5" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="6" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="text" type="String" /> + <param index="1" name="alignment" type="int" enum="HorizontalAlignment" default="0" /> + <param index="2" name="width" type="float" default="-1" /> + <param index="3" name="font_size" type="int" default="16" /> + <param index="4" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="5" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="6" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Returns the size of a bounding box of a single-line string, taking kerning and advance into account. See also [method get_multiline_string_size] and [method draw_string]. For example, to get the string size as displayed by a single-line Label, use: @@ -256,7 +256,7 @@ </method> <method name="get_underline_position" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_size" type="int" default="16" /> + <param index="0" name="font_size" type="int" default="16" /> <description> Returns average pixel offset of the underline below the baseline. [b]Note:[/b] Real underline position of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. @@ -264,7 +264,7 @@ </method> <method name="get_underline_thickness" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_size" type="int" default="16" /> + <param index="0" name="font_size" type="int" default="16" /> <description> Returns average thickness of the underline. [b]Note:[/b] Real underline thickness of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. @@ -272,36 +272,36 @@ </method> <method name="has_char" qualifiers="const"> <return type="bool" /> - <argument index="0" name="char" type="int" /> + <param index="0" name="char" type="int" /> <description> Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. </description> </method> <method name="is_language_supported" qualifiers="const"> <return type="bool" /> - <argument index="0" name="language" type="String" /> + <param index="0" name="language" type="String" /> <description> Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). </description> </method> <method name="is_script_supported" qualifiers="const"> <return type="bool" /> - <argument index="0" name="script" type="String" /> + <param index="0" name="script" type="String" /> <description> Returns [code]true[/code], if font supports given script ([url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code). </description> </method> <method name="set_cache_capacity"> <return type="void" /> - <argument index="0" name="single_line" type="int" /> - <argument index="1" name="multi_line" type="int" /> + <param index="0" name="single_line" type="int" /> + <param index="1" name="multi_line" type="int" /> <description> Sets LRU cache capacity for [code]draw_*[/code] methods. </description> </method> <method name="set_fallbacks"> <return type="void" /> - <argument index="0" name="fallbacks" type="Font[]" /> + <param index="0" name="fallbacks" type="Font[]" /> <description> Sets array of fallback [Font]s. </description> diff --git a/doc/classes/FontFile.xml b/doc/classes/FontFile.xml index dc2cbdde63..622bb17e59 100644 --- a/doc/classes/FontFile.xml +++ b/doc/classes/FontFile.xml @@ -39,8 +39,8 @@ </method> <method name="clear_glyphs"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes all rendered glyphs information from the cache entry. [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. @@ -48,23 +48,23 @@ </method> <method name="clear_kerning_map"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> <description> Removes all kerning overrides. </description> </method> <method name="clear_size_cache"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> + <param index="0" name="cache_index" type="int" /> <description> Removes all font sizes from the cache entry </description> </method> <method name="clear_textures"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes all textures from font cache entry. [b]Note:[/b] This function will not remove glyphs associated with the texture, use [method remove_glyph] to remove them manually. @@ -72,8 +72,8 @@ </method> <method name="get_cache_ascent" qualifiers="const"> <return type="float" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> <description> Returns the font ascent (number of pixels above the baseline). </description> @@ -86,51 +86,51 @@ </method> <method name="get_cache_descent" qualifiers="const"> <return type="float" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> <description> </description> </method> <method name="get_cache_scale" qualifiers="const"> <return type="float" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> <description> </description> </method> <method name="get_cache_underline_position" qualifiers="const"> <return type="float" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> <description> </description> </method> <method name="get_cache_underline_thickness" qualifiers="const"> <return type="float" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> <description> </description> </method> <method name="get_embolden" qualifiers="const"> <return type="float" /> - <argument index="0" name="cache_index" type="int" /> + <param index="0" name="cache_index" type="int" /> <description> Returns embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. </description> </method> <method name="get_face_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="cache_index" type="int" /> + <param index="0" name="cache_index" type="int" /> <description> Recturns an active face index in the TrueType / OpenType collection. </description> </method> <method name="get_glyph_advance" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph" type="int" /> <description> Returns glyph advance (offset of the next glyph). [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. @@ -138,77 +138,77 @@ </method> <method name="get_glyph_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="size" type="int" /> - <argument index="1" name="char" type="int" /> - <argument index="2" name="variation_selector" type="int" /> + <param index="0" name="size" type="int" /> + <param index="1" name="char" type="int" /> + <param index="2" name="variation_selector" type="int" /> <description> Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. </description> </method> <method name="get_glyph_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> <description> Returns list of rendered glyphs in the cache entry. </description> </method> <method name="get_glyph_offset" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns glyph offset from the baseline. </description> </method> <method name="get_glyph_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns glyph size. </description> </method> <method name="get_glyph_texture_idx" qualifiers="const"> <return type="int" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns index of the cache texture containing the glyph. </description> </method> <method name="get_glyph_uv_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns rectangle in the cache texture containing the glyph. </description> </method> <method name="get_kerning" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> <description> Returns kerning for the pair of glyphs. </description> </method> <method name="get_kerning_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> <description> Returns list of the kerning overrides. </description> </method> <method name="get_language_support_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="language" type="String" /> + <param index="0" name="language" type="String" /> <description> Returns [code]true[/code] if support override is enabled for the [code]language[/code]. </description> @@ -221,7 +221,7 @@ </method> <method name="get_script_support_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="script" type="String" /> + <param index="0" name="script" type="String" /> <description> Returns [code]true[/code] if support override is enabled for the [code]script[/code]. </description> @@ -234,54 +234,54 @@ </method> <method name="get_size_cache_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="cache_index" type="int" /> + <param index="0" name="cache_index" type="int" /> <description> Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. </description> </method> <method name="get_texture_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> <description> Returns number of textures used by font cache entry. </description> </method> <method name="get_texture_image" qualifiers="const"> <return type="Image" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Returns a copy of the font cache texture image. </description> </method> <method name="get_texture_offsets" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Returns a copy of the array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. </description> </method> <method name="get_transform" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="cache_index" type="int" /> + <param index="0" name="cache_index" type="int" /> <description> Returns 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. </description> </method> <method name="get_variation_coordinates" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="cache_index" type="int" /> + <param index="0" name="cache_index" type="int" /> <description> Returns variation coordinates for the specified font cache entry. See [method Font.get_supported_variation_list] for more info. </description> </method> <method name="load_bitmap_font"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Loads an AngelCode BMFont (.fnt, .font) bitmap font from file [code]path[/code]. [b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the [code]user://[/code] directory. @@ -289,7 +289,7 @@ </method> <method name="load_dynamic_font"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 (.pfb, .pfm) dynamic font from file [code]path[/code]. [b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the [code]user://[/code] directory. @@ -297,16 +297,16 @@ </method> <method name="remove_cache"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> + <param index="0" name="cache_index" type="int" /> <description> Removes specified font cache entry. </description> </method> <method name="remove_glyph"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Removes specified rendered glyph information from the cache entry. [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. @@ -314,40 +314,40 @@ </method> <method name="remove_kerning"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> <description> Removes kerning override for the pair of glyphs. </description> </method> <method name="remove_language_support_override"> <return type="void" /> - <argument index="0" name="language" type="String" /> + <param index="0" name="language" type="String" /> <description> Remove language support override. </description> </method> <method name="remove_script_support_override"> <return type="void" /> - <argument index="0" name="script" type="String" /> + <param index="0" name="script" type="String" /> <description> Removes script support override. </description> </method> <method name="remove_size_cache"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes specified font size from the cache entry. </description> </method> <method name="remove_texture"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Removes specified texture from the cache entry. [b]Note:[/b] This function will not remove glyphs associated with the texture. Remove them manually using [method remove_glyph]. @@ -355,85 +355,85 @@ </method> <method name="render_glyph"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="index" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="index" type="int" /> <description> Renders specified glyph to the font cache texture. </description> </method> <method name="render_range"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="start" type="int" /> - <argument index="3" name="end" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="start" type="int" /> + <param index="3" name="end" type="int" /> <description> Renders the range of characters to the font cache texture. </description> </method> <method name="set_cache_ascent"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="ascent" type="float" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="ascent" type="float" /> <description> </description> </method> <method name="set_cache_descent"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="descent" type="float" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="descent" type="float" /> <description> </description> </method> <method name="set_cache_scale"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="scale" type="float" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="scale" type="float" /> <description> </description> </method> <method name="set_cache_underline_position"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="underline_position" type="float" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="underline_position" type="float" /> <description> </description> </method> <method name="set_cache_underline_thickness"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="underline_thickness" type="float" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="underline_thickness" type="float" /> <description> </description> </method> <method name="set_embolden"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="strength" type="float" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="strength" type="float" /> <description> Sets embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. </description> </method> <method name="set_face_index"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="face_index" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="face_index" type="int" /> <description> Sets an active face index in the TrueType / OpenType collection. </description> </method> <method name="set_glyph_advance"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="advance" type="Vector2" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="advance" type="Vector2" /> <description> Sets glyph advance (offset of the next glyph). [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. @@ -441,102 +441,102 @@ </method> <method name="set_glyph_offset"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="offset" type="Vector2" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="offset" type="Vector2" /> <description> Sets glyph offset from the baseline. </description> </method> <method name="set_glyph_size"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="gl_size" type="Vector2" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="gl_size" type="Vector2" /> <description> Sets glyph size. </description> </method> <method name="set_glyph_texture_idx"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="texture_idx" type="int" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="texture_idx" type="int" /> <description> Sets index of the cache texture containing the glyph. </description> </method> <method name="set_glyph_uv_rect"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="uv_rect" type="Rect2" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="uv_rect" type="Rect2" /> <description> Sets rectangle in the cache texture containing the glyph. </description> </method> <method name="set_kerning"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> - <argument index="3" name="kerning" type="Vector2" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> + <param index="3" name="kerning" type="Vector2" /> <description> Sets kerning for the pair of glyphs. </description> </method> <method name="set_language_support_override"> <return type="void" /> - <argument index="0" name="language" type="String" /> - <argument index="1" name="supported" type="bool" /> + <param index="0" name="language" type="String" /> + <param index="1" name="supported" type="bool" /> <description> Adds override for [method Font.is_language_supported]. </description> </method> <method name="set_script_support_override"> <return type="void" /> - <argument index="0" name="script" type="String" /> - <argument index="1" name="supported" type="bool" /> + <param index="0" name="script" type="String" /> + <param index="1" name="supported" type="bool" /> <description> Adds override for [method Font.is_script_supported]. </description> </method> <method name="set_texture_image"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> - <argument index="3" name="image" type="Image" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> + <param index="3" name="image" type="Image" /> <description> Sets font cache texture image. </description> </method> <method name="set_texture_offsets"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> - <argument index="3" name="offset" type="PackedInt32Array" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> + <param index="3" name="offset" type="PackedInt32Array" /> <description> Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty (for the fonts without dynamic glyph generation support). </description> </method> <method name="set_transform"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. </description> </method> <method name="set_variation_coordinates"> <return type="void" /> - <argument index="0" name="cache_index" type="int" /> - <argument index="1" name="variation_coordinates" type="Dictionary" /> + <param index="0" name="cache_index" type="int" /> + <param index="1" name="variation_coordinates" type="Dictionary" /> <description> Sets variation coordinates for the specified font cache entry. See [method Font.get_supported_variation_list] for more info. </description> diff --git a/doc/classes/FontVariation.xml b/doc/classes/FontVariation.xml index a1b96fb137..30cb732751 100644 --- a/doc/classes/FontVariation.xml +++ b/doc/classes/FontVariation.xml @@ -29,8 +29,8 @@ <methods> <method name="set_spacing"> <return type="void" /> - <argument index="0" name="spacing" type="int" enum="TextServer.SpacingType" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="spacing" type="int" enum="TextServer.SpacingType" /> + <param index="1" name="value" type="int" /> <description> Sets the spacing for [code]type[/code] (see [enum TextServer.SpacingType]) to [code]value[/code] in pixels (not relative to the font size). </description> diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml index e60ab094c6..7c2966bd4f 100644 --- a/doc/classes/GPUParticles2D.xml +++ b/doc/classes/GPUParticles2D.xml @@ -20,11 +20,11 @@ </method> <method name="emit_particle"> <return type="void" /> - <argument index="0" name="xform" type="Transform2D" /> - <argument index="1" name="velocity" type="Vector2" /> - <argument index="2" name="color" type="Color" /> - <argument index="3" name="custom" type="Color" /> - <argument index="4" name="flags" type="int" /> + <param index="0" name="xform" type="Transform2D" /> + <param index="1" name="velocity" type="Vector2" /> + <param index="2" name="color" type="Color" /> + <param index="3" name="custom" type="Color" /> + <param index="4" name="flags" type="int" /> <description> Emits a single particle. Whether [code]xform[/code], [code]velocity[/code], [code]color[/code] and [code]custom[/code] are applied depends on the value of [code]flags[/code]. See [enum EmitFlags]. </description> diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index b415c56154..4cd95f561f 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -20,18 +20,18 @@ </method> <method name="emit_particle"> <return type="void" /> - <argument index="0" name="xform" type="Transform3D" /> - <argument index="1" name="velocity" type="Vector3" /> - <argument index="2" name="color" type="Color" /> - <argument index="3" name="custom" type="Color" /> - <argument index="4" name="flags" type="int" /> + <param index="0" name="xform" type="Transform3D" /> + <param index="1" name="velocity" type="Vector3" /> + <param index="2" name="color" type="Color" /> + <param index="3" name="custom" type="Color" /> + <param index="4" name="flags" type="int" /> <description> Emits a single particle. Whether [code]xform[/code], [code]velocity[/code], [code]color[/code] and [code]custom[/code] are applied depends on the value of [code]flags[/code]. See [enum EmitFlags]. </description> </method> <method name="get_draw_pass_mesh" qualifiers="const"> <return type="Mesh" /> - <argument index="0" name="pass" type="int" /> + <param index="0" name="pass" type="int" /> <description> Returns the [Mesh] that is drawn at index [code]pass[/code]. </description> @@ -44,8 +44,8 @@ </method> <method name="set_draw_pass_mesh"> <return type="void" /> - <argument index="0" name="pass" type="int" /> - <argument index="1" name="mesh" type="Mesh" /> + <param index="0" name="pass" type="int" /> + <param index="1" name="mesh" type="Mesh" /> <description> Sets the [Mesh] that is drawn at index [code]pass[/code]. </description> diff --git a/doc/classes/GPUParticlesCollisionSDF3D.xml b/doc/classes/GPUParticlesCollisionSDF3D.xml index bc8b3c7c11..1a530b2561 100644 --- a/doc/classes/GPUParticlesCollisionSDF3D.xml +++ b/doc/classes/GPUParticlesCollisionSDF3D.xml @@ -16,15 +16,15 @@ <methods> <method name="get_bake_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member bake_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_bake_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member bake_mask], given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/doc/classes/Generic6DOFJoint3D.xml b/doc/classes/Generic6DOFJoint3D.xml index b1bc411a21..5eec089a6f 100644 --- a/doc/classes/Generic6DOFJoint3D.xml +++ b/doc/classes/Generic6DOFJoint3D.xml @@ -11,79 +11,79 @@ <methods> <method name="get_flag_x" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> + <param index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> <description> </description> </method> <method name="get_flag_y" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> + <param index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> <description> </description> </method> <method name="get_flag_z" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> + <param index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> <description> </description> </method> <method name="get_param_x" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> + <param index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> <description> </description> </method> <method name="get_param_y" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> + <param index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> <description> </description> </method> <method name="get_param_z" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> + <param index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> <description> </description> </method> <method name="set_flag_x"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> + <param index="1" name="value" type="bool" /> <description> </description> </method> <method name="set_flag_y"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> + <param index="1" name="value" type="bool" /> <description> </description> </method> <method name="set_flag_z"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="flag" type="int" enum="Generic6DOFJoint3D.Flag" /> + <param index="1" name="value" type="bool" /> <description> </description> </method> <method name="set_param_x"> <return type="void" /> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> + <param index="1" name="value" type="float" /> <description> </description> </method> <method name="set_param_y"> <return type="void" /> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> + <param index="1" name="value" type="float" /> <description> </description> </method> <method name="set_param_z"> <return type="void" /> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="Generic6DOFJoint3D.Param" /> + <param index="1" name="value" type="float" /> <description> </description> </method> diff --git a/doc/classes/Geometry2D.xml b/doc/classes/Geometry2D.xml index a4cfa1ddff..0926f0acfe 100644 --- a/doc/classes/Geometry2D.xml +++ b/doc/classes/Geometry2D.xml @@ -11,8 +11,8 @@ <methods> <method name="clip_polygons"> <return type="Array" /> - <argument index="0" name="polygon_a" type="PackedVector2Array" /> - <argument index="1" name="polygon_b" type="PackedVector2Array" /> + <param index="0" name="polygon_a" type="PackedVector2Array" /> + <param index="1" name="polygon_b" type="PackedVector2Array" /> <description> Clips [code]polygon_a[/code] against [code]polygon_b[/code] and returns an array of clipped polygons. This performs [constant OPERATION_DIFFERENCE] between polygons. Returns an empty array if [code]polygon_b[/code] completely overlaps [code]polygon_a[/code]. If [code]polygon_b[/code] is enclosed by [code]polygon_a[/code], returns an outer polygon (boundary) and inner polygon (hole) which could be distinguished by calling [method is_polygon_clockwise]. @@ -20,23 +20,23 @@ </method> <method name="clip_polyline_with_polygon"> <return type="Array" /> - <argument index="0" name="polyline" type="PackedVector2Array" /> - <argument index="1" name="polygon" type="PackedVector2Array" /> + <param index="0" name="polyline" type="PackedVector2Array" /> + <param index="1" name="polygon" type="PackedVector2Array" /> <description> Clips [code]polyline[/code] against [code]polygon[/code] and returns an array of clipped polylines. This performs [constant OPERATION_DIFFERENCE] between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape. </description> </method> <method name="convex_hull"> <return type="PackedVector2Array" /> - <argument index="0" name="points" type="PackedVector2Array" /> + <param index="0" name="points" type="PackedVector2Array" /> <description> Given an array of [Vector2]s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first one. </description> </method> <method name="exclude_polygons"> <return type="Array" /> - <argument index="0" name="polygon_a" type="PackedVector2Array" /> - <argument index="1" name="polygon_b" type="PackedVector2Array" /> + <param index="0" name="polygon_a" type="PackedVector2Array" /> + <param index="1" name="polygon_b" type="PackedVector2Array" /> <description> Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons]) and returns an array of excluded polygons. This performs [constant OPERATION_XOR] between polygons. In other words, returns all but common area between polygons. The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. @@ -44,36 +44,36 @@ </method> <method name="get_closest_point_to_segment"> <return type="Vector2" /> - <argument index="0" name="point" type="Vector2" /> - <argument index="1" name="s1" type="Vector2" /> - <argument index="2" name="s2" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> + <param index="1" name="s1" type="Vector2" /> + <param index="2" name="s2" type="Vector2" /> <description> Returns the 2D point on the 2D segment ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point will always be inside the specified segment. </description> </method> <method name="get_closest_point_to_segment_uncapped"> <return type="Vector2" /> - <argument index="0" name="point" type="Vector2" /> - <argument index="1" name="s1" type="Vector2" /> - <argument index="2" name="s2" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> + <param index="1" name="s1" type="Vector2" /> + <param index="2" name="s2" type="Vector2" /> <description> Returns the 2D point on the 2D line defined by ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point can be inside the segment ([code]s1[/code], [code]s2[/code]) or outside of it, i.e. somewhere on the line extending from the segment. </description> </method> <method name="get_closest_points_between_segments"> <return type="PackedVector2Array" /> - <argument index="0" name="p1" type="Vector2" /> - <argument index="1" name="q1" type="Vector2" /> - <argument index="2" name="p2" type="Vector2" /> - <argument index="3" name="q2" type="Vector2" /> + <param index="0" name="p1" type="Vector2" /> + <param index="1" name="q1" type="Vector2" /> + <param index="2" name="p2" type="Vector2" /> + <param index="3" name="q2" type="Vector2" /> <description> Given the two 2D segments ([code]p1[/code], [code]q1[/code]) and ([code]p2[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PackedVector2Array] that contains this point on ([code]p1[/code], [code]q1[/code]) as well the accompanying point on ([code]p2[/code], [code]q2[/code]). </description> </method> <method name="intersect_polygons"> <return type="Array" /> - <argument index="0" name="polygon_a" type="PackedVector2Array" /> - <argument index="1" name="polygon_b" type="PackedVector2Array" /> + <param index="0" name="polygon_a" type="PackedVector2Array" /> + <param index="1" name="polygon_b" type="PackedVector2Array" /> <description> Intersects [code]polygon_a[/code] with [code]polygon_b[/code] and returns an array of intersected polygons. This performs [constant OPERATION_INTERSECTION] between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs. The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. @@ -81,42 +81,42 @@ </method> <method name="intersect_polyline_with_polygon"> <return type="Array" /> - <argument index="0" name="polyline" type="PackedVector2Array" /> - <argument index="1" name="polygon" type="PackedVector2Array" /> + <param index="0" name="polyline" type="PackedVector2Array" /> + <param index="1" name="polygon" type="PackedVector2Array" /> <description> Intersects [code]polyline[/code] with [code]polygon[/code] and returns an array of intersected polylines. This performs [constant OPERATION_INTERSECTION] between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. </description> </method> <method name="is_point_in_circle"> <return type="bool" /> - <argument index="0" name="point" type="Vector2" /> - <argument index="1" name="circle_position" type="Vector2" /> - <argument index="2" name="circle_radius" type="float" /> + <param index="0" name="point" type="Vector2" /> + <param index="1" name="circle_position" type="Vector2" /> + <param index="2" name="circle_radius" type="float" /> <description> Returns [code]true[/code] if [code]point[/code] is inside the circle or if it's located exactly [i]on[/i] the circle's boundary, otherwise returns [code]false[/code]. </description> </method> <method name="is_point_in_polygon"> <return type="bool" /> - <argument index="0" name="point" type="Vector2" /> - <argument index="1" name="polygon" type="PackedVector2Array" /> + <param index="0" name="point" type="Vector2" /> + <param index="1" name="polygon" type="PackedVector2Array" /> <description> Returns [code]true[/code] if [code]point[/code] is inside [code]polygon[/code] or if it's located exactly [i]on[/i] polygon's boundary, otherwise returns [code]false[/code]. </description> </method> <method name="is_polygon_clockwise"> <return type="bool" /> - <argument index="0" name="polygon" type="PackedVector2Array" /> + <param index="0" name="polygon" type="PackedVector2Array" /> <description> Returns [code]true[/code] if [code]polygon[/code]'s vertices are ordered in clockwise order, otherwise returns [code]false[/code]. </description> </method> <method name="line_intersects_line"> <return type="Variant" /> - <argument index="0" name="from_a" type="Vector2" /> - <argument index="1" name="dir_a" type="Vector2" /> - <argument index="2" name="from_b" type="Vector2" /> - <argument index="3" name="dir_b" type="Vector2" /> + <param index="0" name="from_a" type="Vector2" /> + <param index="1" name="dir_a" type="Vector2" /> + <param index="2" name="from_b" type="Vector2" /> + <param index="3" name="dir_b" type="Vector2" /> <description> Checks if the two lines ([code]from_a[/code], [code]dir_a[/code]) and ([code]from_b[/code], [code]dir_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns [code]null[/code]. [b]Note:[/b] The lines are specified using direction vectors, not end points. @@ -124,15 +124,15 @@ </method> <method name="make_atlas"> <return type="Dictionary" /> - <argument index="0" name="sizes" type="PackedVector2Array" /> + <param index="0" name="sizes" type="PackedVector2Array" /> <description> Given an array of [Vector2]s representing tiles, builds an atlas. The returned dictionary has two keys: [code]points[/code] is an array of [Vector2] that specifies the positions of each tile, [code]size[/code] contains the overall size of the whole atlas as [Vector2]. </description> </method> <method name="merge_polygons"> <return type="Array" /> - <argument index="0" name="polygon_a" type="PackedVector2Array" /> - <argument index="1" name="polygon_b" type="PackedVector2Array" /> + <param index="0" name="polygon_a" type="PackedVector2Array" /> + <param index="1" name="polygon_b" type="PackedVector2Array" /> <description> Merges (combines) [code]polygon_a[/code] and [code]polygon_b[/code] and returns an array of merged polygons. This performs [constant OPERATION_UNION] between polygons. The operation may result in an outer polygon (boundary) and multiple inner polygons (holes) produced which could be distinguished by calling [method is_polygon_clockwise]. @@ -140,9 +140,9 @@ </method> <method name="offset_polygon"> <return type="Array" /> - <argument index="0" name="polygon" type="PackedVector2Array" /> - <argument index="1" name="delta" type="float" /> - <argument index="2" name="join_type" type="int" enum="Geometry2D.PolyJoinType" default="0" /> + <param index="0" name="polygon" type="PackedVector2Array" /> + <param index="1" name="delta" type="float" /> + <param index="2" name="join_type" type="int" enum="Geometry2D.PolyJoinType" default="0" /> <description> Inflates or deflates [code]polygon[/code] by [code]delta[/code] units (pixels). If [code]delta[/code] is positive, makes the polygon grow outward. If [code]delta[/code] is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if [code]delta[/code] is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType]. @@ -167,10 +167,10 @@ </method> <method name="offset_polyline"> <return type="Array" /> - <argument index="0" name="polyline" type="PackedVector2Array" /> - <argument index="1" name="delta" type="float" /> - <argument index="2" name="join_type" type="int" enum="Geometry2D.PolyJoinType" default="0" /> - <argument index="3" name="end_type" type="int" enum="Geometry2D.PolyEndType" default="3" /> + <param index="0" name="polyline" type="PackedVector2Array" /> + <param index="1" name="delta" type="float" /> + <param index="2" name="join_type" type="int" enum="Geometry2D.PolyJoinType" default="0" /> + <param index="3" name="end_type" type="int" enum="Geometry2D.PolyEndType" default="3" /> <description> Inflates or deflates [code]polyline[/code] by [code]delta[/code] units (pixels), producing polygons. If [code]delta[/code] is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If [code]delta[/code] is negative, returns an empty array. Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType]. @@ -180,44 +180,44 @@ </method> <method name="point_is_inside_triangle" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point" type="Vector2" /> - <argument index="1" name="a" type="Vector2" /> - <argument index="2" name="b" type="Vector2" /> - <argument index="3" name="c" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> + <param index="1" name="a" type="Vector2" /> + <param index="2" name="b" type="Vector2" /> + <param index="3" name="c" type="Vector2" /> <description> Returns if [code]point[/code] is inside the triangle specified by [code]a[/code], [code]b[/code] and [code]c[/code]. </description> </method> <method name="segment_intersects_circle"> <return type="float" /> - <argument index="0" name="segment_from" type="Vector2" /> - <argument index="1" name="segment_to" type="Vector2" /> - <argument index="2" name="circle_position" type="Vector2" /> - <argument index="3" name="circle_radius" type="float" /> + <param index="0" name="segment_from" type="Vector2" /> + <param index="1" name="segment_to" type="Vector2" /> + <param index="2" name="circle_position" type="Vector2" /> + <param index="3" name="circle_radius" type="float" /> <description> Given the 2D segment ([code]segment_from[/code], [code]segment_to[/code]), returns the position on the segment (as a number between 0 and 1) at which the segment hits the circle that is located at position [code]circle_position[/code] and has radius [code]circle_radius[/code]. If the segment does not intersect the circle, -1 is returned (this is also the case if the line extending the segment would intersect the circle, but the segment does not). </description> </method> <method name="segment_intersects_segment"> <return type="Variant" /> - <argument index="0" name="from_a" type="Vector2" /> - <argument index="1" name="to_a" type="Vector2" /> - <argument index="2" name="from_b" type="Vector2" /> - <argument index="3" name="to_b" type="Vector2" /> + <param index="0" name="from_a" type="Vector2" /> + <param index="1" name="to_a" type="Vector2" /> + <param index="2" name="from_b" type="Vector2" /> + <param index="3" name="to_b" type="Vector2" /> <description> Checks if the two segments ([code]from_a[/code], [code]to_a[/code]) and ([code]from_b[/code], [code]to_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns [code]null[/code]. </description> </method> <method name="triangulate_delaunay"> <return type="PackedInt32Array" /> - <argument index="0" name="points" type="PackedVector2Array" /> + <param index="0" name="points" type="PackedVector2Array" /> <description> Triangulates the area specified by discrete set of [code]points[/code] such that no point is inside the circumcircle of any resulting triangle. Returns a [PackedInt32Array] where each triangle consists of three consecutive point indices into [code]points[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PackedInt32Array] is returned. </description> </method> <method name="triangulate_polygon"> <return type="PackedInt32Array" /> - <argument index="0" name="polygon" type="PackedVector2Array" /> + <param index="0" name="polygon" type="PackedVector2Array" /> <description> Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PackedInt32Array] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). Output triangles will always be counter clockwise, and the contour will be flipped if it's clockwise. If the triangulation did not succeed, an empty [PackedInt32Array] is returned. </description> diff --git a/doc/classes/Geometry3D.xml b/doc/classes/Geometry3D.xml index c05d7df53f..654c499c97 100644 --- a/doc/classes/Geometry3D.xml +++ b/doc/classes/Geometry3D.xml @@ -11,115 +11,115 @@ <methods> <method name="build_box_planes"> <return type="Array" /> - <argument index="0" name="extents" type="Vector3" /> + <param index="0" name="extents" type="Vector3" /> <description> Returns an array with 6 [Plane]s that describe the sides of a box centered at the origin. The box size is defined by [code]extents[/code], which represents one (positive) corner of the box (i.e. half its actual size). </description> </method> <method name="build_capsule_planes"> <return type="Array" /> - <argument index="0" name="radius" type="float" /> - <argument index="1" name="height" type="float" /> - <argument index="2" name="sides" type="int" /> - <argument index="3" name="lats" type="int" /> - <argument index="4" name="axis" type="int" enum="Vector3.Axis" default="2" /> + <param index="0" name="radius" type="float" /> + <param index="1" name="height" type="float" /> + <param index="2" name="sides" type="int" /> + <param index="3" name="lats" type="int" /> + <param index="4" name="axis" type="int" enum="Vector3.Axis" default="2" /> <description> Returns an array of [Plane]s closely bounding a faceted capsule centered at the origin with radius [code]radius[/code] and height [code]height[/code]. The parameter [code]sides[/code] defines how many planes will be generated for the side part of the capsule, whereas [code]lats[/code] gives the number of latitudinal steps at the bottom and top of the capsule. The parameter [code]axis[/code] describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). </description> </method> <method name="build_cylinder_planes"> <return type="Array" /> - <argument index="0" name="radius" type="float" /> - <argument index="1" name="height" type="float" /> - <argument index="2" name="sides" type="int" /> - <argument index="3" name="axis" type="int" enum="Vector3.Axis" default="2" /> + <param index="0" name="radius" type="float" /> + <param index="1" name="height" type="float" /> + <param index="2" name="sides" type="int" /> + <param index="3" name="axis" type="int" enum="Vector3.Axis" default="2" /> <description> Returns an array of [Plane]s closely bounding a faceted cylinder centered at the origin with radius [code]radius[/code] and height [code]height[/code]. The parameter [code]sides[/code] defines how many planes will be generated for the round part of the cylinder. The parameter [code]axis[/code] describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). </description> </method> <method name="clip_polygon"> <return type="PackedVector3Array" /> - <argument index="0" name="points" type="PackedVector3Array" /> - <argument index="1" name="plane" type="Plane" /> + <param index="0" name="points" type="PackedVector3Array" /> + <param index="1" name="plane" type="Plane" /> <description> Clips the polygon defined by the points in [code]points[/code] against the [code]plane[/code] and returns the points of the clipped polygon. </description> </method> <method name="get_closest_point_to_segment"> <return type="Vector3" /> - <argument index="0" name="point" type="Vector3" /> - <argument index="1" name="s1" type="Vector3" /> - <argument index="2" name="s2" type="Vector3" /> + <param index="0" name="point" type="Vector3" /> + <param index="1" name="s1" type="Vector3" /> + <param index="2" name="s2" type="Vector3" /> <description> Returns the 3D point on the 3D segment ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point will always be inside the specified segment. </description> </method> <method name="get_closest_point_to_segment_uncapped"> <return type="Vector3" /> - <argument index="0" name="point" type="Vector3" /> - <argument index="1" name="s1" type="Vector3" /> - <argument index="2" name="s2" type="Vector3" /> + <param index="0" name="point" type="Vector3" /> + <param index="1" name="s1" type="Vector3" /> + <param index="2" name="s2" type="Vector3" /> <description> Returns the 3D point on the 3D line defined by ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point can be inside the segment ([code]s1[/code], [code]s2[/code]) or outside of it, i.e. somewhere on the line extending from the segment. </description> </method> <method name="get_closest_points_between_segments"> <return type="PackedVector3Array" /> - <argument index="0" name="p1" type="Vector3" /> - <argument index="1" name="p2" type="Vector3" /> - <argument index="2" name="q1" type="Vector3" /> - <argument index="3" name="q2" type="Vector3" /> + <param index="0" name="p1" type="Vector3" /> + <param index="1" name="p2" type="Vector3" /> + <param index="2" name="q1" type="Vector3" /> + <param index="3" name="q2" type="Vector3" /> <description> Given the two 3D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PackedVector3Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]). </description> </method> <method name="ray_intersects_triangle"> <return type="Variant" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="dir" type="Vector3" /> - <argument index="2" name="a" type="Vector3" /> - <argument index="3" name="b" type="Vector3" /> - <argument index="4" name="c" type="Vector3" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="dir" type="Vector3" /> + <param index="2" name="a" type="Vector3" /> + <param index="3" name="b" type="Vector3" /> + <param index="4" name="c" type="Vector3" /> <description> Tests if the 3D ray starting at [code]from[/code] with the direction of [code]dir[/code] intersects the triangle specified by [code]a[/code], [code]b[/code] and [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, returns [code]null[/code]. </description> </method> <method name="segment_intersects_convex"> <return type="PackedVector3Array" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> - <argument index="2" name="planes" type="Array" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> + <param index="2" name="planes" type="Array" /> <description> Given a convex hull defined though the [Plane]s in the array [code]planes[/code], tests if the segment ([code]from[/code], [code]to[/code]) intersects with that hull. If an intersection is found, returns a [PackedVector3Array] containing the point the intersection and the hull's normal. Otherwise, returns an empty array. </description> </method> <method name="segment_intersects_cylinder"> <return type="PackedVector3Array" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> - <argument index="2" name="height" type="float" /> - <argument index="3" name="radius" type="float" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> + <param index="2" name="height" type="float" /> + <param index="3" name="radius" type="float" /> <description> Checks if the segment ([code]from[/code], [code]to[/code]) intersects the cylinder with height [code]height[/code] that is centered at the origin and has radius [code]radius[/code]. If no, returns an empty [PackedVector3Array]. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. </description> </method> <method name="segment_intersects_sphere"> <return type="PackedVector3Array" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> - <argument index="2" name="sphere_position" type="Vector3" /> - <argument index="3" name="sphere_radius" type="float" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> + <param index="2" name="sphere_position" type="Vector3" /> + <param index="3" name="sphere_radius" type="float" /> <description> Checks if the segment ([code]from[/code], [code]to[/code]) intersects the sphere that is located at [code]sphere_position[/code] and has radius [code]sphere_radius[/code]. If no, returns an empty [PackedVector3Array]. If yes, returns a [PackedVector3Array] containing the point of intersection and the sphere's normal at the point of intersection. </description> </method> <method name="segment_intersects_triangle"> <return type="Variant" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> - <argument index="2" name="a" type="Vector3" /> - <argument index="3" name="b" type="Vector3" /> - <argument index="4" name="c" type="Vector3" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> + <param index="2" name="a" type="Vector3" /> + <param index="3" name="b" type="Vector3" /> + <param index="4" name="c" type="Vector3" /> <description> Tests if the segment ([code]from[/code], [code]to[/code]) intersects the triangle [code]a[/code], [code]b[/code], [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, returns [code]null[/code]. </description> diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml index 365efa6761..79a60a9e62 100644 --- a/doc/classes/GeometryInstance3D.xml +++ b/doc/classes/GeometryInstance3D.xml @@ -11,21 +11,21 @@ <methods> <method name="get_instance_shader_uniform" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="uniform" type="StringName" /> + <param index="0" name="uniform" type="StringName" /> <description> </description> </method> <method name="set_custom_aabb"> <return type="void" /> - <argument index="0" name="aabb" type="AABB" /> + <param index="0" name="aabb" type="AABB" /> <description> Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero. </description> </method> <method name="set_instance_shader_uniform"> <return type="void" /> - <argument index="0" name="uniform" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="uniform" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> </description> </method> diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index 8c5373216a..bf64feedda 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -12,22 +12,22 @@ <methods> <method name="add_point"> <return type="void" /> - <argument index="0" name="offset" type="float" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="offset" type="float" /> + <param index="1" name="color" type="Color" /> <description> Adds the specified color to the end of the gradient, with the specified offset. </description> </method> <method name="get_color"> <return type="Color" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Returns the color of the gradient color at index [code]point[/code]. </description> </method> <method name="get_offset"> <return type="float" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Returns the offset of the gradient color at index [code]point[/code]. </description> @@ -40,14 +40,14 @@ </method> <method name="interpolate"> <return type="Color" /> - <argument index="0" name="offset" type="float" /> + <param index="0" name="offset" type="float" /> <description> Returns the interpolated color specified by [code]offset[/code]. </description> </method> <method name="remove_point"> <return type="void" /> - <argument index="0" name="point" type="int" /> + <param index="0" name="point" type="int" /> <description> Removes the color at the index [code]point[/code]. </description> @@ -60,16 +60,16 @@ </method> <method name="set_color"> <return type="void" /> - <argument index="0" name="point" type="int" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="point" type="int" /> + <param index="1" name="color" type="Color" /> <description> Sets the color of the gradient color at index [code]point[/code]. </description> </method> <method name="set_offset"> <return type="void" /> - <argument index="0" name="point" type="int" /> - <argument index="1" name="offset" type="float" /> + <param index="0" name="point" type="int" /> + <param index="1" name="offset" type="float" /> <description> Sets the offset for the gradient color at index [code]point[/code]. </description> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 33145dccd0..d257e990f7 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -12,17 +12,17 @@ <methods> <method name="_get_connection_line" qualifiers="virtual const"> <return type="PackedVector2Array" /> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> <description> Virtual method which can be overridden to customize how connections are drawn. </description> </method> <method name="_is_in_input_hotzone" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="graph_node" type="Object" /> - <argument index="1" name="slot_index" type="int" /> - <argument index="2" name="mouse_position" type="Vector2" /> + <param index="0" name="graph_node" type="Object" /> + <param index="1" name="slot_index" type="int" /> + <param index="2" name="mouse_position" type="Vector2" /> <description> Returns whether the [code]mouse_position[/code] is in the input hot zone. By default, a hot zone is a [Rect2] positioned such that its center is at [code]graph_node[/code].[method GraphNode.get_connection_input_position]([code]slot_index[/code]) (For output's case, call [method GraphNode.get_connection_output_position] instead). The hot zone's width is twice the Theme Property [code]port_grab_distance_horizontal[/code], and its height is twice the [code]port_grab_distance_vertical[/code]. @@ -39,9 +39,9 @@ </method> <method name="_is_in_output_hotzone" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="graph_node" type="Object" /> - <argument index="1" name="slot_index" type="int" /> - <argument index="2" name="mouse_position" type="Vector2" /> + <param index="0" name="graph_node" type="Object" /> + <param index="1" name="slot_index" type="int" /> + <param index="2" name="mouse_position" type="Vector2" /> <description> Returns whether the [code]mouse_position[/code] is in the output hot zone. For more information on hot zones, see [method _is_in_input_hotzone]. Below is a sample code to help get started: @@ -57,10 +57,10 @@ </method> <method name="_is_node_hover_valid" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="from_slot" type="int" /> - <argument index="2" name="to" type="StringName" /> - <argument index="3" name="to_slot" type="int" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="from_slot" type="int" /> + <param index="2" name="to" type="StringName" /> + <param index="3" name="to_slot" type="int" /> <description> This virtual method can be used to insert additional error detection while the user is dragging a connection over a valid port. Return [code]true[/code] if the connection is indeed valid or return [code]false[/code] if the connection is impossible. If the connection is impossible, no snapping to the port and thus no connection request to that port will happen. @@ -80,22 +80,22 @@ </method> <method name="add_valid_connection_type"> <return type="void" /> - <argument index="0" name="from_type" type="int" /> - <argument index="1" name="to_type" type="int" /> + <param index="0" name="from_type" type="int" /> + <param index="1" name="to_type" type="int" /> <description> Makes possible the connection between two different slot types. The type is defined with the [method GraphNode.set_slot] method. </description> </method> <method name="add_valid_left_disconnect_type"> <return type="void" /> - <argument index="0" name="type" type="int" /> + <param index="0" name="type" type="int" /> <description> Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type. </description> </method> <method name="add_valid_right_disconnect_type"> <return type="void" /> - <argument index="0" name="type" type="int" /> + <param index="0" name="type" type="int" /> <description> Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type. </description> @@ -114,20 +114,20 @@ </method> <method name="connect_node"> <return type="int" enum="Error" /> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="from_port" type="int" /> - <argument index="2" name="to" type="StringName" /> - <argument index="3" name="to_port" type="int" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="from_port" type="int" /> + <param index="2" name="to" type="StringName" /> + <param index="3" name="to_port" type="int" /> <description> Create a connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection already exists, no connection is created. </description> </method> <method name="disconnect_node"> <return type="void" /> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="from_port" type="int" /> - <argument index="2" name="to" type="StringName" /> - <argument index="3" name="to_port" type="int" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="from_port" type="int" /> + <param index="2" name="to" type="StringName" /> + <param index="3" name="to_port" type="int" /> <description> Removes the connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection does not exist, no connection is removed. </description> @@ -142,8 +142,8 @@ </method> <method name="get_connection_line"> <return type="PackedVector2Array" /> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> <description> Returns the points which would make up a connection between [code]from[/code] and [code]to[/code]. </description> @@ -163,58 +163,58 @@ </method> <method name="is_node_connected"> <return type="bool" /> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="from_port" type="int" /> - <argument index="2" name="to" type="StringName" /> - <argument index="3" name="to_port" type="int" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="from_port" type="int" /> + <param index="2" name="to" type="StringName" /> + <param index="3" name="to_port" type="int" /> <description> Returns [code]true[/code] if the [code]from_port[/code] slot of the [code]from[/code] GraphNode is connected to the [code]to_port[/code] slot of the [code]to[/code] GraphNode. </description> </method> <method name="is_valid_connection_type" qualifiers="const"> <return type="bool" /> - <argument index="0" name="from_type" type="int" /> - <argument index="1" name="to_type" type="int" /> + <param index="0" name="from_type" type="int" /> + <param index="1" name="to_type" type="int" /> <description> Returns whether it's possible to connect slots of the specified types. </description> </method> <method name="remove_valid_connection_type"> <return type="void" /> - <argument index="0" name="from_type" type="int" /> - <argument index="1" name="to_type" type="int" /> + <param index="0" name="from_type" type="int" /> + <param index="1" name="to_type" type="int" /> <description> Makes it not possible to connect between two different slot types. The type is defined with the [method GraphNode.set_slot] method. </description> </method> <method name="remove_valid_left_disconnect_type"> <return type="void" /> - <argument index="0" name="type" type="int" /> + <param index="0" name="type" type="int" /> <description> Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type. </description> </method> <method name="remove_valid_right_disconnect_type"> <return type="void" /> - <argument index="0" name="type" type="int" /> + <param index="0" name="type" type="int" /> <description> Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. </description> </method> <method name="set_connection_activity"> <return type="void" /> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="from_port" type="int" /> - <argument index="2" name="to" type="StringName" /> - <argument index="3" name="to_port" type="int" /> - <argument index="4" name="amount" type="float" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="from_port" type="int" /> + <param index="2" name="to" type="StringName" /> + <param index="3" name="to_port" type="int" /> + <param index="4" name="amount" type="float" /> <description> Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [theme_item activity] theme property. </description> </method> <method name="set_selected"> <return type="void" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Sets the specified [code]node[/code] as the one selected. </description> @@ -284,34 +284,34 @@ </description> </signal> <signal name="connection_drag_started"> - <argument index="0" name="from" type="String" /> - <argument index="1" name="slot" type="String" /> - <argument index="2" name="is_output" type="bool" /> + <param index="0" name="from" type="String" /> + <param index="1" name="slot" type="String" /> + <param index="2" name="is_output" type="bool" /> <description> Emitted at the beginning of a connection drag. </description> </signal> <signal name="connection_from_empty"> - <argument index="0" name="to" type="StringName" /> - <argument index="1" name="to_slot" type="int" /> - <argument index="2" name="release_position" type="Vector2" /> + <param index="0" name="to" type="StringName" /> + <param index="1" name="to_slot" type="int" /> + <param index="2" name="release_position" type="Vector2" /> <description> Emitted when user dragging connection from input port into empty space of the graph. </description> </signal> <signal name="connection_request"> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="from_slot" type="int" /> - <argument index="2" name="to" type="StringName" /> - <argument index="3" name="to_slot" type="int" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="from_slot" type="int" /> + <param index="2" name="to" type="StringName" /> + <param index="3" name="to_slot" type="int" /> <description> Emitted to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created. </description> </signal> <signal name="connection_to_empty"> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="from_slot" type="int" /> - <argument index="2" name="release_position" type="Vector2" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="from_slot" type="int" /> + <param index="2" name="release_position" type="Vector2" /> <description> Emitted when user dragging connection from output port into empty space of the graph. </description> @@ -322,16 +322,16 @@ </description> </signal> <signal name="delete_nodes_request"> - <argument index="0" name="nodes" type="StringName[]" /> + <param index="0" name="nodes" type="StringName[]" /> <description> Emitted when a GraphNode is attempted to be removed from the GraphEdit. Provides a list of node names to be removed (all selected nodes, excluding nodes without closing button). </description> </signal> <signal name="disconnection_request"> - <argument index="0" name="from" type="StringName" /> - <argument index="1" name="from_slot" type="int" /> - <argument index="2" name="to" type="StringName" /> - <argument index="3" name="to_slot" type="int" /> + <param index="0" name="from" type="StringName" /> + <param index="1" name="from_slot" type="int" /> + <param index="2" name="to" type="StringName" /> + <param index="3" name="to_slot" type="int" /> <description> Emitted to the GraphEdit when the connection between [code]from_slot[/code] slot of [code]from[/code] GraphNode and [code]to_slot[/code] slot of [code]to[/code] GraphNode is attempted to be removed. </description> @@ -347,12 +347,12 @@ </description> </signal> <signal name="node_deselected"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> </description> </signal> <signal name="node_selected"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted when a GraphNode is selected. </description> @@ -363,13 +363,13 @@ </description> </signal> <signal name="popup_request"> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. [code]position[/code] is the position of the mouse pointer when the signal is sent. </description> </signal> <signal name="scroll_offset_changed"> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> <description> Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code. </description> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 36dbae1d74..ac14d5d2a8 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -19,14 +19,14 @@ </method> <method name="clear_slot"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Disables input and output slot whose index is [code]idx[/code]. </description> </method> <method name="get_connection_input_color"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the [Color] of the input connection [code]idx[/code]. </description> @@ -39,28 +39,28 @@ </method> <method name="get_connection_input_height"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the height of the input connection [code]idx[/code]. </description> </method> <method name="get_connection_input_position"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the position of the input connection [code]idx[/code]. </description> </method> <method name="get_connection_input_type"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the type of the input connection [code]idx[/code]. </description> </method> <method name="get_connection_output_color"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the [Color] of the output connection [code]idx[/code]. </description> @@ -73,86 +73,86 @@ </method> <method name="get_connection_output_height"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the height of the output connection [code]idx[/code]. </description> </method> <method name="get_connection_output_position"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the position of the output connection [code]idx[/code]. </description> </method> <method name="get_connection_output_type"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the type of the output connection [code]idx[/code]. </description> </method> <method name="get_slot_color_left" qualifiers="const"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the left (input) [Color] of the slot [code]idx[/code]. </description> </method> <method name="get_slot_color_right" qualifiers="const"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the right (output) [Color] of the slot [code]idx[/code]. </description> </method> <method name="get_slot_type_left" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the left (input) type of the slot [code]idx[/code]. </description> </method> <method name="get_slot_type_right" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the right (output) type of the slot [code]idx[/code]. </description> </method> <method name="is_slot_draw_stylebox" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns true if the background [StyleBox] of the slot [code]idx[/code] is drawn. </description> </method> <method name="is_slot_enabled_left" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if left (input) side of the slot [code]idx[/code] is enabled. </description> </method> <method name="is_slot_enabled_right" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if right (output) side of the slot [code]idx[/code] is enabled. </description> </method> <method name="set_slot"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="enable_left" type="bool" /> - <argument index="2" name="type_left" type="int" /> - <argument index="3" name="color_left" type="Color" /> - <argument index="4" name="enable_right" type="bool" /> - <argument index="5" name="type_right" type="int" /> - <argument index="6" name="color_right" type="Color" /> - <argument index="7" name="custom_left" type="Texture2D" default="null" /> - <argument index="8" name="custom_right" type="Texture2D" default="null" /> - <argument index="9" name="enable" type="bool" default="true" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="enable_left" type="bool" /> + <param index="2" name="type_left" type="int" /> + <param index="3" name="color_left" type="Color" /> + <param index="4" name="enable_right" type="bool" /> + <param index="5" name="type_right" type="int" /> + <param index="6" name="color_right" type="Color" /> + <param index="7" name="custom_left" type="Texture2D" default="null" /> + <param index="8" name="custom_right" type="Texture2D" default="null" /> + <param index="9" name="enable" type="bool" default="true" /> <description> Sets properties of the slot with ID [code]idx[/code]. If [code]enable_left[/code]/[code]right[/code], a port will appear and the slot will be able to be connected from this side. @@ -165,56 +165,56 @@ </method> <method name="set_slot_color_left"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="color_left" type="Color" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="color_left" type="Color" /> <description> Sets the [Color] of the left (input) side of the slot [code]idx[/code] to [code]color_left[/code]. </description> </method> <method name="set_slot_color_right"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="color_right" type="Color" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="color_right" type="Color" /> <description> Sets the [Color] of the right (output) side of the slot [code]idx[/code] to [code]color_right[/code]. </description> </method> <method name="set_slot_draw_stylebox"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="draw_stylebox" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="draw_stylebox" type="bool" /> <description> Toggles the background [StyleBox] of the slot [code]idx[/code]. </description> </method> <method name="set_slot_enabled_left"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="enable_left" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="enable_left" type="bool" /> <description> Toggles the left (input) side of the slot [code]idx[/code]. If [code]enable_left[/code] is [code]true[/code], a port will appear on the left side and the slot will be able to be connected from this side. </description> </method> <method name="set_slot_enabled_right"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="enable_right" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="enable_right" type="bool" /> <description> Toggles the right (output) side of the slot [code]idx[/code]. If [code]enable_right[/code] is [code]true[/code], a port will appear on the right side and the slot will be able to be connected from this side. </description> </method> <method name="set_slot_type_left"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="type_left" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="type_left" type="int" /> <description> Sets the left (input) type of the slot [code]idx[/code] to [code]type_left[/code]. </description> </method> <method name="set_slot_type_right"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="type_right" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="type_right" type="int" /> <description> Sets the right (output) type of the slot [code]idx[/code] to [code]type_right[/code]. </description> @@ -260,8 +260,8 @@ </description> </signal> <signal name="dragged"> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> <description> Emitted when the GraphNode is dragged. </description> @@ -277,13 +277,13 @@ </description> </signal> <signal name="resize_request"> - <argument index="0" name="new_minsize" type="Vector2" /> + <param index="0" name="new_minsize" type="Vector2" /> <description> Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]). </description> </signal> <signal name="slot_updated"> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Emitted when any GraphNode's slot is updated. </description> diff --git a/doc/classes/HMACContext.xml b/doc/classes/HMACContext.xml index f2b946cab7..d033738e52 100644 --- a/doc/classes/HMACContext.xml +++ b/doc/classes/HMACContext.xml @@ -62,15 +62,15 @@ </method> <method name="start"> <return type="int" enum="Error" /> - <argument index="0" name="hash_type" type="int" enum="HashingContext.HashType" /> - <argument index="1" name="key" type="PackedByteArray" /> + <param index="0" name="hash_type" type="int" enum="HashingContext.HashType" /> + <param index="1" name="key" type="PackedByteArray" /> <description> Initializes the HMACContext. This method cannot be called again on the same HMACContext until [method finish] has been called. </description> </method> <method name="update"> <return type="int" enum="Error" /> - <argument index="0" name="data" type="PackedByteArray" /> + <param index="0" name="data" type="PackedByteArray" /> <description> Updates the message to be HMACed. This can be called multiple times before [method finish] is called to append [code]data[/code] to the message, but cannot be called until [method start] has been called. </description> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index fb437b6d8e..645f328be0 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -28,10 +28,10 @@ </method> <method name="connect_to_host"> <return type="int" enum="Error" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="port" type="int" default="-1" /> - <argument index="2" name="use_ssl" type="bool" default="false" /> - <argument index="3" name="verify_host" type="bool" default="true" /> + <param index="0" name="host" type="String" /> + <param index="1" name="port" type="int" default="-1" /> + <param index="2" name="use_ssl" type="bool" default="false" /> + <param index="3" name="verify_host" type="bool" default="true" /> <description> Connects 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. @@ -97,7 +97,7 @@ </method> <method name="query_string_from_dict"> <return type="String" /> - <argument index="0" name="fields" type="Dictionary" /> + <param index="0" name="fields" type="Dictionary" /> <description> Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: [codeblocks] @@ -135,10 +135,10 @@ </method> <method name="request"> <return type="int" enum="Error" /> - <argument index="0" name="method" type="int" enum="HTTPClient.Method" /> - <argument index="1" name="url" type="String" /> - <argument index="2" name="headers" type="PackedStringArray" /> - <argument index="3" name="body" type="String" default="""" /> + <param index="0" name="method" type="int" enum="HTTPClient.Method" /> + <param index="1" name="url" type="String" /> + <param index="2" name="headers" type="PackedStringArray" /> + <param index="3" name="body" type="String" default="""" /> <description> Sends a request to the connected host. The URL parameter is usually just the part after the host, so for [code]https://somehost.com/index.php[/code], it is [code]/index.php[/code]. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, [code]*[/code] is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component ([code]host:port[/code]). @@ -163,10 +163,10 @@ </method> <method name="request_raw"> <return type="int" enum="Error" /> - <argument index="0" name="method" type="int" enum="HTTPClient.Method" /> - <argument index="1" name="url" type="String" /> - <argument index="2" name="headers" type="PackedStringArray" /> - <argument index="3" name="body" type="PackedByteArray" /> + <param index="0" name="method" type="int" enum="HTTPClient.Method" /> + <param index="1" name="url" type="String" /> + <param index="2" name="headers" type="PackedStringArray" /> + <param index="3" name="body" type="PackedByteArray" /> <description> Sends a raw request to the connected host. The URL parameter is usually just the part after the host, so for [code]https://somehost.com/index.php[/code], it is [code]/index.php[/code]. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, [code]*[/code] is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component ([code]host:port[/code]). @@ -176,8 +176,8 @@ </method> <method name="set_http_proxy"> <return type="void" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="port" type="int" /> + <param index="0" name="host" type="String" /> + <param index="1" name="port" type="int" /> <description> Sets the proxy server for HTTP requests. The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1. @@ -185,8 +185,8 @@ </method> <method name="set_https_proxy"> <return type="void" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="port" type="int" /> + <param index="0" name="host" type="String" /> + <param index="1" name="port" type="int" /> <description> Sets the proxy server for HTTPS requests. The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 3d2e9449e2..2307cf149d 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -187,11 +187,11 @@ </method> <method name="request"> <return type="int" enum="Error" /> - <argument index="0" name="url" type="String" /> - <argument index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" /> - <argument index="2" name="ssl_validate_domain" type="bool" default="true" /> - <argument index="3" name="method" type="int" enum="HTTPClient.Method" default="0" /> - <argument index="4" name="request_data" type="String" default="""" /> + <param index="0" name="url" type="String" /> + <param index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" /> + <param index="2" name="ssl_validate_domain" type="bool" default="true" /> + <param index="3" name="method" type="int" enum="HTTPClient.Method" default="0" /> + <param index="4" name="request_data" type="String" default="""" /> <description> Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host. @@ -201,11 +201,11 @@ </method> <method name="request_raw"> <return type="int" enum="Error" /> - <argument index="0" name="url" type="String" /> - <argument index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" /> - <argument index="2" name="ssl_validate_domain" type="bool" default="true" /> - <argument index="3" name="method" type="int" enum="HTTPClient.Method" default="0" /> - <argument index="4" name="request_data_raw" type="PackedByteArray" default="PackedByteArray()" /> + <param index="0" name="url" type="String" /> + <param index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" /> + <param index="2" name="ssl_validate_domain" type="bool" default="true" /> + <param index="3" name="method" type="int" enum="HTTPClient.Method" default="0" /> + <param index="4" name="request_data_raw" type="PackedByteArray" default="PackedByteArray()" /> <description> Creates request on the underlying [HTTPClient] using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host. @@ -213,8 +213,8 @@ </method> <method name="set_http_proxy"> <return type="void" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="port" type="int" /> + <param index="0" name="host" type="String" /> + <param index="1" name="port" type="int" /> <description> Sets the proxy server for HTTP requests. The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1. @@ -222,8 +222,8 @@ </method> <method name="set_https_proxy"> <return type="void" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="port" type="int" /> + <param index="0" name="host" type="String" /> + <param index="1" name="port" type="int" /> <description> Sets the proxy server for HTTPS requests. The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1. @@ -259,10 +259,10 @@ </members> <signals> <signal name="request_completed"> - <argument index="0" name="result" type="int" /> - <argument index="1" name="response_code" type="int" /> - <argument index="2" name="headers" type="PackedStringArray" /> - <argument index="3" name="body" type="PackedByteArray" /> + <param index="0" name="result" type="int" /> + <param index="1" name="response_code" type="int" /> + <param index="2" name="headers" type="PackedStringArray" /> + <param index="3" name="body" type="PackedByteArray" /> <description> Emitted when a request is completed. </description> diff --git a/doc/classes/HashingContext.xml b/doc/classes/HashingContext.xml index c126efcfbb..ea973043db 100644 --- a/doc/classes/HashingContext.xml +++ b/doc/classes/HashingContext.xml @@ -69,14 +69,14 @@ </method> <method name="start"> <return type="int" enum="Error" /> - <argument index="0" name="type" type="int" enum="HashingContext.HashType" /> + <param index="0" name="type" type="int" enum="HashingContext.HashType" /> <description> Starts a new hash computation of the given [code]type[/code] (e.g. [constant HASH_SHA256] to start computation of a SHA-256). </description> </method> <method name="update"> <return type="int" enum="Error" /> - <argument index="0" name="chunk" type="PackedByteArray" /> + <param index="0" name="chunk" type="PackedByteArray" /> <description> Updates the computation with the given [code]chunk[/code] of data. </description> diff --git a/doc/classes/HingeJoint3D.xml b/doc/classes/HingeJoint3D.xml index eb1d1d5eca..d2547434e7 100644 --- a/doc/classes/HingeJoint3D.xml +++ b/doc/classes/HingeJoint3D.xml @@ -11,30 +11,30 @@ <methods> <method name="get_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="HingeJoint3D.Flag" /> + <param index="0" name="flag" type="int" enum="HingeJoint3D.Flag" /> <description> Returns the value of the specified flag. </description> </method> <method name="get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="HingeJoint3D.Param" /> + <param index="0" name="param" type="int" enum="HingeJoint3D.Param" /> <description> Returns the value of the specified parameter. </description> </method> <method name="set_flag"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="HingeJoint3D.Flag" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="flag" type="int" enum="HingeJoint3D.Flag" /> + <param index="1" name="enabled" type="bool" /> <description> If [code]true[/code], enables the specified flag. </description> </method> <method name="set_param"> <return type="void" /> - <argument index="0" name="param" type="int" enum="HingeJoint3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="HingeJoint3D.Param" /> + <param index="1" name="value" type="float" /> <description> Sets the value of the specified parameter. </description> diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 569f7fe570..63de1f8081 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -11,14 +11,14 @@ <methods> <method name="clear_cache"> <return type="void" /> - <argument index="0" name="hostname" type="String" default="""" /> + <param index="0" name="hostname" type="String" default="""" /> <description> Removes all of a [code]hostname[/code]'s cached references. If no [code]hostname[/code] is given, all cached IP addresses are removed. </description> </method> <method name="erase_resolve_item"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Removes a given item [code]id[/code] from the queue. This should be used to free a queue after it has completed to enable more queries to happen. </description> @@ -46,45 +46,45 @@ </method> <method name="get_resolve_item_address" qualifiers="const"> <return type="String" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns a queued hostname's IP address, given its queue [code]id[/code]. Returns an empty string on error or if resolution hasn't happened yet (see [method get_resolve_item_status]). </description> </method> <method name="get_resolve_item_addresses" qualifiers="const"> <return type="Array" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns resolved addresses, or an empty array if an error happened or resolution didn't happen yet (see [method get_resolve_item_status]). </description> </method> <method name="get_resolve_item_status" qualifiers="const"> <return type="int" enum="IP.ResolverStatus" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns a queued hostname's status as a [enum ResolverStatus] constant, given its queue [code]id[/code]. </description> </method> <method name="resolve_hostname"> <return type="String" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> + <param index="0" name="host" type="String" /> + <param index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> <description> Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the [enum Type] constant given as [code]ip_type[/code]. </description> </method> <method name="resolve_hostname_addresses"> <return type="Array" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> + <param index="0" name="host" type="String" /> + <param index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> <description> Resolves a given hostname in a blocking way. Addresses are returned as an [Array] of IPv4 or IPv6 addresses depending on [code]ip_type[/code]. </description> </method> <method name="resolve_hostname_queue_item"> <return type="int" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> + <param index="0" name="host" type="String" /> + <param index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> <description> Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the [enum Type] constant given as [code]ip_type[/code]. Returns the queue ID if successful, or [constant RESOLVER_INVALID_ID] on error. </description> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 754d1ae68a..94fb8fbb19 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -14,53 +14,53 @@ <methods> <method name="adjust_bcs"> <return type="void" /> - <argument index="0" name="brightness" type="float" /> - <argument index="1" name="contrast" type="float" /> - <argument index="2" name="saturation" type="float" /> + <param index="0" name="brightness" type="float" /> + <param index="1" name="contrast" type="float" /> + <param index="2" name="saturation" type="float" /> <description> </description> </method> <method name="blend_rect"> <return type="void" /> - <argument index="0" name="src" type="Image" /> - <argument index="1" name="src_rect" type="Rect2i" /> - <argument index="2" name="dst" type="Vector2i" /> + <param index="0" name="src" type="Image" /> + <param index="1" name="src_rect" type="Rect2i" /> + <param index="2" name="dst" type="Vector2i" /> <description> Alpha-blends [code]src_rect[/code] from [code]src[/code] image to this image at coordinates [code]dest[/code], clipped accordingly to both image bounds. This image and [code]src[/code] image [b]must[/b] have the same format. [code]src_rect[/code] with not positive size is treated as empty. </description> </method> <method name="blend_rect_mask"> <return type="void" /> - <argument index="0" name="src" type="Image" /> - <argument index="1" name="mask" type="Image" /> - <argument index="2" name="src_rect" type="Rect2i" /> - <argument index="3" name="dst" type="Vector2i" /> + <param index="0" name="src" type="Image" /> + <param index="1" name="mask" type="Image" /> + <param index="2" name="src_rect" type="Rect2i" /> + <param index="3" name="dst" type="Vector2i" /> <description> Alpha-blends [code]src_rect[/code] from [code]src[/code] image to this image using [code]mask[/code] image at coordinates [code]dst[/code], clipped accordingly to both image bounds. Alpha channels are required for both [code]src[/code] and [code]mask[/code]. [code]dst[/code] pixels and [code]src[/code] pixels will blend if the corresponding mask pixel's alpha value is not 0. This image and [code]src[/code] image [b]must[/b] have the same format. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. [code]src_rect[/code] with not positive size is treated as empty. </description> </method> <method name="blit_rect"> <return type="void" /> - <argument index="0" name="src" type="Image" /> - <argument index="1" name="src_rect" type="Rect2i" /> - <argument index="2" name="dst" type="Vector2i" /> + <param index="0" name="src" type="Image" /> + <param index="1" name="src_rect" type="Rect2i" /> + <param index="2" name="dst" type="Vector2i" /> <description> Copies [code]src_rect[/code] from [code]src[/code] image to this image at coordinates [code]dst[/code], clipped accordingly to both image bounds. This image and [code]src[/code] image [b]must[/b] have the same format. [code]src_rect[/code] with not positive size is treated as empty. </description> </method> <method name="blit_rect_mask"> <return type="void" /> - <argument index="0" name="src" type="Image" /> - <argument index="1" name="mask" type="Image" /> - <argument index="2" name="src_rect" type="Rect2i" /> - <argument index="3" name="dst" type="Vector2i" /> + <param index="0" name="src" type="Image" /> + <param index="1" name="mask" type="Image" /> + <param index="2" name="src_rect" type="Rect2i" /> + <param index="3" name="dst" type="Vector2i" /> <description> Blits [code]src_rect[/code] area from [code]src[/code] image to this image at the coordinates given by [code]dst[/code], clipped accordingly to both image bounds. [code]src[/code] pixel is copied onto [code]dst[/code] if the corresponding [code]mask[/code] pixel's alpha value is not 0. This image and [code]src[/code] image [b]must[/b] have the same format. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. [code]src_rect[/code] with not positive size is treated as empty. </description> </method> <method name="bump_map_to_normal_map"> <return type="void" /> - <argument index="0" name="bump_scale" type="float" default="1.0" /> + <param index="0" name="bump_scale" type="float" default="1.0" /> <description> Converts a bump map to a normal map. A bump map provides a height offset per-pixel, while a normal map provides a normal direction per pixel. </description> @@ -73,25 +73,25 @@ </method> <method name="compress"> <return type="int" enum="Error" /> - <argument index="0" name="mode" type="int" enum="Image.CompressMode" /> - <argument index="1" name="source" type="int" enum="Image.CompressSource" default="0" /> - <argument index="2" name="lossy_quality" type="float" default="0.7" /> + <param index="0" name="mode" type="int" enum="Image.CompressMode" /> + <param index="1" name="source" type="int" enum="Image.CompressSource" default="0" /> + <param index="2" name="lossy_quality" type="float" default="0.7" /> <description> Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See [enum CompressMode] and [enum CompressSource] constants. </description> </method> <method name="compress_from_channels"> <return type="int" enum="Error" /> - <argument index="0" name="mode" type="int" enum="Image.CompressMode" /> - <argument index="1" name="channels" type="int" enum="Image.UsedChannels" /> - <argument index="2" name="lossy_quality" type="float" default="0.7" /> + <param index="0" name="mode" type="int" enum="Image.CompressMode" /> + <param index="1" name="channels" type="int" enum="Image.UsedChannels" /> + <param index="2" name="lossy_quality" type="float" default="0.7" /> <description> </description> </method> <method name="compute_image_metrics"> <return type="Dictionary" /> - <argument index="0" name="compared_image" type="Image" /> - <argument index="1" name="use_luma" type="bool" /> + <param index="0" name="compared_image" type="Image" /> + <param index="1" name="use_luma" type="bool" /> <description> Compute image metrics on the current image and the compared image. The dictionary contains [code]max[/code], [code]mean[/code], [code]mean_squared[/code], [code]root_mean_squared[/code] and [code]peak_snr[/code]. @@ -99,43 +99,43 @@ </method> <method name="convert"> <return type="void" /> - <argument index="0" name="format" type="int" enum="Image.Format" /> + <param index="0" name="format" type="int" enum="Image.Format" /> <description> Converts the image's format. See [enum Format] constants. </description> </method> <method name="copy_from"> <return type="void" /> - <argument index="0" name="src" type="Image" /> + <param index="0" name="src" type="Image" /> <description> Copies [code]src[/code] image to this image. </description> </method> <method name="create"> <return type="void" /> - <argument index="0" name="width" type="int" /> - <argument index="1" name="height" type="int" /> - <argument index="2" name="use_mipmaps" type="bool" /> - <argument index="3" name="format" type="int" enum="Image.Format" /> + <param index="0" name="width" type="int" /> + <param index="1" name="height" type="int" /> + <param index="2" name="use_mipmaps" type="bool" /> + <param index="3" name="format" type="int" enum="Image.Format" /> <description> Creates an empty image of given size and format. See [enum Format] constants. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps]. </description> </method> <method name="create_from_data"> <return type="void" /> - <argument index="0" name="width" type="int" /> - <argument index="1" name="height" type="int" /> - <argument index="2" name="use_mipmaps" type="bool" /> - <argument index="3" name="format" type="int" enum="Image.Format" /> - <argument index="4" name="data" type="PackedByteArray" /> + <param index="0" name="width" type="int" /> + <param index="1" name="height" type="int" /> + <param index="2" name="use_mipmaps" type="bool" /> + <param index="3" name="format" type="int" enum="Image.Format" /> + <param index="4" name="data" type="PackedByteArray" /> <description> Creates a new image of given size and format. See [enum Format] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then loads mipmaps for this image from [code]data[/code]. See [method generate_mipmaps]. </description> </method> <method name="crop"> <return type="void" /> - <argument index="0" name="width" type="int" /> - <argument index="1" name="height" type="int" /> + <param index="0" name="width" type="int" /> + <param index="1" name="height" type="int" /> <description> Crops the image to the given [code]width[/code] and [code]height[/code]. If the specified size is larger than the current size, the extra area is filled with black pixels. </description> @@ -155,21 +155,21 @@ </method> <method name="detect_used_channels" qualifiers="const"> <return type="int" enum="Image.UsedChannels" /> - <argument index="0" name="source" type="int" enum="Image.CompressSource" default="0" /> + <param index="0" name="source" type="int" enum="Image.CompressSource" default="0" /> <description> </description> </method> <method name="fill"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Fills the image with [code]color[/code]. </description> </method> <method name="fill_rect"> <return type="void" /> - <argument index="0" name="rect" type="Rect2i" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="rect" type="Rect2i" /> + <param index="1" name="color" type="Color" /> <description> Fills [code]rect[/code] with [code]color[/code]. </description> @@ -194,7 +194,7 @@ </method> <method name="generate_mipmaps"> <return type="int" enum="Error" /> - <argument index="0" name="renormalize" type="bool" default="false" /> + <param index="0" name="renormalize" type="bool" default="false" /> <description> Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is [code]0[/code]. [b]Note:[/b] Mipmap generation is done on the CPU, is single-threaded and is [i]always[/i] done on the main thread. This means generating mipmaps will result in noticeable stuttering during gameplay, even if [method generate_mipmaps] is called from a [Thread]. @@ -220,15 +220,15 @@ </method> <method name="get_mipmap_offset" qualifiers="const"> <return type="int" /> - <argument index="0" name="mipmap" type="int" /> + <param index="0" name="mipmap" type="int" /> <description> Returns the offset where the image's mipmap with index [code]mipmap[/code] is stored in the [code]data[/code] dictionary. </description> </method> <method name="get_pixel" qualifiers="const"> <return type="Color" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> <description> Returns the color of the pixel at [code](x, y)[/code]. This is the same as [method get_pixelv], but with two integer arguments instead of a [Vector2i] argument. @@ -236,7 +236,7 @@ </method> <method name="get_pixelv" qualifiers="const"> <return type="Color" /> - <argument index="0" name="point" type="Vector2i" /> + <param index="0" name="point" type="Vector2i" /> <description> Returns the color of the pixel at [code]point[/code]. This is the same as [method get_pixel], but with a [Vector2i] argument instead of two integer arguments. @@ -244,7 +244,7 @@ </method> <method name="get_rect" qualifiers="const"> <return type="Image" /> - <argument index="0" name="rect" type="Rect2i" /> + <param index="0" name="rect" type="Rect2i" /> <description> Returns a new image that is a copy of the image's area specified with [code]rect[/code]. </description> @@ -293,7 +293,7 @@ </method> <method name="load"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Loads an image from file [code]path[/code]. See [url=$DOCS_URL/tutorials/assets_pipeline/importing_images.html#supported-image-formats]Supported image formats[/url] for a list of supported image formats and limitations. [b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external images at run-time, such as images located at the [code]user://[/code] directory, and may not work in exported projects. @@ -302,7 +302,7 @@ </method> <method name="load_bmp_from_buffer"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Loads an image from the binary contents of a BMP file. [b]Note:[/b] Godot's BMP module doesn't support 16-bit per pixel images. Only 1-bit, 4-bit, 8-bit, 24-bit, and 32-bit per pixel images are supported. @@ -310,35 +310,35 @@ </method> <method name="load_from_file" qualifiers="static"> <return type="Image" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Creates a new [Image] and loads data from the specified file. </description> </method> <method name="load_jpg_from_buffer"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Loads an image from the binary contents of a JPEG file. </description> </method> <method name="load_png_from_buffer"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Loads an image from the binary contents of a PNG file. </description> </method> <method name="load_tga_from_buffer"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Loads an image from the binary contents of a TGA file. </description> </method> <method name="load_webp_from_buffer"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Loads an image from the binary contents of a WebP file. </description> @@ -357,17 +357,17 @@ </method> <method name="resize"> <return type="void" /> - <argument index="0" name="width" type="int" /> - <argument index="1" name="height" type="int" /> - <argument index="2" name="interpolation" type="int" enum="Image.Interpolation" default="1" /> + <param index="0" name="width" type="int" /> + <param index="1" name="height" type="int" /> + <param index="2" name="interpolation" type="int" enum="Image.Interpolation" default="1" /> <description> Resizes the image to the given [code]width[/code] and [code]height[/code]. New pixels are calculated using the [code]interpolation[/code] mode defined via [enum Interpolation] constants. </description> </method> <method name="resize_to_po2"> <return type="void" /> - <argument index="0" name="square" type="bool" default="false" /> - <argument index="1" name="interpolation" type="int" enum="Image.Interpolation" default="1" /> + <param index="0" name="square" type="bool" default="false" /> + <param index="1" name="interpolation" type="int" enum="Image.Interpolation" default="1" /> <description> Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same. New pixels are calculated using the [code]interpolation[/code] mode defined via [enum Interpolation] constants. </description> @@ -386,15 +386,15 @@ </method> <method name="rotate_90"> <return type="void" /> - <argument index="0" name="direction" type="int" enum="ClockDirection" /> + <param index="0" name="direction" type="int" enum="ClockDirection" /> <description> Rotates the image in the specified [code]direction[/code] by [code]90[/code] degrees. The width and height of the image must be greater than [code]1[/code]. If the width and height are not equal, the image will be resized. </description> </method> <method name="save_exr" qualifiers="const"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="grayscale" type="bool" default="false" /> + <param index="0" name="path" type="String" /> + <param index="1" name="grayscale" type="bool" default="false" /> <description> Saves the image as an EXR file to [code]path[/code]. If [code]grayscale[/code] is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. [b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return [constant ERR_UNAVAILABLE] when it is called from an exported project. @@ -402,7 +402,7 @@ </method> <method name="save_exr_to_buffer" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="grayscale" type="bool" default="false" /> + <param index="0" name="grayscale" type="bool" default="false" /> <description> Saves the image as an EXR file to a byte array. If [code]grayscale[/code] is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module. [b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return an empty byte array when it is called from an exported project. @@ -410,8 +410,8 @@ </method> <method name="save_jpg" qualifiers="const"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="quality" type="float" default="0.75" /> + <param index="0" name="path" type="String" /> + <param index="1" name="quality" type="float" default="0.75" /> <description> Saves the image as a JPEG file to [code]path[/code] with the specified [code]quality[/code] between [code]0.01[/code] and [code]1.0[/code] (inclusive). Higher [code]quality[/code] values result in better-looking output at the cost of larger file sizes. Recommended [code]quality[/code] values are between [code]0.75[/code] and [code]0.90[/code]. Even at quality [code]1.00[/code], JPEG compression remains lossy. [b]Note:[/b] JPEG does not save an alpha channel. If the [Image] contains an alpha channel, the image will still be saved, but the resulting JPEG file won't contain the alpha channel. @@ -419,7 +419,7 @@ </method> <method name="save_jpg_to_buffer" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="quality" type="float" default="0.75" /> + <param index="0" name="quality" type="float" default="0.75" /> <description> Saves the image as a JPEG file to a byte array with the specified [code]quality[/code] between [code]0.01[/code] and [code]1.0[/code] (inclusive). Higher [code]quality[/code] values result in better-looking output at the cost of larger byte array sizes (and therefore memory usage). Recommended [code]quality[/code] values are between [code]0.75[/code] and [code]0.90[/code]. Even at quality [code]1.00[/code], JPEG compression remains lossy. [b]Note:[/b] JPEG does not save an alpha channel. If the [Image] contains an alpha channel, the image will still be saved, but the resulting byte array won't contain the alpha channel. @@ -427,7 +427,7 @@ </method> <method name="save_png" qualifiers="const"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Saves the image as a PNG file to the file at [code]path[/code]. </description> @@ -440,26 +440,26 @@ </method> <method name="save_webp" qualifiers="const"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="lossy" type="bool" default="false" /> - <argument index="2" name="quality" type="float" default="0.75" /> + <param index="0" name="path" type="String" /> + <param index="1" name="lossy" type="bool" default="false" /> + <param index="2" name="quality" type="float" default="0.75" /> <description> Saves the image as a WebP (Web Picture) file to the file at [code]path[/code]. By default it will save lossless. If [code]lossy[/code] is true, the image will be saved lossy, using the [code]quality[/code] setting between 0.0 and 1.0 (inclusive). </description> </method> <method name="save_webp_to_buffer" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="lossy" type="bool" default="false" /> - <argument index="1" name="quality" type="float" default="0.75" /> + <param index="0" name="lossy" type="bool" default="false" /> + <param index="1" name="quality" type="float" default="0.75" /> <description> Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If [code]lossy[/code] is true, the image will be saved lossy, using the [code]quality[/code] setting between 0.0 and 1.0 (inclusive). </description> </method> <method name="set_pixel"> <return type="void" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> - <argument index="2" name="color" type="Color" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> + <param index="2" name="color" type="Color" /> <description> Sets the [Color] of the pixel at [code](x, y)[/code] to [code]color[/code]. Example: [codeblocks] @@ -485,8 +485,8 @@ </method> <method name="set_pixelv"> <return type="void" /> - <argument index="0" name="point" type="Vector2i" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="point" type="Vector2i" /> + <param index="1" name="color" type="Color" /> <description> Sets the [Color] of the pixel at [code]point[/code] to [code]color[/code]. Example: [codeblocks] diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 084bf7e809..c750b540a4 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -31,7 +31,7 @@ <methods> <method name="create_from_image" qualifiers="static"> <return type="ImageTexture" /> - <argument index="0" name="image" type="Image" /> + <param index="0" name="image" type="Image" /> <description> Creates a new [ImageTexture] and initializes it by allocating and setting the data from an [Image]. </description> @@ -44,7 +44,7 @@ </method> <method name="set_image"> <return type="void" /> - <argument index="0" name="image" type="Image" /> + <param index="0" name="image" type="Image" /> <description> Replaces the texture's data with a new [Image]. This will re-allocate new memory for the texture. If you want to update the image, but don't need to change its parameters (format, size), use [method update] instead for better performance. @@ -52,14 +52,14 @@ </method> <method name="set_size_override"> <return type="void" /> - <argument index="0" name="size" type="Vector2i" /> + <param index="0" name="size" type="Vector2i" /> <description> Resizes the texture to the specified dimensions. </description> </method> <method name="update"> <return type="void" /> - <argument index="0" name="image" type="Image" /> + <param index="0" name="image" type="Image" /> <description> Replaces the texture's data with a new [Image]. [b]Note:[/b] The texture has to be created using [method create_from_image] or initialized first with the [method set_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration. diff --git a/doc/classes/ImageTexture3D.xml b/doc/classes/ImageTexture3D.xml index b2068504eb..958c5f90f1 100644 --- a/doc/classes/ImageTexture3D.xml +++ b/doc/classes/ImageTexture3D.xml @@ -9,18 +9,18 @@ <methods> <method name="create"> <return type="int" enum="Error" /> - <argument index="0" name="format" type="int" enum="Image.Format" /> - <argument index="1" name="width" type="int" /> - <argument index="2" name="height" type="int" /> - <argument index="3" name="depth" type="int" /> - <argument index="4" name="use_mipmaps" type="bool" /> - <argument index="5" name="data" type="Image[]" /> + <param index="0" name="format" type="int" enum="Image.Format" /> + <param index="1" name="width" type="int" /> + <param index="2" name="height" type="int" /> + <param index="3" name="depth" type="int" /> + <param index="4" name="use_mipmaps" type="bool" /> + <param index="5" name="data" type="Image[]" /> <description> </description> </method> <method name="update"> <return type="void" /> - <argument index="0" name="data" type="Image[]" /> + <param index="0" name="data" type="Image[]" /> <description> </description> </method> diff --git a/doc/classes/ImageTextureLayered.xml b/doc/classes/ImageTextureLayered.xml index c574e5c9c1..c0ad19ddd7 100644 --- a/doc/classes/ImageTextureLayered.xml +++ b/doc/classes/ImageTextureLayered.xml @@ -9,14 +9,14 @@ <methods> <method name="create_from_images"> <return type="int" enum="Error" /> - <argument index="0" name="images" type="Array" /> + <param index="0" name="images" type="Array" /> <description> </description> </method> <method name="update_layer"> <return type="void" /> - <argument index="0" name="image" type="Image" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="image" type="Image" /> + <param index="1" name="layer" type="int" /> <description> </description> </method> diff --git a/doc/classes/ImmediateMesh.xml b/doc/classes/ImmediateMesh.xml index d12d5de184..a6d2e3e249 100644 --- a/doc/classes/ImmediateMesh.xml +++ b/doc/classes/ImmediateMesh.xml @@ -17,22 +17,22 @@ </method> <method name="surface_add_vertex"> <return type="void" /> - <argument index="0" name="vertex" type="Vector3" /> + <param index="0" name="vertex" type="Vector3" /> <description> Add a 3D vertex using the current attributes previously set. </description> </method> <method name="surface_add_vertex_2d"> <return type="void" /> - <argument index="0" name="vertex" type="Vector2" /> + <param index="0" name="vertex" type="Vector2" /> <description> Add a 2D vertex using the current attributes previously set. </description> </method> <method name="surface_begin"> <return type="void" /> - <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" /> - <argument index="1" name="material" type="Material" default="null" /> + <param index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" /> + <param index="1" name="material" type="Material" default="null" /> <description> Begin a new surface. </description> @@ -45,35 +45,35 @@ </method> <method name="surface_set_color"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Set the color attribute that will be pushed with the next vertex. </description> </method> <method name="surface_set_normal"> <return type="void" /> - <argument index="0" name="normal" type="Vector3" /> + <param index="0" name="normal" type="Vector3" /> <description> Set the normal attribute that will be pushed with the next vertex. </description> </method> <method name="surface_set_tangent"> <return type="void" /> - <argument index="0" name="tangent" type="Plane" /> + <param index="0" name="tangent" type="Plane" /> <description> Set the tangent attribute that will be pushed with the next vertex. </description> </method> <method name="surface_set_uv"> <return type="void" /> - <argument index="0" name="uv" type="Vector2" /> + <param index="0" name="uv" type="Vector2" /> <description> Set the UV attribute that will be pushed with the next vertex. </description> </method> <method name="surface_set_uv2"> <return type="void" /> - <argument index="0" name="uv2" type="Vector2" /> + <param index="0" name="uv2" type="Vector2" /> <description> Set the UV2 attribute that will be pushed with the next vertex. </description> diff --git a/doc/classes/ImporterMesh.xml b/doc/classes/ImporterMesh.xml index 201c0ddd38..8afa35d1b4 100644 --- a/doc/classes/ImporterMesh.xml +++ b/doc/classes/ImporterMesh.xml @@ -13,20 +13,20 @@ <methods> <method name="add_blend_shape"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Adds name for a blend shape that will be added with [method add_surface]. Must be called before surface is added. </description> </method> <method name="add_surface"> <return type="void" /> - <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" /> - <argument index="1" name="arrays" type="Array" /> - <argument index="2" name="blend_shapes" type="Array" default="[]" /> - <argument index="3" name="lods" type="Dictionary" default="{}" /> - <argument index="4" name="material" type="Material" default="null" /> - <argument index="5" name="name" type="String" default="""" /> - <argument index="6" name="flags" type="int" default="0" /> + <param index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" /> + <param index="1" name="arrays" type="Array" /> + <param index="2" name="blend_shapes" type="Array" default="[]" /> + <param index="3" name="lods" type="Dictionary" default="{}" /> + <param index="4" name="material" type="Material" default="null" /> + <param index="5" name="name" type="String" default="""" /> + <param index="6" name="flags" type="int" default="0" /> <description> Creates a new surface, analogous to [method ArrayMesh.add_surface_from_arrays]. Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. @@ -41,8 +41,8 @@ </method> <method name="generate_lods"> <return type="void" /> - <argument index="0" name="normal_merge_angle" type="float" /> - <argument index="1" name="normal_split_angle" type="float" /> + <param index="0" name="normal_merge_angle" type="float" /> + <param index="1" name="normal_split_angle" type="float" /> <description> Generates all lods for this ImporterMesh. [code]normal_merge_angle[/code] and [code]normal_split_angle[/code] are in degrees and used in the same way as the importer settings in [code]lods[/code]. As a good default, use 25 and 60 respectively. @@ -63,7 +63,7 @@ </method> <method name="get_blend_shape_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="blend_shape_idx" type="int" /> + <param index="0" name="blend_shape_idx" type="int" /> <description> Returns the name of the blend shape at this index. </description> @@ -76,7 +76,7 @@ </method> <method name="get_mesh"> <return type="ArrayMesh" /> - <argument index="0" name="base_mesh" type="ArrayMesh" default="null" /> + <param index="0" name="base_mesh" type="ArrayMesh" default="null" /> <description> Returns the mesh data represented by this [ImporterMesh] as a usable [ArrayMesh]. This method caches the returned mesh, and subsequent calls will return the cached data until [method clear] is called. @@ -85,15 +85,15 @@ </method> <method name="get_surface_arrays" qualifiers="const"> <return type="Array" /> - <argument index="0" name="surface_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> <description> Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface. See [method add_surface]. </description> </method> <method name="get_surface_blend_shape_arrays" qualifiers="const"> <return type="Array" /> - <argument index="0" name="surface_idx" type="int" /> - <argument index="1" name="blend_shape_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> + <param index="1" name="blend_shape_idx" type="int" /> <description> Returns a single set of blend shape arrays for the requested blend shape index for a surface. </description> @@ -106,81 +106,81 @@ </method> <method name="get_surface_format" qualifiers="const"> <return type="int" /> - <argument index="0" name="surface_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> <description> Returns the format of the surface that the mesh holds. </description> </method> <method name="get_surface_lod_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="surface_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> <description> Returns the amount of lods that the mesh holds on a given surface. </description> </method> <method name="get_surface_lod_indices" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="surface_idx" type="int" /> - <argument index="1" name="lod_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> + <param index="1" name="lod_idx" type="int" /> <description> Returns the index buffer of a lod for a surface. </description> </method> <method name="get_surface_lod_size" qualifiers="const"> <return type="float" /> - <argument index="0" name="surface_idx" type="int" /> - <argument index="1" name="lod_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> + <param index="1" name="lod_idx" type="int" /> <description> Returns the screen ratio which activates a lod for a surface. </description> </method> <method name="get_surface_material" qualifiers="const"> <return type="Material" /> - <argument index="0" name="surface_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> <description> Returns a [Material] in a given surface. Surface is rendered using this material. </description> </method> <method name="get_surface_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="surface_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> <description> Gets the name assigned to this surface. </description> </method> <method name="get_surface_primitive_type"> <return type="int" enum="Mesh.PrimitiveType" /> - <argument index="0" name="surface_idx" type="int" /> + <param index="0" name="surface_idx" type="int" /> <description> Returns the primitive type of the requested surface (see [method add_surface]). </description> </method> <method name="set_blend_shape_mode"> <return type="void" /> - <argument index="0" name="mode" type="int" enum="Mesh.BlendShapeMode" /> + <param index="0" name="mode" type="int" enum="Mesh.BlendShapeMode" /> <description> Sets the blend shape mode to one of [enum Mesh.BlendShapeMode]. </description> </method> <method name="set_lightmap_size_hint"> <return type="void" /> - <argument index="0" name="size" type="Vector2i" /> + <param index="0" name="size" type="Vector2i" /> <description> Sets the size hint of this mesh for lightmap-unwrapping in UV-space. </description> </method> <method name="set_surface_material"> <return type="void" /> - <argument index="0" name="surface_idx" type="int" /> - <argument index="1" name="material" type="Material" /> + <param index="0" name="surface_idx" type="int" /> + <param index="1" name="material" type="Material" /> <description> Sets a [Material] for a given surface. Surface will be rendered using this material. </description> </method> <method name="set_surface_name"> <return type="void" /> - <argument index="0" name="surface_idx" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="surface_idx" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets a name for a given surface. </description> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 796a80873f..d4e2923610 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -14,8 +14,8 @@ <methods> <method name="action_press"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="strength" type="float" default="1.0" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="strength" type="float" default="1.0" /> <description> This will simulate pressing the specified action. The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action. @@ -24,15 +24,15 @@ </method> <method name="action_release"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> If the specified action is already pressed, this will release it. </description> </method> <method name="add_joy_mapping"> <return type="void" /> - <argument index="0" name="mapping" type="String" /> - <argument index="1" name="update_existing" type="bool" default="false" /> + <param index="0" name="mapping" type="String" /> + <param index="1" name="update_existing" type="bool" default="false" /> <description> Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. </description> @@ -54,8 +54,8 @@ </method> <method name="get_action_raw_strength" qualifiers="const"> <return type="float" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="exact_match" type="bool" default="false" /> <description> Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use [method get_action_strength] instead. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -63,8 +63,8 @@ </method> <method name="get_action_strength" qualifiers="const"> <return type="float" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="exact_match" type="bool" default="false" /> <description> Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -72,8 +72,8 @@ </method> <method name="get_axis" qualifiers="const"> <return type="float" /> - <argument index="0" name="negative_action" type="StringName" /> - <argument index="1" name="positive_action" type="StringName" /> + <param index="0" name="negative_action" type="StringName" /> + <param index="1" name="positive_action" type="StringName" /> <description> Get axis input by specifying two actions, one negative and one positive. This is a shorthand for writing [code]Input.get_action_strength("positive_action") - Input.get_action_strength("negative_action")[/code]. @@ -107,36 +107,36 @@ </method> <method name="get_joy_axis" qualifiers="const"> <return type="float" /> - <argument index="0" name="device" type="int" /> - <argument index="1" name="axis" type="int" enum="JoyAxis" /> + <param index="0" name="device" type="int" /> + <param index="1" name="axis" type="int" enum="JoyAxis" /> <description> Returns the current value of the joypad axis at given index (see [enum JoyAxis]). </description> </method> <method name="get_joy_guid" qualifiers="const"> <return type="String" /> - <argument index="0" name="device" type="int" /> + <param index="0" name="device" type="int" /> <description> Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. Returns [code]"Default Gamepad"[/code] otherwise. </description> </method> <method name="get_joy_name"> <return type="String" /> - <argument index="0" name="device" type="int" /> + <param index="0" name="device" type="int" /> <description> Returns the name of the joypad at the specified device index. </description> </method> <method name="get_joy_vibration_duration"> <return type="float" /> - <argument index="0" name="device" type="int" /> + <param index="0" name="device" type="int" /> <description> Returns the duration of the current vibration effect in seconds. </description> </method> <method name="get_joy_vibration_strength"> <return type="Vector2" /> - <argument index="0" name="device" type="int" /> + <param index="0" name="device" type="int" /> <description> Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. </description> @@ -162,11 +162,11 @@ </method> <method name="get_vector" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="negative_x" type="StringName" /> - <argument index="1" name="positive_x" type="StringName" /> - <argument index="2" name="negative_y" type="StringName" /> - <argument index="3" name="positive_y" type="StringName" /> - <argument index="4" name="deadzone" type="float" default="-1.0" /> + <param index="0" name="negative_x" type="StringName" /> + <param index="1" name="positive_x" type="StringName" /> + <param index="2" name="negative_y" type="StringName" /> + <param index="3" name="positive_y" type="StringName" /> + <param index="4" name="deadzone" type="float" default="-1.0" /> <description> Gets an input vector by specifying four actions for the positive and negative X and Y axes. This method is useful when getting vector input, such as from a joystick, directional pad, arrows, or WASD. The vector has its length limited to 1 and has a circular deadzone, which is useful for using vector input as movement. @@ -175,8 +175,8 @@ </method> <method name="is_action_just_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] when the user starts pressing the action event, meaning it's [code]true[/code] only on the frame that the user pressed down the button. This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. @@ -186,8 +186,8 @@ </method> <method name="is_action_just_released" qualifiers="const"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] when the user stops pressing the action event, meaning it's [code]true[/code] only on the frame that the user released the button. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -195,8 +195,8 @@ </method> <method name="is_action_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -211,22 +211,22 @@ </method> <method name="is_joy_button_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="device" type="int" /> - <argument index="1" name="button" type="int" enum="JoyButton" /> + <param index="0" name="device" type="int" /> + <param index="1" name="button" type="int" enum="JoyButton" /> <description> Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButton]). </description> </method> <method name="is_joy_known"> <return type="bool" /> - <argument index="0" name="device" type="int" /> + <param index="0" name="device" type="int" /> <description> Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices. Unknown joypads are not expected to match these constants, but you can still retrieve events from them. </description> </method> <method name="is_key_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="keycode" type="int" enum="Key" /> + <param index="0" name="keycode" type="int" enum="Key" /> <description> Returns [code]true[/code] if you are pressing the key in the current keyboard layout. You can pass a [enum Key] constant. [method is_key_pressed] is only recommended over [method is_physical_key_pressed] in non-game applications. This ensures that shortcut keys behave as expected depending on the user's keyboard layout, as keyboard shortcuts are generally dependent on the keyboard layout in non-game applications. If in doubt, use [method is_physical_key_pressed]. @@ -235,14 +235,14 @@ </method> <method name="is_mouse_button_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="button" type="int" enum="MouseButton" /> + <param index="0" name="button" type="int" enum="MouseButton" /> <description> Returns [code]true[/code] if you are pressing the mouse button specified with [enum MouseButton]. </description> </method> <method name="is_physical_key_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="keycode" type="int" enum="Key" /> + <param index="0" name="keycode" type="int" enum="Key" /> <description> Returns [code]true[/code] if you are pressing the key in the physical location on the 101/102-key US QWERTY keyboard. You can pass a [enum Key] constant. [method is_physical_key_pressed] is recommended over [method is_key_pressed] for in-game actions, as it will make [kbd]W[/kbd]/[kbd]A[/kbd]/[kbd]S[/kbd]/[kbd]D[/kbd] layouts work regardless of the user's keyboard layout. [method is_physical_key_pressed] will also ensure that the top row number keys work on any keyboard layout. If in doubt, use [method is_physical_key_pressed]. @@ -251,7 +251,7 @@ </method> <method name="parse_input_event"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. Also generates [method Node._input] calls. Example: @@ -273,14 +273,14 @@ </method> <method name="remove_joy_mapping"> <return type="void" /> - <argument index="0" name="guid" type="String" /> + <param index="0" name="guid" type="String" /> <description> Removes all mappings from the internal database that match the given GUID. </description> </method> <method name="set_accelerometer"> <return type="void" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Sets the acceleration value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. @@ -288,9 +288,9 @@ </method> <method name="set_custom_mouse_cursor"> <return type="void" /> - <argument index="0" name="image" type="Resource" /> - <argument index="1" name="shape" type="int" enum="Input.CursorShape" default="0" /> - <argument index="2" name="hotspot" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="image" type="Resource" /> + <param index="1" name="shape" type="int" enum="Input.CursorShape" default="0" /> + <param index="2" name="hotspot" type="Vector2" default="Vector2(0, 0)" /> <description> Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See [enum CursorShape] for the list of shapes. [code]image[/code]'s size must be lower than 256×256. @@ -301,7 +301,7 @@ </method> <method name="set_default_cursor_shape"> <return type="void" /> - <argument index="0" name="shape" type="int" enum="Input.CursorShape" default="0" /> + <param index="0" name="shape" type="int" enum="Input.CursorShape" default="0" /> <description> Sets the default cursor shape to be used in the viewport instead of [constant CURSOR_ARROW]. [b]Note:[/b] If you want to change the default cursor shape for [Control]'s nodes, use [member Control.mouse_default_cursor_shape] instead. @@ -310,7 +310,7 @@ </method> <method name="set_gravity"> <return type="void" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Sets the gravity value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. @@ -318,7 +318,7 @@ </method> <method name="set_gyroscope"> <return type="void" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Sets the value of the rotation rate of the gyroscope sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. @@ -326,7 +326,7 @@ </method> <method name="set_magnetometer"> <return type="void" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Sets the value of the magnetic field of the magnetometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. @@ -334,10 +334,10 @@ </method> <method name="start_joy_vibration"> <return type="void" /> - <argument index="0" name="device" type="int" /> - <argument index="1" name="weak_magnitude" type="float" /> - <argument index="2" name="strong_magnitude" type="float" /> - <argument index="3" name="duration" type="float" default="0" /> + <param index="0" name="device" type="int" /> + <param index="1" name="weak_magnitude" type="float" /> + <param index="2" name="strong_magnitude" type="float" /> + <param index="3" name="duration" type="float" default="0" /> <description> Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. [code]weak_magnitude[/code] is the strength of the weak motor (between 0 and 1) and [code]strong_magnitude[/code] is the strength of the strong motor (between 0 and 1). [code]duration[/code] is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). [b]Note:[/b] Not every hardware is compatible with long effect durations; it is recommended to restart an effect if it has to be played for more than a few seconds. @@ -345,14 +345,14 @@ </method> <method name="stop_joy_vibration"> <return type="void" /> - <argument index="0" name="device" type="int" /> + <param index="0" name="device" type="int" /> <description> Stops the vibration of the joypad. </description> </method> <method name="vibrate_handheld"> <return type="void" /> - <argument index="0" name="duration_ms" type="int" default="500" /> + <param index="0" name="duration_ms" type="int" default="500" /> <description> Vibrate handheld devices. [b]Note:[/b] This method is implemented on Android, iOS, and HTML5. @@ -363,7 +363,7 @@ </method> <method name="warp_mouse"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Sets the mouse position to the specified vector, provided in pixels and relative to an origin at the upper left corner of the currently focused Window Manager game window. Mouse position is clipped to the limits of the screen resolution, or to the limits of the game window if [enum MouseMode] is set to [code]MOUSE_MODE_CONFINED[/code] or [code]MOUSE_MODE_CONFINED_HIDDEN[/code]. @@ -382,8 +382,8 @@ </members> <signals> <signal name="joy_connection_changed"> - <argument index="0" name="device" type="int" /> - <argument index="1" name="connected" type="bool" /> + <param index="0" name="device" type="int" /> + <param index="1" name="connected" type="bool" /> <description> Emitted when a joypad device has been connected or disconnected. </description> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 230ad04b33..71e94cf1a2 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -15,7 +15,7 @@ <methods> <method name="accumulate"> <return type="bool" /> - <argument index="0" name="with_event" type="InputEvent" /> + <param index="0" name="with_event" type="InputEvent" /> <description> Returns [code]true[/code] if the given input event and this input event can be added together (only for events of type [InputEventMouseMotion]). The given input event's position, global position and speed will be copied. The resulting [code]relative[/code] is a sum of both events. Both events' modifiers have to be identical. @@ -29,8 +29,8 @@ </method> <method name="get_action_strength" qualifiers="const"> <return type="float" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="exact_match" type="bool" default="false" /> <description> Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion]. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -38,8 +38,8 @@ </method> <method name="is_action" qualifiers="const"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if this input event matches a pre-defined action of any type. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -47,9 +47,9 @@ </method> <method name="is_action_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="allow_echo" type="bool" default="false" /> - <argument index="2" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="allow_echo" type="bool" default="false" /> + <param index="2" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -58,8 +58,8 @@ </method> <method name="is_action_released" qualifiers="const"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="exact_match" type="bool" default="false" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -79,8 +79,8 @@ </method> <method name="is_match" qualifiers="const"> <return type="bool" /> - <argument index="0" name="event" type="InputEvent" /> - <argument index="1" name="exact_match" type="bool" default="true" /> + <param index="0" name="event" type="InputEvent" /> + <param index="1" name="exact_match" type="bool" default="true" /> <description> Returns [code]true[/code] if the specified [code]event[/code] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -95,8 +95,8 @@ </method> <method name="xformed_by" qualifiers="const"> <return type="InputEvent" /> - <argument index="0" name="xform" type="Transform2D" /> - <argument index="1" name="local_ofs" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="xform" type="Transform2D" /> + <param index="1" name="local_ofs" type="Vector2" default="Vector2(0, 0)" /> <description> Returns a copy of the given input event which has been offset by [code]local_ofs[/code] and transformed by [code]xform[/code]. Relevant for events of type [InputEventMouseButton], [InputEventMouseMotion], [InputEventScreenTouch], [InputEventScreenDrag], [InputEventMagnifyGesture] and [InputEventPanGesture]. </description> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index eb708432b4..8a58519a2b 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -12,37 +12,37 @@ <methods> <method name="action_add_event"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="event" type="InputEvent" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="event" type="InputEvent" /> <description> Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. </description> </method> <method name="action_erase_event"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="event" type="InputEvent" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="event" type="InputEvent" /> <description> Removes an [InputEvent] from an action. </description> </method> <method name="action_erase_events"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Removes all events from an action. </description> </method> <method name="action_get_deadzone"> <return type="float" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Returns a deadzone value for the action. </description> </method> <method name="action_get_events"> <return type="Array" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Returns an array of [InputEvent]s associated with a given action. [b]Note:[/b] When used in the editor (e.g. a tool script or [EditorPlugin]), this method will return events for the editor action. If you want to access your project's input binds from the editor, read the [code]input/*[/code] settings from [ProjectSettings]. @@ -50,24 +50,24 @@ </method> <method name="action_has_event"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="event" type="InputEvent" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="event" type="InputEvent" /> <description> Returns [code]true[/code] if the action has the given [InputEvent] associated with it. </description> </method> <method name="action_set_deadzone"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="deadzone" type="float" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="deadzone" type="float" /> <description> Sets a deadzone value for the action. </description> </method> <method name="add_action"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="deadzone" type="float" default="0.5" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="deadzone" type="float" default="0.5" /> <description> Adds an empty action to the [InputMap] with a configurable [code]deadzone[/code]. An [InputEvent] can then be added to this action with [method action_add_event]. @@ -75,16 +75,16 @@ </method> <method name="erase_action"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Removes an action from the [InputMap]. </description> </method> <method name="event_is_action" qualifiers="const"> <return type="bool" /> - <argument index="0" name="event" type="InputEvent" /> - <argument index="1" name="action" type="StringName" /> - <argument index="2" name="exact_match" type="bool" default="false" /> + <param index="0" name="event" type="InputEvent" /> + <param index="1" name="action" type="StringName" /> + <param index="2" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -98,7 +98,7 @@ </method> <method name="has_action" qualifiers="const"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Returns [code]true[/code] if the [InputMap] has a registered action with the given name. </description> diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml index d22028d478..f6d9c835d1 100644 --- a/doc/classes/InstancePlaceholder.xml +++ b/doc/classes/InstancePlaceholder.xml @@ -12,8 +12,8 @@ <methods> <method name="create_instance"> <return type="Node" /> - <argument index="0" name="replace" type="bool" default="false" /> - <argument index="1" name="custom_scene" type="PackedScene" default="null" /> + <param index="0" name="replace" type="bool" default="false" /> + <param index="1" name="custom_scene" type="PackedScene" default="null" /> <description> Not thread-safe. Use [method Object.call_deferred] if calling from a thread. </description> @@ -26,7 +26,7 @@ </method> <method name="get_stored_values"> <return type="Dictionary" /> - <argument index="0" name="with_order" type="bool" default="false" /> + <param index="0" name="with_order" type="bool" default="false" /> <description> </description> </method> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 97ee946acd..3375e5a758 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -15,17 +15,17 @@ <methods> <method name="add_icon_item"> <return type="int" /> - <argument index="0" name="icon" type="Texture2D" /> - <argument index="1" name="selectable" type="bool" default="true" /> + <param index="0" name="icon" type="Texture2D" /> + <param index="1" name="selectable" type="bool" default="true" /> <description> Adds an item to the item list with no text, only an icon. Returns the index of an added item. </description> </method> <method name="add_item"> <return type="int" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="icon" type="Texture2D" default="null" /> - <argument index="2" name="selectable" type="bool" default="true" /> + <param index="0" name="text" type="String" /> + <param index="1" name="icon" type="Texture2D" default="null" /> + <param index="2" name="selectable" type="bool" default="true" /> <description> Adds an item to the item list with specified text. Returns the index of an added item. Specify an [code]icon[/code], or use [code]null[/code] as the [code]icon[/code] for a list item with no icon. @@ -40,7 +40,7 @@ </method> <method name="deselect"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Ensures the item associated with the specified index is not selected. </description> @@ -59,8 +59,8 @@ </method> <method name="get_item_at_position" qualifiers="const"> <return type="int" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="exact" type="bool" default="false" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="exact" type="bool" default="false" /> <description> Returns the item index at the given [code]position[/code]. When there is no item at that point, -1 will be returned if [code]exact[/code] is [code]true[/code], and the closest item index will be returned otherwise. @@ -68,70 +68,70 @@ </method> <method name="get_item_custom_bg_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the custom background color of the item specified by [code]idx[/code] index. </description> </method> <method name="get_item_custom_fg_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the custom foreground color of the item specified by [code]idx[/code] index. </description> </method> <method name="get_item_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the icon associated with the specified index. </description> </method> <method name="get_item_icon_modulate" qualifiers="const"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns a [Color] modulating item's icon at the specified index. </description> </method> <method name="get_item_icon_region" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the region of item's icon used. The whole icon will be used if the region has no area. </description> </method> <method name="get_item_language" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns item's text language code. </description> </method> <method name="get_item_metadata" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the metadata value of the specified index. </description> </method> <method name="get_item_text" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the text associated with the specified index. </description> </method> <method name="get_item_text_direction" qualifiers="const"> <return type="int" enum="Control.TextDirection" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns item's text base writing direction. </description> </method> <method name="get_item_tooltip" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the tooltip hint associated with the specified index. </description> @@ -157,58 +157,58 @@ </method> <method name="is_item_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if the item at the specified index is disabled. </description> </method> <method name="is_item_icon_transposed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if the item icon will be drawn transposed, i.e. the X and Y axes are swapped. </description> </method> <method name="is_item_selectable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if the item at the specified index is selectable. </description> </method> <method name="is_item_tooltip_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if the tooltip is enabled for specified item index. </description> </method> <method name="is_selected" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if the item at the specified index is currently selected. </description> </method> <method name="move_item"> <return type="void" /> - <argument index="0" name="from_idx" type="int" /> - <argument index="1" name="to_idx" type="int" /> + <param index="0" name="from_idx" type="int" /> + <param index="1" name="to_idx" type="int" /> <description> Moves item from index [code]from_idx[/code] to [code]to_idx[/code]. </description> </method> <method name="remove_item"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Removes the item specified by [code]idx[/code] index from the list. </description> </method> <method name="select"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="single" type="bool" default="true" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="single" type="bool" default="true" /> <description> Select the item at the specified index. [b]Note:[/b] This method does not trigger the item selection signal. @@ -216,24 +216,24 @@ </method> <method name="set_item_custom_bg_color"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="custom_bg_color" type="Color" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="custom_bg_color" type="Color" /> <description> Sets the background color of the item specified by [code]idx[/code] index to the specified [Color]. </description> </method> <method name="set_item_custom_fg_color"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="custom_fg_color" type="Color" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="custom_fg_color" type="Color" /> <description> Sets the foreground color of the item specified by [code]idx[/code] index to the specified [Color]. </description> </method> <method name="set_item_disabled"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="disabled" type="bool" /> <description> Disables (or enables) the item at the specified index. Disabled items cannot be selected and do not trigger activation signals (when double-clicking or pressing [kbd]Enter[/kbd]). @@ -241,88 +241,88 @@ </method> <method name="set_item_icon"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="icon" type="Texture2D" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="icon" type="Texture2D" /> <description> Sets (or replaces) the icon's [Texture2D] associated with the specified index. </description> </method> <method name="set_item_icon_modulate"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="modulate" type="Color" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="modulate" type="Color" /> <description> Sets a modulating [Color] of the item associated with the specified index. </description> </method> <method name="set_item_icon_region"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="rect" type="Rect2" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="rect" type="Rect2" /> <description> Sets the region of item's icon used. The whole icon will be used if the region has no area. </description> </method> <method name="set_item_icon_transposed"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="transposed" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="transposed" type="bool" /> <description> Sets whether the item icon will be drawn transposed. </description> </method> <method name="set_item_language"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="language" type="String" /> <description> Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. </description> </method> <method name="set_item_metadata"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="metadata" type="Variant" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="metadata" type="Variant" /> <description> Sets a value (of any type) to be stored with the item associated with the specified index. </description> </method> <method name="set_item_selectable"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="selectable" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="selectable" type="bool" /> <description> Allows or disallows selection of the item associated with the specified index. </description> </method> <method name="set_item_text"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="text" type="String" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="text" type="String" /> <description> Sets text of the item associated with the specified index. </description> </method> <method name="set_item_text_direction"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="direction" type="int" enum="Control.TextDirection" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="direction" type="int" enum="Control.TextDirection" /> <description> Sets item's text base writing direction. </description> </method> <method name="set_item_tooltip"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="tooltip" type="String" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="tooltip" type="String" /> <description> Sets the tooltip hint for the item associated with the specified index. </description> </method> <method name="set_item_tooltip_enabled"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="enable" type="bool" /> <description> Sets whether the tooltip hint is enabled for specified item index. </description> @@ -385,37 +385,37 @@ </members> <signals> <signal name="empty_clicked"> - <argument index="0" name="at_position" type="Vector2" /> - <argument index="1" name="mouse_button_index" type="int" /> + <param index="0" name="at_position" type="Vector2" /> + <param index="1" name="mouse_button_index" type="int" /> <description> Triggered when any mouse click is issued within the rect of the list but on empty space. </description> </signal> <signal name="item_activated"> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Triggered when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd]. </description> </signal> <signal name="item_clicked"> - <argument index="0" name="index" type="int" /> - <argument index="1" name="at_position" type="Vector2" /> - <argument index="2" name="mouse_button_index" type="int" /> + <param index="0" name="index" type="int" /> + <param index="1" name="at_position" type="Vector2" /> + <param index="2" name="mouse_button_index" type="int" /> <description> Triggered when specified list item has been clicked with any mouse button. The click position is also provided to allow appropriate popup of context menus at the correct location. </description> </signal> <signal name="item_selected"> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Triggered when specified item has been selected. [member allow_reselect] must be enabled to reselect an item. </description> </signal> <signal name="multi_selected"> - <argument index="0" name="index" type="int" /> - <argument index="1" name="selected" type="bool" /> + <param index="0" name="index" type="int" /> + <param index="1" name="selected" type="bool" /> <description> Triggered when a multiple selection is altered on a list allowing multiple selection. </description> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index 9650701c49..5d83c75417 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -50,7 +50,7 @@ </method> <method name="parse"> <return type="int" enum="Error" /> - <argument index="0" name="json_string" type="String" /> + <param index="0" name="json_string" type="String" /> <description> Attempts to parse the [code]json_string[/code] provided. Returns an [enum Error]. If the parse was successful, it returns [code]OK[/code] and the result can be retrieved using [method get_data]. If unsuccessful, use [method get_error_line] and [method get_error_message] for identifying the source of the failure. @@ -58,10 +58,10 @@ </method> <method name="stringify"> <return type="String" /> - <argument index="0" name="data" type="Variant" /> - <argument index="1" name="indent" type="String" default="""" /> - <argument index="2" name="sort_keys" type="bool" default="true" /> - <argument index="3" name="full_precision" type="bool" default="false" /> + <param index="0" name="data" type="Variant" /> + <param index="1" name="indent" type="String" default="""" /> + <param index="2" name="sort_keys" type="bool" default="true" /> + <param index="3" name="full_precision" type="bool" default="false" /> <description> Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network. [b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types. diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml index cfe39d38a7..e8fb208fef 100644 --- a/doc/classes/JSONRPC.xml +++ b/doc/classes/JSONRPC.xml @@ -11,8 +11,8 @@ <methods> <method name="make_notification"> <return type="Dictionary" /> - <argument index="0" name="method" type="String" /> - <argument index="1" name="params" type="Variant" /> + <param index="0" name="method" type="String" /> + <param index="1" name="params" type="Variant" /> <description> Returns a dictionary in the form of a JSON-RPC notification. Notifications are one-shot messages which do not expect a response. - [code]method[/code]: Name of the method being called. @@ -21,9 +21,9 @@ </method> <method name="make_request"> <return type="Dictionary" /> - <argument index="0" name="method" type="String" /> - <argument index="1" name="params" type="Variant" /> - <argument index="2" name="id" type="Variant" /> + <param index="0" name="method" type="String" /> + <param index="1" name="params" type="Variant" /> + <param index="2" name="id" type="Variant" /> <description> Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a server with the expectation of a response. The ID field is used for the server to specify which exact request it is responding to. - [code]method[/code]: Name of the method being called. @@ -33,8 +33,8 @@ </method> <method name="make_response"> <return type="Dictionary" /> - <argument index="0" name="result" type="Variant" /> - <argument index="1" name="id" type="Variant" /> + <param index="0" name="result" type="Variant" /> + <param index="1" name="id" type="Variant" /> <description> When a server has received and processed a request, it is expected to send a response. If you did not want a response then you need to have sent a Notification instead. - [code]result[/code]: The return value of the function which was called. @@ -43,9 +43,9 @@ </method> <method name="make_response_error" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="code" type="int" /> - <argument index="1" name="message" type="String" /> - <argument index="2" name="id" type="Variant" default="null" /> + <param index="0" name="code" type="int" /> + <param index="1" name="message" type="String" /> + <param index="2" name="id" type="Variant" default="null" /> <description> Creates a response which indicates a previous reply has failed in some way. - [code]code[/code]: The error code corresponding to what kind of error this is. See the [enum ErrorCode] constants. @@ -55,8 +55,8 @@ </method> <method name="process_action"> <return type="Variant" /> - <argument index="0" name="action" type="Variant" /> - <argument index="1" name="recurse" type="bool" default="false" /> + <param index="0" name="action" type="Variant" /> + <param index="1" name="recurse" type="bool" default="false" /> <description> Given a Dictionary which takes the form of a JSON-RPC request: unpack the request and run it. Methods are resolved by looking at the field called "method" and looking for an equivalently named function in the JSONRPC object. If one is found that method is called. To add new supported methods extend the JSONRPC class and call [method process_action] on your subclass. @@ -65,14 +65,14 @@ </method> <method name="process_string"> <return type="String" /> - <argument index="0" name="action" type="String" /> + <param index="0" name="action" type="String" /> <description> </description> </method> <method name="set_scope"> <return type="void" /> - <argument index="0" name="scope" type="String" /> - <argument index="1" name="target" type="Object" /> + <param index="0" name="scope" type="String" /> + <param index="1" name="target" type="Object" /> <description> </description> </method> diff --git a/doc/classes/JavaClassWrapper.xml b/doc/classes/JavaClassWrapper.xml index fdfac2748b..d44a63938c 100644 --- a/doc/classes/JavaClassWrapper.xml +++ b/doc/classes/JavaClassWrapper.xml @@ -9,7 +9,7 @@ <methods> <method name="wrap"> <return type="JavaClass" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> </description> </method> diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml index 864028f3a6..d91e8bd3e5 100644 --- a/doc/classes/JavaScript.xml +++ b/doc/classes/JavaScript.xml @@ -13,23 +13,23 @@ <methods> <method name="create_callback"> <return type="JavaScriptObject" /> - <argument index="0" name="callable" type="Callable" /> + <param index="0" name="callable" type="Callable" /> <description> Creates a reference to a [Callable] that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See [JavaScriptObject] for usage. </description> </method> <method name="create_object" qualifiers="vararg"> <return type="Variant" /> - <argument index="0" name="object" type="String" /> + <param index="0" name="object" type="String" /> <description> Creates a new JavaScript object using the [code]new[/code] constructor. The [code]object[/code] must a valid property of the JavaScript [code]window[/code]. See [JavaScriptObject] for usage. </description> </method> <method name="download_buffer"> <return type="void" /> - <argument index="0" name="buffer" type="PackedByteArray" /> - <argument index="1" name="name" type="String" /> - <argument index="2" name="mime" type="String" default=""application/octet-stream"" /> + <param index="0" name="buffer" type="PackedByteArray" /> + <param index="1" name="name" type="String" /> + <param index="2" name="mime" type="String" default=""application/octet-stream"" /> <description> Prompts the user to download a file containing the specified [code]buffer[/code]. The file will have the given [code]name[/code] and [code]mime[/code] type. [b]Note:[/b] The browser may override the [url=https://en.wikipedia.org/wiki/Media_type]MIME type[/url] provided based on the file [code]name[/code]'s extension. @@ -39,8 +39,8 @@ </method> <method name="eval"> <return type="Variant" /> - <argument index="0" name="code" type="String" /> - <argument index="1" name="use_global_execution_context" type="bool" default="false" /> + <param index="0" name="code" type="String" /> + <param index="1" name="use_global_execution_context" type="bool" default="false" /> <description> Execute the string [code]code[/code] as JavaScript code within the browser window. This is a call to the actual global JavaScript function [code]eval()[/code]. If [code]use_global_execution_context[/code] is [code]true[/code], the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment. @@ -48,7 +48,7 @@ </method> <method name="get_interface"> <return type="JavaScriptObject" /> - <argument index="0" name="interface" type="String" /> + <param index="0" name="interface" type="String" /> <description> Returns an interface to a JavaScript object that can be used by scripts. The [code]interface[/code] must be a valid property of the JavaScript [code]window[/code]. The callback must accept a single [Array] argument, which will contain the JavaScript [code]arguments[/code]. See [JavaScriptObject] for usage. </description> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 1f3f0dbb6d..ca6aa05316 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -12,7 +12,7 @@ <methods> <method name="get_angle" qualifiers="const"> <return type="float" /> - <argument index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" /> + <param index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" /> <description> Returns the collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive. </description> diff --git a/doc/classes/KinematicCollision3D.xml b/doc/classes/KinematicCollision3D.xml index 6327d48d38..08ceebdf91 100644 --- a/doc/classes/KinematicCollision3D.xml +++ b/doc/classes/KinematicCollision3D.xml @@ -12,50 +12,50 @@ <methods> <method name="get_angle" qualifiers="const"> <return type="float" /> - <argument index="0" name="collision_index" type="int" default="0" /> - <argument index="1" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" /> + <param index="0" name="collision_index" type="int" default="0" /> + <param index="1" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" /> <description> Returns the collision angle according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive. </description> </method> <method name="get_collider" qualifiers="const"> <return type="Object" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's attached [Object] given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default). See [method Object.get_instance_id]. </description> </method> <method name="get_collider_rid" qualifiers="const"> <return type="RID" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="Object" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's shape given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_shape_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's shape index given a collision index (the deepest collision by default). See [CollisionObject3D]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's velocity given a collision index (the deepest collision by default). </description> @@ -68,21 +68,21 @@ </method> <method name="get_local_shape" qualifiers="const"> <return type="Object" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the moving object's colliding shape given a collision index (the deepest collision by default). </description> </method> <method name="get_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default). </description> </method> <method name="get_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the point of collision in global coordinates given a collision index (the deepest collision by default). </description> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 1ebf770f7e..d882405384 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -19,7 +19,7 @@ </method> <method name="get_line_height" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" default="-1" /> + <param index="0" name="line" type="int" default="-1" /> <description> Returns the height of the line [code]line[/code]. If [code]line[/code] is set to [code]-1[/code], returns the biggest line height. diff --git a/doc/classes/Label3D.xml b/doc/classes/Label3D.xml index 5ba0a2d79a..56690d484d 100644 --- a/doc/classes/Label3D.xml +++ b/doc/classes/Label3D.xml @@ -17,15 +17,15 @@ </method> <method name="get_draw_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="Label3D.DrawFlags" /> + <param index="0" name="flag" type="int" enum="Label3D.DrawFlags" /> <description> Returns the value of the specified flag. </description> </method> <method name="set_draw_flag"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="Label3D.DrawFlags" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="flag" type="int" enum="Label3D.DrawFlags" /> + <param index="1" name="enabled" type="bool" /> <description> If [code]true[/code], the specified flag will be enabled. See [enum Label3D.DrawFlags] for a list of flags. </description> diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 32bf6a67a9..00815758a1 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -18,7 +18,7 @@ </method> <method name="set_height"> <return type="void" /> - <argument index="0" name="height" type="float" /> + <param index="0" name="height" type="float" /> <description> </description> </method> diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml index 46c3e57547..80ff83ec46 100644 --- a/doc/classes/Light3D.xml +++ b/doc/classes/Light3D.xml @@ -13,15 +13,15 @@ <methods> <method name="get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="Light3D.Param" /> + <param index="0" name="param" type="int" enum="Light3D.Param" /> <description> Returns the value of the specified [enum Light3D.Param] parameter. </description> </method> <method name="set_param"> <return type="void" /> - <argument index="0" name="param" type="int" enum="Light3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="Light3D.Param" /> + <param index="1" name="value" type="float" /> <description> Sets the value of the specified [enum Light3D.Param] parameter. </description> diff --git a/doc/classes/LightmapGIData.xml b/doc/classes/LightmapGIData.xml index 13f44150d7..0881d3de8a 100644 --- a/doc/classes/LightmapGIData.xml +++ b/doc/classes/LightmapGIData.xml @@ -11,10 +11,10 @@ <methods> <method name="add_user"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="uv_scale" type="Rect2" /> - <argument index="2" name="slice_index" type="int" /> - <argument index="3" name="sub_instance" type="int" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="uv_scale" type="Rect2" /> + <param index="2" name="slice_index" type="int" /> + <param index="3" name="sub_instance" type="int" /> <description> Adds an object that is considered baked within this [LightmapGIData]. </description> @@ -33,7 +33,7 @@ </method> <method name="get_user_path" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="user_idx" type="int" /> + <param index="0" name="user_idx" type="int" /> <description> Returns the [NodePath] of the baked object at index [code]user_idx[/code]. </description> @@ -46,7 +46,7 @@ </method> <method name="set_uses_spherical_harmonics"> <return type="void" /> - <argument index="0" name="uses_spherical_harmonics" type="bool" /> + <param index="0" name="uses_spherical_harmonics" type="bool" /> <description> If [code]uses_spherical_harmonics[/code] is [code]true[/code], tells the engine to treat the lightmap data as if it was baked with directional information. [b]Note:[/b] Changing this value on already baked lightmaps will not cause them to be baked again. This means the material appearance will look incorrect until lightmaps are baked again, in which case the value set here is discarded as the entire [LightmapGIData] resource is replaced by the lightmapper. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index e2cc43bb75..0bca77749d 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -13,8 +13,8 @@ <methods> <method name="add_point"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="at_position" type="int" default="-1" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="at_position" type="int" default="-1" /> <description> Adds a point at the [code]position[/code]. Appends the point at the end of the line. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position < 0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. @@ -34,22 +34,22 @@ </method> <method name="get_point_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="i" type="int" /> + <param index="0" name="i" type="int" /> <description> Returns point [code]i[/code]'s position. </description> </method> <method name="remove_point"> <return type="void" /> - <argument index="0" name="i" type="int" /> + <param index="0" name="i" type="int" /> <description> Removes the point at index [code]i[/code] from the line. </description> </method> <method name="set_point_position"> <return type="void" /> - <argument index="0" name="i" type="int" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="i" type="int" /> + <param index="1" name="position" type="Vector2" /> <description> Overwrites the position in point [code]i[/code] with the supplied [code]position[/code]. </description> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 2ff13a676b..c06118e621 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -45,8 +45,8 @@ </method> <method name="delete_text"> <return type="void" /> - <argument index="0" name="from_column" type="int" /> - <argument index="1" name="to_column" type="int" /> + <param index="0" name="from_column" type="int" /> + <param index="1" name="to_column" type="int" /> <description> Deletes a section of the [member text] going from position [code]from_column[/code] to [code]to_column[/code]. Both parameters should be within the text's length. </description> @@ -90,7 +90,7 @@ </method> <method name="insert_text_at_caret"> <return type="void" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Inserts [code]text[/code] at the caret. If the resulting value is longer than [member max_length], nothing happens. </description> @@ -103,15 +103,15 @@ </method> <method name="menu_option"> <return type="void" /> - <argument index="0" name="option" type="int" /> + <param index="0" name="option" type="int" /> <description> Executes a given action as defined in the [enum MenuItems] enum. </description> </method> <method name="select"> <return type="void" /> - <argument index="0" name="from" type="int" default="0" /> - <argument index="1" name="to" type="int" default="-1" /> + <param index="0" name="from" type="int" default="0" /> + <param index="1" name="to" type="int" default="-1" /> <description> Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default, [code]from[/code] is at the beginning and [code]to[/code] at the end. [codeblocks] @@ -252,19 +252,19 @@ </members> <signals> <signal name="text_change_rejected"> - <argument index="0" name="rejected_substring" type="String" /> + <param index="0" name="rejected_substring" type="String" /> <description> Emitted when appending text that overflows the [member max_length]. The appended text is truncated to fit [member max_length], and the part that couldn't fit is passed as the [code]rejected_substring[/code] argument. </description> </signal> <signal name="text_changed"> - <argument index="0" name="new_text" type="String" /> + <param index="0" name="new_text" type="String" /> <description> Emitted when the text changes. </description> </signal> <signal name="text_submitted"> - <argument index="0" name="new_text" type="String" /> + <param index="0" name="new_text" type="String" /> <description> Emitted when the user presses [constant KEY_ENTER] on the [LineEdit]. </description> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index 2cf41b750a..acc59a307b 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -74,7 +74,7 @@ </method> <method name="_physics_process" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Called each physics frame with the time since the last physics frame as argument ([code]delta[/code], in seconds). Equivalent to [method Node._physics_process]. If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame. @@ -82,7 +82,7 @@ </method> <method name="_process" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Called each process (idle) frame with the time since the last process frame as argument (in seconds). Equivalent to [method Node._process]. If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame. @@ -91,8 +91,8 @@ </methods> <signals> <signal name="on_request_permissions_result"> - <argument index="0" name="permission" type="String" /> - <argument index="1" name="granted" type="bool" /> + <param index="0" name="permission" type="String" /> + <param index="1" name="granted" type="bool" /> <description> Emitted when a user responds to a permission request. </description> diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index b66a1b9190..ac7b4a48b9 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -11,22 +11,22 @@ <methods> <method name="base64_to_raw"> <return type="PackedByteArray" /> - <argument index="0" name="base64_str" type="String" /> + <param index="0" name="base64_str" type="String" /> <description> Returns a decoded [PackedByteArray] corresponding to the Base64-encoded string [code]base64_str[/code]. </description> </method> <method name="base64_to_utf8"> <return type="String" /> - <argument index="0" name="base64_str" type="String" /> + <param index="0" name="base64_str" type="String" /> <description> Returns a decoded string corresponding to the Base64-encoded string [code]base64_str[/code]. </description> </method> <method name="base64_to_variant"> <return type="Variant" /> - <argument index="0" name="base64_str" type="String" /> - <argument index="1" name="allow_objects" type="bool" default="false" /> + <param index="0" name="base64_str" type="String" /> + <param index="1" name="allow_objects" type="bool" default="false" /> <description> Returns a decoded [Variant] corresponding to the Base64-encoded string [code]base64_str[/code]. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -34,22 +34,22 @@ </method> <method name="raw_to_base64"> <return type="String" /> - <argument index="0" name="array" type="PackedByteArray" /> + <param index="0" name="array" type="PackedByteArray" /> <description> Returns a Base64-encoded string of a given [PackedByteArray]. </description> </method> <method name="utf8_to_base64"> <return type="String" /> - <argument index="0" name="utf8_str" type="String" /> + <param index="0" name="utf8_str" type="String" /> <description> Returns a Base64-encoded string of the UTF-8 string [code]utf8_str[/code]. </description> </method> <method name="variant_to_base64"> <return type="String" /> - <argument index="0" name="variant" type="Variant" /> - <argument index="1" name="full_objects" type="bool" default="false" /> + <param index="0" name="variant" type="Variant" /> + <param index="1" name="full_objects" type="bool" default="false" /> <description> Returns a Base64-encoded string of the [Variant] [code]variant[/code]. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). </description> diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index bec567b3ef..8baa724292 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -20,7 +20,7 @@ </method> <method name="set_disable_shortcuts"> <return type="void" /> - <argument index="0" name="disabled" type="bool" /> + <param index="0" name="disabled" type="bool" /> <description> If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button. </description> diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 48fa2754d5..f708917b4b 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -25,7 +25,7 @@ </method> <method name="_get_blend_shape_name" qualifiers="virtual const"> <return type="StringName" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> @@ -36,70 +36,70 @@ </method> <method name="_set_blend_shape_name" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="name" type="StringName" /> + <param index="0" name="index" type="int" /> + <param index="1" name="name" type="StringName" /> <description> </description> </method> <method name="_surface_get_array_index_len" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="_surface_get_array_len" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="_surface_get_arrays" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="_surface_get_blend_shape_arrays" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="_surface_get_format" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="_surface_get_lods" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="_surface_get_material" qualifiers="virtual const"> <return type="Material" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="_surface_get_primitive_type" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="_surface_set_material" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="material" type="Material" /> + <param index="0" name="index" type="int" /> + <param index="1" name="material" type="Material" /> <description> </description> </method> <method name="create_convex_shape" qualifiers="const"> <return type="Shape3D" /> - <argument index="0" name="clean" type="bool" default="true" /> - <argument index="1" name="simplify" type="bool" default="false" /> + <param index="0" name="clean" type="bool" default="true" /> + <param index="1" name="simplify" type="bool" default="false" /> <description> Calculate a [ConvexPolygonShape3D] from the mesh. If [code]clean[/code] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed. @@ -108,7 +108,7 @@ </method> <method name="create_outline" qualifiers="const"> <return type="Mesh" /> - <argument index="0" name="margin" type="float" /> + <param index="0" name="margin" type="float" /> <description> Calculate an outline mesh at a defined offset (margin) from the original mesh. [b]Note:[/b] This method typically returns the vertices in reverse order (e.g. clockwise to counterclockwise). @@ -147,29 +147,29 @@ </method> <method name="surface_get_arrays" qualifiers="const"> <return type="Array" /> - <argument index="0" name="surf_idx" type="int" /> + <param index="0" name="surf_idx" type="int" /> <description> Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see [method ArrayMesh.add_surface_from_arrays]). </description> </method> <method name="surface_get_blend_shape_arrays" qualifiers="const"> <return type="Array" /> - <argument index="0" name="surf_idx" type="int" /> + <param index="0" name="surf_idx" type="int" /> <description> Returns the blend shape arrays for the requested surface. </description> </method> <method name="surface_get_material" qualifiers="const"> <return type="Material" /> - <argument index="0" name="surf_idx" type="int" /> + <param index="0" name="surf_idx" type="int" /> <description> Returns a [Material] in a given surface. Surface is rendered using this material. </description> </method> <method name="surface_set_material"> <return type="void" /> - <argument index="0" name="surf_idx" type="int" /> - <argument index="1" name="material" type="Material" /> + <param index="0" name="surf_idx" type="int" /> + <param index="1" name="material" type="Material" /> <description> Sets a [Material] for a given surface. Surface will be rendered using this material. </description> diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index 0042bb20d8..b46f080a10 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -59,15 +59,15 @@ </method> <method name="commit_to_surface"> <return type="int" enum="Error" /> - <argument index="0" name="mesh" type="ArrayMesh" /> + <param index="0" name="mesh" type="ArrayMesh" /> <description> Adds a new surface to specified [Mesh] with edited data. </description> </method> <method name="create_from_surface"> <return type="int" enum="Error" /> - <argument index="0" name="mesh" type="ArrayMesh" /> - <argument index="1" name="surface" type="int" /> + <param index="0" name="mesh" type="ArrayMesh" /> + <param index="1" name="surface" type="int" /> <description> Uses specified surface of given [Mesh] to populate data for MeshDataTool. Requires [Mesh] with primitive type [constant Mesh.PRIMITIVE_TRIANGLES]. @@ -81,22 +81,22 @@ </method> <method name="get_edge_faces" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns array of faces that touch given edge. </description> </method> <method name="get_edge_meta" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns meta information assigned to given edge. </description> </method> <method name="get_edge_vertex" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="vertex" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="vertex" type="int" /> <description> Returns index of specified vertex connected to given edge. Vertex argument can only be 0 or 1 because edges are comprised of two vertices. @@ -110,8 +110,8 @@ </method> <method name="get_face_edge" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="edge" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="edge" type="int" /> <description> Returns specified edge associated with given face. Edge argument must be either 0, 1, or 2 because a face only has three edges. @@ -119,22 +119,22 @@ </method> <method name="get_face_meta" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the metadata associated with the given face. </description> </method> <method name="get_face_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Calculates and returns the face normal of the given face. </description> </method> <method name="get_face_vertex" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="vertex" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="vertex" type="int" /> <description> Returns the specified vertex of the given face. Vertex argument must be either 0, 1, or 2 because faces contain three vertices. @@ -155,21 +155,21 @@ </method> <method name="get_vertex" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the vertex at given index. </description> </method> <method name="get_vertex_bones" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the bones of the given vertex. </description> </method> <method name="get_vertex_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the color of the given vertex. </description> @@ -182,151 +182,151 @@ </method> <method name="get_vertex_edges" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns an array of edges that share the given vertex. </description> </method> <method name="get_vertex_faces" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns an array of faces that share the given vertex. </description> </method> <method name="get_vertex_meta" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the metadata associated with the given vertex. </description> </method> <method name="get_vertex_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the normal of the given vertex. </description> </method> <method name="get_vertex_tangent" qualifiers="const"> <return type="Plane" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the tangent of the given vertex. </description> </method> <method name="get_vertex_uv" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the UV of the given vertex. </description> </method> <method name="get_vertex_uv2" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the UV2 of the given vertex. </description> </method> <method name="get_vertex_weights" qualifiers="const"> <return type="PackedFloat32Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns bone weights of the given vertex. </description> </method> <method name="set_edge_meta"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="meta" type="Variant" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="meta" type="Variant" /> <description> Sets the metadata of the given edge. </description> </method> <method name="set_face_meta"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="meta" type="Variant" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="meta" type="Variant" /> <description> Sets the metadata of the given face. </description> </method> <method name="set_material"> <return type="void" /> - <argument index="0" name="material" type="Material" /> + <param index="0" name="material" type="Material" /> <description> Sets the material to be used by newly-constructed [Mesh]. </description> </method> <method name="set_vertex"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="vertex" type="Vector3" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="vertex" type="Vector3" /> <description> Sets the position of the given vertex. </description> </method> <method name="set_vertex_bones"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="bones" type="PackedInt32Array" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="bones" type="PackedInt32Array" /> <description> Sets the bones of the given vertex. </description> </method> <method name="set_vertex_color"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="color" type="Color" /> <description> Sets the color of the given vertex. </description> </method> <method name="set_vertex_meta"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="meta" type="Variant" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="meta" type="Variant" /> <description> Sets the metadata associated with the given vertex. </description> </method> <method name="set_vertex_normal"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="normal" type="Vector3" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="normal" type="Vector3" /> <description> Sets the normal of the given vertex. </description> </method> <method name="set_vertex_tangent"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="tangent" type="Plane" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="tangent" type="Plane" /> <description> Sets the tangent of the given vertex. </description> </method> <method name="set_vertex_uv"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="uv" type="Vector2" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="uv" type="Vector2" /> <description> Sets the UV of the given vertex. </description> </method> <method name="set_vertex_uv2"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="uv2" type="Vector2" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="uv2" type="Vector2" /> <description> Sets the UV2 of the given vertex. </description> </method> <method name="set_vertex_weights"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="weights" type="PackedFloat32Array" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="weights" type="PackedFloat32Array" /> <description> Sets the bone weights of the given vertex. </description> diff --git a/doc/classes/MeshInstance3D.xml b/doc/classes/MeshInstance3D.xml index 24f1f9918b..1e69af6fd7 100644 --- a/doc/classes/MeshInstance3D.xml +++ b/doc/classes/MeshInstance3D.xml @@ -15,8 +15,8 @@ <methods> <method name="create_convex_collision"> <return type="void" /> - <argument index="0" name="clean" type="bool" default="true" /> - <argument index="1" name="simplify" type="bool" default="false" /> + <param index="0" name="clean" type="bool" default="true" /> + <param index="1" name="simplify" type="bool" default="false" /> <description> This helper creates a [StaticBody3D] child node with a [ConvexPolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing. If [code]clean[/code] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed. @@ -43,13 +43,13 @@ </method> <method name="find_blend_shape_by_name"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> <method name="get_active_material" qualifiers="const"> <return type="Material" /> - <argument index="0" name="surface" type="int" /> + <param index="0" name="surface" type="int" /> <description> Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance3D.material_override], the surface override [Material] defined in this [MeshInstance3D], or the surface [Material] defined in the [Mesh]. For example, if [member GeometryInstance3D.material_override] is used, all surfaces will return the override material. </description> @@ -61,13 +61,13 @@ </method> <method name="get_blend_shape_value" qualifiers="const"> <return type="float" /> - <argument index="0" name="blend_shape_idx" type="int" /> + <param index="0" name="blend_shape_idx" type="int" /> <description> </description> </method> <method name="get_surface_override_material" qualifiers="const"> <return type="Material" /> - <argument index="0" name="surface" type="int" /> + <param index="0" name="surface" type="int" /> <description> Returns the override [Material] for the specified surface of the [Mesh] resource. </description> @@ -80,15 +80,15 @@ </method> <method name="set_blend_shape_value"> <return type="void" /> - <argument index="0" name="blend_shape_idx" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="blend_shape_idx" type="int" /> + <param index="1" name="value" type="float" /> <description> </description> </method> <method name="set_surface_override_material"> <return type="void" /> - <argument index="0" name="surface" type="int" /> - <argument index="1" name="material" type="Material" /> + <param index="0" name="surface" type="int" /> + <param index="1" name="material" type="Material" /> <description> Sets the override [Material] for the specified surface of the [Mesh] resource. This material is associated with this [MeshInstance3D] rather than with the [Mesh] resource. </description> diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 6b25441a16..85e57dd0f3 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -19,7 +19,7 @@ </method> <method name="create_item"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Creates a new item in the library with the given ID. You can get an unused ID from [method get_last_unused_item_id]. @@ -27,7 +27,7 @@ </method> <method name="find_item_by_name" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the first item with the given name. </description> @@ -40,49 +40,49 @@ </method> <method name="get_item_mesh" qualifiers="const"> <return type="Mesh" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the item's mesh. </description> </method> <method name="get_item_mesh_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the transform applied to the item's mesh. </description> </method> <method name="get_item_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the item's name. </description> </method> <method name="get_item_navmesh" qualifiers="const"> <return type="NavigationMesh" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the item's navigation mesh. </description> </method> <method name="get_item_navmesh_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the transform applied to the item's navigation mesh. </description> </method> <method name="get_item_preview" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using [method set_item_preview]. Returns an empty [Texture2D] if no preview was manually set in a running project. </description> </method> <method name="get_item_shapes" qualifiers="const"> <return type="Array" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns an item's collision shapes. The array consists of each [Shape3D] followed by its [Transform3D]. @@ -96,31 +96,31 @@ </method> <method name="remove_item"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Removes the item. </description> </method> <method name="set_item_mesh"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="mesh" type="Mesh" /> + <param index="0" name="id" type="int" /> + <param index="1" name="mesh" type="Mesh" /> <description> Sets the item's mesh. </description> </method> <method name="set_item_mesh_transform"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="mesh_transform" type="Transform3D" /> + <param index="0" name="id" type="int" /> + <param index="1" name="mesh_transform" type="Transform3D" /> <description> Sets the transform to apply to the item's mesh. </description> </method> <method name="set_item_name"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets the item's name. This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name]. @@ -128,32 +128,32 @@ </method> <method name="set_item_navmesh"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="navmesh" type="NavigationMesh" /> + <param index="0" name="id" type="int" /> + <param index="1" name="navmesh" type="NavigationMesh" /> <description> Sets the item's navigation mesh. </description> </method> <method name="set_item_navmesh_transform"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="navmesh" type="Transform3D" /> + <param index="0" name="id" type="int" /> + <param index="1" name="navmesh" type="Transform3D" /> <description> Sets the transform to apply to the item's navigation mesh. </description> </method> <method name="set_item_preview"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="id" type="int" /> + <param index="1" name="texture" type="Texture2D" /> <description> Sets a texture to use as the item's preview icon in the editor. </description> </method> <method name="set_item_shapes"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="shapes" type="Array" /> + <param index="0" name="id" type="int" /> + <param index="1" name="shapes" type="Array" /> <description> Sets an item's collision shapes. The array should consist of [Shape3D] objects, each followed by a [Transform3D] that will be applied to it. For shapes that should not have a transform, use [constant Transform3D.IDENTITY]. diff --git a/doc/classes/MethodTweener.xml b/doc/classes/MethodTweener.xml index b22341e0a1..7e042b5eb6 100644 --- a/doc/classes/MethodTweener.xml +++ b/doc/classes/MethodTweener.xml @@ -12,21 +12,21 @@ <methods> <method name="set_delay"> <return type="MethodTweener" /> - <argument index="0" name="delay" type="float" /> + <param index="0" name="delay" type="float" /> <description> Sets the time in seconds after which the [MethodTweener] will start interpolating. By default there's no delay. </description> </method> <method name="set_ease"> <return type="MethodTweener" /> - <argument index="0" name="ease" type="int" enum="Tween.EaseType" /> + <param index="0" name="ease" type="int" enum="Tween.EaseType" /> <description> Sets the type of used easing from [enum Tween.EaseType]. If not set, the default easing is used from the [Tween] that contains this Tweener. </description> </method> <method name="set_trans"> <return type="MethodTweener" /> - <argument index="0" name="trans" type="int" enum="Tween.TransitionType" /> + <param index="0" name="trans" type="int" enum="Tween.TransitionType" /> <description> Sets the type of used transition from [enum Tween.TransitionType]. If not set, the default transition is used from the [Tween] that contains this Tweener. </description> diff --git a/doc/classes/MovieWriter.xml b/doc/classes/MovieWriter.xml index d47e52d7c0..9701f49b99 100644 --- a/doc/classes/MovieWriter.xml +++ b/doc/classes/MovieWriter.xml @@ -29,7 +29,7 @@ </method> <method name="_handles_file" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Called when the engine determines whether this [MovieWriter] is able to handle the file at [code]path[/code]. Must return [code]true[/code] if this [MovieWriter] is able to handle the given file path, [code]false[/code] otherwise. Typically, [method _handles_file] is overridden as follows to allow the user to record a file at any path with a given file extension: [codeblock] @@ -42,9 +42,9 @@ </method> <method name="_write_begin" qualifiers="virtual"> <return type="int" enum="Error" /> - <argument index="0" name="movie_size" type="Vector2i" /> - <argument index="1" name="fps" type="int" /> - <argument index="2" name="base_path" type="String" /> + <param index="0" name="movie_size" type="Vector2i" /> + <param index="1" name="fps" type="int" /> + <param index="2" name="base_path" type="String" /> <description> Called once before the engine starts writing video and audio data. [code]movie_size[/code] is the width and height of the video to save. [code]fps[/code] is the number of frames per second specified in the project settings or using the [code]--fixed-fps <fps>[/code] command line argument. </description> @@ -58,15 +58,15 @@ </method> <method name="_write_frame" qualifiers="virtual"> <return type="int" enum="Error" /> - <argument index="0" name="frame_image" type="Image" /> - <argument index="1" name="audio_frame_block" type="const void*" /> + <param index="0" name="frame_image" type="Image" /> + <param index="1" name="audio_frame_block" type="const void*" /> <description> Called at the end of every rendered frame. The [code]frame_image[/code] and [code]audio_frame_block[/code] function arguments should be written to. </description> </method> <method name="add_writer" qualifiers="static"> <return type="void" /> - <argument index="0" name="writer" type="MovieWriter" /> + <param index="0" name="writer" type="MovieWriter" /> <description> Adds a writer to be usable by the engine. The supported file extensions can be set by overriding [method _handles_file]. [b]Note:[/b] [method add_writer] must be called early enough in the engine initialization to work, as movie writing is designed to start at the same time as the rest of the engine. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 3431a3347b..bae2335cfb 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -22,36 +22,36 @@ </method> <method name="get_instance_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="instance" type="int" /> + <param index="0" name="instance" type="int" /> <description> Gets a specific instance's color. </description> </method> <method name="get_instance_custom_data" qualifiers="const"> <return type="Color" /> - <argument index="0" name="instance" type="int" /> + <param index="0" name="instance" type="int" /> <description> Returns the custom data that has been set for a specific instance. </description> </method> <method name="get_instance_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="instance" type="int" /> + <param index="0" name="instance" type="int" /> <description> Returns the [Transform3D] of a specific instance. </description> </method> <method name="get_instance_transform_2d" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="instance" type="int" /> + <param index="0" name="instance" type="int" /> <description> Returns the [Transform2D] of a specific instance. </description> </method> <method name="set_instance_color"> <return type="void" /> - <argument index="0" name="instance" type="int" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="instance" type="int" /> + <param index="1" name="color" type="Color" /> <description> Sets the color of a specific instance by [i]multiplying[/i] the mesh's existing vertex colors. For the color to take effect, ensure that [member use_colors] is [code]true[/code] on the [MultiMesh] and [member BaseMaterial3D.vertex_color_use_as_albedo] is [code]true[/code] on the material. If the color doesn't look as expected, make sure the material's albedo color is set to pure white ([code]Color(1, 1, 1)[/code]). @@ -59,8 +59,8 @@ </method> <method name="set_instance_custom_data"> <return type="void" /> - <argument index="0" name="instance" type="int" /> - <argument index="1" name="custom_data" type="Color" /> + <param index="0" name="instance" type="int" /> + <param index="1" name="custom_data" type="Color" /> <description> Sets custom data for a specific instance. Although [Color] is used, it is just a container for 4 floating point numbers. For the custom data to be used, ensure that [member use_custom_data] is [code]true[/code]. @@ -68,16 +68,16 @@ </method> <method name="set_instance_transform"> <return type="void" /> - <argument index="0" name="instance" type="int" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="instance" type="int" /> + <param index="1" name="transform" type="Transform3D" /> <description> Sets the [Transform3D] for a specific instance. </description> </method> <method name="set_instance_transform_2d"> <return type="void" /> - <argument index="0" name="instance" type="int" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="instance" type="int" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets the [Transform2D] for a specific instance. </description> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index 06658bf004..e0a3a29147 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -57,8 +57,8 @@ </method> <method name="object_configuration_add"> <return type="int" enum="Error" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="configuration" type="Variant" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="configuration" type="Variant" /> <description> Notifies the MultiplayerAPI of a new [code]configuration[/code] for the given [code]object[/code]. This method is used internally by [SceneTree] to configure the root path for this MultiplayerAPI (passing [code]null[/code] and a valid [NodePath] as [code]configuration[/code]). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. [SceneMultiplayer]) for details on how they use it. [b]Note:[/b] This method is mostly relevant when extending or overriding the MultiplayerAPI behavior via [MultiplayerAPIExtension]. @@ -66,8 +66,8 @@ </method> <method name="object_configuration_remove"> <return type="int" enum="Error" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="configuration" type="Variant" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="configuration" type="Variant" /> <description> Notifies the MultiplayerAPI to remove a [code]configuration[/code] for the given [code]object[/code]. This method is used internally by [SceneTree] to configure the root path for this MultiplayerAPI (passing [code]null[/code] and an empty [NodePath] as [code]configuration[/code]). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. [SceneMultiplayer]) for details on how they use it. [b]Note:[/b] This method is mostly relevant when extending or overriding the MultiplayerAPI behavior via [MultiplayerAPIExtension]. @@ -82,10 +82,10 @@ </method> <method name="rpc"> <return type="int" enum="Error" /> - <argument index="0" name="peer" type="int" /> - <argument index="1" name="object" type="Object" /> - <argument index="2" name="method" type="StringName" /> - <argument index="3" name="arguments" type="Array" default="[]" /> + <param index="0" name="peer" type="int" /> + <param index="1" name="object" type="Object" /> + <param index="2" name="method" type="StringName" /> + <param index="3" name="arguments" type="Array" default="[]" /> <description> Sends an RPC to the target [code]peer[/code]. The given [code]method[/code] will be called on the remote [code]object[/code] with the provided [code]arguments[/code]. The RPC may also be called locally depending on the implementation and RPC configuration. See [method Node.rpc] and [method Node.rpc_config]. [b]Note:[/b] Prefer using [method Node.rpc], [method Node.rpc_id], or [code]my_method.rpc(peer, arg1, arg2, ...)[/code] (in GDScript), since they are faster. This method is mostly useful in conjunction with [MultiplayerAPIExtension] when augmenting or replacing the multiplayer capabilities. @@ -93,7 +93,7 @@ </method> <method name="set_default_interface" qualifiers="static"> <return type="void" /> - <argument index="0" name="interface_name" type="StringName" /> + <param index="0" name="interface_name" type="StringName" /> <description> Sets the default MultiplayerAPI implementation class. This method can be used by modules and extensions to configure which implementation will be used by [SceneTree] when the engine starts. </description> @@ -116,13 +116,13 @@ </description> </signal> <signal name="peer_connected"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when this MultiplayerAPI's [member multiplayer_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). </description> </signal> <signal name="peer_disconnected"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when this MultiplayerAPI's [member multiplayer_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. </description> diff --git a/doc/classes/MultiplayerAPIExtension.xml b/doc/classes/MultiplayerAPIExtension.xml index c369977d57..e67970cc89 100644 --- a/doc/classes/MultiplayerAPIExtension.xml +++ b/doc/classes/MultiplayerAPIExtension.xml @@ -100,16 +100,16 @@ </method> <method name="_object_configuration_add" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="configuration" type="Variant" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="configuration" type="Variant" /> <description> Callback for [method MultiplayerAPI.object_configuration_add]. </description> </method> <method name="_object_configuration_remove" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="configuration" type="Variant" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="configuration" type="Variant" /> <description> Callback for [method MultiplayerAPI.object_configuration_remove]. </description> @@ -122,17 +122,17 @@ </method> <method name="_rpc" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="peer" type="int" /> - <argument index="1" name="object" type="Object" /> - <argument index="2" name="method" type="StringName" /> - <argument index="3" name="args" type="Array" /> + <param index="0" name="peer" type="int" /> + <param index="1" name="object" type="Object" /> + <param index="2" name="method" type="StringName" /> + <param index="3" name="args" type="Array" /> <description> Callback for [method MultiplayerAPI.rpc]. </description> </method> <method name="_set_multiplayer_peer" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="multiplayer_peer" type="MultiplayerPeer" /> + <param index="0" name="multiplayer_peer" type="MultiplayerPeer" /> <description> Called when the [member MultiplayerAPI.multiplayer_peer] is set. </description> diff --git a/doc/classes/MultiplayerPeer.xml b/doc/classes/MultiplayerPeer.xml index 6dde40f018..9e747383b6 100644 --- a/doc/classes/MultiplayerPeer.xml +++ b/doc/classes/MultiplayerPeer.xml @@ -45,7 +45,7 @@ </method> <method name="set_target_peer"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Sets the peer to which packets will be sent. The [code]id[/code] can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is [constant TARGET_PEER_BROADCAST]. @@ -76,13 +76,13 @@ </description> </signal> <signal name="peer_connected"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted by the server when a client connects. </description> </signal> <signal name="peer_disconnected"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted by the server when a client disconnects. </description> diff --git a/doc/classes/MultiplayerPeerExtension.xml b/doc/classes/MultiplayerPeerExtension.xml index f837171e2f..12e281fa76 100644 --- a/doc/classes/MultiplayerPeerExtension.xml +++ b/doc/classes/MultiplayerPeerExtension.xml @@ -29,8 +29,8 @@ </method> <method name="_get_packet" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="r_buffer" type="const uint8_t **" /> - <argument index="1" name="r_buffer_size" type="int32_t*" /> + <param index="0" name="r_buffer" type="const uint8_t **" /> + <param index="1" name="r_buffer_size" type="int32_t*" /> <description> Called when a packet needs to be received by the [MultiplayerAPI], with [code]p_buffer_size[/code] being the size of the binary [code]p_buffer[/code] in bytes. </description> @@ -85,43 +85,43 @@ </method> <method name="_put_packet" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_buffer" type="const uint8_t*" /> - <argument index="1" name="p_buffer_size" type="int" /> + <param index="0" name="p_buffer" type="const uint8_t*" /> + <param index="1" name="p_buffer_size" type="int" /> <description> Called when a packet needs to be sent by the [MultiplayerAPI], with [code]p_buffer_size[/code] being the size of the binary [code]p_buffer[/code] in bytes. </description> </method> <method name="_put_packet_script" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_buffer" type="PackedByteArray" /> + <param index="0" name="p_buffer" type="PackedByteArray" /> <description> Called when a packet needs to be sent by the [MultiplayerAPI], if [method _put_packet] isn't implemented. Use this when extending this class via GDScript. </description> </method> <method name="_set_refuse_new_connections" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="p_enable" type="bool" /> + <param index="0" name="p_enable" type="bool" /> <description> Called when the "refuse new connections" status is set on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]). </description> </method> <method name="_set_target_peer" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="p_peer" type="int" /> + <param index="0" name="p_peer" type="int" /> <description> Called when the target peer to use is set for this [MultiplayerPeer] (see [method MultiplayerPeer.set_target_peer]). </description> </method> <method name="_set_transfer_channel" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="p_channel" type="int" /> + <param index="0" name="p_channel" type="int" /> <description> Called when the channel to use is set for this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]). </description> </method> <method name="_set_transfer_mode" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="p_mode" type="int" /> + <param index="0" name="p_mode" type="int" /> <description> Called when the transfer mode is set on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]). </description> diff --git a/doc/classes/NativeExtension.xml b/doc/classes/NativeExtension.xml index e5e11c1c95..50f976ca6f 100644 --- a/doc/classes/NativeExtension.xml +++ b/doc/classes/NativeExtension.xml @@ -19,7 +19,7 @@ </method> <method name="initialize_library"> <return type="void" /> - <argument index="0" name="level" type="int" enum="NativeExtension.InitializationLevel" /> + <param index="0" name="level" type="int" enum="NativeExtension.InitializationLevel" /> <description> </description> </method> @@ -30,8 +30,8 @@ </method> <method name="open_library"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="entry_symbol" type="String" /> + <param index="0" name="path" type="String" /> + <param index="1" name="entry_symbol" type="String" /> <description> </description> </method> diff --git a/doc/classes/NativeExtensionManager.xml b/doc/classes/NativeExtensionManager.xml index 10c9e32cf2..7d6eefa94f 100644 --- a/doc/classes/NativeExtensionManager.xml +++ b/doc/classes/NativeExtensionManager.xml @@ -9,7 +9,7 @@ <methods> <method name="get_extension"> <return type="NativeExtension" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> @@ -20,25 +20,25 @@ </method> <method name="is_extension_loaded" qualifiers="const"> <return type="bool" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> <method name="load_extension"> <return type="int" enum="NativeExtensionManager.LoadStatus" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> <method name="reload_extension"> <return type="int" enum="NativeExtensionManager.LoadStatus" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> <method name="unload_extension"> <return type="int" enum="NativeExtensionManager.LoadStatus" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index 058f1032cb..c2b57404dc 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -36,7 +36,7 @@ </method> <method name="get_navigation_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -85,29 +85,29 @@ </method> <method name="set_navigation_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_navigation_map"> <return type="void" /> - <argument index="0" name="navigation_map" type="RID" /> + <param index="0" name="navigation_map" type="RID" /> <description> Sets the [RID] of the navigation map this NavigationAgent node should use and also updates the [code]agent[/code] on the NavigationServer. </description> </method> <method name="set_target_location"> <return type="void" /> - <argument index="0" name="location" type="Vector2" /> + <param index="0" name="location" type="Vector2" /> <description> Sets the user desired final location. This will clear the current navigation path. </description> </method> <method name="set_velocity"> <return type="void" /> - <argument index="0" name="velocity" type="Vector2" /> + <param index="0" name="velocity" type="Vector2" /> <description> Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the [signal velocity_computed] signal. </description> @@ -163,7 +163,7 @@ </description> </signal> <signal name="velocity_computed"> - <argument index="0" name="safe_velocity" type="Vector3" /> + <param index="0" name="safe_velocity" type="Vector3" /> <description> Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. </description> diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index c689ddc345..d4221240ba 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -36,7 +36,7 @@ </method> <method name="get_navigation_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -85,29 +85,29 @@ </method> <method name="set_navigation_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_navigation_map"> <return type="void" /> - <argument index="0" name="navigation_map" type="RID" /> + <param index="0" name="navigation_map" type="RID" /> <description> Sets the [RID] of the navigation map this NavigationAgent node should use and also updates the [code]agent[/code] on the NavigationServer. </description> </method> <method name="set_target_location"> <return type="void" /> - <argument index="0" name="location" type="Vector3" /> + <param index="0" name="location" type="Vector3" /> <description> Sets the user desired final location. This will clear the current navigation path. </description> </method> <method name="set_velocity"> <return type="void" /> - <argument index="0" name="velocity" type="Vector3" /> + <param index="0" name="velocity" type="Vector3" /> <description> Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the [signal velocity_computed] signal. </description> @@ -169,7 +169,7 @@ </description> </signal> <signal name="velocity_computed"> - <argument index="0" name="safe_velocity" type="Vector3" /> + <param index="0" name="safe_velocity" type="Vector3" /> <description> Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. </description> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 33d2535ca2..cef23699c8 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -12,7 +12,7 @@ <methods> <method name="add_polygon"> <return type="void" /> - <argument index="0" name="polygon" type="PackedInt32Array" /> + <param index="0" name="polygon" type="PackedInt32Array" /> <description> Adds a polygon using the indices of the vertices you get when calling [method get_vertices]. </description> @@ -25,7 +25,7 @@ </method> <method name="create_from_mesh"> <return type="void" /> - <argument index="0" name="mesh" type="Mesh" /> + <param index="0" name="mesh" type="Mesh" /> <description> Initializes the navigation mesh by setting the vertices and indices according to a [Mesh]. [b]Note:[/b] The given [code]mesh[/code] must be of type [constant Mesh.PRIMITIVE_TRIANGLES] and have an index array. @@ -33,14 +33,14 @@ </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member geometry_collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="get_polygon"> <return type="PackedInt32Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon. </description> @@ -59,15 +59,15 @@ </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member geometry_collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_vertices"> <return type="void" /> - <argument index="0" name="vertices" type="PackedVector3Array" /> + <param index="0" name="vertices" type="PackedVector3Array" /> <description> Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method. </description> diff --git a/doc/classes/NavigationMeshGenerator.xml b/doc/classes/NavigationMeshGenerator.xml index 612ce54d34..30d068b55c 100644 --- a/doc/classes/NavigationMeshGenerator.xml +++ b/doc/classes/NavigationMeshGenerator.xml @@ -15,15 +15,15 @@ <methods> <method name="bake"> <return type="void" /> - <argument index="0" name="nav_mesh" type="NavigationMesh" /> - <argument index="1" name="root_node" type="Node" /> + <param index="0" name="nav_mesh" type="NavigationMesh" /> + <param index="1" name="root_node" type="Node" /> <description> Bakes navigation data to the provided [code]nav_mesh[/code] by parsing child nodes under the provided [code]root_node[/code] or a specific group of nodes for potential source geometry. The parse behavior can be controlled with the [member NavigationMesh.geometry_parsed_geometry_type] and [member NavigationMesh.geometry_source_geometry_mode] properties on the [NavigationMesh] resource. </description> </method> <method name="clear"> <return type="void" /> - <argument index="0" name="nav_mesh" type="NavigationMesh" /> + <param index="0" name="nav_mesh" type="NavigationMesh" /> <description> Removes all polygons and vertices from the provided [code]nav_mesh[/code] resource. </description> diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 0a2ceeedc5..19466c171f 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -48,22 +48,22 @@ <methods> <method name="add_outline"> <return type="void" /> - <argument index="0" name="outline" type="PackedVector2Array" /> + <param index="0" name="outline" type="PackedVector2Array" /> <description> Appends a [PackedVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use. </description> </method> <method name="add_outline_at_index"> <return type="void" /> - <argument index="0" name="outline" type="PackedVector2Array" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="outline" type="PackedVector2Array" /> + <param index="1" name="index" type="int" /> <description> Adds a [PackedVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use. </description> </method> <method name="add_polygon"> <return type="void" /> - <argument index="0" name="polygon" type="PackedInt32Array" /> + <param index="0" name="polygon" type="PackedInt32Array" /> <description> Adds a polygon using the indices of the vertices you get when calling [method get_vertices]. </description> @@ -88,7 +88,7 @@ </method> <method name="get_outline" qualifiers="const"> <return type="PackedVector2Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns a [PackedVector2Array] containing the vertices of an outline that was created in the editor or by script. </description> @@ -101,7 +101,7 @@ </method> <method name="get_polygon"> <return type="PackedInt32Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon. </description> @@ -126,22 +126,22 @@ </method> <method name="remove_outline"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Removes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. </description> </method> <method name="set_outline"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="outline" type="PackedVector2Array" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="outline" type="PackedVector2Array" /> <description> Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. </description> </method> <method name="set_vertices"> <return type="void" /> - <argument index="0" name="vertices" type="PackedVector2Array" /> + <param index="0" name="vertices" type="PackedVector2Array" /> <description> Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method. </description> diff --git a/doc/classes/NavigationRegion2D.xml b/doc/classes/NavigationRegion2D.xml index 75b6544827..655d51b25c 100644 --- a/doc/classes/NavigationRegion2D.xml +++ b/doc/classes/NavigationRegion2D.xml @@ -16,7 +16,7 @@ <methods> <method name="get_navigation_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -29,8 +29,8 @@ </method> <method name="set_navigation_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/doc/classes/NavigationRegion3D.xml b/doc/classes/NavigationRegion3D.xml index f5824a24fd..927b2ba5e5 100644 --- a/doc/classes/NavigationRegion3D.xml +++ b/doc/classes/NavigationRegion3D.xml @@ -16,14 +16,14 @@ <methods> <method name="bake_navigation_mesh"> <return type="void" /> - <argument index="0" name="on_thread" type="bool" default="true" /> + <param index="0" name="on_thread" type="bool" default="true" /> <description> Bakes the [NavigationMesh]. If [code]on_thread[/code] is set to [code]true[/code] (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new [NavigationMesh]. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization. Also, please note that baking on a separate thread is automatically disabled on operating systems that cannot use threads (such as HTML5 with threads disabled). </description> </method> <method name="get_navigation_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -36,8 +36,8 @@ </method> <method name="set_navigation_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index 36379d2531..8469099b80 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -25,24 +25,24 @@ </method> <method name="agent_get_map" qualifiers="const"> <return type="RID" /> - <argument index="0" name="agent" type="RID" /> + <param index="0" name="agent" type="RID" /> <description> Returns the navigation map [RID] the requested [code]agent[/code] is currently assigned to. </description> </method> <method name="agent_is_map_changed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="agent" type="RID" /> + <param index="0" name="agent" type="RID" /> <description> Returns true if the map got changed the previous frame. </description> </method> <method name="agent_set_callback" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="receiver" type="Object" /> - <argument index="2" name="method" type="StringName" /> - <argument index="3" name="userdata" type="Variant" default="null" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="receiver" type="Object" /> + <param index="2" name="method" type="StringName" /> + <param index="3" name="userdata" type="Variant" default="null" /> <description> Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated [code]safe_velocity[/code] to the [code]receiver[/code] object with a signal to the chosen [code]method[/code] name. [b]Note:[/b] Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use [method agent_set_callback] again with a [code]null[/code] object as the [code]receiver[/code]. @@ -50,79 +50,79 @@ </method> <method name="agent_set_map" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="map" type="RID" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="map" type="RID" /> <description> Puts the agent in the map. </description> </method> <method name="agent_set_max_neighbors" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="count" type="int" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="count" type="int" /> <description> Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. </description> </method> <method name="agent_set_max_speed" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="max_speed" type="float" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="max_speed" type="float" /> <description> Sets the maximum speed of the agent. Must be positive. </description> </method> <method name="agent_set_neighbor_dist" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="dist" type="float" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="dist" type="float" /> <description> Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. </description> </method> <method name="agent_set_position" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="position" type="Vector2" /> <description> Sets the position of the agent in world space. </description> </method> <method name="agent_set_radius" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="radius" type="float" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="radius" type="float" /> <description> Sets the radius of the agent. </description> </method> <method name="agent_set_target_velocity" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="target_velocity" type="Vector2" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="target_velocity" type="Vector2" /> <description> Sets the new target velocity. </description> </method> <method name="agent_set_time_horizon" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="time" type="float" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="time" type="float" /> <description> The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. Must be positive. </description> </method> <method name="agent_set_velocity" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="velocity" type="Vector2" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="velocity" type="Vector2" /> <description> Sets the current velocity of the agent. </description> </method> <method name="free_rid" qualifiers="const"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Destroys the given RID. </description> @@ -141,7 +141,7 @@ </method> <method name="map_force_update"> <return type="void" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> This function immediately forces synchronization of the specified navigation [code]map[/code] [RID]. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. @@ -151,86 +151,86 @@ </method> <method name="map_get_agents" qualifiers="const"> <return type="Array" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code]. </description> </method> <method name="map_get_cell_size" qualifiers="const"> <return type="float" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns the map cell size. </description> </method> <method name="map_get_closest_point" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="to_point" type="Vector2" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="to_point" type="Vector2" /> <description> Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface. </description> </method> <method name="map_get_closest_point_owner" qualifiers="const"> <return type="RID" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="to_point" type="Vector2" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="to_point" type="Vector2" /> <description> Returns the owner region RID for the point returned by [method map_get_closest_point]. </description> </method> <method name="map_get_edge_connection_margin" qualifiers="const"> <return type="float" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions. </description> </method> <method name="map_get_path" qualifiers="const"> <return type="PackedVector2Array" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="origin" type="Vector2" /> - <argument index="2" name="destination" type="Vector2" /> - <argument index="3" name="optimize" type="bool" /> - <argument index="4" name="navigation_layers" type="int" default="1" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="origin" type="Vector2" /> + <param index="2" name="destination" type="Vector2" /> + <param index="3" name="optimize" type="bool" /> + <param index="4" name="navigation_layers" type="int" default="1" /> <description> Returns the navigation path to reach the destination from the origin. [code]navigation_layers[/code] is a bitmask of all region navigation layers that are allowed to be in the path. </description> </method> <method name="map_get_regions" qualifiers="const"> <return type="Array" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns all navigation regions [RID]s that are currently assigned to the requested navigation [code]map[/code]. </description> </method> <method name="map_is_active" qualifiers="const"> <return type="bool" /> - <argument index="0" name="nap" type="RID" /> + <param index="0" name="nap" type="RID" /> <description> Returns true if the map is active. </description> </method> <method name="map_set_active" qualifiers="const"> <return type="void" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="active" type="bool" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="active" type="bool" /> <description> Sets the map active. </description> </method> <method name="map_set_cell_size" qualifiers="const"> <return type="void" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="cell_size" type="float" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="cell_size" type="float" /> <description> Set the map cell size used to weld the navigation mesh polygons. </description> </method> <method name="map_set_edge_connection_margin" qualifiers="const"> <return type="void" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="margin" type="float" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="margin" type="float" /> <description> Set the map edge connection margin used to weld the compatible region edges. </description> @@ -243,59 +243,59 @@ </method> <method name="region_get_connection_pathway_end" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="connection" type="int" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="connection" type="int" /> <description> Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. </description> </method> <method name="region_get_connection_pathway_start" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="connection" type="int" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="connection" type="int" /> <description> Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. </description> </method> <method name="region_get_connections_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns how many connections this [code]region[/code] has with other regions in the map. </description> </method> <method name="region_get_enter_cost" qualifiers="const"> <return type="float" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns the [code]enter_cost[/code] of this [code]region[/code]. </description> </method> <method name="region_get_map" qualifiers="const"> <return type="RID" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to. </description> </method> <method name="region_get_navigation_layers" qualifiers="const"> <return type="int" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns the region's navigation layers. </description> </method> <method name="region_get_travel_cost" qualifiers="const"> <return type="float" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns the [code]travel_cost[/code] of this [code]region[/code]. </description> </method> <method name="region_owns_point" qualifiers="const"> <return type="bool" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="point" type="Vector2" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="point" type="Vector2" /> <description> Returns [code]true[/code] if the provided [code]point[/code] in world space is currently owned by the provided navigation [code]region[/code]. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. If multiple navigation meshes have positions at equal distance the navigation region whose polygons are processed first wins the ownership. Polygons are processed in the same order that navigation regions were registered on the NavigationServer. @@ -304,48 +304,48 @@ </method> <method name="region_set_enter_cost" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="enter_cost" type="float" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="enter_cost" type="float" /> <description> Sets the [code]enter_cost[/code] for this [code]region[/code]. </description> </method> <method name="region_set_map" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="map" type="RID" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="map" type="RID" /> <description> Sets the map for the region. </description> </method> <method name="region_set_navigation_layers" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="navigation_layers" type="int" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="navigation_layers" type="int" /> <description> Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]). </description> </method> <method name="region_set_navpoly" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="nav_poly" type="NavigationPolygon" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="nav_poly" type="NavigationPolygon" /> <description> Sets the navigation mesh for the region. </description> </method> <method name="region_set_transform" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets the global transformation for the region. </description> </method> <method name="region_set_travel_cost" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="travel_cost" type="float" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="travel_cost" type="float" /> <description> Sets the [code]travel_cost[/code] for this [code]region[/code]. </description> @@ -353,7 +353,7 @@ </methods> <signals> <signal name="map_changed"> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Emitted when a navigation map is updated, when a region moves or is modified. </description> diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 8600c2643a..f9dfd01c41 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -25,24 +25,24 @@ </method> <method name="agent_get_map" qualifiers="const"> <return type="RID" /> - <argument index="0" name="agent" type="RID" /> + <param index="0" name="agent" type="RID" /> <description> Returns the navigation map [RID] the requested [code]agent[/code] is currently assigned to. </description> </method> <method name="agent_is_map_changed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="agent" type="RID" /> + <param index="0" name="agent" type="RID" /> <description> Returns true if the map got changed the previous frame. </description> </method> <method name="agent_set_callback" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="receiver" type="Object" /> - <argument index="2" name="method" type="StringName" /> - <argument index="3" name="userdata" type="Variant" default="null" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="receiver" type="Object" /> + <param index="2" name="method" type="StringName" /> + <param index="3" name="userdata" type="Variant" default="null" /> <description> Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated [code]safe_velocity[/code] to the [code]receiver[/code] object with a signal to the chosen [code]method[/code] name. [b]Note:[/b] Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use [method agent_set_callback] again with a [code]null[/code] object as the [code]receiver[/code]. @@ -50,79 +50,79 @@ </method> <method name="agent_set_map" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="map" type="RID" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="map" type="RID" /> <description> Puts the agent in the map. </description> </method> <method name="agent_set_max_neighbors" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="count" type="int" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="count" type="int" /> <description> Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. </description> </method> <method name="agent_set_max_speed" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="max_speed" type="float" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="max_speed" type="float" /> <description> Sets the maximum speed of the agent. Must be positive. </description> </method> <method name="agent_set_neighbor_dist" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="dist" type="float" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="dist" type="float" /> <description> Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. </description> </method> <method name="agent_set_position" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="position" type="Vector3" /> <description> Sets the position of the agent in world space. </description> </method> <method name="agent_set_radius" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="radius" type="float" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="radius" type="float" /> <description> Sets the radius of the agent. </description> </method> <method name="agent_set_target_velocity" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="target_velocity" type="Vector3" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="target_velocity" type="Vector3" /> <description> Sets the new target velocity. </description> </method> <method name="agent_set_time_horizon" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="time" type="float" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="time" type="float" /> <description> The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. Must be positive. </description> </method> <method name="agent_set_velocity" qualifiers="const"> <return type="void" /> - <argument index="0" name="agent" type="RID" /> - <argument index="1" name="velocity" type="Vector3" /> + <param index="0" name="agent" type="RID" /> + <param index="1" name="velocity" type="Vector3" /> <description> Sets the current velocity of the agent. </description> </method> <method name="free_rid" qualifiers="const"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Destroys the given RID. </description> @@ -141,7 +141,7 @@ </method> <method name="map_force_update"> <return type="void" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> This function immediately forces synchronization of the specified navigation [code]map[/code] [RID]. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. @@ -151,126 +151,126 @@ </method> <method name="map_get_agents" qualifiers="const"> <return type="Array" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code]. </description> </method> <method name="map_get_cell_size" qualifiers="const"> <return type="float" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns the map cell size. </description> </method> <method name="map_get_closest_point" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="to_point" type="Vector3" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="to_point" type="Vector3" /> <description> Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. </description> </method> <method name="map_get_closest_point_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="to_point" type="Vector3" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="to_point" type="Vector3" /> <description> Returns the normal for the point returned by [method map_get_closest_point]. </description> </method> <method name="map_get_closest_point_owner" qualifiers="const"> <return type="RID" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="to_point" type="Vector3" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="to_point" type="Vector3" /> <description> Returns the owner region RID for the point returned by [method map_get_closest_point]. </description> </method> <method name="map_get_closest_point_to_segment" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="start" type="Vector3" /> - <argument index="2" name="end" type="Vector3" /> - <argument index="3" name="use_collision" type="bool" default="false" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="start" type="Vector3" /> + <param index="2" name="end" type="Vector3" /> + <param index="3" name="use_collision" type="bool" default="false" /> <description> Returns the closest point between the navigation surface and the segment. </description> </method> <method name="map_get_edge_connection_margin" qualifiers="const"> <return type="float" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different regions. </description> </method> <method name="map_get_path" qualifiers="const"> <return type="PackedVector3Array" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="origin" type="Vector3" /> - <argument index="2" name="destination" type="Vector3" /> - <argument index="3" name="optimize" type="bool" /> - <argument index="4" name="navigation_layers" type="int" default="1" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="origin" type="Vector3" /> + <param index="2" name="destination" type="Vector3" /> + <param index="3" name="optimize" type="bool" /> + <param index="4" name="navigation_layers" type="int" default="1" /> <description> Returns the navigation path to reach the destination from the origin. [code]navigation_layers[/code] is a bitmask of all region navigation layers that are allowed to be in the path. </description> </method> <method name="map_get_regions" qualifiers="const"> <return type="Array" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns all navigation regions [RID]s that are currently assigned to the requested navigation [code]map[/code]. </description> </method> <method name="map_get_up" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Returns the map's up direction. </description> </method> <method name="map_is_active" qualifiers="const"> <return type="bool" /> - <argument index="0" name="nap" type="RID" /> + <param index="0" name="nap" type="RID" /> <description> Returns true if the map is active. </description> </method> <method name="map_set_active" qualifiers="const"> <return type="void" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="active" type="bool" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="active" type="bool" /> <description> Sets the map active. </description> </method> <method name="map_set_cell_size" qualifiers="const"> <return type="void" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="cell_size" type="float" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="cell_size" type="float" /> <description> Set the map cell size used to weld the navigation mesh polygons. </description> </method> <method name="map_set_edge_connection_margin" qualifiers="const"> <return type="void" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="margin" type="float" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="margin" type="float" /> <description> Set the map edge connection margin used to weld the compatible region edges. </description> </method> <method name="map_set_up" qualifiers="const"> <return type="void" /> - <argument index="0" name="map" type="RID" /> - <argument index="1" name="up" type="Vector3" /> + <param index="0" name="map" type="RID" /> + <param index="1" name="up" type="Vector3" /> <description> Sets the map up direction. </description> </method> <method name="process"> <return type="void" /> - <argument index="0" name="delta_time" type="float" /> + <param index="0" name="delta_time" type="float" /> <description> Process the collision avoidance agents. The result of this process is needed by the physics server, so this must be called in the main thread. @@ -279,8 +279,8 @@ </method> <method name="region_bake_navmesh" qualifiers="const"> <return type="void" /> - <argument index="0" name="mesh" type="NavigationMesh" /> - <argument index="1" name="node" type="Node" /> + <param index="0" name="mesh" type="NavigationMesh" /> + <param index="1" name="node" type="Node" /> <description> Bakes the navigation mesh. </description> @@ -293,59 +293,59 @@ </method> <method name="region_get_connection_pathway_end" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="connection" type="int" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="connection" type="int" /> <description> Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. </description> </method> <method name="region_get_connection_pathway_start" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="connection" type="int" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="connection" type="int" /> <description> Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. </description> </method> <method name="region_get_connections_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns how many connections this [code]region[/code] has with other regions in the map. </description> </method> <method name="region_get_enter_cost" qualifiers="const"> <return type="float" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns the [code]enter_cost[/code] of this [code]region[/code]. </description> </method> <method name="region_get_map" qualifiers="const"> <return type="RID" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to. </description> </method> <method name="region_get_navigation_layers" qualifiers="const"> <return type="int" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns the region's navigation layers. </description> </method> <method name="region_get_travel_cost" qualifiers="const"> <return type="float" /> - <argument index="0" name="region" type="RID" /> + <param index="0" name="region" type="RID" /> <description> Returns the [code]travel_cost[/code] of this [code]region[/code]. </description> </method> <method name="region_owns_point" qualifiers="const"> <return type="bool" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="point" type="Vector3" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="point" type="Vector3" /> <description> Returns [code]true[/code] if the provided [code]point[/code] in world space is currently owned by the provided navigation [code]region[/code]. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. If multiple navigation meshes have positions at equal distance the navigation region whose polygons are processed first wins the ownership. Polygons are processed in the same order that navigation regions were registered on the NavigationServer. @@ -354,55 +354,55 @@ </method> <method name="region_set_enter_cost" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="enter_cost" type="float" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="enter_cost" type="float" /> <description> Sets the [code]enter_cost[/code] for this [code]region[/code]. </description> </method> <method name="region_set_map" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="map" type="RID" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="map" type="RID" /> <description> Sets the map for the region. </description> </method> <method name="region_set_navigation_layers" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="navigation_layers" type="int" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="navigation_layers" type="int" /> <description> Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer3D.map_get_path]). </description> </method> <method name="region_set_navmesh" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="nav_mesh" type="NavigationMesh" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="nav_mesh" type="NavigationMesh" /> <description> Sets the navigation mesh for the region. </description> </method> <method name="region_set_transform" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> <description> Sets the global transformation for the region. </description> </method> <method name="region_set_travel_cost" qualifiers="const"> <return type="void" /> - <argument index="0" name="region" type="RID" /> - <argument index="1" name="travel_cost" type="float" /> + <param index="0" name="region" type="RID" /> + <param index="1" name="travel_cost" type="float" /> <description> Sets the [code]travel_cost[/code] for this [code]region[/code]. </description> </method> <method name="set_active" qualifiers="const"> <return type="void" /> - <argument index="0" name="active" type="bool" /> + <param index="0" name="active" type="bool" /> <description> Control activation of this server. </description> @@ -410,7 +410,7 @@ </methods> <signals> <signal name="map_changed"> - <argument index="0" name="map" type="RID" /> + <param index="0" name="map" type="RID" /> <description> Emitted when a navigation map is updated, when a region moves or is modified. </description> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 863686926a..d84509ca8f 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -11,15 +11,15 @@ <methods> <method name="get_patch_margin" qualifiers="const"> <return type="int" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the size of the margin on the specified [enum Side]. </description> </method> <method name="set_patch_margin"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="value" type="int" /> <description> Sets the size of the margin on the specified [enum Side] to [code]value[/code] pixels. </description> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 8cc8498609..1436123e94 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -46,7 +46,7 @@ </method> <method name="_input" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Called when there is an input event. The input event propagates up through the node tree until a node consumes it. It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_input]. @@ -57,7 +57,7 @@ </method> <method name="_physics_process" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant. [code]delta[/code] is in seconds. It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_physics_process]. @@ -67,7 +67,7 @@ </method> <method name="_process" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. [code]delta[/code] is in seconds. It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process]. @@ -86,7 +86,7 @@ </method> <method name="_shortcut_input" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Called when an [InputEventKey] or [InputEventShortcut] hasn't been consumed by [method _input] or any GUI [Control] item. The input event propagates up through the node tree until a node consumes it. It is only called if shortcut processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_shortcut_input]. @@ -97,7 +97,7 @@ </method> <method name="_unhandled_input" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Called when an [InputEvent] hasn't been consumed by [method _input] or any GUI [Control] item. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_input]. @@ -108,7 +108,7 @@ </method> <method name="_unhandled_key_input" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Called when an [InputEventKey] or [InputEventShortcut] hasn't been consumed by [method _input] or any GUI [Control] item. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_key_input]. @@ -120,9 +120,9 @@ </method> <method name="add_child"> <return type="void" /> - <argument index="0" name="node" type="Node" /> - <argument index="1" name="legible_unique_name" type="bool" default="false" /> - <argument index="2" name="internal" type="int" enum="Node.InternalMode" default="0" /> + <param index="0" name="node" type="Node" /> + <param index="1" name="legible_unique_name" type="bool" default="false" /> + <param index="2" name="internal" type="int" enum="Node.InternalMode" default="0" /> <description> Adds a child node. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have a human-readable name based on the name of the node being instantiated instead of its type. @@ -150,8 +150,8 @@ </method> <method name="add_sibling"> <return type="void" /> - <argument index="0" name="sibling" type="Node" /> - <argument index="1" name="legible_unique_name" type="bool" default="false" /> + <param index="0" name="sibling" type="Node" /> + <param index="1" name="legible_unique_name" type="bool" default="false" /> <description> Adds a [code]sibling[/code] node to current's node parent, at the same level as that node, right below it. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have a human-readable name based on the name of the node being instantiated instead of its type. @@ -161,8 +161,8 @@ </method> <method name="add_to_group"> <return type="void" /> - <argument index="0" name="group" type="StringName" /> - <argument index="1" name="persistent" type="bool" default="false" /> + <param index="0" name="group" type="StringName" /> + <param index="1" name="persistent" type="bool" default="false" /> <description> Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see [method is_inside_tree]). See notes in the description, and the group methods in [SceneTree]. The [code]persistent[/code] option is used when packing node to [PackedScene] and saving to file. Non-persistent groups aren't stored. @@ -186,7 +186,7 @@ </method> <method name="duplicate" qualifiers="const"> <return type="Node" /> - <argument index="0" name="flags" type="int" default="15" /> + <param index="0" name="flags" type="int" default="15" /> <description> Duplicates the node, returning a new node. You can fine-tune the behavior using the [code]flags[/code] (see [enum DuplicateFlags]). @@ -195,9 +195,9 @@ </method> <method name="find_child" qualifiers="const"> <return type="Node" /> - <argument index="0" name="pattern" type="String" /> - <argument index="1" name="recursive" type="bool" default="true" /> - <argument index="2" name="owned" type="bool" default="true" /> + <param index="0" name="pattern" type="String" /> + <param index="1" name="recursive" type="bool" default="true" /> + <param index="2" name="owned" type="bool" default="true" /> <description> Finds the first descendant of this node whose name matches [code]pattern[/code] as in [method String.match]. [code]pattern[/code] does not match against the full path, just against individual node names. It is case-sensitive, with [code]"*"[/code] matching zero or more characters and [code]"?"[/code] matching any single character except [code]"."[/code]). @@ -210,10 +210,10 @@ </method> <method name="find_children" qualifiers="const"> <return type="Node[]" /> - <argument index="0" name="pattern" type="String" /> - <argument index="1" name="type" type="String" default="""" /> - <argument index="2" name="recursive" type="bool" default="true" /> - <argument index="3" name="owned" type="bool" default="true" /> + <param index="0" name="pattern" type="String" /> + <param index="1" name="type" type="String" default="""" /> + <param index="2" name="recursive" type="bool" default="true" /> + <param index="3" name="owned" type="bool" default="true" /> <description> Finds descendants of this node whose name matches [code]pattern[/code] as in [method String.match], and/or type matches [code]type[/code] as in [method Object.is_class]. [code]pattern[/code] does not match against the full path, just against individual node names. It is case-sensitive, with [code]"*"[/code] matching zero or more characters and [code]"?"[/code] matching any single character except [code]"."[/code]). @@ -227,7 +227,7 @@ </method> <method name="find_parent" qualifiers="const"> <return type="Node" /> - <argument index="0" name="pattern" type="String" /> + <param index="0" name="pattern" type="String" /> <description> Finds the first parent of the current node whose name matches [code]pattern[/code] as in [method String.match]. [code]pattern[/code] does not match against the full path, just against individual node names. It is case-sensitive, with [code]"*"[/code] matching zero or more characters and [code]"?"[/code] matching any single character except [code]"."[/code]). @@ -236,8 +236,8 @@ </method> <method name="get_child" qualifiers="const"> <return type="Node" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="include_internal" type="bool" default="false" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="include_internal" type="bool" default="false" /> <description> Returns a child node by its index (see [method get_child_count]). This method is often used for iterating all children of a node. Negative indices access the children from the last one. @@ -247,7 +247,7 @@ </method> <method name="get_child_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="include_internal" type="bool" default="false" /> + <param index="0" name="include_internal" type="bool" default="false" /> <description> Returns the number of child nodes. If [code]include_internal[/code] is [code]false[/code], internal children aren't counted (see [code]internal[/code] parameter in [method add_child]). @@ -255,7 +255,7 @@ </method> <method name="get_children" qualifiers="const"> <return type="Node[]" /> - <argument index="0" name="include_internal" type="bool" default="false" /> + <param index="0" name="include_internal" type="bool" default="false" /> <description> Returns an array of references to node's children. If [code]include_internal[/code] is [code]false[/code], the returned array won't include internal children (see [code]internal[/code] parameter in [method add_child]). @@ -278,7 +278,7 @@ </method> <method name="get_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="include_internal" type="bool" default="false" /> + <param index="0" name="include_internal" type="bool" default="false" /> <description> Returns the node's order in the scene tree branch. For example, if called on the first child node the position is [code]0[/code]. If [code]include_internal[/code] is [code]false[/code], the index won't take internal children into account, i.e. first non-internal child will have index of 0 (see [code]internal[/code] parameter in [method add_child]). @@ -292,7 +292,7 @@ </method> <method name="get_node" qualifiers="const"> <return type="Node" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, [code]null[/code] is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call <method> on a null instance." error. [b]Note:[/b] Fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). @@ -326,7 +326,7 @@ </method> <method name="get_node_and_resource"> <return type="Array" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Fetches a node and one of its resources as specified by the [NodePath]'s subname (e.g. [code]Area2D/CollisionShape2D:shape[/code]). If several nested resources are specified in the [NodePath], the last one will be fetched. The return value is an array of size 3: the first index points to the [Node] (or [code]null[/code] if not found), the second index points to the [Resource] (or [code]null[/code] if not found), and the third index is the remaining [NodePath], if any. @@ -347,7 +347,7 @@ </method> <method name="get_node_or_null" qualifiers="const"> <return type="Node" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Similar to [method get_node], but does not log an error if [code]path[/code] does not point to a valid [Node]. </description> @@ -366,7 +366,7 @@ </method> <method name="get_path_to" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Returns the relative [NodePath] from this node to the specified [code]node[/code]. Both nodes must be in the same scene or the function will fail. </description> @@ -403,21 +403,21 @@ </method> <method name="has_node" qualifiers="const"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns [code]true[/code] if the node that the [NodePath] points to exists. </description> </method> <method name="has_node_and_resource" qualifiers="const"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns [code]true[/code] if the [NodePath] points to a valid node and its subname points to a valid resource, e.g. [code]Area2D/CollisionShape2D:shape[/code]. Properties with a non-[Resource] type (e.g. nodes or primitive math types) are not considered resources. </description> </method> <method name="is_ancestor_of" qualifiers="const"> <return type="bool" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Returns [code]true[/code] if the given node is a direct or indirect child of the current node. </description> @@ -430,21 +430,21 @@ </method> <method name="is_editable_instance" qualifiers="const"> <return type="bool" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Returns [code]true[/code] if [code]node[/code] has editable children enabled relative to this node. This method is only intended for use with editor tooling. </description> </method> <method name="is_greater_than" qualifiers="const"> <return type="bool" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Returns [code]true[/code] if the given node occurs later in the scene hierarchy than the current node. </description> </method> <method name="is_in_group" qualifiers="const"> <return type="bool" /> - <argument index="0" name="group" type="StringName" /> + <param index="0" name="group" type="StringName" /> <description> Returns [code]true[/code] if this node is in the specified group. See notes in the description, and the group methods in [SceneTree]. </description> @@ -511,8 +511,8 @@ </method> <method name="move_child"> <return type="void" /> - <argument index="0" name="child_node" type="Node" /> - <argument index="1" name="to_position" type="int" /> + <param index="0" name="child_node" type="Node" /> + <param index="1" name="to_position" type="int" /> <description> Moves a child node to a different position (order) among the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. [b]Note:[/b] Internal children can only be moved within their expected "internal range" (see [code]internal[/code] parameter in [method add_child]). @@ -557,16 +557,16 @@ </method> <method name="propagate_call"> <return type="void" /> - <argument index="0" name="method" type="StringName" /> - <argument index="1" name="args" type="Array" default="[]" /> - <argument index="2" name="parent_first" type="bool" default="false" /> + <param index="0" name="method" type="StringName" /> + <param index="1" name="args" type="Array" default="[]" /> + <param index="2" name="parent_first" type="bool" default="false" /> <description> Calls the given method (if present) with the arguments given in [code]args[/code] on this node and recursively on all its children. If the [code]parent_first[/code] argument is [code]true[/code], the method will be called on the current node first, then on all its children. If [code]parent_first[/code] is [code]false[/code], the children will be called first. </description> </method> <method name="propagate_notification"> <return type="void" /> - <argument index="0" name="what" type="int" /> + <param index="0" name="what" type="int" /> <description> Notifies the current node and all its children recursively by calling [method Object.notification] on all of them. </description> @@ -591,7 +591,7 @@ </method> <method name="remove_child"> <return type="void" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Removes a child node. The node is NOT deleted and must be deleted manually. [b]Note:[/b] This function may set the [member owner] of the removed Node (or its descendants) to be [code]null[/code], if that [member owner] is no longer a parent or ancestor. @@ -599,15 +599,15 @@ </method> <method name="remove_from_group"> <return type="void" /> - <argument index="0" name="group" type="StringName" /> + <param index="0" name="group" type="StringName" /> <description> Removes a node from a group. See notes in the description, and the group methods in [SceneTree]. </description> </method> <method name="replace_by"> <return type="void" /> - <argument index="0" name="node" type="Node" /> - <argument index="1" name="keep_groups" type="bool" default="false" /> + <param index="0" name="node" type="Node" /> + <param index="1" name="keep_groups" type="bool" default="false" /> <description> Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. If [code]keep_groups[/code] is [code]true[/code], the [code]node[/code] is added to the same groups that the replaced node is in. @@ -623,7 +623,7 @@ </method> <method name="rpc" qualifiers="vararg"> <return type="int" enum="Error" /> - <argument index="0" name="method" type="StringName" /> + <param index="0" name="method" type="StringName" /> <description> Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. Returns [code]null[/code]. [b]Note:[/b] You can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [MultiplayerAPI]. You also need to keep track of the connection state, either by the [MultiplayerAPI] signals like [code]server_disconnected[/code] or by checking [code]get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED[/code]. @@ -631,8 +631,8 @@ </method> <method name="rpc_config"> <return type="void" /> - <argument index="0" name="method" type="StringName" /> - <argument index="1" name="config" type="Variant" /> + <param index="0" name="method" type="StringName" /> + <param index="1" name="config" type="Variant" /> <description> Changes the RPC mode for the given [code]method[/code] with the given [code]config[/code] which should be [code]null[/code] (to disable) or a [Dictionary] in the form: [codeblock] @@ -648,45 +648,45 @@ </method> <method name="rpc_id" qualifiers="vararg"> <return type="int" enum="Error" /> - <argument index="0" name="peer_id" type="int" /> - <argument index="1" name="method" type="StringName" /> + <param index="0" name="peer_id" type="int" /> + <param index="1" name="method" type="StringName" /> <description> Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method MultiplayerPeer.set_target_peer]). Returns [code]null[/code]. </description> </method> <method name="set_display_folded"> <return type="void" /> - <argument index="0" name="fold" type="bool" /> + <param index="0" name="fold" type="bool" /> <description> Sets the folded state of the node in the Scene dock. This method is only intended for use with editor tooling. </description> </method> <method name="set_editable_instance"> <return type="void" /> - <argument index="0" name="node" type="Node" /> - <argument index="1" name="is_editable" type="bool" /> + <param index="0" name="node" type="Node" /> + <param index="1" name="is_editable" type="bool" /> <description> Sets the editable children state of [code]node[/code] relative to this node. This method is only intended for use with editor tooling. </description> </method> <method name="set_multiplayer_authority"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="recursive" type="bool" default="true" /> + <param index="0" name="id" type="int" /> + <param index="1" name="recursive" type="bool" default="true" /> <description> Sets the node's multiplayer authority to the peer with the given peer ID. The multiplayer authority is the peer that has authority over the node on the network. Useful in conjunction with [method rpc_config] and the [MultiplayerAPI]. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). If [code]recursive[/code], the given peer is recursively set as the authority for all children of this node. </description> </method> <method name="set_physics_process"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a [constant NOTIFICATION_PHYSICS_PROCESS] at a fixed (usually 60 FPS, see [member Engine.physics_ticks_per_second] to change) interval (and the [method _physics_process] callback will be called if exists). Enabled automatically if [method _physics_process] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_physics_process_internal"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal [method _physics_process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting ([method set_physics_process]). Only useful for advanced uses to manipulate built-in nodes' behavior. [b]Warning:[/b] Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported. @@ -694,21 +694,21 @@ </method> <method name="set_process"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables or disables processing. When a node is being processed, it will receive a [constant NOTIFICATION_PROCESS] on every drawn frame (and the [method _process] callback will be called if exists). Enabled automatically if [method _process] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_input"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables or disables input processing. This is not required for GUI controls! Enabled automatically if [method _input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_internal"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal [method _process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting ([method set_process]). Only useful for advanced uses to manipulate built-in nodes' behavior. [b]Warning:[/b] Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported. @@ -716,28 +716,28 @@ </method> <method name="set_process_shortcut_input"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables shortcut processing. Enabled automatically if [method _shortcut_input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_unhandled_input"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a [Control]). Enabled automatically if [method _unhandled_input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_unhandled_key_input"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables unhandled key input processing. Enabled automatically if [method _unhandled_key_input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_scene_instance_load_placeholder"> <return type="void" /> - <argument index="0" name="load_placeholder" type="bool" /> + <param index="0" name="load_placeholder" type="bool" /> <description> Sets whether this is an instance load placeholder. See [InstancePlaceholder]. </description> @@ -781,14 +781,14 @@ </members> <signals> <signal name="child_entered_tree"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted when a child node enters the scene tree, either because it entered on its own or because this node entered with it. This signal is emitted [i]after[/i] the child node's own [constant NOTIFICATION_ENTER_TREE] and [signal tree_entered]. </description> </signal> <signal name="child_exiting_tree"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted when a child node is about to exit the scene tree, either because it is being removed or freed directly, or because this node is exiting the tree. When this signal is received, the child [code]node[/code] is still in the tree and valid. This signal is emitted [i]after[/i] the child node's own [signal tree_exiting] and [constant NOTIFICATION_EXIT_TREE]. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 2238be4ece..50392ea59a 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -13,14 +13,14 @@ <methods> <method name="apply_scale"> <return type="void" /> - <argument index="0" name="ratio" type="Vector2" /> + <param index="0" name="ratio" type="Vector2" /> <description> Multiplies the current scale by the [code]ratio[/code] vector. </description> </method> <method name="get_angle_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="point" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> <description> Returns the angle between the node and the [code]point[/code] in radians. [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/node2d_get_angle_to.png]Illustration of the returned angle.[/url] @@ -28,65 +28,65 @@ </method> <method name="get_relative_transform_to_parent" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="parent" type="Node" /> + <param index="0" name="parent" type="Node" /> <description> Returns the [Transform2D] relative to this node's parent. </description> </method> <method name="global_translate"> <return type="void" /> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> <description> Adds the [code]offset[/code] vector to the node's global position. </description> </method> <method name="look_at"> <return type="void" /> - <argument index="0" name="point" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> <description> Rotates the node so it points towards the [code]point[/code], which is expected to use global coordinates. </description> </method> <method name="move_local_x"> <return type="void" /> - <argument index="0" name="delta" type="float" /> - <argument index="1" name="scaled" type="bool" default="false" /> + <param index="0" name="delta" type="float" /> + <param index="1" name="scaled" type="bool" default="false" /> <description> Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement. </description> </method> <method name="move_local_y"> <return type="void" /> - <argument index="0" name="delta" type="float" /> - <argument index="1" name="scaled" type="bool" default="false" /> + <param index="0" name="delta" type="float" /> + <param index="1" name="scaled" type="bool" default="false" /> <description> Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement. </description> </method> <method name="rotate"> <return type="void" /> - <argument index="0" name="radians" type="float" /> + <param index="0" name="radians" type="float" /> <description> Applies a rotation to the node, in radians, starting from its current rotation. </description> </method> <method name="to_global" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="local_point" type="Vector2" /> + <param index="0" name="local_point" type="Vector2" /> <description> Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the [Node2D] it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node's own position will give an incorrect result, as it will incorporate the node's own transformation into its global position. </description> </method> <method name="to_local" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="global_point" type="Vector2" /> + <param index="0" name="global_point" type="Vector2" /> <description> Transforms the provided global position into a position in local coordinate space. The output will be local relative to the [Node2D] it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent. </description> </method> <method name="translate"> <return type="void" /> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> <description> Translates the node by the given [code]offset[/code] in local coordinates. </description> diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml index ff2afd595a..6958f4f7d5 100644 --- a/doc/classes/Node3D.xml +++ b/doc/classes/Node3D.xml @@ -15,7 +15,7 @@ <methods> <method name="add_gizmo"> <return type="void" /> - <argument index="0" name="gizmo" type="Node3DGizmo" /> + <param index="0" name="gizmo" type="Node3DGizmo" /> <description> Attach a gizmo to this [code]Node3D[/code]. </description> @@ -58,22 +58,22 @@ </method> <method name="global_rotate"> <return type="void" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Rotates the global (world) transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in global coordinate system. </description> </method> <method name="global_scale"> <return type="void" /> - <argument index="0" name="scale" type="Vector3" /> + <param index="0" name="scale" type="Vector3" /> <description> Scales the global (world) transformation by the given [Vector3] scale factors. </description> </method> <method name="global_translate"> <return type="void" /> - <argument index="0" name="offset" type="Vector3" /> + <param index="0" name="offset" type="Vector3" /> <description> Moves the global (world) transformation by [Vector3] offset. The offset is in global coordinate system. </description> @@ -110,8 +110,8 @@ </method> <method name="look_at"> <return type="void" /> - <argument index="0" name="target" type="Vector3" /> - <argument index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" /> + <param index="0" name="target" type="Vector3" /> + <param index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" /> <description> Rotates the node so that the local forward axis (-Z) points toward the [code]target[/code] position. The local up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the local forward axis. The resulting transform is orthogonal, and the scale is preserved. Non-uniform scaling may not work correctly. @@ -121,9 +121,9 @@ </method> <method name="look_at_from_position"> <return type="void" /> - <argument index="0" name="position" type="Vector3" /> - <argument index="1" name="target" type="Vector3" /> - <argument index="2" name="up" type="Vector3" default="Vector3(0, 1, 0)" /> + <param index="0" name="position" type="Vector3" /> + <param index="1" name="target" type="Vector3" /> + <param index="2" name="up" type="Vector3" default="Vector3(0, 1, 0)" /> <description> Moves the node to the specified [code]position[/code], and then rotates the node to point toward the [code]target[/code] as per [method look_at]. Operations take place in global space. </description> @@ -136,65 +136,65 @@ </method> <method name="property_can_revert"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value. </description> </method> <method name="property_get_revert"> <return type="Variant" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the default value of the Node3D property with given [code]name[/code]. </description> </method> <method name="rotate"> <return type="void" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. </description> </method> <method name="rotate_object_local"> <return type="void" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system. </description> </method> <method name="rotate_x"> <return type="void" /> - <argument index="0" name="angle" type="float" /> + <param index="0" name="angle" type="float" /> <description> Rotates the local transformation around the X axis by angle in radians. </description> </method> <method name="rotate_y"> <return type="void" /> - <argument index="0" name="angle" type="float" /> + <param index="0" name="angle" type="float" /> <description> Rotates the local transformation around the Y axis by angle in radians. </description> </method> <method name="rotate_z"> <return type="void" /> - <argument index="0" name="angle" type="float" /> + <param index="0" name="angle" type="float" /> <description> Rotates the local transformation around the Z axis by angle in radians. </description> </method> <method name="scale_object_local"> <return type="void" /> - <argument index="0" name="scale" type="Vector3" /> + <param index="0" name="scale" type="Vector3" /> <description> Scales the local transformation by given 3D scale factors in object-local coordinate system. </description> </method> <method name="set_disable_scale"> <return type="void" /> - <argument index="0" name="disable" type="bool" /> + <param index="0" name="disable" type="bool" /> <description> Sets whether the node uses a scale of [code](1, 1, 1)[/code] or its local transformation scale. Changes to the local transformation scale are preserved. </description> @@ -207,30 +207,30 @@ </method> <method name="set_ignore_transform_notification"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Sets whether the node ignores notification that its transformation (global or local) changed. </description> </method> <method name="set_notify_local_transform"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Sets whether the node notifies about its local transformation changes. [Node3D] will not propagate this by default. </description> </method> <method name="set_notify_transform"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Sets whether the node notifies about its global and local transformation changes. [Node3D] will not propagate this by default, unless it is in the editor context and it has a valid gizmo. </description> </method> <method name="set_subgizmo_selection"> <return type="void" /> - <argument index="0" name="gizmo" type="Node3DGizmo" /> - <argument index="1" name="id" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="gizmo" type="Node3DGizmo" /> + <param index="1" name="id" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> Set subgizmo selection for this node in the editor. </description> @@ -243,21 +243,21 @@ </method> <method name="to_global" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="local_point" type="Vector3" /> + <param index="0" name="local_point" type="Vector3" /> <description> Transforms [code]local_point[/code] from this node's local space to world space. </description> </method> <method name="to_local" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="global_point" type="Vector3" /> + <param index="0" name="global_point" type="Vector3" /> <description> Transforms [code]global_point[/code] from world space to this node's local space. </description> </method> <method name="translate"> <return type="void" /> - <argument index="0" name="offset" type="Vector3" /> + <param index="0" name="offset" type="Vector3" /> <description> Changes the node's position by the given offset [Vector3]. Note that the translation [code]offset[/code] is affected by the node's scale, so if scaled by e.g. [code](10, 1, 1)[/code], a translation by an offset of [code](2, 0, 0)[/code] would actually add 20 ([code]2 * 10[/code]) to the X coordinate. @@ -265,7 +265,7 @@ </method> <method name="translate_object_local"> <return type="void" /> - <argument index="0" name="offset" type="Vector3" /> + <param index="0" name="offset" type="Vector3" /> <description> Changes the node's position by the given offset [Vector3] in local space. </description> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index d9e0680a38..edea501d6e 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -35,14 +35,14 @@ </constructor> <constructor name="NodePath"> <return type="NodePath" /> - <argument index="0" name="from" type="NodePath" /> + <param index="0" name="from" type="NodePath" /> <description> Constructs a [NodePath] as a copy of the given [NodePath]. [code]NodePath("example")[/code] is equivalent to [code]^"example"[/code]. </description> </constructor> <constructor name="NodePath"> <return type="NodePath" /> - <argument index="0" name="from" type="String" /> + <param index="0" name="from" type="String" /> <description> Creates a NodePath from a string, e.g. [code]"Path2D/PathFollow2D/Sprite2D:texture:size"[/code]. A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. The "subnames" optionally included after the path to the target node can point to resources or properties, and can also be nested. @@ -111,7 +111,7 @@ </method> <method name="get_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Gets the node name indicated by [code]idx[/code] (0 to [method get_name_count] - 1). [codeblocks] @@ -139,7 +139,7 @@ </method> <method name="get_subname" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Gets the resource or property name indicated by [code]idx[/code] (0 to [method get_subname_count]). [codeblocks] @@ -185,13 +185,13 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="NodePath" /> + <param index="0" name="right" type="NodePath" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="NodePath" /> + <param index="0" name="right" type="NodePath" /> <description> </description> </operator> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 75cd52787a..a1f1e9f0d6 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -12,8 +12,8 @@ <methods> <method name="alert"> <return type="void" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="title" type="String" default=""Alert!"" /> + <param index="0" name="text" type="String" /> + <param index="1" name="title" type="String" default=""Alert!"" /> <description> Displays a modal dialog box using the host OS' facilities. Execution is blocked until the dialog is closed. </description> @@ -33,14 +33,14 @@ </method> <method name="crash"> <return type="void" /> - <argument index="0" name="message" type="String" /> + <param index="0" name="message" type="String" /> <description> Crashes the engine (or the editor if called within a [code]@tool[/code] script). This should [i]only[/i] be used for testing the system's crash handler, not for any other purpose. For general error reporting, use (in order of preference) [method @GDScript.assert], [method @GlobalScope.push_error] or [method alert]. See also [method kill]. </description> </method> <method name="create_instance"> <return type="int" /> - <argument index="0" name="arguments" type="PackedStringArray" /> + <param index="0" name="arguments" type="PackedStringArray" /> <description> Creates a new instance of Godot that runs independently. The [code]arguments[/code] are used in the given order and separated by a space. If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code]. @@ -49,9 +49,9 @@ </method> <method name="create_process"> <return type="int" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="arguments" type="PackedStringArray" /> - <argument index="2" name="open_console" type="bool" default="false" /> + <param index="0" name="path" type="String" /> + <param index="1" name="arguments" type="PackedStringArray" /> + <param index="2" name="open_console" type="bool" default="false" /> <description> Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The path specified in [code]path[/code] must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. On Windows, if [code]open_console[/code] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms. @@ -72,7 +72,7 @@ </method> <method name="delay_msec" qualifiers="const"> <return type="void" /> - <argument index="0" name="msec" type="int" /> + <param index="0" name="msec" type="int" /> <description> Delays execution of the current thread by [code]msec[/code] milliseconds. [code]msec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_msec] will do nothing and will print an error message. [b]Note:[/b] [method delay_msec] is a [i]blocking[/i] way to delay code execution. To delay code execution in a non-blocking way, see [method SceneTree.create_timer]. Awaiting with [method SceneTree.create_timer] will delay the execution of code placed below the [code]await[/code] without affecting the rest of the project (or editor, for [EditorPlugin]s and [EditorScript]s). @@ -81,7 +81,7 @@ </method> <method name="delay_usec" qualifiers="const"> <return type="void" /> - <argument index="0" name="usec" type="int" /> + <param index="0" name="usec" type="int" /> <description> Delays execution of the current thread by [code]usec[/code] microseconds. [code]usec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_usec] will do nothing and will print an error message. [b]Note:[/b] [method delay_usec] is a [i]blocking[/i] way to delay code execution. To delay code execution in a non-blocking way, see [method SceneTree.create_timer]. Awaiting with [method SceneTree.create_timer] will delay the execution of code placed below the [code]await[/code] without affecting the rest of the project (or editor, for [EditorPlugin]s and [EditorScript]s). @@ -90,7 +90,7 @@ </method> <method name="dump_memory_to_file"> <return type="void" /> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description". @@ -98,7 +98,7 @@ </method> <method name="dump_resources_to_file"> <return type="void" /> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> Dumps all used resources to file (only works in debug). Entry format per line: "Resource Type : Resource Location". @@ -107,11 +107,11 @@ </method> <method name="execute"> <return type="int" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="arguments" type="PackedStringArray" /> - <argument index="2" name="output" type="Array" default="[]" /> - <argument index="3" name="read_stderr" type="bool" default="false" /> - <argument index="4" name="open_console" type="bool" default="false" /> + <param index="0" name="path" type="String" /> + <param index="1" name="arguments" type="PackedStringArray" /> + <param index="2" name="output" type="Array" default="[]" /> + <param index="3" name="read_stderr" type="bool" default="false" /> + <param index="4" name="open_console" type="bool" default="false" /> <description> Executes a command. The file specified in [code]path[/code] must exist and be executable. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. If an [code]output[/code] [Array] is provided, the complete shell output of the process will be appended as a single [String] element in [code]output[/code]. If [code]read_stderr[/code] is [code]true[/code], the output to the standard error stream will be included too. On Windows, if [code]open_console[/code] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms. @@ -148,7 +148,7 @@ </method> <method name="find_keycode_from_string" qualifiers="const"> <return type="int" enum="Key" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Returns the keycode of the given string (e.g. "Escape"). </description> @@ -235,7 +235,7 @@ </method> <method name="get_environment" qualifiers="const"> <return type="String" /> - <argument index="0" name="variable" type="String" /> + <param index="0" name="variable" type="String" /> <description> Returns the value of an environment variable. Returns an empty string if the environment variable doesn't exist. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. @@ -257,7 +257,7 @@ </method> <method name="get_keycode_string" qualifiers="const"> <return type="String" /> - <argument index="0" name="code" type="int" enum="Key" /> + <param index="0" name="code" type="int" enum="Key" /> <description> Returns the given keycode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). See also [member InputEventKey.keycode] and [method InputEventKey.get_keycode_with_modifiers]. @@ -394,8 +394,8 @@ </method> <method name="get_system_dir" qualifiers="const"> <return type="String" /> - <argument index="0" name="dir" type="int" enum="OS.SystemDir" /> - <argument index="1" name="shared_storage" type="bool" default="true" /> + <param index="0" name="dir" type="int" enum="OS.SystemDir" /> + <param index="1" name="shared_storage" type="bool" default="true" /> <description> Returns the actual path to commonly used folders across different platforms. Available locations are specified in [enum SystemDir]. [b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows. @@ -404,9 +404,9 @@ </method> <method name="get_system_font_path" qualifiers="const"> <return type="String" /> - <argument index="0" name="font_name" type="String" /> - <argument index="1" name="bold" type="bool" default="false" /> - <argument index="2" name="italic" type="bool" default="false" /> + <param index="0" name="font_name" type="String" /> + <param index="1" name="bold" type="bool" default="false" /> + <param index="2" name="italic" type="bool" default="false" /> <description> Returns path to the system font file with [code]font_name[/code] and style. Return empty string if no matching fonts found. [b]Note:[/b] This method is implemented on iOS, Linux, macOS and Windows. @@ -449,7 +449,7 @@ </method> <method name="has_environment" qualifiers="const"> <return type="bool" /> - <argument index="0" name="variable" type="String" /> + <param index="0" name="variable" type="String" /> <description> Returns [code]true[/code] if the environment variable with the name [code]variable[/code] exists. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. @@ -457,7 +457,7 @@ </method> <method name="has_feature" qualifiers="const"> <return type="bool" /> - <argument index="0" name="tag_name" type="String" /> + <param index="0" name="tag_name" type="String" /> <description> Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the [url=$DOCS_URL/getting_started/workflow/export/feature_tags.html]Feature Tags[/url] documentation for more details. [b]Note:[/b] Tag names are case-sensitive. @@ -473,14 +473,14 @@ </method> <method name="is_keycode_unicode" qualifiers="const"> <return type="bool" /> - <argument index="0" name="code" type="int" /> + <param index="0" name="code" type="int" /> <description> Returns [code]true[/code] if the input keycode corresponds to a Unicode character. </description> </method> <method name="is_process_running" qualifiers="const"> <return type="bool" /> - <argument index="0" name="pid" type="int" /> + <param index="0" name="pid" type="int" /> <description> Returns [code]true[/code] if the child process ID ([code]pid[/code]) is still running or [code]false[/code] if it has terminated. Must be a valid ID generated from [method create_process]. @@ -507,7 +507,7 @@ </method> <method name="kill"> <return type="int" enum="Error" /> - <argument index="0" name="pid" type="int" /> + <param index="0" name="pid" type="int" /> <description> Kill (terminate) the process identified by the given process ID ([code]pid[/code]), e.g. the one returned by [method execute] in non-blocking mode. See also [method crash]. [b]Note:[/b] This method can also be used to kill processes that were not spawned by the game. @@ -516,7 +516,7 @@ </method> <method name="move_to_trash" qualifiers="const"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Moves the file or directory to the system's recycle bin. See also [method Directory.remove]. The method takes only global paths, so you may need to use [method ProjectSettings.globalize_path]. Do not use it for files in [code]res://[/code] as it will not work in exported project. @@ -536,7 +536,7 @@ </method> <method name="print_all_resources"> <return type="void" /> - <argument index="0" name="tofile" type="String" default="""" /> + <param index="0" name="tofile" type="String" default="""" /> <description> Shows all resources in the game. Optionally, the list can be written to a file by specifying a file path in [code]tofile[/code]. </description> @@ -549,21 +549,21 @@ </method> <method name="print_resources_by_type"> <return type="void" /> - <argument index="0" name="types" type="PackedStringArray" /> + <param index="0" name="types" type="PackedStringArray" /> <description> Shows the number of resources loaded by the game of the given types. </description> </method> <method name="print_resources_in_use"> <return type="void" /> - <argument index="0" name="short" type="bool" default="false" /> + <param index="0" name="short" type="bool" default="false" /> <description> Shows all resources currently used by the game. </description> </method> <method name="request_permission"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> At the moment this function is only used by [code]AudioDriverOpenSL[/code] to request permission for [code]RECORD_AUDIO[/code] on Android. </description> @@ -577,8 +577,8 @@ </method> <method name="set_environment" qualifiers="const"> <return type="bool" /> - <argument index="0" name="variable" type="String" /> - <argument index="1" name="value" type="String" /> + <param index="0" name="variable" type="String" /> + <param index="1" name="value" type="String" /> <description> Sets the value of the environment variable [code]variable[/code] to [code]value[/code]. The environment variable will be set for the Godot process and any process executed with [method execute] after running [method set_environment]. The environment variable will [i]not[/i] persist to processes run after the Godot process was terminated. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. @@ -586,8 +586,8 @@ </method> <method name="set_restart_on_exit"> <return type="void" /> - <argument index="0" name="restart" type="bool" /> - <argument index="1" name="arguments" type="PackedStringArray" default="PackedStringArray()" /> + <param index="0" name="restart" type="bool" /> + <param index="1" name="arguments" type="PackedStringArray" default="PackedStringArray()" /> <description> If [code]restart[/code] is [code]true[/code], restarts the project automatically when it is exited with [method SceneTree.quit] or [constant Node.NOTIFICATION_WM_CLOSE_REQUEST]. Command line [code]arguments[/code] can be supplied. To restart the project with the same command line arguments as originally used to run the project, pass [method get_cmdline_args] as the value for [code]arguments[/code]. [method set_restart_on_exit] can be used to apply setting changes that require a restart. See also [method is_restart_on_exit_set] and [method get_restart_on_exit_arguments]. @@ -597,21 +597,21 @@ </method> <method name="set_thread_name"> <return type="int" enum="Error" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Sets the name of the current thread. </description> </method> <method name="set_use_file_access_save_and_swap"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Enables backup saves if [code]enabled[/code] is [code]true[/code]. </description> </method> <method name="shell_open"> <return type="int" enum="Error" /> - <argument index="0" name="uri" type="String" /> + <param index="0" name="uri" type="String" /> <description> Requests the OS to open a resource with the most appropriate program. For example: - [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the user's Downloads folder. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 061b32bfdf..824da0591e 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -36,7 +36,7 @@ <methods> <method name="_get" qualifiers="virtual"> <return type="Variant" /> - <argument index="0" name="property" type="StringName" /> + <param index="0" name="property" type="StringName" /> <description> Virtual method which can be overridden to customize the return value of [method get]. Returns the given property. Returns [code]null[/code] if the [code]property[/code] does not exist. @@ -59,15 +59,15 @@ </method> <method name="_notification" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="what" type="int" /> + <param index="0" name="what" type="int" /> <description> Called whenever the object receives a notification, which is identified in [code]what[/code] by a constant. The base [Object] has two constants [constant NOTIFICATION_POSTINITIALIZE] and [constant NOTIFICATION_PREDELETE], but subclasses such as [Node] define a lot more notifications which are also received by this method. </description> </method> <method name="_set" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Virtual method which can be overridden to customize the return value of [method set]. Sets a property. Returns [code]true[/code] if the [code]property[/code] exists. @@ -82,15 +82,15 @@ </method> <method name="add_user_signal"> <return type="void" /> - <argument index="0" name="signal" type="String" /> - <argument index="1" name="arguments" type="Array" default="[]" /> + <param index="0" name="signal" type="String" /> + <param index="1" name="arguments" type="Array" default="[]" /> <description> Adds a user-defined [code]signal[/code]. Arguments are optional, but can be added as an [Array] of dictionaries, each containing [code]name: String[/code] and [code]type: int[/code] (see [enum Variant.Type]) entries. </description> </method> <method name="call" qualifiers="vararg"> <return type="Variant" /> - <argument index="0" name="method" type="StringName" /> + <param index="0" name="method" type="StringName" /> <description> Calls the [code]method[/code] on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblocks] @@ -108,7 +108,7 @@ </method> <method name="call_deferred" qualifiers="vararg"> <return type="Variant" /> - <argument index="0" name="method" type="StringName" /> + <param index="0" name="method" type="StringName" /> <description> Calls the [code]method[/code] on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblocks] @@ -126,8 +126,8 @@ </method> <method name="callv"> <return type="Variant" /> - <argument index="0" name="method" type="StringName" /> - <argument index="1" name="arg_array" type="Array" /> + <param index="0" name="method" type="StringName" /> + <param index="1" name="arg_array" type="Array" /> <description> Calls the [code]method[/code] on the object and returns the result. Contrarily to [method call], this method does not support a variable number of arguments but expects all parameters to be via a single [Array]. [codeblocks] @@ -150,9 +150,9 @@ </method> <method name="connect"> <return type="int" enum="Error" /> - <argument index="0" name="signal" type="StringName" /> - <argument index="1" name="callable" type="Callable" /> - <argument index="2" name="flags" type="int" default="0" /> + <param index="0" name="signal" type="StringName" /> + <param index="1" name="callable" type="Callable" /> + <param index="2" name="flags" type="int" default="0" /> <description> Connects a [code]signal[/code] to a [code]callable[/code]. Use [code]flags[/code] to set deferred or one-shot connections. See [enum ConnectFlags] constants. A signal can only be connected once to a [Callable]. It will print an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections. @@ -291,8 +291,8 @@ </method> <method name="disconnect"> <return type="void" /> - <argument index="0" name="signal" type="StringName" /> - <argument index="1" name="callable" type="Callable" /> + <param index="0" name="signal" type="StringName" /> + <param index="1" name="callable" type="Callable" /> <description> Disconnects a [code]signal[/code] from a given [code]callable[/code]. If you try to disconnect a connection that does not exist, the method will print an error. Use [method is_connected] to ensure that the connection exists. @@ -300,7 +300,7 @@ </method> <method name="emit_signal" qualifiers="vararg"> <return type="int" enum="Error" /> - <argument index="0" name="signal" type="StringName" /> + <param index="0" name="signal" type="StringName" /> <description> Emits the given [code]signal[/code]. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblocks] @@ -323,7 +323,7 @@ </method> <method name="get" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="property" type="StringName" /> + <param index="0" name="property" type="StringName" /> <description> Returns the [Variant] value of the given [code]property[/code]. If the [code]property[/code] doesn't exist, this will return [code]null[/code]. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). @@ -348,7 +348,7 @@ </method> <method name="get_indexed" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="property" type="NodePath" /> + <param index="0" name="property" type="NodePath" /> <description> Gets the object's property indexed by the given [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Examples: [code]"position:x"[/code] or [code]"material:next_pass:blend_mode"[/code]. [b]Note:[/b] Even though the method takes [NodePath] argument, it doesn't support actual paths to [Node]s in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use [method Node.get_node_and_resource] instead. @@ -363,8 +363,8 @@ </method> <method name="get_meta" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="default" type="Variant" default="null" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="default" type="Variant" default="null" /> <description> Returns the object's metadata entry for the given [code]name[/code]. Throws error if the entry does not exist, unless [code]default[/code] is not [code]null[/code] (in which case the default value will be returned). @@ -397,7 +397,7 @@ </method> <method name="get_signal_connection_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="signal" type="StringName" /> + <param index="0" name="signal" type="StringName" /> <description> Returns an [Array] of connections for the given [code]signal[/code]. </description> @@ -410,28 +410,28 @@ </method> <method name="has_meta" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if a metadata entry is found with the given [code]name[/code]. </description> </method> <method name="has_method" qualifiers="const"> <return type="bool" /> - <argument index="0" name="method" type="StringName" /> + <param index="0" name="method" type="StringName" /> <description> Returns [code]true[/code] if the object contains the given [code]method[/code]. </description> </method> <method name="has_signal" qualifiers="const"> <return type="bool" /> - <argument index="0" name="signal" type="StringName" /> + <param index="0" name="signal" type="StringName" /> <description> Returns [code]true[/code] if the given [code]signal[/code] exists. </description> </method> <method name="has_user_signal" qualifiers="const"> <return type="bool" /> - <argument index="0" name="signal" type="StringName" /> + <param index="0" name="signal" type="StringName" /> <description> Returns [code]true[/code] if the given user-defined [code]signal[/code] exists. Only signals added using [method add_user_signal] are taken into account. </description> @@ -444,7 +444,7 @@ </method> <method name="is_class" qualifiers="const"> <return type="bool" /> - <argument index="0" name="class" type="String" /> + <param index="0" name="class" type="String" /> <description> Returns [code]true[/code] if the object inherits from the given [code]class[/code]. See also [method get_class]. [b]Note:[/b] [method is_class] does not take [code]class_name[/code] declarations into account. If the object has a [code]class_name[/code] defined, [method is_class] will return [code]false[/code] for that name. @@ -452,8 +452,8 @@ </method> <method name="is_connected" qualifiers="const"> <return type="bool" /> - <argument index="0" name="signal" type="StringName" /> - <argument index="1" name="callable" type="Callable" /> + <param index="0" name="signal" type="StringName" /> + <param index="1" name="callable" type="Callable" /> <description> Returns [code]true[/code] if a connection exists for a given [code]signal[/code] and [code]callable[/code]. </description> @@ -466,8 +466,8 @@ </method> <method name="notification"> <return type="void" /> - <argument index="0" name="what" type="int" /> - <argument index="1" name="reversed" type="bool" default="false" /> + <param index="0" name="what" type="int" /> + <param index="1" name="reversed" type="bool" default="false" /> <description> Send a given notification to the object, which will also trigger a call to the [method _notification] method of all classes that the object inherits from. If [code]reversed[/code] is [code]true[/code], [method _notification] is called first on the object's own class, and then up to its successive parent classes. If [code]reversed[/code] is [code]false[/code], [method _notification] is called first on the highest ancestor ([Object] itself), and then down to its successive inheriting classes. @@ -481,15 +481,15 @@ </method> <method name="remove_meta"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes a given entry from the object's metadata. See also [method set_meta]. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Assigns a new value to the given property. If the [code]property[/code] does not exist or the given value's type doesn't match, nothing will happen. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). @@ -497,15 +497,15 @@ </method> <method name="set_block_signals"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> If set to [code]true[/code], signal emission is blocked. </description> </method> <method name="set_deferred"> <return type="void" /> - <argument index="0" name="property" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="property" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. [code]call_deferred("set", property, value)[/code]. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). @@ -513,8 +513,8 @@ </method> <method name="set_indexed"> <return type="void" /> - <argument index="0" name="property" type="NodePath" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="property" type="NodePath" /> + <param index="1" name="value" type="Variant" /> <description> Assigns a new value to the property identified by the [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Example: [codeblocks] @@ -535,15 +535,15 @@ </method> <method name="set_message_translation"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Defines whether the object can translate strings (with calls to [method tr]). Enabled by default. </description> </method> <method name="set_meta"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Adds, changes or removes a given entry in the object's metadata. Metadata are serialized and can take any [Variant] value. To remove a given entry from the object's metadata, use [method remove_meta]. Metadata is also removed if its value is set to [code]null[/code]. This means you can also use [code]set_meta("name", null)[/code] to remove metadata for [code]"name"[/code]. @@ -551,7 +551,7 @@ </method> <method name="set_script"> <return type="void" /> - <argument index="0" name="script" type="Variant" /> + <param index="0" name="script" type="Variant" /> <description> Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script's [method _init] method will be called. @@ -566,8 +566,8 @@ </method> <method name="tr" qualifiers="const"> <return type="String" /> - <argument index="0" name="message" type="StringName" /> - <argument index="1" name="context" type="StringName" default="""" /> + <param index="0" name="message" type="StringName" /> + <param index="1" name="context" type="StringName" default="""" /> <description> Translates a message using translation catalogs configured in the Project Settings. An additional context could be used to specify the translation context. Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] unchanged. See [method set_message_translation]. @@ -576,10 +576,10 @@ </method> <method name="tr_n" qualifiers="const"> <return type="String" /> - <argument index="0" name="message" type="StringName" /> - <argument index="1" name="plural_message" type="StringName" /> - <argument index="2" name="n" type="int" /> - <argument index="3" name="context" type="StringName" default="""" /> + <param index="0" name="message" type="StringName" /> + <param index="1" name="plural_message" type="StringName" /> + <param index="2" name="n" type="int" /> + <param index="3" name="context" type="StringName" default="""" /> <description> Translates a message involving plurals using translation catalogs configured in the Project Settings. An additional context could be used to specify the translation context. Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] or [code]plural_message[/code] unchanged. See [method set_message_translation]. diff --git a/doc/classes/OccluderInstance3D.xml b/doc/classes/OccluderInstance3D.xml index 08d12341cd..556ff07267 100644 --- a/doc/classes/OccluderInstance3D.xml +++ b/doc/classes/OccluderInstance3D.xml @@ -15,15 +15,15 @@ <methods> <method name="get_bake_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member bake_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_bake_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member bake_mask], given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/doc/classes/OptimizedTranslation.xml b/doc/classes/OptimizedTranslation.xml index 68765f9862..54ebfd3146 100644 --- a/doc/classes/OptimizedTranslation.xml +++ b/doc/classes/OptimizedTranslation.xml @@ -11,7 +11,7 @@ <methods> <method name="generate"> <return type="void" /> - <argument index="0" name="from" type="Translation" /> + <param index="0" name="from" type="Translation" /> <description> Generates and sets an optimized translation from the given [Translation] resource. </description> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 737662fe69..9e476bd05b 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -13,24 +13,24 @@ <methods> <method name="add_icon_item"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="label" type="String" /> - <argument index="2" name="id" type="int" default="-1" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="label" type="String" /> + <param index="2" name="id" type="int" default="-1" /> <description> Adds an item, with a [code]texture[/code] icon, text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, the item index will be used as the item's ID. New items are appended at the end. </description> </method> <method name="add_item"> <return type="void" /> - <argument index="0" name="label" type="String" /> - <argument index="1" name="id" type="int" default="-1" /> + <param index="0" name="label" type="String" /> + <param index="1" name="id" type="int" default="-1" /> <description> Adds an item, with text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, the item index will be used as the item's ID. New items are appended at the end. </description> </method> <method name="add_separator"> <return type="void" /> - <argument index="0" name="text" type="String" default="""" /> + <param index="0" name="text" type="String" default="""" /> <description> Adds a separator to the list of items. Separators help to group items, and can optionally be given a [code]text[/code] header. A separator also gets an index assigned, and is appended at the end of the item list. </description> @@ -43,42 +43,42 @@ </method> <method name="get_item_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the icon of the item at index [code]idx[/code]. </description> </method> <method name="get_item_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the ID of the item at index [code]idx[/code]. </description> </method> <method name="get_item_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the index of the item with the given [code]id[/code]. </description> </method> <method name="get_item_metadata" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID. </description> </method> <method name="get_item_text" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the text of the item at index [code]idx[/code]. </description> </method> <method name="get_item_tooltip" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the tooltip of the item at index [code]idx[/code]. </description> @@ -92,7 +92,7 @@ </method> <method name="get_selectable_item" qualifiers="const"> <return type="int" /> - <argument index="0" name="from_last" type="bool" default="false" /> + <param index="0" name="from_last" type="bool" default="false" /> <description> </description> </method> @@ -115,27 +115,27 @@ </method> <method name="is_item_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. </description> </method> <method name="is_item_separator" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> <method name="remove_item"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Removes the item at index [code]idx[/code]. </description> </method> <method name="select"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Selects an item by index and makes it the current item. This will work even if the item is disabled. Passing [code]-1[/code] as the index deselects any currently selected item. @@ -143,8 +143,8 @@ </method> <method name="set_item_disabled"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="disabled" type="bool" /> <description> Sets whether the item at index [code]idx[/code] is disabled. Disabled items are drawn differently in the dropdown and are not selectable by the user. If the current selected item is set as disabled, it will remain selected. @@ -152,40 +152,40 @@ </method> <method name="set_item_icon"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="texture" type="Texture2D" /> <description> Sets the icon of the item at index [code]idx[/code]. </description> </method> <method name="set_item_id"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="id" type="int" /> <description> Sets the ID of the item at index [code]idx[/code]. </description> </method> <method name="set_item_metadata"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="metadata" type="Variant" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="metadata" type="Variant" /> <description> Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID. </description> </method> <method name="set_item_text"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="text" type="String" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="text" type="String" /> <description> Sets the text of the item at index [code]idx[/code]. </description> </method> <method name="set_item_tooltip"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="tooltip" type="String" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="tooltip" type="String" /> <description> Sets the tooltip of the item at index [code]idx[/code]. </description> @@ -208,13 +208,13 @@ </members> <signals> <signal name="item_focused"> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Emitted when the user navigates to an item using the [code]ui_up[/code] or [code]ui_down[/code] actions. The index of the item selected is passed as argument. </description> </signal> <signal name="item_selected"> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Emitted when the current item has been changed by the user. The index of the item selected is passed as argument. </description> diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index 3b84128123..3083ea849b 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -26,26 +26,26 @@ <methods> <method name="add_file"> <return type="int" enum="Error" /> - <argument index="0" name="pck_path" type="String" /> - <argument index="1" name="source_path" type="String" /> - <argument index="2" name="encrypt" type="bool" default="false" /> + <param index="0" name="pck_path" type="String" /> + <param index="1" name="source_path" type="String" /> + <param index="2" name="encrypt" type="bool" default="false" /> <description> Adds the [code]source_path[/code] file to the current PCK package at the [code]pck_path[/code] internal path (should start with [code]res://[/code]). </description> </method> <method name="flush"> <return type="int" enum="Error" /> - <argument index="0" name="verbose" type="bool" default="false" /> + <param index="0" name="verbose" type="bool" default="false" /> <description> Writes the files specified using all [method add_file] calls since the last flush. If [code]verbose[/code] is [code]true[/code], a list of files added will be printed to the console for easier debugging. </description> </method> <method name="pck_start"> <return type="int" enum="Error" /> - <argument index="0" name="pck_name" type="String" /> - <argument index="1" name="alignment" type="int" default="32" /> - <argument index="2" name="key" type="String" default=""0000000000000000000000000000000000000000000000000000000000000000"" /> - <argument index="3" name="encrypt_directory" type="bool" default="false" /> + <param index="0" name="pck_name" type="String" /> + <param index="1" name="alignment" type="int" default="32" /> + <param index="2" name="key" type="String" default=""0000000000000000000000000000000000000000000000000000000000000000"" /> + <param index="3" name="encrypt_directory" type="bool" default="false" /> <description> Creates a new PCK file with the name [code]pck_name[/code]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [code]pck_name[/code] (even though it's not required). </description> diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index 3af3bb8697..f7210122e6 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -17,14 +17,14 @@ </constructor> <constructor name="PackedByteArray"> <return type="PackedByteArray" /> - <argument index="0" name="from" type="PackedByteArray" /> + <param index="0" name="from" type="PackedByteArray" /> <description> Constructs a [PackedByteArray] as a copy of the given [PackedByteArray]. </description> </constructor> <constructor name="PackedByteArray"> <return type="PackedByteArray" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedByteArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -33,22 +33,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedByteArray" /> + <param index="0" name="array" type="PackedByteArray" /> <description> Appends a [PackedByteArray] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="int" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -56,110 +56,110 @@ </method> <method name="compress" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="compression_mode" type="int" default="0" /> + <param index="0" name="compression_mode" type="int" default="0" /> <description> Returns a new [PackedByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. </description> </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Returns the number of times an element is in the array. </description> </method> <method name="decode_double" qualifiers="const"> <return type="float" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_float" qualifiers="const"> <return type="float" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_half" qualifiers="const"> <return type="float" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_s16" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_s32" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_s64" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_s8" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_u16" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_u32" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_u64" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_u8" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> + <param index="0" name="byte_offset" type="int" /> <description> </description> </method> <method name="decode_var" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="allow_objects" type="bool" default="false" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="allow_objects" type="bool" default="false" /> <description> </description> </method> <method name="decode_var_size" qualifiers="const"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="allow_objects" type="bool" default="false" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="allow_objects" type="bool" default="false" /> <description> </description> </method> <method name="decompress" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="buffer_size" type="int" /> - <argument index="1" name="compression_mode" type="int" default="0" /> + <param index="0" name="buffer_size" type="int" /> + <param index="1" name="compression_mode" type="int" default="0" /> <description> Returns a new [PackedByteArray] with the data decompressed. Set [code]buffer_size[/code] to the size of the uncompressed data. Set the compression mode using one of [enum File.CompressionMode]'s constants. </description> </method> <method name="decompress_dynamic" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="max_output_size" type="int" /> - <argument index="1" name="compression_mode" type="int" default="0" /> + <param index="0" name="max_output_size" type="int" /> + <param index="1" name="compression_mode" type="int" default="0" /> <description> Returns a new [PackedByteArray] with the data decompressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. [b]This method only accepts gzip and deflate compression modes.[/b] This method is potentially slower than [code]decompress[/code], as it may have to re-allocate its output buffer multiple times while decompressing, whereas [code]decompress[/code] knows it's output buffer size from the beginning. @@ -174,100 +174,100 @@ </method> <method name="encode_double"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="float" /> <description> </description> </method> <method name="encode_float"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="float" /> <description> </description> </method> <method name="encode_half"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="float" /> <description> </description> </method> <method name="encode_s16"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="int" /> <description> </description> </method> <method name="encode_s32"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="int" /> <description> </description> </method> <method name="encode_s64"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="int" /> <description> </description> </method> <method name="encode_s8"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="int" /> <description> </description> </method> <method name="encode_u16"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="int" /> <description> </description> </method> <method name="encode_u32"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="int" /> <description> </description> </method> <method name="encode_u64"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="int" /> <description> </description> </method> <method name="encode_u8"> <return type="void" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="int" /> <description> </description> </method> <method name="encode_var"> <return type="int" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="value" type="Variant" /> - <argument index="2" name="allow_objects" type="bool" default="false" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="value" type="Variant" /> + <param index="2" name="allow_objects" type="bool" default="false" /> <description> </description> </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="int" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> @@ -298,15 +298,15 @@ </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="has_encoded_var" qualifiers="const"> <return type="bool" /> - <argument index="0" name="byte_offset" type="int" /> - <argument index="1" name="allow_objects" type="bool" default="false" /> + <param index="0" name="byte_offset" type="int" /> + <param index="1" name="allow_objects" type="bool" default="false" /> <description> </description> </method> @@ -328,8 +328,8 @@ </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="int" /> <description> Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -342,21 +342,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Appends an element at the end of the array. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -369,16 +369,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="int" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="int" /> <description> Changes the byte at the given index. </description> @@ -391,8 +391,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedByteArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedByteArray]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -441,25 +441,25 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedByteArray" /> + <param index="0" name="right" type="PackedByteArray" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedByteArray" /> - <argument index="0" name="right" type="PackedByteArray" /> + <param index="0" name="right" type="PackedByteArray" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedByteArray" /> + <param index="0" name="right" type="PackedByteArray" /> <description> </description> </operator> <operator name="operator []"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index 12a553af49..dd9ada44fb 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -17,14 +17,14 @@ </constructor> <constructor name="PackedColorArray"> <return type="PackedColorArray" /> - <argument index="0" name="from" type="PackedColorArray" /> + <param index="0" name="from" type="PackedColorArray" /> <description> Constructs a [PackedColorArray] as a copy of the given [PackedColorArray]. </description> </constructor> <constructor name="PackedColorArray"> <return type="PackedColorArray" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedColorArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -33,22 +33,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="Color" /> + <param index="0" name="value" type="Color" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedColorArray" /> + <param index="0" name="array" type="PackedColorArray" /> <description> Appends a [PackedColorArray] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="Color" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="Color" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -56,7 +56,7 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Color" /> + <param index="0" name="value" type="Color" /> <description> Returns the number of times an element is in the array. </description> @@ -69,30 +69,30 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="Color" /> + <param index="0" name="value" type="Color" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Color" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="Color" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="Color" /> + <param index="0" name="value" type="Color" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="Color" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="Color" /> <description> Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -105,21 +105,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="Color" /> + <param index="0" name="value" type="Color" /> <description> Appends a value to the array. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -132,16 +132,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Color" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="Color" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="Color" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="Color" /> <description> Changes the [Color] at the given index. </description> @@ -154,8 +154,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedColorArray" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedColorArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedColorArray]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -177,25 +177,25 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedColorArray" /> + <param index="0" name="right" type="PackedColorArray" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedColorArray" /> - <argument index="0" name="right" type="PackedColorArray" /> + <param index="0" name="right" type="PackedColorArray" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedColorArray" /> + <param index="0" name="right" type="PackedColorArray" /> <description> </description> </operator> <operator name="operator []"> <return type="Color" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml index cba7269ccf..5035c8dee4 100644 --- a/doc/classes/PackedDataContainer.xml +++ b/doc/classes/PackedDataContainer.xml @@ -9,7 +9,7 @@ <methods> <method name="pack"> <return type="int" enum="Error" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> </description> </method> diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml index 0a114e6c06..ee5497cb1b 100644 --- a/doc/classes/PackedFloat32Array.xml +++ b/doc/classes/PackedFloat32Array.xml @@ -18,14 +18,14 @@ </constructor> <constructor name="PackedFloat32Array"> <return type="PackedFloat32Array" /> - <argument index="0" name="from" type="PackedFloat32Array" /> + <param index="0" name="from" type="PackedFloat32Array" /> <description> Constructs a [PackedFloat32Array] as a copy of the given [PackedFloat32Array]. </description> </constructor> <constructor name="PackedFloat32Array"> <return type="PackedFloat32Array" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedFloat32Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -34,22 +34,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedFloat32Array" /> + <param index="0" name="array" type="PackedFloat32Array" /> <description> Appends a [PackedFloat32Array] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="float" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Returns the number of times an element is in the array. </description> @@ -70,30 +70,30 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="float" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="float" /> <description> Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -106,21 +106,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Appends an element at the end of the array. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -133,16 +133,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="float" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="float" /> <description> Changes the float at the given index. </description> @@ -155,8 +155,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedFloat32Array" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedFloat32Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedFloat32Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -180,25 +180,25 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedFloat32Array" /> + <param index="0" name="right" type="PackedFloat32Array" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedFloat32Array" /> - <argument index="0" name="right" type="PackedFloat32Array" /> + <param index="0" name="right" type="PackedFloat32Array" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedFloat32Array" /> + <param index="0" name="right" type="PackedFloat32Array" /> <description> </description> </operator> <operator name="operator []"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml index 0327559f5b..2cc8eff059 100644 --- a/doc/classes/PackedFloat64Array.xml +++ b/doc/classes/PackedFloat64Array.xml @@ -18,14 +18,14 @@ </constructor> <constructor name="PackedFloat64Array"> <return type="PackedFloat64Array" /> - <argument index="0" name="from" type="PackedFloat64Array" /> + <param index="0" name="from" type="PackedFloat64Array" /> <description> Constructs a [PackedFloat64Array] as a copy of the given [PackedFloat64Array]. </description> </constructor> <constructor name="PackedFloat64Array"> <return type="PackedFloat64Array" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedFloat64Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -34,22 +34,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedFloat64Array" /> + <param index="0" name="array" type="PackedFloat64Array" /> <description> Appends a [PackedFloat64Array] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="float" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Returns the number of times an element is in the array. </description> @@ -70,30 +70,30 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="float" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="float" /> <description> Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -106,21 +106,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Appends an element at the end of the array. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -133,16 +133,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="float" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="float" /> <description> Changes the float at the given index. </description> @@ -155,8 +155,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedFloat64Array" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedFloat64Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedFloat64Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -180,25 +180,25 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedFloat64Array" /> + <param index="0" name="right" type="PackedFloat64Array" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedFloat64Array" /> - <argument index="0" name="right" type="PackedFloat64Array" /> + <param index="0" name="right" type="PackedFloat64Array" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedFloat64Array" /> + <param index="0" name="right" type="PackedFloat64Array" /> <description> </description> </operator> <operator name="operator []"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml index f8b606d266..70f3f1d180 100644 --- a/doc/classes/PackedInt32Array.xml +++ b/doc/classes/PackedInt32Array.xml @@ -18,14 +18,14 @@ </constructor> <constructor name="PackedInt32Array"> <return type="PackedInt32Array" /> - <argument index="0" name="from" type="PackedInt32Array" /> + <param index="0" name="from" type="PackedInt32Array" /> <description> Constructs a [PackedInt32Array] as a copy of the given [PackedInt32Array]. </description> </constructor> <constructor name="PackedInt32Array"> <return type="PackedInt32Array" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedInt32Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -34,22 +34,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedInt32Array" /> + <param index="0" name="array" type="PackedInt32Array" /> <description> Appends a [PackedInt32Array] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="int" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Returns the number of times an element is in the array. </description> @@ -70,30 +70,30 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="int" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="int" /> <description> Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -106,21 +106,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Appends a value to the array. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -133,16 +133,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="int" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="int" /> <description> Changes the integer at the given index. </description> @@ -155,8 +155,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedInt32Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedInt32Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -180,25 +180,25 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedInt32Array" /> + <param index="0" name="right" type="PackedInt32Array" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedInt32Array" /> - <argument index="0" name="right" type="PackedInt32Array" /> + <param index="0" name="right" type="PackedInt32Array" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedInt32Array" /> + <param index="0" name="right" type="PackedInt32Array" /> <description> </description> </operator> <operator name="operator []"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml index ea3e304d35..5d590f02a4 100644 --- a/doc/classes/PackedInt64Array.xml +++ b/doc/classes/PackedInt64Array.xml @@ -18,14 +18,14 @@ </constructor> <constructor name="PackedInt64Array"> <return type="PackedInt64Array" /> - <argument index="0" name="from" type="PackedInt64Array" /> + <param index="0" name="from" type="PackedInt64Array" /> <description> Constructs a [PackedInt64Array] as a copy of the given [PackedInt64Array]. </description> </constructor> <constructor name="PackedInt64Array"> <return type="PackedInt64Array" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedInt64Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -34,22 +34,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedInt64Array" /> + <param index="0" name="array" type="PackedInt64Array" /> <description> Appends a [PackedInt64Array] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="int" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Returns the number of times an element is in the array. </description> @@ -70,30 +70,30 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="int" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="int" /> <description> Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -106,21 +106,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Appends a value to the array. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -133,16 +133,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="int" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="int" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="int" /> <description> Changes the integer at the given index. </description> @@ -155,8 +155,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedInt64Array" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedInt64Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedInt64Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -180,25 +180,25 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedInt64Array" /> + <param index="0" name="right" type="PackedInt64Array" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedInt64Array" /> - <argument index="0" name="right" type="PackedInt64Array" /> + <param index="0" name="right" type="PackedInt64Array" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedInt64Array" /> + <param index="0" name="right" type="PackedInt64Array" /> <description> </description> </operator> <operator name="operator []"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 821fc1ae95..c7fe7d8c37 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -90,14 +90,14 @@ </method> <method name="instantiate" qualifiers="const"> <return type="Node" /> - <argument index="0" name="edit_state" type="int" enum="PackedScene.GenEditState" default="0" /> + <param index="0" name="edit_state" type="int" enum="PackedScene.GenEditState" default="0" /> <description> Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a [constant Node.NOTIFICATION_INSTANCED] notification on the root node. </description> </method> <method name="pack"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="Node" /> + <param index="0" name="path" type="Node" /> <description> Pack will ignore any sub-nodes not owned by given node. See [member Node.owner]. </description> diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index a4653344f0..0e6afec2d9 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -24,14 +24,14 @@ </constructor> <constructor name="PackedStringArray"> <return type="PackedStringArray" /> - <argument index="0" name="from" type="PackedStringArray" /> + <param index="0" name="from" type="PackedStringArray" /> <description> Constructs a [PackedStringArray] as a copy of the given [PackedStringArray]. </description> </constructor> <constructor name="PackedStringArray"> <return type="PackedStringArray" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedStringArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -40,22 +40,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedStringArray" /> + <param index="0" name="array" type="PackedStringArray" /> <description> Appends a [PackedStringArray] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="String" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="String" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -63,7 +63,7 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Returns the number of times an element is in the array. </description> @@ -76,30 +76,30 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="String" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="String" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="String" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="String" /> <description> Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -112,21 +112,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Appends a string element at end of the array. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -139,16 +139,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="String" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="String" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="String" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="String" /> <description> Changes the [String] at the given index. </description> @@ -161,8 +161,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedStringArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedStringArray]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -184,25 +184,25 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedStringArray" /> + <param index="0" name="right" type="PackedStringArray" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedStringArray" /> - <argument index="0" name="right" type="PackedStringArray" /> + <param index="0" name="right" type="PackedStringArray" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedStringArray" /> + <param index="0" name="right" type="PackedStringArray" /> <description> </description> </operator> <operator name="operator []"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml index 8f3e5d173d..97ed8cdc57 100644 --- a/doc/classes/PackedVector2Array.xml +++ b/doc/classes/PackedVector2Array.xml @@ -18,14 +18,14 @@ </constructor> <constructor name="PackedVector2Array"> <return type="PackedVector2Array" /> - <argument index="0" name="from" type="PackedVector2Array" /> + <param index="0" name="from" type="PackedVector2Array" /> <description> Constructs a [PackedVector2Array] as a copy of the given [PackedVector2Array]. </description> </constructor> <constructor name="PackedVector2Array"> <return type="PackedVector2Array" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -34,22 +34,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="Vector2" /> + <param index="0" name="value" type="Vector2" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedVector2Array" /> + <param index="0" name="array" type="PackedVector2Array" /> <description> Appends a [PackedVector2Array] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="Vector2" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="Vector2" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Vector2" /> + <param index="0" name="value" type="Vector2" /> <description> Returns the number of times an element is in the array. </description> @@ -70,30 +70,30 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="Vector2" /> + <param index="0" name="value" type="Vector2" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Vector2" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="Vector2" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="Vector2" /> + <param index="0" name="value" type="Vector2" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="Vector2" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="Vector2" /> <description> Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -106,21 +106,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="Vector2" /> + <param index="0" name="value" type="Vector2" /> <description> Inserts a [Vector2] at the end. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -133,16 +133,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Vector2" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="Vector2" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="Vector2" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="Vector2" /> <description> Changes the [Vector2] at the given index. </description> @@ -155,8 +155,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedVector2Array" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedVector2Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedVector2Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -178,31 +178,31 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedVector2Array" /> + <param index="0" name="right" type="PackedVector2Array" /> <description> </description> </operator> <operator name="operator *"> <return type="PackedVector2Array" /> - <argument index="0" name="right" type="Transform2D" /> + <param index="0" name="right" type="Transform2D" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedVector2Array" /> - <argument index="0" name="right" type="PackedVector2Array" /> + <param index="0" name="right" type="PackedVector2Array" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedVector2Array" /> + <param index="0" name="right" type="PackedVector2Array" /> <description> </description> </operator> <operator name="operator []"> <return type="Vector2" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index 1207293c32..102d68a22c 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -17,14 +17,14 @@ </constructor> <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> - <argument index="0" name="from" type="PackedVector3Array" /> + <param index="0" name="from" type="PackedVector3Array" /> <description> Constructs a [PackedVector3Array] as a copy of the given [PackedVector3Array]. </description> </constructor> <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> @@ -33,22 +33,22 @@ <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedVector3Array" /> + <param index="0" name="array" type="PackedVector3Array" /> <description> Appends a [PackedVector3Array] at the end of this array. </description> </method> <method name="bsearch"> <return type="int" /> - <argument index="0" name="value" type="Vector3" /> - <argument index="1" name="before" type="bool" default="true" /> + <param index="0" name="value" type="Vector3" /> + <param index="1" name="before" type="bool" default="true" /> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -56,7 +56,7 @@ </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Returns the number of times an element is in the array. </description> @@ -69,30 +69,30 @@ </method> <method name="fill"> <return type="void" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Vector3" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="value" type="Vector3" /> + <param index="1" name="from" type="int" default="0" /> <description> Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> <method name="has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Returns [code]true[/code] if the array contains [code]value[/code]. </description> </method> <method name="insert"> <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="Vector3" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="Vector3" /> <description> Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> @@ -105,21 +105,21 @@ </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="Vector3" /> + <param index="0" name="value" type="Vector3" /> <description> Inserts a [Vector3] at the end. </description> </method> <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> @@ -132,16 +132,16 @@ </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="value" type="Vector3" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="value" type="Vector3" /> + <param index="1" name="from" type="int" default="-1" /> <description> Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="Vector3" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="Vector3" /> <description> Changes the [Vector3] at the given index. </description> @@ -154,8 +154,8 @@ </method> <method name="slice" qualifiers="const"> <return type="PackedVector3Array" /> - <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" default="2147483647" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> Returns the slice of the [PackedVector3Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedVector3Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -177,31 +177,31 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="PackedVector3Array" /> + <param index="0" name="right" type="PackedVector3Array" /> <description> </description> </operator> <operator name="operator *"> <return type="PackedVector3Array" /> - <argument index="0" name="right" type="Transform3D" /> + <param index="0" name="right" type="Transform3D" /> <description> </description> </operator> <operator name="operator +"> <return type="PackedVector3Array" /> - <argument index="0" name="right" type="PackedVector3Array" /> + <param index="0" name="right" type="PackedVector3Array" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="PackedVector3Array" /> + <param index="0" name="right" type="PackedVector3Array" /> <description> </description> </operator> <operator name="operator []"> <return type="Vector3" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 40fa90e4da..6bfaa71838 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -30,7 +30,7 @@ </method> <method name="get_var"> <return type="Variant" /> - <argument index="0" name="allow_objects" type="bool" default="false" /> + <param index="0" name="allow_objects" type="bool" default="false" /> <description> Gets a Variant. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -38,15 +38,15 @@ </method> <method name="put_packet"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Sends a raw packet. </description> </method> <method name="put_var"> <return type="int" enum="Error" /> - <argument index="0" name="var" type="Variant" /> - <argument index="1" name="full_objects" type="bool" default="false" /> + <param index="0" name="var" type="Variant" /> + <param index="1" name="full_objects" type="bool" default="false" /> <description> Sends a [Variant] as a packet. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). </description> diff --git a/doc/classes/PacketPeerDTLS.xml b/doc/classes/PacketPeerDTLS.xml index ee45c42498..319740e76b 100644 --- a/doc/classes/PacketPeerDTLS.xml +++ b/doc/classes/PacketPeerDTLS.xml @@ -13,10 +13,10 @@ <methods> <method name="connect_to_peer"> <return type="int" enum="Error" /> - <argument index="0" name="packet_peer" type="PacketPeerUDP" /> - <argument index="1" name="validate_certs" type="bool" default="true" /> - <argument index="2" name="for_hostname" type="String" default="""" /> - <argument index="3" name="valid_certificate" type="X509Certificate" default="null" /> + <param index="0" name="packet_peer" type="PacketPeerUDP" /> + <param index="1" name="validate_certs" type="bool" default="true" /> + <param index="2" name="for_hostname" type="String" default="""" /> + <param index="3" name="valid_certificate" type="X509Certificate" default="null" /> <description> Connects a [code]peer[/code] beginning the DTLS handshake using the underlying [PacketPeerUDP] which must be connected (see [method PacketPeerUDP.connect_to_host]). If [code]validate_certs[/code] is [code]true[/code], [PacketPeerDTLS] will validate that the certificate presented by the remote peer and match it with the [code]for_hostname[/code] argument. You can specify a custom [X509Certificate] to use for validation via the [code]valid_certificate[/code] argument. </description> diff --git a/doc/classes/PacketPeerExtension.xml b/doc/classes/PacketPeerExtension.xml index 7cf5ef3504..28263b3f59 100644 --- a/doc/classes/PacketPeerExtension.xml +++ b/doc/classes/PacketPeerExtension.xml @@ -19,15 +19,15 @@ </method> <method name="_get_packet" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="r_buffer" type="const uint8_t **" /> - <argument index="1" name="r_buffer_size" type="int32_t*" /> + <param index="0" name="r_buffer" type="const uint8_t **" /> + <param index="1" name="r_buffer_size" type="int32_t*" /> <description> </description> </method> <method name="_put_packet" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_buffer" type="const uint8_t*" /> - <argument index="1" name="p_buffer_size" type="int" /> + <param index="0" name="p_buffer" type="const uint8_t*" /> + <param index="1" name="p_buffer_size" type="int" /> <description> </description> </method> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 7c6622be3c..bcd9f3fb46 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -12,9 +12,9 @@ <methods> <method name="bind"> <return type="int" enum="Error" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="bind_address" type="String" default=""*"" /> - <argument index="2" name="recv_buf_size" type="int" default="65536" /> + <param index="0" name="port" type="int" /> + <param index="1" name="bind_address" type="String" default=""*"" /> + <param index="2" name="recv_buf_size" type="int" default="65536" /> <description> Binds this [PacketPeerUDP] to the specified [code]port[/code] and [code]address[/code] with a buffer size [code]recv_buf_size[/code], allowing it to receive incoming packets. If [code]address[/code] is set to [code]"*"[/code] (default), the peer will be bound on all available addresses (both IPv4 and IPv6). @@ -30,8 +30,8 @@ </method> <method name="connect_to_host"> <return type="int" enum="Error" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="port" type="int" /> + <param index="0" name="host" type="String" /> + <param index="1" name="port" type="int" /> <description> Calling this method connects this UDP peer to the given [code]host[/code]/[code]port[/code] pair. UDP is in reality connectionless, so this option only means that incoming packets from different addresses are automatically discarded, and that outgoing packets are always sent to the connected address (future calls to [method set_dest_address] are not allowed). This method does not send any data to the remote peer, to do that, use [method PacketPeer.put_var] or [method PacketPeer.put_packet] as usual. See also [UDPServer]. [b]Note:[/b] Connecting to the remote peer does not help to protect from malicious attacks like IP spoofing, etc. Think about using an encryption technique like SSL or DTLS if you feel like your application is transferring sensitive information. @@ -69,8 +69,8 @@ </method> <method name="join_multicast_group"> <return type="int" enum="Error" /> - <argument index="0" name="multicast_address" type="String" /> - <argument index="1" name="interface_name" type="String" /> + <param index="0" name="multicast_address" type="String" /> + <param index="1" name="interface_name" type="String" /> <description> Joins the multicast group specified by [code]multicast_address[/code] using the interface identified by [code]interface_name[/code]. You can join the same multicast group with multiple interfaces. Use [method IP.get_local_interfaces] to know which are available. @@ -79,15 +79,15 @@ </method> <method name="leave_multicast_group"> <return type="int" enum="Error" /> - <argument index="0" name="multicast_address" type="String" /> - <argument index="1" name="interface_name" type="String" /> + <param index="0" name="multicast_address" type="String" /> + <param index="1" name="interface_name" type="String" /> <description> Removes the interface identified by [code]interface_name[/code] from the multicast group specified by [code]multicast_address[/code]. </description> </method> <method name="set_broadcast_enabled"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Enable or disable sending of broadcast packets (e.g. [code]set_dest_address("255.255.255.255", 4343)[/code]. This option is disabled by default. [b]Note:[/b] Some Android devices might require the [code]CHANGE_WIFI_MULTICAST_STATE[/code] permission and this option to be enabled to receive broadcast packets too. @@ -95,8 +95,8 @@ </method> <method name="set_dest_address"> <return type="int" enum="Error" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="port" type="int" /> + <param index="0" name="host" type="String" /> + <param index="1" name="port" type="int" /> <description> Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed. [b]Note:[/b] [method set_broadcast_enabled] must be enabled before sending packets to a broadcast address (e.g. [code]255.255.255.255[/code]). diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 7badd826d9..fe4caaa10c 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -13,60 +13,60 @@ <methods> <method name="get_param_max" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> + <param index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> <description> Returns the maximum value range for the given parameter. </description> </method> <method name="get_param_min" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> + <param index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> <description> Returns the minimum value range for the given parameter. </description> </method> <method name="get_param_texture" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> + <param index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> <description> Returns the [Texture2D] used by the specified parameter. </description> </method> <method name="get_particle_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="particle_flag" type="int" enum="ParticlesMaterial.ParticleFlags" /> + <param index="0" name="particle_flag" type="int" enum="ParticlesMaterial.ParticleFlags" /> <description> Returns [code]true[/code] if the specified particle flag is enabled. See [enum ParticleFlags] for options. </description> </method> <method name="set_param_max"> <return type="void" /> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> + <param index="1" name="value" type="float" /> <description> Sets the maximum value range for the given parameter. </description> </method> <method name="set_param_min"> <return type="void" /> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> + <param index="1" name="value" type="float" /> <description> Sets the minimum value range for the given parameter. </description> </method> <method name="set_param_texture"> <return type="void" /> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> + <param index="1" name="texture" type="Texture2D" /> <description> Sets the [Texture2D] for the specified [enum Parameter]. </description> </method> <method name="set_particle_flag"> <return type="void" /> - <argument index="0" name="particle_flag" type="int" enum="ParticlesMaterial.ParticleFlags" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="particle_flag" type="int" enum="ParticlesMaterial.ParticleFlags" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], enables the specified particle flag. See [enum ParticleFlags] for options. </description> diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index 01da9cb9a2..f61c051a52 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -15,9 +15,9 @@ <methods> <method name="add_custom_monitor"> <return type="void" /> - <argument index="0" name="id" type="StringName" /> - <argument index="1" name="callable" type="Callable" /> - <argument index="2" name="arguments" type="Array" default="[]" /> + <param index="0" name="id" type="StringName" /> + <param index="1" name="callable" type="Callable" /> + <param index="2" name="arguments" type="Array" default="[]" /> <description> Adds a custom monitor with the name [code]id[/code]. You can specify the category of the monitor using slash delimiters in [code]id[/code] (for example: [code]"Game/NumberOfNPCs"[/code]). If there is more than one slash delimiter, then the default category is used. The default category is [code]"Custom"[/code]. Prints an error if given [code]id[/code] is already present. [codeblocks] @@ -73,7 +73,7 @@ </method> <method name="get_custom_monitor"> <return type="Variant" /> - <argument index="0" name="id" type="StringName" /> + <param index="0" name="id" type="StringName" /> <description> Returns the value of custom monitor with given [code]id[/code]. The callable is called to get the value of custom monitor. See also [method has_custom_monitor]. Prints an error if the given [code]id[/code] is absent. </description> @@ -86,7 +86,7 @@ </method> <method name="get_monitor" qualifiers="const"> <return type="float" /> - <argument index="0" name="monitor" type="int" enum="Performance.Monitor" /> + <param index="0" name="monitor" type="int" enum="Performance.Monitor" /> <description> Returns the value of one of the available built-in monitors. You should provide one of the [enum Monitor] constants as the argument, like this: [codeblocks] @@ -108,14 +108,14 @@ </method> <method name="has_custom_monitor"> <return type="bool" /> - <argument index="0" name="id" type="StringName" /> + <param index="0" name="id" type="StringName" /> <description> Returns [code]true[/code] if custom monitor with the given [code]id[/code] is present, [code]false[/code] otherwise. </description> </method> <method name="remove_custom_monitor"> <return type="void" /> - <argument index="0" name="id" type="StringName" /> + <param index="0" name="id" type="StringName" /> <description> Removes the custom monitor with given [code]id[/code]. Prints an error if the given [code]id[/code] is already absent. </description> diff --git a/doc/classes/PhysicalBone3D.xml b/doc/classes/PhysicalBone3D.xml index 7e8cc91766..0768df31cc 100644 --- a/doc/classes/PhysicalBone3D.xml +++ b/doc/classes/PhysicalBone3D.xml @@ -9,21 +9,21 @@ <methods> <method name="_integrate_forces" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="state" type="PhysicsDirectBodyState3D" /> + <param index="0" name="state" type="PhysicsDirectBodyState3D" /> <description> Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but the [member custom_integrator] property allows you to disable the default behavior and do fully custom force integration for a body. </description> </method> <method name="apply_central_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> + <param index="0" name="impulse" type="Vector3" /> <description> </description> </method> <method name="apply_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> - <argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="impulse" type="Vector3" /> + <param index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> </description> </method> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index 9cebd68d76..b9bffafdef 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -12,7 +12,7 @@ <methods> <method name="add_collision_exception_with"> <return type="void" /> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Adds a body to the list of bodies that this body can't collide with. </description> @@ -25,9 +25,9 @@ </method> <method name="move_and_collide"> <return type="KinematicCollision2D" /> - <argument index="0" name="distance" type="Vector2" /> - <argument index="1" name="test_only" type="bool" default="false" /> - <argument index="2" name="safe_margin" type="float" default="0.08" /> + <param index="0" name="distance" type="Vector2" /> + <param index="1" name="test_only" type="bool" default="false" /> + <param index="2" name="safe_margin" type="float" default="0.08" /> <description> Moves the body along the vector [code]distance[/code]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. Returns a [KinematicCollision2D], which contains information about the collision when stopped, or when touching another body along the motion. @@ -37,17 +37,17 @@ </method> <method name="remove_collision_exception_with"> <return type="void" /> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Removes a body from the list of bodies that this body can't collide with. </description> </method> <method name="test_move"> <return type="bool" /> - <argument index="0" name="from" type="Transform2D" /> - <argument index="1" name="distance" type="Vector2" /> - <argument index="2" name="collision" type="KinematicCollision2D" default="null" /> - <argument index="3" name="safe_margin" type="float" default="0.08" /> + <param index="0" name="from" type="Transform2D" /> + <param index="1" name="distance" type="Vector2" /> + <param index="2" name="collision" type="KinematicCollision2D" default="null" /> + <param index="3" name="safe_margin" type="float" default="0.08" /> <description> Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]distance[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. diff --git a/doc/classes/PhysicsBody3D.xml b/doc/classes/PhysicsBody3D.xml index 843f813997..4a641e5040 100644 --- a/doc/classes/PhysicsBody3D.xml +++ b/doc/classes/PhysicsBody3D.xml @@ -12,14 +12,14 @@ <methods> <method name="add_collision_exception_with"> <return type="void" /> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Adds a body to the list of bodies that this body can't collide with. </description> </method> <method name="get_axis_lock" qualifiers="const"> <return type="bool" /> - <argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> + <param index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> <description> Returns [code]true[/code] if the specified linear or rotational [code]axis[/code] is locked. </description> @@ -32,10 +32,10 @@ </method> <method name="move_and_collide"> <return type="KinematicCollision3D" /> - <argument index="0" name="distance" type="Vector3" /> - <argument index="1" name="test_only" type="bool" default="false" /> - <argument index="2" name="safe_margin" type="float" default="0.001" /> - <argument index="3" name="max_collisions" type="int" default="1" /> + <param index="0" name="distance" type="Vector3" /> + <param index="1" name="test_only" type="bool" default="false" /> + <param index="2" name="safe_margin" type="float" default="0.001" /> + <param index="3" name="max_collisions" type="int" default="1" /> <description> Moves the body along the vector [code]distance[/code]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. The body will stop if it collides. Returns a [KinematicCollision3D], which contains information about the collision when stopped, or when touching another body along the motion. @@ -46,26 +46,26 @@ </method> <method name="remove_collision_exception_with"> <return type="void" /> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Removes a body from the list of bodies that this body can't collide with. </description> </method> <method name="set_axis_lock"> <return type="void" /> - <argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> - <argument index="1" name="lock" type="bool" /> + <param index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> + <param index="1" name="lock" type="bool" /> <description> Locks or unlocks the specified linear or rotational [code]axis[/code] depending on the value of [code]lock[/code]. </description> </method> <method name="test_move"> <return type="bool" /> - <argument index="0" name="from" type="Transform3D" /> - <argument index="1" name="distance" type="Vector3" /> - <argument index="2" name="collision" type="KinematicCollision3D" default="null" /> - <argument index="3" name="safe_margin" type="float" default="0.001" /> - <argument index="4" name="max_collisions" type="int" default="1" /> + <param index="0" name="from" type="Transform3D" /> + <param index="1" name="distance" type="Vector3" /> + <param index="2" name="collision" type="KinematicCollision3D" default="null" /> + <param index="3" name="safe_margin" type="float" default="0.001" /> + <param index="4" name="max_collisions" type="int" default="1" /> <description> Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [code]distance[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. diff --git a/doc/classes/PhysicsDirectBodyState2D.xml b/doc/classes/PhysicsDirectBodyState2D.xml index 783b0488d8..56367fbf0c 100644 --- a/doc/classes/PhysicsDirectBodyState2D.xml +++ b/doc/classes/PhysicsDirectBodyState2D.xml @@ -13,7 +13,7 @@ <methods> <method name="add_constant_central_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="force" type="Vector2" default="Vector2(0, 0)" /> <description> Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector2(0, 0)[/code]. This is equivalent to using [method add_constant_force] at the body's center of mass. @@ -21,8 +21,8 @@ </method> <method name="add_constant_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" /> - <argument index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="force" type="Vector2" /> + <param index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector2(0, 0)[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -30,14 +30,14 @@ </method> <method name="add_constant_torque"> <return type="void" /> - <argument index="0" name="torque" type="float" /> + <param index="0" name="torque" type="float" /> <description> Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = 0[/code]. </description> </method> <method name="apply_central_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="force" type="Vector2" default="Vector2(0, 0)" /> <description> Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method apply_force] at the body's center of mass. @@ -45,7 +45,7 @@ </method> <method name="apply_central_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector2" /> + <param index="0" name="impulse" type="Vector2" /> <description> Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -54,8 +54,8 @@ </method> <method name="apply_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" /> - <argument index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="force" type="Vector2" /> + <param index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -63,8 +63,8 @@ </method> <method name="apply_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector2" /> - <argument index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="impulse" type="Vector2" /> + <param index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -73,14 +73,14 @@ </method> <method name="apply_torque"> <return type="void" /> - <argument index="0" name="torque" type="float" /> + <param index="0" name="torque" type="float" /> <description> Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. </description> </method> <method name="apply_torque_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="float" /> + <param index="0" name="impulse" type="float" /> <description> Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -102,42 +102,42 @@ </method> <method name="get_contact_collider" qualifiers="const"> <return type="RID" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the collider's [RID]. </description> </method> <method name="get_contact_collider_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the collider's object id. </description> </method> <method name="get_contact_collider_object" qualifiers="const"> <return type="Object" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it). </description> </method> <method name="get_contact_collider_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the contact position in the collider. </description> </method> <method name="get_contact_collider_shape" qualifiers="const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the collider's shape index. </description> </method> <method name="get_contact_collider_velocity_at_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the linear velocity vector at the collider's contact point. </description> @@ -151,21 +151,21 @@ </method> <method name="get_contact_local_normal" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the local normal at the contact point. </description> </method> <method name="get_contact_local_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the local position of the contact point. </description> </method> <method name="get_contact_local_shape" qualifiers="const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the local shape index of the collision. </description> @@ -178,7 +178,7 @@ </method> <method name="get_velocity_at_local_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="local_position" type="Vector2" /> + <param index="0" name="local_position" type="Vector2" /> <description> Returns the body's velocity at the given relative position, including both translation and rotation. </description> @@ -191,7 +191,7 @@ </method> <method name="set_constant_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" /> + <param index="0" name="force" type="Vector2" /> <description> Sets the body's total constant positional forces applied during each physics update. See [method add_constant_force] and [method add_constant_central_force]. @@ -199,7 +199,7 @@ </method> <method name="set_constant_torque"> <return type="void" /> - <argument index="0" name="torque" type="float" /> + <param index="0" name="torque" type="float" /> <description> Sets the body's total constant rotational forces applied during each physics update. See [method add_constant_torque]. diff --git a/doc/classes/PhysicsDirectBodyState3D.xml b/doc/classes/PhysicsDirectBodyState3D.xml index 16c53b0727..b05960b035 100644 --- a/doc/classes/PhysicsDirectBodyState3D.xml +++ b/doc/classes/PhysicsDirectBodyState3D.xml @@ -13,7 +13,7 @@ <methods> <method name="add_constant_central_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="force" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code]. This is equivalent to using [method add_constant_force] at the body's center of mass. @@ -21,8 +21,8 @@ </method> <method name="add_constant_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> - <argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="force" type="Vector3" /> + <param index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -30,14 +30,14 @@ </method> <method name="add_constant_torque"> <return type="void" /> - <argument index="0" name="torque" type="Vector3" /> + <param index="0" name="torque" type="Vector3" /> <description> Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = Vector3(0, 0, 0)[/code]. </description> </method> <method name="apply_central_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="force" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method apply_force] at the body's center of mass. @@ -45,7 +45,7 @@ </method> <method name="apply_central_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="impulse" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -54,8 +54,8 @@ </method> <method name="apply_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> - <argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="force" type="Vector3" /> + <param index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -63,8 +63,8 @@ </method> <method name="apply_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> - <argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="impulse" type="Vector3" /> + <param index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -73,14 +73,14 @@ </method> <method name="apply_torque"> <return type="void" /> - <argument index="0" name="torque" type="Vector3" /> + <param index="0" name="torque" type="Vector3" /> <description> Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. </description> </method> <method name="apply_torque_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> + <param index="0" name="impulse" type="Vector3" /> <description> Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -102,42 +102,42 @@ </method> <method name="get_contact_collider" qualifiers="const"> <return type="RID" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the collider's [RID]. </description> </method> <method name="get_contact_collider_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the collider's object id. </description> </method> <method name="get_contact_collider_object" qualifiers="const"> <return type="Object" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the collider object. </description> </method> <method name="get_contact_collider_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the contact position in the collider. </description> </method> <method name="get_contact_collider_shape" qualifiers="const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the collider's shape index. </description> </method> <method name="get_contact_collider_velocity_at_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the linear velocity vector at the collider's contact point. </description> @@ -151,28 +151,28 @@ </method> <method name="get_contact_impulse" qualifiers="const"> <return type="float" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Impulse created by the contact. Only implemented for Bullet physics. </description> </method> <method name="get_contact_local_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the local normal at the contact point. </description> </method> <method name="get_contact_local_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the local position of the contact point. </description> </method> <method name="get_contact_local_shape" qualifiers="const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> Returns the local shape index of the collision. </description> @@ -185,7 +185,7 @@ </method> <method name="get_velocity_at_local_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="local_position" type="Vector3" /> + <param index="0" name="local_position" type="Vector3" /> <description> Returns the body's velocity at the given relative position, including both translation and rotation. </description> @@ -198,7 +198,7 @@ </method> <method name="set_constant_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> + <param index="0" name="force" type="Vector3" /> <description> Sets the body's total constant positional forces applied during each physics update. See [method add_constant_force] and [method add_constant_central_force]. @@ -206,7 +206,7 @@ </method> <method name="set_constant_torque"> <return type="void" /> - <argument index="0" name="torque" type="Vector3" /> + <param index="0" name="torque" type="Vector3" /> <description> Sets the body's total constant rotational forces applied during each physics update. See [method add_constant_torque]. diff --git a/doc/classes/PhysicsDirectBodyState3DExtension.xml b/doc/classes/PhysicsDirectBodyState3DExtension.xml index f0659f8f1b..ade197eadc 100644 --- a/doc/classes/PhysicsDirectBodyState3DExtension.xml +++ b/doc/classes/PhysicsDirectBodyState3DExtension.xml @@ -9,58 +9,58 @@ <methods> <method name="_add_constant_central_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> + <param index="0" name="force" type="Vector3" /> <description> </description> </method> <method name="_add_constant_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="force" type="Vector3" /> + <param index="1" name="position" type="Vector3" /> <description> </description> </method> <method name="_add_constant_torque" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="torque" type="Vector3" /> + <param index="0" name="torque" type="Vector3" /> <description> </description> </method> <method name="_apply_central_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> + <param index="0" name="force" type="Vector3" /> <description> </description> </method> <method name="_apply_central_impulse" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> + <param index="0" name="impulse" type="Vector3" /> <description> </description> </method> <method name="_apply_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="force" type="Vector3" /> + <param index="1" name="position" type="Vector3" /> <description> </description> </method> <method name="_apply_impulse" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="impulse" type="Vector3" /> + <param index="1" name="position" type="Vector3" /> <description> </description> </method> <method name="_apply_torque" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="torque" type="Vector3" /> + <param index="0" name="torque" type="Vector3" /> <description> </description> </method> <method name="_apply_torque_impulse" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> + <param index="0" name="impulse" type="Vector3" /> <description> </description> </method> @@ -91,37 +91,37 @@ </method> <method name="_get_contact_collider" qualifiers="virtual const"> <return type="RID" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> <method name="_get_contact_collider_id" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> <method name="_get_contact_collider_object" qualifiers="virtual const"> <return type="Object" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> <method name="_get_contact_collider_position" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> <method name="_get_contact_collider_shape" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> <method name="_get_contact_collider_velocity_at_position" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> @@ -132,25 +132,25 @@ </method> <method name="_get_contact_impulse" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> <method name="_get_contact_local_normal" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> <method name="_get_contact_local_position" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> <method name="_get_contact_local_shape" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="contact_idx" type="int" /> + <param index="0" name="contact_idx" type="int" /> <description> </description> </method> @@ -206,7 +206,7 @@ </method> <method name="_get_velocity_at_local_position" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="local_position" type="Vector3" /> + <param index="0" name="local_position" type="Vector3" /> <description> </description> </method> @@ -222,37 +222,37 @@ </method> <method name="_set_angular_velocity" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="velocity" type="Vector3" /> + <param index="0" name="velocity" type="Vector3" /> <description> </description> </method> <method name="_set_constant_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> + <param index="0" name="force" type="Vector3" /> <description> </description> </method> <method name="_set_constant_torque" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="torque" type="Vector3" /> + <param index="0" name="torque" type="Vector3" /> <description> </description> </method> <method name="_set_linear_velocity" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="velocity" type="Vector3" /> + <param index="0" name="velocity" type="Vector3" /> <description> </description> </method> <method name="_set_sleep_state" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> </description> </method> <method name="_set_transform" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="transform" type="Transform3D" /> + <param index="0" name="transform" type="Transform3D" /> <description> </description> </method> diff --git a/doc/classes/PhysicsDirectSpaceState2D.xml b/doc/classes/PhysicsDirectSpaceState2D.xml index 0b95243fe6..e5a9e5dacf 100644 --- a/doc/classes/PhysicsDirectSpaceState2D.xml +++ b/doc/classes/PhysicsDirectSpaceState2D.xml @@ -13,7 +13,7 @@ <methods> <method name="cast_motion"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> <description> Checks how far a [Shape2D] can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a [PhysicsShapeQueryParameters2D] object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned. @@ -22,8 +22,8 @@ </method> <method name="collide_shape"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters2D] object, second one is in the collided shape from the physics space. @@ -31,7 +31,7 @@ </method> <method name="get_rest_info"> <return type="Dictionary" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead. [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The returned object is a dictionary containing the following fields: @@ -45,8 +45,8 @@ </method> <method name="intersect_point"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsPointQueryParameters2D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsPointQueryParameters2D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks whether a point is inside any solid shape. Position and other parameters are defined through [PhysicsPointQueryParameters2D]. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. @@ -59,7 +59,7 @@ </method> <method name="intersect_ray"> <return type="Dictionary" /> - <argument index="0" name="parameters" type="PhysicsRayQueryParameters2D" /> + <param index="0" name="parameters" type="PhysicsRayQueryParameters2D" /> <description> Intersects a ray in a given space. Ray position and other parameters are defined through [PhysicsRayQueryParameters2D]. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. @@ -73,8 +73,8 @@ </method> <method name="intersect_shape"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. diff --git a/doc/classes/PhysicsDirectSpaceState3D.xml b/doc/classes/PhysicsDirectSpaceState3D.xml index 048baed345..6539edd4fe 100644 --- a/doc/classes/PhysicsDirectSpaceState3D.xml +++ b/doc/classes/PhysicsDirectSpaceState3D.xml @@ -13,7 +13,7 @@ <methods> <method name="cast_motion"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> <description> Checks how far a [Shape3D] can move without colliding. All the parameters for the query, including the shape, are supplied through a [PhysicsShapeQueryParameters3D] object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned. @@ -22,8 +22,8 @@ </method> <method name="collide_shape"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters3D] object, second one is in the collided shape from the physics space. @@ -32,7 +32,7 @@ </method> <method name="get_rest_info"> <return type="Dictionary" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields: [code]collider_id[/code]: The colliding object's ID. @@ -47,8 +47,8 @@ </method> <method name="intersect_point"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsPointQueryParameters3D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsPointQueryParameters3D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks whether a point is inside any solid shape. Position and other parameters are defined through [PhysicsPointQueryParameters3D]. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. @@ -60,7 +60,7 @@ </method> <method name="intersect_ray"> <return type="Dictionary" /> - <argument index="0" name="parameters" type="PhysicsRayQueryParameters3D" /> + <param index="0" name="parameters" type="PhysicsRayQueryParameters3D" /> <description> Intersects a ray in a given space. Ray position and other parameters are defined through [PhysicsRayQueryParameters3D]. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. @@ -74,8 +74,8 @@ </method> <method name="intersect_shape"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. diff --git a/doc/classes/PhysicsDirectSpaceState3DExtension.xml b/doc/classes/PhysicsDirectSpaceState3DExtension.xml index f150907963..98593012db 100644 --- a/doc/classes/PhysicsDirectSpaceState3DExtension.xml +++ b/doc/classes/PhysicsDirectSpaceState3DExtension.xml @@ -9,89 +9,89 @@ <methods> <method name="_cast_motion" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shape_rid" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> - <argument index="2" name="motion" type="Vector3" /> - <argument index="3" name="margin" type="float" /> - <argument index="4" name="collision_mask" type="int" /> - <argument index="5" name="collide_with_bodies" type="bool" /> - <argument index="6" name="collide_with_areas" type="bool" /> - <argument index="7" name="closest_safe" type="float*" /> - <argument index="8" name="closest_unsafe" type="float*" /> - <argument index="9" name="info" type="PhysicsServer3DExtensionShapeRestInfo*" /> + <param index="0" name="shape_rid" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> + <param index="2" name="motion" type="Vector3" /> + <param index="3" name="margin" type="float" /> + <param index="4" name="collision_mask" type="int" /> + <param index="5" name="collide_with_bodies" type="bool" /> + <param index="6" name="collide_with_areas" type="bool" /> + <param index="7" name="closest_safe" type="float*" /> + <param index="8" name="closest_unsafe" type="float*" /> + <param index="9" name="info" type="PhysicsServer3DExtensionShapeRestInfo*" /> <description> </description> </method> <method name="_collide_shape" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shape_rid" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> - <argument index="2" name="motion" type="Vector3" /> - <argument index="3" name="margin" type="float" /> - <argument index="4" name="collision_mask" type="int" /> - <argument index="5" name="collide_with_bodies" type="bool" /> - <argument index="6" name="collide_with_areas" type="bool" /> - <argument index="7" name="results" type="void*" /> - <argument index="8" name="max_results" type="int" /> - <argument index="9" name="result_count" type="int32_t*" /> + <param index="0" name="shape_rid" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> + <param index="2" name="motion" type="Vector3" /> + <param index="3" name="margin" type="float" /> + <param index="4" name="collision_mask" type="int" /> + <param index="5" name="collide_with_bodies" type="bool" /> + <param index="6" name="collide_with_areas" type="bool" /> + <param index="7" name="results" type="void*" /> + <param index="8" name="max_results" type="int" /> + <param index="9" name="result_count" type="int32_t*" /> <description> </description> </method> <method name="_get_closest_point_to_object_volume" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="object" type="RID" /> - <argument index="1" name="point" type="Vector3" /> + <param index="0" name="object" type="RID" /> + <param index="1" name="point" type="Vector3" /> <description> </description> </method> <method name="_intersect_point" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="position" type="Vector3" /> - <argument index="1" name="collision_mask" type="int" /> - <argument index="2" name="collide_with_bodies" type="bool" /> - <argument index="3" name="collide_with_areas" type="bool" /> - <argument index="4" name="results" type="PhysicsServer3DExtensionShapeResult*" /> - <argument index="5" name="max_results" type="int" /> + <param index="0" name="position" type="Vector3" /> + <param index="1" name="collision_mask" type="int" /> + <param index="2" name="collide_with_bodies" type="bool" /> + <param index="3" name="collide_with_areas" type="bool" /> + <param index="4" name="results" type="PhysicsServer3DExtensionShapeResult*" /> + <param index="5" name="max_results" type="int" /> <description> </description> </method> <method name="_intersect_ray" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> - <argument index="2" name="collision_mask" type="int" /> - <argument index="3" name="collide_with_bodies" type="bool" /> - <argument index="4" name="collide_with_areas" type="bool" /> - <argument index="5" name="hit_from_inside" type="bool" /> - <argument index="6" name="hit_back_faces" type="bool" /> - <argument index="7" name="result" type="PhysicsServer3DExtensionRayResult*" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> + <param index="2" name="collision_mask" type="int" /> + <param index="3" name="collide_with_bodies" type="bool" /> + <param index="4" name="collide_with_areas" type="bool" /> + <param index="5" name="hit_from_inside" type="bool" /> + <param index="6" name="hit_back_faces" type="bool" /> + <param index="7" name="result" type="PhysicsServer3DExtensionRayResult*" /> <description> </description> </method> <method name="_intersect_shape" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="shape_rid" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> - <argument index="2" name="motion" type="Vector3" /> - <argument index="3" name="margin" type="float" /> - <argument index="4" name="collision_mask" type="int" /> - <argument index="5" name="collide_with_bodies" type="bool" /> - <argument index="6" name="collide_with_areas" type="bool" /> - <argument index="7" name="result_count" type="PhysicsServer3DExtensionShapeResult*" /> - <argument index="8" name="max_results" type="int" /> + <param index="0" name="shape_rid" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> + <param index="2" name="motion" type="Vector3" /> + <param index="3" name="margin" type="float" /> + <param index="4" name="collision_mask" type="int" /> + <param index="5" name="collide_with_bodies" type="bool" /> + <param index="6" name="collide_with_areas" type="bool" /> + <param index="7" name="result_count" type="PhysicsServer3DExtensionShapeResult*" /> + <param index="8" name="max_results" type="int" /> <description> </description> </method> <method name="_rest_info" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shape_rid" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> - <argument index="2" name="motion" type="Vector3" /> - <argument index="3" name="margin" type="float" /> - <argument index="4" name="collision_mask" type="int" /> - <argument index="5" name="collide_with_bodies" type="bool" /> - <argument index="6" name="collide_with_areas" type="bool" /> - <argument index="7" name="rest_info" type="PhysicsServer3DExtensionShapeRestInfo*" /> + <param index="0" name="shape_rid" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> + <param index="2" name="motion" type="Vector3" /> + <param index="3" name="margin" type="float" /> + <param index="4" name="collision_mask" type="int" /> + <param index="5" name="collide_with_bodies" type="bool" /> + <param index="6" name="collide_with_areas" type="bool" /> + <param index="7" name="rest_info" type="PhysicsServer3DExtensionShapeRestInfo*" /> <description> </description> </method> diff --git a/doc/classes/PhysicsRayQueryParameters2D.xml b/doc/classes/PhysicsRayQueryParameters2D.xml index 1cfc6caadf..5afd3973a0 100644 --- a/doc/classes/PhysicsRayQueryParameters2D.xml +++ b/doc/classes/PhysicsRayQueryParameters2D.xml @@ -11,10 +11,10 @@ <methods> <method name="create" qualifiers="static"> <return type="PhysicsRayQueryParameters2D" /> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> - <argument index="2" name="collision_mask" type="int" default="4294967295" /> - <argument index="3" name="exclude" type="Array" default="[]" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> + <param index="2" name="collision_mask" type="int" default="4294967295" /> + <param index="3" name="exclude" type="Array" default="[]" /> <description> Returns a new, pre-configured [PhysicsRayQueryParameters2D] object. Use it to quickly create query parameters using the most common options. [codeblock] diff --git a/doc/classes/PhysicsRayQueryParameters3D.xml b/doc/classes/PhysicsRayQueryParameters3D.xml index e9216a8300..620aa6bf5f 100644 --- a/doc/classes/PhysicsRayQueryParameters3D.xml +++ b/doc/classes/PhysicsRayQueryParameters3D.xml @@ -11,10 +11,10 @@ <methods> <method name="create" qualifiers="static"> <return type="PhysicsRayQueryParameters3D" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> - <argument index="2" name="collision_mask" type="int" default="4294967295" /> - <argument index="3" name="exclude" type="Array" default="[]" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> + <param index="2" name="collision_mask" type="int" default="4294967295" /> + <param index="3" name="exclude" type="Array" default="[]" /> <description> Returns a new, pre-configured [PhysicsRayQueryParameters3D] object. Use it to quickly create query parameters using the most common options. [codeblock] diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index 1413a3ec11..4bb44223b3 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -11,32 +11,32 @@ <methods> <method name="area_add_shape"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape" type="RID" /> - <argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> - <argument index="3" name="disabled" type="bool" default="false" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape" type="RID" /> + <param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> + <param index="3" name="disabled" type="bool" default="false" /> <description> Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="area_attach_canvas_instance_id"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="id" type="int" /> <description> </description> </method> <method name="area_attach_object_instance_id"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="id" type="int" /> <description> Assigns the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="area_clear_shapes"> <return type="void" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. </description> @@ -49,97 +49,97 @@ </method> <method name="area_get_canvas_instance_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> </description> </method> <method name="area_get_object_instance_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Gets the instance ID of the object the area is assigned to. </description> </method> <method name="area_get_param" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" /> <description> Returns an area parameter value. See [enum AreaParameter] for a list of available parameters. </description> </method> <method name="area_get_shape" qualifiers="const"> <return type="RID" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Returns the [RID] of the nth shape of an area. </description> </method> <method name="area_get_shape_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Returns the number of shapes assigned to an area. </description> </method> <method name="area_get_shape_transform" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Returns the transform matrix of a shape within an area. </description> </method> <method name="area_get_space" qualifiers="const"> <return type="RID" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Returns the space assigned to the area. </description> </method> <method name="area_get_transform" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Returns the transform matrix for an area. </description> </method> <method name="area_remove_shape"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Removes a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> <method name="area_set_area_monitor_callback"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="callback" type="Callable" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="callback" type="Callable" /> <description> </description> </method> <method name="area_set_collision_layer"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="layer" type="int" /> <description> Assigns the area to one or many physics layers. </description> </method> <method name="area_set_collision_mask"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="mask" type="int" /> <description> Sets which physics layers the area will monitor. </description> </method> <method name="area_set_monitor_callback"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="callback" type="Callable" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="callback" type="Callable" /> <description> Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. @@ -151,75 +151,75 @@ </method> <method name="area_set_monitorable"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="monitorable" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="monitorable" type="bool" /> <description> </description> </method> <method name="area_set_param"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" /> + <param index="2" name="value" type="Variant" /> <description> Sets the value for an area parameter. See [enum AreaParameter] for a list of available parameters. </description> </method> <method name="area_set_shape"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="shape" type="RID" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="shape" type="RID" /> <description> Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="area_set_shape_disabled"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="disabled" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="disabled" type="bool" /> <description> Disables a given shape in an area. </description> </method> <method name="area_set_shape_transform"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="transform" type="Transform2D" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="transform" type="Transform2D" /> <description> Sets the transform matrix for an area shape. </description> </method> <method name="area_set_space"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="space" type="RID" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="space" type="RID" /> <description> Assigns a space to the area. </description> </method> <method name="area_set_transform"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets the transform matrix for an area. </description> </method> <method name="body_add_collision_exception"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="excepted_body" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="excepted_body" type="RID" /> <description> Adds a body to the list of bodies exempt from collisions. </description> </method> <method name="body_add_constant_central_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector2" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector2" /> <description> Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector2(0, 0))[/code]. This is equivalent to using [method body_add_constant_force] at the body's center of mass. @@ -227,9 +227,9 @@ </method> <method name="body_add_constant_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector2" /> - <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector2" /> + <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector2(0, 0))[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -237,26 +237,26 @@ </method> <method name="body_add_constant_torque"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="float" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="float" /> <description> Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]body_set_constant_torque(body, 0)[/code]. </description> </method> <method name="body_add_shape"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape" type="RID" /> - <argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> - <argument index="3" name="disabled" type="bool" default="false" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape" type="RID" /> + <param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> + <param index="3" name="disabled" type="bool" default="false" /> <description> Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="body_apply_central_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector2" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector2" /> <description> Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method body_apply_force] at the body's center of mass. @@ -264,8 +264,8 @@ </method> <method name="body_apply_central_impulse"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="Vector2" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="Vector2" /> <description> Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -274,9 +274,9 @@ </method> <method name="body_apply_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector2" /> - <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector2" /> + <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -284,9 +284,9 @@ </method> <method name="body_apply_impulse"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="Vector2" /> - <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="Vector2" /> + <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -295,16 +295,16 @@ </method> <method name="body_apply_torque"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="float" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="float" /> <description> Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. </description> </method> <method name="body_apply_torque_impulse"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="float" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="float" /> <description> Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -312,22 +312,22 @@ </method> <method name="body_attach_canvas_instance_id"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="id" type="int" /> <description> </description> </method> <method name="body_attach_object_instance_id"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="id" type="int" /> <description> Assigns the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="body_clear_shapes"> <return type="void" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Removes all shapes from a body. </description> @@ -340,27 +340,27 @@ </method> <method name="body_get_canvas_instance_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="body_get_collision_layer" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the physics layer or layers a body belongs to. </description> </method> <method name="body_get_collision_mask" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the physics layer or layers a body can collide with. </description> </method> <method name="body_get_constant_force" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the body's total constant positional forces applied during each physics update. See [method body_add_constant_force] and [method body_add_constant_central_force]. @@ -368,7 +368,7 @@ </method> <method name="body_get_constant_torque" qualifiers="const"> <return type="float" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the body's total constant rotational forces applied during each physics update. See [method body_add_constant_torque]. @@ -376,143 +376,143 @@ </method> <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> <return type="int" enum="PhysicsServer2D.CCDMode" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the continuous collision detection mode. </description> </method> <method name="body_get_direct_state"> <return type="PhysicsDirectBodyState2D" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the [PhysicsDirectBodyState2D] of the body. Returns [code]null[/code] if the body is destroyed or removed from the physics space. </description> </method> <method name="body_get_max_contacts_reported" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. </description> </method> <method name="body_get_mode" qualifiers="const"> <return type="int" enum="PhysicsServer2D.BodyMode" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the body mode. </description> </method> <method name="body_get_object_instance_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Gets the instance ID of the object the area is assigned to. </description> </method> <method name="body_get_param" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" /> <description> Returns the value of a body parameter. See [enum BodyParameter] for a list of available parameters. </description> </method> <method name="body_get_shape" qualifiers="const"> <return type="RID" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Returns the [RID] of the nth shape of a body. </description> </method> <method name="body_get_shape_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the number of shapes assigned to a body. </description> </method> <method name="body_get_shape_transform" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Returns the transform matrix of a body shape. </description> </method> <method name="body_get_space" qualifiers="const"> <return type="RID" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the [RID] of the space assigned to a body. </description> </method> <method name="body_get_state" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" /> <description> Returns a body state. </description> </method> <method name="body_is_omitting_force_integration" qualifiers="const"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_remove_collision_exception"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="excepted_body" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="excepted_body" type="RID" /> <description> Removes a body from the list of bodies exempt from collisions. </description> </method> <method name="body_remove_shape"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. </description> </method> <method name="body_reset_mass_properties"> <return type="void" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using [method body_set_param]. </description> </method> <method name="body_set_axis_velocity"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="axis_velocity" type="Vector2" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="axis_velocity" type="Vector2" /> <description> Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="body_set_collision_layer"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="layer" type="int" /> <description> Sets the physics layer or layers a body belongs to. </description> </method> <method name="body_set_collision_mask"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="mask" type="int" /> <description> Sets the physics layer or layers a body can collide with. </description> </method> <method name="body_set_constant_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector2" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector2" /> <description> Sets the body's total constant positional forces applied during each physics update. See [method body_add_constant_force] and [method body_add_constant_central_force]. @@ -520,8 +520,8 @@ </method> <method name="body_set_constant_torque"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="float" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="float" /> <description> Sets the body's total constant rotational forces applied during each physics update. See [method body_add_constant_torque]. @@ -529,8 +529,8 @@ </method> <method name="body_set_continuous_collision_detection_mode"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="mode" type="int" enum="PhysicsServer2D.CCDMode" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="mode" type="int" enum="PhysicsServer2D.CCDMode" /> <description> Sets the continuous collision detection mode using one of the [enum CCDMode] constants. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. @@ -538,9 +538,9 @@ </method> <method name="body_set_force_integration_callback"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="callable" type="Callable" /> - <argument index="2" name="userdata" type="Variant" default="null" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="callable" type="Callable" /> + <param index="2" name="userdata" type="Variant" default="null" /> <description> Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). The force integration function takes 2 arguments: @@ -550,87 +550,87 @@ </method> <method name="body_set_max_contacts_reported"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="amount" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="amount" type="int" /> <description> Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </description> </method> <method name="body_set_mode"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="mode" type="int" enum="PhysicsServer2D.BodyMode" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="mode" type="int" enum="PhysicsServer2D.BodyMode" /> <description> Sets the body mode using one of the [enum BodyMode] constants. </description> </method> <method name="body_set_omit_force_integration"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_set_param"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" /> + <param index="2" name="value" type="Variant" /> <description> Sets a body parameter. See [enum BodyParameter] for a list of available parameters. </description> </method> <method name="body_set_shape"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="shape" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="shape" type="RID" /> <description> Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="body_set_shape_as_one_way_collision"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="enable" type="bool" /> - <argument index="3" name="margin" type="float" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="enable" type="bool" /> + <param index="3" name="margin" type="float" /> <description> Enables one way collision on body if [code]enable[/code] is [code]true[/code]. </description> </method> <method name="body_set_shape_disabled"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="disabled" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="disabled" type="bool" /> <description> Disables shape in body if [code]disable[/code] is [code]true[/code]. </description> </method> <method name="body_set_shape_transform"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="transform" type="Transform2D" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="transform" type="Transform2D" /> <description> Sets the transform matrix for a body shape. </description> </method> <method name="body_set_space"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="space" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="space" type="RID" /> <description> Assigns a space to the body (see [method space_create]). </description> </method> <method name="body_set_state"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" /> + <param index="2" name="value" type="Variant" /> <description> Sets a body state using one of the [enum BodyState] constants. Note that the method doesn't take effect immediately. The state will change on the next physics frame. @@ -638,9 +638,9 @@ </method> <method name="body_test_motion"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="parameters" type="PhysicsTestMotionParameters2D" /> - <argument index="2" name="result" type="PhysicsTestMotionResult2D" default="null" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="parameters" type="PhysicsTestMotionParameters2D" /> + <param index="2" name="result" type="PhysicsTestMotionResult2D" default="null" /> <description> Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters2D] is passed to set motion parameters. [PhysicsTestMotionResult2D] can be passed to return additional information. </description> @@ -667,38 +667,38 @@ </method> <method name="damped_spring_joint_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" /> <description> Returns the value of a damped spring joint parameter. See [enum DampedSpringParam] for a list of available parameters. </description> </method> <method name="damped_spring_joint_set_param"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" /> + <param index="2" name="value" type="float" /> <description> Sets a damped spring joint parameter. See [enum DampedSpringParam] for a list of available parameters. </description> </method> <method name="free_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Destroys any of the objects created by PhysicsServer2D. If the [RID] passed is not one of the objects that can be created by PhysicsServer2D, an error will be sent to the console. </description> </method> <method name="get_process_info"> <return type="int" /> - <argument index="0" name="process_info" type="int" enum="PhysicsServer2D.ProcessInfo" /> + <param index="0" name="process_info" type="int" enum="PhysicsServer2D.ProcessInfo" /> <description> Returns information about the current state of the 2D physics engine. See [enum ProcessInfo] for a list of available states. </description> </method> <method name="joint_clear"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> </description> </method> @@ -709,54 +709,54 @@ </method> <method name="joint_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" /> <description> Returns the value of a joint parameter. </description> </method> <method name="joint_get_type" qualifiers="const"> <return type="int" enum="PhysicsServer2D.JointType" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> Returns a joint's type (see [enum JointType]). </description> </method> <method name="joint_make_damped_spring"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="anchor_a" type="Vector2" /> - <argument index="2" name="anchor_b" type="Vector2" /> - <argument index="3" name="body_a" type="RID" /> - <argument index="4" name="body_b" type="RID" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="anchor_a" type="Vector2" /> + <param index="2" name="anchor_b" type="Vector2" /> + <param index="3" name="body_a" type="RID" /> + <param index="4" name="body_b" type="RID" /> <description> </description> </method> <method name="joint_make_groove"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="groove1_a" type="Vector2" /> - <argument index="2" name="groove2_a" type="Vector2" /> - <argument index="3" name="anchor_b" type="Vector2" /> - <argument index="4" name="body_a" type="RID" /> - <argument index="5" name="body_b" type="RID" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="groove1_a" type="Vector2" /> + <param index="2" name="groove2_a" type="Vector2" /> + <param index="3" name="anchor_b" type="Vector2" /> + <param index="4" name="body_a" type="RID" /> + <param index="5" name="body_b" type="RID" /> <description> </description> </method> <method name="joint_make_pin"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="anchor" type="Vector2" /> - <argument index="2" name="body_a" type="RID" /> - <argument index="3" name="body_b" type="RID" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="anchor" type="Vector2" /> + <param index="2" name="body_a" type="RID" /> + <param index="3" name="body_b" type="RID" /> <description> </description> </method> <method name="joint_set_param"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" /> + <param index="2" name="value" type="float" /> <description> Sets a joint parameter. See [enum JointParam] for a list of available parameters. </description> @@ -778,29 +778,29 @@ </method> <method name="set_active"> <return type="void" /> - <argument index="0" name="active" type="bool" /> + <param index="0" name="active" type="bool" /> <description> Activates or deactivates the 2D physics engine. </description> </method> <method name="shape_get_data" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="shape" type="RID" /> + <param index="0" name="shape" type="RID" /> <description> Returns the shape data. </description> </method> <method name="shape_get_type" qualifiers="const"> <return type="int" enum="PhysicsServer2D.ShapeType" /> - <argument index="0" name="shape" type="RID" /> + <param index="0" name="shape" type="RID" /> <description> Returns a shape's type (see [enum ShapeType]). </description> </method> <method name="shape_set_data"> <return type="void" /> - <argument index="0" name="shape" type="RID" /> - <argument index="1" name="data" type="Variant" /> + <param index="0" name="shape" type="RID" /> + <param index="1" name="data" type="Variant" /> <description> Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. </description> @@ -813,39 +813,39 @@ </method> <method name="space_get_direct_state"> <return type="PhysicsDirectSpaceState2D" /> - <argument index="0" name="space" type="RID" /> + <param index="0" name="space" type="RID" /> <description> Returns the state of a space, a [PhysicsDirectSpaceState2D]. This object can be used to make collision/intersection queries. </description> </method> <method name="space_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" /> <description> Returns the value of a space parameter. </description> </method> <method name="space_is_active" qualifiers="const"> <return type="bool" /> - <argument index="0" name="space" type="RID" /> + <param index="0" name="space" type="RID" /> <description> Returns whether the space is active. </description> </method> <method name="space_set_active"> <return type="void" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="active" type="bool" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="active" type="bool" /> <description> Marks a space as active. It will not have an effect, unless it is assigned to an area or body. </description> </method> <method name="space_set_param"> <return type="void" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" /> + <param index="2" name="value" type="float" /> <description> Sets the value for a space parameter. See [enum SpaceParameter] for a list of available parameters. </description> diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 2e84287227..b76e9dfdf4 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -11,25 +11,25 @@ <methods> <method name="area_add_shape"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape" type="RID" /> - <argument index="2" name="transform" type="Transform3D" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" /> - <argument index="3" name="disabled" type="bool" default="false" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape" type="RID" /> + <param index="2" name="transform" type="Transform3D" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" /> + <param index="3" name="disabled" type="bool" default="false" /> <description> Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="area_attach_object_instance_id"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="id" type="int" /> <description> Assigns the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="area_clear_shapes"> <return type="void" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. </description> @@ -42,91 +42,91 @@ </method> <method name="area_get_object_instance_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Gets the instance ID of the object the area is assigned to. </description> </method> <method name="area_get_param" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.AreaParameter" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.AreaParameter" /> <description> Returns an area parameter value. A list of available parameters is on the [enum AreaParameter] constants. </description> </method> <method name="area_get_shape" qualifiers="const"> <return type="RID" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Returns the [RID] of the nth shape of an area. </description> </method> <method name="area_get_shape_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Returns the number of shapes assigned to an area. </description> </method> <method name="area_get_shape_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Returns the transform matrix of a shape within an area. </description> </method> <method name="area_get_space" qualifiers="const"> <return type="RID" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Returns the space assigned to the area. </description> </method> <method name="area_get_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> Returns the transform matrix for an area. </description> </method> <method name="area_remove_shape"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Removes a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> <method name="area_set_area_monitor_callback"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="callback" type="Callable" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="callback" type="Callable" /> <description> </description> </method> <method name="area_set_collision_layer"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="layer" type="int" /> <description> Assigns the area to one or many physics layers. </description> </method> <method name="area_set_collision_mask"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="mask" type="int" /> <description> Sets which physics layers the area will monitor. </description> </method> <method name="area_set_monitor_callback"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="callback" type="Callable" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="callback" type="Callable" /> <description> Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. @@ -138,82 +138,82 @@ </method> <method name="area_set_monitorable"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="monitorable" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="monitorable" type="bool" /> <description> </description> </method> <method name="area_set_param"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.AreaParameter" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.AreaParameter" /> + <param index="2" name="value" type="Variant" /> <description> Sets the value for an area parameter. A list of available parameters is on the [enum AreaParameter] constants. </description> </method> <method name="area_set_ray_pickable"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> Sets object pickable with rays. </description> </method> <method name="area_set_shape"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="shape" type="RID" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="shape" type="RID" /> <description> Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="area_set_shape_disabled"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="disabled" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="disabled" type="bool" /> <description> </description> </method> <method name="area_set_shape_transform"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> Sets the transform matrix for an area shape. </description> </method> <method name="area_set_space"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="space" type="RID" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="space" type="RID" /> <description> Assigns a space to the area. </description> </method> <method name="area_set_transform"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> <description> Sets the transform matrix for an area. </description> </method> <method name="body_add_collision_exception"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="excepted_body" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="excepted_body" type="RID" /> <description> Adds a body to the list of bodies exempt from collisions. </description> </method> <method name="body_add_constant_central_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> <description> Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector3(0, 0, 0))[/code]. This is equivalent to using [method body_add_constant_force] at the body's center of mass. @@ -221,9 +221,9 @@ </method> <method name="body_add_constant_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> - <argument index="2" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> + <param index="2" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector3(0, 0, 0))[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -231,26 +231,26 @@ </method> <method name="body_add_constant_torque"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="Vector3" /> <description> Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]body_set_constant_torque(body, Vector3(0, 0, 0))[/code]. </description> </method> <method name="body_add_shape"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape" type="RID" /> - <argument index="2" name="transform" type="Transform3D" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" /> - <argument index="3" name="disabled" type="bool" default="false" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape" type="RID" /> + <param index="2" name="transform" type="Transform3D" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" /> + <param index="3" name="disabled" type="bool" default="false" /> <description> Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="body_apply_central_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> <description> Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method body_apply_force] at the body's center of mass. @@ -258,8 +258,8 @@ </method> <method name="body_apply_central_impulse"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="Vector3" /> <description> Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -268,9 +268,9 @@ </method> <method name="body_apply_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> - <argument index="2" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> + <param index="2" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -278,9 +278,9 @@ </method> <method name="body_apply_impulse"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="Vector3" /> - <argument index="2" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="Vector3" /> + <param index="2" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -289,16 +289,16 @@ </method> <method name="body_apply_torque"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="Vector3" /> <description> Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. </description> </method> <method name="body_apply_torque_impulse"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="Vector3" /> <description> Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -306,15 +306,15 @@ </method> <method name="body_attach_object_instance_id"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="id" type="int" /> <description> Assigns the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="body_clear_shapes"> <return type="void" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Removes all shapes from a body. </description> @@ -326,21 +326,21 @@ </method> <method name="body_get_collision_layer" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the physics layer or layers a body belongs to. </description> </method> <method name="body_get_collision_mask" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the physics layer or layers a body can collide with. </description> </method> <method name="body_get_constant_force" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the body's total constant positional forces applied during each physics update. See [method body_add_constant_force] and [method body_add_constant_central_force]. @@ -348,7 +348,7 @@ </method> <method name="body_get_constant_torque" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the body's total constant rotational forces applied during each physics update. See [method body_add_constant_torque]. @@ -356,103 +356,103 @@ </method> <method name="body_get_direct_state"> <return type="PhysicsDirectBodyState3D" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the [PhysicsDirectBodyState3D] of the body. Returns [code]null[/code] if the body is destroyed or removed from the physics space. </description> </method> <method name="body_get_max_contacts_reported" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. </description> </method> <method name="body_get_mode" qualifiers="const"> <return type="int" enum="PhysicsServer3D.BodyMode" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the body mode. </description> </method> <method name="body_get_object_instance_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Gets the instance ID of the object the area is assigned to. </description> </method> <method name="body_get_param" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.BodyParameter" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.BodyParameter" /> <description> Returns the value of a body parameter. A list of available parameters is on the [enum BodyParameter] constants. </description> </method> <method name="body_get_shape" qualifiers="const"> <return type="RID" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Returns the [RID] of the nth shape of a body. </description> </method> <method name="body_get_shape_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the number of shapes assigned to a body. </description> </method> <method name="body_get_shape_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Returns the transform matrix of a body shape. </description> </method> <method name="body_get_space" qualifiers="const"> <return type="RID" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the [RID] of the space assigned to a body. </description> </method> <method name="body_get_state" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="state" type="int" enum="PhysicsServer3D.BodyState" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="state" type="int" enum="PhysicsServer3D.BodyState" /> <description> Returns a body state. </description> </method> <method name="body_is_axis_locked" qualifiers="const"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> <description> </description> </method> <method name="body_is_continuous_collision_detection_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> If [code]true[/code], the continuous collision detection mode is enabled. </description> </method> <method name="body_is_omitting_force_integration" qualifiers="const"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_remove_collision_exception"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="excepted_body" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="excepted_body" type="RID" /> <description> Removes a body from the list of bodies exempt from collisions. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. @@ -460,55 +460,55 @@ </method> <method name="body_remove_shape"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. </description> </method> <method name="body_reset_mass_properties"> <return type="void" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using [method body_set_param]. </description> </method> <method name="body_set_axis_lock"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> - <argument index="2" name="lock" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> + <param index="2" name="lock" type="bool" /> <description> </description> </method> <method name="body_set_axis_velocity"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="axis_velocity" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="axis_velocity" type="Vector3" /> <description> Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="body_set_collision_layer"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="layer" type="int" /> <description> Sets the physics layer or layers a body belongs to. </description> </method> <method name="body_set_collision_mask"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="mask" type="int" /> <description> Sets the physics layer or layers a body can collide with. </description> </method> <method name="body_set_constant_force"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> <description> Sets the body's total constant positional forces applied during each physics update. See [method body_add_constant_force] and [method body_add_constant_central_force]. @@ -516,8 +516,8 @@ </method> <method name="body_set_constant_torque"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="Vector3" /> <description> Sets the body's total constant rotational forces applied during each physics update. See [method body_add_constant_torque]. @@ -525,8 +525,8 @@ </method> <method name="body_set_enable_continuous_collision_detection"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], the continuous collision detection mode is enabled. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. @@ -534,9 +534,9 @@ </method> <method name="body_set_force_integration_callback"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="callable" type="Callable" /> - <argument index="2" name="userdata" type="Variant" default="null" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="callable" type="Callable" /> + <param index="2" name="userdata" type="Variant" default="null" /> <description> Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). The force integration function takes 2 arguments: @@ -546,93 +546,93 @@ </method> <method name="body_set_max_contacts_reported"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="amount" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="amount" type="int" /> <description> Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </description> </method> <method name="body_set_mode"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="mode" type="int" enum="PhysicsServer3D.BodyMode" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="mode" type="int" enum="PhysicsServer3D.BodyMode" /> <description> Sets the body mode, from one of the [enum BodyMode] constants. </description> </method> <method name="body_set_omit_force_integration"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_set_param"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.BodyParameter" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.BodyParameter" /> + <param index="2" name="value" type="Variant" /> <description> Sets a body parameter. A list of available parameters is on the [enum BodyParameter] constants. </description> </method> <method name="body_set_ray_pickable"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> Sets the body pickable with rays if [code]enabled[/code] is set. </description> </method> <method name="body_set_shape"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="shape" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="shape" type="RID" /> <description> Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="body_set_shape_disabled"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="disabled" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="disabled" type="bool" /> <description> </description> </method> <method name="body_set_shape_transform"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> Sets the transform matrix for a body shape. </description> </method> <method name="body_set_space"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="space" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="space" type="RID" /> <description> Assigns a space to the body (see [method space_create]). </description> </method> <method name="body_set_state"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="state" type="int" enum="PhysicsServer3D.BodyState" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="state" type="int" enum="PhysicsServer3D.BodyState" /> + <param index="2" name="value" type="Variant" /> <description> Sets a body state (see [enum BodyState] constants). </description> </method> <method name="body_test_motion"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="parameters" type="PhysicsTestMotionParameters3D" /> - <argument index="2" name="result" type="PhysicsTestMotionResult3D" default="null" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="parameters" type="PhysicsTestMotionParameters3D" /> + <param index="2" name="result" type="PhysicsTestMotionResult3D" default="null" /> <description> Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters3D] is passed to set motion parameters. [PhysicsTestMotionResult3D] can be passed to return additional information. </description> @@ -654,17 +654,17 @@ </method> <method name="cone_twist_joint_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.ConeTwistJointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.ConeTwistJointParam" /> <description> Gets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants). </description> </method> <method name="cone_twist_joint_set_param"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.ConeTwistJointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.ConeTwistJointParam" /> + <param index="2" name="value" type="float" /> <description> Sets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants). </description> @@ -686,52 +686,52 @@ </method> <method name="free_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Destroys any of the objects created by PhysicsServer3D. If the [RID] passed is not one of the objects that can be created by PhysicsServer3D, an error will be sent to the console. </description> </method> <method name="generic_6dof_joint_get_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="axis" type="int" enum="Vector3.Axis" /> - <argument index="2" name="flag" type="int" enum="PhysicsServer3D.G6DOFJointAxisFlag" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="axis" type="int" enum="Vector3.Axis" /> + <param index="2" name="flag" type="int" enum="PhysicsServer3D.G6DOFJointAxisFlag" /> <description> Gets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants). </description> </method> <method name="generic_6dof_joint_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="axis" type="int" enum="Vector3.Axis" /> - <argument index="2" name="param" type="int" enum="PhysicsServer3D.G6DOFJointAxisParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="axis" type="int" enum="Vector3.Axis" /> + <param index="2" name="param" type="int" enum="PhysicsServer3D.G6DOFJointAxisParam" /> <description> Gets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants). </description> </method> <method name="generic_6dof_joint_set_flag"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="axis" type="int" enum="Vector3.Axis" /> - <argument index="2" name="flag" type="int" enum="PhysicsServer3D.G6DOFJointAxisFlag" /> - <argument index="3" name="enable" type="bool" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="axis" type="int" enum="Vector3.Axis" /> + <param index="2" name="flag" type="int" enum="PhysicsServer3D.G6DOFJointAxisFlag" /> + <param index="3" name="enable" type="bool" /> <description> Sets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants). </description> </method> <method name="generic_6dof_joint_set_param"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="axis" type="int" enum="Vector3.Axis" /> - <argument index="2" name="param" type="int" enum="PhysicsServer3D.G6DOFJointAxisParam" /> - <argument index="3" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="axis" type="int" enum="Vector3.Axis" /> + <param index="2" name="param" type="int" enum="PhysicsServer3D.G6DOFJointAxisParam" /> + <param index="3" name="value" type="float" /> <description> Sets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants). </description> </method> <method name="get_process_info"> <return type="int" /> - <argument index="0" name="process_info" type="int" enum="PhysicsServer3D.ProcessInfo" /> + <param index="0" name="process_info" type="int" enum="PhysicsServer3D.ProcessInfo" /> <description> Returns information about the current state of the 3D physics engine. See [enum ProcessInfo] for a list of available states. </description> @@ -743,41 +743,41 @@ </method> <method name="hinge_joint_get_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="flag" type="int" enum="PhysicsServer3D.HingeJointFlag" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="flag" type="int" enum="PhysicsServer3D.HingeJointFlag" /> <description> Gets a hinge_joint flag (see [enum HingeJointFlag] constants). </description> </method> <method name="hinge_joint_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.HingeJointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.HingeJointParam" /> <description> Gets a hinge_joint parameter (see [enum HingeJointParam]). </description> </method> <method name="hinge_joint_set_flag"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="flag" type="int" enum="PhysicsServer3D.HingeJointFlag" /> - <argument index="2" name="enabled" type="bool" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="flag" type="int" enum="PhysicsServer3D.HingeJointFlag" /> + <param index="2" name="enabled" type="bool" /> <description> Sets a hinge_joint flag (see [enum HingeJointFlag] constants). </description> </method> <method name="hinge_joint_set_param"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.HingeJointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.HingeJointParam" /> + <param index="2" name="value" type="float" /> <description> Sets a hinge_joint parameter (see [enum HingeJointParam] constants). </description> </method> <method name="joint_clear"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> </description> </method> @@ -788,119 +788,119 @@ </method> <method name="joint_get_solver_priority" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> Gets the priority value of the Joint3D. </description> </method> <method name="joint_get_type" qualifiers="const"> <return type="int" enum="PhysicsServer3D.JointType" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> Returns the type of the Joint3D. </description> </method> <method name="joint_make_cone_twist"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="local_ref_A" type="Transform3D" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="local_ref_B" type="Transform3D" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="local_ref_A" type="Transform3D" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="local_ref_B" type="Transform3D" /> <description> </description> </method> <method name="joint_make_generic_6dof"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="local_ref_A" type="Transform3D" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="local_ref_B" type="Transform3D" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="local_ref_A" type="Transform3D" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="local_ref_B" type="Transform3D" /> <description> </description> </method> <method name="joint_make_hinge"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="hinge_A" type="Transform3D" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="hinge_B" type="Transform3D" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="hinge_A" type="Transform3D" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="hinge_B" type="Transform3D" /> <description> </description> </method> <method name="joint_make_pin"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="local_A" type="Vector3" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="local_B" type="Vector3" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="local_A" type="Vector3" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="local_B" type="Vector3" /> <description> </description> </method> <method name="joint_make_slider"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="local_ref_A" type="Transform3D" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="local_ref_B" type="Transform3D" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="local_ref_A" type="Transform3D" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="local_ref_B" type="Transform3D" /> <description> </description> </method> <method name="joint_set_solver_priority"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="priority" type="int" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="priority" type="int" /> <description> Sets the priority value of the Joint3D. </description> </method> <method name="pin_joint_get_local_a" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> Returns position of the joint in the local space of body a of the joint. </description> </method> <method name="pin_joint_get_local_b" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> Returns position of the joint in the local space of body b of the joint. </description> </method> <method name="pin_joint_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.PinJointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.PinJointParam" /> <description> Gets a pin_joint parameter (see [enum PinJointParam] constants). </description> </method> <method name="pin_joint_set_local_a"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="local_A" type="Vector3" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="local_A" type="Vector3" /> <description> Sets position of the joint in the local space of body a of the joint. </description> </method> <method name="pin_joint_set_local_b"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="local_B" type="Vector3" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="local_B" type="Vector3" /> <description> Sets position of the joint in the local space of body b of the joint. </description> </method> <method name="pin_joint_set_param"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.PinJointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.PinJointParam" /> + <param index="2" name="value" type="float" /> <description> Sets a pin_joint parameter (see [enum PinJointParam] constants). </description> @@ -912,53 +912,53 @@ </method> <method name="set_active"> <return type="void" /> - <argument index="0" name="active" type="bool" /> + <param index="0" name="active" type="bool" /> <description> Activates or deactivates the 3D physics engine. </description> </method> <method name="shape_get_data" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="shape" type="RID" /> + <param index="0" name="shape" type="RID" /> <description> Returns the shape data. </description> </method> <method name="shape_get_type" qualifiers="const"> <return type="int" enum="PhysicsServer3D.ShapeType" /> - <argument index="0" name="shape" type="RID" /> + <param index="0" name="shape" type="RID" /> <description> Returns the type of shape (see [enum ShapeType] constants). </description> </method> <method name="shape_set_data"> <return type="void" /> - <argument index="0" name="shape" type="RID" /> - <argument index="1" name="data" type="Variant" /> + <param index="0" name="shape" type="RID" /> + <param index="1" name="data" type="Variant" /> <description> Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. </description> </method> <method name="slider_joint_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.SliderJointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.SliderJointParam" /> <description> Gets a slider_joint parameter (see [enum SliderJointParam] constants). </description> </method> <method name="slider_joint_set_param"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.SliderJointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.SliderJointParam" /> + <param index="2" name="value" type="float" /> <description> Gets a slider_joint parameter (see [enum SliderJointParam] constants). </description> </method> <method name="soft_body_get_bounds" qualifiers="const"> <return type="AABB" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> @@ -970,39 +970,39 @@ </method> <method name="space_get_direct_state"> <return type="PhysicsDirectSpaceState3D" /> - <argument index="0" name="space" type="RID" /> + <param index="0" name="space" type="RID" /> <description> Returns the state of a space, a [PhysicsDirectSpaceState3D]. This object can be used to make collision/intersection queries. </description> </method> <method name="space_get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.SpaceParameter" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.SpaceParameter" /> <description> Returns the value of a space parameter. </description> </method> <method name="space_is_active" qualifiers="const"> <return type="bool" /> - <argument index="0" name="space" type="RID" /> + <param index="0" name="space" type="RID" /> <description> Returns whether the space is active. </description> </method> <method name="space_set_active"> <return type="void" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="active" type="bool" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="active" type="bool" /> <description> Marks a space as active. It will not have an effect, unless it is assigned to an area or body. </description> </method> <method name="space_set_param"> <return type="void" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.SpaceParameter" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.SpaceParameter" /> + <param index="2" name="value" type="float" /> <description> Sets the value for a space parameter. A list of available parameters is on the [enum SpaceParameter] constants. </description> diff --git a/doc/classes/PhysicsServer3DExtension.xml b/doc/classes/PhysicsServer3DExtension.xml index 795f5b86dd..4188b04e4a 100644 --- a/doc/classes/PhysicsServer3DExtension.xml +++ b/doc/classes/PhysicsServer3DExtension.xml @@ -9,23 +9,23 @@ <methods> <method name="_area_add_shape" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape" type="RID" /> - <argument index="2" name="transform" type="Transform3D" /> - <argument index="3" name="disabled" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape" type="RID" /> + <param index="2" name="transform" type="Transform3D" /> + <param index="3" name="disabled" type="bool" /> <description> </description> </method> <method name="_area_attach_object_instance_id" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="id" type="int" /> <description> </description> </method> <method name="_area_clear_shapes" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> </description> </method> @@ -36,236 +36,236 @@ </method> <method name="_area_get_object_instance_id" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> </description> </method> <method name="_area_get_param" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.AreaParameter" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.AreaParameter" /> <description> </description> </method> <method name="_area_get_shape" qualifiers="virtual const"> <return type="RID" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> </description> </method> <method name="_area_get_shape_count" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> </description> </method> <method name="_area_get_shape_transform" qualifiers="virtual const"> <return type="Transform3D" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> </description> </method> <method name="_area_get_space" qualifiers="virtual const"> <return type="RID" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> </description> </method> <method name="_area_get_transform" qualifiers="virtual const"> <return type="Transform3D" /> - <argument index="0" name="area" type="RID" /> + <param index="0" name="area" type="RID" /> <description> </description> </method> <method name="_area_remove_shape" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> </description> </method> <method name="_area_set_area_monitor_callback" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="callback" type="Callable" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="callback" type="Callable" /> <description> </description> </method> <method name="_area_set_collision_layer" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="layer" type="int" /> <description> </description> </method> <method name="_area_set_collision_mask" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="mask" type="int" /> <description> </description> </method> <method name="_area_set_monitor_callback" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="callback" type="Callable" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="callback" type="Callable" /> <description> </description> </method> <method name="_area_set_monitorable" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="monitorable" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="monitorable" type="bool" /> <description> </description> </method> <method name="_area_set_param" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.AreaParameter" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.AreaParameter" /> + <param index="2" name="value" type="Variant" /> <description> </description> </method> <method name="_area_set_ray_pickable" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="_area_set_shape" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="shape" type="RID" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="shape" type="RID" /> <description> </description> </method> <method name="_area_set_shape_disabled" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="disabled" type="bool" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="disabled" type="bool" /> <description> </description> </method> <method name="_area_set_shape_transform" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> </description> </method> <method name="_area_set_space" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="space" type="RID" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="space" type="RID" /> <description> </description> </method> <method name="_area_set_transform" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="area" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> <description> </description> </method> <method name="_body_add_collision_exception" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="excepted_body" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="excepted_body" type="RID" /> <description> </description> </method> <method name="_body_add_constant_central_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> <description> </description> </method> <method name="_body_add_constant_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> - <argument index="2" name="position" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> + <param index="2" name="position" type="Vector3" /> <description> </description> </method> <method name="_body_add_constant_torque" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="Vector3" /> <description> </description> </method> <method name="_body_add_shape" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape" type="RID" /> - <argument index="2" name="transform" type="Transform3D" /> - <argument index="3" name="disabled" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape" type="RID" /> + <param index="2" name="transform" type="Transform3D" /> + <param index="3" name="disabled" type="bool" /> <description> </description> </method> <method name="_body_apply_central_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> <description> </description> </method> <method name="_body_apply_central_impulse" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="Vector3" /> <description> </description> </method> <method name="_body_apply_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> - <argument index="2" name="position" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> + <param index="2" name="position" type="Vector3" /> <description> </description> </method> <method name="_body_apply_impulse" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="Vector3" /> - <argument index="2" name="position" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="Vector3" /> + <param index="2" name="position" type="Vector3" /> <description> </description> </method> <method name="_body_apply_torque" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="Vector3" /> <description> </description> </method> <method name="_body_apply_torque_impulse" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="impulse" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="impulse" type="Vector3" /> <description> </description> </method> <method name="_body_attach_object_instance_id" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="id" type="int" /> <description> </description> </method> <method name="_body_clear_shapes" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> @@ -276,273 +276,273 @@ </method> <method name="_body_get_collision_layer" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_collision_mask" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_constant_force" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_constant_torque" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_direct_state" qualifiers="virtual"> <return type="PhysicsDirectBodyState3D" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_max_contacts_reported" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_mode" qualifiers="virtual const"> <return type="int" enum="PhysicsServer3D.BodyMode" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_object_instance_id" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_param" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.BodyParameter" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.BodyParameter" /> <description> </description> </method> <method name="_body_get_shape" qualifiers="virtual const"> <return type="RID" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> </description> </method> <method name="_body_get_shape_count" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_shape_transform" qualifiers="virtual const"> <return type="Transform3D" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> </description> </method> <method name="_body_get_space" qualifiers="virtual const"> <return type="RID" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_get_state" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="state" type="int" enum="PhysicsServer3D.BodyState" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="state" type="int" enum="PhysicsServer3D.BodyState" /> <description> </description> </method> <method name="_body_is_axis_locked" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> <description> </description> </method> <method name="_body_is_continuous_collision_detection_enabled" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_is_omitting_force_integration" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_remove_collision_exception" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="excepted_body" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="excepted_body" type="RID" /> <description> </description> </method> <method name="_body_remove_shape" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> <description> </description> </method> <method name="_body_reset_mass_properties" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> <method name="_body_set_axis_lock" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> - <argument index="2" name="lock" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" /> + <param index="2" name="lock" type="bool" /> <description> </description> </method> <method name="_body_set_axis_velocity" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="axis_velocity" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="axis_velocity" type="Vector3" /> <description> </description> </method> <method name="_body_set_collision_layer" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="layer" type="int" /> <description> </description> </method> <method name="_body_set_collision_mask" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="mask" type="int" /> <description> </description> </method> <method name="_body_set_constant_force" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="force" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="force" type="Vector3" /> <description> </description> </method> <method name="_body_set_constant_torque" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="torque" type="Vector3" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="torque" type="Vector3" /> <description> </description> </method> <method name="_body_set_enable_continuous_collision_detection" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="_body_set_force_integration_callback" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="callable" type="Callable" /> - <argument index="2" name="userdata" type="Variant" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="callable" type="Callable" /> + <param index="2" name="userdata" type="Variant" /> <description> </description> </method> <method name="_body_set_max_contacts_reported" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="amount" type="int" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="amount" type="int" /> <description> </description> </method> <method name="_body_set_mode" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="mode" type="int" enum="PhysicsServer3D.BodyMode" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="mode" type="int" enum="PhysicsServer3D.BodyMode" /> <description> </description> </method> <method name="_body_set_omit_force_integration" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="_body_set_param" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.BodyParameter" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.BodyParameter" /> + <param index="2" name="value" type="Variant" /> <description> </description> </method> <method name="_body_set_ray_pickable" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="_body_set_shape" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="shape" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="shape" type="RID" /> <description> </description> </method> <method name="_body_set_shape_disabled" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="disabled" type="bool" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="disabled" type="bool" /> <description> </description> </method> <method name="_body_set_shape_transform" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="shape_idx" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="shape_idx" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> </description> </method> <method name="_body_set_space" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="space" type="RID" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="space" type="RID" /> <description> </description> </method> <method name="_body_set_state" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="state" type="int" enum="PhysicsServer3D.BodyState" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="state" type="int" enum="PhysicsServer3D.BodyState" /> + <param index="2" name="value" type="Variant" /> <description> </description> </method> <method name="_body_test_motion" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="body" type="RID" /> - <argument index="1" name="from" type="Transform3D" /> - <argument index="2" name="motion" type="Vector3" /> - <argument index="3" name="margin" type="float" /> - <argument index="4" name="max_collisions" type="int" /> - <argument index="5" name="collide_separation_ray" type="bool" /> - <argument index="6" name="result" type="PhysicsServer3DExtensionMotionResult*" /> + <param index="0" name="body" type="RID" /> + <param index="1" name="from" type="Transform3D" /> + <param index="2" name="motion" type="Vector3" /> + <param index="3" name="margin" type="float" /> + <param index="4" name="max_collisions" type="int" /> + <param index="5" name="collide_separation_ray" type="bool" /> + <param index="6" name="result" type="PhysicsServer3DExtensionMotionResult*" /> <description> </description> </method> @@ -563,16 +563,16 @@ </method> <method name="_cone_twist_joint_get_param" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.ConeTwistJointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.ConeTwistJointParam" /> <description> </description> </method> <method name="_cone_twist_joint_set_param" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.ConeTwistJointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.ConeTwistJointParam" /> + <param index="2" name="value" type="float" /> <description> </description> </method> @@ -593,47 +593,47 @@ </method> <method name="_free_rid" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> </description> </method> <method name="_generic_6dof_joint_get_flag" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="axis" type="int" enum="Vector3.Axis" /> - <argument index="2" name="flag" type="int" enum="PhysicsServer3D.G6DOFJointAxisFlag" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="axis" type="int" enum="Vector3.Axis" /> + <param index="2" name="flag" type="int" enum="PhysicsServer3D.G6DOFJointAxisFlag" /> <description> </description> </method> <method name="_generic_6dof_joint_get_param" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="axis" type="int" enum="Vector3.Axis" /> - <argument index="2" name="param" type="int" enum="PhysicsServer3D.G6DOFJointAxisParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="axis" type="int" enum="Vector3.Axis" /> + <param index="2" name="param" type="int" enum="PhysicsServer3D.G6DOFJointAxisParam" /> <description> </description> </method> <method name="_generic_6dof_joint_set_flag" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="axis" type="int" enum="Vector3.Axis" /> - <argument index="2" name="flag" type="int" enum="PhysicsServer3D.G6DOFJointAxisFlag" /> - <argument index="3" name="enable" type="bool" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="axis" type="int" enum="Vector3.Axis" /> + <param index="2" name="flag" type="int" enum="PhysicsServer3D.G6DOFJointAxisFlag" /> + <param index="3" name="enable" type="bool" /> <description> </description> </method> <method name="_generic_6dof_joint_set_param" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="axis" type="int" enum="Vector3.Axis" /> - <argument index="2" name="param" type="int" enum="PhysicsServer3D.G6DOFJointAxisParam" /> - <argument index="3" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="axis" type="int" enum="Vector3.Axis" /> + <param index="2" name="param" type="int" enum="PhysicsServer3D.G6DOFJointAxisParam" /> + <param index="3" name="value" type="float" /> <description> </description> </method> <method name="_get_process_info" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="process_info" type="int" enum="PhysicsServer3D.ProcessInfo" /> + <param index="0" name="process_info" type="int" enum="PhysicsServer3D.ProcessInfo" /> <description> </description> </method> @@ -644,37 +644,37 @@ </method> <method name="_hinge_joint_get_flag" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="flag" type="int" enum="PhysicsServer3D.HingeJointFlag" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="flag" type="int" enum="PhysicsServer3D.HingeJointFlag" /> <description> </description> </method> <method name="_hinge_joint_get_param" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.HingeJointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.HingeJointParam" /> <description> </description> </method> <method name="_hinge_joint_set_flag" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="flag" type="int" enum="PhysicsServer3D.HingeJointFlag" /> - <argument index="2" name="enabled" type="bool" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="flag" type="int" enum="PhysicsServer3D.HingeJointFlag" /> + <param index="2" name="enabled" type="bool" /> <description> </description> </method> <method name="_hinge_joint_set_param" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.HingeJointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.HingeJointParam" /> + <param index="2" name="value" type="float" /> <description> </description> </method> <method name="_joint_clear" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> </description> </method> @@ -685,111 +685,111 @@ </method> <method name="_joint_get_solver_priority" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> </description> </method> <method name="_joint_get_type" qualifiers="virtual const"> <return type="int" enum="PhysicsServer3D.JointType" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> </description> </method> <method name="_joint_make_cone_twist" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="local_ref_A" type="Transform3D" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="local_ref_B" type="Transform3D" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="local_ref_A" type="Transform3D" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="local_ref_B" type="Transform3D" /> <description> </description> </method> <method name="_joint_make_generic_6dof" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="local_ref_A" type="Transform3D" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="local_ref_B" type="Transform3D" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="local_ref_A" type="Transform3D" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="local_ref_B" type="Transform3D" /> <description> </description> </method> <method name="_joint_make_hinge" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="hinge_A" type="Transform3D" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="hinge_B" type="Transform3D" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="hinge_A" type="Transform3D" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="hinge_B" type="Transform3D" /> <description> </description> </method> <method name="_joint_make_pin" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="local_A" type="Vector3" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="local_B" type="Vector3" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="local_A" type="Vector3" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="local_B" type="Vector3" /> <description> </description> </method> <method name="_joint_make_slider" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="body_A" type="RID" /> - <argument index="2" name="local_ref_A" type="Transform3D" /> - <argument index="3" name="body_B" type="RID" /> - <argument index="4" name="local_ref_B" type="Transform3D" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="body_A" type="RID" /> + <param index="2" name="local_ref_A" type="Transform3D" /> + <param index="3" name="body_B" type="RID" /> + <param index="4" name="local_ref_B" type="Transform3D" /> <description> </description> </method> <method name="_joint_set_solver_priority" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="priority" type="int" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="priority" type="int" /> <description> </description> </method> <method name="_pin_joint_get_local_a" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> </description> </method> <method name="_pin_joint_get_local_b" qualifiers="virtual const"> <return type="Vector3" /> - <argument index="0" name="joint" type="RID" /> + <param index="0" name="joint" type="RID" /> <description> </description> </method> <method name="_pin_joint_get_param" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.PinJointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.PinJointParam" /> <description> </description> </method> <method name="_pin_joint_set_local_a" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="local_A" type="Vector3" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="local_A" type="Vector3" /> <description> </description> </method> <method name="_pin_joint_set_local_b" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="local_B" type="Vector3" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="local_B" type="Vector3" /> <description> </description> </method> <method name="_pin_joint_set_param" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.PinJointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.PinJointParam" /> + <param index="2" name="value" type="float" /> <description> </description> </method> @@ -800,47 +800,47 @@ </method> <method name="_set_active" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="active" type="bool" /> + <param index="0" name="active" type="bool" /> <description> </description> </method> <method name="_shape_get_data" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="shape" type="RID" /> + <param index="0" name="shape" type="RID" /> <description> </description> </method> <method name="_shape_get_type" qualifiers="virtual const"> <return type="int" enum="PhysicsServer3D.ShapeType" /> - <argument index="0" name="shape" type="RID" /> + <param index="0" name="shape" type="RID" /> <description> </description> </method> <method name="_shape_set_data" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shape" type="RID" /> - <argument index="1" name="data" type="Variant" /> + <param index="0" name="shape" type="RID" /> + <param index="1" name="data" type="Variant" /> <description> </description> </method> <method name="_slider_joint_get_param" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.SliderJointParam" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.SliderJointParam" /> <description> </description> </method> <method name="_slider_joint_set_param" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="joint" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.SliderJointParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="joint" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.SliderJointParam" /> + <param index="2" name="value" type="float" /> <description> </description> </method> <method name="_soft_body_get_bounds" qualifiers="virtual const"> <return type="AABB" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> </description> </method> @@ -851,35 +851,35 @@ </method> <method name="_space_get_direct_state" qualifiers="virtual"> <return type="PhysicsDirectSpaceState3D" /> - <argument index="0" name="space" type="RID" /> + <param index="0" name="space" type="RID" /> <description> </description> </method> <method name="_space_get_param" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.SpaceParameter" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.SpaceParameter" /> <description> </description> </method> <method name="_space_is_active" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="space" type="RID" /> + <param index="0" name="space" type="RID" /> <description> </description> </method> <method name="_space_set_active" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="active" type="bool" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="active" type="bool" /> <description> </description> </method> <method name="_space_set_param" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="space" type="RID" /> - <argument index="1" name="param" type="int" enum="PhysicsServer3D.SpaceParameter" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="space" type="RID" /> + <param index="1" name="param" type="int" enum="PhysicsServer3D.SpaceParameter" /> + <param index="2" name="value" type="float" /> <description> </description> </method> diff --git a/doc/classes/PhysicsServer3DRenderingServerHandler.xml b/doc/classes/PhysicsServer3DRenderingServerHandler.xml index a40a2dd1c6..90066aeb2c 100644 --- a/doc/classes/PhysicsServer3DRenderingServerHandler.xml +++ b/doc/classes/PhysicsServer3DRenderingServerHandler.xml @@ -9,21 +9,21 @@ <methods> <method name="_set_aabb" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="aabb" type="AABB" /> + <param index="0" name="aabb" type="AABB" /> <description> </description> </method> <method name="_set_normal" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="vertex_id" type="int" /> - <argument index="1" name="normals" type="const void*" /> + <param index="0" name="vertex_id" type="int" /> + <param index="1" name="normals" type="const void*" /> <description> </description> </method> <method name="_set_vertex" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="vertex_id" type="int" /> - <argument index="1" name="vertices" type="const void*" /> + <param index="0" name="vertex_id" type="int" /> + <param index="1" name="vertices" type="const void*" /> <description> </description> </method> diff --git a/doc/classes/PhysicsTestMotionResult3D.xml b/doc/classes/PhysicsTestMotionResult3D.xml index e347a350c2..f82df1989f 100644 --- a/doc/classes/PhysicsTestMotionResult3D.xml +++ b/doc/classes/PhysicsTestMotionResult3D.xml @@ -11,35 +11,35 @@ <methods> <method name="get_collider" qualifiers="const"> <return type="Object" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's attached [Object] given a collision index (the deepest collision by default), if a collision occurred. </description> </method> <method name="get_collider_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default), if a collision occurred. See [method Object.get_instance_id]. </description> </method> <method name="get_collider_rid" qualifiers="const"> <return type="RID" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default), if a collision occurred. </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's shape index given a collision index (the deepest collision by default), if a collision occurred. See [CollisionObject3D]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's velocity given a collision index (the deepest collision by default), if a collision occurred. </description> @@ -52,28 +52,28 @@ </method> <method name="get_collision_depth" qualifiers="const"> <return type="float" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the length of overlap along the collision normal given a collision index (the deepest collision by default), if a collision occurred. </description> </method> <method name="get_collision_local_shape" qualifiers="const"> <return type="int" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the moving object's colliding shape given a collision index (the deepest collision by default), if a collision occurred. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default), if a collision occurred. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="collision_index" type="int" default="0" /> + <param index="0" name="collision_index" type="int" default="0" /> <description> Returns the point of collision in global coordinates given a collision index (the deepest collision by default), if a collision occurred. </description> diff --git a/doc/classes/PinJoint3D.xml b/doc/classes/PinJoint3D.xml index 013a18b92c..007cdf830d 100644 --- a/doc/classes/PinJoint3D.xml +++ b/doc/classes/PinJoint3D.xml @@ -11,15 +11,15 @@ <methods> <method name="get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="PinJoint3D.Param" /> + <param index="0" name="param" type="int" enum="PinJoint3D.Param" /> <description> Returns the value of the specified parameter. </description> </method> <method name="set_param"> <return type="void" /> - <argument index="0" name="param" type="int" enum="PinJoint3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="PinJoint3D.Param" /> + <param index="1" name="value" type="float" /> <description> Sets the value of the specified parameter. </description> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index df9d25902b..63a05ef15c 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -18,49 +18,49 @@ </constructor> <constructor name="Plane"> <return type="Plane" /> - <argument index="0" name="from" type="Plane" /> + <param index="0" name="from" type="Plane" /> <description> Constructs a [Plane] as a copy of the given [Plane]. </description> </constructor> <constructor name="Plane"> <return type="Plane" /> - <argument index="0" name="a" type="float" /> - <argument index="1" name="b" type="float" /> - <argument index="2" name="c" type="float" /> - <argument index="3" name="d" type="float" /> + <param index="0" name="a" type="float" /> + <param index="1" name="b" type="float" /> + <param index="2" name="c" type="float" /> + <param index="3" name="d" type="float" /> <description> 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> </constructor> <constructor name="Plane"> <return type="Plane" /> - <argument index="0" name="normal" type="Vector3" /> + <param index="0" name="normal" type="Vector3" /> <description> Creates a plane from the normal vector. The plane will intersect the origin. </description> </constructor> <constructor name="Plane"> <return type="Plane" /> - <argument index="0" name="normal" type="Vector3" /> - <argument index="1" name="d" type="float" /> + <param index="0" name="normal" type="Vector3" /> + <param index="1" name="d" type="float" /> <description> Creates a plane from the normal vector and the plane's distance from the origin. </description> </constructor> <constructor name="Plane"> <return type="Plane" /> - <argument index="0" name="normal" type="Vector3" /> - <argument index="1" name="point" type="Vector3" /> + <param index="0" name="normal" type="Vector3" /> + <param index="1" name="point" type="Vector3" /> <description> Creates a plane from the normal vector and a point on the plane. </description> </constructor> <constructor name="Plane"> <return type="Plane" /> - <argument index="0" name="point1" type="Vector3" /> - <argument index="1" name="point2" type="Vector3" /> - <argument index="2" name="point3" type="Vector3" /> + <param index="0" name="point1" type="Vector3" /> + <param index="1" name="point2" type="Vector3" /> + <param index="2" name="point3" type="Vector3" /> <description> Creates a plane from the three points, given in clockwise order. </description> @@ -75,53 +75,53 @@ </method> <method name="distance_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="point" type="Vector3" /> + <param index="0" name="point" type="Vector3" /> <description> Returns the shortest distance from the plane to the position [code]point[/code]. If the point is above the plane, the distance will be positive. If below, the distance will be negative. </description> </method> <method name="has_point" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point" type="Vector3" /> - <argument index="1" name="tolerance" type="float" default="1e-05" /> + <param index="0" name="point" type="Vector3" /> + <param index="1" name="tolerance" type="float" default="1e-05" /> <description> Returns [code]true[/code] if [code]point[/code] is inside the plane. Comparison uses a custom minimum [code]tolerance[/code] threshold. </description> </method> <method name="intersect_3" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="b" type="Plane" /> - <argument index="1" name="c" type="Plane" /> + <param index="0" name="b" type="Plane" /> + <param index="1" name="c" type="Plane" /> <description> Returns the intersection point of the three planes [code]b[/code], [code]c[/code] and this plane. If no intersection is found, [code]null[/code] is returned. </description> </method> <method name="intersects_ray" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="dir" type="Vector3" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="dir" type="Vector3" /> <description> Returns the intersection point of a ray consisting of the position [code]from[/code] and the direction normal [code]dir[/code] with this plane. If no intersection is found, [code]null[/code] is returned. </description> </method> <method name="intersects_segment" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> <description> Returns the intersection point of a segment from position [code]from[/code] to position [code]to[/code] with this plane. If no intersection is found, [code]null[/code] is returned. </description> </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="to_plane" type="Plane" /> + <param index="0" name="to_plane" type="Plane" /> <description> Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> </method> <method name="is_point_over" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point" type="Vector3" /> + <param index="0" name="point" type="Vector3" /> <description> Returns [code]true[/code] if [code]point[/code] is located above the plane. </description> @@ -134,7 +134,7 @@ </method> <method name="project" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="point" type="Vector3" /> + <param index="0" name="point" type="Vector3" /> <description> Returns the orthogonal projection of [code]point[/code] into a point in the plane. </description> @@ -173,7 +173,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Plane" /> + <param index="0" name="right" type="Plane" /> <description> Returns [code]true[/code] if the planes are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -181,14 +181,14 @@ </operator> <operator name="operator *"> <return type="Plane" /> - <argument index="0" name="right" type="Transform3D" /> + <param index="0" name="right" type="Transform3D" /> <description> Inversely transforms (multiplies) the [Plane] by the given [Transform3D] transformation matrix. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Plane" /> + <param index="0" name="right" type="Plane" /> <description> Returns [code]true[/code] if the planes are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 5f75ac6c50..8498e703fb 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -11,8 +11,8 @@ <methods> <method name="add_bone"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="weights" type="PackedFloat32Array" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="weights" type="PackedFloat32Array" /> <description> Adds a bone with the specified [code]path[/code] and [code]weights[/code]. </description> @@ -25,7 +25,7 @@ </method> <method name="erase_bone"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes the specified bone from this [Polygon2D]. </description> @@ -38,30 +38,30 @@ </method> <method name="get_bone_path" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the path to the node associated with the specified bone. </description> </method> <method name="get_bone_weights" qualifiers="const"> <return type="PackedFloat32Array" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the height values of the specified bone. </description> </method> <method name="set_bone_path"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="path" type="NodePath" /> + <param index="0" name="index" type="int" /> + <param index="1" name="path" type="NodePath" /> <description> Sets the path to the node associated with the specified bone. </description> </method> <method name="set_bone_weights"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="weights" type="PackedFloat32Array" /> + <param index="0" name="index" type="int" /> + <param index="1" name="weights" type="PackedFloat32Array" /> <description> Sets the weight values for the specified bone. </description> diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index dbe9978ef5..84d757bfca 100644 --- a/doc/classes/PolygonPathFinder.xml +++ b/doc/classes/PolygonPathFinder.xml @@ -9,8 +9,8 @@ <methods> <method name="find_path"> <return type="PackedVector2Array" /> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> <description> </description> </method> @@ -21,40 +21,40 @@ </method> <method name="get_closest_point" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="point" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> <description> </description> </method> <method name="get_intersections" qualifiers="const"> <return type="PackedVector2Array" /> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> <description> </description> </method> <method name="get_point_penalty" qualifiers="const"> <return type="float" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> <method name="is_point_inside" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> <description> </description> </method> <method name="set_point_penalty"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="penalty" type="float" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="penalty" type="float" /> <description> </description> </method> <method name="setup"> <return type="void" /> - <argument index="0" name="points" type="PackedVector2Array" /> - <argument index="1" name="connections" type="PackedInt32Array" /> + <param index="0" name="points" type="PackedVector2Array" /> + <param index="1" name="connections" type="PackedInt32Array" /> <description> </description> </method> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 5da2196f29..410489481e 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -15,9 +15,9 @@ <methods> <method name="add_check_item"> <return type="void" /> - <argument index="0" name="label" type="String" /> - <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="accel" type="int" enum="Key" default="0" /> + <param index="0" name="label" type="String" /> + <param index="1" name="id" type="int" default="-1" /> + <param index="2" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new checkable item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -26,9 +26,9 @@ </method> <method name="add_check_shortcut"> <return type="void" /> - <argument index="0" name="shortcut" type="Shortcut" /> - <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="global" type="bool" default="false" /> + <param index="0" name="shortcut" type="Shortcut" /> + <param index="1" name="id" type="int" default="-1" /> + <param index="2" name="global" type="bool" default="false" /> <description> Adds a new checkable item and assigns the specified [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -37,10 +37,10 @@ </method> <method name="add_icon_check_item"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="label" type="String" /> - <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="accel" type="int" enum="Key" default="0" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="label" type="String" /> + <param index="2" name="id" type="int" default="-1" /> + <param index="3" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new checkable item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -49,10 +49,10 @@ </method> <method name="add_icon_check_shortcut"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="shortcut" type="Shortcut" /> - <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="global" type="bool" default="false" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="shortcut" type="Shortcut" /> + <param index="2" name="id" type="int" default="-1" /> + <param index="3" name="global" type="bool" default="false" /> <description> Adds a new checkable item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -61,10 +61,10 @@ </method> <method name="add_icon_item"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="label" type="String" /> - <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="accel" type="int" enum="Key" default="0" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="label" type="String" /> + <param index="2" name="id" type="int" default="-1" /> + <param index="3" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -72,30 +72,30 @@ </method> <method name="add_icon_radio_check_item"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="label" type="String" /> - <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="accel" type="int" enum="Key" default="0" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="label" type="String" /> + <param index="2" name="id" type="int" default="-1" /> + <param index="3" name="accel" type="int" enum="Key" default="0" /> <description> Same as [method add_icon_check_item], but uses a radio check button. </description> </method> <method name="add_icon_radio_check_shortcut"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="shortcut" type="Shortcut" /> - <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="global" type="bool" default="false" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="shortcut" type="Shortcut" /> + <param index="2" name="id" type="int" default="-1" /> + <param index="3" name="global" type="bool" default="false" /> <description> Same as [method add_icon_check_shortcut], but uses a radio check button. </description> </method> <method name="add_icon_shortcut"> <return type="void" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="shortcut" type="Shortcut" /> - <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="global" type="bool" default="false" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="shortcut" type="Shortcut" /> + <param index="2" name="id" type="int" default="-1" /> + <param index="3" name="global" type="bool" default="false" /> <description> Adds a new item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -103,9 +103,9 @@ </method> <method name="add_item"> <return type="void" /> - <argument index="0" name="label" type="String" /> - <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="accel" type="int" enum="Key" default="0" /> + <param index="0" name="label" type="String" /> + <param index="1" name="id" type="int" default="-1" /> + <param index="2" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -114,11 +114,11 @@ </method> <method name="add_multistate_item"> <return type="void" /> - <argument index="0" name="label" type="String" /> - <argument index="1" name="max_states" type="int" /> - <argument index="2" name="default_state" type="int" default="0" /> - <argument index="3" name="id" type="int" default="-1" /> - <argument index="4" name="accel" type="int" enum="Key" default="0" /> + <param index="0" name="label" type="String" /> + <param index="1" name="max_states" type="int" /> + <param index="2" name="default_state" type="int" default="0" /> + <param index="3" name="id" type="int" default="-1" /> + <param index="4" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new multistate item with text [code]label[/code]. Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code]. @@ -127,9 +127,9 @@ </method> <method name="add_radio_check_item"> <return type="void" /> - <argument index="0" name="label" type="String" /> - <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="accel" type="int" enum="Key" default="0" /> + <param index="0" name="label" type="String" /> + <param index="1" name="id" type="int" default="-1" /> + <param index="2" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new radio check button with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -138,9 +138,9 @@ </method> <method name="add_radio_check_shortcut"> <return type="void" /> - <argument index="0" name="shortcut" type="Shortcut" /> - <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="global" type="bool" default="false" /> + <param index="0" name="shortcut" type="Shortcut" /> + <param index="1" name="id" type="int" default="-1" /> + <param index="2" name="global" type="bool" default="false" /> <description> Adds a new radio check button and assigns a [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -149,8 +149,8 @@ </method> <method name="add_separator"> <return type="void" /> - <argument index="0" name="label" type="String" default="""" /> - <argument index="1" name="id" type="int" default="-1" /> + <param index="0" name="label" type="String" default="""" /> + <param index="1" name="id" type="int" default="-1" /> <description> Adds a separator between items. Separators also occupy an index, which you can set by using the [code]id[/code] parameter. A [code]label[/code] can optionally be provided, which will appear at the center of the separator. @@ -158,9 +158,9 @@ </method> <method name="add_shortcut"> <return type="void" /> - <argument index="0" name="shortcut" type="Shortcut" /> - <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="global" type="bool" default="false" /> + <param index="0" name="shortcut" type="Shortcut" /> + <param index="1" name="id" type="int" default="-1" /> + <param index="2" name="global" type="bool" default="false" /> <description> Adds a [Shortcut]. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -168,9 +168,9 @@ </method> <method name="add_submenu_item"> <return type="void" /> - <argument index="0" name="label" type="String" /> - <argument index="1" name="submenu" type="String" /> - <argument index="2" name="id" type="int" default="-1" /> + <param index="0" name="label" type="String" /> + <param index="1" name="submenu" type="String" /> + <param index="2" name="id" type="int" default="-1" /> <description> Adds an item that will act as a submenu of the parent [PopupMenu] node when clicked. The [code]submenu[/code] argument is the name of the child [PopupMenu] node that will be shown when the item is clicked. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -190,91 +190,91 @@ </method> <method name="get_item_accelerator" qualifiers="const"> <return type="int" enum="Key" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the accelerator of the item at the given [code]index[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> <method name="get_item_horizontal_offset" qualifiers="const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the horizontal offset of the item at the given [code]index[/code]. </description> </method> <method name="get_item_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the icon of the item at the given [code]index[/code]. </description> </method> <method name="get_item_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the id of the item at the given [code]index[/code]. [code]id[/code] can be manually assigned, while index can not. </description> </method> <method name="get_item_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the index of the item containing the specified [code]id[/code]. Index is automatically assigned to each item by the engine and can not be set manually. </description> </method> <method name="get_item_language" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns item's text language code. </description> </method> <method name="get_item_metadata" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the metadata of the specified item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. </description> </method> <method name="get_item_shortcut" qualifiers="const"> <return type="Shortcut" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the [Shortcut] associated with the item at the given [code]index[/code]. </description> </method> <method name="get_item_submenu" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the submenu name of the item at the given [code]index[/code]. See [method add_submenu_item] for more info on how to add a submenu. </description> </method> <method name="get_item_text" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the text of the item at the given [code]index[/code]. </description> </method> <method name="get_item_text_direction" qualifiers="const"> <return type="int" enum="Control.TextDirection" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns item's text base writing direction. </description> </method> <method name="get_item_tooltip" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the tooltip associated with the item at the given [code]index[/code]. </description> </method> <method name="is_item_checkable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns [code]true[/code] if the item at the given [code]index[/code] is checkable in some way, i.e. if it has a checkbox or radio button. [b]Note:[/b] Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -282,14 +282,14 @@ </method> <method name="is_item_checked" qualifiers="const"> <return type="bool" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns [code]true[/code] if the item at the given [code]index[/code] is checked. </description> </method> <method name="is_item_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns [code]true[/code] if the item at the given [code]index[/code] is disabled. When it is disabled it can't be selected, or its action invoked. See [method set_item_disabled] for more info on how to disable an item. @@ -297,7 +297,7 @@ </method> <method name="is_item_radio_checkable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns [code]true[/code] if the item at the given [code]index[/code] has radio button-style checkability. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. @@ -305,21 +305,21 @@ </method> <method name="is_item_separator" qualifiers="const"> <return type="bool" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns [code]true[/code] if the item is a separator. If it is, it will be displayed as a line. See [method add_separator] for more info on how to add a separator. </description> </method> <method name="is_item_shortcut_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns [code]true[/code] if the specified item's shortcut is disabled. </description> </method> <method name="remove_item"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes the item at the given [code]index[/code] from the menu. [b]Note:[/b] The indices of items after the removed item will be shifted by one. @@ -327,30 +327,30 @@ </method> <method name="scroll_to_item"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Moves the scroll view to make the item at the given [code]index[/code] visible. </description> </method> <method name="set_current_index"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Sets the currently focused item as the given [code]index[/code]. </description> </method> <method name="set_item_accelerator"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="accel" type="int" enum="Key" /> + <param index="0" name="index" type="int" /> + <param index="1" name="accel" type="int" enum="Key" /> <description> Sets the accelerator of the item at the given [code]index[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> <method name="set_item_as_checkable"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="index" type="int" /> + <param index="1" name="enable" type="bool" /> <description> Sets whether the item at the given [code]index[/code] has a checkbox. If [code]false[/code], sets the type of the item to plain text. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -358,56 +358,56 @@ </method> <method name="set_item_as_radio_checkable"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="index" type="int" /> + <param index="1" name="enable" type="bool" /> <description> Sets the type of the item at the given [code]index[/code] to radio button. If [code]false[/code], sets the type of the item to plain text. </description> </method> <method name="set_item_as_separator"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="index" type="int" /> + <param index="1" name="enable" type="bool" /> <description> Mark the item at the given [code]index[/code] as a separator, which means that it would be displayed as a line. If [code]false[/code], sets the type of the item to plain text. </description> </method> <method name="set_item_checked"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="checked" type="bool" /> + <param index="0" name="index" type="int" /> + <param index="1" name="checked" type="bool" /> <description> Sets the checkstate status of the item at the given [code]index[/code]. </description> </method> <method name="set_item_disabled"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="index" type="int" /> + <param index="1" name="disabled" type="bool" /> <description> Enables/disables the item at the given [code]index[/code]. When it is disabled, it can't be selected and its action can't be invoked. </description> </method> <method name="set_item_horizontal_offset"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="offset" type="int" /> + <param index="0" name="index" type="int" /> + <param index="1" name="offset" type="int" /> <description> Sets the horizontal offset of the item at the given [code]index[/code]. </description> </method> <method name="set_item_icon"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="icon" type="Texture2D" /> + <param index="0" name="index" type="int" /> + <param index="1" name="icon" type="Texture2D" /> <description> Replaces the [Texture2D] icon of the item at the given [code]index[/code]. </description> </method> <method name="set_item_id"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="index" type="int" /> + <param index="1" name="id" type="int" /> <description> Sets the [code]id[/code] of the item at the given [code]index[/code]. The [code]id[/code] is used in [signal id_pressed] and [signal id_focused] signals. @@ -415,87 +415,87 @@ </method> <method name="set_item_language"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="index" type="int" /> + <param index="1" name="language" type="String" /> <description> Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. </description> </method> <method name="set_item_metadata"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="metadata" type="Variant" /> + <param index="0" name="index" type="int" /> + <param index="1" name="metadata" type="Variant" /> <description> Sets the metadata of an item, which may be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. </description> </method> <method name="set_item_multistate"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="state" type="int" /> + <param index="0" name="index" type="int" /> + <param index="1" name="state" type="int" /> <description> Sets the state of a multistate item. See [method add_multistate_item] for details. </description> </method> <method name="set_item_shortcut"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="shortcut" type="Shortcut" /> - <argument index="2" name="global" type="bool" default="false" /> + <param index="0" name="index" type="int" /> + <param index="1" name="shortcut" type="Shortcut" /> + <param index="2" name="global" type="bool" default="false" /> <description> Sets a [Shortcut] for the item at the given [code]index[/code]. </description> </method> <method name="set_item_shortcut_disabled"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="index" type="int" /> + <param index="1" name="disabled" type="bool" /> <description> Disables the [Shortcut] of the item at the given [code]index[/code]. </description> </method> <method name="set_item_submenu"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="submenu" type="String" /> + <param index="0" name="index" type="int" /> + <param index="1" name="submenu" type="String" /> <description> Sets the submenu of the item at the given [code]index[/code]. The submenu is the name of a child [PopupMenu] node that would be shown when the item is clicked. </description> </method> <method name="set_item_text"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="text" type="String" /> + <param index="0" name="index" type="int" /> + <param index="1" name="text" type="String" /> <description> Sets the text of the item at the given [code]index[/code]. </description> </method> <method name="set_item_text_direction"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="direction" type="int" enum="Control.TextDirection" /> + <param index="0" name="index" type="int" /> + <param index="1" name="direction" type="int" enum="Control.TextDirection" /> <description> Sets item's text base writing direction. </description> </method> <method name="set_item_tooltip"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="tooltip" type="String" /> + <param index="0" name="index" type="int" /> + <param index="1" name="tooltip" type="String" /> <description> Sets the [String] tooltip of the item at the given [code]index[/code]. </description> </method> <method name="toggle_item_checked"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Toggles the check state of the item at the given [code]index[/code]. </description> </method> <method name="toggle_item_multistate"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Cycle to the next state of a multistate item. See [method add_multistate_item] for details. </description> @@ -523,19 +523,19 @@ </members> <signals> <signal name="id_focused"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when user navigated to an item of some [code]id[/code] using [code]ui_up[/code] or [code]ui_down[/code] action. </description> </signal> <signal name="id_pressed"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when an item of some [code]id[/code] is pressed or its accelerator is activated. </description> </signal> <signal name="index_pressed"> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Emitted when an item of some [code]index[/code] is pressed or its accelerator is activated. </description> diff --git a/doc/classes/PortableCompressedTexture2D.xml b/doc/classes/PortableCompressedTexture2D.xml index aad72bbb48..c7e2f2fbdc 100644 --- a/doc/classes/PortableCompressedTexture2D.xml +++ b/doc/classes/PortableCompressedTexture2D.xml @@ -15,10 +15,10 @@ <methods> <method name="create_from_image"> <return type="void" /> - <argument index="0" name="image" type="Image" /> - <argument index="1" name="compression_mode" type="int" enum="PortableCompressedTexture2D.CompressionMode" /> - <argument index="2" name="normal_map" type="bool" default="false" /> - <argument index="3" name="lossy_quality" type="float" default="0.8" /> + <param index="0" name="image" type="Image" /> + <param index="1" name="compression_mode" type="int" enum="PortableCompressedTexture2D.CompressionMode" /> + <param index="2" name="normal_map" type="bool" default="false" /> + <param index="3" name="lossy_quality" type="float" default="0.8" /> <description> Initializes the compressed texture from a base image. The compression mode must be provided. If this image will be used as a normal map, the "normal map" flag is recommended, to ensure optimum quality. @@ -45,7 +45,7 @@ </method> <method name="set_keep_all_compressed_buffers" qualifiers="static"> <return type="void" /> - <argument index="0" name="keep" type="bool" /> + <param index="0" name="keep" type="bool" /> <description> Overrides the flag globally for all textures of this type. This is used primarily by the editor. </description> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 9df8d2df80..a6c18bbe2f 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -17,7 +17,7 @@ <methods> <method name="add_property_info"> <return type="void" /> - <argument index="0" name="hint" type="Dictionary" /> + <param index="0" name="hint" type="Dictionary" /> <description> Adds a custom property info to a property. The dictionary must contain: - [code]name[/code]: [String] (the property's name) @@ -55,21 +55,21 @@ </method> <method name="clear"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Clears the whole configuration (not recommended, may break things). </description> </method> <method name="get_order" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the order of a configuration value (influences when saved to the config file). </description> </method> <method name="get_setting" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the value of a setting. [b]Example:[/b] @@ -85,7 +85,7 @@ </method> <method name="globalize_path" qualifiers="const"> <return type="String" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns the absolute, native OS path corresponding to the localized [code]path[/code] (starting with [code]res://[/code] or [code]user://[/code]). The returned path will vary depending on the operating system and user preferences. See [url=$DOCS_URL/tutorials/io/data_paths.html]File paths in Godot projects[/url] to see what those paths convert to. See also [method localize_path]. [b]Note:[/b] [method globalize_path] with [code]res://[/code] will not work in an exported project. Instead, prepend the executable's base directory to the path when running from an exported project: @@ -106,16 +106,16 @@ </method> <method name="has_setting" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns [code]true[/code] if a configuration value is present. </description> </method> <method name="load_resource_pack"> <return type="bool" /> - <argument index="0" name="pack" type="String" /> - <argument index="1" name="replace_files" type="bool" default="true" /> - <argument index="2" name="offset" type="int" default="0" /> + <param index="0" name="pack" type="String" /> + <param index="1" name="replace_files" type="bool" default="true" /> + <param index="2" name="offset" type="int" default="0" /> <description> Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem ([code]res://[/code]). Returns [code]true[/code] on success. [b]Note:[/b] If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code] unless [code]replace_files[/code] is set to [code]false[/code]. @@ -124,21 +124,21 @@ </method> <method name="localize_path" qualifiers="const"> <return type="String" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns the localized path (starting with [code]res://[/code]) corresponding to the absolute, native OS [code]path[/code]. See also [method globalize_path]. </description> </method> <method name="property_can_revert"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns [code]true[/code] if the specified property exists and its initial value differs from the current value. </description> </method> <method name="property_get_revert"> <return type="Variant" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the specified property's initial value. Returns [code]null[/code] if the property does not exist. </description> @@ -152,31 +152,31 @@ </method> <method name="save_custom"> <return type="int" enum="Error" /> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> Saves the configuration to a custom file. The file extension must be [code].godot[/code] (to save in text-based [ConfigFile] format) or [code].binary[/code] (to save in binary format). You can also save [code]override.cfg[/code] file, which is also text, but can be used in exported projects unlike other formats. </description> </method> <method name="set_initial_value"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="String" /> + <param index="1" name="value" type="Variant" /> <description> Sets the specified property's initial value. This is the value the property reverts to. </description> </method> <method name="set_order"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="position" type="int" /> + <param index="0" name="name" type="String" /> + <param index="1" name="position" type="int" /> <description> Sets the order of a configuration value (influences when saved to the config file). </description> </method> <method name="set_setting"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="String" /> + <param index="1" name="value" type="Variant" /> <description> Sets the value of a setting. [b]Example:[/b] diff --git a/doc/classes/Projection.xml b/doc/classes/Projection.xml index 2bbfd04e9e..b8f6e54d87 100644 --- a/doc/classes/Projection.xml +++ b/doc/classes/Projection.xml @@ -14,13 +14,13 @@ </constructor> <constructor name="Projection"> <return type="Projection" /> - <argument index="0" name="from" type="Projection" /> + <param index="0" name="from" type="Projection" /> <description> </description> </constructor> <constructor name="Projection"> <return type="Projection" /> - <argument index="0" name="from" type="Transform3D" /> + <param index="0" name="from" type="Transform3D" /> <description> </description> </constructor> @@ -28,98 +28,98 @@ <methods> <method name="create_depth_correction" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="flip_y" type="bool" /> + <param index="0" name="flip_y" type="bool" /> <description> </description> </method> <method name="create_fit_aabb" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="aabb" type="AABB" /> + <param index="0" name="aabb" type="AABB" /> <description> </description> </method> <method name="create_for_hmd" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="eye" type="int" /> - <argument index="1" name="aspect" type="float" /> - <argument index="2" name="intraocular_dist" type="float" /> - <argument index="3" name="display_width" type="float" /> - <argument index="4" name="display_to_lens" type="float" /> - <argument index="5" name="oversample" type="float" /> - <argument index="6" name="z_near" type="float" /> - <argument index="7" name="z_far" type="float" /> + <param index="0" name="eye" type="int" /> + <param index="1" name="aspect" type="float" /> + <param index="2" name="intraocular_dist" type="float" /> + <param index="3" name="display_width" type="float" /> + <param index="4" name="display_to_lens" type="float" /> + <param index="5" name="oversample" type="float" /> + <param index="6" name="z_near" type="float" /> + <param index="7" name="z_far" type="float" /> <description> </description> </method> <method name="create_frustum" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="left" type="float" /> - <argument index="1" name="right" type="float" /> - <argument index="2" name="bottom" type="float" /> - <argument index="3" name="top" type="float" /> - <argument index="4" name="z_near" type="float" /> - <argument index="5" name="z_far" type="float" /> + <param index="0" name="left" type="float" /> + <param index="1" name="right" type="float" /> + <param index="2" name="bottom" type="float" /> + <param index="3" name="top" type="float" /> + <param index="4" name="z_near" type="float" /> + <param index="5" name="z_far" type="float" /> <description> </description> </method> <method name="create_frustum_aspect" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="size" type="float" /> - <argument index="1" name="aspect" type="float" /> - <argument index="2" name="offset" type="Vector2" /> - <argument index="3" name="z_near" type="float" /> - <argument index="4" name="z_far" type="float" /> - <argument index="5" name="flip_fov" type="bool" default="false" /> + <param index="0" name="size" type="float" /> + <param index="1" name="aspect" type="float" /> + <param index="2" name="offset" type="Vector2" /> + <param index="3" name="z_near" type="float" /> + <param index="4" name="z_far" type="float" /> + <param index="5" name="flip_fov" type="bool" default="false" /> <description> </description> </method> <method name="create_light_atlas_rect" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="rect" type="Rect2" /> + <param index="0" name="rect" type="Rect2" /> <description> </description> </method> <method name="create_orthogonal" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="left" type="float" /> - <argument index="1" name="right" type="float" /> - <argument index="2" name="bottom" type="float" /> - <argument index="3" name="top" type="float" /> - <argument index="4" name="z_near" type="float" /> - <argument index="5" name="z_far" type="float" /> + <param index="0" name="left" type="float" /> + <param index="1" name="right" type="float" /> + <param index="2" name="bottom" type="float" /> + <param index="3" name="top" type="float" /> + <param index="4" name="z_near" type="float" /> + <param index="5" name="z_far" type="float" /> <description> </description> </method> <method name="create_orthogonal_aspect" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="size" type="float" /> - <argument index="1" name="aspect" type="float" /> - <argument index="2" name="z_near" type="float" /> - <argument index="3" name="z_far" type="float" /> - <argument index="4" name="flip_fov" type="bool" default="false" /> + <param index="0" name="size" type="float" /> + <param index="1" name="aspect" type="float" /> + <param index="2" name="z_near" type="float" /> + <param index="3" name="z_far" type="float" /> + <param index="4" name="flip_fov" type="bool" default="false" /> <description> </description> </method> <method name="create_perspective" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="fovy" type="float" /> - <argument index="1" name="aspect" type="float" /> - <argument index="2" name="z_near" type="float" /> - <argument index="3" name="z_far" type="float" /> - <argument index="4" name="flip_fov" type="bool" default="false" /> + <param index="0" name="fovy" type="float" /> + <param index="1" name="aspect" type="float" /> + <param index="2" name="z_near" type="float" /> + <param index="3" name="z_far" type="float" /> + <param index="4" name="flip_fov" type="bool" default="false" /> <description> </description> </method> <method name="create_perspective_hmd" qualifiers="static"> <return type="Projection" /> - <argument index="0" name="fovy" type="float" /> - <argument index="1" name="aspect" type="float" /> - <argument index="2" name="z_near" type="float" /> - <argument index="3" name="z_far" type="float" /> - <argument index="4" name="flip_fov" type="bool" /> - <argument index="5" name="eye" type="int" /> - <argument index="6" name="intraocular_dist" type="float" /> - <argument index="7" name=" convergence_dist" type="float" /> + <param index="0" name="fovy" type="float" /> + <param index="1" name="aspect" type="float" /> + <param index="2" name="z_near" type="float" /> + <param index="3" name="z_far" type="float" /> + <param index="4" name="flip_fov" type="bool" /> + <param index="5" name="eye" type="int" /> + <param index="6" name="intraocular_dist" type="float" /> + <param index="7" name=" convergence_dist" type="float" /> <description> </description> </method> @@ -150,8 +150,8 @@ </method> <method name="get_fovy" qualifiers="static"> <return type="float" /> - <argument index="0" name="fovx" type="float" /> - <argument index="1" name="aspect" type="float" /> + <param index="0" name="fovx" type="float" /> + <param index="1" name="aspect" type="float" /> <description> </description> </method> @@ -162,13 +162,13 @@ </method> <method name="get_pixels_per_meter" qualifiers="const"> <return type="int" /> - <argument index="0" name="for_pixel_width" type="int" /> + <param index="0" name="for_pixel_width" type="int" /> <description> </description> </method> <method name="get_projection_plane" qualifiers="const"> <return type="Plane" /> - <argument index="0" name="plane" type="int" /> + <param index="0" name="plane" type="int" /> <description> </description> </method> @@ -199,13 +199,13 @@ </method> <method name="jitter_offseted" qualifiers="const"> <return type="Projection" /> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> <description> </description> </method> <method name="perspective_znear_adjusted" qualifiers="const"> <return type="Projection" /> - <argument index="0" name="new_znear" type="float" /> + <param index="0" name="new_znear" type="float" /> <description> </description> </method> @@ -241,31 +241,31 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Projection" /> + <param index="0" name="right" type="Projection" /> <description> </description> </operator> <operator name="operator *"> <return type="Projection" /> - <argument index="0" name="right" type="Projection" /> + <param index="0" name="right" type="Projection" /> <description> </description> </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Projection" /> + <param index="0" name="right" type="Projection" /> <description> </description> </operator> <operator name="operator []"> <return type="Vector4" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/PropertyTweener.xml b/doc/classes/PropertyTweener.xml index e0fbeec7c1..75d9c919aa 100644 --- a/doc/classes/PropertyTweener.xml +++ b/doc/classes/PropertyTweener.xml @@ -22,7 +22,7 @@ </method> <method name="from"> <return type="PropertyTweener" /> - <argument index="0" name="value" type="Variant" /> + <param index="0" name="value" type="Variant" /> <description> Sets a custom initial value to the [PropertyTweener]. Example: [codeblock] @@ -43,21 +43,21 @@ </method> <method name="set_delay"> <return type="PropertyTweener" /> - <argument index="0" name="delay" type="float" /> + <param index="0" name="delay" type="float" /> <description> Sets the time in seconds after which the [PropertyTweener] will start interpolating. By default there's no delay. </description> </method> <method name="set_ease"> <return type="PropertyTweener" /> - <argument index="0" name="ease" type="int" enum="Tween.EaseType" /> + <param index="0" name="ease" type="int" enum="Tween.EaseType" /> <description> Sets the type of used easing from [enum Tween.EaseType]. If not set, the default easing is used from the [Tween] that contains this Tweener. </description> </method> <method name="set_trans"> <return type="PropertyTweener" /> - <argument index="0" name="trans" type="int" enum="Tween.TransitionType" /> + <param index="0" name="trans" type="int" enum="Tween.TransitionType" /> <description> Sets the type of used transition from [enum Tween.TransitionType]. If not set, the default transition is used from the [Tween] that contains this Tweener. </description> diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml index 30e96607da..e75d4ea737 100644 --- a/doc/classes/Quaternion.xml +++ b/doc/classes/Quaternion.xml @@ -21,45 +21,45 @@ </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="from" type="Quaternion" /> + <param index="0" name="from" type="Quaternion" /> <description> Constructs a [Quaternion] as a copy of the given [Quaternion]. </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="arc_from" type="Vector3" /> - <argument index="1" name="arc_to" type="Vector3" /> + <param index="0" name="arc_from" type="Vector3" /> + <param index="1" name="arc_to" type="Vector3" /> <description> </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="euler_yxz" type="Vector3" /> + <param index="0" name="euler_yxz" type="Vector3" /> <description> </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="from" type="Basis" /> + <param index="0" name="from" type="Basis" /> <description> Constructs a quaternion from the given [Basis]. </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> - <argument index="2" name="z" type="float" /> - <argument index="3" name="w" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> + <param index="2" name="z" type="float" /> + <param index="3" name="w" type="float" /> <description> Constructs a quaternion defined by the given values. </description> @@ -68,7 +68,7 @@ <methods> <method name="angle_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Quaternion" /> + <param index="0" name="to" type="Quaternion" /> <description> Returns the angle between this quaternion and [code]to[/code]. This is the magnitude of the angle you would need to rotate by to get from one to the other. [b]Note:[/b] This method has an abnormally high amount of floating-point error, so methods such as [code]is_zero_approx[/code] will not work reliably. @@ -76,7 +76,7 @@ </method> <method name="dot" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Quaternion" /> + <param index="0" name="with" type="Quaternion" /> <description> Returns the dot product of two quaternions. </description> @@ -110,7 +110,7 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="to" type="Quaternion" /> + <param index="0" name="to" type="Quaternion" /> <description> Returns [code]true[/code] if this quaternion and [code]quat[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> @@ -146,8 +146,8 @@ </method> <method name="slerp" qualifiers="const"> <return type="Quaternion" /> - <argument index="0" name="to" type="Quaternion" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Quaternion" /> + <param index="1" name="weight" type="float" /> <description> Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code]. [b]Note:[/b] Both quaternions must be normalized. @@ -155,18 +155,18 @@ </method> <method name="slerpni" qualifiers="const"> <return type="Quaternion" /> - <argument index="0" name="to" type="Quaternion" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Quaternion" /> + <param index="1" name="weight" type="float" /> <description> Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees. </description> </method> <method name="spherical_cubic_interpolate" qualifiers="const"> <return type="Quaternion" /> - <argument index="0" name="b" type="Quaternion" /> - <argument index="1" name="pre_a" type="Quaternion" /> - <argument index="2" name="post_b" type="Quaternion" /> - <argument index="3" name="weight" type="float" /> + <param index="0" name="b" type="Quaternion" /> + <param index="1" name="pre_a" type="Quaternion" /> + <param index="2" name="post_b" type="Quaternion" /> + <param index="3" name="weight" type="float" /> <description> Performs a spherical cubic interpolation between quaternions [code]pre_a[/code], this vector, [code]b[/code], and [code]post_b[/code], by the given amount [code]weight[/code]. </description> @@ -198,7 +198,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Returns [code]true[/code] if the quaternions are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -206,63 +206,63 @@ </operator> <operator name="operator *"> <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Composes these two quaternions by multiplying them together. This has the effect of rotating the second quaternion (the child) by the first quaternion (the parent). </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Rotates (multiplies) the [Vector3] by the given [Quaternion]. </description> </operator> <operator name="operator *"> <return type="Quaternion" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator *"> <return type="Quaternion" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator +"> <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Adds each component of the left [Quaternion] to the right [Quaternion]. This operation is not meaningful on its own, but it can be used as a part of a larger expression, such as approximating an intermediate rotation between two nearby rotations. </description> </operator> <operator name="operator -"> <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Subtracts each component of the left [Quaternion] by the right [Quaternion]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator /"> <return type="Quaternion" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator /"> <return type="Quaternion" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Returns [code]true[/code] if the quaternions are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -270,7 +270,7 @@ </operator> <operator name="operator []"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access quaternion components using their index. [code]q[0][/code] is equivalent to [code]q.x[/code], [code]q[1][/code] is equivalent to [code]q.y[/code], [code]q[2][/code] is equivalent to [code]q.z[/code], and [code]q[3][/code] is equivalent to [code]q.w[/code]. </description> diff --git a/doc/classes/RDShaderFile.xml b/doc/classes/RDShaderFile.xml index e719337f22..72bf6faaec 100644 --- a/doc/classes/RDShaderFile.xml +++ b/doc/classes/RDShaderFile.xml @@ -9,7 +9,7 @@ <methods> <method name="get_spirv" qualifiers="const"> <return type="RDShaderSPIRV" /> - <argument index="0" name="version" type="StringName" default="&""" /> + <param index="0" name="version" type="StringName" default="&""" /> <description> </description> </method> @@ -20,8 +20,8 @@ </method> <method name="set_bytecode"> <return type="void" /> - <argument index="0" name="bytecode" type="RDShaderSPIRV" /> - <argument index="1" name="version" type="StringName" default="&""" /> + <param index="0" name="bytecode" type="RDShaderSPIRV" /> + <param index="1" name="version" type="StringName" default="&""" /> <description> </description> </method> diff --git a/doc/classes/RDShaderSPIRV.xml b/doc/classes/RDShaderSPIRV.xml index 4453d7eb27..13dc2c6519 100644 --- a/doc/classes/RDShaderSPIRV.xml +++ b/doc/classes/RDShaderSPIRV.xml @@ -9,27 +9,27 @@ <methods> <method name="get_stage_bytecode" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> + <param index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> <description> </description> </method> <method name="get_stage_compile_error" qualifiers="const"> <return type="String" /> - <argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> + <param index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> <description> </description> </method> <method name="set_stage_bytecode"> <return type="void" /> - <argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> - <argument index="1" name="bytecode" type="PackedByteArray" /> + <param index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> + <param index="1" name="bytecode" type="PackedByteArray" /> <description> </description> </method> <method name="set_stage_compile_error"> <return type="void" /> - <argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> - <argument index="1" name="compile_error" type="String" /> + <param index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> + <param index="1" name="compile_error" type="String" /> <description> </description> </method> diff --git a/doc/classes/RDShaderSource.xml b/doc/classes/RDShaderSource.xml index 4c3c21bcb9..ddeae95e39 100644 --- a/doc/classes/RDShaderSource.xml +++ b/doc/classes/RDShaderSource.xml @@ -9,14 +9,14 @@ <methods> <method name="get_stage_source" qualifiers="const"> <return type="String" /> - <argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> + <param index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> <description> </description> </method> <method name="set_stage_source"> <return type="void" /> - <argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> - <argument index="1" name="source" type="String" /> + <param index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage" /> + <param index="1" name="source" type="String" /> <description> </description> </method> diff --git a/doc/classes/RDTextureFormat.xml b/doc/classes/RDTextureFormat.xml index fe2f6d7b1c..1b70303d2d 100644 --- a/doc/classes/RDTextureFormat.xml +++ b/doc/classes/RDTextureFormat.xml @@ -9,13 +9,13 @@ <methods> <method name="add_shareable_format"> <return type="void" /> - <argument index="0" name="format" type="int" enum="RenderingDevice.DataFormat" /> + <param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" /> <description> </description> </method> <method name="remove_shareable_format"> <return type="void" /> - <argument index="0" name="format" type="int" enum="RenderingDevice.DataFormat" /> + <param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" /> <description> </description> </method> diff --git a/doc/classes/RDUniform.xml b/doc/classes/RDUniform.xml index 29664d7c40..d144024000 100644 --- a/doc/classes/RDUniform.xml +++ b/doc/classes/RDUniform.xml @@ -9,7 +9,7 @@ <methods> <method name="add_id"> <return type="void" /> - <argument index="0" name="id" type="RID" /> + <param index="0" name="id" type="RID" /> <description> </description> </method> diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index 39be605e1b..a6523e4c8b 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -17,7 +17,7 @@ </constructor> <constructor name="RID"> <return type="RID" /> - <argument index="0" name="from" type="RID" /> + <param index="0" name="from" type="RID" /> <description> Constructs a [RID] as a copy of the given [RID]. </description> @@ -40,37 +40,37 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="RID" /> + <param index="0" name="right" type="RID" /> <description> </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="RID" /> + <param index="0" name="right" type="RID" /> <description> </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="RID" /> + <param index="0" name="right" type="RID" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="RID" /> + <param index="0" name="right" type="RID" /> <description> </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="RID" /> + <param index="0" name="right" type="RID" /> <description> </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="RID" /> + <param index="0" name="right" type="RID" /> <description> </description> </operator> diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index 28151e858e..726f9e91d8 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -27,16 +27,16 @@ </method> <method name="randf_range"> <return type="float" /> - <argument index="0" name="from" type="float" /> - <argument index="1" name="to" type="float" /> + <param index="0" name="from" type="float" /> + <param index="1" name="to" type="float" /> <description> Returns a pseudo-random float between [code]from[/code] and [code]to[/code] (inclusive). </description> </method> <method name="randfn"> <return type="float" /> - <argument index="0" name="mean" type="float" default="0.0" /> - <argument index="1" name="deviation" type="float" default="1.0" /> + <param index="0" name="mean" type="float" default="0.0" /> + <param index="1" name="deviation" type="float" default="1.0" /> <description> Returns a [url=https://en.wikipedia.org/wiki/Normal_distribution]normally-distributed[/url] pseudo-random number, using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. This is also called Gaussian distribution. </description> @@ -49,8 +49,8 @@ </method> <method name="randi_range"> <return type="int" /> - <argument index="0" name="from" type="int" /> - <argument index="1" name="to" type="int" /> + <param index="0" name="from" type="int" /> + <param index="1" name="to" type="int" /> <description> Returns a pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code] (inclusive). </description> diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 22793e75d8..a4be738395 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -11,14 +11,14 @@ <methods> <method name="_value_changed" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="new_value" type="float" /> + <param index="0" name="new_value" type="float" /> <description> Called when the [Range]'s value is changed (following the same conditions as [signal value_changed]). </description> </method> <method name="share"> <return type="void" /> - <argument index="0" name="with" type="Node" /> + <param index="0" name="with" type="Node" /> <description> Binds two [Range]s together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. </description> @@ -69,7 +69,7 @@ </description> </signal> <signal name="value_changed"> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Emitted when [member value] changes. When used on a [Slider], this is called continuously while dragging (potentially every frame). If you are performing an expensive operation in a function connected to [signal value_changed], consider using a [i]debouncing[/i] [Timer] to call the function less often. [b]Note:[/b] Unlike signals such as [signal LineEdit.text_changed], [signal value_changed] is also emitted when [code]value[/code] is set directly via code. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 2a7d3502df..bbf29c1f44 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -16,14 +16,14 @@ <methods> <method name="add_exception"> <return type="void" /> - <argument index="0" name="node" type="CollisionObject2D" /> + <param index="0" name="node" type="CollisionObject2D" /> <description> Adds a collision exception so the ray does not report collisions with the specified [CollisionObject2D] node. </description> </method> <method name="add_exception_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Adds a collision exception so the ray does not report collisions with the specified [RID]. </description> @@ -55,7 +55,7 @@ </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -81,22 +81,22 @@ </method> <method name="remove_exception"> <return type="void" /> - <argument index="0" name="node" type="CollisionObject2D" /> + <param index="0" name="node" type="CollisionObject2D" /> <description> Removes a collision exception so the ray does report collisions with the specified [CollisionObject2D] node. </description> </method> <method name="remove_exception_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Removes a collision exception so the ray does report collisions with the specified [RID]. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/doc/classes/RayCast3D.xml b/doc/classes/RayCast3D.xml index 65437daa79..09ce79191d 100644 --- a/doc/classes/RayCast3D.xml +++ b/doc/classes/RayCast3D.xml @@ -17,14 +17,14 @@ <methods> <method name="add_exception"> <return type="void" /> - <argument index="0" name="node" type="CollisionObject3D" /> + <param index="0" name="node" type="CollisionObject3D" /> <description> Adds a collision exception so the ray does not report collisions with the specified [CollisionObject3D] node. </description> </method> <method name="add_exception_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Adds a collision exception so the ray does not report collisions with the specified [RID]. </description> @@ -56,7 +56,7 @@ </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -82,22 +82,22 @@ </method> <method name="remove_exception"> <return type="void" /> - <argument index="0" name="node" type="CollisionObject3D" /> + <param index="0" name="node" type="CollisionObject3D" /> <description> Removes a collision exception so the ray does report collisions with the specified [CollisionObject3D] node. </description> </method> <method name="remove_exception_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Removes a collision exception so the ray does report collisions with the specified [RID]. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index e4b66a9d53..082075b161 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -23,32 +23,32 @@ </constructor> <constructor name="Rect2"> <return type="Rect2" /> - <argument index="0" name="from" type="Rect2" /> + <param index="0" name="from" type="Rect2" /> <description> Constructs a [Rect2] as a copy of the given [Rect2]. </description> </constructor> <constructor name="Rect2"> <return type="Rect2" /> - <argument index="0" name="from" type="Rect2i" /> + <param index="0" name="from" type="Rect2i" /> <description> Constructs a [Rect2] from a [Rect2i]. </description> </constructor> <constructor name="Rect2"> <return type="Rect2" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="size" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="size" type="Vector2" /> <description> Constructs a [Rect2] by position and size. </description> </constructor> <constructor name="Rect2"> <return type="Rect2" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> - <argument index="2" name="width" type="float" /> - <argument index="3" name="height" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> + <param index="2" name="width" type="float" /> + <param index="3" name="height" type="float" /> <description> Constructs a [Rect2] by x, y, width, and height. </description> @@ -63,14 +63,14 @@ </method> <method name="encloses" qualifiers="const"> <return type="bool" /> - <argument index="0" name="b" type="Rect2" /> + <param index="0" name="b" type="Rect2" /> <description> Returns [code]true[/code] if this [Rect2] completely encloses another one. </description> </method> <method name="expand" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="to" type="Vector2" /> + <param index="0" name="to" type="Vector2" /> <description> Returns a copy of this [Rect2] expanded to include a given point. [b]Example:[/b] @@ -104,25 +104,25 @@ </method> <method name="grow" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="amount" type="float" /> + <param index="0" name="amount" type="float" /> <description> Returns a copy of the [Rect2] grown by the specified [code]amount[/code] on all sides. </description> </method> <method name="grow_individual" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="left" type="float" /> - <argument index="1" name="top" type="float" /> - <argument index="2" name="right" type="float" /> - <argument index="3" name="bottom" type="float" /> + <param index="0" name="left" type="float" /> + <param index="1" name="top" type="float" /> + <param index="2" name="right" type="float" /> + <param index="3" name="bottom" type="float" /> <description> Returns a copy of the [Rect2] grown by the specified amount on each side individually. </description> </method> <method name="grow_side" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="side" type="int" /> - <argument index="1" name="amount" type="float" /> + <param index="0" name="side" type="int" /> + <param index="1" name="amount" type="float" /> <description> Returns a copy of the [Rect2] grown by the specified [code]amount[/code] on the specified [enum Side]. </description> @@ -136,7 +136,7 @@ </method> <method name="has_point" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> <description> Returns [code]true[/code] if the [Rect2] contains a point. By convention, the right and bottom edges of the [Rect2] are considered exclusive, so points on these edges are [b]not[/b] included. [b]Note:[/b] This method is not reliable for [Rect2] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points. @@ -144,7 +144,7 @@ </method> <method name="intersection" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="b" type="Rect2" /> + <param index="0" name="b" type="Rect2" /> <description> Returns the intersection of this [Rect2] and [code]b[/code]. If the rectangles do not intersect, an empty [Rect2] is returned. @@ -152,8 +152,8 @@ </method> <method name="intersects" qualifiers="const"> <return type="bool" /> - <argument index="0" name="b" type="Rect2" /> - <argument index="1" name="include_borders" type="bool" default="false" /> + <param index="0" name="b" type="Rect2" /> + <param index="1" name="include_borders" type="bool" default="false" /> <description> Returns [code]true[/code] if the [Rect2] overlaps with [code]b[/code] (i.e. they have at least one point in common). If [code]include_borders[/code] is [code]true[/code], they will also be considered overlapping if their borders touch, even without intersection. @@ -161,14 +161,14 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="rect" type="Rect2" /> + <param index="0" name="rect" type="Rect2" /> <description> Returns [code]true[/code] if this [Rect2] and [code]rect[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. </description> </method> <method name="merge" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="b" type="Rect2" /> + <param index="0" name="b" type="Rect2" /> <description> Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code]. </description> @@ -189,7 +189,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Rect2" /> + <param index="0" name="right" type="Rect2" /> <description> Returns [code]true[/code] if the rectangles are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -197,14 +197,14 @@ </operator> <operator name="operator *"> <return type="Rect2" /> - <argument index="0" name="right" type="Transform2D" /> + <param index="0" name="right" type="Transform2D" /> <description> Inversely transforms (multiplies) the [Rect2] by the given [Transform2D] transformation matrix. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Rect2" /> + <param index="0" name="right" type="Rect2" /> <description> Returns [code]true[/code] if the rectangles are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index c9ae685a15..a71380c69a 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -21,32 +21,32 @@ </constructor> <constructor name="Rect2i"> <return type="Rect2i" /> - <argument index="0" name="from" type="Rect2i" /> + <param index="0" name="from" type="Rect2i" /> <description> Constructs a [Rect2i] as a copy of the given [Rect2i]. </description> </constructor> <constructor name="Rect2i"> <return type="Rect2i" /> - <argument index="0" name="from" type="Rect2" /> + <param index="0" name="from" type="Rect2" /> <description> Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated. </description> </constructor> <constructor name="Rect2i"> <return type="Rect2i" /> - <argument index="0" name="position" type="Vector2i" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="position" type="Vector2i" /> + <param index="1" name="size" type="Vector2i" /> <description> Constructs a [Rect2i] by position and size. </description> </constructor> <constructor name="Rect2i"> <return type="Rect2i" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> - <argument index="2" name="width" type="int" /> - <argument index="3" name="height" type="int" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> + <param index="2" name="width" type="int" /> + <param index="3" name="height" type="int" /> <description> Constructs a [Rect2i] by x, y, width, and height. </description> @@ -61,14 +61,14 @@ </method> <method name="encloses" qualifiers="const"> <return type="bool" /> - <argument index="0" name="b" type="Rect2i" /> + <param index="0" name="b" type="Rect2i" /> <description> Returns [code]true[/code] if this [Rect2i] completely encloses another one. </description> </method> <method name="expand" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="to" type="Vector2i" /> + <param index="0" name="to" type="Vector2i" /> <description> Returns a copy of this [Rect2i] expanded so that the borders align with the given point. [codeblocks] @@ -102,25 +102,25 @@ </method> <method name="grow" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="amount" type="int" /> + <param index="0" name="amount" type="int" /> <description> Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on all sides. </description> </method> <method name="grow_individual" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="left" type="int" /> - <argument index="1" name="top" type="int" /> - <argument index="2" name="right" type="int" /> - <argument index="3" name="bottom" type="int" /> + <param index="0" name="left" type="int" /> + <param index="1" name="top" type="int" /> + <param index="2" name="right" type="int" /> + <param index="3" name="bottom" type="int" /> <description> Returns a copy of the [Rect2i] grown by the specified amount on each side individually. </description> </method> <method name="grow_side" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="side" type="int" /> - <argument index="1" name="amount" type="int" /> + <param index="0" name="side" type="int" /> + <param index="1" name="amount" type="int" /> <description> Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on the specified [enum Side]. </description> @@ -134,7 +134,7 @@ </method> <method name="has_point" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point" type="Vector2i" /> + <param index="0" name="point" type="Vector2i" /> <description> Returns [code]true[/code] if the [Rect2i] contains a point. By convention, the right and bottom edges of the [Rect2i] are considered exclusive, so points on these edges are [b]not[/b] included. [b]Note:[/b] This method is not reliable for [Rect2i] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points. @@ -142,7 +142,7 @@ </method> <method name="intersection" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="b" type="Rect2i" /> + <param index="0" name="b" type="Rect2i" /> <description> Returns the intersection of this [Rect2i] and [code]b[/code]. If the rectangles do not intersect, an empty [Rect2i] is returned. @@ -150,14 +150,14 @@ </method> <method name="intersects" qualifiers="const"> <return type="bool" /> - <argument index="0" name="b" type="Rect2i" /> + <param index="0" name="b" type="Rect2i" /> <description> Returns [code]true[/code] if the [Rect2i] overlaps with [code]b[/code] (i.e. they have at least one point in common). </description> </method> <method name="merge" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="b" type="Rect2i" /> + <param index="0" name="b" type="Rect2i" /> <description> Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code]. </description> @@ -178,14 +178,14 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Rect2i" /> + <param index="0" name="right" type="Rect2i" /> <description> Returns [code]true[/code] if the rectangles are not equal. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Rect2i" /> + <param index="0" name="right" type="Rect2i" /> <description> Returns [code]true[/code] if the rectangles are equal. </description> diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 3962f309de..2f0b9dae72 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -9,102 +9,102 @@ <methods> <method name="barrier"> <return type="void" /> - <argument index="0" name="from" type="int" default="7" /> - <argument index="1" name="to" type="int" default="7" /> + <param index="0" name="from" type="int" default="7" /> + <param index="1" name="to" type="int" default="7" /> <description> </description> </method> <method name="buffer_clear"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="RID" /> - <argument index="1" name="offset" type="int" /> - <argument index="2" name="size_bytes" type="int" /> - <argument index="3" name="post_barrier" type="int" default="7" /> + <param index="0" name="buffer" type="RID" /> + <param index="1" name="offset" type="int" /> + <param index="2" name="size_bytes" type="int" /> + <param index="3" name="post_barrier" type="int" default="7" /> <description> </description> </method> <method name="buffer_get_data"> <return type="PackedByteArray" /> - <argument index="0" name="buffer" type="RID" /> + <param index="0" name="buffer" type="RID" /> <description> </description> </method> <method name="buffer_update"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="RID" /> - <argument index="1" name="offset" type="int" /> - <argument index="2" name="size_bytes" type="int" /> - <argument index="3" name="data" type="PackedByteArray" /> - <argument index="4" name="post_barrier" type="int" default="7" /> + <param index="0" name="buffer" type="RID" /> + <param index="1" name="offset" type="int" /> + <param index="2" name="size_bytes" type="int" /> + <param index="3" name="data" type="PackedByteArray" /> + <param index="4" name="post_barrier" type="int" default="7" /> <description> </description> </method> <method name="capture_timestamp"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> </description> </method> <method name="compute_list_add_barrier"> <return type="void" /> - <argument index="0" name="compute_list" type="int" /> + <param index="0" name="compute_list" type="int" /> <description> </description> </method> <method name="compute_list_begin"> <return type="int" /> - <argument index="0" name="allow_draw_overlap" type="bool" default="false" /> + <param index="0" name="allow_draw_overlap" type="bool" default="false" /> <description> </description> </method> <method name="compute_list_bind_compute_pipeline"> <return type="void" /> - <argument index="0" name="compute_list" type="int" /> - <argument index="1" name="compute_pipeline" type="RID" /> + <param index="0" name="compute_list" type="int" /> + <param index="1" name="compute_pipeline" type="RID" /> <description> </description> </method> <method name="compute_list_bind_uniform_set"> <return type="void" /> - <argument index="0" name="compute_list" type="int" /> - <argument index="1" name="uniform_set" type="RID" /> - <argument index="2" name="set_index" type="int" /> + <param index="0" name="compute_list" type="int" /> + <param index="1" name="uniform_set" type="RID" /> + <param index="2" name="set_index" type="int" /> <description> </description> </method> <method name="compute_list_dispatch"> <return type="void" /> - <argument index="0" name="compute_list" type="int" /> - <argument index="1" name="x_groups" type="int" /> - <argument index="2" name="y_groups" type="int" /> - <argument index="3" name="z_groups" type="int" /> + <param index="0" name="compute_list" type="int" /> + <param index="1" name="x_groups" type="int" /> + <param index="2" name="y_groups" type="int" /> + <param index="3" name="z_groups" type="int" /> <description> </description> </method> <method name="compute_list_end"> <return type="void" /> - <argument index="0" name="post_barrier" type="int" default="7" /> + <param index="0" name="post_barrier" type="int" default="7" /> <description> </description> </method> <method name="compute_list_set_push_constant"> <return type="void" /> - <argument index="0" name="compute_list" type="int" /> - <argument index="1" name="buffer" type="PackedByteArray" /> - <argument index="2" name="size_bytes" type="int" /> + <param index="0" name="compute_list" type="int" /> + <param index="1" name="buffer" type="PackedByteArray" /> + <param index="2" name="size_bytes" type="int" /> <description> </description> </method> <method name="compute_pipeline_create"> <return type="RID" /> - <argument index="0" name="shader" type="RID" /> - <argument index="1" name="specialization_constants" type="RDPipelineSpecializationConstant[]" default="[]" /> + <param index="0" name="shader" type="RID" /> + <param index="1" name="specialization_constants" type="RDPipelineSpecializationConstant[]" default="[]" /> <description> </description> </method> <method name="compute_pipeline_is_valid"> <return type="bool" /> - <argument index="0" name="compute_pieline" type="RID" /> + <param index="0" name="compute_pieline" type="RID" /> <description> </description> </method> @@ -115,8 +115,8 @@ </method> <method name="draw_command_begin_label"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="name" type="String" /> + <param index="1" name="color" type="Color" /> <description> </description> </method> @@ -127,111 +127,111 @@ </method> <method name="draw_command_insert_label"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="name" type="String" /> + <param index="1" name="color" type="Color" /> <description> </description> </method> <method name="draw_list_begin"> <return type="int" /> - <argument index="0" name="framebuffer" type="RID" /> - <argument index="1" name="initial_color_action" type="int" enum="RenderingDevice.InitialAction" /> - <argument index="2" name="final_color_action" type="int" enum="RenderingDevice.FinalAction" /> - <argument index="3" name="initial_depth_action" type="int" enum="RenderingDevice.InitialAction" /> - <argument index="4" name="final_depth_action" type="int" enum="RenderingDevice.FinalAction" /> - <argument index="5" name="clear_color_values" type="PackedColorArray" default="PackedColorArray()" /> - <argument index="6" name="clear_depth" type="float" default="1.0" /> - <argument index="7" name="clear_stencil" type="int" default="0" /> - <argument index="8" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" /> - <argument index="9" name="storage_textures" type="Array" default="[]" /> + <param index="0" name="framebuffer" type="RID" /> + <param index="1" name="initial_color_action" type="int" enum="RenderingDevice.InitialAction" /> + <param index="2" name="final_color_action" type="int" enum="RenderingDevice.FinalAction" /> + <param index="3" name="initial_depth_action" type="int" enum="RenderingDevice.InitialAction" /> + <param index="4" name="final_depth_action" type="int" enum="RenderingDevice.FinalAction" /> + <param index="5" name="clear_color_values" type="PackedColorArray" default="PackedColorArray()" /> + <param index="6" name="clear_depth" type="float" default="1.0" /> + <param index="7" name="clear_stencil" type="int" default="0" /> + <param index="8" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="9" name="storage_textures" type="Array" default="[]" /> <description> </description> </method> <method name="draw_list_begin_for_screen"> <return type="int" /> - <argument index="0" name="screen" type="int" default="0" /> - <argument index="1" name="clear_color" type="Color" default="Color(0, 0, 0, 1)" /> + <param index="0" name="screen" type="int" default="0" /> + <param index="1" name="clear_color" type="Color" default="Color(0, 0, 0, 1)" /> <description> </description> </method> <method name="draw_list_begin_split"> <return type="PackedInt64Array" /> - <argument index="0" name="framebuffer" type="RID" /> - <argument index="1" name="splits" type="int" /> - <argument index="2" name="initial_color_action" type="int" enum="RenderingDevice.InitialAction" /> - <argument index="3" name="final_color_action" type="int" enum="RenderingDevice.FinalAction" /> - <argument index="4" name="initial_depth_action" type="int" enum="RenderingDevice.InitialAction" /> - <argument index="5" name="final_depth_action" type="int" enum="RenderingDevice.FinalAction" /> - <argument index="6" name="clear_color_values" type="PackedColorArray" default="PackedColorArray()" /> - <argument index="7" name="clear_depth" type="float" default="1.0" /> - <argument index="8" name="clear_stencil" type="int" default="0" /> - <argument index="9" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" /> - <argument index="10" name="storage_textures" type="RID[]" default="[]" /> + <param index="0" name="framebuffer" type="RID" /> + <param index="1" name="splits" type="int" /> + <param index="2" name="initial_color_action" type="int" enum="RenderingDevice.InitialAction" /> + <param index="3" name="final_color_action" type="int" enum="RenderingDevice.FinalAction" /> + <param index="4" name="initial_depth_action" type="int" enum="RenderingDevice.InitialAction" /> + <param index="5" name="final_depth_action" type="int" enum="RenderingDevice.FinalAction" /> + <param index="6" name="clear_color_values" type="PackedColorArray" default="PackedColorArray()" /> + <param index="7" name="clear_depth" type="float" default="1.0" /> + <param index="8" name="clear_stencil" type="int" default="0" /> + <param index="9" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="10" name="storage_textures" type="RID[]" default="[]" /> <description> </description> </method> <method name="draw_list_bind_index_array"> <return type="void" /> - <argument index="0" name="draw_list" type="int" /> - <argument index="1" name="index_array" type="RID" /> + <param index="0" name="draw_list" type="int" /> + <param index="1" name="index_array" type="RID" /> <description> </description> </method> <method name="draw_list_bind_render_pipeline"> <return type="void" /> - <argument index="0" name="draw_list" type="int" /> - <argument index="1" name="render_pipeline" type="RID" /> + <param index="0" name="draw_list" type="int" /> + <param index="1" name="render_pipeline" type="RID" /> <description> </description> </method> <method name="draw_list_bind_uniform_set"> <return type="void" /> - <argument index="0" name="draw_list" type="int" /> - <argument index="1" name="uniform_set" type="RID" /> - <argument index="2" name="set_index" type="int" /> + <param index="0" name="draw_list" type="int" /> + <param index="1" name="uniform_set" type="RID" /> + <param index="2" name="set_index" type="int" /> <description> </description> </method> <method name="draw_list_bind_vertex_array"> <return type="void" /> - <argument index="0" name="draw_list" type="int" /> - <argument index="1" name="vertex_array" type="RID" /> + <param index="0" name="draw_list" type="int" /> + <param index="1" name="vertex_array" type="RID" /> <description> </description> </method> <method name="draw_list_disable_scissor"> <return type="void" /> - <argument index="0" name="draw_list" type="int" /> + <param index="0" name="draw_list" type="int" /> <description> </description> </method> <method name="draw_list_draw"> <return type="void" /> - <argument index="0" name="draw_list" type="int" /> - <argument index="1" name="use_indices" type="bool" /> - <argument index="2" name="instances" type="int" /> - <argument index="3" name="procedural_vertex_count" type="int" default="0" /> + <param index="0" name="draw_list" type="int" /> + <param index="1" name="use_indices" type="bool" /> + <param index="2" name="instances" type="int" /> + <param index="3" name="procedural_vertex_count" type="int" default="0" /> <description> </description> </method> <method name="draw_list_enable_scissor"> <return type="void" /> - <argument index="0" name="draw_list" type="int" /> - <argument index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="0" name="draw_list" type="int" /> + <param index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" /> <description> </description> </method> <method name="draw_list_end"> <return type="void" /> - <argument index="0" name="post_barrier" type="int" default="7" /> + <param index="0" name="post_barrier" type="int" default="7" /> <description> </description> </method> <method name="draw_list_set_push_constant"> <return type="void" /> - <argument index="0" name="draw_list" type="int" /> - <argument index="1" name="buffer" type="PackedByteArray" /> - <argument index="2" name="size_bytes" type="int" /> + <param index="0" name="draw_list" type="int" /> + <param index="1" name="buffer" type="PackedByteArray" /> + <param index="2" name="size_bytes" type="int" /> <description> </description> </method> @@ -242,78 +242,78 @@ </method> <method name="draw_list_switch_to_next_pass_split"> <return type="PackedInt64Array" /> - <argument index="0" name="splits" type="int" /> + <param index="0" name="splits" type="int" /> <description> </description> </method> <method name="framebuffer_create"> <return type="RID" /> - <argument index="0" name="textures" type="RID[]" /> - <argument index="1" name="validate_with_format" type="int" default="-1" /> - <argument index="2" name="view_count" type="int" default="1" /> + <param index="0" name="textures" type="RID[]" /> + <param index="1" name="validate_with_format" type="int" default="-1" /> + <param index="2" name="view_count" type="int" default="1" /> <description> </description> </method> <method name="framebuffer_create_empty"> <return type="RID" /> - <argument index="0" name="size" type="Vector2i" /> - <argument index="1" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0" /> - <argument index="2" name="validate_with_format" type="int" default="-1" /> + <param index="0" name="size" type="Vector2i" /> + <param index="1" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0" /> + <param index="2" name="validate_with_format" type="int" default="-1" /> <description> </description> </method> <method name="framebuffer_create_multipass"> <return type="RID" /> - <argument index="0" name="textures" type="RID[]" /> - <argument index="1" name="passes" type="RDFramebufferPass[]" /> - <argument index="2" name="validate_with_format" type="int" default="-1" /> - <argument index="3" name="view_count" type="int" default="1" /> + <param index="0" name="textures" type="RID[]" /> + <param index="1" name="passes" type="RDFramebufferPass[]" /> + <param index="2" name="validate_with_format" type="int" default="-1" /> + <param index="3" name="view_count" type="int" default="1" /> <description> </description> </method> <method name="framebuffer_format_create"> <return type="int" /> - <argument index="0" name="attachments" type="RDAttachmentFormat[]" /> - <argument index="1" name="view_count" type="int" default="1" /> + <param index="0" name="attachments" type="RDAttachmentFormat[]" /> + <param index="1" name="view_count" type="int" default="1" /> <description> </description> </method> <method name="framebuffer_format_create_empty"> <return type="int" /> - <argument index="0" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0" /> + <param index="0" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0" /> <description> </description> </method> <method name="framebuffer_format_create_multipass"> <return type="int" /> - <argument index="0" name="attachments" type="RDAttachmentFormat[]" /> - <argument index="1" name="passes" type="RDFramebufferPass[]" /> - <argument index="2" name="view_count" type="int" default="1" /> + <param index="0" name="attachments" type="RDAttachmentFormat[]" /> + <param index="1" name="passes" type="RDFramebufferPass[]" /> + <param index="2" name="view_count" type="int" default="1" /> <description> </description> </method> <method name="framebuffer_format_get_texture_samples"> <return type="int" enum="RenderingDevice.TextureSamples" /> - <argument index="0" name="format" type="int" /> - <argument index="1" name="render_pass" type="int" default="0" /> + <param index="0" name="format" type="int" /> + <param index="1" name="render_pass" type="int" default="0" /> <description> </description> </method> <method name="framebuffer_get_format"> <return type="int" /> - <argument index="0" name="framebuffer" type="RID" /> + <param index="0" name="framebuffer" type="RID" /> <description> </description> </method> <method name="framebuffer_is_valid" qualifiers="const"> <return type="bool" /> - <argument index="0" name="framebuffer" type="RID" /> + <param index="0" name="framebuffer" type="RID" /> <description> </description> </method> <method name="free_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> </description> </method> @@ -324,19 +324,19 @@ </method> <method name="get_captured_timestamp_cpu_time" qualifiers="const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="get_captured_timestamp_gpu_time" qualifiers="const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> <method name="get_captured_timestamp_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </method> @@ -367,9 +367,9 @@ </method> <method name="get_driver_resource"> <return type="int" /> - <argument index="0" name="resource" type="int" enum="RenderingDevice.DriverResource" /> - <argument index="1" name="rid" type="RID" /> - <argument index="2" name="index" type="int" /> + <param index="0" name="resource" type="int" enum="RenderingDevice.DriverResource" /> + <param index="1" name="rid" type="RID" /> + <param index="2" name="index" type="int" /> <description> </description> </method> @@ -380,58 +380,58 @@ </method> <method name="get_memory_usage" qualifiers="const"> <return type="int" /> - <argument index="0" name="type" type="int" enum="RenderingDevice.MemoryType" /> + <param index="0" name="type" type="int" enum="RenderingDevice.MemoryType" /> <description> </description> </method> <method name="index_array_create"> <return type="RID" /> - <argument index="0" name="index_buffer" type="RID" /> - <argument index="1" name="index_offset" type="int" /> - <argument index="2" name="index_count" type="int" /> + <param index="0" name="index_buffer" type="RID" /> + <param index="1" name="index_offset" type="int" /> + <param index="2" name="index_count" type="int" /> <description> </description> </method> <method name="index_buffer_create"> <return type="RID" /> - <argument index="0" name="size_indices" type="int" /> - <argument index="1" name="format" type="int" enum="RenderingDevice.IndexBufferFormat" /> - <argument index="2" name="data" type="PackedByteArray" default="PackedByteArray()" /> - <argument index="3" name="use_restart_indices" type="bool" default="false" /> + <param index="0" name="size_indices" type="int" /> + <param index="1" name="format" type="int" enum="RenderingDevice.IndexBufferFormat" /> + <param index="2" name="data" type="PackedByteArray" default="PackedByteArray()" /> + <param index="3" name="use_restart_indices" type="bool" default="false" /> <description> </description> </method> <method name="limit_get" qualifiers="const"> <return type="int" /> - <argument index="0" name="limit" type="int" enum="RenderingDevice.Limit" /> + <param index="0" name="limit" type="int" enum="RenderingDevice.Limit" /> <description> </description> </method> <method name="render_pipeline_create"> <return type="RID" /> - <argument index="0" name="shader" type="RID" /> - <argument index="1" name="framebuffer_format" type="int" /> - <argument index="2" name="vertex_format" type="int" /> - <argument index="3" name="primitive" type="int" enum="RenderingDevice.RenderPrimitive" /> - <argument index="4" name="rasterization_state" type="RDPipelineRasterizationState" /> - <argument index="5" name="multisample_state" type="RDPipelineMultisampleState" /> - <argument index="6" name="stencil_state" type="RDPipelineDepthStencilState" /> - <argument index="7" name="color_blend_state" type="RDPipelineColorBlendState" /> - <argument index="8" name="dynamic_state_flags" type="int" default="0" /> - <argument index="9" name="for_render_pass" type="int" default="0" /> - <argument index="10" name="specialization_constants" type="RDPipelineSpecializationConstant[]" default="[]" /> + <param index="0" name="shader" type="RID" /> + <param index="1" name="framebuffer_format" type="int" /> + <param index="2" name="vertex_format" type="int" /> + <param index="3" name="primitive" type="int" enum="RenderingDevice.RenderPrimitive" /> + <param index="4" name="rasterization_state" type="RDPipelineRasterizationState" /> + <param index="5" name="multisample_state" type="RDPipelineMultisampleState" /> + <param index="6" name="stencil_state" type="RDPipelineDepthStencilState" /> + <param index="7" name="color_blend_state" type="RDPipelineColorBlendState" /> + <param index="8" name="dynamic_state_flags" type="int" default="0" /> + <param index="9" name="for_render_pass" type="int" default="0" /> + <param index="10" name="specialization_constants" type="RDPipelineSpecializationConstant[]" default="[]" /> <description> </description> </method> <method name="render_pipeline_is_valid"> <return type="bool" /> - <argument index="0" name="render_pipeline" type="RID" /> + <param index="0" name="render_pipeline" type="RID" /> <description> </description> </method> <method name="sampler_create"> <return type="RID" /> - <argument index="0" name="state" type="RDSamplerState" /> + <param index="0" name="state" type="RDSamplerState" /> <description> </description> </method> @@ -442,61 +442,61 @@ </method> <method name="screen_get_height" qualifiers="const"> <return type="int" /> - <argument index="0" name="screen" type="int" default="0" /> + <param index="0" name="screen" type="int" default="0" /> <description> </description> </method> <method name="screen_get_width" qualifiers="const"> <return type="int" /> - <argument index="0" name="screen" type="int" default="0" /> + <param index="0" name="screen" type="int" default="0" /> <description> </description> </method> <method name="set_resource_name"> <return type="void" /> - <argument index="0" name="id" type="RID" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="id" type="RID" /> + <param index="1" name="name" type="String" /> <description> </description> </method> <method name="shader_compile_binary_from_spirv"> <return type="PackedByteArray" /> - <argument index="0" name="spirv_data" type="RDShaderSPIRV" /> - <argument index="1" name="name" type="String" default="""" /> + <param index="0" name="spirv_data" type="RDShaderSPIRV" /> + <param index="1" name="name" type="String" default="""" /> <description> </description> </method> <method name="shader_compile_spirv_from_source"> <return type="RDShaderSPIRV" /> - <argument index="0" name="shader_source" type="RDShaderSource" /> - <argument index="1" name="allow_cache" type="bool" default="true" /> + <param index="0" name="shader_source" type="RDShaderSource" /> + <param index="1" name="allow_cache" type="bool" default="true" /> <description> </description> </method> <method name="shader_create_from_bytecode"> <return type="RID" /> - <argument index="0" name="binary_data" type="PackedByteArray" /> + <param index="0" name="binary_data" type="PackedByteArray" /> <description> </description> </method> <method name="shader_create_from_spirv"> <return type="RID" /> - <argument index="0" name="spirv_data" type="RDShaderSPIRV" /> - <argument index="1" name="name" type="String" default="""" /> + <param index="0" name="spirv_data" type="RDShaderSPIRV" /> + <param index="1" name="name" type="String" default="""" /> <description> </description> </method> <method name="shader_get_vertex_input_attribute_mask"> <return type="int" /> - <argument index="0" name="shader" type="RID" /> + <param index="0" name="shader" type="RID" /> <description> </description> </method> <method name="storage_buffer_create"> <return type="RID" /> - <argument index="0" name="size_bytes" type="int" /> - <argument index="1" name="data" type="PackedByteArray" default="PackedByteArray()" /> - <argument index="2" name="usage" type="int" default="0" /> + <param index="0" name="size_bytes" type="int" /> + <param index="1" name="data" type="PackedByteArray" default="PackedByteArray()" /> + <param index="2" name="usage" type="int" default="0" /> <description> </description> </method> @@ -512,140 +512,140 @@ </method> <method name="texture_buffer_create"> <return type="RID" /> - <argument index="0" name="size_bytes" type="int" /> - <argument index="1" name="format" type="int" enum="RenderingDevice.DataFormat" /> - <argument index="2" name="data" type="PackedByteArray" default="PackedByteArray()" /> + <param index="0" name="size_bytes" type="int" /> + <param index="1" name="format" type="int" enum="RenderingDevice.DataFormat" /> + <param index="2" name="data" type="PackedByteArray" default="PackedByteArray()" /> <description> </description> </method> <method name="texture_clear"> <return type="int" enum="Error" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="base_mipmap" type="int" /> - <argument index="3" name="mipmap_count" type="int" /> - <argument index="4" name="base_layer" type="int" /> - <argument index="5" name="layer_count" type="int" /> - <argument index="6" name="post_barrier" type="int" default="7" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="base_mipmap" type="int" /> + <param index="3" name="mipmap_count" type="int" /> + <param index="4" name="base_layer" type="int" /> + <param index="5" name="layer_count" type="int" /> + <param index="6" name="post_barrier" type="int" default="7" /> <description> </description> </method> <method name="texture_copy"> <return type="int" enum="Error" /> - <argument index="0" name="from_texture" type="RID" /> - <argument index="1" name="to_texture" type="RID" /> - <argument index="2" name="from_pos" type="Vector3" /> - <argument index="3" name="to_pos" type="Vector3" /> - <argument index="4" name="size" type="Vector3" /> - <argument index="5" name="src_mipmap" type="int" /> - <argument index="6" name="dst_mipmap" type="int" /> - <argument index="7" name="src_layer" type="int" /> - <argument index="8" name="dst_layer" type="int" /> - <argument index="9" name="post_barrier" type="int" default="7" /> + <param index="0" name="from_texture" type="RID" /> + <param index="1" name="to_texture" type="RID" /> + <param index="2" name="from_pos" type="Vector3" /> + <param index="3" name="to_pos" type="Vector3" /> + <param index="4" name="size" type="Vector3" /> + <param index="5" name="src_mipmap" type="int" /> + <param index="6" name="dst_mipmap" type="int" /> + <param index="7" name="src_layer" type="int" /> + <param index="8" name="dst_layer" type="int" /> + <param index="9" name="post_barrier" type="int" default="7" /> <description> </description> </method> <method name="texture_create"> <return type="RID" /> - <argument index="0" name="format" type="RDTextureFormat" /> - <argument index="1" name="view" type="RDTextureView" /> - <argument index="2" name="data" type="PackedByteArray[]" default="[]" /> + <param index="0" name="format" type="RDTextureFormat" /> + <param index="1" name="view" type="RDTextureView" /> + <param index="2" name="data" type="PackedByteArray[]" default="[]" /> <description> </description> </method> <method name="texture_create_shared"> <return type="RID" /> - <argument index="0" name="view" type="RDTextureView" /> - <argument index="1" name="with_texture" type="RID" /> + <param index="0" name="view" type="RDTextureView" /> + <param index="1" name="with_texture" type="RID" /> <description> </description> </method> <method name="texture_create_shared_from_slice"> <return type="RID" /> - <argument index="0" name="view" type="RDTextureView" /> - <argument index="1" name="with_texture" type="RID" /> - <argument index="2" name="layer" type="int" /> - <argument index="3" name="mipmap" type="int" /> - <argument index="4" name="mipmaps" type="int" default="1" /> - <argument index="5" name="slice_type" type="int" enum="RenderingDevice.TextureSliceType" default="0" /> + <param index="0" name="view" type="RDTextureView" /> + <param index="1" name="with_texture" type="RID" /> + <param index="2" name="layer" type="int" /> + <param index="3" name="mipmap" type="int" /> + <param index="4" name="mipmaps" type="int" default="1" /> + <param index="5" name="slice_type" type="int" enum="RenderingDevice.TextureSliceType" default="0" /> <description> </description> </method> <method name="texture_get_data"> <return type="PackedByteArray" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="layer" type="int" /> <description> </description> </method> <method name="texture_is_format_supported_for_usage" qualifiers="const"> <return type="bool" /> - <argument index="0" name="format" type="int" enum="RenderingDevice.DataFormat" /> - <argument index="1" name="usage_flags" type="int" /> + <param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" /> + <param index="1" name="usage_flags" type="int" /> <description> </description> </method> <method name="texture_is_shared"> <return type="bool" /> - <argument index="0" name="texture" type="RID" /> + <param index="0" name="texture" type="RID" /> <description> </description> </method> <method name="texture_is_valid"> <return type="bool" /> - <argument index="0" name="texture" type="RID" /> + <param index="0" name="texture" type="RID" /> <description> </description> </method> <method name="texture_resolve_multisample"> <return type="int" enum="Error" /> - <argument index="0" name="from_texture" type="RID" /> - <argument index="1" name="to_texture" type="RID" /> - <argument index="2" name="post_barrier" type="int" default="7" /> + <param index="0" name="from_texture" type="RID" /> + <param index="1" name="to_texture" type="RID" /> + <param index="2" name="post_barrier" type="int" default="7" /> <description> </description> </method> <method name="texture_update"> <return type="int" enum="Error" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="layer" type="int" /> - <argument index="2" name="data" type="PackedByteArray" /> - <argument index="3" name="post_barrier" type="int" default="7" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="layer" type="int" /> + <param index="2" name="data" type="PackedByteArray" /> + <param index="3" name="post_barrier" type="int" default="7" /> <description> </description> </method> <method name="uniform_buffer_create"> <return type="RID" /> - <argument index="0" name="size_bytes" type="int" /> - <argument index="1" name="data" type="PackedByteArray" default="PackedByteArray()" /> + <param index="0" name="size_bytes" type="int" /> + <param index="1" name="data" type="PackedByteArray" default="PackedByteArray()" /> <description> </description> </method> <method name="uniform_set_create"> <return type="RID" /> - <argument index="0" name="uniforms" type="Array" /> - <argument index="1" name="shader" type="RID" /> - <argument index="2" name="shader_set" type="int" /> + <param index="0" name="uniforms" type="Array" /> + <param index="1" name="shader" type="RID" /> + <param index="2" name="shader_set" type="int" /> <description> </description> </method> <method name="uniform_set_is_valid"> <return type="bool" /> - <argument index="0" name="uniform_set" type="RID" /> + <param index="0" name="uniform_set" type="RID" /> <description> </description> </method> <method name="vertex_buffer_create"> <return type="RID" /> - <argument index="0" name="size_bytes" type="int" /> - <argument index="1" name="data" type="PackedByteArray" default="PackedByteArray()" /> - <argument index="2" name="use_as_storage" type="bool" default="false" /> + <param index="0" name="size_bytes" type="int" /> + <param index="1" name="data" type="PackedByteArray" default="PackedByteArray()" /> + <param index="2" name="use_as_storage" type="bool" default="false" /> <description> </description> </method> <method name="vertex_format_create"> <return type="int" /> - <argument index="0" name="vertex_descriptions" type="RDVertexAttribute[]" /> + <param index="0" name="vertex_descriptions" type="RDVertexAttribute[]" /> <description> </description> </method> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index c06b2e1d98..19a75c8515 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -20,9 +20,9 @@ <methods> <method name="bake_render_uv2"> <return type="Image[]" /> - <argument index="0" name="base" type="RID" /> - <argument index="1" name="material_overrides" type="Array" /> - <argument index="2" name="image_size" type="Vector2i" /> + <param index="0" name="base" type="RID" /> + <param index="1" name="material_overrides" type="Array" /> + <param index="2" name="image_size" type="Vector2i" /> <description> </description> </method> @@ -40,104 +40,104 @@ </method> <method name="camera_effects_set_custom_exposure"> <return type="void" /> - <argument index="0" name="camera_effects" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="exposure" type="float" /> + <param index="0" name="camera_effects" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="exposure" type="float" /> <description> </description> </method> <method name="camera_effects_set_dof_blur"> <return type="void" /> - <argument index="0" name="camera_effects" type="RID" /> - <argument index="1" name="far_enable" type="bool" /> - <argument index="2" name="far_distance" type="float" /> - <argument index="3" name="far_transition" type="float" /> - <argument index="4" name="near_enable" type="bool" /> - <argument index="5" name="near_distance" type="float" /> - <argument index="6" name="near_transition" type="float" /> - <argument index="7" name="amount" type="float" /> + <param index="0" name="camera_effects" type="RID" /> + <param index="1" name="far_enable" type="bool" /> + <param index="2" name="far_distance" type="float" /> + <param index="3" name="far_transition" type="float" /> + <param index="4" name="near_enable" type="bool" /> + <param index="5" name="near_distance" type="float" /> + <param index="6" name="near_transition" type="float" /> + <param index="7" name="amount" type="float" /> <description> </description> </method> <method name="camera_effects_set_dof_blur_bokeh_shape"> <return type="void" /> - <argument index="0" name="shape" type="int" enum="RenderingServer.DOFBokehShape" /> + <param index="0" name="shape" type="int" enum="RenderingServer.DOFBokehShape" /> <description> </description> </method> <method name="camera_effects_set_dof_blur_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.DOFBlurQuality" /> - <argument index="1" name="use_jitter" type="bool" /> + <param index="0" name="quality" type="int" enum="RenderingServer.DOFBlurQuality" /> + <param index="1" name="use_jitter" type="bool" /> <description> </description> </method> <method name="camera_set_camera_effects"> <return type="void" /> - <argument index="0" name="camera" type="RID" /> - <argument index="1" name="effects" type="RID" /> + <param index="0" name="camera" type="RID" /> + <param index="1" name="effects" type="RID" /> <description> </description> </method> <method name="camera_set_cull_mask"> <return type="void" /> - <argument index="0" name="camera" type="RID" /> - <argument index="1" name="layers" type="int" /> + <param index="0" name="camera" type="RID" /> + <param index="1" name="layers" type="int" /> <description> Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to [member Camera3D.cull_mask]. </description> </method> <method name="camera_set_environment"> <return type="void" /> - <argument index="0" name="camera" type="RID" /> - <argument index="1" name="env" type="RID" /> + <param index="0" name="camera" type="RID" /> + <param index="1" name="env" type="RID" /> <description> Sets the environment used by this camera. Equivalent to [member Camera3D.environment]. </description> </method> <method name="camera_set_frustum"> <return type="void" /> - <argument index="0" name="camera" type="RID" /> - <argument index="1" name="size" type="float" /> - <argument index="2" name="offset" type="Vector2" /> - <argument index="3" name="z_near" type="float" /> - <argument index="4" name="z_far" type="float" /> + <param index="0" name="camera" type="RID" /> + <param index="1" name="size" type="float" /> + <param index="2" name="offset" type="Vector2" /> + <param index="3" name="z_near" type="float" /> + <param index="4" name="z_far" type="float" /> <description> Sets camera to use frustum projection. This mode allows adjusting the [code]offset[/code] argument to create "tilted frustum" effects. </description> </method> <method name="camera_set_orthogonal"> <return type="void" /> - <argument index="0" name="camera" type="RID" /> - <argument index="1" name="size" type="float" /> - <argument index="2" name="z_near" type="float" /> - <argument index="3" name="z_far" type="float" /> + <param index="0" name="camera" type="RID" /> + <param index="1" name="size" type="float" /> + <param index="2" name="z_near" type="float" /> + <param index="3" name="z_far" type="float" /> <description> Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are. </description> </method> <method name="camera_set_perspective"> <return type="void" /> - <argument index="0" name="camera" type="RID" /> - <argument index="1" name="fovy_degrees" type="float" /> - <argument index="2" name="z_near" type="float" /> - <argument index="3" name="z_far" type="float" /> + <param index="0" name="camera" type="RID" /> + <param index="1" name="fovy_degrees" type="float" /> + <param index="2" name="z_near" type="float" /> + <param index="3" name="z_far" type="float" /> <description> Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away. </description> </method> <method name="camera_set_transform"> <return type="void" /> - <argument index="0" name="camera" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="camera" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> <description> Sets [Transform3D] of camera. </description> </method> <method name="camera_set_use_vertical_aspect"> <return type="void" /> - <argument index="0" name="camera" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="camera" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], preserves the horizontal aspect ratio which is equivalent to [constant Camera3D.KEEP_WIDTH]. If [code]false[/code], preserves the vertical aspect ratio which is equivalent to [constant Camera3D.KEEP_HEIGHT]. </description> @@ -151,181 +151,181 @@ </method> <method name="canvas_item_add_animation_slice"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="animation_length" type="float" /> - <argument index="2" name="slice_begin" type="float" /> - <argument index="3" name="slice_end" type="float" /> - <argument index="4" name="offset" type="float" default="0.0" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="animation_length" type="float" /> + <param index="2" name="slice_begin" type="float" /> + <param index="3" name="slice_end" type="float" /> + <param index="4" name="offset" type="float" default="0.0" /> <description> Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. </description> </method> <method name="canvas_item_add_circle"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="radius" type="float" /> - <argument index="3" name="color" type="Color" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="radius" type="float" /> + <param index="3" name="color" type="Color" /> <description> </description> </method> <method name="canvas_item_add_clip_ignore"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="ignore" type="bool" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="ignore" type="bool" /> <description> </description> </method> <method name="canvas_item_add_line"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="from" type="Vector2" /> - <argument index="2" name="to" type="Vector2" /> - <argument index="3" name="color" type="Color" /> - <argument index="4" name="width" type="float" default="1.0" /> - <argument index="5" name="antialiased" type="bool" default="false" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="from" type="Vector2" /> + <param index="2" name="to" type="Vector2" /> + <param index="3" name="color" type="Color" /> + <param index="4" name="width" type="float" default="1.0" /> + <param index="5" name="antialiased" type="bool" default="false" /> <description> </description> </method> <method name="canvas_item_add_mesh"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="mesh" type="RID" /> - <argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> - <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="texture" type="RID" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="mesh" type="RID" /> + <param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" /> + <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="texture" type="RID" /> <description> </description> </method> <method name="canvas_item_add_msdf_texture_rect_region"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="texture" type="RID" /> - <argument index="3" name="src_rect" type="Rect2" /> - <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="5" name="outline_size" type="int" default="0" /> - <argument index="6" name="px_range" type="float" default="1.0" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="texture" type="RID" /> + <param index="3" name="src_rect" type="Rect2" /> + <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="5" name="outline_size" type="int" default="0" /> + <param index="6" name="px_range" type="float" default="1.0" /> <description> </description> </method> <method name="canvas_item_add_multimesh"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="mesh" type="RID" /> - <argument index="2" name="texture" type="RID" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="mesh" type="RID" /> + <param index="2" name="texture" type="RID" /> <description> </description> </method> <method name="canvas_item_add_nine_patch"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="source" type="Rect2" /> - <argument index="3" name="texture" type="RID" /> - <argument index="4" name="topleft" type="Vector2" /> - <argument index="5" name="bottomright" type="Vector2" /> - <argument index="6" name="x_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" /> - <argument index="7" name="y_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" /> - <argument index="8" name="draw_center" type="bool" default="true" /> - <argument index="9" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="source" type="Rect2" /> + <param index="3" name="texture" type="RID" /> + <param index="4" name="topleft" type="Vector2" /> + <param index="5" name="bottomright" type="Vector2" /> + <param index="6" name="x_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" /> + <param index="7" name="y_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" /> + <param index="8" name="draw_center" type="bool" default="true" /> + <param index="9" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <description> </description> </method> <method name="canvas_item_add_particles"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="particles" type="RID" /> - <argument index="2" name="texture" type="RID" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="particles" type="RID" /> + <param index="2" name="texture" type="RID" /> <description> </description> </method> <method name="canvas_item_add_polygon"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="points" type="PackedVector2Array" /> - <argument index="2" name="colors" type="PackedColorArray" /> - <argument index="3" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> - <argument index="4" name="texture" type="RID" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="points" type="PackedVector2Array" /> + <param index="2" name="colors" type="PackedColorArray" /> + <param index="3" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> + <param index="4" name="texture" type="RID" /> <description> </description> </method> <method name="canvas_item_add_polyline"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="points" type="PackedVector2Array" /> - <argument index="2" name="colors" type="PackedColorArray" /> - <argument index="3" name="width" type="float" default="1.0" /> - <argument index="4" name="antialiased" type="bool" default="false" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="points" type="PackedVector2Array" /> + <param index="2" name="colors" type="PackedColorArray" /> + <param index="3" name="width" type="float" default="1.0" /> + <param index="4" name="antialiased" type="bool" default="false" /> <description> </description> </method> <method name="canvas_item_add_primitive"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="points" type="PackedVector2Array" /> - <argument index="2" name="colors" type="PackedColorArray" /> - <argument index="3" name="uvs" type="PackedVector2Array" /> - <argument index="4" name="texture" type="RID" /> - <argument index="5" name="width" type="float" default="1.0" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="points" type="PackedVector2Array" /> + <param index="2" name="colors" type="PackedColorArray" /> + <param index="3" name="uvs" type="PackedVector2Array" /> + <param index="4" name="texture" type="RID" /> + <param index="5" name="width" type="float" default="1.0" /> <description> </description> </method> <method name="canvas_item_add_rect"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="color" type="Color" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="color" type="Color" /> <description> </description> </method> <method name="canvas_item_add_set_transform"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> </description> </method> <method name="canvas_item_add_texture_rect"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="texture" type="RID" /> - <argument index="3" name="tile" type="bool" default="false" /> - <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="5" name="transpose" type="bool" default="false" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="texture" type="RID" /> + <param index="3" name="tile" type="bool" default="false" /> + <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="5" name="transpose" type="bool" default="false" /> <description> </description> </method> <method name="canvas_item_add_texture_rect_region"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="texture" type="RID" /> - <argument index="3" name="src_rect" type="Rect2" /> - <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="5" name="transpose" type="bool" default="false" /> - <argument index="6" name="clip_uv" type="bool" default="true" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="texture" type="RID" /> + <param index="3" name="src_rect" type="Rect2" /> + <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="5" name="transpose" type="bool" default="false" /> + <param index="6" name="clip_uv" type="bool" default="true" /> <description> </description> </method> <method name="canvas_item_add_triangle_array"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="indices" type="PackedInt32Array" /> - <argument index="2" name="points" type="PackedVector2Array" /> - <argument index="3" name="colors" type="PackedColorArray" /> - <argument index="4" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> - <argument index="5" name="bones" type="PackedInt32Array" default="PackedInt32Array()" /> - <argument index="6" name="weights" type="PackedFloat32Array" default="PackedFloat32Array()" /> - <argument index="7" name="texture" type="RID" /> - <argument index="8" name="count" type="int" default="-1" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="indices" type="PackedInt32Array" /> + <param index="2" name="points" type="PackedVector2Array" /> + <param index="3" name="colors" type="PackedColorArray" /> + <param index="4" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> + <param index="5" name="bones" type="PackedInt32Array" default="PackedInt32Array()" /> + <param index="6" name="weights" type="PackedFloat32Array" default="PackedFloat32Array()" /> + <param index="7" name="texture" type="RID" /> + <param index="8" name="count" type="int" default="-1" /> <description> </description> </method> <method name="canvas_item_clear"> <return type="void" /> - <argument index="0" name="item" type="RID" /> + <param index="0" name="item" type="RID" /> <description> Clears the [CanvasItem] and removes all commands in it. </description> @@ -337,170 +337,170 @@ </method> <method name="canvas_item_set_canvas_group_mode"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.CanvasGroupMode" /> - <argument index="2" name="clear_margin" type="float" default="5.0" /> - <argument index="3" name="fit_empty" type="bool" default="false" /> - <argument index="4" name="fit_margin" type="float" default="0.0" /> - <argument index="5" name="blur_mipmaps" type="bool" default="false" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.CanvasGroupMode" /> + <param index="2" name="clear_margin" type="float" default="5.0" /> + <param index="3" name="fit_empty" type="bool" default="false" /> + <param index="4" name="fit_margin" type="float" default="0.0" /> + <param index="5" name="blur_mipmaps" type="bool" default="false" /> <description> </description> </method> <method name="canvas_item_set_clip"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="clip" type="bool" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="clip" type="bool" /> <description> </description> </method> <method name="canvas_item_set_copy_to_backbuffer"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="enabled" type="bool" /> - <argument index="2" name="rect" type="Rect2" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="enabled" type="bool" /> + <param index="2" name="rect" type="Rect2" /> <description> Sets the [CanvasItem] to copy a rect to the backbuffer. </description> </method> <method name="canvas_item_set_custom_rect"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="use_custom_rect" type="bool" /> - <argument index="2" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="use_custom_rect" type="bool" /> + <param index="2" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" /> <description> </description> </method> <method name="canvas_item_set_default_texture_filter"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" /> <description> </description> </method> <method name="canvas_item_set_default_texture_repeat"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" /> <description> </description> </method> <method name="canvas_item_set_distance_field_mode"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> </description> </method> <method name="canvas_item_set_draw_behind_parent"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> </description> </method> <method name="canvas_item_set_draw_index"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="index" type="int" /> <description> Sets the index for the [CanvasItem]. </description> </method> <method name="canvas_item_set_light_mask"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="mask" type="int" /> <description> </description> </method> <method name="canvas_item_set_material"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="material" type="RID" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="material" type="RID" /> <description> Sets a new material to the [CanvasItem]. </description> </method> <method name="canvas_item_set_modulate"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="color" type="Color" /> <description> </description> </method> <method name="canvas_item_set_parent"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="parent" type="RID" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="parent" type="RID" /> <description> </description> </method> <method name="canvas_item_set_self_modulate"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="color" type="Color" /> <description> </description> </method> <method name="canvas_item_set_sort_children_by_y"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> </description> </method> <method name="canvas_item_set_transform"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> </description> </method> <method name="canvas_item_set_use_parent_material"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> Sets if the [CanvasItem] uses its parent's material. </description> </method> <method name="canvas_item_set_visibility_notifier"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="area" type="Rect2" /> - <argument index="3" name="enter_callable" type="Callable" /> - <argument index="4" name="exit_callable" type="Callable" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="area" type="Rect2" /> + <param index="3" name="enter_callable" type="Callable" /> + <param index="4" name="exit_callable" type="Callable" /> <description> </description> </method> <method name="canvas_item_set_visible"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="visible" type="bool" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="visible" type="bool" /> <description> </description> </method> <method name="canvas_item_set_z_as_relative_to_parent"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If this is enabled, the Z index of the parent will be added to the children's Z index. </description> </method> <method name="canvas_item_set_z_index"> <return type="void" /> - <argument index="0" name="item" type="RID" /> - <argument index="1" name="z_index" type="int" /> + <param index="0" name="item" type="RID" /> + <param index="1" name="z_index" type="int" /> <description> Sets the [CanvasItem]'s Z index, i.e. its draw order (lower indexes are drawn first). </description> </method> <method name="canvas_light_attach_to_canvas"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="canvas" type="RID" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="canvas" type="RID" /> <description> Attaches the canvas light to the canvas. Removes it from its previous canvas. </description> @@ -514,8 +514,8 @@ </method> <method name="canvas_light_occluder_attach_to_canvas"> <return type="void" /> - <argument index="0" name="occluder" type="RID" /> - <argument index="1" name="canvas" type="RID" /> + <param index="0" name="occluder" type="RID" /> + <param index="1" name="canvas" type="RID" /> <description> Attaches a light occluder to the canvas. Removes it from its previous canvas. </description> @@ -529,177 +529,177 @@ </method> <method name="canvas_light_occluder_set_as_sdf_collision"> <return type="void" /> - <argument index="0" name="occluder" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="occluder" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="canvas_light_occluder_set_enabled"> <return type="void" /> - <argument index="0" name="occluder" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="occluder" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> Enables or disables light occluder. </description> </method> <method name="canvas_light_occluder_set_light_mask"> <return type="void" /> - <argument index="0" name="occluder" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="occluder" type="RID" /> + <param index="1" name="mask" type="int" /> <description> The light mask. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_occluder_set_polygon"> <return type="void" /> - <argument index="0" name="occluder" type="RID" /> - <argument index="1" name="polygon" type="RID" /> + <param index="0" name="occluder" type="RID" /> + <param index="1" name="polygon" type="RID" /> <description> Sets a light occluder's polygon. </description> </method> <method name="canvas_light_occluder_set_transform"> <return type="void" /> - <argument index="0" name="occluder" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="occluder" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets a light occluder's [Transform2D]. </description> </method> <method name="canvas_light_set_color"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="color" type="Color" /> <description> Sets the color for a light. </description> </method> <method name="canvas_light_set_enabled"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> Enables or disables a canvas light. </description> </method> <method name="canvas_light_set_energy"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="energy" type="float" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="energy" type="float" /> <description> Sets a canvas light's energy. </description> </method> <method name="canvas_light_set_height"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="height" type="float" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="height" type="float" /> <description> Sets a canvas light's height. </description> </method> <method name="canvas_light_set_item_cull_mask"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="mask" type="int" /> <description> The light mask. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_set_item_shadow_cull_mask"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="mask" type="int" /> <description> The binary mask used to determine which layers this canvas light's shadows affects. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_set_layer_range"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="min_layer" type="int" /> - <argument index="2" name="max_layer" type="int" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="min_layer" type="int" /> + <param index="2" name="max_layer" type="int" /> <description> The layer range that gets rendered with this light. </description> </method> <method name="canvas_light_set_mode"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.CanvasLightMode" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.CanvasLightMode" /> <description> The mode of the light, see [enum CanvasLightMode] constants. </description> </method> <method name="canvas_light_set_shadow_color"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="color" type="Color" /> <description> Sets the color of the canvas light's shadow. </description> </method> <method name="canvas_light_set_shadow_enabled"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> Enables or disables the canvas light's shadow. </description> </method> <method name="canvas_light_set_shadow_filter"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="filter" type="int" enum="RenderingServer.CanvasLightShadowFilter" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="filter" type="int" enum="RenderingServer.CanvasLightShadowFilter" /> <description> Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants. </description> </method> <method name="canvas_light_set_shadow_smooth"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="smooth" type="float" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="smooth" type="float" /> <description> Smoothens the shadow. The lower, the smoother. </description> </method> <method name="canvas_light_set_texture"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="texture" type="RID" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="texture" type="RID" /> <description> Sets the texture to be used by a [PointLight2D]. Equivalent to [member PointLight2D.texture]. </description> </method> <method name="canvas_light_set_texture_offset"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="offset" type="Vector2" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="offset" type="Vector2" /> <description> Sets the offset of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.offset]. </description> </method> <method name="canvas_light_set_texture_scale"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="scale" type="float" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="scale" type="float" /> <description> Sets the scale factor of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.texture_scale]. </description> </method> <method name="canvas_light_set_transform"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets the canvas light's [Transform2D]. </description> </method> <method name="canvas_light_set_z_range"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="min_z" type="int" /> - <argument index="2" name="max_z" type="int" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="min_z" type="int" /> + <param index="2" name="max_z" type="int" /> <description> Sets the Z range of objects that will be affected by this light. Equivalent to [member Light2D.range_z_min] and [member Light2D.range_z_max]. </description> @@ -713,47 +713,47 @@ </method> <method name="canvas_occluder_polygon_set_cull_mode"> <return type="void" /> - <argument index="0" name="occluder_polygon" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.CanvasOccluderPolygonCullMode" /> + <param index="0" name="occluder_polygon" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.CanvasOccluderPolygonCullMode" /> <description> Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants. </description> </method> <method name="canvas_occluder_polygon_set_shape"> <return type="void" /> - <argument index="0" name="occluder_polygon" type="RID" /> - <argument index="1" name="shape" type="PackedVector2Array" /> - <argument index="2" name="closed" type="bool" /> + <param index="0" name="occluder_polygon" type="RID" /> + <param index="1" name="shape" type="PackedVector2Array" /> + <param index="2" name="closed" type="bool" /> <description> Sets the shape of the occluder polygon. </description> </method> <method name="canvas_set_disable_scale"> <return type="void" /> - <argument index="0" name="disable" type="bool" /> + <param index="0" name="disable" type="bool" /> <description> </description> </method> <method name="canvas_set_item_mirroring"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="item" type="RID" /> - <argument index="2" name="mirroring" type="Vector2" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="item" type="RID" /> + <param index="2" name="mirroring" type="Vector2" /> <description> A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2]. </description> </method> <method name="canvas_set_modulate"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="color" type="Color" /> <description> Modulates all colors in the given canvas. </description> </method> <method name="canvas_set_shadow_texture_size"> <return type="void" /> - <argument index="0" name="size" type="int" /> + <param index="0" name="size" type="int" /> <description> </description> </method> @@ -764,31 +764,31 @@ </method> <method name="canvas_texture_set_channel"> <return type="void" /> - <argument index="0" name="canvas_texture" type="RID" /> - <argument index="1" name="channel" type="int" enum="RenderingServer.CanvasTextureChannel" /> - <argument index="2" name="texture" type="RID" /> + <param index="0" name="canvas_texture" type="RID" /> + <param index="1" name="channel" type="int" enum="RenderingServer.CanvasTextureChannel" /> + <param index="2" name="texture" type="RID" /> <description> </description> </method> <method name="canvas_texture_set_shading_parameters"> <return type="void" /> - <argument index="0" name="canvas_texture" type="RID" /> - <argument index="1" name="base_color" type="Color" /> - <argument index="2" name="shininess" type="float" /> + <param index="0" name="canvas_texture" type="RID" /> + <param index="1" name="base_color" type="Color" /> + <param index="2" name="shininess" type="float" /> <description> </description> </method> <method name="canvas_texture_set_texture_filter"> <return type="void" /> - <argument index="0" name="canvas_texture" type="RID" /> - <argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" /> + <param index="0" name="canvas_texture" type="RID" /> + <param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" /> <description> </description> </method> <method name="canvas_texture_set_texture_repeat"> <return type="void" /> - <argument index="0" name="canvas_texture" type="RID" /> - <argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" /> + <param index="0" name="canvas_texture" type="RID" /> + <param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" /> <description> </description> </method> @@ -804,74 +804,74 @@ </method> <method name="decal_set_albedo_mix"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="albedo_mix" type="float" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="albedo_mix" type="float" /> <description> </description> </method> <method name="decal_set_cull_mask"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="mask" type="int" /> <description> </description> </method> <method name="decal_set_distance_fade"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="enabled" type="bool" /> - <argument index="2" name="begin" type="float" /> - <argument index="3" name="length" type="float" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="enabled" type="bool" /> + <param index="2" name="begin" type="float" /> + <param index="3" name="length" type="float" /> <description> </description> </method> <method name="decal_set_emission_energy"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="energy" type="float" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="energy" type="float" /> <description> </description> </method> <method name="decal_set_extents"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="extents" type="Vector3" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="extents" type="Vector3" /> <description> </description> </method> <method name="decal_set_fade"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="above" type="float" /> - <argument index="2" name="below" type="float" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="above" type="float" /> + <param index="2" name="below" type="float" /> <description> </description> </method> <method name="decal_set_modulate"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="color" type="Color" /> <description> </description> </method> <method name="decal_set_normal_fade"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="fade" type="float" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="fade" type="float" /> <description> </description> </method> <method name="decal_set_texture"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="type" type="int" enum="RenderingServer.DecalTexture" /> - <argument index="2" name="texture" type="RID" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="type" type="int" enum="RenderingServer.DecalTexture" /> + <param index="2" name="texture" type="RID" /> <description> </description> </method> <method name="decals_set_filter"> <return type="void" /> - <argument index="0" name="filter" type="int" enum="RenderingServer.DecalFilter" /> + <param index="0" name="filter" type="int" enum="RenderingServer.DecalFilter" /> <description> </description> </method> @@ -885,22 +885,22 @@ </method> <method name="directional_shadow_atlas_set_size"> <return type="void" /> - <argument index="0" name="size" type="int" /> - <argument index="1" name="is_16bits" type="bool" /> + <param index="0" name="size" type="int" /> + <param index="1" name="is_16bits" type="bool" /> <description> </description> </method> <method name="directional_soft_shadow_filter_set_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" /> + <param index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" /> <description> </description> </method> <method name="environment_bake_panorama"> <return type="Image" /> - <argument index="0" name="environment" type="RID" /> - <argument index="1" name="bake_irradiance" type="bool" /> - <argument index="2" name="size" type="Vector2i" /> + <param index="0" name="environment" type="RID" /> + <param index="1" name="bake_irradiance" type="bool" /> + <param index="2" name="size" type="Vector2i" /> <description> </description> </method> @@ -913,264 +913,264 @@ </method> <method name="environment_glow_set_use_bicubic_upscale"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> </description> </method> <method name="environment_glow_set_use_high_quality"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> </description> </method> <method name="environment_set_adjustment"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="brightness" type="float" /> - <argument index="3" name="contrast" type="float" /> - <argument index="4" name="saturation" type="float" /> - <argument index="5" name="use_1d_color_correction" type="bool" /> - <argument index="6" name="color_correction" type="RID" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="brightness" type="float" /> + <param index="3" name="contrast" type="float" /> + <param index="4" name="saturation" type="float" /> + <param index="5" name="use_1d_color_correction" type="bool" /> + <param index="6" name="color_correction" type="RID" /> <description> Sets the values to be used with the "Adjustment" post-process effect. See [Environment] for more details. </description> </method> <method name="environment_set_ambient_light"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="ambient" type="int" enum="RenderingServer.EnvironmentAmbientSource" default="0" /> - <argument index="3" name="energy" type="float" default="1.0" /> - <argument index="4" name="sky_contibution" type="float" default="0.0" /> - <argument index="5" name="reflection_source" type="int" enum="RenderingServer.EnvironmentReflectionSource" default="0" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="ambient" type="int" enum="RenderingServer.EnvironmentAmbientSource" default="0" /> + <param index="3" name="energy" type="float" default="1.0" /> + <param index="4" name="sky_contibution" type="float" default="0.0" /> + <param index="5" name="reflection_source" type="int" enum="RenderingServer.EnvironmentReflectionSource" default="0" /> <description> </description> </method> <method name="environment_set_background"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="bg" type="int" enum="RenderingServer.EnvironmentBG" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="bg" type="int" enum="RenderingServer.EnvironmentBG" /> <description> Sets the [i]BGMode[/i] of the environment. Equivalent to [member Environment.background_mode]. </description> </method> <method name="environment_set_bg_color"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="color" type="Color" /> <description> Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). </description> </method> <method name="environment_set_bg_energy"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="energy" type="float" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="energy" type="float" /> <description> Sets the intensity of the background color. </description> </method> <method name="environment_set_canvas_max_layer"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="max_layer" type="int" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="max_layer" type="int" /> <description> Sets the maximum layer to use if using Canvas background mode. </description> </method> <method name="environment_set_fog"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="light_color" type="Color" /> - <argument index="3" name="light_energy" type="float" /> - <argument index="4" name="sun_scatter" type="float" /> - <argument index="5" name="density" type="float" /> - <argument index="6" name="height" type="float" /> - <argument index="7" name="height_density" type="float" /> - <argument index="8" name="aerial_perspective" type="float" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="light_color" type="Color" /> + <param index="3" name="light_energy" type="float" /> + <param index="4" name="sun_scatter" type="float" /> + <param index="5" name="density" type="float" /> + <param index="6" name="height" type="float" /> + <param index="7" name="height_density" type="float" /> + <param index="8" name="aerial_perspective" type="float" /> <description> </description> </method> <method name="environment_set_glow"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="levels" type="PackedFloat32Array" /> - <argument index="3" name="intensity" type="float" /> - <argument index="4" name="strength" type="float" /> - <argument index="5" name="mix" type="float" /> - <argument index="6" name="bloom_threshold" type="float" /> - <argument index="7" name="blend_mode" type="int" enum="RenderingServer.EnvironmentGlowBlendMode" /> - <argument index="8" name="hdr_bleed_threshold" type="float" /> - <argument index="9" name="hdr_bleed_scale" type="float" /> - <argument index="10" name="hdr_luminance_cap" type="float" /> - <argument index="11" name="glow_map_strength" type="float" /> - <argument index="12" name="glow_map" type="RID" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="levels" type="PackedFloat32Array" /> + <param index="3" name="intensity" type="float" /> + <param index="4" name="strength" type="float" /> + <param index="5" name="mix" type="float" /> + <param index="6" name="bloom_threshold" type="float" /> + <param index="7" name="blend_mode" type="int" enum="RenderingServer.EnvironmentGlowBlendMode" /> + <param index="8" name="hdr_bleed_threshold" type="float" /> + <param index="9" name="hdr_bleed_scale" type="float" /> + <param index="10" name="hdr_luminance_cap" type="float" /> + <param index="11" name="glow_map_strength" type="float" /> + <param index="12" name="glow_map" type="RID" /> <description> </description> </method> <method name="environment_set_sdfgi"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="cascades" type="int" /> - <argument index="3" name="min_cell_size" type="float" /> - <argument index="4" name="y_scale" type="int" enum="RenderingServer.EnvironmentSDFGIYScale" /> - <argument index="5" name="use_occlusion" type="bool" /> - <argument index="6" name="bounce_feedback" type="float" /> - <argument index="7" name="read_sky" type="bool" /> - <argument index="8" name="energy" type="float" /> - <argument index="9" name="normal_bias" type="float" /> - <argument index="10" name="probe_bias" type="float" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="cascades" type="int" /> + <param index="3" name="min_cell_size" type="float" /> + <param index="4" name="y_scale" type="int" enum="RenderingServer.EnvironmentSDFGIYScale" /> + <param index="5" name="use_occlusion" type="bool" /> + <param index="6" name="bounce_feedback" type="float" /> + <param index="7" name="read_sky" type="bool" /> + <param index="8" name="energy" type="float" /> + <param index="9" name="normal_bias" type="float" /> + <param index="10" name="probe_bias" type="float" /> <description> </description> </method> <method name="environment_set_sdfgi_frames_to_converge"> <return type="void" /> - <argument index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToConverge" /> + <param index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToConverge" /> <description> </description> </method> <method name="environment_set_sdfgi_frames_to_update_light"> <return type="void" /> - <argument index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToUpdateLight" /> + <param index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToUpdateLight" /> <description> </description> </method> <method name="environment_set_sdfgi_ray_count"> <return type="void" /> - <argument index="0" name="ray_count" type="int" enum="RenderingServer.EnvironmentSDFGIRayCount" /> + <param index="0" name="ray_count" type="int" enum="RenderingServer.EnvironmentSDFGIRayCount" /> <description> </description> </method> <method name="environment_set_sky"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="sky" type="RID" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="sky" type="RID" /> <description> Sets the [Sky] to be used as the environment's background when using [i]BGMode[/i] sky. Equivalent to [member Environment.sky]. </description> </method> <method name="environment_set_sky_custom_fov"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="scale" type="float" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="scale" type="float" /> <description> Sets a custom field of view for the background [Sky]. Equivalent to [member Environment.sky_custom_fov]. </description> </method> <method name="environment_set_sky_orientation"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="orientation" type="Basis" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="orientation" type="Basis" /> <description> Sets the rotation of the background [Sky] expressed as a [Basis]. Equivalent to [member Environment.sky_rotation], where the rotation vector is used to construct the [Basis]. </description> </method> <method name="environment_set_ssao"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="radius" type="float" /> - <argument index="3" name="intensity" type="float" /> - <argument index="4" name="power" type="float" /> - <argument index="5" name="detail" type="float" /> - <argument index="6" name="horizon" type="float" /> - <argument index="7" name="sharpness" type="float" /> - <argument index="8" name="light_affect" type="float" /> - <argument index="9" name="ao_channel_affect" type="float" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="radius" type="float" /> + <param index="3" name="intensity" type="float" /> + <param index="4" name="power" type="float" /> + <param index="5" name="detail" type="float" /> + <param index="6" name="horizon" type="float" /> + <param index="7" name="sharpness" type="float" /> + <param index="8" name="light_affect" type="float" /> + <param index="9" name="ao_channel_affect" type="float" /> <description> Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See [Environment] for more details. </description> </method> <method name="environment_set_ssao_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSAOQuality" /> - <argument index="1" name="half_size" type="bool" /> - <argument index="2" name="adaptive_target" type="float" /> - <argument index="3" name="blur_passes" type="int" /> - <argument index="4" name="fadeout_from" type="float" /> - <argument index="5" name="fadeout_to" type="float" /> + <param index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSAOQuality" /> + <param index="1" name="half_size" type="bool" /> + <param index="2" name="adaptive_target" type="float" /> + <param index="3" name="blur_passes" type="int" /> + <param index="4" name="fadeout_from" type="float" /> + <param index="5" name="fadeout_to" type="float" /> <description> Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See [Environment] for more details. </description> </method> <method name="environment_set_ssil_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSILQuality" /> - <argument index="1" name="half_size" type="bool" /> - <argument index="2" name="adaptive_target" type="float" /> - <argument index="3" name="blur_passes" type="int" /> - <argument index="4" name="fadeout_from" type="float" /> - <argument index="5" name="fadeout_to" type="float" /> + <param index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSILQuality" /> + <param index="1" name="half_size" type="bool" /> + <param index="2" name="adaptive_target" type="float" /> + <param index="3" name="blur_passes" type="int" /> + <param index="4" name="fadeout_from" type="float" /> + <param index="5" name="fadeout_to" type="float" /> <description> Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See [Environment] for more details. </description> </method> <method name="environment_set_ssr"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="max_steps" type="int" /> - <argument index="3" name="fade_in" type="float" /> - <argument index="4" name="fade_out" type="float" /> - <argument index="5" name="depth_tolerance" type="float" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="max_steps" type="int" /> + <param index="3" name="fade_in" type="float" /> + <param index="4" name="fade_out" type="float" /> + <param index="5" name="depth_tolerance" type="float" /> <description> Sets the variables to be used with the "screen space reflections" post-process effect. See [Environment] for more details. </description> </method> <method name="environment_set_ssr_roughness_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSRRoughnessQuality" /> + <param index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSRRoughnessQuality" /> <description> </description> </method> <method name="environment_set_tonemap"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="tone_mapper" type="int" enum="RenderingServer.EnvironmentToneMapper" /> - <argument index="2" name="exposure" type="float" /> - <argument index="3" name="white" type="float" /> - <argument index="4" name="auto_exposure" type="bool" /> - <argument index="5" name="min_luminance" type="float" /> - <argument index="6" name="max_luminance" type="float" /> - <argument index="7" name="auto_exp_speed" type="float" /> - <argument index="8" name="auto_exp_grey" type="float" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="tone_mapper" type="int" enum="RenderingServer.EnvironmentToneMapper" /> + <param index="2" name="exposure" type="float" /> + <param index="3" name="white" type="float" /> + <param index="4" name="auto_exposure" type="bool" /> + <param index="5" name="min_luminance" type="float" /> + <param index="6" name="max_luminance" type="float" /> + <param index="7" name="auto_exp_speed" type="float" /> + <param index="8" name="auto_exp_grey" type="float" /> <description> Sets the variables to be used with the "tonemap" post-process effect. See [Environment] for more details. </description> </method> <method name="environment_set_volumetric_fog"> <return type="void" /> - <argument index="0" name="env" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="density" type="float" /> - <argument index="3" name="albedo" type="Color" /> - <argument index="4" name="emission" type="Color" /> - <argument index="5" name="emission_energy" type="float" /> - <argument index="6" name="anisotropy" type="float" /> - <argument index="7" name="length" type="float" /> - <argument index="8" name="p_detail_spread" type="float" /> - <argument index="9" name="gi_inject" type="float" /> - <argument index="10" name="temporal_reprojection" type="bool" /> - <argument index="11" name="temporal_reprojection_amount" type="float" /> - <argument index="12" name="ambient_inject" type="float" /> + <param index="0" name="env" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="density" type="float" /> + <param index="3" name="albedo" type="Color" /> + <param index="4" name="emission" type="Color" /> + <param index="5" name="emission_energy" type="float" /> + <param index="6" name="anisotropy" type="float" /> + <param index="7" name="length" type="float" /> + <param index="8" name="p_detail_spread" type="float" /> + <param index="9" name="gi_inject" type="float" /> + <param index="10" name="temporal_reprojection" type="bool" /> + <param index="11" name="temporal_reprojection_amount" type="float" /> + <param index="12" name="ambient_inject" type="float" /> <description> </description> </method> <method name="environment_set_volumetric_fog_filter_active"> <return type="void" /> - <argument index="0" name="active" type="bool" /> + <param index="0" name="active" type="bool" /> <description> Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts. </description> </method> <method name="environment_set_volumetric_fog_volume_size"> <return type="void" /> - <argument index="0" name="size" type="int" /> - <argument index="1" name="depth" type="int" /> + <param index="0" name="size" type="int" /> + <param index="1" name="depth" type="int" /> <description> Sets the resolution of the volumetric fog's froxel buffer. [code]size[/code] is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While [code]depth[/code] is directly used to set the depth of the buffer. </description> @@ -1183,32 +1183,32 @@ </method> <method name="fog_volume_set_extents"> <return type="void" /> - <argument index="0" name="fog_volume" type="RID" /> - <argument index="1" name="extents" type="Vector3" /> + <param index="0" name="fog_volume" type="RID" /> + <param index="1" name="extents" type="Vector3" /> <description> Sets the size of the fog volume when shape is [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER] or [constant RenderingServer.FOG_VOLUME_SHAPE_BOX]. </description> </method> <method name="fog_volume_set_material"> <return type="void" /> - <argument index="0" name="fog_volume" type="RID" /> - <argument index="1" name="material" type="RID" /> + <param index="0" name="fog_volume" type="RID" /> + <param index="1" name="material" type="RID" /> <description> Sets the [Material] of the fog volume. Can be either a [FogMaterial] or a custom [ShaderMaterial]. </description> </method> <method name="fog_volume_set_shape"> <return type="void" /> - <argument index="0" name="fog_volume" type="RID" /> - <argument index="1" name="shape" type="int" enum="RenderingServer.FogVolumeShape" /> + <param index="0" name="fog_volume" type="RID" /> + <param index="1" name="shape" type="int" enum="RenderingServer.FogVolumeShape" /> <description> Sets the shape of the fog volume to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD]. </description> </method> <method name="force_draw"> <return type="void" /> - <argument index="0" name="swap_buffers" type="bool" default="true" /> - <argument index="1" name="frame_step" type="float" default="0.0" /> + <param index="0" name="swap_buffers" type="bool" default="true" /> + <param index="1" name="frame_step" type="float" default="0.0" /> <description> </description> </method> @@ -1219,7 +1219,7 @@ </method> <method name="free_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Tries to free an object in the RenderingServer. </description> @@ -1236,7 +1236,7 @@ </method> <method name="get_rendering_info"> <return type="int" /> - <argument index="0" name="info" type="int" enum="RenderingServer.RenderingInfo" /> + <param index="0" name="info" type="int" enum="RenderingServer.RenderingInfo" /> <description> </description> </method> @@ -1288,22 +1288,22 @@ </method> <method name="gi_set_use_half_resolution"> <return type="void" /> - <argument index="0" name="half_resolution" type="bool" /> + <param index="0" name="half_resolution" type="bool" /> <description> If [code]half_resolution[/code] is [code]true[/code], renders [VoxelGI] and SDFGI ([member Environment.sdfgi_enabled]) buffers at halved resolution (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. [LightmapGI] rendering is not affected by this setting. See also [member ProjectSettings.rendering/global_illumination/gi/use_half_resolution]. </description> </method> <method name="global_shader_uniform_add"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="type" type="int" enum="RenderingServer.GlobalShaderUniformType" /> - <argument index="2" name="default_value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="type" type="int" enum="RenderingServer.GlobalShaderUniformType" /> + <param index="2" name="default_value" type="Variant" /> <description> </description> </method> <method name="global_shader_uniform_get" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> @@ -1314,27 +1314,27 @@ </method> <method name="global_shader_uniform_get_type" qualifiers="const"> <return type="int" enum="RenderingServer.GlobalShaderUniformType" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> <method name="global_shader_uniform_remove"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> <method name="global_shader_uniform_set"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> </description> </method> <method name="global_shader_uniform_set_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> </description> </method> @@ -1346,30 +1346,30 @@ </method> <method name="has_feature" qualifiers="const"> <return type="bool" /> - <argument index="0" name="feature" type="int" enum="RenderingServer.Features" /> + <param index="0" name="feature" type="int" enum="RenderingServer.Features" /> <description> Not yet implemented. Always returns [code]false[/code]. </description> </method> <method name="has_os_feature" qualifiers="const"> <return type="bool" /> - <argument index="0" name="feature" type="String" /> + <param index="0" name="feature" type="String" /> <description> Returns [code]true[/code] if the OS supports a certain feature. Features might be [code]s3tc[/code], [code]etc[/code], and [code]etc2[/code]. </description> </method> <method name="instance_attach_object_instance_id"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="id" type="int" /> <description> Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with [method instances_cull_aabb], [method instances_cull_convex], and [method instances_cull_ray]. </description> </method> <method name="instance_attach_skeleton"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="skeleton" type="RID" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="skeleton" type="RID" /> <description> Attaches a skeleton to an instance. Removes the previous skeleton from the instance. </description> @@ -1384,8 +1384,8 @@ </method> <method name="instance_create2"> <return type="RID" /> - <argument index="0" name="base" type="RID" /> - <argument index="1" name="scenario" type="RID" /> + <param index="0" name="base" type="RID" /> + <param index="1" name="scenario" type="RID" /> <description> Creates a visual instance, adds it to the RenderingServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. @@ -1393,85 +1393,85 @@ </method> <method name="instance_geometry_get_shader_uniform" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="parameter" type="StringName" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="parameter" type="StringName" /> <description> </description> </method> <method name="instance_geometry_get_shader_uniform_default_value" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="parameter" type="StringName" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="parameter" type="StringName" /> <description> </description> </method> <method name="instance_geometry_get_shader_uniform_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="instance" type="RID" /> + <param index="0" name="instance" type="RID" /> <description> </description> </method> <method name="instance_geometry_set_cast_shadows_setting"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="shadow_casting_setting" type="int" enum="RenderingServer.ShadowCastingSetting" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="shadow_casting_setting" type="int" enum="RenderingServer.ShadowCastingSetting" /> <description> Sets the shadow casting setting to one of [enum ShadowCastingSetting]. Equivalent to [member GeometryInstance3D.cast_shadow]. </description> </method> <method name="instance_geometry_set_flag"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="flag" type="int" enum="RenderingServer.InstanceFlags" /> - <argument index="2" name="enabled" type="bool" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="flag" type="int" enum="RenderingServer.InstanceFlags" /> + <param index="2" name="enabled" type="bool" /> <description> Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details. </description> </method> <method name="instance_geometry_set_lightmap"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="lightmap" type="RID" /> - <argument index="2" name="lightmap_uv_scale" type="Rect2" /> - <argument index="3" name="lightmap_slice" type="int" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="lightmap" type="RID" /> + <param index="2" name="lightmap_uv_scale" type="Rect2" /> + <param index="3" name="lightmap_slice" type="int" /> <description> </description> </method> <method name="instance_geometry_set_lod_bias"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="lod_bias" type="float" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="lod_bias" type="float" /> <description> </description> </method> <method name="instance_geometry_set_material_overlay"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="material" type="RID" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="material" type="RID" /> <description> Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_overlay]. </description> </method> <method name="instance_geometry_set_material_override"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="material" type="RID" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="material" type="RID" /> <description> Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_override]. </description> </method> <method name="instance_geometry_set_shader_uniform"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="parameter" type="StringName" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="parameter" type="StringName" /> + <param index="2" name="value" type="Variant" /> <description> </description> </method> <method name="instance_geometry_set_transparency"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="transparency" type="float" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="transparency" type="float" /> <description> Sets the transparency for the given geometry instance. Equivalent to [member GeometryInstance3D.transparency]. A transparency of [code]0.0[/code] is fully opaque, while [code]1.0[/code] is fully transparent. Values greater than [code]0.0[/code] (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting [code]transparency[/code] to a value greater than [code]0.0[/code] (exclusive) will [i]not[/i] disable shadow rendering. @@ -1481,109 +1481,109 @@ </method> <method name="instance_geometry_set_visibility_range"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="min" type="float" /> - <argument index="2" name="max" type="float" /> - <argument index="3" name="min_margin" type="float" /> - <argument index="4" name="max_margin" type="float" /> - <argument index="5" name="fade_mode" type="int" enum="RenderingServer.VisibilityRangeFadeMode" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="min" type="float" /> + <param index="2" name="max" type="float" /> + <param index="3" name="min_margin" type="float" /> + <param index="4" name="max_margin" type="float" /> + <param index="5" name="fade_mode" type="int" enum="RenderingServer.VisibilityRangeFadeMode" /> <description> Sets the visibility range values for the given geometry instance. Equivalent to [member GeometryInstance3D.visibility_range_begin] and related properties. </description> </method> <method name="instance_set_base"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="base" type="RID" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="base" type="RID" /> <description> Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario. </description> </method> <method name="instance_set_blend_shape_weight"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="shape" type="int" /> - <argument index="2" name="weight" type="float" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="shape" type="int" /> + <param index="2" name="weight" type="float" /> <description> Sets the weight for a given blend shape associated with this instance. </description> </method> <method name="instance_set_custom_aabb"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="aabb" type="AABB" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="aabb" type="AABB" /> <description> Sets a custom AABB to use when culling objects from the view frustum. Equivalent to [method GeometryInstance3D.set_custom_aabb]. </description> </method> <method name="instance_set_extra_visibility_margin"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="margin" type="float" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="margin" type="float" /> <description> Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to [member GeometryInstance3D.extra_cull_margin]. </description> </method> <method name="instance_set_ignore_culling"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> </description> </method> <method name="instance_set_layer_mask"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="mask" type="int" /> <description> Sets the render layers that this instance will be drawn to. Equivalent to [member VisualInstance3D.layers]. </description> </method> <method name="instance_set_scenario"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="scenario" type="RID" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="scenario" type="RID" /> <description> Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in. </description> </method> <method name="instance_set_surface_override_material"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="surface" type="int" /> - <argument index="2" name="material" type="RID" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="surface" type="int" /> + <param index="2" name="material" type="RID" /> <description> Sets the override material of a specific surface. Equivalent to [method MeshInstance3D.set_surface_override_material]. </description> </method> <method name="instance_set_transform"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> <description> Sets the world space transform of the instance. Equivalent to [member Node3D.transform]. </description> </method> <method name="instance_set_visibility_parent"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="parent" type="RID" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="parent" type="RID" /> <description> Sets the visibility parent for the given instance. Equivalent to [member Node3D.visibility_parent]. </description> </method> <method name="instance_set_visible"> <return type="void" /> - <argument index="0" name="instance" type="RID" /> - <argument index="1" name="visible" type="bool" /> + <param index="0" name="instance" type="RID" /> + <param index="1" name="visible" type="bool" /> <description> Sets whether an instance is drawn or not. Equivalent to [member Node3D.visible]. </description> </method> <method name="instances_cull_aabb" qualifiers="const"> <return type="Array" /> - <argument index="0" name="aabb" type="AABB" /> - <argument index="1" name="scenario" type="RID" /> + <param index="0" name="aabb" type="AABB" /> + <param index="1" name="scenario" type="RID" /> <description> Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. @@ -1591,8 +1591,8 @@ </method> <method name="instances_cull_convex" qualifiers="const"> <return type="Array" /> - <argument index="0" name="convex" type="Array" /> - <argument index="1" name="scenario" type="RID" /> + <param index="0" name="convex" type="Array" /> + <param index="1" name="scenario" type="RID" /> <description> Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. @@ -1600,9 +1600,9 @@ </method> <method name="instances_cull_ray" qualifiers="const"> <return type="Array" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> - <argument index="2" name="scenario" type="RID" /> + <param index="0" name="from" type="Vector3" /> + <param index="1" name="to" type="Vector3" /> + <param index="2" name="scenario" type="RID" /> <description> Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. @@ -1610,120 +1610,120 @@ </method> <method name="light_directional_set_blend_splits"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to [member DirectionalLight3D.directional_shadow_blend_splits]. </description> </method> <method name="light_directional_set_shadow_mode"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalShadowMode" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalShadowMode" /> <description> Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options. </description> </method> <method name="light_directional_set_sky_mode"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalSkyMode" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalSkyMode" /> <description> If [code]true[/code], this light will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon. </description> </method> <method name="light_omni_set_shadow_mode"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.LightOmniShadowMode" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.LightOmniShadowMode" /> <description> Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to [member OmniLight3D.omni_shadow_mode]. </description> </method> <method name="light_projectors_set_filter"> <return type="void" /> - <argument index="0" name="filter" type="int" enum="RenderingServer.LightProjectorFilter" /> + <param index="0" name="filter" type="int" enum="RenderingServer.LightProjectorFilter" /> <description> </description> </method> <method name="light_set_bake_mode"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="bake_mode" type="int" enum="RenderingServer.LightBakeMode" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="bake_mode" type="int" enum="RenderingServer.LightBakeMode" /> <description> </description> </method> <method name="light_set_color"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="color" type="Color" /> <description> Sets the color of the light. Equivalent to [member Light3D.light_color]. </description> </method> <method name="light_set_cull_mask"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="mask" type="int" /> <description> Sets the cull mask for this Light3D. Lights only affect objects in the selected layers. Equivalent to [member Light3D.light_cull_mask]. </description> </method> <method name="light_set_distance_fade"> <return type="void" /> - <argument index="0" name="decal" type="RID" /> - <argument index="1" name="enabled" type="bool" /> - <argument index="2" name="begin" type="float" /> - <argument index="3" name="shadow" type="float" /> - <argument index="4" name="length" type="float" /> + <param index="0" name="decal" type="RID" /> + <param index="1" name="enabled" type="bool" /> + <param index="2" name="begin" type="float" /> + <param index="3" name="shadow" type="float" /> + <param index="4" name="length" type="float" /> <description> Sets the distance fade for this Light3D. This acts as a form of level of detail (LOD) and can be used to improve performance. Equivalent to [member Light3D.distance_fade_enabled], [member Light3D.distance_fade_begin], [member Light3D.distance_fade_shadow], and [member Light3D.distance_fade_length]. </description> </method> <method name="light_set_max_sdfgi_cascade"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="cascade" type="int" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="cascade" type="int" /> <description> </description> </method> <method name="light_set_negative"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], light will subtract light instead of adding light. Equivalent to [member Light3D.light_negative]. </description> </method> <method name="light_set_param"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="param" type="int" enum="RenderingServer.LightParam" /> - <argument index="2" name="value" type="float" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="param" type="int" enum="RenderingServer.LightParam" /> + <param index="2" name="value" type="float" /> <description> Sets the specified light parameter. See [enum LightParam] for options. Equivalent to [method Light3D.set_param]. </description> </method> <method name="light_set_projector"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="texture" type="RID" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="texture" type="RID" /> <description> Not implemented in Godot 3.x. </description> </method> <method name="light_set_reverse_cull_face_mode"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If [code]true[/code], reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with [method instance_geometry_set_cast_shadows_setting]. Equivalent to [member Light3D.shadow_reverse_cull_face]. </description> </method> <method name="light_set_shadow"> <return type="void" /> - <argument index="0" name="light" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="light" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If [code]true[/code], light will cast shadows. Equivalent to [member Light3D.shadow_enabled]. </description> @@ -1735,71 +1735,71 @@ </method> <method name="lightmap_get_probe_capture_bsp_tree" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="lightmap" type="RID" /> + <param index="0" name="lightmap" type="RID" /> <description> </description> </method> <method name="lightmap_get_probe_capture_points" qualifiers="const"> <return type="PackedVector3Array" /> - <argument index="0" name="lightmap" type="RID" /> + <param index="0" name="lightmap" type="RID" /> <description> </description> </method> <method name="lightmap_get_probe_capture_sh" qualifiers="const"> <return type="PackedColorArray" /> - <argument index="0" name="lightmap" type="RID" /> + <param index="0" name="lightmap" type="RID" /> <description> </description> </method> <method name="lightmap_get_probe_capture_tetrahedra" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="lightmap" type="RID" /> + <param index="0" name="lightmap" type="RID" /> <description> </description> </method> <method name="lightmap_set_probe_bounds"> <return type="void" /> - <argument index="0" name="lightmap" type="RID" /> - <argument index="1" name="bounds" type="AABB" /> + <param index="0" name="lightmap" type="RID" /> + <param index="1" name="bounds" type="AABB" /> <description> </description> </method> <method name="lightmap_set_probe_capture_data"> <return type="void" /> - <argument index="0" name="lightmap" type="RID" /> - <argument index="1" name="points" type="PackedVector3Array" /> - <argument index="2" name="point_sh" type="PackedColorArray" /> - <argument index="3" name="tetrahedra" type="PackedInt32Array" /> - <argument index="4" name="bsp_tree" type="PackedInt32Array" /> + <param index="0" name="lightmap" type="RID" /> + <param index="1" name="points" type="PackedVector3Array" /> + <param index="2" name="point_sh" type="PackedColorArray" /> + <param index="3" name="tetrahedra" type="PackedInt32Array" /> + <param index="4" name="bsp_tree" type="PackedInt32Array" /> <description> </description> </method> <method name="lightmap_set_probe_capture_update_speed"> <return type="void" /> - <argument index="0" name="speed" type="float" /> + <param index="0" name="speed" type="float" /> <description> </description> </method> <method name="lightmap_set_probe_interior"> <return type="void" /> - <argument index="0" name="lightmap" type="RID" /> - <argument index="1" name="interior" type="bool" /> + <param index="0" name="lightmap" type="RID" /> + <param index="1" name="interior" type="bool" /> <description> </description> </method> <method name="lightmap_set_textures"> <return type="void" /> - <argument index="0" name="lightmap" type="RID" /> - <argument index="1" name="light" type="RID" /> - <argument index="2" name="uses_sh" type="bool" /> + <param index="0" name="lightmap" type="RID" /> + <param index="1" name="light" type="RID" /> + <param index="2" name="uses_sh" type="bool" /> <description> </description> </method> <method name="make_sphere_mesh"> <return type="RID" /> - <argument index="0" name="latitudes" type="int" /> - <argument index="1" name="longitudes" type="int" /> - <argument index="2" name="radius" type="float" /> + <param index="0" name="latitudes" type="int" /> + <param index="1" name="longitudes" type="int" /> + <param index="2" name="radius" type="float" /> <description> Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. </description> @@ -1813,66 +1813,66 @@ </method> <method name="material_get_param" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="material" type="RID" /> - <argument index="1" name="parameter" type="StringName" /> + <param index="0" name="material" type="RID" /> + <param index="1" name="parameter" type="StringName" /> <description> Returns the value of a certain material's parameter. </description> </method> <method name="material_set_next_pass"> <return type="void" /> - <argument index="0" name="material" type="RID" /> - <argument index="1" name="next_material" type="RID" /> + <param index="0" name="material" type="RID" /> + <param index="1" name="next_material" type="RID" /> <description> Sets an object's next material. </description> </method> <method name="material_set_param"> <return type="void" /> - <argument index="0" name="material" type="RID" /> - <argument index="1" name="parameter" type="StringName" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="material" type="RID" /> + <param index="1" name="parameter" type="StringName" /> + <param index="2" name="value" type="Variant" /> <description> Sets a material's parameter. </description> </method> <method name="material_set_render_priority"> <return type="void" /> - <argument index="0" name="material" type="RID" /> - <argument index="1" name="priority" type="int" /> + <param index="0" name="material" type="RID" /> + <param index="1" name="priority" type="int" /> <description> Sets a material's render priority. </description> </method> <method name="material_set_shader"> <return type="void" /> - <argument index="0" name="shader_material" type="RID" /> - <argument index="1" name="shader" type="RID" /> + <param index="0" name="shader_material" type="RID" /> + <param index="1" name="shader" type="RID" /> <description> Sets a shader material's shader. </description> </method> <method name="mesh_add_surface"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="Dictionary" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="Dictionary" /> <description> </description> </method> <method name="mesh_add_surface_from_arrays"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="primitive" type="int" enum="RenderingServer.PrimitiveType" /> - <argument index="2" name="arrays" type="Array" /> - <argument index="3" name="blend_shapes" type="Array" default="[]" /> - <argument index="4" name="lods" type="Dictionary" default="{}" /> - <argument index="5" name="compress_format" type="int" default="0" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="primitive" type="int" enum="RenderingServer.PrimitiveType" /> + <param index="2" name="arrays" type="Array" /> + <param index="3" name="blend_shapes" type="Array" default="[]" /> + <param index="4" name="lods" type="Dictionary" default="{}" /> + <param index="5" name="compress_format" type="int" default="0" /> <description> </description> </method> <method name="mesh_clear"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> + <param index="0" name="mesh" type="RID" /> <description> Removes all surfaces from a mesh. </description> @@ -1887,165 +1887,165 @@ </method> <method name="mesh_create_from_surfaces"> <return type="RID" /> - <argument index="0" name="surfaces" type="Dictionary[]" /> - <argument index="1" name="blend_shape_count" type="int" default="0" /> + <param index="0" name="surfaces" type="Dictionary[]" /> + <param index="1" name="blend_shape_count" type="int" default="0" /> <description> </description> </method> <method name="mesh_get_blend_shape_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="mesh" type="RID" /> + <param index="0" name="mesh" type="RID" /> <description> Returns a mesh's blend shape count. </description> </method> <method name="mesh_get_blend_shape_mode" qualifiers="const"> <return type="int" enum="RenderingServer.BlendShapeMode" /> - <argument index="0" name="mesh" type="RID" /> + <param index="0" name="mesh" type="RID" /> <description> Returns a mesh's blend shape mode. </description> </method> <method name="mesh_get_custom_aabb" qualifiers="const"> <return type="AABB" /> - <argument index="0" name="mesh" type="RID" /> + <param index="0" name="mesh" type="RID" /> <description> Returns a mesh's custom aabb. </description> </method> <method name="mesh_get_surface"> <return type="Dictionary" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="int" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="int" /> <description> </description> </method> <method name="mesh_get_surface_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="mesh" type="RID" /> + <param index="0" name="mesh" type="RID" /> <description> Returns a mesh's number of surfaces. </description> </method> <method name="mesh_set_blend_shape_mode"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.BlendShapeMode" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.BlendShapeMode" /> <description> Sets a mesh's blend shape mode. </description> </method> <method name="mesh_set_custom_aabb"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="aabb" type="AABB" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="aabb" type="AABB" /> <description> Sets a mesh's custom aabb. </description> </method> <method name="mesh_set_shadow_mesh"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="shadow_mesh" type="RID" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="shadow_mesh" type="RID" /> <description> </description> </method> <method name="mesh_surface_get_arrays" qualifiers="const"> <return type="Array" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="int" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="int" /> <description> Returns a mesh's surface's buffer arrays. </description> </method> <method name="mesh_surface_get_blend_shape_arrays" qualifiers="const"> <return type="Array" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="int" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="int" /> <description> Returns a mesh's surface's arrays for blend shapes. </description> </method> <method name="mesh_surface_get_format_attribute_stride" qualifiers="const"> <return type="int" /> - <argument index="0" name="format" type="int" /> - <argument index="1" name="vertex_count" type="int" /> + <param index="0" name="format" type="int" /> + <param index="1" name="vertex_count" type="int" /> <description> </description> </method> <method name="mesh_surface_get_format_offset" qualifiers="const"> <return type="int" /> - <argument index="0" name="format" type="int" /> - <argument index="1" name="vertex_count" type="int" /> - <argument index="2" name="array_index" type="int" /> + <param index="0" name="format" type="int" /> + <param index="1" name="vertex_count" type="int" /> + <param index="2" name="array_index" type="int" /> <description> </description> </method> <method name="mesh_surface_get_format_skin_stride" qualifiers="const"> <return type="int" /> - <argument index="0" name="format" type="int" /> - <argument index="1" name="vertex_count" type="int" /> + <param index="0" name="format" type="int" /> + <param index="1" name="vertex_count" type="int" /> <description> </description> </method> <method name="mesh_surface_get_format_vertex_stride" qualifiers="const"> <return type="int" /> - <argument index="0" name="format" type="int" /> - <argument index="1" name="vertex_count" type="int" /> + <param index="0" name="format" type="int" /> + <param index="1" name="vertex_count" type="int" /> <description> </description> </method> <method name="mesh_surface_get_material" qualifiers="const"> <return type="RID" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="int" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="int" /> <description> Returns a mesh's surface's material. </description> </method> <method name="mesh_surface_set_material"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="int" /> - <argument index="2" name="material" type="RID" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="int" /> + <param index="2" name="material" type="RID" /> <description> Sets a mesh's surface's material. </description> </method> <method name="mesh_surface_update_attribute_region"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="int" /> - <argument index="2" name="offset" type="int" /> - <argument index="3" name="data" type="PackedByteArray" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="int" /> + <param index="2" name="offset" type="int" /> + <param index="3" name="data" type="PackedByteArray" /> <description> </description> </method> <method name="mesh_surface_update_skin_region"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="int" /> - <argument index="2" name="offset" type="int" /> - <argument index="3" name="data" type="PackedByteArray" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="int" /> + <param index="2" name="offset" type="int" /> + <param index="3" name="data" type="PackedByteArray" /> <description> </description> </method> <method name="mesh_surface_update_vertex_region"> <return type="void" /> - <argument index="0" name="mesh" type="RID" /> - <argument index="1" name="surface" type="int" /> - <argument index="2" name="offset" type="int" /> - <argument index="3" name="data" type="PackedByteArray" /> + <param index="0" name="mesh" type="RID" /> + <param index="1" name="surface" type="int" /> + <param index="2" name="offset" type="int" /> + <param index="3" name="data" type="PackedByteArray" /> <description> </description> </method> <method name="multimesh_allocate_data"> <return type="void" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="instances" type="int" /> - <argument index="2" name="transform_format" type="int" enum="RenderingServer.MultimeshTransformFormat" /> - <argument index="3" name="color_format" type="bool" default="false" /> - <argument index="4" name="custom_data_format" type="bool" default="false" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="instances" type="int" /> + <param index="2" name="transform_format" type="int" enum="RenderingServer.MultimeshTransformFormat" /> + <param index="3" name="color_format" type="bool" default="false" /> + <param index="4" name="custom_data_format" type="bool" default="false" /> <description> </description> </method> @@ -2059,125 +2059,125 @@ </method> <method name="multimesh_get_aabb" qualifiers="const"> <return type="AABB" /> - <argument index="0" name="multimesh" type="RID" /> + <param index="0" name="multimesh" type="RID" /> <description> Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh. </description> </method> <method name="multimesh_get_buffer" qualifiers="const"> <return type="PackedFloat32Array" /> - <argument index="0" name="multimesh" type="RID" /> + <param index="0" name="multimesh" type="RID" /> <description> </description> </method> <method name="multimesh_get_instance_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="multimesh" type="RID" /> + <param index="0" name="multimesh" type="RID" /> <description> Returns the number of instances allocated for this multimesh. </description> </method> <method name="multimesh_get_mesh" qualifiers="const"> <return type="RID" /> - <argument index="0" name="multimesh" type="RID" /> + <param index="0" name="multimesh" type="RID" /> <description> Returns the RID of the mesh that will be used in drawing this multimesh. </description> </method> <method name="multimesh_get_visible_instances" qualifiers="const"> <return type="int" /> - <argument index="0" name="multimesh" type="RID" /> + <param index="0" name="multimesh" type="RID" /> <description> Returns the number of visible instances for this multimesh. </description> </method> <method name="multimesh_instance_get_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="index" type="int" /> <description> Returns the color by which the specified instance will be modulated. </description> </method> <method name="multimesh_instance_get_custom_data" qualifiers="const"> <return type="Color" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="index" type="int" /> <description> Returns the custom data associated with the specified instance. </description> </method> <method name="multimesh_instance_get_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="index" type="int" /> <description> Returns the [Transform3D] of the specified instance. </description> </method> <method name="multimesh_instance_get_transform_2d" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="index" type="int" /> <description> Returns the [Transform2D] of the specified instance. For use when the multimesh is set to use 2D transforms. </description> </method> <method name="multimesh_instance_set_color"> <return type="void" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="index" type="int" /> - <argument index="2" name="color" type="Color" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="index" type="int" /> + <param index="2" name="color" type="Color" /> <description> Sets the color by which this instance will be modulated. Equivalent to [method MultiMesh.set_instance_color]. </description> </method> <method name="multimesh_instance_set_custom_data"> <return type="void" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="index" type="int" /> - <argument index="2" name="custom_data" type="Color" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="index" type="int" /> + <param index="2" name="custom_data" type="Color" /> <description> Sets the custom data for this instance. Custom data is passed as a [Color], but is interpreted as a [code]vec4[/code] in the shader. Equivalent to [method MultiMesh.set_instance_custom_data]. </description> </method> <method name="multimesh_instance_set_transform"> <return type="void" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="index" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="index" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> Sets the [Transform3D] for this instance. Equivalent to [method MultiMesh.set_instance_transform]. </description> </method> <method name="multimesh_instance_set_transform_2d"> <return type="void" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="index" type="int" /> - <argument index="2" name="transform" type="Transform2D" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="index" type="int" /> + <param index="2" name="transform" type="Transform2D" /> <description> Sets the [Transform2D] for this instance. For use when multimesh is used in 2D. Equivalent to [method MultiMesh.set_instance_transform_2d]. </description> </method> <method name="multimesh_set_buffer"> <return type="void" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="buffer" type="PackedFloat32Array" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="buffer" type="PackedFloat32Array" /> <description> </description> </method> <method name="multimesh_set_mesh"> <return type="void" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="mesh" type="RID" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="mesh" type="RID" /> <description> Sets the mesh to be drawn by the multimesh. Equivalent to [member MultiMesh.mesh]. </description> </method> <method name="multimesh_set_visible_instances"> <return type="void" /> - <argument index="0" name="multimesh" type="RID" /> - <argument index="1" name="visible" type="int" /> + <param index="0" name="multimesh" type="RID" /> + <param index="1" name="visible" type="int" /> <description> Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to [member MultiMesh.visible_instance_count]. </description> @@ -2189,9 +2189,9 @@ </method> <method name="occluder_set_mesh"> <return type="void" /> - <argument index="0" name="occluder" type="RID" /> - <argument index="1" name="vertices" type="PackedVector3Array" /> - <argument index="2" name="indices" type="PackedInt32Array" /> + <param index="0" name="occluder" type="RID" /> + <param index="1" name="vertices" type="PackedVector3Array" /> + <param index="2" name="indices" type="PackedInt32Array" /> <description> </description> </method> @@ -2210,70 +2210,70 @@ </method> <method name="particles_collision_height_field_update"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> + <param index="0" name="particles_collision" type="RID" /> <description> </description> </method> <method name="particles_collision_set_attractor_attenuation"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="curve" type="float" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="curve" type="float" /> <description> </description> </method> <method name="particles_collision_set_attractor_directionality"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="amount" type="float" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="amount" type="float" /> <description> </description> </method> <method name="particles_collision_set_attractor_strength"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="setrngth" type="float" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="setrngth" type="float" /> <description> </description> </method> <method name="particles_collision_set_box_extents"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="extents" type="Vector3" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="extents" type="Vector3" /> <description> </description> </method> <method name="particles_collision_set_collision_type"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="type" type="int" enum="RenderingServer.ParticlesCollisionType" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="type" type="int" enum="RenderingServer.ParticlesCollisionType" /> <description> </description> </method> <method name="particles_collision_set_cull_mask"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="mask" type="int" /> <description> </description> </method> <method name="particles_collision_set_field_texture"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="texture" type="RID" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="texture" type="RID" /> <description> </description> </method> <method name="particles_collision_set_height_field_resolution"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="resolution" type="int" enum="RenderingServer.ParticlesCollisionHeightfieldResolution" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="resolution" type="int" enum="RenderingServer.ParticlesCollisionHeightfieldResolution" /> <description> </description> </method> <method name="particles_collision_set_sphere_radius"> <return type="void" /> - <argument index="0" name="particles_collision" type="RID" /> - <argument index="1" name="radius" type="float" /> + <param index="0" name="particles_collision" type="RID" /> + <param index="1" name="radius" type="float" /> <description> </description> </method> @@ -2287,180 +2287,180 @@ </method> <method name="particles_emit"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> - <argument index="2" name="velocity" type="Vector3" /> - <argument index="3" name="color" type="Color" /> - <argument index="4" name="custom" type="Color" /> - <argument index="5" name="emit_flags" type="int" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> + <param index="2" name="velocity" type="Vector3" /> + <param index="3" name="color" type="Color" /> + <param index="4" name="custom" type="Color" /> + <param index="5" name="emit_flags" type="int" /> <description> </description> </method> <method name="particles_get_current_aabb"> <return type="AABB" /> - <argument index="0" name="particles" type="RID" /> + <param index="0" name="particles" type="RID" /> <description> Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to [method GPUParticles3D.capture_aabb]. </description> </method> <method name="particles_get_emitting"> <return type="bool" /> - <argument index="0" name="particles" type="RID" /> + <param index="0" name="particles" type="RID" /> <description> Returns [code]true[/code] if particles are currently set to emitting. </description> </method> <method name="particles_is_inactive"> <return type="bool" /> - <argument index="0" name="particles" type="RID" /> + <param index="0" name="particles" type="RID" /> <description> Returns [code]true[/code] if particles are not emitting and particles are set to inactive. </description> </method> <method name="particles_request_process"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> + <param index="0" name="particles" type="RID" /> <description> Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to [method instances_cull_aabb], [method instances_cull_convex], or [method instances_cull_ray]. </description> </method> <method name="particles_restart"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> + <param index="0" name="particles" type="RID" /> <description> Reset the particles on the next update. Equivalent to [method GPUParticles3D.restart]. </description> </method> <method name="particles_set_amount"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="amount" type="int" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="amount" type="int" /> <description> Sets the number of particles to be drawn and allocates the memory for them. Equivalent to [member GPUParticles3D.amount]. </description> </method> <method name="particles_set_collision_base_size"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="size" type="float" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="size" type="float" /> <description> </description> </method> <method name="particles_set_custom_aabb"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="aabb" type="AABB" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="aabb" type="AABB" /> <description> Sets a custom axis-aligned bounding box for the particle system. Equivalent to [member GPUParticles3D.visibility_aabb]. </description> </method> <method name="particles_set_draw_order"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="order" type="int" enum="RenderingServer.ParticlesDrawOrder" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="order" type="int" enum="RenderingServer.ParticlesDrawOrder" /> <description> Sets the draw order of the particles to one of the named enums from [enum ParticlesDrawOrder]. See [enum ParticlesDrawOrder] for options. Equivalent to [member GPUParticles3D.draw_order]. </description> </method> <method name="particles_set_draw_pass_mesh"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="pass" type="int" /> - <argument index="2" name="mesh" type="RID" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="pass" type="int" /> + <param index="2" name="mesh" type="RID" /> <description> Sets the mesh to be used for the specified draw pass. Equivalent to [member GPUParticles3D.draw_pass_1], [member GPUParticles3D.draw_pass_2], [member GPUParticles3D.draw_pass_3], and [member GPUParticles3D.draw_pass_4]. </description> </method> <method name="particles_set_draw_passes"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="count" type="int" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="count" type="int" /> <description> Sets the number of draw passes to use. Equivalent to [member GPUParticles3D.draw_passes]. </description> </method> <method name="particles_set_emission_transform"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="transform" type="Transform3D" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="transform" type="Transform3D" /> <description> Sets the [Transform3D] that will be used by the particles when they first emit. </description> </method> <method name="particles_set_emitting"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="emitting" type="bool" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="emitting" type="bool" /> <description> If [code]true[/code], particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to [member GPUParticles3D.emitting]. </description> </method> <method name="particles_set_explosiveness_ratio"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="ratio" type="float" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="ratio" type="float" /> <description> Sets the explosiveness ratio. Equivalent to [member GPUParticles3D.explosiveness]. </description> </method> <method name="particles_set_fixed_fps"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="fps" type="int" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="fps" type="int" /> <description> Sets the frame rate that the particle system rendering will be fixed to. Equivalent to [member GPUParticles3D.fixed_fps]. </description> </method> <method name="particles_set_fractional_delta"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], uses fractional delta which smooths the movement of the particles. Equivalent to [member GPUParticles3D.fract_delta]. </description> </method> <method name="particles_set_interpolate"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="particles_set_lifetime"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="lifetime" type="float" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="lifetime" type="float" /> <description> Sets the lifetime of each particle in the system. Equivalent to [member GPUParticles3D.lifetime]. </description> </method> <method name="particles_set_mode"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.ParticlesMode" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.ParticlesMode" /> <description> </description> </method> <method name="particles_set_one_shot"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="one_shot" type="bool" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="one_shot" type="bool" /> <description> If [code]true[/code], particles will emit once and then stop. Equivalent to [member GPUParticles3D.one_shot]. </description> </method> <method name="particles_set_pre_process_time"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="time" type="float" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="time" type="float" /> <description> Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to [member GPUParticles3D.preprocess]. </description> </method> <method name="particles_set_process_material"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="material" type="RID" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="material" type="RID" /> <description> Sets the material for processing the particles. [b]Note:[/b] This is not the material used to draw the materials. Equivalent to [member GPUParticles3D.process_material]. @@ -2468,60 +2468,60 @@ </method> <method name="particles_set_randomness_ratio"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="ratio" type="float" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="ratio" type="float" /> <description> Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to [member GPUParticles3D.randomness]. </description> </method> <method name="particles_set_speed_scale"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="scale" type="float" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="scale" type="float" /> <description> Sets the speed scale of the particle system. Equivalent to [member GPUParticles3D.speed_scale]. </description> </method> <method name="particles_set_subemitter"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="subemitter_particles" type="RID" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="subemitter_particles" type="RID" /> <description> </description> </method> <method name="particles_set_trail_bind_poses"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="bind_poses" type="Transform3D[]" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="bind_poses" type="Transform3D[]" /> <description> </description> </method> <method name="particles_set_trails"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="enable" type="bool" /> - <argument index="2" name="length_sec" type="float" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="enable" type="bool" /> + <param index="2" name="length_sec" type="float" /> <description> </description> </method> <method name="particles_set_transform_align"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="align" type="int" enum="RenderingServer.ParticlesTransformAlign" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="align" type="int" enum="RenderingServer.ParticlesTransformAlign" /> <description> </description> </method> <method name="particles_set_use_local_coordinates"> <return type="void" /> - <argument index="0" name="particles" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="particles" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], particles use local coordinates. If [code]false[/code] they use global coordinates. Equivalent to [member GPUParticles3D.local_coords]. </description> </method> <method name="positional_soft_shadow_filter_set_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" /> + <param index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" /> <description> </description> </method> @@ -2535,114 +2535,114 @@ </method> <method name="reflection_probe_set_ambient_color"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="color" type="Color" /> <description> </description> </method> <method name="reflection_probe_set_ambient_energy"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="energy" type="float" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="energy" type="float" /> <description> </description> </method> <method name="reflection_probe_set_ambient_mode"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeAmbientMode" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeAmbientMode" /> <description> </description> </method> <method name="reflection_probe_set_as_interior"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], reflections will ignore sky contribution. Equivalent to [member ReflectionProbe.interior]. </description> </method> <method name="reflection_probe_set_cull_mask"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="layers" type="int" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="layers" type="int" /> <description> Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to [member ReflectionProbe.cull_mask]. </description> </method> <method name="reflection_probe_set_enable_box_projection"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], uses box projection. This can make reflections look more correct in certain situations. Equivalent to [member ReflectionProbe.box_projection]. </description> </method> <method name="reflection_probe_set_enable_shadows"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to [member ReflectionProbe.enable_shadows]. </description> </method> <method name="reflection_probe_set_extents"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="extents" type="Vector3" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="extents" type="Vector3" /> <description> Sets the size of the area that the reflection probe will capture. Equivalent to [member ReflectionProbe.extents]. </description> </method> <method name="reflection_probe_set_intensity"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="intensity" type="float" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="intensity" type="float" /> <description> Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to [member ReflectionProbe.intensity]. </description> </method> <method name="reflection_probe_set_max_distance"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="distance" type="float" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="distance" type="float" /> <description> Sets the max distance away from the probe an object can be before it is culled. Equivalent to [member ReflectionProbe.max_distance]. </description> </method> <method name="reflection_probe_set_mesh_lod_threshold"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="pixels" type="float" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="pixels" type="float" /> <description> </description> </method> <method name="reflection_probe_set_origin_offset"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="offset" type="Vector3" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="offset" type="Vector3" /> <description> Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to [member ReflectionProbe.origin_offset]. </description> </method> <method name="reflection_probe_set_resolution"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="resolution" type="int" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="resolution" type="int" /> <description> </description> </method> <method name="reflection_probe_set_update_mode"> <return type="void" /> - <argument index="0" name="probe" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeUpdateMode" /> + <param index="0" name="probe" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeUpdateMode" /> <description> Sets how often the reflection probe updates. Can either be once or every frame. See [enum ReflectionProbeUpdateMode] for options. </description> </method> <method name="request_frame_drawn_callback"> <return type="void" /> - <argument index="0" name="callable" type="Callable" /> + <param index="0" name="callable" type="Callable" /> <description> Schedules a callback to the given callable after a frame has been drawn. </description> @@ -2657,55 +2657,55 @@ </method> <method name="scenario_set_camera_effects"> <return type="void" /> - <argument index="0" name="scenario" type="RID" /> - <argument index="1" name="effects" type="RID" /> + <param index="0" name="scenario" type="RID" /> + <param index="1" name="effects" type="RID" /> <description> </description> </method> <method name="scenario_set_environment"> <return type="void" /> - <argument index="0" name="scenario" type="RID" /> - <argument index="1" name="environment" type="RID" /> + <param index="0" name="scenario" type="RID" /> + <param index="1" name="environment" type="RID" /> <description> Sets the environment that will be used with this scenario. </description> </method> <method name="scenario_set_fallback_environment"> <return type="void" /> - <argument index="0" name="scenario" type="RID" /> - <argument index="1" name="environment" type="RID" /> + <param index="0" name="scenario" type="RID" /> + <param index="1" name="environment" type="RID" /> <description> Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment. </description> </method> <method name="screen_space_roughness_limiter_set_active"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> - <argument index="1" name="amount" type="float" /> - <argument index="2" name="limit" type="float" /> + <param index="0" name="enable" type="bool" /> + <param index="1" name="amount" type="float" /> + <param index="2" name="limit" type="float" /> <description> </description> </method> <method name="set_boot_image"> <return type="void" /> - <argument index="0" name="image" type="Image" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="scale" type="bool" /> - <argument index="3" name="use_filter" type="bool" default="true" /> + <param index="0" name="image" type="Image" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="scale" type="bool" /> + <param index="3" name="use_filter" type="bool" default="true" /> <description> Sets a boot image. The color defines the background color. If [code]scale[/code] is [code]true[/code], the image will be scaled to fit the screen size. If [code]use_filter[/code] is [code]true[/code], the image will be scaled with linear interpolation. If [code]use_filter[/code] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation. </description> </method> <method name="set_debug_generate_wireframes"> <return type="void" /> - <argument index="0" name="generate" type="bool" /> + <param index="0" name="generate" type="bool" /> <description> If [code]true[/code], the engine will generate wireframes for use with the wireframe debug mode. </description> </method> <method name="set_default_clear_color"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Sets the default clear color which is used when a specific clear color has not been selected. </description> @@ -2719,16 +2719,16 @@ </method> <method name="shader_get_code" qualifiers="const"> <return type="String" /> - <argument index="0" name="shader" type="RID" /> + <param index="0" name="shader" type="RID" /> <description> Returns a shader's code. </description> </method> <method name="shader_get_default_texture_param" qualifiers="const"> <return type="RID" /> - <argument index="0" name="shader" type="RID" /> - <argument index="1" name="param" type="StringName" /> - <argument index="2" name="index" type="int" default="0" /> + <param index="0" name="shader" type="RID" /> + <param index="1" name="param" type="StringName" /> + <param index="2" name="index" type="int" default="0" /> <description> Returns a default texture from a shader searched by name. [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture. @@ -2736,31 +2736,31 @@ </method> <method name="shader_get_param_default" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="shader" type="RID" /> - <argument index="1" name="param" type="StringName" /> + <param index="0" name="shader" type="RID" /> + <param index="1" name="param" type="StringName" /> <description> </description> </method> <method name="shader_get_shader_uniform_list" qualifiers="const"> <return type="Dictionary[]" /> - <argument index="0" name="shader" type="RID" /> + <param index="0" name="shader" type="RID" /> <description> Returns the parameters of a shader. </description> </method> <method name="shader_set_code"> <return type="void" /> - <argument index="0" name="shader" type="RID" /> - <argument index="1" name="code" type="String" /> + <param index="0" name="shader" type="RID" /> + <param index="1" name="code" type="String" /> <description> </description> </method> <method name="shader_set_default_texture_param"> <return type="void" /> - <argument index="0" name="shader" type="RID" /> - <argument index="1" name="param" type="StringName" /> - <argument index="2" name="texture" type="RID" /> - <argument index="3" name="index" type="int" default="0" /> + <param index="0" name="shader" type="RID" /> + <param index="1" name="param" type="StringName" /> + <param index="2" name="texture" type="RID" /> + <param index="3" name="index" type="int" default="0" /> <description> Sets a shader's default texture. Overwrites the texture given by name. [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture. @@ -2768,49 +2768,49 @@ </method> <method name="shader_set_path_hint"> <return type="void" /> - <argument index="0" name="shader" type="RID" /> - <argument index="1" name="path" type="String" /> + <param index="0" name="shader" type="RID" /> + <param index="1" name="path" type="String" /> <description> </description> </method> <method name="skeleton_allocate_data"> <return type="void" /> - <argument index="0" name="skeleton" type="RID" /> - <argument index="1" name="bones" type="int" /> - <argument index="2" name="is_2d_skeleton" type="bool" default="false" /> + <param index="0" name="skeleton" type="RID" /> + <param index="1" name="bones" type="int" /> + <param index="2" name="is_2d_skeleton" type="bool" default="false" /> <description> </description> </method> <method name="skeleton_bone_get_transform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="skeleton" type="RID" /> - <argument index="1" name="bone" type="int" /> + <param index="0" name="skeleton" type="RID" /> + <param index="1" name="bone" type="int" /> <description> Returns the [Transform3D] set for a specific bone of this skeleton. </description> </method> <method name="skeleton_bone_get_transform_2d" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="skeleton" type="RID" /> - <argument index="1" name="bone" type="int" /> + <param index="0" name="skeleton" type="RID" /> + <param index="1" name="bone" type="int" /> <description> Returns the [Transform2D] set for a specific bone of this skeleton. </description> </method> <method name="skeleton_bone_set_transform"> <return type="void" /> - <argument index="0" name="skeleton" type="RID" /> - <argument index="1" name="bone" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="skeleton" type="RID" /> + <param index="1" name="bone" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> Sets the [Transform3D] for a specific bone of this skeleton. </description> </method> <method name="skeleton_bone_set_transform_2d"> <return type="void" /> - <argument index="0" name="skeleton" type="RID" /> - <argument index="1" name="bone" type="int" /> - <argument index="2" name="transform" type="Transform2D" /> + <param index="0" name="skeleton" type="RID" /> + <param index="1" name="bone" type="int" /> + <param index="2" name="transform" type="Transform2D" /> <description> Sets the [Transform2D] for a specific bone of this skeleton. </description> @@ -2824,24 +2824,24 @@ </method> <method name="skeleton_get_bone_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="skeleton" type="RID" /> + <param index="0" name="skeleton" type="RID" /> <description> Returns the number of bones allocated for this skeleton. </description> </method> <method name="skeleton_set_base_transform_2d"> <return type="void" /> - <argument index="0" name="skeleton" type="RID" /> - <argument index="1" name="base_transform" type="Transform2D" /> + <param index="0" name="skeleton" type="RID" /> + <param index="1" name="base_transform" type="Transform2D" /> <description> </description> </method> <method name="sky_bake_panorama"> <return type="Image" /> - <argument index="0" name="sky" type="RID" /> - <argument index="1" name="energy" type="float" /> - <argument index="2" name="bake_irradiance" type="bool" /> - <argument index="3" name="size" type="Vector2i" /> + <param index="0" name="sky" type="RID" /> + <param index="1" name="energy" type="float" /> + <param index="2" name="bake_irradiance" type="bool" /> + <param index="3" name="size" type="Vector2i" /> <description> </description> </method> @@ -2854,23 +2854,23 @@ </method> <method name="sky_set_material"> <return type="void" /> - <argument index="0" name="sky" type="RID" /> - <argument index="1" name="material" type="RID" /> + <param index="0" name="sky" type="RID" /> + <param index="1" name="material" type="RID" /> <description> Sets the material that the sky uses to render the background and reflection maps. </description> </method> <method name="sky_set_mode"> <return type="void" /> - <argument index="0" name="sky" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.SkyMode" /> + <param index="0" name="sky" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.SkyMode" /> <description> </description> </method> <method name="sky_set_radiance_size"> <return type="void" /> - <argument index="0" name="sky" type="RID" /> - <argument index="1" name="radiance_size" type="int" /> + <param index="0" name="sky" type="RID" /> + <param index="1" name="radiance_size" type="int" /> <description> </description> </method> @@ -2884,46 +2884,46 @@ </method> <method name="sub_surface_scattering_set_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.SubSurfaceScatteringQuality" /> + <param index="0" name="quality" type="int" enum="RenderingServer.SubSurfaceScatteringQuality" /> <description> </description> </method> <method name="sub_surface_scattering_set_scale"> <return type="void" /> - <argument index="0" name="scale" type="float" /> - <argument index="1" name="depth_scale" type="float" /> + <param index="0" name="scale" type="float" /> + <param index="1" name="depth_scale" type="float" /> <description> </description> </method> <method name="texture_2d_create"> <return type="RID" /> - <argument index="0" name="image" type="Image" /> + <param index="0" name="image" type="Image" /> <description> </description> </method> <method name="texture_2d_get" qualifiers="const"> <return type="Image" /> - <argument index="0" name="texture" type="RID" /> + <param index="0" name="texture" type="RID" /> <description> </description> </method> <method name="texture_2d_layer_get" qualifiers="const"> <return type="Image" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="layer" type="int" /> <description> </description> </method> <method name="texture_2d_layered_create"> <return type="RID" /> - <argument index="0" name="layers" type="Image[]" /> - <argument index="1" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" /> + <param index="0" name="layers" type="Image[]" /> + <param index="1" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" /> <description> </description> </method> <method name="texture_2d_layered_placeholder_create"> <return type="RID" /> - <argument index="0" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" /> + <param index="0" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" /> <description> </description> </method> @@ -2934,26 +2934,26 @@ </method> <method name="texture_2d_update"> <return type="void" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="image" type="Image" /> - <argument index="2" name="layer" type="int" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="image" type="Image" /> + <param index="2" name="layer" type="int" /> <description> </description> </method> <method name="texture_3d_create"> <return type="RID" /> - <argument index="0" name="format" type="int" enum="Image.Format" /> - <argument index="1" name="width" type="int" /> - <argument index="2" name="height" type="int" /> - <argument index="3" name="depth" type="int" /> - <argument index="4" name="mipmaps" type="bool" /> - <argument index="5" name="data" type="Image[]" /> + <param index="0" name="format" type="int" enum="Image.Format" /> + <param index="1" name="width" type="int" /> + <param index="2" name="height" type="int" /> + <param index="3" name="depth" type="int" /> + <param index="4" name="mipmaps" type="bool" /> + <param index="5" name="data" type="Image[]" /> <description> </description> </method> <method name="texture_3d_get" qualifiers="const"> <return type="Image[]" /> - <argument index="0" name="texture" type="RID" /> + <param index="0" name="texture" type="RID" /> <description> </description> </method> @@ -2964,80 +2964,80 @@ </method> <method name="texture_3d_update"> <return type="void" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="data" type="Image[]" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="data" type="Image[]" /> <description> </description> </method> <method name="texture_get_path" qualifiers="const"> <return type="String" /> - <argument index="0" name="texture" type="RID" /> + <param index="0" name="texture" type="RID" /> <description> </description> </method> <method name="texture_proxy_create"> <return type="RID" /> - <argument index="0" name="base" type="RID" /> + <param index="0" name="base" type="RID" /> <description> </description> </method> <method name="texture_proxy_update"> <return type="void" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="proxy_to" type="RID" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="proxy_to" type="RID" /> <description> </description> </method> <method name="texture_replace"> <return type="void" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="by_texture" type="RID" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="by_texture" type="RID" /> <description> </description> </method> <method name="texture_set_force_redraw_if_visible"> <return type="void" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="texture_set_path"> <return type="void" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="path" type="String" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="path" type="String" /> <description> </description> </method> <method name="texture_set_size_override"> <return type="void" /> - <argument index="0" name="texture" type="RID" /> - <argument index="1" name="width" type="int" /> - <argument index="2" name="height" type="int" /> + <param index="0" name="texture" type="RID" /> + <param index="1" name="width" type="int" /> + <param index="2" name="height" type="int" /> <description> </description> </method> <method name="viewport_attach_camera"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="camera" type="RID" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="camera" type="RID" /> <description> Sets a viewport's camera. </description> </method> <method name="viewport_attach_canvas"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="canvas" type="RID" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="canvas" type="RID" /> <description> Sets a viewport's canvas. </description> </method> <method name="viewport_attach_to_screen"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" /> - <argument index="2" name="screen" type="int" default="0" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="2" name="screen" type="int" default="0" /> <description> Copies the viewport to a region of the screen specified by [code]rect[/code]. If [method viewport_set_render_direct_to_screen] is [code]true[/code], then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. For example, you can set the root viewport to not render at all with the following code: @@ -3061,53 +3061,53 @@ </method> <method name="viewport_get_measured_render_time_cpu" qualifiers="const"> <return type="float" /> - <argument index="0" name="viewport" type="RID" /> + <param index="0" name="viewport" type="RID" /> <description> </description> </method> <method name="viewport_get_measured_render_time_gpu" qualifiers="const"> <return type="float" /> - <argument index="0" name="viewport" type="RID" /> + <param index="0" name="viewport" type="RID" /> <description> </description> </method> <method name="viewport_get_render_info"> <return type="int" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="type" type="int" enum="RenderingServer.ViewportRenderInfoType" /> - <argument index="2" name="info" type="int" enum="RenderingServer.ViewportRenderInfo" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="type" type="int" enum="RenderingServer.ViewportRenderInfoType" /> + <param index="2" name="info" type="int" enum="RenderingServer.ViewportRenderInfo" /> <description> </description> </method> <method name="viewport_get_texture" qualifiers="const"> <return type="RID" /> - <argument index="0" name="viewport" type="RID" /> + <param index="0" name="viewport" type="RID" /> <description> Returns the viewport's last rendered frame. </description> </method> <method name="viewport_remove_canvas"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="canvas" type="RID" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="canvas" type="RID" /> <description> Detaches a viewport from a canvas and vice versa. </description> </method> <method name="viewport_set_active"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="active" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="active" type="bool" /> <description> If [code]true[/code], sets the viewport active, else sets it inactive. </description> </method> <method name="viewport_set_canvas_stacking"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="layer" type="int" /> - <argument index="3" name="sublayer" type="int" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="layer" type="int" /> + <param index="3" name="sublayer" type="int" /> <description> Sets the stacking order for a viewport's canvas. [code]layer[/code] is the actual canvas layer, while [code]sublayer[/code] specifies the stacking order of the canvas among those in the same layer. @@ -3115,131 +3115,131 @@ </method> <method name="viewport_set_canvas_transform"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="offset" type="Transform2D" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="offset" type="Transform2D" /> <description> Sets the transformation of a viewport's canvas. </description> </method> <method name="viewport_set_clear_mode"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="clear_mode" type="int" enum="RenderingServer.ViewportClearMode" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="clear_mode" type="int" enum="RenderingServer.ViewportClearMode" /> <description> Sets the clear mode of a viewport. See [enum ViewportClearMode] for options. </description> </method> <method name="viewport_set_debug_draw"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="draw" type="int" enum="RenderingServer.ViewportDebugDraw" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="draw" type="int" enum="RenderingServer.ViewportDebugDraw" /> <description> Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options. </description> </method> <method name="viewport_set_default_canvas_item_texture_filter"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" /> <description> </description> </method> <method name="viewport_set_default_canvas_item_texture_repeat"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" /> <description> </description> </method> <method name="viewport_set_disable_2d"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="disable" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="disable" type="bool" /> <description> If [code]true[/code], the viewport's canvas is not rendered. </description> </method> <method name="viewport_set_disable_3d"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="disable" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="disable" type="bool" /> <description> </description> </method> <method name="viewport_set_disable_environment"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="disabled" type="bool" /> <description> If [code]true[/code], rendering of a viewport's environment is disabled. </description> </method> <method name="viewport_set_fsr_sharpness"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="sharpness" type="float" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="sharpness" type="float" /> <description> Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. </description> </method> <method name="viewport_set_global_canvas_transform"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets the viewport's global transformation matrix. </description> </method> <method name="viewport_set_measure_render_time"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="viewport_set_msaa"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" /> <description> Sets the anti-aliasing mode. See [enum ViewportMSAA] for options. </description> </method> <method name="viewport_set_occlusion_culling_build_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.ViewportOcclusionCullingBuildQuality" /> + <param index="0" name="quality" type="int" enum="RenderingServer.ViewportOcclusionCullingBuildQuality" /> <description> </description> </method> <method name="viewport_set_occlusion_rays_per_thread"> <return type="void" /> - <argument index="0" name="rays_per_thread" type="int" /> + <param index="0" name="rays_per_thread" type="int" /> <description> </description> </method> <method name="viewport_set_parent_viewport"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="parent_viewport" type="RID" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="parent_viewport" type="RID" /> <description> Sets the viewport's parent to another viewport. </description> </method> <method name="viewport_set_positional_shadow_atlas_quadrant_subdivision"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="quadrant" type="int" /> - <argument index="2" name="subdivision" type="int" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="quadrant" type="int" /> + <param index="2" name="subdivision" type="int" /> <description> Sets the shadow atlas quadrant's subdivision. </description> </method> <method name="viewport_set_positional_shadow_atlas_size"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="use_16_bits" type="bool" default="false" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="use_16_bits" type="bool" default="false" /> <description> Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2. [b]Note:[/b] If this is set to [code]0[/code], no shadows will be visible at all (including directional shadows). @@ -3247,24 +3247,24 @@ </method> <method name="viewport_set_render_direct_to_screen"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If [code]true[/code], render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the [code]SCREEN_TEXTURE[/code]. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size. </description> </method> <method name="viewport_set_scaling_3d_mode"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="scaling_3d_mode" type="int" enum="RenderingServer.ViewportScaling3DMode" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="scaling_3d_mode" type="int" enum="RenderingServer.ViewportScaling3DMode" /> <description> Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible. </description> </method> <method name="viewport_set_scaling_3d_scale"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="scale" type="float" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="scale" type="float" /> <description> Scales the 3D render buffer based on the viewport size uses an image filter specified in [enum ViewportScaling3DMode] to scale the output image to the full viewport size. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [enum ViewportMSAA] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. When using FSR upscaling, AMD recommends exposing the following values as preset options to users "Ultra Quality: 0.77", "Quality: 0.67", "Balanced: 0.59", "Performance: 0.5" instead of exposing the entire scale. @@ -3272,8 +3272,8 @@ </method> <method name="viewport_set_scenario"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="scenario" type="RID" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="scenario" type="RID" /> <description> Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas etc. @@ -3281,46 +3281,46 @@ </method> <method name="viewport_set_screen_space_aa"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.ViewportScreenSpaceAA" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.ViewportScreenSpaceAA" /> <description> </description> </method> <method name="viewport_set_sdf_oversize_and_scale"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="oversize" type="int" enum="RenderingServer.ViewportSDFOversize" /> - <argument index="2" name="scale" type="int" enum="RenderingServer.ViewportSDFScale" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="oversize" type="int" enum="RenderingServer.ViewportSDFOversize" /> + <param index="2" name="scale" type="int" enum="RenderingServer.ViewportSDFScale" /> <description> </description> </method> <method name="viewport_set_size"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="width" type="int" /> - <argument index="2" name="height" type="int" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="width" type="int" /> + <param index="2" name="height" type="int" /> <description> Sets the viewport's width and height. </description> </method> <method name="viewport_set_snap_2d_transforms_to_pixel"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> </description> </method> <method name="viewport_set_snap_2d_vertices_to_pixel"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> </description> </method> <method name="viewport_set_texture_mipmap_bias"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="mipmap_bias" type="float" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="mipmap_bias" type="float" /> <description> Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). To get sharper textures at a distance without introducing too much graininess, set this between [code]-0.75[/code] and [code]0.0[/code]. Enabling temporal antialiasing ([member ProjectSettings.rendering/anti_aliasing/quality/use_taa]) can help reduce the graininess visible when using negative mipmap bias. [b]Note:[/b] When the 3D scaling mode is set to FSR 1.0, this value is used to adjust the automatic mipmap bias which is calculated internally based on the scale factor. The formula for this is [code]-log2(1.0 / scale) + mipmap_bias[/code]. @@ -3328,62 +3328,62 @@ </method> <method name="viewport_set_transparent_background"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If [code]true[/code], the viewport renders its background as transparent. </description> </method> <method name="viewport_set_update_mode"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="update_mode" type="int" enum="RenderingServer.ViewportUpdateMode" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="update_mode" type="int" enum="RenderingServer.ViewportUpdateMode" /> <description> Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options. </description> </method> <method name="viewport_set_use_debanding"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="viewport_set_use_occlusion_culling"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="viewport_set_use_taa"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], use Temporal Anti-Aliasing. </description> </method> <method name="viewport_set_use_xr"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="use_xr" type="bool" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="use_xr" type="bool" /> <description> If [code]true[/code], the viewport uses augmented or virtual reality technologies. See [XRInterface]. </description> </method> <method name="viewport_set_vrs_mode"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="mode" type="int" enum="RenderingServer.ViewportVRSMode" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="mode" type="int" enum="RenderingServer.ViewportVRSMode" /> <description> Sets the Variable Rate Shading (VRS) mode for the viewport. Note, if hardware does not support VRS this property is ignored. </description> </method> <method name="viewport_set_vrs_texture"> <return type="void" /> - <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="texture" type="RID" /> + <param index="0" name="viewport" type="RID" /> + <param index="1" name="texture" type="RID" /> <description> Texture to use when the VRS mode is set to [constant RenderingServer.VIEWPORT_VRS_TEXTURE]. </description> @@ -3395,29 +3395,29 @@ </method> <method name="visibility_notifier_set_aabb"> <return type="void" /> - <argument index="0" name="notifier" type="RID" /> - <argument index="1" name="aabb" type="AABB" /> + <param index="0" name="notifier" type="RID" /> + <param index="1" name="aabb" type="AABB" /> <description> </description> </method> <method name="visibility_notifier_set_callbacks"> <return type="void" /> - <argument index="0" name="notifier" type="RID" /> - <argument index="1" name="enter_callable" type="Callable" /> - <argument index="2" name="exit_callable" type="Callable" /> + <param index="0" name="notifier" type="RID" /> + <param index="1" name="enter_callable" type="Callable" /> + <param index="2" name="exit_callable" type="Callable" /> <description> </description> </method> <method name="voxel_gi_allocate_data"> <return type="void" /> - <argument index="0" name="voxel_gi" type="RID" /> - <argument index="1" name="to_cell_xform" type="Transform3D" /> - <argument index="2" name="aabb" type="AABB" /> - <argument index="3" name="octree_size" type="Vector3i" /> - <argument index="4" name="octree_cells" type="PackedByteArray" /> - <argument index="5" name="data_cells" type="PackedByteArray" /> - <argument index="6" name="distance_field" type="PackedByteArray" /> - <argument index="7" name="level_counts" type="PackedInt32Array" /> + <param index="0" name="voxel_gi" type="RID" /> + <param index="1" name="to_cell_xform" type="Transform3D" /> + <param index="2" name="aabb" type="AABB" /> + <param index="3" name="octree_size" type="Vector3i" /> + <param index="4" name="octree_cells" type="PackedByteArray" /> + <param index="5" name="data_cells" type="PackedByteArray" /> + <param index="6" name="distance_field" type="PackedByteArray" /> + <param index="7" name="level_counts" type="PackedInt32Array" /> <description> </description> </method> @@ -3428,92 +3428,92 @@ </method> <method name="voxel_gi_get_data_cells" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="voxel_gi" type="RID" /> + <param index="0" name="voxel_gi" type="RID" /> <description> </description> </method> <method name="voxel_gi_get_distance_field" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="voxel_gi" type="RID" /> + <param index="0" name="voxel_gi" type="RID" /> <description> </description> </method> <method name="voxel_gi_get_level_counts" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="voxel_gi" type="RID" /> + <param index="0" name="voxel_gi" type="RID" /> <description> </description> </method> <method name="voxel_gi_get_octree_cells" qualifiers="const"> <return type="PackedByteArray" /> - <argument index="0" name="voxel_gi" type="RID" /> + <param index="0" name="voxel_gi" type="RID" /> <description> </description> </method> <method name="voxel_gi_get_octree_size" qualifiers="const"> <return type="Vector3i" /> - <argument index="0" name="voxel_gi" type="RID" /> + <param index="0" name="voxel_gi" type="RID" /> <description> </description> </method> <method name="voxel_gi_get_to_cell_xform" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="voxel_gi" type="RID" /> + <param index="0" name="voxel_gi" type="RID" /> <description> </description> </method> <method name="voxel_gi_set_bias"> <return type="void" /> - <argument index="0" name="voxel_gi" type="RID" /> - <argument index="1" name="bias" type="float" /> + <param index="0" name="voxel_gi" type="RID" /> + <param index="1" name="bias" type="float" /> <description> </description> </method> <method name="voxel_gi_set_dynamic_range"> <return type="void" /> - <argument index="0" name="voxel_gi" type="RID" /> - <argument index="1" name="range" type="float" /> + <param index="0" name="voxel_gi" type="RID" /> + <param index="1" name="range" type="float" /> <description> </description> </method> <method name="voxel_gi_set_energy"> <return type="void" /> - <argument index="0" name="voxel_gi" type="RID" /> - <argument index="1" name="energy" type="float" /> + <param index="0" name="voxel_gi" type="RID" /> + <param index="1" name="energy" type="float" /> <description> </description> </method> <method name="voxel_gi_set_interior"> <return type="void" /> - <argument index="0" name="voxel_gi" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="voxel_gi" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="voxel_gi_set_normal_bias"> <return type="void" /> - <argument index="0" name="voxel_gi" type="RID" /> - <argument index="1" name="bias" type="float" /> + <param index="0" name="voxel_gi" type="RID" /> + <param index="1" name="bias" type="float" /> <description> </description> </method> <method name="voxel_gi_set_propagation"> <return type="void" /> - <argument index="0" name="voxel_gi" type="RID" /> - <argument index="1" name="amount" type="float" /> + <param index="0" name="voxel_gi" type="RID" /> + <param index="1" name="amount" type="float" /> <description> </description> </method> <method name="voxel_gi_set_quality"> <return type="void" /> - <argument index="0" name="quality" type="int" enum="RenderingServer.VoxelGIQuality" /> + <param index="0" name="quality" type="int" enum="RenderingServer.VoxelGIQuality" /> <description> </description> </method> <method name="voxel_gi_set_use_two_bounces"> <return type="void" /> - <argument index="0" name="voxel_gi" type="RID" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="voxel_gi" type="RID" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index b08b1540ab..b5a2179463 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -19,7 +19,7 @@ </method> <method name="duplicate" qualifiers="const"> <return type="Resource" /> - <argument index="0" name="subresources" type="bool" default="false" /> + <param index="0" name="subresources" type="bool" default="false" /> <description> Duplicates the resource, returning a new resource with the exported members copied. [b]Note:[/b] To duplicate the resource the constructor is called without arguments. This method will error when the constructor doesn't have default values. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources. @@ -60,7 +60,7 @@ </method> <method name="take_over_path"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path. </description> diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index fef94b5f3b..cfa1b9f5d7 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -13,20 +13,20 @@ <methods> <method name="_exists" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> <method name="_get_classes_used" qualifiers="virtual const"> <return type="PackedStringArray" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> <method name="_get_dependencies" qualifiers="virtual const"> <return type="PackedStringArray" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="add_types" type="bool" /> + <param index="0" name="path" type="String" /> + <param index="1" name="add_types" type="bool" /> <description> If implemented, gets the dependencies of a given resource. If [code]add_types[/code] is [code]true[/code], paths should be appended [code]::TypeName[/code], where [code]TypeName[/code] is the class name of the dependency. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. @@ -40,7 +40,7 @@ </method> <method name="_get_resource_type" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return [code]""[/code]. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. @@ -48,13 +48,13 @@ </method> <method name="_get_resource_uid" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> <method name="_handles_type" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="type" type="StringName" /> + <param index="0" name="type" type="StringName" /> <description> Tells which resource class this loader can load. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them. @@ -62,10 +62,10 @@ </method> <method name="_load" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="original_path" type="String" /> - <argument index="2" name="use_sub_threads" type="bool" /> - <argument index="3" name="cache_mode" type="int" /> + <param index="0" name="path" type="String" /> + <param index="1" name="original_path" type="String" /> + <param index="2" name="use_sub_threads" type="bool" /> + <param index="3" name="cache_mode" type="int" /> <description> Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, [code]original_path[/code] will target the source file. Returns a [Resource] object on success, or an [enum Error] constant in case of failure. The [code]cache_mode[/code] property defines whether and how the cache should be used or updated when loading the resource. See [enum CacheMode] for details. @@ -73,8 +73,8 @@ </method> <method name="_rename_dependencies" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="renames" type="Dictionary" /> + <param index="0" name="path" type="String" /> + <param index="1" name="renames" type="Dictionary" /> <description> If implemented, renames dependencies within the given resource and saves it. [code]renames[/code] is a dictionary [code]{ String => String }[/code] mapping old dependency paths to new paths. Returns [constant OK] on success, or an [enum Error] constant in case of failure. diff --git a/doc/classes/ResourceFormatSaver.xml b/doc/classes/ResourceFormatSaver.xml index f9c4ca0d49..93f3a732bc 100644 --- a/doc/classes/ResourceFormatSaver.xml +++ b/doc/classes/ResourceFormatSaver.xml @@ -12,23 +12,23 @@ <methods> <method name="_get_recognized_extensions" qualifiers="virtual const"> <return type="PackedStringArray" /> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> Returns the list of extensions available for saving the resource object, provided it is recognized (see [method _recognize]). </description> </method> <method name="_recognize" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> Returns whether the given resource object can be saved by this saver. </description> </method> <method name="_save" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="path" type="Resource" /> - <argument index="1" name="resource" type="String" /> - <argument index="2" name="flags" type="int" /> + <param index="0" name="path" type="Resource" /> + <param index="1" name="resource" type="String" /> + <param index="2" name="flags" type="int" /> <description> Saves the given resource object to a file at the target [code]path[/code]. [code]flags[/code] is a bitmask composed with [enum ResourceSaver.SaverFlags] constants. Returns [constant OK] on success, or an [enum Error] constant in case of failure. diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 729058c9b3..1632be7e88 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -14,8 +14,8 @@ <methods> <method name="add_resource_format_loader"> <return type="void" /> - <argument index="0" name="format_loader" type="ResourceFormatLoader" /> - <argument index="1" name="at_front" type="bool" default="false" /> + <param index="0" name="format_loader" type="ResourceFormatLoader" /> + <param index="1" name="at_front" type="bool" default="false" /> <description> Registers a new [ResourceFormatLoader]. The ResourceLoader will use the ResourceFormatLoader as described in [method load]. This method is performed implicitly for ResourceFormatLoaders written in GDScript (see [ResourceFormatLoader] for more information). @@ -23,8 +23,8 @@ </method> <method name="exists"> <return type="bool" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="type_hint" type="String" default="""" /> + <param index="0" name="path" type="String" /> + <param index="1" name="type_hint" type="String" default="""" /> <description> Returns whether a recognized resource exists for the given [code]path[/code]. An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. Anything that inherits from [Resource] can be used as a type hint, for example [Image]. @@ -32,28 +32,28 @@ </method> <method name="get_dependencies"> <return type="PackedStringArray" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns the dependencies for the resource at the given [code]path[/code]. </description> </method> <method name="get_recognized_extensions_for_type"> <return type="PackedStringArray" /> - <argument index="0" name="type" type="String" /> + <param index="0" name="type" type="String" /> <description> Returns the list of recognized extensions for a resource type. </description> </method> <method name="get_resource_uid"> <return type="int" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns the ID associated with a given resource path, or [code]-1[/code] when no such ID exists. </description> </method> <method name="has_cached"> <return type="bool" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns whether a cached resource is available for the given [code]path[/code]. Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the [method load] method will use the cached version. The cached resource can be overridden by using [method Resource.take_over_path] on a new resource for that same path. @@ -61,9 +61,9 @@ </method> <method name="load"> <return type="Resource" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="type_hint" type="String" default="""" /> - <argument index="2" name="cache_mode" type="int" enum="ResourceLoader.CacheMode" default="1" /> + <param index="0" name="path" type="String" /> + <param index="1" name="type_hint" type="String" default="""" /> + <param index="2" name="cache_mode" type="int" enum="ResourceLoader.CacheMode" default="1" /> <description> Loads a resource at the given [code]path[/code], caching the result for further access. The registered [ResourceFormatLoader]s are queried sequentially to find the first one which can handle the file's extension, and then attempt loading. If loading fails, the remaining ResourceFormatLoaders are also attempted. @@ -75,7 +75,7 @@ </method> <method name="load_threaded_get"> <return type="Resource" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns the resource loaded by [method load_threaded_request]. If this is called before the loading thread is done (i.e. [method load_threaded_get_status] is not [constant THREAD_LOAD_LOADED]), the calling thread will be blocked until the resource has finished loading. @@ -83,8 +83,8 @@ </method> <method name="load_threaded_get_status"> <return type="int" enum="ResourceLoader.ThreadLoadStatus" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="progress" type="Array" default="[]" /> + <param index="0" name="path" type="String" /> + <param index="1" name="progress" type="Array" default="[]" /> <description> Returns the status of a threaded loading operation started with [method load_threaded_request] for the resource at [code]path[/code]. See [enum ThreadLoadStatus] for possible return values. An array variable can optionally be passed via [code]progress[/code], and will return a one-element array containing the percentage of completion of the threaded loading. @@ -92,10 +92,10 @@ </method> <method name="load_threaded_request"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="type_hint" type="String" default="""" /> - <argument index="2" name="use_sub_threads" type="bool" default="false" /> - <argument index="3" name="cache_mode" type="int" enum="ResourceLoader.CacheMode" default="1" /> + <param index="0" name="path" type="String" /> + <param index="1" name="type_hint" type="String" default="""" /> + <param index="2" name="use_sub_threads" type="bool" default="false" /> + <param index="3" name="cache_mode" type="int" enum="ResourceLoader.CacheMode" default="1" /> <description> Loads the resource using threads. If [code]use_sub_threads[/code] is [code]true[/code], multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns). The [code]cache_mode[/code] property defines whether and how the cache should be used or updated when loading the resource. See [enum CacheMode] for details. @@ -103,14 +103,14 @@ </method> <method name="remove_resource_format_loader"> <return type="void" /> - <argument index="0" name="format_loader" type="ResourceFormatLoader" /> + <param index="0" name="format_loader" type="ResourceFormatLoader" /> <description> Unregisters the given [ResourceFormatLoader]. </description> </method> <method name="set_abort_on_missing_resources"> <return type="void" /> - <argument index="0" name="abort" type="bool" /> + <param index="0" name="abort" type="bool" /> <description> Changes the behavior on missing sub-resources. The default behavior is to abort loading. </description> diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index 63db131cec..e52434c2a4 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -12,15 +12,15 @@ <methods> <method name="add_resource"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="resource" type="Resource" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="resource" type="Resource" /> <description> Adds a resource to the preloader with the given [code]name[/code]. If a resource with the given [code]name[/code] already exists, the new resource will be renamed to "[code]name[/code] N" where N is an incrementing number starting from 2. </description> </method> <method name="get_resource" qualifiers="const"> <return type="Resource" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the resource associated to [code]name[/code]. </description> @@ -33,22 +33,22 @@ </method> <method name="has_resource" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the preloader contains a resource associated to [code]name[/code]. </description> </method> <method name="remove_resource"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Removes the resource associated to [code]name[/code] from the preloader. </description> </method> <method name="rename_resource"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="newname" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="newname" type="StringName" /> <description> Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code]. </description> diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 10387a4f14..4c1fad22de 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -12,8 +12,8 @@ <methods> <method name="add_resource_format_saver"> <return type="void" /> - <argument index="0" name="format_saver" type="ResourceFormatSaver" /> - <argument index="1" name="at_front" type="bool" default="false" /> + <param index="0" name="format_saver" type="ResourceFormatSaver" /> + <param index="1" name="at_front" type="bool" default="false" /> <description> Registers a new [ResourceFormatSaver]. The ResourceSaver will use the ResourceFormatSaver as described in [method save]. This method is performed implicitly for ResourceFormatSavers written in GDScript (see [ResourceFormatSaver] for more information). @@ -21,23 +21,23 @@ </method> <method name="get_recognized_extensions"> <return type="PackedStringArray" /> - <argument index="0" name="type" type="Resource" /> + <param index="0" name="type" type="Resource" /> <description> Returns the list of extensions available for saving a resource of a given type. </description> </method> <method name="remove_resource_format_saver"> <return type="void" /> - <argument index="0" name="format_saver" type="ResourceFormatSaver" /> + <param index="0" name="format_saver" type="ResourceFormatSaver" /> <description> Unregisters the given [ResourceFormatSaver]. </description> </method> <method name="save"> <return type="int" enum="Error" /> - <argument index="0" name="resource" type="Resource" /> - <argument index="1" name="path" type="String" default="""" /> - <argument index="2" name="flags" type="int" enum="ResourceSaver.SaverFlags" default="0" /> + <param index="0" name="resource" type="Resource" /> + <param index="1" name="path" type="String" default="""" /> + <param index="2" name="flags" type="int" enum="ResourceSaver.SaverFlags" default="0" /> <description> Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object. If [code]path[/code] is empty, [ResourceSaver] will try to use [member Resource.resource_path]. The [code]flags[/code] bitmask can be specified to customize the save behavior using [enum SaverFlags] flags. diff --git a/doc/classes/ResourceUID.xml b/doc/classes/ResourceUID.xml index 782a8a2968..7ac5dd58a8 100644 --- a/doc/classes/ResourceUID.xml +++ b/doc/classes/ResourceUID.xml @@ -13,8 +13,8 @@ <methods> <method name="add_id"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="path" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="path" type="String" /> <description> Adds a new UID value which is mapped to the given resource path. Fails with an error if the UID already exists, so be sure to check [method has_id] beforehand, or use [method set_id] instead. @@ -29,7 +29,7 @@ </method> <method name="get_id_path" qualifiers="const"> <return type="String" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the path that the given UID value refers to. Fails with an error if the UID does not exist, so be sure to check [method has_id] beforehand. @@ -37,21 +37,21 @@ </method> <method name="has_id" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns whether the given UID value is known to the cache. </description> </method> <method name="id_to_text" qualifiers="const"> <return type="String" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Converts the given UID to a [code]uid://[/code] string value. </description> </method> <method name="remove_id"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Removes a loaded UID value from the cache. Fails with an error if the UID does not exist, so be sure to check [method has_id] beforehand. @@ -59,8 +59,8 @@ </method> <method name="set_id"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="path" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="path" type="String" /> <description> Updates the resource path of an existing UID. Fails with an error if the UID does not exist, so be sure to check [method has_id] beforehand, or use [method add_id] instead. @@ -68,7 +68,7 @@ </method> <method name="text_to_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="text_id" type="String" /> + <param index="0" name="text_id" type="String" /> <description> Extracts the UID value from the given [code]uid://[/code] string. </description> diff --git a/doc/classes/RichTextEffect.xml b/doc/classes/RichTextEffect.xml index 2256839378..304950d97c 100644 --- a/doc/classes/RichTextEffect.xml +++ b/doc/classes/RichTextEffect.xml @@ -25,7 +25,7 @@ <methods> <method name="_process_custom_fx" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="char_fx" type="CharFXTransform" /> + <param index="0" name="char_fx" type="CharFXTransform" /> <description> Override this method to modify properties in [code]char_fx[/code]. The method must return [code]true[/code] if the character could be transformed successfully. If the method returns [code]false[/code], it will skip transformation to avoid displaying broken text. </description> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 8228bcc442..ef01eba49d 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -18,11 +18,11 @@ <methods> <method name="add_image"> <return type="void" /> - <argument index="0" name="image" type="Texture2D" /> - <argument index="1" name="width" type="int" default="0" /> - <argument index="2" name="height" type="int" default="0" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="0" name="image" type="Texture2D" /> + <param index="1" name="width" type="int" default="0" /> + <param index="2" name="height" type="int" default="0" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="inline_align" type="int" enum="InlineAlignment" default="5" /> <description> Adds an image's opening and closing tags to the tag stack, optionally providing a [code]width[/code] and [code]height[/code] to resize the image and a [code]color[/code] to tint the image. If [code]width[/code] or [code]height[/code] is set to 0, the image size will be adjusted in order to keep the original aspect ratio. @@ -30,14 +30,14 @@ </method> <method name="add_text"> <return type="void" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Adds raw non-BBCode-parsed text to the tag stack. </description> </method> <method name="append_text"> <return type="void" /> - <argument index="0" name="bbcode" type="String" /> + <param index="0" name="bbcode" type="String" /> <description> Parses [code]bbcode[/code] and adds tags to the tag stack as needed. [b]Note:[/b] Using this method, you can't close a tag that was opened in a previous [method append_text] call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the [member text] instead of using [method append_text]. @@ -57,7 +57,7 @@ </method> <method name="get_character_line"> <return type="int" /> - <argument index="0" name="character" type="int" /> + <param index="0" name="character" type="int" /> <description> Returns the line number of the character position provided. [b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded. @@ -65,7 +65,7 @@ </method> <method name="get_character_paragraph"> <return type="int" /> - <argument index="0" name="character" type="int" /> + <param index="0" name="character" type="int" /> <description> Returns the paragraph number of the character position provided. [b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded. @@ -94,7 +94,7 @@ </method> <method name="get_line_offset"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the vertical offset of the line found at the provided index. [b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded. @@ -115,7 +115,7 @@ </method> <method name="get_paragraph_offset"> <return type="float" /> - <argument index="0" name="paragraph" type="int" /> + <param index="0" name="paragraph" type="int" /> <description> Returns the vertical offset of the paragraph found at the provided index. [b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded. @@ -174,7 +174,7 @@ </method> <method name="install_effect"> <return type="void" /> - <argument index="0" name="effect" type="Variant" /> + <param index="0" name="effect" type="Variant" /> <description> Installs a custom effect. [code]effect[/code] should be a valid [RichTextEffect]. </description> @@ -199,14 +199,14 @@ </method> <method name="parse_bbcode"> <return type="void" /> - <argument index="0" name="bbcode" type="String" /> + <param index="0" name="bbcode" type="String" /> <description> The assignment version of [method append_text]. Clears the tag stack and inserts the new content. </description> </method> <method name="parse_expressions_for_values"> <return type="Dictionary" /> - <argument index="0" name="expressions" type="PackedStringArray" /> + <param index="0" name="expressions" type="PackedStringArray" /> <description> Parses BBCode parameter [code]expressions[/code] into a dictionary. </description> @@ -219,7 +219,7 @@ </method> <method name="push_bgcolor"> <return type="void" /> - <argument index="0" name="bgcolor" type="Color" /> + <param index="0" name="bgcolor" type="Color" /> <description> Adds a [code][bgcolor][/code] tag to the tag stack. </description> @@ -244,55 +244,55 @@ </method> <method name="push_color"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Adds a [code][color][/code] tag to the tag stack. </description> </method> <method name="push_dropcap"> <return type="void" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="font" type="Font" /> - <argument index="2" name="size" type="int" /> - <argument index="3" name="dropcap_margins" type="Rect2" default="Rect2(0, 0, 0, 0)" /> - <argument index="4" name="color" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="5" name="outline_size" type="int" default="0" /> - <argument index="6" name="outline_color" type="Color" default="Color(0, 0, 0, 0)" /> + <param index="0" name="string" type="String" /> + <param index="1" name="font" type="Font" /> + <param index="2" name="size" type="int" /> + <param index="3" name="dropcap_margins" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="4" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="5" name="outline_size" type="int" default="0" /> + <param index="6" name="outline_color" type="Color" default="Color(0, 0, 0, 0)" /> <description> Adds a [code][dropcap][/code] tag to the tag stack. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. </description> </method> <method name="push_fgcolor"> <return type="void" /> - <argument index="0" name="fgcolor" type="Color" /> + <param index="0" name="fgcolor" type="Color" /> <description> Adds a [code][fgcolor][/code] tag to the tag stack. </description> </method> <method name="push_font"> <return type="void" /> - <argument index="0" name="font" type="Font" /> - <argument index="1" name="font_size" type="int" /> + <param index="0" name="font" type="Font" /> + <param index="1" name="font_size" type="int" /> <description> Adds a [code][font][/code] tag to the tag stack. Overrides default fonts for its duration. </description> </method> <method name="push_font_size"> <return type="void" /> - <argument index="0" name="font_size" type="int" /> + <param index="0" name="font_size" type="int" /> <description> </description> </method> <method name="push_hint"> <return type="void" /> - <argument index="0" name="description" type="String" /> + <param index="0" name="description" type="String" /> <description> Adds a [code][hint][/code] tag to the tag stack. Same as BBCode [code][hint=something]{text}[/hint][/code]. </description> </method> <method name="push_indent"> <return type="void" /> - <argument index="0" name="level" type="int" /> + <param index="0" name="level" type="int" /> <description> Adds an [code][indent][/code] tag to the tag stack. Multiplies [code]level[/code] by current [member tab_size] to determine new margin length. </description> @@ -305,16 +305,16 @@ </method> <method name="push_list"> <return type="void" /> - <argument index="0" name="level" type="int" /> - <argument index="1" name="type" type="int" enum="RichTextLabel.ListType" /> - <argument index="2" name="capitalize" type="bool" /> + <param index="0" name="level" type="int" /> + <param index="1" name="type" type="int" enum="RichTextLabel.ListType" /> + <param index="2" name="capitalize" type="bool" /> <description> Adds [code][ol][/code] or [code][ul][/code] tag to the tag stack. Multiplies [code]level[/code] by current [member tab_size] to determine new margin length. </description> </method> <method name="push_meta"> <return type="void" /> - <argument index="0" name="data" type="Variant" /> + <param index="0" name="data" type="Variant" /> <description> Adds a [code][meta][/code] tag to the tag stack. Similar to the BBCode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types. </description> @@ -333,24 +333,24 @@ </method> <method name="push_outline_color"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Adds a [code][outline_color][/code] tag to the tag stack. Adds text outline for its duration. </description> </method> <method name="push_outline_size"> <return type="void" /> - <argument index="0" name="outline_size" type="int" /> + <param index="0" name="outline_size" type="int" /> <description> Adds a [code][outline_size][/code] tag to the tag stack. Overrides default text outline size for its duration. </description> </method> <method name="push_paragraph"> <return type="void" /> - <argument index="0" name="alignment" type="int" enum="HorizontalAlignment" /> - <argument index="1" name="base_direction" type="int" enum="Control.TextDirection" default="0" /> - <argument index="2" name="language" type="String" default="""" /> - <argument index="3" name="st_parser" type="int" enum="TextServer.StructuredTextParser" default="0" /> + <param index="0" name="alignment" type="int" enum="HorizontalAlignment" /> + <param index="1" name="base_direction" type="int" enum="Control.TextDirection" default="0" /> + <param index="2" name="language" type="String" default="""" /> + <param index="3" name="st_parser" type="int" enum="TextServer.StructuredTextParser" default="0" /> <description> Adds a [code][p][/code] tag to the tag stack. </description> @@ -363,8 +363,8 @@ </method> <method name="push_table"> <return type="void" /> - <argument index="0" name="columns" type="int" /> - <argument index="1" name="inline_align" type="int" enum="InlineAlignment" default="0" /> + <param index="0" name="columns" type="int" /> + <param index="1" name="inline_align" type="int" enum="InlineAlignment" default="0" /> <description> Adds a [code][table=columns,inline_align][/code] tag to the tag stack. </description> @@ -377,7 +377,7 @@ </method> <method name="remove_line"> <return type="bool" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Removes a line of content from the label. Returns [code]true[/code] if the line exists. The [code]line[/code] argument is the index of the line to remove, it can take values in the interval [code][0, get_line_count() - 1][/code]. @@ -385,14 +385,14 @@ </method> <method name="scroll_to_line"> <return type="void" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Scrolls the window's top line to match [code]line[/code]. </description> </method> <method name="scroll_to_paragraph"> <return type="void" /> - <argument index="0" name="paragraph" type="int" /> + <param index="0" name="paragraph" type="int" /> <description> Scrolls the window's top line to match first line of the [code]paragraph[/code]. </description> @@ -406,39 +406,39 @@ </method> <method name="set_cell_border_color"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Sets color of a table cell border. </description> </method> <method name="set_cell_padding"> <return type="void" /> - <argument index="0" name="padding" type="Rect2" /> + <param index="0" name="padding" type="Rect2" /> <description> Sets inner padding of a table cell. </description> </method> <method name="set_cell_row_background_color"> <return type="void" /> - <argument index="0" name="odd_row_bg" type="Color" /> - <argument index="1" name="even_row_bg" type="Color" /> + <param index="0" name="odd_row_bg" type="Color" /> + <param index="1" name="even_row_bg" type="Color" /> <description> Sets color of a table cell. Separate colors for alternating rows can be specified. </description> </method> <method name="set_cell_size_override"> <return type="void" /> - <argument index="0" name="min_size" type="Vector2" /> - <argument index="1" name="max_size" type="Vector2" /> + <param index="0" name="min_size" type="Vector2" /> + <param index="1" name="max_size" type="Vector2" /> <description> Sets minimum and maximum size overrides for a table cell. </description> </method> <method name="set_table_column_expand"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="expand" type="bool" /> - <argument index="2" name="ratio" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="expand" type="bool" /> + <param index="2" name="ratio" type="int" /> <description> Edits the selected column's expansion options. If [code]expand[/code] is [code]true[/code], the column expands in proportion to its expansion ratio versus the other columns' ratios. For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively. @@ -534,19 +534,19 @@ </description> </signal> <signal name="meta_clicked"> - <argument index="0" name="meta" type="Variant" /> + <param index="0" name="meta" type="Variant" /> <description> Triggered when the user clicks on content between meta tags. If the meta is defined in text, e.g. [code][url={"data"="hi"}]hi[/url][/code], then the parameter for this signal will be a [String] type. If a particular type or an object is desired, the [method push_meta] method must be used to manually insert the data into the tag stack. </description> </signal> <signal name="meta_hover_ended"> - <argument index="0" name="meta" type="Variant" /> + <param index="0" name="meta" type="Variant" /> <description> Triggers when the mouse exits a meta tag. </description> </signal> <signal name="meta_hover_started"> - <argument index="0" name="meta" type="Variant" /> + <param index="0" name="meta" type="Variant" /> <description> Triggers when the mouse enters a meta tag. </description> diff --git a/doc/classes/RigidDynamicBody2D.xml b/doc/classes/RigidDynamicBody2D.xml index 087156989e..c50da89a26 100644 --- a/doc/classes/RigidDynamicBody2D.xml +++ b/doc/classes/RigidDynamicBody2D.xml @@ -17,14 +17,14 @@ <methods> <method name="_integrate_forces" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="state" type="PhysicsDirectBodyState2D" /> + <param index="0" name="state" type="PhysicsDirectBodyState2D" /> <description> Allows you to read and safely modify the simulation state for the object. Use this instead of [method Node._physics_process] if you need to directly change the body's [code]position[/code] or other physics properties. By default, it works in addition to the usual physics behavior, but [member custom_integrator] allows you to disable the default behavior and write custom force integration for a body. </description> </method> <method name="add_constant_central_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" /> + <param index="0" name="force" type="Vector2" /> <description> Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector2(0, 0)[/code]. This is equivalent to using [method add_constant_force] at the body's center of mass. @@ -32,8 +32,8 @@ </method> <method name="add_constant_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" /> - <argument index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="force" type="Vector2" /> + <param index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector2(0, 0)[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -41,14 +41,14 @@ </method> <method name="add_constant_torque"> <return type="void" /> - <argument index="0" name="torque" type="float" /> + <param index="0" name="torque" type="float" /> <description> Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = 0[/code]. </description> </method> <method name="apply_central_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" /> + <param index="0" name="force" type="Vector2" /> <description> Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method apply_force] at the body's center of mass. @@ -56,7 +56,7 @@ </method> <method name="apply_central_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="impulse" type="Vector2" default="Vector2(0, 0)" /> <description> Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -65,8 +65,8 @@ </method> <method name="apply_force"> <return type="void" /> - <argument index="0" name="force" type="Vector2" /> - <argument index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="force" type="Vector2" /> + <param index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -74,8 +74,8 @@ </method> <method name="apply_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector2" /> - <argument index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="impulse" type="Vector2" /> + <param index="1" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -84,14 +84,14 @@ </method> <method name="apply_torque"> <return type="void" /> - <argument index="0" name="torque" type="float" /> + <param index="0" name="torque" type="float" /> <description> Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. </description> </method> <method name="apply_torque_impulse"> <return type="void" /> - <argument index="0" name="torque" type="float" /> + <param index="0" name="torque" type="float" /> <description> Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -106,7 +106,7 @@ </method> <method name="set_axis_velocity"> <return type="void" /> - <argument index="0" name="axis_velocity" type="Vector2" /> + <param index="0" name="axis_velocity" type="Vector2" /> <description> Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> @@ -197,24 +197,24 @@ </members> <signals> <signal name="body_entered"> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Emitted when a collision with another [PhysicsBody2D] or [TileMap] occurs. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. </description> </signal> <signal name="body_exited"> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Emitted when the collision with another [PhysicsBody2D] or [TileMap] ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. </description> </signal> <signal name="body_shape_entered"> - <argument index="0" name="body_rid" type="RID" /> - <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="body_rid" type="RID" /> + <param index="1" name="body" type="Node" /> + <param index="2" name="body_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of this RigidDynamicBody2D's [Shape2D]s collides with another [PhysicsBody2D] or [TileMap]'s [Shape2D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_rid[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. @@ -224,10 +224,10 @@ </description> </signal> <signal name="body_shape_exited"> - <argument index="0" name="body_rid" type="RID" /> - <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="body_rid" type="RID" /> + <param index="1" name="body" type="Node" /> + <param index="2" name="body_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when the collision between one of this RigidDynamicBody2D's [Shape2D]s and another [PhysicsBody2D] or [TileMap]'s [Shape2D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_rid[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. diff --git a/doc/classes/RigidDynamicBody3D.xml b/doc/classes/RigidDynamicBody3D.xml index 285176b8b0..5c89dbbf44 100644 --- a/doc/classes/RigidDynamicBody3D.xml +++ b/doc/classes/RigidDynamicBody3D.xml @@ -17,14 +17,14 @@ <methods> <method name="_integrate_forces" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="state" type="PhysicsDirectBodyState3D" /> + <param index="0" name="state" type="PhysicsDirectBodyState3D" /> <description> Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but the [member custom_integrator] property allows you to disable the default behavior and do fully custom force integration for a body. </description> </method> <method name="add_constant_central_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> + <param index="0" name="force" type="Vector3" /> <description> Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code]. This is equivalent to using [method add_constant_force] at the body's center of mass. @@ -32,8 +32,8 @@ </method> <method name="add_constant_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> - <argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="force" type="Vector3" /> + <param index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -41,14 +41,14 @@ </method> <method name="add_constant_torque"> <return type="void" /> - <argument index="0" name="torque" type="Vector3" /> + <param index="0" name="torque" type="Vector3" /> <description> Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = Vector3(0, 0, 0)[/code]. </description> </method> <method name="apply_central_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> + <param index="0" name="force" type="Vector3" /> <description> Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method apply_force] at the body's center of mass. @@ -56,7 +56,7 @@ </method> <method name="apply_central_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> + <param index="0" name="impulse" type="Vector3" /> <description> Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -65,8 +65,8 @@ </method> <method name="apply_force"> <return type="void" /> - <argument index="0" name="force" type="Vector3" /> - <argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="force" type="Vector3" /> + <param index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -74,8 +74,8 @@ </method> <method name="apply_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> - <argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> + <param index="0" name="impulse" type="Vector3" /> + <param index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" /> <description> Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -84,14 +84,14 @@ </method> <method name="apply_torque"> <return type="void" /> - <argument index="0" name="torque" type="Vector3" /> + <param index="0" name="torque" type="Vector3" /> <description> Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. </description> </method> <method name="apply_torque_impulse"> <return type="void" /> - <argument index="0" name="impulse" type="Vector3" /> + <param index="0" name="impulse" type="Vector3" /> <description> Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -112,7 +112,7 @@ </method> <method name="set_axis_velocity"> <return type="void" /> - <argument index="0" name="axis_velocity" type="Vector3" /> + <param index="0" name="axis_velocity" type="Vector3" /> <description> Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> @@ -203,24 +203,24 @@ </members> <signals> <signal name="body_entered"> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Emitted when a collision with another [PhysicsBody3D] or [GridMap] occurs. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. </description> </signal> <signal name="body_exited"> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Emitted when the collision with another [PhysicsBody3D] or [GridMap] ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. </description> </signal> <signal name="body_shape_entered"> - <argument index="0" name="body_rid" type="RID" /> - <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="body_rid" type="RID" /> + <param index="1" name="body" type="Node" /> + <param index="2" name="body_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when one of this RigidDynamicBody3D's [Shape3D]s collides with another [PhysicsBody3D] or [GridMap]'s [Shape3D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body_rid[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. @@ -230,10 +230,10 @@ </description> </signal> <signal name="body_shape_exited"> - <argument index="0" name="body_rid" type="RID" /> - <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape_index" type="int" /> - <argument index="3" name="local_shape_index" type="int" /> + <param index="0" name="body_rid" type="RID" /> + <param index="1" name="body" type="Node" /> + <param index="2" name="body_shape_index" type="int" /> + <param index="3" name="local_shape_index" type="int" /> <description> Emitted when the collision between one of this RigidDynamicBody3D's [Shape3D]s and another [PhysicsBody3D] or [GridMap]'s [Shape3D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body_rid[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [GridMap]s are detected if the Meshes have [Shape3D]s. diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index d226577a95..f171d29b84 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -12,7 +12,7 @@ <methods> <method name="get_connection_binds" qualifiers="const"> <return type="Array" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the list of bound parameters for the signal at [code]idx[/code]. </description> @@ -26,42 +26,42 @@ </method> <method name="get_connection_flags" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the connection flags for the signal at [code]idx[/code]. See [enum Object.ConnectFlags] constants. </description> </method> <method name="get_connection_method" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the method connected to the signal at [code]idx[/code]. </description> </method> <method name="get_connection_signal" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the name of the signal at [code]idx[/code]. </description> </method> <method name="get_connection_source" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the path to the node that owns the signal at [code]idx[/code], relative to the root node. </description> </method> <method name="get_connection_target" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the path to the node that owns the method connected to the signal at [code]idx[/code], relative to the root node. </description> </method> <method name="get_connection_unbinds" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the number of unbound parameters for the signal at [code]idx[/code]. </description> @@ -75,50 +75,50 @@ </method> <method name="get_node_groups" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the list of group names associated with the node at [code]idx[/code]. </description> </method> <method name="get_node_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instantiated or inherited scene among siblings from the base scene. Despite the name, this index is not related to the [code]idx[/code] argument used here and in other methods. </description> </method> <method name="get_node_instance" qualifiers="const"> <return type="PackedScene" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns a [PackedScene] for the node at [code]idx[/code] (i.e. the whole branch starting at this node, with its child nodes and resources), or [code]null[/code] if the node is not an instance. </description> </method> <method name="get_node_instance_placeholder" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the path to the represented scene file if the node at [code]idx[/code] is an [InstancePlaceholder]. </description> </method> <method name="get_node_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the name of the node at [code]idx[/code]. </description> </method> <method name="get_node_owner_path" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the path to the owner of the node at [code]idx[/code], relative to the root node. </description> </method> <method name="get_node_path" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="for_parent" type="bool" default="false" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="for_parent" type="bool" default="false" /> <description> Returns the path to the node at [code]idx[/code]. If [code]for_parent[/code] is [code]true[/code], returns the path of the [code]idx[/code] node's parent instead. @@ -126,7 +126,7 @@ </method> <method name="get_node_property_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the number of exported or overridden properties for the node at [code]idx[/code]. The [code]prop_idx[/code] argument used to query node property data in other [code]get_node_property_*[/code] methods in the interval [code][0, get_node_property_count() - 1][/code]. @@ -134,30 +134,30 @@ </method> <method name="get_node_property_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="prop_idx" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="prop_idx" type="int" /> <description> Returns the name of the property at [code]prop_idx[/code] for the node at [code]idx[/code]. </description> </method> <method name="get_node_property_value" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="prop_idx" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="prop_idx" type="int" /> <description> Returns the value of the property at [code]prop_idx[/code] for the node at [code]idx[/code]. </description> </method> <method name="get_node_type" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the type of the node at [code]idx[/code]. </description> </method> <method name="is_node_instance_placeholder" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns [code]true[/code] if the node at [code]idx[/code] is an [InstancePlaceholder]. </description> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 9982cc0d60..dfa5704548 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -15,8 +15,8 @@ <methods> <method name="call_group" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="group" type="StringName" /> - <argument index="1" name="method" type="StringName" /> + <param index="0" name="group" type="StringName" /> + <param index="1" name="method" type="StringName" /> <description> Calls [code]method[/code] on each member of the given group. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. If a node doesn't have the given method or the argument list does not match (either in count or in types), it will be skipped. [b]Note:[/b] [method call_group] will call methods immediately on all members at once, which can cause stuttering if an expensive method is called on lots of members. To wait for one frame after [method call_group] was called, use [method call_group_flags] with the [constant GROUP_CALL_DEFERRED] flag. @@ -24,9 +24,9 @@ </method> <method name="call_group_flags" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="flags" type="int" /> - <argument index="1" name="group" type="StringName" /> - <argument index="2" name="method" type="StringName" /> + <param index="0" name="flags" type="int" /> + <param index="1" name="group" type="StringName" /> + <param index="2" name="method" type="StringName" /> <description> Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. If a node doesn't have the given method or the argument list does not match (either in count or in types), it will be skipped. [codeblock] @@ -38,7 +38,7 @@ </method> <method name="change_scene"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Changes the running scene to the one at the given [code]path[/code], after loading it into a [PackedScene] and creating a new instance. Returns [constant OK] on success, [constant ERR_CANT_OPEN] if the [code]path[/code] cannot be loaded into a [PackedScene], or [constant ERR_CANT_CREATE] if that scene cannot be instantiated. @@ -47,7 +47,7 @@ </method> <method name="change_scene_to"> <return type="int" enum="Error" /> - <argument index="0" name="packed_scene" type="PackedScene" /> + <param index="0" name="packed_scene" type="PackedScene" /> <description> Changes the running scene to a new instance of the given [PackedScene]. Returns [constant OK] on success or [constant ERR_CANT_CREATE] if the scene cannot be instantiated. @@ -56,8 +56,8 @@ </method> <method name="create_timer"> <return type="SceneTreeTimer" /> - <argument index="0" name="time_sec" type="float" /> - <argument index="1" name="process_always" type="bool" default="true" /> + <param index="0" name="time_sec" type="float" /> + <param index="1" name="process_always" type="bool" default="true" /> <description> Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. If [code]process_always[/code] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. Commonly used to create a one-shot delay timer as in the following example: @@ -88,7 +88,7 @@ </method> <method name="get_first_node_in_group"> <return type="Node" /> - <argument index="0" name="group" type="StringName" /> + <param index="0" name="group" type="StringName" /> <description> Returns the first node in the specified group, or [code]null[/code] if the group is empty or does not exist. </description> @@ -101,7 +101,7 @@ </method> <method name="get_multiplayer" qualifiers="const"> <return type="MultiplayerAPI" /> - <argument index="0" name="for_path" type="NodePath" default="NodePath("")" /> + <param index="0" name="for_path" type="NodePath" default="NodePath("")" /> <description> Return the [MultiplayerAPI] configured for the given path, or the default one if [code]for_path[/code] is empty. </description> @@ -114,7 +114,7 @@ </method> <method name="get_nodes_in_group"> <return type="Array" /> - <argument index="0" name="group" type="StringName" /> + <param index="0" name="group" type="StringName" /> <description> Returns a list of all nodes assigned to the given group. </description> @@ -127,15 +127,15 @@ </method> <method name="has_group" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the given group exists. </description> </method> <method name="notify_group"> <return type="void" /> - <argument index="0" name="group" type="StringName" /> - <argument index="1" name="notification" type="int" /> + <param index="0" name="group" type="StringName" /> + <param index="1" name="notification" type="int" /> <description> Sends the given notification to all members of the [code]group[/code]. [b]Note:[/b] [method notify_group] will immediately notify all members at once, which can cause stuttering if an expensive method is called as a result of sending the notification lots of members. To wait for one frame, use [method notify_group_flags] with the [constant GROUP_CALL_DEFERRED] flag. @@ -143,9 +143,9 @@ </method> <method name="notify_group_flags"> <return type="void" /> - <argument index="0" name="call_flags" type="int" /> - <argument index="1" name="group" type="StringName" /> - <argument index="2" name="notification" type="int" /> + <param index="0" name="call_flags" type="int" /> + <param index="1" name="group" type="StringName" /> + <param index="2" name="notification" type="int" /> <description> Sends the given notification to all members of the [code]group[/code], respecting the given [enum GroupCallFlags]. [b]Note:[/b] Group call flags are used to control the notification sending behavior. By default, notifications will be sent immediately in a way similar to [method notify_group]. However, if the [constant GROUP_CALL_DEFERRED] flag is present in the [code]flags[/code] argument, notifications will be sent with a one-frame delay in a way similar to using [code]Object.call_deferred("notification", ...)[/code]. @@ -153,14 +153,14 @@ </method> <method name="queue_delete"> <return type="void" /> - <argument index="0" name="obj" type="Object" /> + <param index="0" name="obj" type="Object" /> <description> Queues the given object for deletion, delaying the call to [method Object.free] to after the current frame. </description> </method> <method name="quit"> <return type="void" /> - <argument index="0" name="exit_code" type="int" default="0" /> + <param index="0" name="exit_code" type="int" default="0" /> <description> Quits the application at the end of the current iteration. Argument [code]exit_code[/code] can optionally be given (defaulting to 0) to customize the exit status code. By convention, an exit code of [code]0[/code] indicates success whereas a non-zero exit code indicates an error. @@ -177,9 +177,9 @@ </method> <method name="set_group"> <return type="void" /> - <argument index="0" name="group" type="StringName" /> - <argument index="1" name="property" type="String" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="group" type="StringName" /> + <param index="1" name="property" type="String" /> + <param index="2" name="value" type="Variant" /> <description> Sets the given [code]property[/code] to [code]value[/code] on all members of the given group. [b]Note:[/b] [method set_group] will set the property immediately on all members at once, which can cause stuttering if a property with an expensive setter is set on lots of members. To wait for one frame, use [method set_group_flags] with the [constant GROUP_CALL_DEFERRED] flag. @@ -187,10 +187,10 @@ </method> <method name="set_group_flags"> <return type="void" /> - <argument index="0" name="call_flags" type="int" /> - <argument index="1" name="group" type="StringName" /> - <argument index="2" name="property" type="String" /> - <argument index="3" name="value" type="Variant" /> + <param index="0" name="call_flags" type="int" /> + <param index="1" name="group" type="StringName" /> + <param index="2" name="property" type="String" /> + <param index="3" name="value" type="Variant" /> <description> Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GroupCallFlags]. [b]Note:[/b] Group call flags are used to control the property setting behavior. By default, properties will be set immediately in a way similar to [method set_group]. However, if the [constant GROUP_CALL_DEFERRED] flag is present in the [code]flags[/code] argument, properties will be set with a one-frame delay in a way similar to [method Object.call_deferred]. @@ -198,8 +198,8 @@ </method> <method name="set_multiplayer"> <return type="void" /> - <argument index="0" name="multiplayer" type="MultiplayerAPI" /> - <argument index="1" name="root_path" type="NodePath" default="NodePath("")" /> + <param index="0" name="multiplayer" type="MultiplayerAPI" /> + <param index="1" name="root_path" type="NodePath" default="NodePath("")" /> <description> Sets a custom [MultiplayerAPI] with the given [code]root_path[/code] (controlling also the relative subpaths), or override the default one if [code]root_path[/code] is empty. </description> @@ -244,25 +244,25 @@ </members> <signals> <signal name="node_added"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted whenever a node is added to the [SceneTree]. </description> </signal> <signal name="node_configuration_warning_changed"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted when a node's configuration changed. Only emitted in [code]tool[/code] mode. </description> </signal> <signal name="node_removed"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted whenever a node is removed from the [SceneTree]. </description> </signal> <signal name="node_renamed"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted whenever a node is renamed. </description> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index cd8841c8c5..f567a0c23c 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -32,7 +32,7 @@ </method> <method name="get_property_default_value"> <return type="Variant" /> - <argument index="0" name="property" type="StringName" /> + <param index="0" name="property" type="StringName" /> <description> Returns the default value of the specified property. </description> @@ -63,7 +63,7 @@ </method> <method name="has_script_signal" qualifiers="const"> <return type="bool" /> - <argument index="0" name="signal_name" type="StringName" /> + <param index="0" name="signal_name" type="StringName" /> <description> Returns [code]true[/code] if the script, or a base class, defines a signal with the given name. </description> @@ -76,7 +76,7 @@ </method> <method name="instance_has" qualifiers="const"> <return type="bool" /> - <argument index="0" name="base_object" type="Object" /> + <param index="0" name="base_object" type="Object" /> <description> Returns [code]true[/code] if [code]base_object[/code] is an instance of this script. </description> @@ -89,7 +89,7 @@ </method> <method name="reload"> <return type="int" enum="Error" /> - <argument index="0" name="keep_state" type="bool" default="false" /> + <param index="0" name="keep_state" type="bool" default="false" /> <description> Reloads the script's class implementation. Returns an error code. </description> diff --git a/doc/classes/ScriptCreateDialog.xml b/doc/classes/ScriptCreateDialog.xml index 79ee95719d..6b608aca4f 100644 --- a/doc/classes/ScriptCreateDialog.xml +++ b/doc/classes/ScriptCreateDialog.xml @@ -29,10 +29,10 @@ <methods> <method name="config"> <return type="void" /> - <argument index="0" name="inherits" type="String" /> - <argument index="1" name="path" type="String" /> - <argument index="2" name="built_in_enabled" type="bool" default="true" /> - <argument index="3" name="load_enabled" type="bool" default="true" /> + <param index="0" name="inherits" type="String" /> + <param index="1" name="path" type="String" /> + <param index="2" name="built_in_enabled" type="bool" default="true" /> + <param index="3" name="load_enabled" type="bool" default="true" /> <description> Prefills required fields to configure the ScriptCreateDialog for use. </description> @@ -45,7 +45,7 @@ </members> <signals> <signal name="script_created"> - <argument index="0" name="script" type="Script" /> + <param index="0" name="script" type="Script" /> <description> Emitted when the user clicks the OK button. </description> diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 92488b2392..33ff054cce 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -35,22 +35,22 @@ </method> <method name="goto_line"> <return type="void" /> - <argument index="0" name="line_number" type="int" /> + <param index="0" name="line_number" type="int" /> <description> Goes to the specified line in the current script. </description> </method> <method name="open_script_create_dialog"> <return type="void" /> - <argument index="0" name="base_name" type="String" /> - <argument index="1" name="base_path" type="String" /> + <param index="0" name="base_name" type="String" /> + <param index="1" name="base_path" type="String" /> <description> Opens the script create dialog. The script will extend [code]base_name[/code]. The file extension can be omitted from [code]base_path[/code]. It will be added based on the selected scripting language. </description> </method> <method name="register_syntax_highlighter"> <return type="void" /> - <argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" /> + <param index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" /> <description> Registers the [EditorSyntaxHighlighter] to the editor, the [EditorSyntaxHighlighter] will be available on all open scripts. [b]Note:[/b] Does not apply to scripts that are already opened. @@ -58,7 +58,7 @@ </method> <method name="unregister_syntax_highlighter"> <return type="void" /> - <argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" /> + <param index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" /> <description> Unregisters the [EditorSyntaxHighlighter] from the editor. [b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened. @@ -67,13 +67,13 @@ </methods> <signals> <signal name="editor_script_changed"> - <argument index="0" name="script" type="Script" /> + <param index="0" name="script" type="Script" /> <description> Emitted when user changed active script. Argument is a freshly activated [Script]. </description> </signal> <signal name="script_close"> - <argument index="0" name="script" type="Script" /> + <param index="0" name="script" type="Script" /> <description> Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed. </description> diff --git a/doc/classes/ScriptEditorBase.xml b/doc/classes/ScriptEditorBase.xml index 3bed1127ee..c365e0971b 100644 --- a/doc/classes/ScriptEditorBase.xml +++ b/doc/classes/ScriptEditorBase.xml @@ -11,7 +11,7 @@ <methods> <method name="add_syntax_highlighter"> <return type="void" /> - <argument index="0" name="highlighter" type="EditorSyntaxHighlighter" /> + <param index="0" name="highlighter" type="EditorSyntaxHighlighter" /> <description> Adds a [EditorSyntaxHighlighter] to the open script. </description> @@ -30,7 +30,7 @@ </description> </signal> <signal name="go_to_help"> - <argument index="0" name="what" type="String" /> + <param index="0" name="what" type="String" /> <description> Emitted when the user requests a specific documentation page. </description> @@ -41,20 +41,20 @@ </description> </signal> <signal name="replace_in_files_requested"> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Emitted when the user request to find and replace text in the file system. Not used by visual scripts. </description> </signal> <signal name="request_help"> - <argument index="0" name="topic" type="String" /> + <param index="0" name="topic" type="String" /> <description> Emitted when the user requests contextual help. </description> </signal> <signal name="request_open_script_at_line"> - <argument index="0" name="script" type="Object" /> - <argument index="1" name="line" type="int" /> + <param index="0" name="script" type="Object" /> + <param index="1" name="line" type="int" /> <description> Emitted when the user requests a script. </description> @@ -65,7 +65,7 @@ </description> </signal> <signal name="search_in_files_requested"> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Emitted when the user request to search text in the file system. Not used by visual scripts. </description> diff --git a/doc/classes/ScriptExtension.xml b/doc/classes/ScriptExtension.xml index 4e432ca9a8..b59c49d785 100644 --- a/doc/classes/ScriptExtension.xml +++ b/doc/classes/ScriptExtension.xml @@ -44,7 +44,7 @@ </method> <method name="_get_member_line" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="member" type="StringName" /> + <param index="0" name="member" type="StringName" /> <description> </description> </method> @@ -55,13 +55,13 @@ </method> <method name="_get_method_info" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="method" type="StringName" /> + <param index="0" name="method" type="StringName" /> <description> </description> </method> <method name="_get_property_default_value" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="property" type="StringName" /> + <param index="0" name="property" type="StringName" /> <description> </description> </method> @@ -92,13 +92,13 @@ </method> <method name="_has_method" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="method" type="StringName" /> + <param index="0" name="method" type="StringName" /> <description> </description> </method> <method name="_has_script_signal" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="signal" type="StringName" /> + <param index="0" name="signal" type="StringName" /> <description> </description> </method> @@ -109,19 +109,19 @@ </method> <method name="_inherits_script" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="script" type="Script" /> + <param index="0" name="script" type="Script" /> <description> </description> </method> <method name="_instance_create" qualifiers="virtual const"> <return type="void*" /> - <argument index="0" name="for_object" type="Object" /> + <param index="0" name="for_object" type="Object" /> <description> </description> </method> <method name="_instance_has" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="object" type="Object" /> + <param index="0" name="object" type="Object" /> <description> </description> </method> @@ -142,25 +142,25 @@ </method> <method name="_placeholder_erased" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="placeholder" type="void*" /> + <param index="0" name="placeholder" type="void*" /> <description> </description> </method> <method name="_placeholder_instance_create" qualifiers="virtual const"> <return type="void*" /> - <argument index="0" name="for_object" type="Object" /> + <param index="0" name="for_object" type="Object" /> <description> </description> </method> <method name="_reload" qualifiers="virtual"> <return type="int" enum="Error" /> - <argument index="0" name="keep_state" type="bool" /> + <param index="0" name="keep_state" type="bool" /> <description> </description> </method> <method name="_set_source_code" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="code" type="String" /> + <param index="0" name="code" type="String" /> <description> </description> </method> diff --git a/doc/classes/ScriptLanguageExtension.xml b/doc/classes/ScriptLanguageExtension.xml index 45d4cf44fa..2d41f8e880 100644 --- a/doc/classes/ScriptLanguageExtension.xml +++ b/doc/classes/ScriptLanguageExtension.xml @@ -9,29 +9,29 @@ <methods> <method name="_add_global_constant" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> </description> </method> <method name="_add_named_global_constant" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> </description> </method> <method name="_alloc_instance_binding_data" qualifiers="virtual"> <return type="void*" /> - <argument index="0" name="object" type="Object" /> + <param index="0" name="object" type="Object" /> <description> </description> </method> <method name="_auto_indent_code" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="code" type="String" /> - <argument index="1" name="from_line" type="int" /> - <argument index="2" name="to_line" type="int" /> + <param index="0" name="code" type="String" /> + <param index="1" name="from_line" type="int" /> + <param index="2" name="to_line" type="int" /> <description> </description> </method> @@ -42,9 +42,9 @@ </method> <method name="_complete_code" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="code" type="String" /> - <argument index="1" name="path" type="String" /> - <argument index="2" name="owner" type="Object" /> + <param index="0" name="code" type="String" /> + <param index="1" name="path" type="String" /> + <param index="2" name="owner" type="Object" /> <description> </description> </method> @@ -65,8 +65,8 @@ </method> <method name="_debug_get_globals" qualifiers="virtual"> <return type="Dictionary" /> - <argument index="0" name="max_subitems" type="int" /> - <argument index="1" name="max_depth" type="int" /> + <param index="0" name="max_subitems" type="int" /> + <param index="1" name="max_depth" type="int" /> <description> </description> </method> @@ -77,57 +77,57 @@ </method> <method name="_debug_get_stack_level_function" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="level" type="int" /> + <param index="0" name="level" type="int" /> <description> </description> </method> <method name="_debug_get_stack_level_instance" qualifiers="virtual"> <return type="void*" /> - <argument index="0" name="level" type="int" /> + <param index="0" name="level" type="int" /> <description> </description> </method> <method name="_debug_get_stack_level_line" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="level" type="int" /> + <param index="0" name="level" type="int" /> <description> </description> </method> <method name="_debug_get_stack_level_locals" qualifiers="virtual"> <return type="Dictionary" /> - <argument index="0" name="level" type="int" /> - <argument index="1" name="max_subitems" type="int" /> - <argument index="2" name="max_depth" type="int" /> + <param index="0" name="level" type="int" /> + <param index="1" name="max_subitems" type="int" /> + <param index="2" name="max_depth" type="int" /> <description> </description> </method> <method name="_debug_get_stack_level_members" qualifiers="virtual"> <return type="Dictionary" /> - <argument index="0" name="level" type="int" /> - <argument index="1" name="max_subitems" type="int" /> - <argument index="2" name="max_depth" type="int" /> + <param index="0" name="level" type="int" /> + <param index="1" name="max_subitems" type="int" /> + <param index="2" name="max_depth" type="int" /> <description> </description> </method> <method name="_debug_parse_stack_level_expression" qualifiers="virtual"> <return type="String" /> - <argument index="0" name="level" type="int" /> - <argument index="1" name="expression" type="String" /> - <argument index="2" name="max_subitems" type="int" /> - <argument index="3" name="max_depth" type="int" /> + <param index="0" name="level" type="int" /> + <param index="1" name="expression" type="String" /> + <param index="2" name="max_subitems" type="int" /> + <param index="3" name="max_depth" type="int" /> <description> </description> </method> <method name="_execute_file" qualifiers="virtual"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> <method name="_find_function" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="class_name" type="String" /> - <argument index="1" name="function_name" type="String" /> + <param index="0" name="class_name" type="String" /> + <param index="1" name="function_name" type="String" /> <description> </description> </method> @@ -143,13 +143,13 @@ </method> <method name="_free_instance_binding_data" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="data" type="void*" /> + <param index="0" name="data" type="void*" /> <description> </description> </method> <method name="_get_built_in_templates" qualifiers="virtual const"> <return type="Dictionary[]" /> - <argument index="0" name="object" type="StringName" /> + <param index="0" name="object" type="StringName" /> <description> </description> </method> @@ -165,7 +165,7 @@ </method> <method name="_get_global_class_name" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> @@ -211,7 +211,7 @@ </method> <method name="_handles_global_class_type" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="type" type="String" /> + <param index="0" name="type" type="String" /> <description> </description> </method> @@ -227,7 +227,7 @@ </method> <method name="_is_control_flow_keyword" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="keyword" type="String" /> + <param index="0" name="keyword" type="String" /> <description> </description> </method> @@ -238,34 +238,34 @@ </method> <method name="_lookup_code" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="code" type="String" /> - <argument index="1" name="symbol" type="String" /> - <argument index="2" name="path" type="String" /> - <argument index="3" name="owner" type="Object" /> + <param index="0" name="code" type="String" /> + <param index="1" name="symbol" type="String" /> + <param index="2" name="path" type="String" /> + <param index="3" name="owner" type="Object" /> <description> </description> </method> <method name="_make_function" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="class_name" type="String" /> - <argument index="1" name="function_name" type="String" /> - <argument index="2" name="function_args" type="PackedStringArray" /> + <param index="0" name="class_name" type="String" /> + <param index="1" name="function_name" type="String" /> + <param index="2" name="function_args" type="PackedStringArray" /> <description> </description> </method> <method name="_make_template" qualifiers="virtual const"> <return type="Script" /> - <argument index="0" name="template" type="String" /> - <argument index="1" name="class_name" type="String" /> - <argument index="2" name="base_class_name" type="String" /> + <param index="0" name="template" type="String" /> + <param index="1" name="class_name" type="String" /> + <param index="2" name="base_class_name" type="String" /> <description> </description> </method> <method name="_open_in_external_editor" qualifiers="virtual"> <return type="int" enum="Error" /> - <argument index="0" name="script" type="Script" /> - <argument index="1" name="line" type="int" /> - <argument index="2" name="column" type="int" /> + <param index="0" name="script" type="Script" /> + <param index="1" name="line" type="int" /> + <param index="2" name="column" type="int" /> <description> </description> </method> @@ -276,15 +276,15 @@ </method> <method name="_profiling_get_accumulated_data" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="info_array" type="ScriptLanguageExtensionProfilingInfo*" /> - <argument index="1" name="info_max" type="int" /> + <param index="0" name="info_array" type="ScriptLanguageExtensionProfilingInfo*" /> + <param index="1" name="info_max" type="int" /> <description> </description> </method> <method name="_profiling_get_frame_data" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="info_array" type="ScriptLanguageExtensionProfilingInfo*" /> - <argument index="1" name="info_max" type="int" /> + <param index="0" name="info_array" type="ScriptLanguageExtensionProfilingInfo*" /> + <param index="1" name="info_max" type="int" /> <description> </description> </method> @@ -300,13 +300,13 @@ </method> <method name="_refcount_decremented_instance_binding" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="object" type="Object" /> + <param index="0" name="object" type="Object" /> <description> </description> </method> <method name="_refcount_incremented_instance_binding" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="object" type="Object" /> + <param index="0" name="object" type="Object" /> <description> </description> </method> @@ -317,14 +317,14 @@ </method> <method name="_reload_tool_script" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="script" type="Script" /> - <argument index="1" name="soft_reload" type="bool" /> + <param index="0" name="script" type="Script" /> + <param index="1" name="soft_reload" type="bool" /> <description> </description> </method> <method name="_remove_named_global_constant" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> </description> </method> @@ -350,18 +350,18 @@ </method> <method name="_validate" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="script" type="String" /> - <argument index="1" name="path" type="String" /> - <argument index="2" name="validate_functions" type="bool" /> - <argument index="3" name="validate_errors" type="bool" /> - <argument index="4" name="validate_warnings" type="bool" /> - <argument index="5" name="validate_safe_lines" type="bool" /> + <param index="0" name="script" type="String" /> + <param index="1" name="path" type="String" /> + <param index="2" name="validate_functions" type="bool" /> + <param index="3" name="validate_errors" type="bool" /> + <param index="4" name="validate_warnings" type="bool" /> + <param index="5" name="validate_safe_lines" type="bool" /> <description> </description> </method> <method name="_validate_path" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> </description> </method> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 1bbf5cb91b..207a745696 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -14,7 +14,7 @@ <methods> <method name="ensure_control_visible"> <return type="void" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <description> Ensures the given [code]control[/code] is visible (must be a direct or indirect child of the ScrollContainer). Used by [member follow_focus]. [b]Note:[/b] This will not work on a node that was just added during the same frame. If you want to scroll to a newly added child, you must wait until the next frame using [signal SceneTree.process_frame]: diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 1921c5b91d..6390d36bf1 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -12,8 +12,8 @@ <methods> <method name="get_default_texture_param" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="param" type="StringName" /> - <argument index="1" name="index" type="int" default="0" /> + <param index="0" name="param" type="StringName" /> + <param index="1" name="index" type="int" default="0" /> <description> Returns the texture that is set as default for the specified parameter. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. @@ -28,7 +28,7 @@ </method> <method name="has_uniform" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the shader has this param defined as a uniform in its code. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. @@ -36,9 +36,9 @@ </method> <method name="set_default_texture_param"> <return type="void" /> - <argument index="0" name="param" type="StringName" /> - <argument index="1" name="texture" type="Texture2D" /> - <argument index="2" name="index" type="int" default="0" /> + <param index="0" name="param" type="StringName" /> + <param index="1" name="texture" type="Texture2D" /> + <param index="2" name="index" type="int" default="0" /> <description> Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial]. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 1208b93a62..3e2247c022 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -12,29 +12,29 @@ <methods> <method name="get_shader_uniform" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="param" type="StringName" /> + <param index="0" name="param" type="StringName" /> <description> Returns the current value set for this material of a uniform in the shader. </description> </method> <method name="property_can_revert"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value. </description> </method> <method name="property_get_revert"> <return type="Variant" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the default value of the material property with given [code]name[/code]. </description> </method> <method name="set_shader_uniform"> <return type="void" /> - <argument index="0" name="param" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="param" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Changes the value set for this material of a uniform in the shader. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 94fb2d7dc7..8f5ca034e4 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -12,9 +12,9 @@ <methods> <method name="collide"> <return type="bool" /> - <argument index="0" name="local_xform" type="Transform2D" /> - <argument index="1" name="with_shape" type="Shape2D" /> - <argument index="2" name="shape_xform" type="Transform2D" /> + <param index="0" name="local_xform" type="Transform2D" /> + <param index="1" name="with_shape" type="Shape2D" /> + <param index="2" name="shape_xform" type="Transform2D" /> <description> Returns [code]true[/code] if this shape is colliding with another. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). @@ -22,9 +22,9 @@ </method> <method name="collide_and_get_contacts"> <return type="Array" /> - <argument index="0" name="local_xform" type="Transform2D" /> - <argument index="1" name="with_shape" type="Shape2D" /> - <argument index="2" name="shape_xform" type="Transform2D" /> + <param index="0" name="local_xform" type="Transform2D" /> + <param index="1" name="with_shape" type="Shape2D" /> + <param index="2" name="shape_xform" type="Transform2D" /> <description> Returns a list of contact point pairs where this shape touches another. If there are no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary of [code]with_shape[/code]. @@ -34,11 +34,11 @@ </method> <method name="collide_with_motion"> <return type="bool" /> - <argument index="0" name="local_xform" type="Transform2D" /> - <argument index="1" name="local_motion" type="Vector2" /> - <argument index="2" name="with_shape" type="Shape2D" /> - <argument index="3" name="shape_xform" type="Transform2D" /> - <argument index="4" name="shape_motion" type="Vector2" /> + <param index="0" name="local_xform" type="Transform2D" /> + <param index="1" name="local_motion" type="Vector2" /> + <param index="2" name="with_shape" type="Shape2D" /> + <param index="3" name="shape_xform" type="Transform2D" /> + <param index="4" name="shape_motion" type="Vector2" /> <description> Returns whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). @@ -46,11 +46,11 @@ </method> <method name="collide_with_motion_and_get_contacts"> <return type="Array" /> - <argument index="0" name="local_xform" type="Transform2D" /> - <argument index="1" name="local_motion" type="Vector2" /> - <argument index="2" name="with_shape" type="Shape2D" /> - <argument index="3" name="shape_xform" type="Transform2D" /> - <argument index="4" name="shape_motion" type="Vector2" /> + <param index="0" name="local_xform" type="Transform2D" /> + <param index="1" name="local_motion" type="Vector2" /> + <param index="2" name="with_shape" type="Shape2D" /> + <param index="3" name="shape_xform" type="Transform2D" /> + <param index="4" name="shape_motion" type="Vector2" /> <description> Returns a list of contact point pairs where this shape would touch another, if a given movement was applied. If there would be no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary of [code]with_shape[/code]. @@ -60,8 +60,8 @@ </method> <method name="draw"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="color" type="Color" /> <description> Draws a solid shape onto a [CanvasItem] with the [RenderingServer] API filled with the specified [code]color[/code]. The exact drawing method is specific for each shape and cannot be configured. </description> diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml index 70da03dc6e..652cacfb53 100644 --- a/doc/classes/ShapeCast2D.xml +++ b/doc/classes/ShapeCast2D.xml @@ -14,14 +14,14 @@ <methods> <method name="add_exception"> <return type="void" /> - <argument index="0" name="node" type="CollisionObject2D" /> + <param index="0" name="node" type="CollisionObject2D" /> <description> Adds a collision exception so the shape does not report collisions with the specified [CollisionObject2D] node. </description> </method> <method name="add_exception_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Adds a collision exception so the shape does not report collisions with the specified [RID]. </description> @@ -53,14 +53,14 @@ </method> <method name="get_collider" qualifiers="const"> <return type="Object" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the collided [Object] of one of the multiple collisions at [code]index[/code], or [code]null[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the shape ID of the colliding shape of one of the multiple collisions at [code]index[/code], or [code]0[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). </description> @@ -73,21 +73,21 @@ </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the normal of one of the multiple collisions at [code]index[/code] of the intersecting object. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the collision point of one of the multiple collisions at [code]index[/code] where the shape intersects the colliding object. [b]Note:[/b] this point is in the [b]global[/b] coordinate system. @@ -101,22 +101,22 @@ </method> <method name="remove_exception"> <return type="void" /> - <argument index="0" name="node" type="CollisionObject2D" /> + <param index="0" name="node" type="CollisionObject2D" /> <description> Removes a collision exception so the shape does report collisions with the specified [CollisionObject2D] node. </description> </method> <method name="remove_exception_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Removes a collision exception so the shape does report collisions with the specified [RID]. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/doc/classes/ShapeCast3D.xml b/doc/classes/ShapeCast3D.xml index 085bc9acd1..9a5606e198 100644 --- a/doc/classes/ShapeCast3D.xml +++ b/doc/classes/ShapeCast3D.xml @@ -14,14 +14,14 @@ <methods> <method name="add_exception"> <return type="void" /> - <argument index="0" name="node" type="Object" /> + <param index="0" name="node" type="Object" /> <description> Adds a collision exception so the shape does not report collisions with the specified [CollisionObject3D] node. </description> </method> <method name="add_exception_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Adds a collision exception so the shape does not report collisions with the specified [RID]. </description> @@ -53,14 +53,14 @@ </method> <method name="get_collider" qualifiers="const"> <return type="Object" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the collided [Object] of one of the multiple collisions at [code]index[/code], or [code]null[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the shape ID of the colliding shape of one of the multiple collisions at [code]index[/code], or [code]0[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). </description> @@ -73,21 +73,21 @@ </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the normal of one of the multiple collisions at [code]index[/code] of the intersecting object. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the collision point of one of the multiple collisions at [code]index[/code] where the shape intersects the colliding object. [b]Note:[/b] this point is in the [b]global[/b] coordinate system. @@ -101,29 +101,29 @@ </method> <method name="remove_exception"> <return type="void" /> - <argument index="0" name="node" type="Object" /> + <param index="0" name="node" type="Object" /> <description> Removes a collision exception so the shape does report collisions with the specified [CollisionObject3D] node. </description> </method> <method name="remove_exception_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Removes a collision exception so the shape does report collisions with the specified [RID]. </description> </method> <method name="resource_changed"> <return type="void" /> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> This method is used internally to update the debug gizmo in the editor. Any code placed in this function will be called whenever the [member shape] resource is modified. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml index 46524a1d74..329471fdb8 100644 --- a/doc/classes/Shortcut.xml +++ b/doc/classes/Shortcut.xml @@ -24,7 +24,7 @@ </method> <method name="matches_event" qualifiers="const"> <return type="bool" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Returns whether any [InputEvent] in [member events] equals [code]event[/code]. </description> diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index 049e7f8777..dc543085cf 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -18,15 +18,15 @@ </constructor> <constructor name="Signal"> <return type="Signal" /> - <argument index="0" name="from" type="Signal" /> + <param index="0" name="from" type="Signal" /> <description> Constructs a [Signal] as a copy of the given [Signal]. </description> </constructor> <constructor name="Signal"> <return type="Signal" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="signal" type="StringName" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="signal" type="StringName" /> <description> Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code]. </description> @@ -35,8 +35,8 @@ <methods> <method name="connect"> <return type="int" /> - <argument index="0" name="callable" type="Callable" /> - <argument index="1" name="flags" type="int" default="0" /> + <param index="0" name="callable" type="Callable" /> + <param index="1" name="flags" type="int" default="0" /> <description> Connects this signal to the specified [Callable], optionally providing connection flags. You can provide additional arguments to the connected method call by using [method Callable.bind]. [codeblock] @@ -50,7 +50,7 @@ </method> <method name="disconnect"> <return type="void" /> - <argument index="0" name="callable" type="Callable" /> + <param index="0" name="callable" type="Callable" /> <description> Disconnects this signal from the specified [Callable]. </description> @@ -87,7 +87,7 @@ </method> <method name="is_connected" qualifiers="const"> <return type="bool" /> - <argument index="0" name="callable" type="Callable" /> + <param index="0" name="callable" type="Callable" /> <description> Returns [code]true[/code] if the specified [Callable] is connected to this signal. </description> @@ -101,13 +101,13 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Signal" /> + <param index="0" name="right" type="Signal" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Signal" /> + <param index="0" name="right" type="Signal" /> <description> </description> </operator> diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml index 7867e5afa3..0abb8be075 100644 --- a/doc/classes/Skeleton2D.xml +++ b/doc/classes/Skeleton2D.xml @@ -13,15 +13,15 @@ <methods> <method name="execute_modifications"> <return type="void" /> - <argument index="0" name="delta" type="float" /> - <argument index="1" name="execution_mode" type="int" /> + <param index="0" name="delta" type="float" /> + <param index="1" name="execution_mode" type="int" /> <description> Executes all the modifications on the [SkeletonModificationStack2D], if the Skeleton3D has one assigned. </description> </method> <method name="get_bone"> <return type="Bone2D" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns a [Bone2D] from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter [code]idx[/code]. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling. </description> @@ -34,7 +34,7 @@ </method> <method name="get_bone_local_pose_override"> <return type="Transform2D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the local pose override transform for [code]bone_idx[/code]. </description> @@ -53,10 +53,10 @@ </method> <method name="set_bone_local_pose_override"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="override_pose" type="Transform2D" /> - <argument index="2" name="strength" type="float" /> - <argument index="3" name="persistent" type="bool" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="override_pose" type="Transform2D" /> + <param index="2" name="strength" type="float" /> + <param index="3" name="persistent" type="bool" /> <description> Sets the local pose transform, [code]pose[/code], for the bone at [code]bone_idx[/code]. [code]amount[/code] is the interpolation strength that will be used when applying the pose, and [code]persistent[/code] determines if the applied pose will remain. @@ -65,7 +65,7 @@ </method> <method name="set_modification_stack"> <return type="void" /> - <argument index="0" name="modification_stack" type="SkeletonModificationStack2D" /> + <param index="0" name="modification_stack" type="SkeletonModificationStack2D" /> <description> Sets the [SkeletonModificationStack2D] attached to this skeleton. </description> diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index 6295724aa2..c02a482a91 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -15,15 +15,15 @@ <methods> <method name="add_bone"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Adds a bone, with name [code]name[/code]. [method get_bone_count] will become the bone index. </description> </method> <method name="add_bone_child"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="child_bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="child_bone_idx" type="int" /> <description> Takes the given bone pose/transform and converts it to a world transform, relative to the [Skeleton3D] node. This is useful for using the bone transform in calculations with transforms from [Node3D]-based nodes. @@ -54,15 +54,15 @@ </method> <method name="execute_modifications"> <return type="void" /> - <argument index="0" name="delta" type="float" /> - <argument index="1" name="execution_mode" type="int" /> + <param index="0" name="delta" type="float" /> + <param index="1" name="execution_mode" type="int" /> <description> Executes all the modifications on the [SkeletonModificationStack3D], if the Skeleton3D has one assigned. </description> </method> <method name="find_bone" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns the bone index that matches [code]name[/code] as its name. </description> @@ -75,14 +75,14 @@ </method> <method name="force_update_bone_child_transform"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Force updates the bone transform for the bone at [code]bone_idx[/code] and all of its children. </description> </method> <method name="get_bone_children"> <return type="PackedInt32Array" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns an array containing the bone indexes of all the children node of the passed in bone, [code]bone_idx[/code]. </description> @@ -95,49 +95,49 @@ </method> <method name="get_bone_global_pose" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. </description> </method> <method name="get_bone_global_pose_no_override" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. </description> </method> <method name="get_bone_global_pose_override" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the global pose override transform for [code]bone_idx[/code]. </description> </method> <method name="get_bone_global_rest" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the global rest transform for [code]bone_idx[/code]. </description> </method> <method name="get_bone_local_pose_override" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the local pose override transform for [code]bone_idx[/code]. </description> </method> <method name="get_bone_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the name of the bone at index [code]index[/code]. </description> </method> <method name="get_bone_parent" qualifiers="const"> <return type="int" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the bone index which is the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent. [b]Note:[/b] The parent bone returned will always be less than [code]bone_idx[/code]. @@ -145,32 +145,32 @@ </method> <method name="get_bone_pose" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. </description> </method> <method name="get_bone_pose_position" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> </description> </method> <method name="get_bone_pose_rotation" qualifiers="const"> <return type="Quaternion" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> </description> </method> <method name="get_bone_pose_scale" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> </description> </method> <method name="get_bone_rest" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the rest transform for a bone [code]bone_idx[/code]. </description> @@ -189,8 +189,8 @@ </method> <method name="global_pose_to_local_pose"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="global_pose" type="Transform3D" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="global_pose" type="Transform3D" /> <description> Takes the passed-in global pose and converts it to local pose transform. This can be used to easily convert a global pose from [method get_bone_global_pose] to a global transform in [method set_bone_local_pose_override]. @@ -198,7 +198,7 @@ </method> <method name="global_pose_to_world_transform"> <return type="Transform3D" /> - <argument index="0" name="global_pose" type="Transform3D" /> + <param index="0" name="global_pose" type="Transform3D" /> <description> Takes the passed-in global pose and converts it to a world transform. This can be used to easily convert a global pose from [method get_bone_global_pose] to a global transform usable with a node's transform, like [member Node3D.global_transform] for example. @@ -206,8 +206,8 @@ </method> <method name="global_pose_z_forward_to_bone_forward"> <return type="Basis" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="basis" type="Basis" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="basis" type="Basis" /> <description> Rotates the given [Basis] so that the forward axis of the Basis is facing in the forward direction of the bone at [code]bone_idx[/code]. This is helper function to make using [method Transform3D.looking_at] easier with bone poses. @@ -215,15 +215,15 @@ </method> <method name="is_bone_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns whether the bone pose for the bone at [code]bone_idx[/code] is enabled. </description> </method> <method name="local_pose_to_global_pose"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="local_pose" type="Transform3D" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="local_pose" type="Transform3D" /> <description> Converts the passed-in local pose to a global pose relative to the inputted bone, [code]bone_idx[/code]. This could be used to convert [method get_bone_pose] for use with the [method set_bone_global_pose_override] function. @@ -237,7 +237,7 @@ </method> <method name="physical_bones_add_collision_exception"> <return type="void" /> - <argument index="0" name="exception" type="RID" /> + <param index="0" name="exception" type="RID" /> <description> Adds a collision exception to the physical bone. Works just like the [RigidDynamicBody3D] node. @@ -245,7 +245,7 @@ </method> <method name="physical_bones_remove_collision_exception"> <return type="void" /> - <argument index="0" name="exception" type="RID" /> + <param index="0" name="exception" type="RID" /> <description> Removes a collision exception to the physical bone. Works just like the [RigidDynamicBody3D] node. @@ -253,7 +253,7 @@ </method> <method name="physical_bones_start_simulation"> <return type="void" /> - <argument index="0" name="bones" type="StringName[]" default="[]" /> + <param index="0" name="bones" type="StringName[]" default="[]" /> <description> Tells the [PhysicalBone3D] nodes in the Skeleton to start simulating and reacting to the physics world. Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated. @@ -267,15 +267,15 @@ </method> <method name="register_skin"> <return type="SkinReference" /> - <argument index="0" name="skin" type="Skin" /> + <param index="0" name="skin" type="Skin" /> <description> Binds the given Skin to the Skeleton. </description> </method> <method name="remove_bone_child"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="child_bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="child_bone_idx" type="int" /> <description> Removes the passed in child bone index, [code]child_bone_idx[/code], from the passed-in bone, [code]bone_idx[/code], if it exists. [b]Note:[/b] This does not remove the child bone, but instead it removes the connection it has to the parent bone. @@ -283,26 +283,26 @@ </method> <method name="set_bone_children"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="bone_children" type="PackedInt32Array" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="bone_children" type="PackedInt32Array" /> <description> Sets the children for the passed in bone, [code]bone_idx[/code], to the passed-in array of bone indexes, [code]bone_children[/code]. </description> </method> <method name="set_bone_enabled"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="enabled" type="bool" default="true" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="enabled" type="bool" default="true" /> <description> Disables the pose for the bone at [code]bone_idx[/code] if [code]false[/code], enables the bone pose if [code]true[/code]. </description> </method> <method name="set_bone_global_pose_override"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="pose" type="Transform3D" /> - <argument index="2" name="amount" type="float" /> - <argument index="3" name="persistent" type="bool" default="false" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="pose" type="Transform3D" /> + <param index="2" name="amount" type="float" /> + <param index="3" name="persistent" type="bool" default="false" /> <description> Sets the global pose transform, [code]pose[/code], for the bone at [code]bone_idx[/code]. [code]amount[/code] is the interpolation strength that will be used when applying the pose, and [code]persistent[/code] determines if the applied pose will remain. @@ -311,10 +311,10 @@ </method> <method name="set_bone_local_pose_override"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="pose" type="Transform3D" /> - <argument index="2" name="amount" type="float" /> - <argument index="3" name="persistent" type="bool" default="false" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="pose" type="Transform3D" /> + <param index="2" name="amount" type="float" /> + <param index="3" name="persistent" type="bool" default="false" /> <description> Sets the local pose transform, [code]pose[/code], for the bone at [code]bone_idx[/code]. [code]amount[/code] is the interpolation strength that will be used when applying the pose, and [code]persistent[/code] determines if the applied pose will remain. @@ -323,15 +323,15 @@ </method> <method name="set_bone_name"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="name" type="String" /> <description> </description> </method> <method name="set_bone_parent"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="parent_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="parent_idx" type="int" /> <description> Sets the bone index [code]parent_idx[/code] as the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent. [b]Note:[/b] [code]parent_idx[/code] must be less than [code]bone_idx[/code]. @@ -339,50 +339,50 @@ </method> <method name="set_bone_pose_position"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="position" type="Vector3" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="position" type="Vector3" /> <description> </description> </method> <method name="set_bone_pose_rotation"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="rotation" type="Quaternion" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="rotation" type="Quaternion" /> <description> </description> </method> <method name="set_bone_pose_scale"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="scale" type="Vector3" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="scale" type="Vector3" /> <description> </description> </method> <method name="set_bone_rest"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="rest" type="Transform3D" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="rest" type="Transform3D" /> <description> Sets the rest transform for bone [code]bone_idx[/code]. </description> </method> <method name="set_modification_stack"> <return type="void" /> - <argument index="0" name="modification_stack" type="SkeletonModificationStack3D" /> + <param index="0" name="modification_stack" type="SkeletonModificationStack3D" /> <description> Sets the modification stack for this skeleton to the passed-in modification stack, [code]modification_stack[/code]. </description> </method> <method name="unparent_bone_and_rest"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Unparents the bone at [code]bone_idx[/code] and sets its rest position to that of its parent prior to being reset. </description> </method> <method name="world_transform_to_global_pose"> <return type="Transform3D" /> - <argument index="0" name="world_transform" type="Transform3D" /> + <param index="0" name="world_transform" type="Transform3D" /> <description> Takes the passed-in global transform and converts it to a global pose. This can be used to easily convert a global transform from [member Node3D.global_transform] to a global pose usable with [method set_bone_global_pose_override], for example. @@ -401,12 +401,12 @@ </members> <signals> <signal name="bone_enabled_changed"> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> </description> </signal> <signal name="bone_pose_changed"> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> This signal is emitted when one of the bones in the Skeleton3D node have changed their pose. This is used to inform nodes that rely on bone positions that one of the bones in the Skeleton3D have changed their transform/pose. </description> diff --git a/doc/classes/SkeletonIK3D.xml b/doc/classes/SkeletonIK3D.xml index 0545469e4c..788ba3e248 100644 --- a/doc/classes/SkeletonIK3D.xml +++ b/doc/classes/SkeletonIK3D.xml @@ -20,7 +20,7 @@ </method> <method name="start"> <return type="void" /> - <argument index="0" name="one_time" type="bool" default="false" /> + <param index="0" name="one_time" type="bool" default="false" /> <description> </description> </method> diff --git a/doc/classes/SkeletonModification2D.xml b/doc/classes/SkeletonModification2D.xml index 8ce9bf5731..c9171ead51 100644 --- a/doc/classes/SkeletonModification2D.xml +++ b/doc/classes/SkeletonModification2D.xml @@ -19,24 +19,24 @@ </method> <method name="_execute" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Executes the given modification. This is where the modification performs whatever function it is designed to do. </description> </method> <method name="_setup_modification" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="modification_stack" type="SkeletonModificationStack2D" /> + <param index="0" name="modification_stack" type="SkeletonModificationStack2D" /> <description> Called when the modification is setup. This is where the modification performs initialization. </description> </method> <method name="clamp_angle"> <return type="float" /> - <argument index="0" name="angle" type="float" /> - <argument index="1" name="min" type="float" /> - <argument index="2" name="max" type="float" /> - <argument index="3" name="invert" type="bool" /> + <param index="0" name="angle" type="float" /> + <param index="1" name="min" type="float" /> + <param index="2" name="max" type="float" /> + <param index="3" name="invert" type="bool" /> <description> Takes a angle and clamps it so it is within the passed-in [code]min[/code] and [code]max[/code] range. [code]invert[/code] will inversely clamp the angle, clamping it to the range outside of the given bounds. </description> @@ -61,14 +61,14 @@ </method> <method name="set_editor_draw_gizmo"> <return type="void" /> - <argument index="0" name="draw_gizmo" type="bool" /> + <param index="0" name="draw_gizmo" type="bool" /> <description> Sets whether this modification will call [method _draw_editor_gizmo] in the Godot editor to draw modification-specific gizmos. </description> </method> <method name="set_is_setup"> <return type="void" /> - <argument index="0" name="is_setup" type="bool" /> + <param index="0" name="is_setup" type="bool" /> <description> Manually allows you to set the setup state of the modification. This function should only rarely be used, as the [SkeletonModificationStack2D] the modification is bound to should handle setting the modification up. </description> diff --git a/doc/classes/SkeletonModification2DCCDIK.xml b/doc/classes/SkeletonModification2DCCDIK.xml index a613787a3e..048d5cb397 100644 --- a/doc/classes/SkeletonModification2DCCDIK.xml +++ b/doc/classes/SkeletonModification2DCCDIK.xml @@ -14,73 +14,73 @@ <methods> <method name="get_ccdik_joint_bone2d_node" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_bone_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the index of the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_constraint_angle_invert" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. See [method set_ccdik_joint_constraint_angle_invert] for details. </description> </method> <method name="get_ccdik_joint_constraint_angle_max" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the maximum angle constraint for the joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_constraint_angle_min" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the minimum angle constraint for the joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_enable_constraint" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns whether angle constraints on the CCDIK joint at [code]joint_idx[/code] are enabled. </description> </method> <method name="get_ccdik_joint_rotate_from_joint" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns whether the joint at [code]joint_idx[/code] is set to rotate from the joint, [code]true[/code], or to rotate from the tip, [code]false[/code]. The default is to rotate from the tip. </description> </method> <method name="set_ccdik_joint_bone2d_node"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone2d_nodepath" type="NodePath" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone2d_nodepath" type="NodePath" /> <description> Sets the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="set_ccdik_joint_bone_index"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_idx" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone2d_node[/code] of the CCDIK joint based on data provided by the linked skeleton. </description> </method> <method name="set_ccdik_joint_constraint_angle_invert"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="invert" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="invert" type="bool" /> <description> Sets whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. An inverted joint constraint only constraints the CCDIK joint to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values. @@ -88,32 +88,32 @@ </method> <method name="set_ccdik_joint_constraint_angle_max"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="angle_max" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="angle_max" type="float" /> <description> Sets the maximum angle constraint for the joint at [code]joint_idx[/code]. </description> </method> <method name="set_ccdik_joint_constraint_angle_min"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="angle_min" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="angle_min" type="float" /> <description> Sets the minimum angle constraint for the joint at [code]joint_idx[/code]. </description> </method> <method name="set_ccdik_joint_enable_constraint"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="enable_constraint" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="enable_constraint" type="bool" /> <description> Determines whether angle constraints on the CCDIK joint at [code]joint_idx[/code] are enabled. When [code]true[/code], constraints will be enabled and taken into account when solving. </description> </method> <method name="set_ccdik_joint_rotate_from_joint"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="rotate_from_joint" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="rotate_from_joint" type="bool" /> <description> Sets whether the joint at [code]joint_idx[/code] is set to rotate from the joint, [code]true[/code], or to rotate from the tip, [code]false[/code]. </description> diff --git a/doc/classes/SkeletonModification2DFABRIK.xml b/doc/classes/SkeletonModification2DFABRIK.xml index 883d4aa04b..3108a55deb 100644 --- a/doc/classes/SkeletonModification2DFABRIK.xml +++ b/doc/classes/SkeletonModification2DFABRIK.xml @@ -15,60 +15,60 @@ <methods> <method name="get_fabrik_joint_bone2d_node" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_bone_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the index of the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_magnet_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the magnet position vector for the joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_use_target_rotation" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns whether the joint is using the target's rotation rather than allowing FABRIK to rotate the joint. This option only applies to the tip/final joint in the chain. </description> </method> <method name="set_fabrik_joint_bone2d_node"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone2d_nodepath" type="NodePath" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone2d_nodepath" type="NodePath" /> <description> Sets the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="set_fabrik_joint_bone_index"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_idx" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the FABRIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone2d_node[/code] of the FABRIK joint based on data provided by the linked skeleton. </description> </method> <method name="set_fabrik_joint_magnet_position"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="magnet_position" type="Vector2" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="magnet_position" type="Vector2" /> <description> Sets the magnet position vector for the joint at [code]joint_idx[/code]. </description> </method> <method name="set_fabrik_joint_use_target_rotation"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="use_target_rotation" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="use_target_rotation" type="bool" /> <description> Sets whether the joint at [code]joint_idx[/code] will use the target node's rotation rather than letting FABRIK rotate the node. [b]Note:[/b] This option only works for the tip/final joint in the chain. For all other nodes, this option will be ignored. diff --git a/doc/classes/SkeletonModification2DJiggle.xml b/doc/classes/SkeletonModification2DJiggle.xml index 9948239eb8..0fadf6e6c2 100644 --- a/doc/classes/SkeletonModification2DJiggle.xml +++ b/doc/classes/SkeletonModification2DJiggle.xml @@ -19,56 +19,56 @@ </method> <method name="get_jiggle_joint_bone2d_node" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_bone_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the index of the [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_damping" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the amount of damping of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_gravity" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns a [Vector2] representing the amount of gravity the Jiggle joint at [code]joint_idx[/code] is influenced by. </description> </method> <method name="get_jiggle_joint_mass" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the amount of mass of the jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is overriding the default Jiggle joint data defined in the modification. </description> </method> <method name="get_jiggle_joint_stiffness" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the stiffness of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_use_gravity" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is using gravity or not. </description> @@ -81,78 +81,78 @@ </method> <method name="set_collision_mask"> <return type="void" /> - <argument index="0" name="collision_mask" type="int" /> + <param index="0" name="collision_mask" type="int" /> <description> Sets the collision mask that the Jiggle modifier will use when reacting to colliders, if the Jiggle modifier is set to take colliders into account. </description> </method> <method name="set_jiggle_joint_bone2d_node"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone2d_node" type="NodePath" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone2d_node" type="NodePath" /> <description> Sets the [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_bone_index"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_idx" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the Jiggle joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone2d_node[/code] of the Jiggle joint based on data provided by the linked skeleton. </description> </method> <method name="set_jiggle_joint_damping"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="damping" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="damping" type="float" /> <description> Sets the amount of dampening of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_gravity"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="gravity" type="Vector2" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="gravity" type="Vector2" /> <description> Sets the gravity vector of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_mass"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="mass" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="mass" type="float" /> <description> Sets the of mass of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_override"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="override" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="override" type="bool" /> <description> Sets whether the Jiggle joint at [code]joint_idx[/code] should override the default Jiggle joint settings. Setting this to [code]true[/code] will make the joint use its own settings rather than the default ones attached to the modification. </description> </method> <method name="set_jiggle_joint_stiffness"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="stiffness" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="stiffness" type="float" /> <description> Sets the of stiffness of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_use_gravity"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="use_gravity" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="use_gravity" type="bool" /> <description> Sets whether the Jiggle joint at [code]joint_idx[/code] should use gravity. </description> </method> <method name="set_use_colliders"> <return type="void" /> - <argument index="0" name="use_colliders" type="bool" /> + <param index="0" name="use_colliders" type="bool" /> <description> If [code]true[/code], the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects. </description> diff --git a/doc/classes/SkeletonModification2DLookAt.xml b/doc/classes/SkeletonModification2DLookAt.xml index 802801fbef..4747b06056 100644 --- a/doc/classes/SkeletonModification2DLookAt.xml +++ b/doc/classes/SkeletonModification2DLookAt.xml @@ -41,14 +41,14 @@ </method> <method name="set_additional_rotation"> <return type="void" /> - <argument index="0" name="rotation" type="float" /> + <param index="0" name="rotation" type="float" /> <description> Sets the amount of additional rotation that is to be applied after executing the modification. This allows for offsetting the results by the inputted rotation amount. </description> </method> <method name="set_constraint_angle_invert"> <return type="void" /> - <argument index="0" name="invert" type="bool" /> + <param index="0" name="invert" type="bool" /> <description> When [code]true[/code], the modification will use an inverted joint constraint. An inverted joint constraint only constraints the [Bone2D] to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values. @@ -56,21 +56,21 @@ </method> <method name="set_constraint_angle_max"> <return type="void" /> - <argument index="0" name="angle_max" type="float" /> + <param index="0" name="angle_max" type="float" /> <description> Sets the constraint's maximum allowed angle. </description> </method> <method name="set_constraint_angle_min"> <return type="void" /> - <argument index="0" name="angle_min" type="float" /> + <param index="0" name="angle_min" type="float" /> <description> Sets the constraint's minimum allowed angle. </description> </method> <method name="set_enable_constraint"> <return type="void" /> - <argument index="0" name="enable_constraint" type="bool" /> + <param index="0" name="enable_constraint" type="bool" /> <description> Sets whether this modification will use constraints or not. When [code]true[/code], constraints will be applied when solving the LookAt modification. </description> diff --git a/doc/classes/SkeletonModification2DPhysicalBones.xml b/doc/classes/SkeletonModification2DPhysicalBones.xml index 9fb7b6d215..9ddb34a5d0 100644 --- a/doc/classes/SkeletonModification2DPhysicalBones.xml +++ b/doc/classes/SkeletonModification2DPhysicalBones.xml @@ -17,15 +17,15 @@ </method> <method name="get_physical_bone_node" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the [PhysicalBone2D] node at [code]joint_idx[/code]. </description> </method> <method name="set_physical_bone_node"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="physicalbone2d_node" type="NodePath" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="physicalbone2d_node" type="NodePath" /> <description> Sets the [PhysicalBone2D] node at [code]joint_idx[/code]. [b]Note:[/b] This is just the index used for this modification, not the bone index used in the [Skeleton2D]. @@ -33,7 +33,7 @@ </method> <method name="start_simulation"> <return type="void" /> - <argument index="0" name="bones" type="StringName[]" default="[]" /> + <param index="0" name="bones" type="StringName[]" default="[]" /> <description> Tell the [PhysicalBone2D] nodes to start simulating and interacting with the physics world. Optionally, an array of bone names can be passed to this function, and that will cause only [PhysicalBone2D] nodes with those names to start simulating. @@ -41,7 +41,7 @@ </method> <method name="stop_simulation"> <return type="void" /> - <argument index="0" name="bones" type="StringName[]" default="[]" /> + <param index="0" name="bones" type="StringName[]" default="[]" /> <description> Tell the [PhysicalBone2D] nodes to stop simulating and interacting with the physics world. Optionally, an array of bone names can be passed to this function, and that will cause only [PhysicalBone2D] nodes with those names to stop simulating. diff --git a/doc/classes/SkeletonModification2DStackHolder.xml b/doc/classes/SkeletonModification2DStackHolder.xml index f66f88d6b5..791dea2fb1 100644 --- a/doc/classes/SkeletonModification2DStackHolder.xml +++ b/doc/classes/SkeletonModification2DStackHolder.xml @@ -18,7 +18,7 @@ </method> <method name="set_held_modification_stack"> <return type="void" /> - <argument index="0" name="held_modification_stack" type="SkeletonModificationStack2D" /> + <param index="0" name="held_modification_stack" type="SkeletonModificationStack2D" /> <description> Sets the [SkeletonModificationStack2D] that this modification is holding. This modification stack will then be executed when this modification is executed. </description> diff --git a/doc/classes/SkeletonModification2DTwoBoneIK.xml b/doc/classes/SkeletonModification2DTwoBoneIK.xml index 956e94dce8..edd5431a0c 100644 --- a/doc/classes/SkeletonModification2DTwoBoneIK.xml +++ b/doc/classes/SkeletonModification2DTwoBoneIK.xml @@ -36,28 +36,28 @@ </method> <method name="set_joint_one_bone2d_node"> <return type="void" /> - <argument index="0" name="bone2d_node" type="NodePath" /> + <param index="0" name="bone2d_node" type="NodePath" /> <description> Sets the [Bone2D] node that is being used as the first bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_one_bone_idx"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Sets the index of the [Bone2D] node that is being used as the first bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_two_bone2d_node"> <return type="void" /> - <argument index="0" name="bone2d_node" type="NodePath" /> + <param index="0" name="bone2d_node" type="NodePath" /> <description> Sets the [Bone2D] node that is being used as the second bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_two_bone_idx"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Sets the index of the [Bone2D] node that is being used as the second bone in the TwoBoneIK modification. </description> diff --git a/doc/classes/SkeletonModification3D.xml b/doc/classes/SkeletonModification3D.xml index b21c9a2be9..9a6e72baaf 100644 --- a/doc/classes/SkeletonModification3D.xml +++ b/doc/classes/SkeletonModification3D.xml @@ -12,14 +12,14 @@ <methods> <method name="_execute" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Executes the given modification. This is where the modification performs whatever function it is designed to do. </description> </method> <method name="_setup_modification" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="modification_stack" type="SkeletonModificationStack3D" /> + <param index="0" name="modification_stack" type="SkeletonModificationStack3D" /> <description> Sets up the modification so it can be executed. This function should be called automatically by the [SkeletonModificationStack3D] containing this modification. If you need to initialize a modification before use, this is the place to do it! @@ -27,10 +27,10 @@ </method> <method name="clamp_angle"> <return type="float" /> - <argument index="0" name="angle" type="float" /> - <argument index="1" name="min" type="float" /> - <argument index="2" name="max" type="float" /> - <argument index="3" name="invert" type="bool" /> + <param index="0" name="angle" type="float" /> + <param index="1" name="min" type="float" /> + <param index="2" name="max" type="float" /> + <param index="3" name="invert" type="bool" /> <description> Takes a angle and clamps it so it is within the passed-in [code]min[/code] and [code]max[/code] range. [code]invert[/code] will inversely clamp the angle, clamping it to the range outside of the given bounds. </description> @@ -49,7 +49,7 @@ </method> <method name="set_is_setup"> <return type="void" /> - <argument index="0" name="is_setup" type="bool" /> + <param index="0" name="is_setup" type="bool" /> <description> Manually allows you to set the setup state of the modification. This function should only rarely be used, as the [SkeletonModificationStack3D] the modification is bound to should handle setting the modification up. </description> diff --git a/doc/classes/SkeletonModification3DCCDIK.xml b/doc/classes/SkeletonModification3DCCDIK.xml index 6f5409ed4d..fbefca32ad 100644 --- a/doc/classes/SkeletonModification3DCCDIK.xml +++ b/doc/classes/SkeletonModification3DCCDIK.xml @@ -14,97 +14,97 @@ <methods> <method name="get_ccdik_joint_bone_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the bone index of the bone assigned to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_bone_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the name of the bone that is assigned to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_ccdik_axis" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the integer representing the joint axis of the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_constraint_angle_max" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the maximum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle is in degrees! </description> </method> <method name="get_ccdik_joint_constraint_angle_min" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the minimum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle is in degrees! </description> </method> <method name="get_ccdik_joint_constraint_invert" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. See [method set_ccdik_joint_constraint_invert] for details. </description> </method> <method name="get_ccdik_joint_enable_joint_constraint" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Enables angle constraints to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="set_ccdik_joint_bone_index"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_index" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_index" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_name[/code] of the CCDIK joint based on data provided by the linked skeleton. </description> </method> <method name="set_ccdik_joint_bone_name"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_name" type="String" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_name" type="String" /> <description> Sets the bone name, [code]bone_name[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_index[/code] of the CCDIK joint based on data provided by the linked skeleton. </description> </method> <method name="set_ccdik_joint_ccdik_axis"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="axis" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="axis" type="int" /> <description> Sets the joint axis of the CCDIK joint at [code]joint_idx[/code] to the passed-in joint axis, [code]axis[/code]. </description> </method> <method name="set_ccdik_joint_constraint_angle_max"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="max_angle" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="max_angle" type="float" /> <description> Sets the maximum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle must be in radians! </description> </method> <method name="set_ccdik_joint_constraint_angle_min"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="min_angle" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="min_angle" type="float" /> <description> Sets the minimum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle must be in radians! </description> </method> <method name="set_ccdik_joint_constraint_invert"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="invert" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="invert" type="bool" /> <description> Sets whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. An inverted joint constraint only constraints the CCDIK joint to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values. @@ -112,8 +112,8 @@ </method> <method name="set_ccdik_joint_enable_joint_constraint"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="enable" type="bool" /> <description> Sets whether joint constraints are enabled for the CCDIK joint at [code]joint_idx[/code]. </description> diff --git a/doc/classes/SkeletonModification3DFABRIK.xml b/doc/classes/SkeletonModification3DFABRIK.xml index 41f78fab41..5908f94650 100644 --- a/doc/classes/SkeletonModification3DFABRIK.xml +++ b/doc/classes/SkeletonModification3DFABRIK.xml @@ -15,56 +15,56 @@ <methods> <method name="fabrik_joint_auto_calculate_length"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Will attempt to automatically calculate the length of the bone assigned to the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_auto_calculate_length" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns a boolean that indicates whether this modification will attempt to autocalculate the length of the bone assigned to the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_bone_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the bone index of the bone assigned to the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_bone_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the name of the bone that is assigned to the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_length" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the length of the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_magnet" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the magnet vector of the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_fabrik_joint_tip_node" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the [Node3D]-based node placed at the tip of the FABRIK joint at [code]joint_idx[/code], if one has been set. </description> </method> <method name="get_fabrik_joint_use_target_basis" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns a boolean indicating whether the FABRIK joint uses the target's [Basis] for its rotation. [b]Note:[/b] This option is only available for the final bone in the FABRIK chain, with this setting being ignored for all other bones. @@ -72,55 +72,55 @@ </method> <method name="get_fabrik_joint_use_tip_node" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Sets the [Node3D]-based node that will be used as the tip of the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="set_fabrik_joint_auto_calculate_length"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="auto_calculate_length" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="auto_calculate_length" type="bool" /> <description> When [code]true[/code], this modification will attempt to automatically calculate the length of the bone for the FABRIK joint at [code]joint_idx[/code]. It does this by either using the tip node assigned, if there is one assigned, or the distance the of the bone's children, if the bone has any. If the bone has no children and no tip node is assigned, then the modification [b]cannot[/b] autocalculate the joint's length. In this case, the joint length should be entered manually or a tip node assigned. </description> </method> <method name="set_fabrik_joint_bone_index"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_index" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_index" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the FABRIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_name[/code] of the FABRIK joint based on data provided by the [Skeleton3D]. </description> </method> <method name="set_fabrik_joint_bone_name"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_name" type="String" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_name" type="String" /> <description> Sets the bone name, [code]bone_name[/code], of the FABRIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_index[/code] of the FABRIK joint based on data provided by the [Skeleton3D]. </description> </method> <method name="set_fabrik_joint_length"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="length" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="length" type="float" /> <description> Sets the joint length, [code]length[/code], of the FABRIK joint at [code]joint_idx[/code]. </description> </method> <method name="set_fabrik_joint_magnet"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="magnet_position" type="Vector3" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="magnet_position" type="Vector3" /> <description> Sets the magenet position to [code]magnet_position[/code] for the joint at [code]joint_idx[/code]. The magnet position is used to nudge the joint in that direction when solving, which gives some control over how that joint will bend when being solved. </description> </method> <method name="set_fabrik_joint_tip_node"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="tip_node" type="NodePath" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="tip_node" type="NodePath" /> <description> Sets the nodepath of the FARIK joint at [code]joint_idx[/code] to [code]tip_node[/code]. The tip node is used to calculate the length of the FABRIK joint when set to automatically calculate joint length. [b]Note:[/b] The tip node should generally be a child node of a [BoneAttachment3D] node attached to the bone that this FABRIK joint operates on, with the child node being offset so it is at the end of the bone. @@ -128,8 +128,8 @@ </method> <method name="set_fabrik_joint_use_target_basis"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="use_target_basis" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="use_target_basis" type="bool" /> <description> Sets whether the FABRIK joint at [code]joint_idx[/code] uses the target's [Basis] for its rotation. [b]Note:[/b] This option is only available for the final bone in the FABRIK chain, with this setting being ignored for all other bones. @@ -137,8 +137,8 @@ </method> <method name="set_fabrik_joint_use_tip_node"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="use_tip_node" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="use_tip_node" type="bool" /> <description> Sets whether the tip node should be used when autocalculating the joint length for the FABRIK joint at [code]joint_idx[/code]. This will only work if there is a node assigned to the tip nodepath for this joint. </description> diff --git a/doc/classes/SkeletonModification3DJiggle.xml b/doc/classes/SkeletonModification3DJiggle.xml index 697de4a580..ddbd5b4274 100644 --- a/doc/classes/SkeletonModification3DJiggle.xml +++ b/doc/classes/SkeletonModification3DJiggle.xml @@ -19,63 +19,63 @@ </method> <method name="get_jiggle_joint_bone_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the bone index of the bone assigned to the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_bone_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the name of the bone that is assigned to the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_damping" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the amount of dampening of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_gravity" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns a [Vector3] representign the amount of gravity the Jiggle joint at [code]joint_idx[/code] is influenced by. </description> </method> <method name="get_jiggle_joint_mass" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the amount of mass of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is overriding the default jiggle joint data defined in the modification. </description> </method> <method name="get_jiggle_joint_roll" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the amount of roll/twist applied to the bone that the Jiggle joint is applied to. </description> </method> <method name="get_jiggle_joint_stiffness" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns the stiffness of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="get_jiggle_joint_use_gravity" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is using gravity or not. </description> @@ -88,86 +88,86 @@ </method> <method name="set_collision_mask"> <return type="void" /> - <argument index="0" name="mask" type="int" /> + <param index="0" name="mask" type="int" /> <description> Sets the collision mask that the Jiggle modifier takes into account when performing physics calculations. </description> </method> <method name="set_jiggle_joint_bone_index"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_idx" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the Jiggle joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_name[/code] of the Jiggle joint based on data provided by the [Skeleton3D]. </description> </method> <method name="set_jiggle_joint_bone_name"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets the bone name, [code]bone_name[/code], of the Jiggle joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_index[/code] of the Jiggle joint based on data provided by the [Skeleton3D]. </description> </method> <method name="set_jiggle_joint_damping"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="damping" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="damping" type="float" /> <description> Sets the amount of dampening of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_gravity"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="gravity" type="Vector3" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="gravity" type="Vector3" /> <description> Sets the gravity vector of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_mass"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="mass" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="mass" type="float" /> <description> Sets the of mass of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_override"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="override" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="override" type="bool" /> <description> Sets whether the Jiggle joint at [code]joint_idx[/code] should override the default Jiggle joint settings. Setting this to true will make the joint use its own settings rather than the default ones attached to the modification. </description> </method> <method name="set_jiggle_joint_roll"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="roll" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="roll" type="float" /> <description> Sets the amount of roll/twist on the bone the Jiggle joint is attached to. </description> </method> <method name="set_jiggle_joint_stiffness"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="stiffness" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="stiffness" type="float" /> <description> Sets the of stiffness of the Jiggle joint at [code]joint_idx[/code]. </description> </method> <method name="set_jiggle_joint_use_gravity"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="use_gravity" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="use_gravity" type="bool" /> <description> Sets whether the Jiggle joint at [code]joint_idx[/code] should use gravity. </description> </method> <method name="set_use_colliders"> <return type="void" /> - <argument index="0" name="use_colliders" type="bool" /> + <param index="0" name="use_colliders" type="bool" /> <description> When [code]true[/code], the Jiggle modifier will use raycasting to prevent the Jiggle joints from rotating themselves into collision objects when solving. </description> diff --git a/doc/classes/SkeletonModification3DLookAt.xml b/doc/classes/SkeletonModification3DLookAt.xml index 90330c4cf0..3602cfad95 100644 --- a/doc/classes/SkeletonModification3DLookAt.xml +++ b/doc/classes/SkeletonModification3DLookAt.xml @@ -29,20 +29,20 @@ </method> <method name="set_additional_rotation"> <return type="void" /> - <argument index="0" name="additional_rotation" type="Vector3" /> + <param index="0" name="additional_rotation" type="Vector3" /> <description> Sets the amount of extra rotation to be applied after the LookAt modification executes. This allows you to adjust the finished result. </description> </method> <method name="set_lock_rotation_plane"> <return type="void" /> - <argument index="0" name="plane" type="int" /> + <param index="0" name="plane" type="int" /> <description> </description> </method> <method name="set_lock_rotation_to_plane"> <return type="void" /> - <argument index="0" name="lock_to_plane" type="bool" /> + <param index="0" name="lock_to_plane" type="bool" /> <description> When [code]true[/code], the LookAt modification will limit its rotation to a single plane in 3D space. The plane used can be configured using the [code]set_lock_rotation_plane[/code] function. </description> diff --git a/doc/classes/SkeletonModification3DStackHolder.xml b/doc/classes/SkeletonModification3DStackHolder.xml index d5ed770fc0..24240236a4 100644 --- a/doc/classes/SkeletonModification3DStackHolder.xml +++ b/doc/classes/SkeletonModification3DStackHolder.xml @@ -18,7 +18,7 @@ </method> <method name="set_held_modification_stack"> <return type="void" /> - <argument index="0" name="held_modification_stack" type="SkeletonModificationStack3D" /> + <param index="0" name="held_modification_stack" type="SkeletonModificationStack3D" /> <description> Sets the [SkeletonModificationStack3D] that this modification is holding. This modification stack will then be executed when this modification is executed. </description> diff --git a/doc/classes/SkeletonModification3DTwoBoneIK.xml b/doc/classes/SkeletonModification3DTwoBoneIK.xml index 0576591e2e..2fd7afc360 100644 --- a/doc/classes/SkeletonModification3DTwoBoneIK.xml +++ b/doc/classes/SkeletonModification3DTwoBoneIK.xml @@ -91,7 +91,7 @@ </method> <method name="set_auto_calculate_joint_length"> <return type="void" /> - <argument index="0" name="auto_calculate_joint_length" type="bool" /> + <param index="0" name="auto_calculate_joint_length" type="bool" /> <description> If true, the TwoBoneIK modification will attempt to autocalculate the lengths of the bones being used. The first bone will be calculated by using the distance from the origin of the first bone to the origin of the second bone. The second bone will be calculated either using the tip node if that setting is enabled, or by using the distances of the second bone's children. If the tip node is not enabled and the bone has no children, then the length cannot be autocalculated. In this case, the length will either have to be manually inputted or a tip node used to calculate the length. @@ -99,70 +99,70 @@ </method> <method name="set_joint_one_bone_idx"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the first bone. When possible, this will also update the [code]bone_name[/code] of the first bone based on data provided by the [Skeleton3D]. </description> </method> <method name="set_joint_one_bone_name"> <return type="void" /> - <argument index="0" name="bone_name" type="String" /> + <param index="0" name="bone_name" type="String" /> <description> Sets the bone name, [code]bone_name[/code], of the first bone. When possible, this will also update the [code]bone_index[/code] of the first bone based on data provided by the [Skeleton3D]. </description> </method> <method name="set_joint_one_length"> <return type="void" /> - <argument index="0" name="bone_length" type="float" /> + <param index="0" name="bone_length" type="float" /> <description> Sets the length of the first bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_one_roll"> <return type="void" /> - <argument index="0" name="roll" type="float" /> + <param index="0" name="roll" type="float" /> <description> Sets the amount of roll/twist applied to the first bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_two_bone_idx"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the second bone. When possible, this will also update the [code]bone_name[/code] of the second bone based on data provided by the [Skeleton3D]. </description> </method> <method name="set_joint_two_bone_name"> <return type="void" /> - <argument index="0" name="bone_name" type="String" /> + <param index="0" name="bone_name" type="String" /> <description> Sets the bone name, [code]bone_name[/code], of the second bone. When possible, this will also update the [code]bone_index[/code] of the second bone based on data provided by the [Skeleton3D]. </description> </method> <method name="set_joint_two_length"> <return type="void" /> - <argument index="0" name="bone_length" type="float" /> + <param index="0" name="bone_length" type="float" /> <description> Sets the length of the second bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_two_roll"> <return type="void" /> - <argument index="0" name="roll" type="float" /> + <param index="0" name="roll" type="float" /> <description> Sets the amount of roll/twist applied to the second bone in the TwoBoneIK modification. </description> </method> <method name="set_pole_node"> <return type="void" /> - <argument index="0" name="pole_nodepath" type="NodePath" /> + <param index="0" name="pole_nodepath" type="NodePath" /> <description> Sets the node to be used as the for the pole of the TwoBoneIK. When a node is set and the modification is set to use the pole node, the TwoBoneIK modification will bend the nodes in the direction towards this node when the bones need to bend. </description> </method> <method name="set_tip_node"> <return type="void" /> - <argument index="0" name="tip_nodepath" type="NodePath" /> + <param index="0" name="tip_nodepath" type="NodePath" /> <description> Sets the node to be used as the tip for the second bone. This is used to calculate the length and position of the end of the second bone in the TwoBoneIK modification. [b]Note:[/b] The tip node should generally be a child node of a [BoneAttachment3D] node attached to the second bone, with the child node being offset so it is at the end of the bone. @@ -170,14 +170,14 @@ </method> <method name="set_use_pole_node"> <return type="void" /> - <argument index="0" name="use_pole_node" type="bool" /> + <param index="0" name="use_pole_node" type="bool" /> <description> When [code]true[/code], the TwoBoneIK modification will bend the bones towards the pole node, if one has been set. This gives control over the direction the TwoBoneIK solver will bend, which is helpful for joints like elbows that only bend in certain directions. </description> </method> <method name="set_use_tip_node"> <return type="void" /> - <argument index="0" name="use_tip_node" type="bool" /> + <param index="0" name="use_tip_node" type="bool" /> <description> When [code]true[/code], the TwoBoneIK modification will use the tip node to calculate the distance and position of the end/tip of the second bone. This is the most stable solution for knowing the tip position and length of the second bone. </description> diff --git a/doc/classes/SkeletonModificationStack2D.xml b/doc/classes/SkeletonModificationStack2D.xml index 9ddb8856ce..d752323231 100644 --- a/doc/classes/SkeletonModificationStack2D.xml +++ b/doc/classes/SkeletonModificationStack2D.xml @@ -13,29 +13,29 @@ <methods> <method name="add_modification"> <return type="void" /> - <argument index="0" name="modification" type="SkeletonModification2D" /> + <param index="0" name="modification" type="SkeletonModification2D" /> <description> Adds the passed-in [SkeletonModification2D] to the stack. </description> </method> <method name="delete_modification"> <return type="void" /> - <argument index="0" name="mod_idx" type="int" /> + <param index="0" name="mod_idx" type="int" /> <description> Deletes the [SkeletonModification2D] at the index position [code]mod_idx[/code], if it exists. </description> </method> <method name="enable_all_modifications"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Enables all [SkeletonModification2D]s in the stack. </description> </method> <method name="execute"> <return type="void" /> - <argument index="0" name="delta" type="float" /> - <argument index="1" name="execution_mode" type="int" /> + <param index="0" name="delta" type="float" /> + <param index="1" name="execution_mode" type="int" /> <description> Executes all of the [SkeletonModification2D]s in the stack that use the same execution mode as the passed-in [code]execution_mode[/code], starting from index [code]0[/code] to [member modification_count]. [b]Note:[/b] The order of the modifications can matter depending on the modifications. For example, modifications on a spine should operate before modifications on the arms in order to get proper results. @@ -49,7 +49,7 @@ </method> <method name="get_modification" qualifiers="const"> <return type="SkeletonModification2D" /> - <argument index="0" name="mod_idx" type="int" /> + <param index="0" name="mod_idx" type="int" /> <description> Returns the [SkeletonModification2D] at the passed-in index, [code]mod_idx[/code]. </description> @@ -62,8 +62,8 @@ </method> <method name="set_modification"> <return type="void" /> - <argument index="0" name="mod_idx" type="int" /> - <argument index="1" name="modification" type="SkeletonModification2D" /> + <param index="0" name="mod_idx" type="int" /> + <param index="1" name="modification" type="SkeletonModification2D" /> <description> Sets the modification at [code]mod_idx[/code] to the passed-in modification, [code]modification[/code]. </description> diff --git a/doc/classes/SkeletonModificationStack3D.xml b/doc/classes/SkeletonModificationStack3D.xml index fc952f6864..010c2181e7 100644 --- a/doc/classes/SkeletonModificationStack3D.xml +++ b/doc/classes/SkeletonModificationStack3D.xml @@ -12,29 +12,29 @@ <methods> <method name="add_modification"> <return type="void" /> - <argument index="0" name="modification" type="SkeletonModification3D" /> + <param index="0" name="modification" type="SkeletonModification3D" /> <description> Adds the passed-in [SkeletonModification3D] to the stack. </description> </method> <method name="delete_modification"> <return type="void" /> - <argument index="0" name="mod_idx" type="int" /> + <param index="0" name="mod_idx" type="int" /> <description> Deletes the [SkeletonModification3D] at the index position [code]mod_idx[/code], if it exists. </description> </method> <method name="enable_all_modifications"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Enables all [SkeletonModification3D]s in the stack. </description> </method> <method name="execute"> <return type="void" /> - <argument index="0" name="delta" type="float" /> - <argument index="1" name="execution_mode" type="int" /> + <param index="0" name="delta" type="float" /> + <param index="1" name="execution_mode" type="int" /> <description> Executes all of the [SkeletonModification3D]s in the stack that use the same execution mode as the passed-in [code]execution_mode[/code], starting from index [code]0[/code] to [member modification_count]. [b]Note:[/b] The order of the modifications can matter depending on the modifications. For example, modifications on a spine should operate before modifications on the arms in order to get proper results. @@ -48,7 +48,7 @@ </method> <method name="get_modification" qualifiers="const"> <return type="SkeletonModification3D" /> - <argument index="0" name="mod_idx" type="int" /> + <param index="0" name="mod_idx" type="int" /> <description> Returns the [SkeletonModification3D] at the passed-in index, [code]mod_idx[/code]. </description> @@ -61,8 +61,8 @@ </method> <method name="set_modification"> <return type="void" /> - <argument index="0" name="mod_idx" type="int" /> - <argument index="1" name="modification" type="SkeletonModification3D" /> + <param index="0" name="mod_idx" type="int" /> + <param index="1" name="modification" type="SkeletonModification3D" /> <description> Sets the modification at [code]mod_idx[/code] to the passed-in modification, [code]modification[/code]. </description> diff --git a/doc/classes/SkeletonProfile.xml b/doc/classes/SkeletonProfile.xml index 5c2d0eefb4..52925c2d41 100644 --- a/doc/classes/SkeletonProfile.xml +++ b/doc/classes/SkeletonProfile.xml @@ -11,14 +11,14 @@ <methods> <method name="find_bone" qualifiers="const"> <return type="int" /> - <argument index="0" name="bone_name" type="StringName" /> + <param index="0" name="bone_name" type="StringName" /> <description> Returns the bone index that matches [code]bone_name[/code] as its name. </description> </method> <method name="get_bone_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the name of the bone at [code]bone_idx[/code] that will be the key name in the [BoneMap]. In the retargeting process, the returned bone name is the bone name of the target skeleton. @@ -26,35 +26,35 @@ </method> <method name="get_bone_parent" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the name of the bone which is the parent to the bone at [code]bone_idx[/code]. The result is empty if the bone has no parent. </description> </method> <method name="get_bone_tail" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the name of the bone which is the tail of the bone at [code]bone_idx[/code]. </description> </method> <method name="get_group" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the group of the bone at [code]bone_idx[/code]. </description> </method> <method name="get_group_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="group_idx" type="int" /> + <param index="0" name="group_idx" type="int" /> <description> Returns the name of the group at [code]group_idx[/code] that will be the drawing group in the [BoneMap] editor. </description> </method> <method name="get_handle_offset" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the offset of the bone at [code]bone_idx[/code] that will be the button position in the [BoneMap] editor. This is the offset with origin at the top left corner of the square. @@ -62,29 +62,29 @@ </method> <method name="get_reference_pose" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the reference pose transform for bone [code]bone_idx[/code]. </description> </method> <method name="get_tail_direction" qualifiers="const"> <return type="int" enum="SkeletonProfile.TailDirection" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> Returns the tail direction of the bone at [code]bone_idx[/code]. </description> </method> <method name="get_texture" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="group_idx" type="int" /> + <param index="0" name="group_idx" type="int" /> <description> Returns the texture of the group at [code]group_idx[/code] that will be the drawing group background image in the [BoneMap] editor. </description> </method> <method name="set_bone_name"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="bone_name" type="StringName" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="bone_name" type="StringName" /> <description> Sets the name of the bone at [code]bone_idx[/code] that will be the key name in the [BoneMap]. In the retargeting process, the setting bone name is the bone name of the target skeleton. @@ -92,40 +92,40 @@ </method> <method name="set_bone_parent"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="bone_parent" type="StringName" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="bone_parent" type="StringName" /> <description> Sets the bone with name [code]bone_parent[/code] as the parent of the bone at [code]bone_idx[/code]. If an empty string is passed, then the bone has no parent. </description> </method> <method name="set_bone_tail"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="bone_tail" type="StringName" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="bone_tail" type="StringName" /> <description> Sets the bone with name [code]bone_tail[/code] as the tail of the bone at [code]bone_idx[/code]. </description> </method> <method name="set_group"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="group" type="StringName" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="group" type="StringName" /> <description> Sets the group of the bone at [code]bone_idx[/code]. </description> </method> <method name="set_group_name"> <return type="void" /> - <argument index="0" name="group_idx" type="int" /> - <argument index="1" name="group_name" type="StringName" /> + <param index="0" name="group_idx" type="int" /> + <param index="1" name="group_name" type="StringName" /> <description> Sets the name of the group at [code]group_idx[/code] that will be the drawing group in the [BoneMap] editor. </description> </method> <method name="set_handle_offset"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="handle_offset" type="Vector2" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="handle_offset" type="Vector2" /> <description> Sets the offset of the bone at [code]bone_idx[/code] that will be the button position in the [BoneMap] editor. This is the offset with origin at the top left corner of the square. @@ -133,16 +133,16 @@ </method> <method name="set_reference_pose"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="bone_name" type="Transform3D" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="bone_name" type="Transform3D" /> <description> Sets the reference pose transform for bone [code]bone_idx[/code]. </description> </method> <method name="set_tail_direction"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="tail_direction" type="int" enum="SkeletonProfile.TailDirection" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="tail_direction" type="int" enum="SkeletonProfile.TailDirection" /> <description> Sets the tail direction of the bone at [code]bone_idx[/code]. [b]Note:[/b] This only specifies the method of calculation. The actual coordinates required should be stored in an external skeleton, so the calculation itself needs to be done externally. @@ -150,8 +150,8 @@ </method> <method name="set_texture"> <return type="void" /> - <argument index="0" name="group_idx" type="int" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="group_idx" type="int" /> + <param index="1" name="texture" type="Texture2D" /> <description> Sets the texture of the group at [code]group_idx[/code] that will be the drawing group background image in the [BoneMap] editor. </description> diff --git a/doc/classes/Skin.xml b/doc/classes/Skin.xml index af1af7bad2..ea60bd707d 100644 --- a/doc/classes/Skin.xml +++ b/doc/classes/Skin.xml @@ -9,15 +9,15 @@ <methods> <method name="add_bind"> <return type="void" /> - <argument index="0" name="bone" type="int" /> - <argument index="1" name="pose" type="Transform3D" /> + <param index="0" name="bone" type="int" /> + <param index="1" name="pose" type="Transform3D" /> <description> </description> </method> <method name="add_named_bind"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="pose" type="Transform3D" /> + <param index="0" name="name" type="String" /> + <param index="1" name="pose" type="Transform3D" /> <description> </description> </method> @@ -28,7 +28,7 @@ </method> <method name="get_bind_bone" qualifiers="const"> <return type="int" /> - <argument index="0" name="bind_index" type="int" /> + <param index="0" name="bind_index" type="int" /> <description> </description> </method> @@ -39,40 +39,40 @@ </method> <method name="get_bind_name" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="bind_index" type="int" /> + <param index="0" name="bind_index" type="int" /> <description> </description> </method> <method name="get_bind_pose" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="bind_index" type="int" /> + <param index="0" name="bind_index" type="int" /> <description> </description> </method> <method name="set_bind_bone"> <return type="void" /> - <argument index="0" name="bind_index" type="int" /> - <argument index="1" name="bone" type="int" /> + <param index="0" name="bind_index" type="int" /> + <param index="1" name="bone" type="int" /> <description> </description> </method> <method name="set_bind_count"> <return type="void" /> - <argument index="0" name="bind_count" type="int" /> + <param index="0" name="bind_count" type="int" /> <description> </description> </method> <method name="set_bind_name"> <return type="void" /> - <argument index="0" name="bind_index" type="int" /> - <argument index="1" name="name" type="StringName" /> + <param index="0" name="bind_index" type="int" /> + <param index="1" name="name" type="StringName" /> <description> </description> </method> <method name="set_bind_pose"> <return type="void" /> - <argument index="0" name="bind_index" type="int" /> - <argument index="1" name="pose" type="Transform3D" /> + <param index="0" name="bind_index" type="int" /> + <param index="1" name="pose" type="Transform3D" /> <description> </description> </method> diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index 4139530db1..88ea7f2b49 100644 --- a/doc/classes/Slider.xml +++ b/doc/classes/Slider.xml @@ -25,7 +25,7 @@ </members> <signals> <signal name="drag_ended"> - <argument index="0" name="value_changed" type="bool" /> + <param index="0" name="value_changed" type="bool" /> <description> Emitted when dragging stops. If [code]value_changed[/code] is true, [member Range.value] is different from the value when you started the dragging. </description> diff --git a/doc/classes/SliderJoint3D.xml b/doc/classes/SliderJoint3D.xml index d62cf8aac4..7470f89979 100644 --- a/doc/classes/SliderJoint3D.xml +++ b/doc/classes/SliderJoint3D.xml @@ -11,14 +11,14 @@ <methods> <method name="get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="SliderJoint3D.Param" /> + <param index="0" name="param" type="int" enum="SliderJoint3D.Param" /> <description> </description> </method> <method name="set_param"> <return type="void" /> - <argument index="0" name="param" type="int" enum="SliderJoint3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="SliderJoint3D.Param" /> + <param index="1" name="value" type="float" /> <description> </description> </method> diff --git a/doc/classes/SoftDynamicBody3D.xml b/doc/classes/SoftDynamicBody3D.xml index 86552f30f6..f59df90eca 100644 --- a/doc/classes/SoftDynamicBody3D.xml +++ b/doc/classes/SoftDynamicBody3D.xml @@ -13,7 +13,7 @@ <methods> <method name="add_collision_exception_with"> <return type="void" /> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Adds a body to the list of bodies that this body can't collide with. </description> @@ -26,14 +26,14 @@ </method> <method name="get_collision_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -45,46 +45,46 @@ </method> <method name="get_point_transform"> <return type="Vector3" /> - <argument index="0" name="point_index" type="int" /> + <param index="0" name="point_index" type="int" /> <description> Returns local translation of a vertex in the surface array. </description> </method> <method name="is_point_pinned" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point_index" type="int" /> + <param index="0" name="point_index" type="int" /> <description> Returns [code]true[/code] if vertex is set to pinned. </description> </method> <method name="remove_collision_exception_with"> <return type="void" /> - <argument index="0" name="body" type="Node" /> + <param index="0" name="body" type="Node" /> <description> Removes a body from the list of bodies that this body can't collide with. </description> </method> <method name="set_collision_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_point_pinned"> <return type="void" /> - <argument index="0" name="point_index" type="int" /> - <argument index="1" name="pinned" type="bool" /> - <argument index="2" name="attachment_path" type="NodePath" default="NodePath("")" /> + <param index="0" name="point_index" type="int" /> + <param index="1" name="pinned" type="bool" /> + <param index="2" name="attachment_path" type="NodePath" default="NodePath("")" /> <description> Sets the pinned state of a surface vertex. When set to [code]true[/code], the optional [code]attachment_path[/code] can define a [Node3D] the pinned vertex will be attached to. </description> diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index f2bc65f8df..fb4b9466b5 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -30,7 +30,7 @@ </members> <signals> <signal name="dragged"> - <argument index="0" name="offset" type="int" /> + <param index="0" name="offset" type="int" /> <description> Emitted when the dragger is dragged by user. </description> diff --git a/doc/classes/SpringArm3D.xml b/doc/classes/SpringArm3D.xml index d89b8f4549..29331e3071 100644 --- a/doc/classes/SpringArm3D.xml +++ b/doc/classes/SpringArm3D.xml @@ -14,7 +14,7 @@ <methods> <method name="add_excluded_object"> <return type="void" /> - <argument index="0" name="RID" type="RID" /> + <param index="0" name="RID" type="RID" /> <description> Adds the [PhysicsBody3D] object with the given [RID] to the list of [PhysicsBody3D] objects excluded from the collision check. </description> @@ -33,7 +33,7 @@ </method> <method name="remove_excluded_object"> <return type="bool" /> - <argument index="0" name="RID" type="RID" /> + <param index="0" name="RID" type="RID" /> <description> Removes the given [RID] from the list of [PhysicsBody3D] objects excluded from the collision check. </description> diff --git a/doc/classes/Sprite2D.xml b/doc/classes/Sprite2D.xml index 2edc13a12b..83532721b2 100644 --- a/doc/classes/Sprite2D.xml +++ b/doc/classes/Sprite2D.xml @@ -41,7 +41,7 @@ </method> <method name="is_pixel_opaque" qualifiers="const"> <return type="bool" /> - <argument index="0" name="pos" type="Vector2" /> + <param index="0" name="pos" type="Vector2" /> <description> Returns [code]true[/code], if the pixel at the given position is opaque and [code]false[/code] in other case. [b]Note:[/b] It also returns [code]false[/code], if the sprite's texture is [code]null[/code] or if the given position is invalid. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index bc381578d9..5fa984e7a0 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -17,7 +17,7 @@ </method> <method name="get_draw_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags" /> + <param index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags" /> <description> Returns the value of the specified flag. </description> @@ -30,8 +30,8 @@ </method> <method name="set_draw_flag"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags" /> + <param index="1" name="enabled" type="bool" /> <description> If [code]true[/code], the specified flag will be enabled. See [enum SpriteBase3D.DrawFlags] for a list of flags. </description> diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index 0d423630d4..f063a4c4c2 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -12,23 +12,23 @@ <methods> <method name="add_animation"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> + <param index="0" name="anim" type="StringName" /> <description> Adds a new animation to the library. </description> </method> <method name="add_frame"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> - <argument index="1" name="frame" type="Texture2D" /> - <argument index="2" name="at_position" type="int" default="-1" /> + <param index="0" name="anim" type="StringName" /> + <param index="1" name="frame" type="Texture2D" /> + <param index="2" name="at_position" type="int" default="-1" /> <description> Adds a frame to the given animation. </description> </method> <method name="clear"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> + <param index="0" name="anim" type="StringName" /> <description> Removes all frames from the given animation. </description> @@ -41,7 +41,7 @@ </method> <method name="get_animation_loop" qualifiers="const"> <return type="bool" /> - <argument index="0" name="anim" type="StringName" /> + <param index="0" name="anim" type="StringName" /> <description> Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code]. </description> @@ -54,77 +54,77 @@ </method> <method name="get_animation_speed" qualifiers="const"> <return type="float" /> - <argument index="0" name="anim" type="StringName" /> + <param index="0" name="anim" type="StringName" /> <description> The animation's speed in frames per second. </description> </method> <method name="get_frame" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="anim" type="StringName" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="anim" type="StringName" /> + <param index="1" name="idx" type="int" /> <description> Returns the animation's selected frame. </description> </method> <method name="get_frame_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="anim" type="StringName" /> + <param index="0" name="anim" type="StringName" /> <description> Returns the number of frames in the animation. </description> </method> <method name="has_animation" qualifiers="const"> <return type="bool" /> - <argument index="0" name="anim" type="StringName" /> + <param index="0" name="anim" type="StringName" /> <description> If [code]true[/code], the named animation exists. </description> </method> <method name="remove_animation"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> + <param index="0" name="anim" type="StringName" /> <description> Removes the given animation. </description> </method> <method name="remove_frame"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> - <argument index="1" name="idx" type="int" /> + <param index="0" name="anim" type="StringName" /> + <param index="1" name="idx" type="int" /> <description> Removes the animation's selected frame. </description> </method> <method name="rename_animation"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> - <argument index="1" name="newname" type="StringName" /> + <param index="0" name="anim" type="StringName" /> + <param index="1" name="newname" type="StringName" /> <description> Changes the animation's name to [code]newname[/code]. </description> </method> <method name="set_animation_loop"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> - <argument index="1" name="loop" type="bool" /> + <param index="0" name="anim" type="StringName" /> + <param index="1" name="loop" type="bool" /> <description> If [code]true[/code], the animation will loop. </description> </method> <method name="set_animation_speed"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> - <argument index="1" name="speed" type="float" /> + <param index="0" name="anim" type="StringName" /> + <param index="1" name="speed" type="float" /> <description> The animation's speed in frames per second. </description> </method> <method name="set_frame"> <return type="void" /> - <argument index="0" name="anim" type="StringName" /> - <argument index="1" name="idx" type="int" /> - <argument index="2" name="txt" type="Texture2D" /> + <param index="0" name="anim" type="StringName" /> + <param index="1" name="idx" type="int" /> + <param index="2" name="txt" type="Texture2D" /> <description> Sets the texture of the given frame. </description> diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index bd69867001..7ce38d9d21 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -42,7 +42,7 @@ </method> <method name="get_data"> <return type="Array" /> - <argument index="0" name="bytes" type="int" /> + <param index="0" name="bytes" type="int" /> <description> Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the [code]bytes[/code] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array. </description> @@ -61,14 +61,14 @@ </method> <method name="get_partial_data"> <return type="Array" /> - <argument index="0" name="bytes" type="int" /> + <param index="0" name="bytes" type="int" /> <description> Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array. </description> </method> <method name="get_string"> <return type="String" /> - <argument index="0" name="bytes" type="int" default="-1" /> + <param index="0" name="bytes" type="int" default="-1" /> <description> Gets an ASCII string with byte-length [code]bytes[/code] from the stream. If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_string]. </description> @@ -99,14 +99,14 @@ </method> <method name="get_utf8_string"> <return type="String" /> - <argument index="0" name="bytes" type="int" default="-1" /> + <param index="0" name="bytes" type="int" default="-1" /> <description> Gets an UTF-8 string with byte-length [code]bytes[/code] from the stream (this decodes the string sent as UTF-8). If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string]. </description> </method> <method name="get_var"> <return type="Variant" /> - <argument index="0" name="allow_objects" type="bool" default="false" /> + <param index="0" name="allow_objects" type="bool" default="false" /> <description> Gets a Variant from the stream. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -114,63 +114,63 @@ </method> <method name="put_16"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Puts a signed 16-bit value into the stream. </description> </method> <method name="put_32"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Puts a signed 32-bit value into the stream. </description> </method> <method name="put_64"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Puts a signed 64-bit value into the stream. </description> </method> <method name="put_8"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Puts a signed byte into the stream. </description> </method> <method name="put_data"> <return type="int" enum="Error" /> - <argument index="0" name="data" type="PackedByteArray" /> + <param index="0" name="data" type="PackedByteArray" /> <description> Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an [enum @GlobalScope.Error] code. </description> </method> <method name="put_double"> <return type="void" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Puts a double-precision float into the stream. </description> </method> <method name="put_float"> <return type="void" /> - <argument index="0" name="value" type="float" /> + <param index="0" name="value" type="float" /> <description> Puts a single-precision float into the stream. </description> </method> <method name="put_partial_data"> <return type="Array" /> - <argument index="0" name="data" type="PackedByteArray" /> + <param index="0" name="data" type="PackedByteArray" /> <description> Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an [enum @GlobalScope.Error] code and an integer, describing how much data was actually sent. </description> </method> <method name="put_string"> <return type="void" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. [b]Note:[/b] To put an ASCII string without prepending its size, you can use [method put_data]: @@ -186,35 +186,35 @@ </method> <method name="put_u16"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Puts an unsigned 16-bit value into the stream. </description> </method> <method name="put_u32"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Puts an unsigned 32-bit value into the stream. </description> </method> <method name="put_u64"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Puts an unsigned 64-bit value into the stream. </description> </method> <method name="put_u8"> <return type="void" /> - <argument index="0" name="value" type="int" /> + <param index="0" name="value" type="int" /> <description> Puts an unsigned byte into the stream. </description> </method> <method name="put_utf8_string"> <return type="void" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. [b]Note:[/b] To put an UTF-8 string without prepending its size, you can use [method put_data]: @@ -230,8 +230,8 @@ </method> <method name="put_var"> <return type="void" /> - <argument index="0" name="value" type="Variant" /> - <argument index="1" name="full_objects" type="bool" default="false" /> + <param index="0" name="value" type="Variant" /> + <param index="1" name="full_objects" type="bool" default="false" /> <description> Puts a Variant into the stream. If [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). </description> diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index de725aef5b..ee603360fa 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -36,14 +36,14 @@ </method> <method name="resize"> <return type="void" /> - <argument index="0" name="size" type="int" /> + <param index="0" name="size" type="int" /> <description> Resizes the [member data_array]. This [i]doesn't[/i] update the cursor. </description> </method> <method name="seek"> <return type="void" /> - <argument index="0" name="position" type="int" /> + <param index="0" name="position" type="int" /> <description> Moves the cursor to the specified position. [code]position[/code] must be a valid index of [member data_array]. </description> diff --git a/doc/classes/StreamPeerExtension.xml b/doc/classes/StreamPeerExtension.xml index a3a08c530c..46783de275 100644 --- a/doc/classes/StreamPeerExtension.xml +++ b/doc/classes/StreamPeerExtension.xml @@ -14,33 +14,33 @@ </method> <method name="_get_data" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="r_buffer" type="uint8_t*" /> - <argument index="1" name="r_bytes" type="int" /> - <argument index="2" name="r_received" type="int32_t*" /> + <param index="0" name="r_buffer" type="uint8_t*" /> + <param index="1" name="r_bytes" type="int" /> + <param index="2" name="r_received" type="int32_t*" /> <description> </description> </method> <method name="_get_partial_data" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="r_buffer" type="uint8_t*" /> - <argument index="1" name="r_bytes" type="int" /> - <argument index="2" name="r_received" type="int32_t*" /> + <param index="0" name="r_buffer" type="uint8_t*" /> + <param index="1" name="r_bytes" type="int" /> + <param index="2" name="r_received" type="int32_t*" /> <description> </description> </method> <method name="_put_data" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_data" type="const uint8_t*" /> - <argument index="1" name="p_bytes" type="int" /> - <argument index="2" name="r_sent" type="int32_t*" /> + <param index="0" name="p_data" type="const uint8_t*" /> + <param index="1" name="p_bytes" type="int" /> + <param index="2" name="r_sent" type="int32_t*" /> <description> </description> </method> <method name="_put_partial_data" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_data" type="const uint8_t*" /> - <argument index="1" name="p_bytes" type="int" /> - <argument index="2" name="r_sent" type="int32_t*" /> + <param index="0" name="p_data" type="const uint8_t*" /> + <param index="1" name="p_bytes" type="int" /> + <param index="2" name="r_sent" type="int32_t*" /> <description> </description> </method> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 70762cbf6c..dd571226b8 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -13,20 +13,20 @@ <methods> <method name="accept_stream"> <return type="int" enum="Error" /> - <argument index="0" name="stream" type="StreamPeer" /> - <argument index="1" name="private_key" type="CryptoKey" /> - <argument index="2" name="certificate" type="X509Certificate" /> - <argument index="3" name="chain" type="X509Certificate" default="null" /> + <param index="0" name="stream" type="StreamPeer" /> + <param index="1" name="private_key" type="CryptoKey" /> + <param index="2" name="certificate" type="X509Certificate" /> + <param index="3" name="chain" type="X509Certificate" default="null" /> <description> Accepts a peer connection as a server using the given [code]private_key[/code] and providing the given [code]certificate[/code] to the client. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. </description> </method> <method name="connect_to_stream"> <return type="int" enum="Error" /> - <argument index="0" name="stream" type="StreamPeer" /> - <argument index="1" name="validate_certs" type="bool" default="false" /> - <argument index="2" name="for_hostname" type="String" default="""" /> - <argument index="3" name="valid_certificate" type="X509Certificate" default="null" /> + <param index="0" name="stream" type="StreamPeer" /> + <param index="1" name="validate_certs" type="bool" default="false" /> + <param index="2" name="for_hostname" type="String" default="""" /> + <param index="3" name="valid_certificate" type="X509Certificate" default="null" /> <description> Connects to a peer using an underlying [StreamPeer] [code]stream[/code]. If [code]validate_certs[/code] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [code]for_hostname[/code]. [b]Note:[/b] Specifying a custom [code]valid_certificate[/code] is not supported in HTML5 exports due to browsers restrictions. diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index f06cf5c7a2..58f3a0e8db 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -12,8 +12,8 @@ <methods> <method name="bind"> <return type="int" enum="Error" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="host" type="String" default=""*"" /> + <param index="0" name="port" type="int" /> + <param index="1" name="host" type="String" default=""*"" /> <description> Opens the TCP socket, and binds it to the specified local address. This method is generally not needed, and only used to force the subsequent call to [method connect_to_host] to use the specified [code]host[/code] and [code]port[/code] as source address. This can be desired in some NAT punchthrough techniques, or when forcing the source network interface. @@ -21,8 +21,8 @@ </method> <method name="connect_to_host"> <return type="int" enum="Error" /> - <argument index="0" name="host" type="String" /> - <argument index="1" name="port" type="int" /> + <param index="0" name="host" type="String" /> + <param index="1" name="port" type="int" /> <description> Connects to the specified [code]host:port[/code] pair. A hostname will be resolved if valid. Returns [constant OK] on success. </description> @@ -65,7 +65,7 @@ </method> <method name="set_no_delay"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> If [code]enabled[/code] is [code]true[/code], packets will be sent immediately. If [code]enabled[/code] is [code]false[/code] (the default), packet transfers will be delayed and combined using [url=https://en.wikipedia.org/wiki/Nagle%27s_algorithm]Nagle's algorithm[/url]. [b]Note:[/b] It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 35ad5f03ab..06579ec49e 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -18,21 +18,21 @@ </constructor> <constructor name="String"> <return type="String" /> - <argument index="0" name="from" type="String" /> + <param index="0" name="from" type="String" /> <description> Constructs a [String] as a copy of the given [String]. </description> </constructor> <constructor name="String"> <return type="String" /> - <argument index="0" name="from" type="NodePath" /> + <param index="0" name="from" type="NodePath" /> <description> Constructs a new String from the given [NodePath]. </description> </constructor> <constructor name="String"> <return type="String" /> - <argument index="0" name="from" type="StringName" /> + <param index="0" name="from" type="StringName" /> <description> Constructs a new String from the given [StringName]. </description> @@ -41,7 +41,7 @@ <methods> <method name="begins_with" qualifiers="const"> <return type="bool" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Returns [code]true[/code] if the string begins with the given string. </description> @@ -92,7 +92,7 @@ </method> <method name="casecmp_to" qualifiers="const"> <return type="int" /> - <argument index="0" name="to" type="String" /> + <param index="0" name="to" type="String" /> <description> Performs a case-sensitive comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. @@ -102,7 +102,7 @@ </method> <method name="chr" qualifiers="static"> <return type="String" /> - <argument index="0" name="char" type="int" /> + <param index="0" name="char" type="int" /> <description> Directly converts an decimal integer to a unicode character. Tables of these characters can be found in various locations, for example [url=https://unicodelookup.com/]here.[/url] [codeblock] @@ -113,25 +113,25 @@ </method> <method name="contains" qualifiers="const"> <return type="bool" /> - <argument index="0" name="what" type="String" /> + <param index="0" name="what" type="String" /> <description> Returns [code]true[/code] if the string contains the given string. </description> </method> <method name="count" qualifiers="const"> <return type="int" /> - <argument index="0" name="what" type="String" /> - <argument index="1" name="from" type="int" default="0" /> - <argument index="2" name="to" type="int" default="0" /> + <param index="0" name="what" type="String" /> + <param index="1" name="from" type="int" default="0" /> + <param index="2" name="to" type="int" default="0" /> <description> Returns the number of occurrences of substring [code]what[/code] between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. </description> </method> <method name="countn" qualifiers="const"> <return type="int" /> - <argument index="0" name="what" type="String" /> - <argument index="1" name="from" type="int" default="0" /> - <argument index="2" name="to" type="int" default="0" /> + <param index="0" name="what" type="String" /> + <param index="1" name="from" type="int" default="0" /> + <param index="2" name="to" type="int" default="0" /> <description> Returns the number of occurrences of substring [code]what[/code] (ignoring case) between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. </description> @@ -144,15 +144,15 @@ </method> <method name="ends_with" qualifiers="const"> <return type="bool" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Returns [code]true[/code] if the string ends with the given string. </description> </method> <method name="find" qualifiers="const"> <return type="int" /> - <argument index="0" name="what" type="String" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="what" type="String" /> + <param index="1" name="from" type="int" default="0" /> <description> Returns the index of the [b]first[/b] case-sensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the end of the string. [b]Note:[/b] If you just want to know whether a string contains a substring, use the [code]in[/code] operator as follows: @@ -169,16 +169,16 @@ </method> <method name="findn" qualifiers="const"> <return type="int" /> - <argument index="0" name="what" type="String" /> - <argument index="1" name="from" type="int" default="0" /> + <param index="0" name="what" type="String" /> + <param index="1" name="from" type="int" default="0" /> <description> Returns the index of the [b]first[/b] case-insensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the end of the string. </description> </method> <method name="format" qualifiers="const"> <return type="String" /> - <argument index="0" name="values" type="Variant" /> - <argument index="1" name="placeholder" type="String" default=""{_}"" /> + <param index="0" name="values" type="Variant" /> + <param index="1" name="placeholder" type="String" default=""{_}"" /> <description> Formats the string by replacing all occurrences of [code]placeholder[/code] with the elements of [code]values[/code]. [code]values[/code] can be a [Dictionary] or an [Array]. Any underscores in [code]placeholder[/code] will be replaced with the corresponding keys in advance. Array elements use their index as keys. @@ -234,8 +234,8 @@ </method> <method name="get_slice" qualifiers="const"> <return type="String" /> - <argument index="0" name="delimiter" type="String" /> - <argument index="1" name="slice" type="int" /> + <param index="0" name="delimiter" type="String" /> + <param index="1" name="slice" type="int" /> <description> Splits a string using a [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns an empty string if the index doesn't exist. This is a more performant alternative to [method split] for cases when you need only one element from the array at a fixed index. @@ -247,15 +247,15 @@ </method> <method name="get_slice_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="delimiter" type="String" /> + <param index="0" name="delimiter" type="String" /> <description> Splits a string using a [code]delimiter[/code] and returns a number of slices. </description> </method> <method name="get_slicec" qualifiers="const"> <return type="String" /> - <argument index="0" name="delimiter" type="int" /> - <argument index="1" name="slice" type="int" /> + <param index="0" name="delimiter" type="int" /> + <param index="1" name="slice" type="int" /> <description> Splits a string using a Unicode character with code [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns an empty string if the index doesn't exist. This is a more performant alternative to [method split] for cases when you need only one element from the array at a fixed index. @@ -286,7 +286,7 @@ </method> <method name="humanize_size" qualifiers="static"> <return type="String" /> - <argument index="0" name="size" type="int" /> + <param index="0" name="size" type="int" /> <description> Converts an integer representing a number of bytes into a human-readable form. Note that this output is in [url=https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes]IEC prefix format[/url], and includes [code]B[/code], [code]KiB[/code], [code]MiB[/code], [code]GiB[/code], [code]TiB[/code], [code]PiB[/code], and [code]EiB[/code]. @@ -294,7 +294,7 @@ </method> <method name="indent" qualifiers="const"> <return type="String" /> - <argument index="0" name="prefix" type="String" /> + <param index="0" name="prefix" type="String" /> <description> Returns a copy of the string with lines indented with [code]prefix[/code]. For example, the string can be indented with two tabs using [code]"\t\t"[/code], or four spaces using [code]" "[/code]. The prefix can be any string so it can also be used to comment out strings with e.g. [code]"# "[/code]. See also [method dedent] to remove indentation. @@ -303,8 +303,8 @@ </method> <method name="insert" qualifiers="const"> <return type="String" /> - <argument index="0" name="position" type="int" /> - <argument index="1" name="what" type="String" /> + <param index="0" name="position" type="int" /> + <param index="1" name="what" type="String" /> <description> Returns a copy of the string with the substring [code]what[/code] inserted at the given position. </description> @@ -329,14 +329,14 @@ </method> <method name="is_subsequence_of" qualifiers="const"> <return type="bool" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Returns [code]true[/code] if this string is a subsequence of the given string. </description> </method> <method name="is_subsequence_ofn" qualifiers="const"> <return type="bool" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Returns [code]true[/code] if this string is a subsequence of the given string, without considering case. </description> @@ -362,7 +362,7 @@ </method> <method name="is_valid_hex_number" qualifiers="const"> <return type="bool" /> - <argument index="0" name="with_prefix" type="bool" default="false" /> + <param index="0" name="with_prefix" type="bool" default="false" /> <description> Returns [code]true[/code] if this string contains a valid hexadecimal number. If [code]with_prefix[/code] is [code]true[/code], then a validity of the hexadecimal number is determined by [code]0x[/code] prefix, for instance: [code]0xDEADC0DE[/code]. </description> @@ -405,7 +405,7 @@ </method> <method name="join" qualifiers="const"> <return type="String" /> - <argument index="0" name="parts" type="PackedStringArray" /> + <param index="0" name="parts" type="PackedStringArray" /> <description> Returns a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method. Example: @@ -427,7 +427,7 @@ </method> <method name="left" qualifiers="const"> <return type="String" /> - <argument index="0" name="length" type="int" /> + <param index="0" name="length" type="int" /> <description> Returns a number of characters from the left of the string. If negative [code]length[/code] is used, the characters are counted downwards from [String]'s length. Examples: @@ -445,15 +445,15 @@ </method> <method name="lpad" qualifiers="const"> <return type="String" /> - <argument index="0" name="min_length" type="int" /> - <argument index="1" name="character" type="String" default="" "" /> + <param index="0" name="min_length" type="int" /> + <param index="1" name="character" type="String" default="" "" /> <description> Formats a string to be at least [code]min_length[/code] long by adding [code]character[/code]s to the left of the string. </description> </method> <method name="lstrip" qualifiers="const"> <return type="String" /> - <argument index="0" name="chars" type="String" /> + <param index="0" name="chars" type="String" /> <description> Returns a copy of the string with characters removed from the left. The [code]chars[/code] argument is a string specifying the set of characters to be removed. [b]Note:[/b] The [code]chars[/code] is not a prefix. See [method trim_prefix] method that will remove a single prefix string rather than a set of characters. @@ -461,14 +461,14 @@ </method> <method name="match" qualifiers="const"> <return type="bool" /> - <argument index="0" name="expr" type="String" /> + <param index="0" name="expr" type="String" /> <description> Does a simple case-sensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). An empty string or empty expression always evaluates to [code]false[/code]. </description> </method> <method name="matchn" qualifiers="const"> <return type="bool" /> - <argument index="0" name="expr" type="String" /> + <param index="0" name="expr" type="String" /> <description> Does a simple case-insensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). An empty string or empty expression always evaluates to [code]false[/code]. </description> @@ -487,7 +487,7 @@ </method> <method name="naturalnocasecmp_to" qualifiers="const"> <return type="int" /> - <argument index="0" name="to" type="String" /> + <param index="0" name="to" type="String" /> <description> Performs a case-insensitive [i]natural order[/i] comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison. When used for sorting, natural order comparison will order suites of numbers as expected by most people. If you sort the numbers from 1 to 10 using natural order, you will get [code][1, 2, 3, ...][/code] instead of [code][1, 10, 2, 3, ...][/code]. @@ -498,7 +498,7 @@ </method> <method name="nocasecmp_to" qualifiers="const"> <return type="int" /> - <argument index="0" name="to" type="String" /> + <param index="0" name="to" type="String" /> <description> Performs a case-insensitive comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison. [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. @@ -508,8 +508,8 @@ </method> <method name="num" qualifiers="static"> <return type="String" /> - <argument index="0" name="number" type="float" /> - <argument index="1" name="decimals" type="int" default="-1" /> + <param index="0" name="number" type="float" /> + <param index="1" name="decimals" type="int" default="-1" /> <description> Converts a [float] to a string representation of a decimal number. The number of decimal places can be specified with [code]decimals[/code]. If [code]decimals[/code] is [code]-1[/code] (default), decimal places will be automatically adjusted so that the string representation has 14 significant digits (counting both digits to the left and the right of the decimal point). @@ -530,91 +530,91 @@ </method> <method name="num_int64" qualifiers="static"> <return type="String" /> - <argument index="0" name="number" type="int" /> - <argument index="1" name="base" type="int" default="10" /> - <argument index="2" name="capitalize_hex" type="bool" default="false" /> + <param index="0" name="number" type="int" /> + <param index="1" name="base" type="int" default="10" /> + <param index="2" name="capitalize_hex" type="bool" default="false" /> <description> Converts a signed [int] to a string representation of a number. </description> </method> <method name="num_scientific" qualifiers="static"> <return type="String" /> - <argument index="0" name="number" type="float" /> + <param index="0" name="number" type="float" /> <description> </description> </method> <method name="num_uint64" qualifiers="static"> <return type="String" /> - <argument index="0" name="number" type="int" /> - <argument index="1" name="base" type="int" default="10" /> - <argument index="2" name="capitalize_hex" type="bool" default="false" /> + <param index="0" name="number" type="int" /> + <param index="1" name="base" type="int" default="10" /> + <param index="2" name="capitalize_hex" type="bool" default="false" /> <description> Converts a unsigned [int] to a string representation of a number. </description> </method> <method name="pad_decimals" qualifiers="const"> <return type="String" /> - <argument index="0" name="digits" type="int" /> + <param index="0" name="digits" type="int" /> <description> Formats a number to have an exact number of [code]digits[/code] after the decimal point. </description> </method> <method name="pad_zeros" qualifiers="const"> <return type="String" /> - <argument index="0" name="digits" type="int" /> + <param index="0" name="digits" type="int" /> <description> Formats a number to have an exact number of [code]digits[/code] before the decimal point. </description> </method> <method name="plus_file" qualifiers="const"> <return type="String" /> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code]. </description> </method> <method name="repeat" qualifiers="const"> <return type="String" /> - <argument index="0" name="count" type="int" /> + <param index="0" name="count" type="int" /> <description> Returns original string repeated a number of times. The number of repetitions is given by the argument. </description> </method> <method name="replace" qualifiers="const"> <return type="String" /> - <argument index="0" name="what" type="String" /> - <argument index="1" name="forwhat" type="String" /> + <param index="0" name="what" type="String" /> + <param index="1" name="forwhat" type="String" /> <description> Replaces occurrences of a case-sensitive substring with the given one inside the string. </description> </method> <method name="replacen" qualifiers="const"> <return type="String" /> - <argument index="0" name="what" type="String" /> - <argument index="1" name="forwhat" type="String" /> + <param index="0" name="what" type="String" /> + <param index="1" name="forwhat" type="String" /> <description> Replaces occurrences of a case-insensitive substring with the given one inside the string. </description> </method> <method name="rfind" qualifiers="const"> <return type="int" /> - <argument index="0" name="what" type="String" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="what" type="String" /> + <param index="1" name="from" type="int" default="-1" /> <description> Returns the index of the [b]last[/b] case-sensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the beginning of the string. </description> </method> <method name="rfindn" qualifiers="const"> <return type="int" /> - <argument index="0" name="what" type="String" /> - <argument index="1" name="from" type="int" default="-1" /> + <param index="0" name="what" type="String" /> + <param index="1" name="from" type="int" default="-1" /> <description> Returns the index of the [b]last[/b] case-insensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the beginning of the string. </description> </method> <method name="right" qualifiers="const"> <return type="String" /> - <argument index="0" name="length" type="int" /> + <param index="0" name="length" type="int" /> <description> Returns a number of characters from the right of the string. If negative [code]length[/code] is used, the characters are counted downwards from [String]'s length. Examples: @@ -626,17 +626,17 @@ </method> <method name="rpad" qualifiers="const"> <return type="String" /> - <argument index="0" name="min_length" type="int" /> - <argument index="1" name="character" type="String" default="" "" /> + <param index="0" name="min_length" type="int" /> + <param index="1" name="character" type="String" default="" "" /> <description> Formats a string to be at least [code]min_length[/code] long by adding [code]character[/code]s to the right of the string. </description> </method> <method name="rsplit" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="delimiter" type="String" /> - <argument index="1" name="allow_empty" type="bool" default="true" /> - <argument index="2" name="maxsplit" type="int" default="0" /> + <param index="0" name="delimiter" type="String" /> + <param index="1" name="allow_empty" type="bool" default="true" /> + <param index="2" name="maxsplit" type="int" default="0" /> <description> Splits the string by a [code]delimiter[/code] string and returns an array of the substrings, starting from right. The splits in the returned array are sorted in the same order as the original string, from left to right. @@ -659,7 +659,7 @@ </method> <method name="rstrip" qualifiers="const"> <return type="String" /> - <argument index="0" name="chars" type="String" /> + <param index="0" name="chars" type="String" /> <description> Returns a copy of the string with characters removed from the right. The [code]chars[/code] argument is a string specifying the set of characters to be removed. [b]Note:[/b] The [code]chars[/code] is not a suffix. See [method trim_suffix] method that will remove a single suffix string rather than a set of characters. @@ -691,7 +691,7 @@ </method> <method name="similarity" qualifiers="const"> <return type="float" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Returns the similarity index ([url=https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient]Sorensen-Dice coefficient[/url]) of this string compared to another. A result of 1.0 means totally similar, while 0.0 means totally dissimilar. [codeblock] @@ -710,9 +710,9 @@ </method> <method name="split" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="delimiter" type="String" /> - <argument index="1" name="allow_empty" type="bool" default="true" /> - <argument index="2" name="maxsplit" type="int" default="0" /> + <param index="0" name="delimiter" type="String" /> + <param index="1" name="allow_empty" type="bool" default="true" /> + <param index="2" name="maxsplit" type="int" default="0" /> <description> Splits the string by a [code]delimiter[/code] string and returns an array of the substrings. The [code]delimiter[/code] can be of any length. If [code]allow_empty[/code] is [code]true[/code], and there are two adjacent delimiters in the string, it will add an empty string to the array of substrings at this position. @@ -739,8 +739,8 @@ </method> <method name="split_floats" qualifiers="const"> <return type="PackedFloat32Array" /> - <argument index="0" name="delimiter" type="String" /> - <argument index="1" name="allow_empty" type="bool" default="true" /> + <param index="0" name="delimiter" type="String" /> + <param index="1" name="allow_empty" type="bool" default="true" /> <description> Splits the string in floats by using a delimiter string and returns an array of the substrings. For example, [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code]. @@ -749,8 +749,8 @@ </method> <method name="strip_edges" qualifiers="const"> <return type="String" /> - <argument index="0" name="left" type="bool" default="true" /> - <argument index="1" name="right" type="bool" default="true" /> + <param index="0" name="left" type="bool" default="true" /> + <param index="1" name="right" type="bool" default="true" /> <description> Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. </description> @@ -763,8 +763,8 @@ </method> <method name="substr" qualifiers="const"> <return type="String" /> - <argument index="0" name="from" type="int" /> - <argument index="1" name="len" type="int" default="-1" /> + <param index="0" name="from" type="int" /> + <param index="1" name="len" type="int" default="-1" /> <description> Returns part of the string from the position [code]from[/code] with length [code]len[/code]. Argument [code]len[/code] is optional and using [code]-1[/code] will return remaining characters from given position. </description> @@ -830,21 +830,21 @@ </method> <method name="trim_prefix" qualifiers="const"> <return type="String" /> - <argument index="0" name="prefix" type="String" /> + <param index="0" name="prefix" type="String" /> <description> Removes a given string from the start if it starts with it or leaves the string unchanged. </description> </method> <method name="trim_suffix" qualifiers="const"> <return type="String" /> - <argument index="0" name="suffix" type="String" /> + <param index="0" name="suffix" type="String" /> <description> Removes a given string from the end if it ends with it or leaves the string unchanged. </description> </method> <method name="unicode_at" qualifiers="const"> <return type="int" /> - <argument index="0" name="at" type="int" /> + <param index="0" name="at" type="int" /> <description> Returns the character code at position [code]at[/code]. </description> @@ -885,7 +885,7 @@ </method> <method name="xml_escape" qualifiers="const"> <return type="String" /> - <argument index="0" name="escape_quotes" type="bool" default="false" /> + <param index="0" name="escape_quotes" type="bool" default="false" /> <description> Returns a copy of the string with special characters escaped using the XML standard. If [code]escape_quotes[/code] is [code]true[/code], the single quote ([code]'[/code]) and double quote ([code]"[/code]) characters are also escaped. </description> @@ -900,73 +900,73 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="StringName" /> + <param index="0" name="right" type="StringName" /> <description> </description> </operator> <operator name="operator %"> <return type="String" /> - <argument index="0" name="right" type="Variant" /> + <param index="0" name="right" type="Variant" /> <description> </description> </operator> <operator name="operator +"> <return type="String" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator +"> <return type="String" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="StringName" /> + <param index="0" name="right" type="StringName" /> <description> </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator []"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index a2bcac9788..c40d8929fc 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -19,14 +19,14 @@ </constructor> <constructor name="StringName"> <return type="StringName" /> - <argument index="0" name="from" type="StringName" /> + <param index="0" name="from" type="StringName" /> <description> Constructs a [StringName] as a copy of the given [StringName]. </description> </constructor> <constructor name="StringName"> <return type="StringName" /> - <argument index="0" name="from" type="String" /> + <param index="0" name="from" type="String" /> <description> Creates a new [StringName] from the given [String]. [code]StringName("example")[/code] is equivalent to [code]&"example"[/code]. </description> @@ -43,49 +43,49 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="StringName" /> + <param index="0" name="right" type="StringName" /> <description> </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="StringName" /> + <param index="0" name="right" type="StringName" /> <description> </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="StringName" /> + <param index="0" name="right" type="StringName" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="StringName" /> + <param index="0" name="right" type="StringName" /> <description> </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="StringName" /> + <param index="0" name="right" type="StringName" /> <description> </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="StringName" /> + <param index="0" name="right" type="StringName" /> <description> </description> </operator> diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index d863e3c652..8593acd1ef 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -12,8 +12,8 @@ <methods> <method name="_draw" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="to_canvas_item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> + <param index="0" name="to_canvas_item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> <description> </description> </method> @@ -24,27 +24,27 @@ </method> <method name="_get_draw_rect" qualifiers="virtual const"> <return type="Rect2" /> - <argument index="0" name="rect" type="Rect2" /> + <param index="0" name="rect" type="Rect2" /> <description> </description> </method> <method name="_get_style_margin" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="side" type="int" enum="Side" /> + <param index="0" name="side" type="int" enum="Side" /> <description> </description> </method> <method name="_test_mask" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="point" type="Vector2" /> - <argument index="1" name="rect" type="Rect2" /> + <param index="0" name="point" type="Vector2" /> + <param index="1" name="rect" type="Rect2" /> <description> </description> </method> <method name="draw" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> <description> Draws this stylebox using a canvas item identified by the given [RID]. The [RID] value can either be the result of [method CanvasItem.get_canvas_item] called on an existing [CanvasItem]-derived node, or directly from creating a canvas item in the [RenderingServer] with [method RenderingServer.canvas_item_create]. @@ -64,14 +64,14 @@ </method> <method name="get_default_margin" qualifiers="const"> <return type="float" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the default margin of the specified [enum Side]. </description> </method> <method name="get_margin" qualifiers="const"> <return type="float" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the content margin offset for the specified [enum Side]. Positive values reduce size inwards, unlike [Control]'s margin values. @@ -91,16 +91,16 @@ </method> <method name="set_default_margin"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="offset" type="float" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="offset" type="float" /> <description> Sets the default value of the specified [enum Side] to [code]offset[/code] pixels. </description> </method> <method name="test_mask" qualifiers="const"> <return type="bool" /> - <argument index="0" name="point" type="Vector2" /> - <argument index="1" name="rect" type="Rect2" /> + <param index="0" name="point" type="Vector2" /> + <param index="1" name="rect" type="Rect2" /> <description> Test a position in a rectangle, return whether it passes the mask test. </description> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index c80f8dcbb1..48f656af8e 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -26,7 +26,7 @@ <methods> <method name="get_border_width" qualifiers="const"> <return type="int" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the specified [enum Side]'s border width. </description> @@ -39,79 +39,79 @@ </method> <method name="get_corner_radius" qualifiers="const"> <return type="int" /> - <argument index="0" name="corner" type="int" enum="Corner" /> + <param index="0" name="corner" type="int" enum="Corner" /> <description> Returns the given [code]corner[/code]'s radius. See [enum Corner] for possible values. </description> </method> <method name="get_expand_margin" qualifiers="const"> <return type="float" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the size of the specified [enum Side]'s expand margin. </description> </method> <method name="set_border_width"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="width" type="int" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="width" type="int" /> <description> Sets the specified [enum Side]'s border width to [code]width[/code] pixels. </description> </method> <method name="set_border_width_all"> <return type="void" /> - <argument index="0" name="width" type="int" /> + <param index="0" name="width" type="int" /> <description> Sets the border width to [code]width[/code] pixels for all sides. </description> </method> <method name="set_corner_radius"> <return type="void" /> - <argument index="0" name="corner" type="int" enum="Corner" /> - <argument index="1" name="radius" type="int" /> + <param index="0" name="corner" type="int" enum="Corner" /> + <param index="1" name="radius" type="int" /> <description> Sets the corner radius to [code]radius[/code] pixels for the given [code]corner[/code]. See [enum Corner] for possible values. </description> </method> <method name="set_corner_radius_all"> <return type="void" /> - <argument index="0" name="radius" type="int" /> + <param index="0" name="radius" type="int" /> <description> Sets the corner radius to [code]radius[/code] pixels for all corners. </description> </method> <method name="set_corner_radius_individual"> <return type="void" /> - <argument index="0" name="radius_top_left" type="int" /> - <argument index="1" name="radius_top_right" type="int" /> - <argument index="2" name="radius_bottom_right" type="int" /> - <argument index="3" name="radius_bottom_left" type="int" /> + <param index="0" name="radius_top_left" type="int" /> + <param index="1" name="radius_top_right" type="int" /> + <param index="2" name="radius_bottom_right" type="int" /> + <param index="3" name="radius_bottom_left" type="int" /> <description> Sets the corner radius for each corner to [code]radius_top_left[/code], [code]radius_top_right[/code], [code]radius_bottom_right[/code], and [code]radius_bottom_left[/code] pixels. </description> </method> <method name="set_expand_margin"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="size" type="float" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="size" type="float" /> <description> Sets the expand margin to [code]size[/code] pixels for the specified [enum Side]. </description> </method> <method name="set_expand_margin_all"> <return type="void" /> - <argument index="0" name="size" type="float" /> + <param index="0" name="size" type="float" /> <description> Sets the expand margin to [code]size[/code] pixels for all margins. </description> </method> <method name="set_expand_margin_individual"> <return type="void" /> - <argument index="0" name="size_left" type="float" /> - <argument index="1" name="size_top" type="float" /> - <argument index="2" name="size_right" type="float" /> - <argument index="3" name="size_bottom" type="float" /> + <param index="0" name="size_left" type="float" /> + <param index="1" name="size_top" type="float" /> + <param index="2" name="size_right" type="float" /> + <param index="3" name="size_bottom" type="float" /> <description> Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels. </description> diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 8c324d4e37..2468857cf1 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -11,47 +11,47 @@ <methods> <method name="get_expand_margin_size" qualifiers="const"> <return type="float" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the expand margin size of the specified [enum Side]. </description> </method> <method name="get_margin_size" qualifiers="const"> <return type="float" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> Returns the margin size of the specified [enum Side]. </description> </method> <method name="set_expand_margin_all"> <return type="void" /> - <argument index="0" name="size" type="float" /> + <param index="0" name="size" type="float" /> <description> Sets the expand margin to [code]size[/code] pixels for all margins. </description> </method> <method name="set_expand_margin_individual"> <return type="void" /> - <argument index="0" name="size_left" type="float" /> - <argument index="1" name="size_top" type="float" /> - <argument index="2" name="size_right" type="float" /> - <argument index="3" name="size_bottom" type="float" /> + <param index="0" name="size_left" type="float" /> + <param index="1" name="size_top" type="float" /> + <param index="2" name="size_right" type="float" /> + <param index="3" name="size_bottom" type="float" /> <description> Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels. </description> </method> <method name="set_expand_margin_size"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="size" type="float" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="size" type="float" /> <description> Sets the expand margin to [code]size[/code] pixels for the specified [enum Side]. </description> </method> <method name="set_margin_size"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="size" type="float" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="size" type="float" /> <description> Sets the margin to [code]size[/code] pixels for the specified [enum Side]. </description> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index ad638a680b..51c9e59fd2 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -33,19 +33,19 @@ <methods> <method name="add_index"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Adds a vertex to index array if you are using indexed vertices. Does not need to be called before adding vertices. </description> </method> <method name="add_triangle_fan"> <return type="void" /> - <argument index="0" name="vertices" type="PackedVector3Array" /> - <argument index="1" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> - <argument index="2" name="colors" type="PackedColorArray" default="PackedColorArray()" /> - <argument index="3" name="uv2s" type="PackedVector2Array" default="PackedVector2Array()" /> - <argument index="4" name="normals" type="PackedVector3Array" default="PackedVector3Array()" /> - <argument index="5" name="tangents" type="Array" default="[]" /> + <param index="0" name="vertices" type="PackedVector3Array" /> + <param index="1" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" /> + <param index="2" name="colors" type="PackedColorArray" default="PackedColorArray()" /> + <param index="3" name="uv2s" type="PackedVector2Array" default="PackedVector2Array()" /> + <param index="4" name="normals" type="PackedVector3Array" default="PackedVector3Array()" /> + <param index="5" name="tangents" type="Array" default="[]" /> <description> Inserts a triangle fan made of array data into [Mesh] being constructed. Requires the primitive type be set to [constant Mesh.PRIMITIVE_TRIANGLES]. @@ -53,23 +53,23 @@ </method> <method name="add_vertex"> <return type="void" /> - <argument index="0" name="vertex" type="Vector3" /> + <param index="0" name="vertex" type="Vector3" /> <description> Specifies the position of current vertex. Should be called after specifying other vertex properties (e.g. Color, UV). </description> </method> <method name="append_from"> <return type="void" /> - <argument index="0" name="existing" type="Mesh" /> - <argument index="1" name="surface" type="int" /> - <argument index="2" name="transform" type="Transform3D" /> + <param index="0" name="existing" type="Mesh" /> + <param index="1" name="surface" type="int" /> + <param index="2" name="transform" type="Transform3D" /> <description> Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform3D]. </description> </method> <method name="begin"> <return type="void" /> - <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" /> + <param index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" /> <description> Called before adding any vertices. Takes the primitive type as an argument (e.g. [constant Mesh.PRIMITIVE_TRIANGLES]). </description> @@ -82,8 +82,8 @@ </method> <method name="commit"> <return type="ArrayMesh" /> - <argument index="0" name="existing" type="ArrayMesh" default="null" /> - <argument index="1" name="flags" type="int" default="0" /> + <param index="0" name="existing" type="ArrayMesh" default="null" /> + <param index="1" name="flags" type="int" default="0" /> <description> Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. [b]FIXME:[/b] Document possible values for [code]flags[/code], it changed in 4.0. Likely some combinations of [enum Mesh.ArrayFormat]. @@ -97,17 +97,17 @@ </method> <method name="create_from"> <return type="void" /> - <argument index="0" name="existing" type="Mesh" /> - <argument index="1" name="surface" type="int" /> + <param index="0" name="existing" type="Mesh" /> + <param index="1" name="surface" type="int" /> <description> Creates a vertex array from an existing [Mesh]. </description> </method> <method name="create_from_blend_shape"> <return type="void" /> - <argument index="0" name="existing" type="Mesh" /> - <argument index="1" name="surface" type="int" /> - <argument index="2" name="blend_shape" type="String" /> + <param index="0" name="existing" type="Mesh" /> + <param index="1" name="surface" type="int" /> + <param index="2" name="blend_shape" type="String" /> <description> Creates a vertex array from the specified blend shape of an existing [Mesh]. This can be used to extract a specific pose from a blend shape. </description> @@ -120,8 +120,8 @@ </method> <method name="generate_lod"> <return type="PackedInt32Array" /> - <argument index="0" name="nd_threshold" type="float" /> - <argument index="1" name="target_index_count" type="int" default="3" /> + <param index="0" name="nd_threshold" type="float" /> + <param index="1" name="target_index_count" type="int" default="3" /> <description> Generates a LOD for a given [code]nd_threshold[/code] in linear units (square root of quadric error metric), using at most [code]target_index_count[/code] indices. Deprecated. Unused internally and neglects to preserve normals or UVs. Consider using [method ImporterMesh.generate_lods] instead. @@ -129,7 +129,7 @@ </method> <method name="generate_normals"> <return type="void" /> - <argument index="0" name="flip" type="bool" default="false" /> + <param index="0" name="flip" type="bool" default="false" /> <description> Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays]. For correct display of normal-mapped surfaces, you will also have to generate tangents using [method generate_tangents]. [b]Note:[/b] [method generate_normals] only works if the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES]. @@ -149,7 +149,7 @@ </method> <method name="get_custom_format" qualifiers="const"> <return type="int" enum="SurfaceTool.CustomFormat" /> - <argument index="0" name="channel_index" type="int" /> + <param index="0" name="channel_index" type="int" /> <description> Returns the format for custom [code]channel_index[/code] (currently up to 4). Returns [constant CUSTOM_MAX] if this custom channel is unused. </description> @@ -182,14 +182,14 @@ </method> <method name="set_bones"> <return type="void" /> - <argument index="0" name="bones" type="PackedInt32Array" /> + <param index="0" name="bones" type="PackedInt32Array" /> <description> Specifies an array of bones to use for the [i]next[/i] vertex. [code]bones[/code] must contain 4 integers. </description> </method> <method name="set_color"> <return type="void" /> - <argument index="0" name="color" type="Color" /> + <param index="0" name="color" type="Color" /> <description> Specifies a [Color] to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. [b]Note:[/b] The material must have [member BaseMaterial3D.vertex_color_use_as_albedo] enabled for the vertex color to be visible. @@ -197,8 +197,8 @@ </method> <method name="set_custom"> <return type="void" /> - <argument index="0" name="channel_index" type="int" /> - <argument index="1" name="custom_color" type="Color" /> + <param index="0" name="channel_index" type="int" /> + <param index="1" name="custom_color" type="Color" /> <description> Sets the custom value on this vertex for [code]channel_index[/code]. [method set_custom_format] must be called first for this [code]channel_index[/code]. Formats which are not RGBA will ignore other color channels. @@ -206,8 +206,8 @@ </method> <method name="set_custom_format"> <return type="void" /> - <argument index="0" name="channel_index" type="int" /> - <argument index="1" name="format" type="int" enum="SurfaceTool.CustomFormat" /> + <param index="0" name="channel_index" type="int" /> + <param index="1" name="format" type="int" enum="SurfaceTool.CustomFormat" /> <description> Sets the color format for this custom [code]channel_index[/code]. Use [constant CUSTOM_MAX] to disable. Must be invoked after [method begin] and should be set before [method commit] or [method commit_to_arrays]. @@ -215,21 +215,21 @@ </method> <method name="set_material"> <return type="void" /> - <argument index="0" name="material" type="Material" /> + <param index="0" name="material" type="Material" /> <description> Sets [Material] to be used by the [Mesh] you are constructing. </description> </method> <method name="set_normal"> <return type="void" /> - <argument index="0" name="normal" type="Vector3" /> + <param index="0" name="normal" type="Vector3" /> <description> Specifies a normal to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. </description> </method> <method name="set_skin_weight_count"> <return type="void" /> - <argument index="0" name="count" type="int" enum="SurfaceTool.SkinWeightCount" /> + <param index="0" name="count" type="int" enum="SurfaceTool.SkinWeightCount" /> <description> Set to [constant SKIN_8_WEIGHTS] to indicate that up to 8 bone influences per vertex may be used. By default, only 4 bone influences are used ([constant SKIN_4_WEIGHTS]) @@ -238,35 +238,35 @@ </method> <method name="set_smooth_group"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Specifies whether the current vertex (if using only vertex arrays) or current index (if also using index arrays) should use smooth normals for normal calculation. </description> </method> <method name="set_tangent"> <return type="void" /> - <argument index="0" name="tangent" type="Plane" /> + <param index="0" name="tangent" type="Plane" /> <description> Specifies a tangent to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. </description> </method> <method name="set_uv"> <return type="void" /> - <argument index="0" name="uv" type="Vector2" /> + <param index="0" name="uv" type="Vector2" /> <description> Specifies a set of UV coordinates to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. </description> </method> <method name="set_uv2"> <return type="void" /> - <argument index="0" name="uv2" type="Vector2" /> + <param index="0" name="uv2" type="Vector2" /> <description> Specifies an optional second set of UV coordinates to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. </description> </method> <method name="set_weights"> <return type="void" /> - <argument index="0" name="weights" type="PackedFloat32Array" /> + <param index="0" name="weights" type="PackedFloat32Array" /> <description> Specifies weight values to use for the [i]next[/i] vertex. [code]weights[/code] must contain 4 values. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. </description> diff --git a/doc/classes/SyntaxHighlighter.xml b/doc/classes/SyntaxHighlighter.xml index 70cbd83371..fcac96c04d 100644 --- a/doc/classes/SyntaxHighlighter.xml +++ b/doc/classes/SyntaxHighlighter.xml @@ -19,7 +19,7 @@ </method> <method name="_get_line_syntax_highlighting" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Virtual method which can be overridden to return syntax highlighting data. See [method get_line_syntax_highlighting] for more details. @@ -40,7 +40,7 @@ </method> <method name="get_line_syntax_highlighting"> <return type="Dictionary" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns syntax highlighting data for a single line. If the line is not cached, calls [method _get_line_syntax_highlighting] to calculate the data. The return [Dictionary] is column number to [Dictionary]. The column number notes the start of a region, the region will end if another region is found, or at the end of the line. The nested [Dictionary] contains the data for that region, currently only the key "color" is supported. diff --git a/doc/classes/TCPServer.xml b/doc/classes/TCPServer.xml index 06fe4de9e2..0990fb853a 100644 --- a/doc/classes/TCPServer.xml +++ b/doc/classes/TCPServer.xml @@ -30,8 +30,8 @@ </method> <method name="listen"> <return type="int" enum="Error" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="bind_address" type="String" default=""*"" /> + <param index="0" name="port" type="int" /> + <param index="1" name="bind_address" type="String" default=""*"" /> <description> Listen on the [code]port[/code] binding to [code]bind_address[/code]. If [code]bind_address[/code] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6). diff --git a/doc/classes/TabBar.xml b/doc/classes/TabBar.xml index 79d52b70fb..f4ec33e9e1 100644 --- a/doc/classes/TabBar.xml +++ b/doc/classes/TabBar.xml @@ -11,15 +11,15 @@ <methods> <method name="add_tab"> <return type="void" /> - <argument index="0" name="title" type="String" default="""" /> - <argument index="1" name="icon" type="Texture2D" default="null" /> + <param index="0" name="title" type="String" default="""" /> + <param index="1" name="icon" type="Texture2D" default="null" /> <description> Adds a new tab. </description> </method> <method name="ensure_tab_visible"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Moves the scroll view to make the tab visible. </description> @@ -38,28 +38,28 @@ </method> <method name="get_tab_button_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns the [Texture2D] for the right button of the tab at index [code]tab_idx[/code] or [code]null[/code] if the button has no [Texture2D]. </description> </method> <method name="get_tab_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns the [Texture2D] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture2D]. </description> </method> <method name="get_tab_idx_at_point" qualifiers="const"> <return type="int" /> - <argument index="0" name="point" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> <description> Returns the index of the tab at local coordinates [code]point[/code]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position. </description> </method> <method name="get_tab_language" qualifiers="const"> <return type="String" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns tab title language code. </description> @@ -72,106 +72,106 @@ </method> <method name="get_tab_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns tab [Rect2] with local position and size. </description> </method> <method name="get_tab_text_direction" qualifiers="const"> <return type="int" enum="Control.TextDirection" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns tab title text base writing direction. </description> </method> <method name="get_tab_title" qualifiers="const"> <return type="String" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns the title of the tab at index [code]tab_idx[/code]. </description> </method> <method name="is_tab_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. </description> </method> <method name="is_tab_hidden" qualifiers="const"> <return type="bool" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is hidden. </description> </method> <method name="move_tab"> <return type="void" /> - <argument index="0" name="from" type="int" /> - <argument index="1" name="to" type="int" /> + <param index="0" name="from" type="int" /> + <param index="1" name="to" type="int" /> <description> Moves a tab from [code]from[/code] to [code]to[/code]. </description> </method> <method name="remove_tab"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Removes the tab at index [code]tab_idx[/code]. </description> </method> <method name="set_tab_button_icon"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="icon" type="Texture2D" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="icon" type="Texture2D" /> <description> Sets an [code]icon[/code] for the button of the tab at index [code]tab_idx[/code] (located to the right, before the close button), making it visible and clickable (See [signal tab_button_pressed]). Giving it a [code]null[/code] value will hide the button. </description> </method> <method name="set_tab_disabled"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="disabled" type="bool" /> <description> If [code]disabled[/code] is [code]true[/code], disables the tab at index [code]tab_idx[/code], making it non-interactable. </description> </method> <method name="set_tab_hidden"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="hidden" type="bool" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="hidden" type="bool" /> <description> If [code]hidden[/code] is [code]true[/code], hides the tab at index [code]tab_idx[/code], making it disappear from the tab area. </description> </method> <method name="set_tab_icon"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="icon" type="Texture2D" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="icon" type="Texture2D" /> <description> Sets an [code]icon[/code] for the tab at index [code]tab_idx[/code]. </description> </method> <method name="set_tab_language"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="language" type="String" /> <description> Sets language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. </description> </method> <method name="set_tab_text_direction"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="direction" type="int" enum="Control.TextDirection" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="direction" type="int" enum="Control.TextDirection" /> <description> Sets tab title base writing direction. </description> </method> <method name="set_tab_title"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="title" type="String" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="title" type="String" /> <description> Sets a [code]title[/code] for the tab at index [code]tab_idx[/code]. </description> @@ -215,31 +215,31 @@ </members> <signals> <signal name="active_tab_rearranged"> - <argument index="0" name="idx_to" type="int" /> + <param index="0" name="idx_to" type="int" /> <description> Emitted when the active tab is rearranged via mouse drag. See [member drag_to_rearrange_enabled]. </description> </signal> <signal name="tab_button_pressed"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when a tab's right button is pressed. See [method set_tab_button_icon]. </description> </signal> <signal name="tab_changed"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when switching to another tab. </description> </signal> <signal name="tab_clicked"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when a tab is clicked, even if it is the current tab. </description> </signal> <signal name="tab_close_pressed"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when a tab's close button is pressed. [b]Note:[/b] Tabs are not removed automatically once the close button is pressed, this behavior needs to be programmed manually. For example: @@ -254,19 +254,19 @@ </description> </signal> <signal name="tab_hovered"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when a tab is hovered by the mouse. </description> </signal> <signal name="tab_rmb_clicked"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when a tab is right-clicked. [member select_with_rmb] must be enabled. </description> </signal> <signal name="tab_selected"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when a tab is selected via click or script, even if it is the current tab. </description> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 10b5f730ad..3a3b0a7b28 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -33,14 +33,14 @@ </method> <method name="get_tab_button_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns the button icon from the tab at index [code]tab_idx[/code]. </description> </method> <method name="get_tab_control" qualifiers="const"> <return type="Control" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns the [Control] node from the tab at index [code]tab_idx[/code]. </description> @@ -53,89 +53,89 @@ </method> <method name="get_tab_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns the [Texture2D] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture2D]. </description> </method> <method name="get_tab_idx_at_point" qualifiers="const"> <return type="int" /> - <argument index="0" name="point" type="Vector2" /> + <param index="0" name="point" type="Vector2" /> <description> Returns the index of the tab at local coordinates [code]point[/code]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position. </description> </method> <method name="get_tab_idx_from_control" qualifiers="const"> <return type="int" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <description> Returns the index of the tab tied to the given [code]control[/code]. The control must be a child of the [TabContainer]. </description> </method> <method name="get_tab_title" qualifiers="const"> <return type="String" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> <method name="is_tab_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. </description> </method> <method name="is_tab_hidden" qualifiers="const"> <return type="bool" /> - <argument index="0" name="tab_idx" type="int" /> + <param index="0" name="tab_idx" type="int" /> <description> Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is hidden. </description> </method> <method name="set_popup"> <return type="void" /> - <argument index="0" name="popup" type="Node" /> + <param index="0" name="popup" type="Node" /> <description> If set on a [Popup] node instance, a popup menu icon appears in the top-right corner of the [TabContainer] (setting it to [code]null[/code] will make it go away). Clicking it will expand the [Popup] node. </description> </method> <method name="set_tab_button_icon"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="icon" type="Texture2D" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="icon" type="Texture2D" /> <description> Sets the button icon from the tab at index [code]tab_idx[/code]. </description> </method> <method name="set_tab_disabled"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="disabled" type="bool" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="disabled" type="bool" /> <description> If [code]disabled[/code] is [code]true[/code], disables the tab at index [code]tab_idx[/code], making it non-interactable. </description> </method> <method name="set_tab_hidden"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="hidden" type="bool" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="hidden" type="bool" /> <description> If [code]hidden[/code] is [code]true[/code], hides the tab at index [code]tab_idx[/code], making it disappear from the tab area. </description> </method> <method name="set_tab_icon"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="icon" type="Texture2D" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="icon" type="Texture2D" /> <description> Sets an icon for the tab at index [code]tab_idx[/code]. </description> </method> <method name="set_tab_title"> <return type="void" /> - <argument index="0" name="tab_idx" type="int" /> - <argument index="1" name="title" type="String" /> + <param index="0" name="tab_idx" type="int" /> + <param index="1" name="title" type="String" /> <description> Sets a custom title for the tab at index [code]tab_idx[/code] (tab titles default to the name of the indexed child node). Set it back to the child's name to make the tab default to it again. </description> @@ -175,19 +175,19 @@ </description> </signal> <signal name="tab_button_pressed"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when the user clicks on the button icon on this tab. </description> </signal> <signal name="tab_changed"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when switching to another tab. </description> </signal> <signal name="tab_selected"> - <argument index="0" name="tab" type="int" /> + <param index="0" name="tab" type="int" /> <description> Emitted when a tab is selected, even if it is the current tab. </description> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 18a4893f03..c1fdfbf085 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -30,7 +30,7 @@ </method> <method name="_handle_unicode_input" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="unicode_char" type="int" /> + <param index="0" name="unicode_char" type="int" /> <description> Override this method to define what happens when the types in the provided key [code]unicode[/code]. </description> @@ -50,7 +50,7 @@ </method> <method name="add_gutter"> <return type="void" /> - <argument index="0" name="at" type="int" default="-1" /> + <param index="0" name="at" type="int" default="-1" /> <description> Register a new gutter to this [TextEdit]. Use [code]at[/code] to have a specific gutter order. A value of [code]-1[/code] appends the gutter to the right. </description> @@ -147,7 +147,7 @@ </method> <method name="get_first_non_whitespace_column" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the first column containing a non-whitespace character. </description> @@ -166,28 +166,28 @@ </method> <method name="get_gutter_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="gutter" type="int" /> + <param index="0" name="gutter" type="int" /> <description> Returns the name of the gutter at the given index. </description> </method> <method name="get_gutter_type" qualifiers="const"> <return type="int" enum="TextEdit.GutterType" /> - <argument index="0" name="gutter" type="int" /> + <param index="0" name="gutter" type="int" /> <description> Returns the type of the gutter at the given index. </description> </method> <method name="get_gutter_width" qualifiers="const"> <return type="int" /> - <argument index="0" name="gutter" type="int" /> + <param index="0" name="gutter" type="int" /> <description> Returns the width of the gutter at the given index. </description> </method> <method name="get_indent_level" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the amount of spaces and [code]tab * tab_size[/code] before the first char. </description> @@ -212,22 +212,22 @@ </method> <method name="get_line" qualifiers="const"> <return type="String" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the text of a specific line. </description> </method> <method name="get_line_background_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the current background color of the line. [code]Color(0, 0, 0, 0)[/code] is returned if no color is set. </description> </method> <method name="get_line_column_at_pos" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="position" type="Vector2i" /> - <argument index="1" name="allow_out_of_bounds" type="bool" default="true" /> + <param index="0" name="position" type="Vector2i" /> + <param index="1" name="allow_out_of_bounds" type="bool" default="true" /> <description> Returns the line and column at the given position. In the returned vector, [code]x[/code] is the column, [code]y[/code] is the line. If [code]allow_out_of_bounds[/code] is [code]false[/code] and the position is not over the text, both vector values will be set to [code]-1[/code]. </description> @@ -240,32 +240,32 @@ </method> <method name="get_line_gutter_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> <description> Returns the icon currently in [code]gutter[/code] at [code]line[/code]. </description> </method> <method name="get_line_gutter_item_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> <description> Returns the color currently in [code]gutter[/code] at [code]line[/code]. </description> </method> <method name="get_line_gutter_metadata" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> <description> Returns the metadata currently in [code]gutter[/code] at [code]line[/code]. </description> </method> <method name="get_line_gutter_text" qualifiers="const"> <return type="String" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> <description> Returns the text currently in [code]gutter[/code] at [code]line[/code]. </description> @@ -278,30 +278,30 @@ </method> <method name="get_line_width" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="wrap_index" type="int" default="-1" /> + <param index="0" name="line" type="int" /> + <param index="1" name="wrap_index" type="int" default="-1" /> <description> Returns the width in pixels of the [code]wrap_index[/code] on [code]line[/code]. </description> </method> <method name="get_line_wrap_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the number of times the given line is wrapped. </description> </method> <method name="get_line_wrap_index_at_column" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="column" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="column" type="int" /> <description> Returns the wrap index of the given line column. </description> </method> <method name="get_line_wrapped_text" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns an array of [String]s representing each wrapped index. </description> @@ -321,7 +321,7 @@ </method> <method name="get_minimap_line_at_pos" qualifiers="const"> <return type="int" /> - <argument index="0" name="position" type="Vector2i" /> + <param index="0" name="position" type="Vector2i" /> <description> Returns the equivalent minimap line at [code]position[/code] </description> @@ -334,25 +334,25 @@ </method> <method name="get_next_visible_line_index_offset_from" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="wrap_index" type="int" /> - <argument index="2" name="visible_amount" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="wrap_index" type="int" /> + <param index="2" name="visible_amount" type="int" /> <description> Similar to [method get_next_visible_line_offset_from], but takes into account the line wrap indexes. In the returned vector, [code]x[/code] is the line, [code]y[/code] is the wrap index. </description> </method> <method name="get_next_visible_line_offset_from" qualifiers="const"> <return type="int" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="visible_amount" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="visible_amount" type="int" /> <description> Returns the count to the next visible line from [code]line[/code] to [code]line + visible_amount[/code]. Can also count backwards. For example if a [TextEdit] has 5 lines with lines 2 and 3 hidden, calling this with [code]line = 1, visible_amount = 1[/code] would return 3. </description> </method> <method name="get_pos_at_line_column" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="column" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="column" type="int" /> <description> Returns the local position for the given [code]line[/code] and [code]column[/code]. If [code]x[/code] or [code]y[/code] of the returned vector equal [code]-1[/code], the position is outside of the viewable area of the control. [b]Note:[/b] The Y position corresponds to the bottom side of the line. Use [method get_rect_at_line_column] to get the top side position. @@ -360,8 +360,8 @@ </method> <method name="get_rect_at_line_column" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="column" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="column" type="int" /> <description> Returns the local position and size for the grapheme at the given [code]line[/code] and [code]column[/code]. If [code]x[/code] or [code]y[/code] position of the returned rect equal [code]-1[/code], the position is outside of the viewable area of the control. [b]Note:[/b] The Y position of the returned rect corresponds to the top side of the line, unlike [method get_pos_at_line_column] which returns the bottom side. @@ -375,8 +375,8 @@ </method> <method name="get_scroll_pos_for_line" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="wrap_index" type="int" default="0" /> + <param index="0" name="line" type="int" /> + <param index="1" name="wrap_index" type="int" default="0" /> <description> Returns the scroll position for [code]wrap_index[/code] of [code]line[/code]. </description> @@ -461,15 +461,15 @@ </method> <method name="get_visible_line_count_in_range" qualifiers="const"> <return type="int" /> - <argument index="0" name="from_line" type="int" /> - <argument index="1" name="to_line" type="int" /> + <param index="0" name="from_line" type="int" /> + <param index="1" name="to_line" type="int" /> <description> Returns the total number of visible + wrapped lines between the two lines. </description> </method> <method name="get_word_at_pos" qualifiers="const"> <return type="String" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Returns the word at [code]position[/code]. </description> @@ -506,15 +506,15 @@ </method> <method name="insert_line_at"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="text" type="String" /> + <param index="0" name="line" type="int" /> + <param index="1" name="text" type="String" /> <description> Inserts a new line with [code]text[/code] at [code]line[/code]. </description> </method> <method name="insert_text_at_caret"> <return type="void" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Insert the specified text at the caret position. </description> @@ -533,36 +533,36 @@ </method> <method name="is_gutter_clickable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="gutter" type="int" /> + <param index="0" name="gutter" type="int" /> <description> Returns whether the gutter is clickable. </description> </method> <method name="is_gutter_drawn" qualifiers="const"> <return type="bool" /> - <argument index="0" name="gutter" type="int" /> + <param index="0" name="gutter" type="int" /> <description> Returns whether the gutter is currently drawn. </description> </method> <method name="is_gutter_overwritable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="gutter" type="int" /> + <param index="0" name="gutter" type="int" /> <description> Returns whether the gutter is overwritable. </description> </method> <method name="is_line_gutter_clickable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> <description> Returns whether the gutter on the given line is clickable. </description> </method> <method name="is_line_wrapped" qualifiers="const"> <return type="bool" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns if the given line is wrapped. </description> @@ -575,7 +575,7 @@ </method> <method name="is_mouse_over_selection" qualifiers="const"> <return type="bool" /> - <argument index="0" name="edges" type="bool" /> + <param index="0" name="edges" type="bool" /> <description> Returns whether the mouse is over selection. If [code]edges[/code] is [code]true[/code], the edges are considered part of the selection. </description> @@ -588,15 +588,15 @@ </method> <method name="menu_option"> <return type="void" /> - <argument index="0" name="option" type="int" /> + <param index="0" name="option" type="int" /> <description> Triggers a right-click menu action by the specified index. See [enum MenuItems] for a list of available indexes. </description> </method> <method name="merge_gutters"> <return type="void" /> - <argument index="0" name="from_line" type="int" /> - <argument index="1" name="to_line" type="int" /> + <param index="0" name="from_line" type="int" /> + <param index="1" name="to_line" type="int" /> <description> Merge the gutters from [code]from_line[/code] into [code]to_line[/code]. Only overwritable gutters will be copied. </description> @@ -615,17 +615,17 @@ </method> <method name="remove_gutter"> <return type="void" /> - <argument index="0" name="gutter" type="int" /> + <param index="0" name="gutter" type="int" /> <description> Removes the gutter from this [TextEdit]. </description> </method> <method name="remove_text"> <return type="void" /> - <argument index="0" name="from_line" type="int" /> - <argument index="1" name="from_column" type="int" /> - <argument index="2" name="to_line" type="int" /> - <argument index="3" name="to_column" type="int" /> + <param index="0" name="from_line" type="int" /> + <param index="1" name="from_column" type="int" /> + <param index="2" name="to_line" type="int" /> + <param index="3" name="to_column" type="int" /> <description> Removes text between the given positions. [b]Note:[/b] This does not adjust the caret or selection, which as a result it can end up in an invalid position. @@ -633,10 +633,10 @@ </method> <method name="search" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="flags" type="int" /> - <argument index="2" name="from_line" type="int" /> - <argument index="3" name="from_colum" type="int" /> + <param index="0" name="text" type="String" /> + <param index="1" name="flags" type="int" /> + <param index="2" name="from_line" type="int" /> + <param index="3" name="from_colum" type="int" /> <description> Perform a search inside the text. Search flags can be specified in the [enum SearchFlags] enum. In the returned vector, [code]x[/code] is the column, [code]y[/code] is the line. If no results are found, both are equal to [code]-1[/code]. @@ -662,10 +662,10 @@ </method> <method name="select"> <return type="void" /> - <argument index="0" name="from_line" type="int" /> - <argument index="1" name="from_column" type="int" /> - <argument index="2" name="to_line" type="int" /> - <argument index="3" name="to_column" type="int" /> + <param index="0" name="from_line" type="int" /> + <param index="1" name="from_column" type="int" /> + <param index="2" name="to_line" type="int" /> + <param index="3" name="to_column" type="int" /> <description> Perform selection, from line/column to line/column. If [member selecting_enabled] is [code]false[/code], no selection will occur. @@ -686,8 +686,8 @@ </method> <method name="set_caret_column"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="adjust_viewport" type="bool" default="true" /> + <param index="0" name="column" type="int" /> + <param index="1" name="adjust_viewport" type="bool" default="true" /> <description> Moves the caret to the specified [code]column[/code] index. If [code]adjust_viewport[/code] is [code]true[/code], the viewport will center at the caret position after the move occurs. @@ -695,10 +695,10 @@ </method> <method name="set_caret_line"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="adjust_viewport" type="bool" default="true" /> - <argument index="2" name="can_be_hidden" type="bool" default="true" /> - <argument index="3" name="wrap_index" type="int" default="0" /> + <param index="0" name="line" type="int" /> + <param index="1" name="adjust_viewport" type="bool" default="true" /> + <param index="2" name="can_be_hidden" type="bool" default="true" /> + <param index="3" name="wrap_index" type="int" default="0" /> <description> Moves the caret to the specified [code]line[/code] index. If [code]adjust_viewport[/code] is [code]true[/code], the viewport will center at the caret position after the move occurs. @@ -707,193 +707,193 @@ </method> <method name="set_gutter_clickable"> <return type="void" /> - <argument index="0" name="gutter" type="int" /> - <argument index="1" name="clickable" type="bool" /> + <param index="0" name="gutter" type="int" /> + <param index="1" name="clickable" type="bool" /> <description> Sets the gutter as clickable. This will change the mouse cursor to a pointing hand when hovering over the gutter. </description> </method> <method name="set_gutter_custom_draw"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="draw_callback" type="Callable" /> + <param index="0" name="column" type="int" /> + <param index="1" name="draw_callback" type="Callable" /> <description> Set a custom draw method for the gutter. The callback method must take the following args: [code]line: int, gutter: int, Area: Rect2[/code]. </description> </method> <method name="set_gutter_draw"> <return type="void" /> - <argument index="0" name="gutter" type="int" /> - <argument index="1" name="draw" type="bool" /> + <param index="0" name="gutter" type="int" /> + <param index="1" name="draw" type="bool" /> <description> Sets whether the gutter should be drawn. </description> </method> <method name="set_gutter_name"> <return type="void" /> - <argument index="0" name="gutter" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="gutter" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets the name of the gutter. </description> </method> <method name="set_gutter_overwritable"> <return type="void" /> - <argument index="0" name="gutter" type="int" /> - <argument index="1" name="overwritable" type="bool" /> + <param index="0" name="gutter" type="int" /> + <param index="1" name="overwritable" type="bool" /> <description> Sets the gutter to overwritable. See [method merge_gutters]. </description> </method> <method name="set_gutter_type"> <return type="void" /> - <argument index="0" name="gutter" type="int" /> - <argument index="1" name="type" type="int" enum="TextEdit.GutterType" /> + <param index="0" name="gutter" type="int" /> + <param index="1" name="type" type="int" enum="TextEdit.GutterType" /> <description> Sets the type of gutter. </description> </method> <method name="set_gutter_width"> <return type="void" /> - <argument index="0" name="gutter" type="int" /> - <argument index="1" name="width" type="int" /> + <param index="0" name="gutter" type="int" /> + <param index="1" name="width" type="int" /> <description> Set the width of the gutter. </description> </method> <method name="set_line"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="new_text" type="String" /> + <param index="0" name="line" type="int" /> + <param index="1" name="new_text" type="String" /> <description> Sets the text for a specific line. </description> </method> <method name="set_line_as_center_visible"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="wrap_index" type="int" default="0" /> + <param index="0" name="line" type="int" /> + <param index="1" name="wrap_index" type="int" default="0" /> <description> Positions the [code]wrap_index[/code] of [code]line[/code] at the center of the viewport. </description> </method> <method name="set_line_as_first_visible"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="wrap_index" type="int" default="0" /> + <param index="0" name="line" type="int" /> + <param index="1" name="wrap_index" type="int" default="0" /> <description> Positions the [code]wrap_index[/code] of [code]line[/code] at the top of the viewport. </description> </method> <method name="set_line_as_last_visible"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="wrap_index" type="int" default="0" /> + <param index="0" name="line" type="int" /> + <param index="1" name="wrap_index" type="int" default="0" /> <description> Positions the [code]wrap_index[/code] of [code]line[/code] at the bottom of the viewport. </description> </method> <method name="set_line_background_color"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="line" type="int" /> + <param index="1" name="color" type="Color" /> <description> Sets the current background color of the line. Set to [code]Color(0, 0, 0, 0)[/code] for no color. </description> </method> <method name="set_line_gutter_clickable"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> - <argument index="2" name="clickable" type="bool" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> + <param index="2" name="clickable" type="bool" /> <description> Sets the [code]gutter[/code] on [code]line[/code] as clickable. </description> </method> <method name="set_line_gutter_icon"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> - <argument index="2" name="icon" type="Texture2D" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> + <param index="2" name="icon" type="Texture2D" /> <description> Sets the icon for [code]gutter[/code] on [code]line[/code]. </description> </method> <method name="set_line_gutter_item_color"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> - <argument index="2" name="color" type="Color" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> + <param index="2" name="color" type="Color" /> <description> Sets the color for [code]gutter[/code] on [code]line[/code]. </description> </method> <method name="set_line_gutter_metadata"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> - <argument index="2" name="metadata" type="Variant" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> + <param index="2" name="metadata" type="Variant" /> <description> Sets the metadata for [code]gutter[/code] on [code]line[/code]. </description> </method> <method name="set_line_gutter_text"> <return type="void" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> - <argument index="2" name="text" type="String" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> + <param index="2" name="text" type="String" /> <description> Sets the text for [code]gutter[/code] on [code]line[/code]. </description> </method> <method name="set_overtype_mode_enabled"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> If [code]true[/code], sets the user into overtype mode. When the user types in this mode, it will override existing text. </description> </method> <method name="set_search_flags"> <return type="void" /> - <argument index="0" name="flags" type="int" /> + <param index="0" name="flags" type="int" /> <description> Sets the search flags. This is used with [method set_search_text] to highlight occurrences of the searched text. Search flags can be specified from the [enum SearchFlags] enum. </description> </method> <method name="set_search_text"> <return type="void" /> - <argument index="0" name="search_text" type="String" /> + <param index="0" name="search_text" type="String" /> <description> Sets the search text. See [method set_search_flags]. </description> </method> <method name="set_selection_mode"> <return type="void" /> - <argument index="0" name="mode" type="int" enum="TextEdit.SelectionMode" /> - <argument index="1" name="line" type="int" default="-1" /> - <argument index="2" name="column" type="int" default="-1" /> + <param index="0" name="mode" type="int" enum="TextEdit.SelectionMode" /> + <param index="1" name="line" type="int" default="-1" /> + <param index="2" name="column" type="int" default="-1" /> <description> Sets the current selection mode. </description> </method> <method name="set_tab_size"> <return type="void" /> - <argument index="0" name="size" type="int" /> + <param index="0" name="size" type="int" /> <description> Sets the tab size for the [TextEdit] to use. </description> </method> <method name="set_tooltip_request_func"> <return type="void" /> - <argument index="0" name="callback" type="Callable" /> + <param index="0" name="callback" type="Callable" /> <description> Provide custom tooltip text. The callback method must take the following args: [code]hovered_word: String[/code] </description> </method> <method name="swap_lines"> <return type="void" /> - <argument index="0" name="from_line" type="int" /> - <argument index="1" name="to_line" type="int" /> + <param index="0" name="from_line" type="int" /> + <param index="1" name="to_line" type="int" /> <description> Swaps the two lines. </description> @@ -1036,8 +1036,8 @@ </description> </signal> <signal name="gutter_clicked"> - <argument index="0" name="line" type="int" /> - <argument index="1" name="gutter" type="int" /> + <param index="0" name="line" type="int" /> + <param index="1" name="gutter" type="int" /> <description> Emitted when a gutter is clicked. </description> @@ -1048,8 +1048,8 @@ </description> </signal> <signal name="lines_edited_from"> - <argument index="0" name="from_line" type="int" /> - <argument index="1" name="to_line" type="int" /> + <param index="0" name="from_line" type="int" /> + <param index="1" name="to_line" type="int" /> <description> Emitted immediately when the text changes. When text is added [code]from_line[/code] will be less then [code]to_line[/code]. On a remove [code]to_line[/code] will be less then [code]from_line[/code]. diff --git a/doc/classes/TextLine.xml b/doc/classes/TextLine.xml index 601650db2e..c7fd767743 100644 --- a/doc/classes/TextLine.xml +++ b/doc/classes/TextLine.xml @@ -11,21 +11,21 @@ <methods> <method name="add_object"> <return type="bool" /> - <argument index="0" name="key" type="Variant" /> - <argument index="1" name="size" type="Vector2" /> - <argument index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> - <argument index="3" name="length" type="int" default="1" /> + <param index="0" name="key" type="Variant" /> + <param index="1" name="size" type="Vector2" /> + <param index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="3" name="length" type="int" default="1" /> <description> Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. </description> </method> <method name="add_string"> <return type="bool" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="font" type="Font" /> - <argument index="2" name="font_size" type="int" /> - <argument index="3" name="language" type="String" default="""" /> - <argument index="4" name="meta" type="Variant" default="null" /> + <param index="0" name="text" type="String" /> + <param index="1" name="font" type="Font" /> + <param index="2" name="font_size" type="int" /> + <param index="3" name="language" type="String" default="""" /> + <param index="4" name="meta" type="Variant" default="null" /> <description> Adds text span and font to draw it. </description> @@ -38,19 +38,19 @@ </method> <method name="draw" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. </description> </method> <method name="draw_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="outline_size" type="int" default="1" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="outline_size" type="int" default="1" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. </description> @@ -87,7 +87,7 @@ </method> <method name="get_object_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="key" type="Variant" /> + <param index="0" name="key" type="Variant" /> <description> Returns bounding rectangle of the inline object. </description> @@ -112,23 +112,23 @@ </method> <method name="hit_test" qualifiers="const"> <return type="int" /> - <argument index="0" name="coords" type="float" /> + <param index="0" name="coords" type="float" /> <description> Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. </description> </method> <method name="resize_object"> <return type="bool" /> - <argument index="0" name="key" type="Variant" /> - <argument index="1" name="size" type="Vector2" /> - <argument index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="0" name="key" type="Variant" /> + <param index="1" name="size" type="Vector2" /> + <param index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> <description> Sets new size and alignment of embedded object. </description> </method> <method name="set_bidi_override"> <return type="void" /> - <argument index="0" name="override" type="Array" /> + <param index="0" name="override" type="Array" /> <description> Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -136,7 +136,7 @@ </method> <method name="tab_align"> <return type="void" /> - <argument index="0" name="tab_stops" type="PackedFloat32Array" /> + <param index="0" name="tab_stops" type="PackedFloat32Array" /> <description> Aligns text to the given tab-stops. </description> diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index c733d8fcee..ea3815cec4 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -11,21 +11,21 @@ <methods> <method name="add_object"> <return type="bool" /> - <argument index="0" name="key" type="Variant" /> - <argument index="1" name="size" type="Vector2" /> - <argument index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> - <argument index="3" name="length" type="int" default="1" /> + <param index="0" name="key" type="Variant" /> + <param index="1" name="size" type="Vector2" /> + <param index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="3" name="length" type="int" default="1" /> <description> Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. </description> </method> <method name="add_string"> <return type="bool" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="font" type="Font" /> - <argument index="2" name="font_size" type="int" /> - <argument index="3" name="language" type="String" default="""" /> - <argument index="4" name="meta" type="Variant" default="null" /> + <param index="0" name="text" type="String" /> + <param index="1" name="font" type="Font" /> + <param index="2" name="font_size" type="int" /> + <param index="3" name="language" type="String" default="""" /> + <param index="4" name="meta" type="Variant" default="null" /> <description> Adds text span and font to draw it. </description> @@ -44,61 +44,61 @@ </method> <method name="draw" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="3" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="3" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw all lines of the text and drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. </description> </method> <method name="draw_dropcap" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. </description> </method> <method name="draw_dropcap_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="outline_size" type="int" default="1" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="outline_size" type="int" default="1" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw drop cap outline into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. </description> </method> <method name="draw_line" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="line" type="int" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="line" type="int" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw single line of text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. </description> </method> <method name="draw_line_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="line" type="int" /> - <argument index="3" name="outline_size" type="int" default="1" /> - <argument index="4" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="line" type="int" /> + <param index="3" name="outline_size" type="int" default="1" /> + <param index="4" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw outline of the single line of text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. </description> </method> <method name="draw_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="outline_size" type="int" default="1" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="outline_size" type="int" default="1" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. </description> @@ -123,7 +123,7 @@ </method> <method name="get_line_ascent" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the text line ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). </description> @@ -136,64 +136,64 @@ </method> <method name="get_line_descent" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the text line descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). </description> </method> <method name="get_line_object_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="key" type="Variant" /> + <param index="0" name="line" type="int" /> + <param index="1" name="key" type="Variant" /> <description> Returns bounding rectangle of the inline object. </description> </method> <method name="get_line_objects" qualifiers="const"> <return type="Array" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns array of inline objects in the line. </description> </method> <method name="get_line_range" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns character range of the line. </description> </method> <method name="get_line_rid" qualifiers="const"> <return type="RID" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns TextServer line buffer RID. </description> </method> <method name="get_line_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns size of the bounding box of the line of text. </description> </method> <method name="get_line_underline_position" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns pixel offset of the underline below the baseline. </description> </method> <method name="get_line_underline_thickness" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns thickness of the underline. </description> </method> <method name="get_line_width" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns width (for horizontal layout) or height (for vertical) of the line of text. </description> @@ -218,23 +218,23 @@ </method> <method name="hit_test" qualifiers="const"> <return type="int" /> - <argument index="0" name="coords" type="Vector2" /> + <param index="0" name="coords" type="Vector2" /> <description> Returns caret character offset at the specified coordinates. This function always returns a valid position. </description> </method> <method name="resize_object"> <return type="bool" /> - <argument index="0" name="key" type="Variant" /> - <argument index="1" name="size" type="Vector2" /> - <argument index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="0" name="key" type="Variant" /> + <param index="1" name="size" type="Vector2" /> + <param index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> <description> Sets new size and alignment of embedded object. </description> </method> <method name="set_bidi_override"> <return type="void" /> - <argument index="0" name="override" type="Array" /> + <param index="0" name="override" type="Array" /> <description> Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -242,18 +242,18 @@ </method> <method name="set_dropcap"> <return type="bool" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="font" type="Font" /> - <argument index="2" name="font_size" type="int" /> - <argument index="3" name="dropcap_margins" type="Rect2" default="Rect2(0, 0, 0, 0)" /> - <argument index="4" name="language" type="String" default="""" /> + <param index="0" name="text" type="String" /> + <param index="1" name="font" type="Font" /> + <param index="2" name="font_size" type="int" /> + <param index="3" name="dropcap_margins" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="4" name="language" type="String" default="""" /> <description> Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. </description> </method> <method name="tab_align"> <return type="void" /> - <argument index="0" name="tab_stops" type="PackedFloat32Array" /> + <param index="0" name="tab_stops" type="PackedFloat32Array" /> <description> Aligns paragraph to the given tab-stops. </description> diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index b54536f897..be3c04e913 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -17,8 +17,8 @@ </method> <method name="create_shaped_text"> <return type="RID" /> - <argument index="0" name="direction" type="int" enum="TextServer.Direction" default="0" /> - <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="1" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method free_rid] method. [b]Note:[/b] Direction is ignored if server does not support [constant FEATURE_BIDI_LAYOUT] feature (supported by [TextServerAdvanced]). @@ -27,19 +27,19 @@ </method> <method name="draw_hex_code_box" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="pos" type="Vector2" /> - <argument index="3" name="index" type="int" /> - <argument index="4" name="color" type="Color" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="pos" type="Vector2" /> + <param index="3" name="index" type="int" /> + <param index="4" name="color" type="Color" /> <description> Draws box displaying character hexadecimal code. Used for replacing missing characters. </description> </method> <method name="font_clear_glyphs"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes all rendered glyphs information from the cache entry. [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually. @@ -47,23 +47,23 @@ </method> <method name="font_clear_kerning_map"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Removes all kerning overrides. </description> </method> <method name="font_clear_size_cache"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Removes all font sizes from the cache entry. </description> </method> <method name="font_clear_textures"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes all textures from font cache entry. [b]Note:[/b] This function will not remove glyphs associated with the texture, use [method font_remove_glyph] to remove them manually. @@ -71,12 +71,12 @@ </method> <method name="font_draw_glyph" qualifiers="const"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="size" type="int" /> - <argument index="3" name="pos" type="Vector2" /> - <argument index="4" name="index" type="int" /> - <argument index="5" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="size" type="int" /> + <param index="3" name="pos" type="Vector2" /> + <param index="4" name="index" type="int" /> + <param index="5" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draws single glyph into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index]. @@ -85,13 +85,13 @@ </method> <method name="font_draw_glyph_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="size" type="int" /> - <argument index="3" name="outline_size" type="int" /> - <argument index="4" name="pos" type="Vector2" /> - <argument index="5" name="index" type="int" /> - <argument index="6" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="size" type="int" /> + <param index="3" name="outline_size" type="int" /> + <param index="4" name="pos" type="Vector2" /> + <param index="5" name="index" type="int" /> + <param index="6" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draws single glyph outline of size [code]outline_size[/code] into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index]. @@ -100,51 +100,51 @@ </method> <method name="font_get_ascent" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns the font ascent (number of pixels above the baseline). </description> </method> <method name="font_get_descent" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns the font descent (number of pixels below the baseline). </description> </method> <method name="font_get_embolden" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font embolden strength. </description> </method> <method name="font_get_face_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns number of faces in the TrueType / OpenType collection. </description> </method> <method name="font_get_face_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Recturns an active face index in the TrueType / OpenType collection. </description> </method> <method name="font_get_fixed_size" qualifiers="const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns bitmap font fixed size. </description> </method> <method name="font_get_generate_mipmaps" qualifiers="const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns [code]true[/code] if font texture mipmap generation is enabled. </description> @@ -157,9 +157,9 @@ </method> <method name="font_get_glyph_advance" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph" type="int" /> <description> Returns glyph advance (offset of the next glyph). [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. @@ -167,9 +167,9 @@ </method> <method name="font_get_glyph_contours" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="font" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="index" type="int" /> + <param index="0" name="font" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="index" type="int" /> <description> Returns outline contours of the glyph as a [code]Dictionary[/code] with the following contents: [code]points[/code] - [PackedVector3Array], containing outline points. [code]x[/code] and [code]y[/code] are point coordinates. [code]z[/code] is the type of the point, using the [enum ContourPointTag] values. @@ -179,54 +179,54 @@ </method> <method name="font_get_glyph_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="char" type="int" /> - <argument index="3" name="variation_selector" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="char" type="int" /> + <param index="3" name="variation_selector" type="int" /> <description> Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. </description> </method> <method name="font_get_glyph_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Returns list of rendered glyphs in the cache entry. </description> </method> <method name="font_get_glyph_offset" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns glyph offset from the baseline. </description> </method> <method name="font_get_glyph_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns size of the glyph. </description> </method> <method name="font_get_glyph_texture_idx" qualifiers="const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns index of the cache texture containing the glyph. </description> </method> <method name="font_get_glyph_texture_rid" qualifiers="const"> <return type="RID" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns resource id of the cache texture containing the glyph. [b]Note:[/b] If there are pending glyphs to render, calling this function might trigger the texture cache update. @@ -234,9 +234,9 @@ </method> <method name="font_get_glyph_texture_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns size of the cache texture containing the glyph. [b]Note:[/b] If there are pending glyphs to render, calling this function might trigger the texture cache update. @@ -244,251 +244,251 @@ </method> <method name="font_get_glyph_uv_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns rectangle in the cache texture containing the glyph. </description> </method> <method name="font_get_hinting" qualifiers="const"> <return type="int" enum="TextServer.Hinting" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns the font hinting mode. Used by dynamic fonts only. </description> </method> <method name="font_get_kerning" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> <description> Returns kerning for the pair of glyphs. </description> </method> <method name="font_get_kerning_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns list of the kerning overrides. </description> </method> <method name="font_get_language_support_override"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="language" type="String" /> <description> Returns [code]true[/code] if support override is enabled for the [code]language[/code]. </description> </method> <method name="font_get_language_support_overrides"> <return type="PackedStringArray" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns list of language support overrides. </description> </method> <method name="font_get_msdf_pixel_range" qualifiers="const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns the width of the range around the shape between the minimum and maximum representable signed distance. </description> </method> <method name="font_get_msdf_size" qualifiers="const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns source font size used to generate MSDF textures. </description> </method> <method name="font_get_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font family name. </description> </method> <method name="font_get_opentype_feature_overrides" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font OpenType feature set override. </description> </method> <method name="font_get_oversampling" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. </description> </method> <method name="font_get_scale" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns scaling factor of the color bitmap font. </description> </method> <method name="font_get_script_support_override"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="script" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="script" type="String" /> <description> Returns [code]true[/code] if support override is enabled for the [code]script[/code]. </description> </method> <method name="font_get_script_support_overrides"> <return type="PackedStringArray" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns list of script support overrides. </description> </method> <method name="font_get_size_cache_list" qualifiers="const"> <return type="Array" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. </description> </method> <method name="font_get_style" qualifiers="const"> <return type="int" enum="TextServer.FontStyle" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font style flags, see [enum FontStyle]. </description> </method> <method name="font_get_style_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font style name. </description> </method> <method name="font_get_subpixel_positioning" qualifiers="const"> <return type="int" enum="TextServer.SubpixelPositioning" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font sub-pixel glyph positioning mode. </description> </method> <method name="font_get_supported_chars" qualifiers="const"> <return type="String" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns a string containing all the characters available in the font. </description> </method> <method name="font_get_texture_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Returns number of textures used by font cache entry. </description> </method> <method name="font_get_texture_image" qualifiers="const"> <return type="Image" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Returns font cache texture image data. </description> </method> <method name="font_get_texture_offsets" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Returns array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. </description> </method> <method name="font_get_transform" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns 2D transform applied to the font outlines. </description> </method> <method name="font_get_underline_position" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns pixel offset of the underline below the baseline. </description> </method> <method name="font_get_underline_thickness" qualifiers="const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns thickness of the underline in pixels. </description> </method> <method name="font_get_variation_coordinates" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info. </description> </method> <method name="font_has_char" qualifiers="const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="char" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="char" type="int" /> <description> Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. </description> </method> <method name="font_is_antialiased" qualifiers="const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns [code]true[/code] if font 8-bit anitialiased glyph rendering is supported and enabled. </description> </method> <method name="font_is_force_autohinter" qualifiers="const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns [code]true[/code] if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only. </description> </method> <method name="font_is_language_supported" qualifiers="const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="language" type="String" /> <description> Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). </description> </method> <method name="font_is_multichannel_signed_distance_field" qualifiers="const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. </description> </method> <method name="font_is_script_supported" qualifiers="const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="script" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="script" type="String" /> <description> Returns [code]true[/code], if font supports given script (ISO 15924 code). </description> </method> <method name="font_remove_glyph"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Removes specified rendered glyph information from the cache entry. [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually. @@ -496,42 +496,42 @@ </method> <method name="font_remove_kerning"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> <description> Removes kerning override for the pair of glyphs. </description> </method> <method name="font_remove_language_support_override"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="language" type="String" /> <description> Remove language support override. </description> </method> <method name="font_remove_script_support_override"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="script" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="script" type="String" /> <description> Removes script support override. </description> </method> <method name="font_remove_size_cache"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes specified font size from the cache entry. </description> </method> <method name="font_remove_texture"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Removes specified texture from the cache entry. [b]Note:[/b] This function will not remove glyphs associated with the texture, remove them manually, using [method font_remove_glyph]. @@ -539,100 +539,100 @@ </method> <method name="font_render_glyph"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="index" type="int" /> <description> Renders specified glyph to the font cache texture. </description> </method> <method name="font_render_range"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="start" type="int" /> - <argument index="3" name="end" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="start" type="int" /> + <param index="3" name="end" type="int" /> <description> Renders the range of characters to the font cache texture. </description> </method> <method name="font_set_antialiased"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="antialiased" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="antialiased" type="bool" /> <description> If set to [code]true[/code], 8-bit antialiased glyph rendering is used, otherwise 1-bit rendering is used. Used by dynamic fonts only. </description> </method> <method name="font_set_ascent"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="ascent" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="ascent" type="float" /> <description> Sets the font ascent (number of pixels above the baseline). </description> </method> <method name="font_set_data"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="data" type="PackedByteArray" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="data" type="PackedByteArray" /> <description> Sets font source data, e.g contents of the dynamic font source file. </description> </method> <method name="font_set_descent"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="descent" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="descent" type="float" /> <description> Sets the font descent (number of pixels below the baseline). </description> </method> <method name="font_set_embolden"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="strength" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="strength" type="float" /> <description> Sets font embolden strength. If [code]strength[/code] is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. </description> </method> <method name="font_set_face_index"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="face_index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="face_index" type="int" /> <description> Sets an active face index in the TrueType / OpenType collection. </description> </method> <method name="font_set_fixed_size"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="fixed_size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="fixed_size" type="int" /> <description> Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. </description> </method> <method name="font_set_force_autohinter"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="force_autohinter" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="force_autohinter" type="bool" /> <description> If set to [code]true[/code] auto-hinting is preferred over font built-in hinting. </description> </method> <method name="font_set_generate_mipmaps"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="generate_mipmaps" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="generate_mipmaps" type="bool" /> <description> If set to [code]true[/code] font texture mipmap generation is enabled. </description> </method> <method name="font_set_global_oversampling"> <return type="void" /> - <argument index="0" name="oversampling" type="float" /> + <param index="0" name="oversampling" type="float" /> <description> Sets oversampling factor, shared by all font in the TextServer. [b]Note:[/b] This value can be automatically changed by display server. @@ -640,10 +640,10 @@ </method> <method name="font_set_glyph_advance"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="advance" type="Vector2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="advance" type="Vector2" /> <description> Sets glyph advance (offset of the next glyph). [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. @@ -651,91 +651,91 @@ </method> <method name="font_set_glyph_offset"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="offset" type="Vector2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="offset" type="Vector2" /> <description> Sets glyph offset from the baseline. </description> </method> <method name="font_set_glyph_size"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="gl_size" type="Vector2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="gl_size" type="Vector2" /> <description> Sets size of the glyph. </description> </method> <method name="font_set_glyph_texture_idx"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="texture_idx" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="texture_idx" type="int" /> <description> Sets index of the cache texture containing the glyph. </description> </method> <method name="font_set_glyph_uv_rect"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="uv_rect" type="Rect2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="uv_rect" type="Rect2" /> <description> Sets rectangle in the cache texture containing the glyph. </description> </method> <method name="font_set_hinting"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="hinting" type="int" enum="TextServer.Hinting" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="hinting" type="int" enum="TextServer.Hinting" /> <description> Sets font hinting mode. Used by dynamic fonts only. </description> </method> <method name="font_set_kerning"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> - <argument index="3" name="kerning" type="Vector2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> + <param index="3" name="kerning" type="Vector2" /> <description> Sets kerning for the pair of glyphs. </description> </method> <method name="font_set_language_support_override"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="language" type="String" /> - <argument index="2" name="supported" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="language" type="String" /> + <param index="2" name="supported" type="bool" /> <description> Adds override for [method font_is_language_supported]. </description> </method> <method name="font_set_msdf_pixel_range"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="msdf_pixel_range" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="msdf_pixel_range" type="int" /> <description> Sets the width of the range around the shape between the minimum and maximum representable signed distance. </description> </method> <method name="font_set_msdf_size"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="msdf_size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="msdf_size" type="int" /> <description> Sets source font size used to generate MSDF textures. </description> </method> <method name="font_set_multichannel_signed_distance_field"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="msdf" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="msdf" type="bool" /> <description> If set to [code]true[/code], glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. [b]Note:[/b] MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts. @@ -743,94 +743,94 @@ </method> <method name="font_set_name"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="name" type="String" /> <description> Sets the font family name. </description> </method> <method name="font_set_opentype_feature_overrides"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="overrides" type="Dictionary" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="overrides" type="Dictionary" /> <description> Sets font OpenType feature set override. </description> </method> <method name="font_set_oversampling"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="oversampling" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="oversampling" type="float" /> <description> Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. </description> </method> <method name="font_set_scale"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="scale" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="scale" type="float" /> <description> Sets scaling factor of the color bitmap font. </description> </method> <method name="font_set_script_support_override"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="script" type="String" /> - <argument index="2" name="supported" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="script" type="String" /> + <param index="2" name="supported" type="bool" /> <description> Adds override for [method font_is_script_supported]. </description> </method> <method name="font_set_style"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="style" type="int" enum="TextServer.FontStyle" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="style" type="int" enum="TextServer.FontStyle" /> <description> Sets the font style flags, see [enum FontStyle]. </description> </method> <method name="font_set_style_name"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="name" type="String" /> <description> Sets the font style name. </description> </method> <method name="font_set_subpixel_positioning"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="subpixel_positioning" type="int" enum="TextServer.SubpixelPositioning" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="subpixel_positioning" type="int" enum="TextServer.SubpixelPositioning" /> <description> Sets font sub-pixel glyph positioning mode. </description> </method> <method name="font_set_texture_image"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> - <argument index="3" name="image" type="Image" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> + <param index="3" name="image" type="Image" /> <description> Sets font cache texture image data. </description> </method> <method name="font_set_texture_offsets"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> - <argument index="3" name="offset" type="PackedInt32Array" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> + <param index="3" name="offset" type="PackedInt32Array" /> <description> Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. </description> </method> <method name="font_set_transform"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. For example, to simulate italic typeface by slanting, apply the following transform [code]Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)[/code]. @@ -838,55 +838,55 @@ </method> <method name="font_set_underline_position"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="underline_position" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="underline_position" type="float" /> <description> Sets pixel offset of the underline below the baseline. </description> </method> <method name="font_set_underline_thickness"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="underline_thickness" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="underline_thickness" type="float" /> <description> Sets thickness of the underline in pixels. </description> </method> <method name="font_set_variation_coordinates"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="variation_coordinates" type="Dictionary" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="variation_coordinates" type="Dictionary" /> <description> Sets variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info. </description> </method> <method name="font_supported_feature_list" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns the dictionary of the supported OpenType features. </description> </method> <method name="font_supported_variation_list" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns the dictionary of the supported OpenType variation coordinates. </description> </method> <method name="format_number" qualifiers="const"> <return type="String" /> - <argument index="0" name="number" type="String" /> - <argument index="1" name="language" type="String" default="""" /> + <param index="0" name="number" type="String" /> + <param index="1" name="language" type="String" default="""" /> <description> Converts a number from the Western Arabic (0..9) to the numeral systems used in [code]language[/code]. </description> </method> <method name="free_rid"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Frees an object created by this [TextServer]. </description> @@ -899,8 +899,8 @@ </method> <method name="get_hex_code_box_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="size" type="int" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="size" type="int" /> + <param index="1" name="index" type="int" /> <description> Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). </description> @@ -925,22 +925,22 @@ </method> <method name="has"> <return type="bool" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Returns [code]true[/code] if [code]rid[/code] is valid resource owned by this text server. </description> </method> <method name="has_feature" qualifiers="const"> <return type="bool" /> - <argument index="0" name="feature" type="int" enum="TextServer.Feature" /> + <param index="0" name="feature" type="int" enum="TextServer.Feature" /> <description> Returns [code]true[/code] if the server supports a feature. </description> </method> <method name="is_confusable" qualifiers="const"> <return type="int" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="dict" type="PackedStringArray" /> + <param index="0" name="string" type="String" /> + <param index="1" name="dict" type="PackedStringArray" /> <description> Returns index of the first string in [code]dict[/dict] which is visually confusable with the [code]string[/string], or [code]-1[/code] if none is found. [b]Note:[/b] This method doesn't detect invisible characters, for spoof detection use it in combination with [method spoof_check]. @@ -949,14 +949,14 @@ </method> <method name="is_locale_right_to_left" qualifiers="const"> <return type="bool" /> - <argument index="0" name="locale" type="String" /> + <param index="0" name="locale" type="String" /> <description> Returns [code]true[/code] if locale is right-to-left. </description> </method> <method name="is_valid_identifier" qualifiers="const"> <return type="bool" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Returns [code]true[/code] is [code]string[/code] is a valid identifier. If the text server supports the [constant FEATURE_UNICODE_IDENTIFIERS] feature, a valid identifier must: @@ -971,7 +971,7 @@ </method> <method name="load_support_data"> <return type="bool" /> - <argument index="0" name="filename" type="String" /> + <param index="0" name="filename" type="String" /> <description> Loads optional TextServer database (e.g. ICU break iterators and dictionaries). [b]Note:[/b] This function should be called before any other TextServer functions used, otherwise it won't have any effect. @@ -979,38 +979,38 @@ </method> <method name="name_to_tag" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Converts readable feature, variation, script or language name to OpenType tag. </description> </method> <method name="parse_number" qualifiers="const"> <return type="String" /> - <argument index="0" name="number" type="String" /> - <argument index="1" name="language" type="String" default="""" /> + <param index="0" name="number" type="String" /> + <param index="1" name="language" type="String" default="""" /> <description> Converts a number from the numeral systems used in [code]language[/code] to Western Arabic (0..9). </description> </method> <method name="parse_structured_text" qualifiers="const"> <return type="Array" /> - <argument index="0" name="parser_type" type="int" enum="TextServer.StructuredTextParser" /> - <argument index="1" name="args" type="Array" /> - <argument index="2" name="text" type="String" /> + <param index="0" name="parser_type" type="int" enum="TextServer.StructuredTextParser" /> + <param index="1" name="args" type="Array" /> + <param index="2" name="text" type="String" /> <description> Default implementation of the BiDi algorithm override function. See [enum StructuredTextParser] for more info. </description> </method> <method name="percent_sign" qualifiers="const"> <return type="String" /> - <argument index="0" name="language" type="String" default="""" /> + <param index="0" name="language" type="String" default="""" /> <description> Returns percent sign used in the [code]language[/code]. </description> </method> <method name="save_support_data" qualifiers="const"> <return type="bool" /> - <argument index="0" name="filename" type="String" /> + <param index="0" name="filename" type="String" /> <description> Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. [b]Note:[/b] This function is used by during project export, to include TextServer database. @@ -1018,98 +1018,98 @@ </method> <method name="shaped_get_span_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns number of text spans added using [method shaped_text_add_string] or [method shaped_text_add_object]. </description> </method> <method name="shaped_get_span_meta" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="index" type="int" /> <description> Returns text span metadata. </description> </method> <method name="shaped_set_span_update_font"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="index" type="int" /> - <argument index="2" name="fonts" type="Array" /> - <argument index="3" name="size" type="int" /> - <argument index="4" name="opentype_features" type="Dictionary" default="{}" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="index" type="int" /> + <param index="2" name="fonts" type="Array" /> + <param index="3" name="size" type="int" /> + <param index="4" name="opentype_features" type="Dictionary" default="{}" /> <description> Changes text span font, font size and OpenType features, without changing the text. </description> </method> <method name="shaped_text_add_object"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="key" type="Variant" /> - <argument index="2" name="size" type="Vector2" /> - <argument index="3" name="inline_align" type="int" enum="InlineAlignment" default="5" /> - <argument index="4" name="length" type="int" default="1" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="key" type="Variant" /> + <param index="2" name="size" type="Vector2" /> + <param index="3" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="4" name="length" type="int" default="1" /> <description> Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. </description> </method> <method name="shaped_text_add_string"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="text" type="String" /> - <argument index="2" name="fonts" type="Array" /> - <argument index="3" name="size" type="int" /> - <argument index="4" name="opentype_features" type="Dictionary" default="{}" /> - <argument index="5" name="language" type="String" default="""" /> - <argument index="6" name="meta" type="Variant" default="null" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="text" type="String" /> + <param index="2" name="fonts" type="Array" /> + <param index="3" name="size" type="int" /> + <param index="4" name="opentype_features" type="Dictionary" default="{}" /> + <param index="5" name="language" type="String" default="""" /> + <param index="6" name="meta" type="Variant" default="null" /> <description> Adds text span and font to draw it to the text buffer. </description> </method> <method name="shaped_text_clear"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Clears text buffer (removes text and inline objects). </description> </method> <method name="shaped_text_draw" qualifiers="const"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="pos" type="Vector2" /> - <argument index="3" name="clip_l" type="float" default="-1" /> - <argument index="4" name="clip_r" type="float" default="-1" /> - <argument index="5" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="pos" type="Vector2" /> + <param index="3" name="clip_l" type="float" default="-1" /> + <param index="4" name="clip_r" type="float" default="-1" /> + <param index="5" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). </description> </method> <method name="shaped_text_draw_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="pos" type="Vector2" /> - <argument index="3" name="clip_l" type="float" default="-1" /> - <argument index="4" name="clip_r" type="float" default="-1" /> - <argument index="5" name="outline_size" type="int" default="1" /> - <argument index="6" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="pos" type="Vector2" /> + <param index="3" name="clip_l" type="float" default="-1" /> + <param index="4" name="clip_r" type="float" default="-1" /> + <param index="5" name="outline_size" type="int" default="1" /> + <param index="6" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draw the outline of the shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). </description> </method> <method name="shaped_text_fit_to_width"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="width" type="float" /> - <argument index="2" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="width" type="float" /> + <param index="2" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" /> <description> Adjusts text with to fit to specified width, returns new text width. </description> </method> <method name="shaped_text_get_ascent" qualifiers="const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). [b]Note:[/b] Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline. @@ -1117,22 +1117,22 @@ </method> <method name="shaped_text_get_carets" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="position" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="position" type="int" /> <description> Returns shapes of the carets corresponding to the character offset [code]position[/code] in the text. Returned caret shape is 1 pixel wide rectangle. </description> </method> <method name="shaped_text_get_custom_punctuation" qualifiers="const"> <return type="String" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. </description> </method> <method name="shaped_text_get_descent" qualifiers="const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). [b]Note:[/b] Overall descent can be higher than font descent, if some glyphs are displaced from the baseline. @@ -1140,130 +1140,130 @@ </method> <method name="shaped_text_get_direction" qualifiers="const"> <return type="int" enum="TextServer.Direction" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns direction of the text. </description> </method> <method name="shaped_text_get_dominant_direction_in_range" qualifiers="const"> <return type="int" enum="TextServer.Direction" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="start" type="int" /> - <argument index="2" name="end" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="start" type="int" /> + <param index="2" name="end" type="int" /> <description> Returns dominant direction of in the range of text. </description> </method> <method name="shaped_text_get_ellipsis_glyph_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns number of glyphs in the ellipsis. </description> </method> <method name="shaped_text_get_ellipsis_glyphs" qualifiers="const"> <return type="Array" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns array of the glyphs in the ellipsis. </description> </method> <method name="shaped_text_get_ellipsis_pos" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns position of the ellipsis. </description> </method> <method name="shaped_text_get_glyph_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns number of glyphs in the buffer. </description> </method> <method name="shaped_text_get_glyphs" qualifiers="const"> <return type="Array" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns an array of glyphs in the visual order. </description> </method> <method name="shaped_text_get_grapheme_bounds" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="pos" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="pos" type="int" /> <description> Returns composite character's bounds as offsets from the start of the line. </description> </method> <method name="shaped_text_get_inferred_direction" qualifiers="const"> <return type="int" enum="TextServer.Direction" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns direction of the text, inferred by the BiDi algorithm. </description> </method> <method name="shaped_text_get_line_breaks" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="width" type="float" /> - <argument index="2" name="start" type="int" default="0" /> - <argument index="3" name="break_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="width" type="float" /> + <param index="2" name="start" type="int" default="0" /> + <param index="3" name="break_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> <description> Breaks text to the lines and returns character ranges for each line. </description> </method> <method name="shaped_text_get_line_breaks_adv" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="width" type="PackedFloat32Array" /> - <argument index="2" name="start" type="int" default="0" /> - <argument index="3" name="once" type="bool" default="true" /> - <argument index="4" name="break_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="width" type="PackedFloat32Array" /> + <param index="2" name="start" type="int" default="0" /> + <param index="3" name="once" type="bool" default="true" /> + <param index="4" name="break_flags" type="int" enum="TextServer.LineBreakFlag" default="3" /> <description> Breaks text to the lines and columns. Returns character ranges for each segment. </description> </method> <method name="shaped_text_get_object_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="key" type="Variant" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="key" type="Variant" /> <description> Returns bounding rectangle of the inline object. </description> </method> <method name="shaped_text_get_objects" qualifiers="const"> <return type="Array" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns array of inline objects. </description> </method> <method name="shaped_text_get_orientation" qualifiers="const"> <return type="int" enum="TextServer.Orientation" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns text orientation. </description> </method> <method name="shaped_text_get_parent" qualifiers="const"> <return type="RID" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns the parent buffer from which the substring originates. </description> </method> <method name="shaped_text_get_preserve_control" qualifiers="const"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns [code]true[/code] if text buffer is configured to display control characters. </description> </method> <method name="shaped_text_get_preserve_invalid" qualifiers="const"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters. [b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters. @@ -1271,133 +1271,133 @@ </method> <method name="shaped_text_get_range" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns substring buffer character range in the parent buffer. </description> </method> <method name="shaped_text_get_selection" qualifiers="const"> <return type="PackedVector2Array" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="start" type="int" /> - <argument index="2" name="end" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="start" type="int" /> + <param index="2" name="end" type="int" /> <description> Returns selection rectangles for the specified character range. </description> </method> <method name="shaped_text_get_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns size of the text. </description> </method> <method name="shaped_text_get_spacing" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="spacing" type="int" enum="TextServer.SpacingType" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="spacing" type="int" enum="TextServer.SpacingType" /> <description> Returns extra spacing added between glyphs or lines in pixels. </description> </method> <method name="shaped_text_get_trim_pos" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns the position of the overrun trim. </description> </method> <method name="shaped_text_get_underline_position" qualifiers="const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns pixel offset of the underline below the baseline. </description> </method> <method name="shaped_text_get_underline_thickness" qualifiers="const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns thickness of the underline. </description> </method> <method name="shaped_text_get_width" qualifiers="const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns width (for horizontal layout) or height (for vertical) of the text. </description> </method> <method name="shaped_text_get_word_breaks" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="grapheme_flags" type="int" enum="TextServer.GraphemeFlag" default="264" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="grapheme_flags" type="int" enum="TextServer.GraphemeFlag" default="264" /> <description> Breaks text into words and returns array of character ranges. Use [code]grapheme_flags[/code] to set what characters are used for breaking (see [enum GraphemeFlag]). </description> </method> <method name="shaped_text_hit_test_grapheme" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="coords" type="float" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="coords" type="float" /> <description> Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found. </description> </method> <method name="shaped_text_hit_test_position" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="coords" type="float" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="coords" type="float" /> <description> Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. </description> </method> <method name="shaped_text_is_ready" qualifiers="const"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns [code]true[/code] if buffer is successfully shaped. </description> </method> <method name="shaped_text_next_grapheme_pos" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="pos" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="pos" type="int" /> <description> Returns composite character end position closest to the [code]pos[/code]. </description> </method> <method name="shaped_text_overrun_trim_to_width"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="width" type="float" default="0" /> - <argument index="2" name="overrun_trim_flags" type="int" enum="TextServer.TextOverrunFlag" default="0" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="width" type="float" default="0" /> + <param index="2" name="overrun_trim_flags" type="int" enum="TextServer.TextOverrunFlag" default="0" /> <description> Trims text if it exceeds the given width. </description> </method> <method name="shaped_text_prev_grapheme_pos" qualifiers="const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="pos" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="pos" type="int" /> <description> Returns composite character start position closest to the [code]pos[/code]. </description> </method> <method name="shaped_text_resize_object"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="key" type="Variant" /> - <argument index="2" name="size" type="Vector2" /> - <argument index="3" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="key" type="Variant" /> + <param index="2" name="size" type="Vector2" /> + <param index="3" name="inline_align" type="int" enum="InlineAlignment" default="5" /> <description> Sets new size and alignment of embedded object. </description> </method> <method name="shaped_text_set_bidi_override"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="override" type="Array" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="override" type="Array" /> <description> Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -1405,16 +1405,16 @@ </method> <method name="shaped_text_set_custom_punctuation"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="punct" type="String" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="punct" type="String" /> <description> Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. </description> </method> <method name="shaped_text_set_direction"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="direction" type="int" enum="TextServer.Direction" default="0" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="direction" type="int" enum="TextServer.Direction" default="0" /> <description> Sets desired text direction. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale. [b]Note:[/b] Direction is ignored if server does not support [constant FEATURE_BIDI_LAYOUT] feature (supported by [TextServerAdvanced]). @@ -1422,8 +1422,8 @@ </method> <method name="shaped_text_set_orientation"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Sets desired text orientation. [b]Note:[/b] Orientation is ignored if server does not support [constant FEATURE_VERTICAL_LAYOUT] feature (supported by [TextServerAdvanced]). @@ -1431,32 +1431,32 @@ </method> <method name="shaped_text_set_preserve_control"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If set to [code]true[/code] text buffer will display control characters. </description> </method> <method name="shaped_text_set_preserve_invalid"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. </description> </method> <method name="shaped_text_set_spacing"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="spacing" type="int" enum="TextServer.SpacingType" /> - <argument index="2" name="value" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="spacing" type="int" enum="TextServer.SpacingType" /> + <param index="2" name="value" type="int" /> <description> Sets extra spacing added between glyphs or lines in pixels. </description> </method> <method name="shaped_text_shape"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. [b]Note:[/b] It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested. @@ -1464,31 +1464,31 @@ </method> <method name="shaped_text_sort_logical"> <return type="Array" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns text glyphs in the logical order. </description> </method> <method name="shaped_text_substr" qualifiers="const"> <return type="RID" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="start" type="int" /> - <argument index="2" name="length" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="start" type="int" /> + <param index="2" name="length" type="int" /> <description> Returns text buffer for the substring of the text in the [code]shaped[/code] text buffer (including inline objects). </description> </method> <method name="shaped_text_tab_align"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="tab_stops" type="PackedFloat32Array" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="tab_stops" type="PackedFloat32Array" /> <description> Aligns shaped text to the given tab-stops. </description> </method> <method name="spoof_check" qualifiers="const"> <return type="bool" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Returns [code]true[/code] if [code]string[/code] is likely to be an attempt at confusing the reader. [b]Note:[/b] Always returns [code]false[/code] if the server does not support the [constant FEATURE_UNICODE_SECURITY] feature. @@ -1496,16 +1496,16 @@ </method> <method name="string_get_word_breaks" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="language" type="String" default="""" /> + <param index="0" name="string" type="String" /> + <param index="1" name="language" type="String" default="""" /> <description> Returns array of the word break character offsets. </description> </method> <method name="string_to_lower" qualifiers="const"> <return type="String" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="language" type="String" default="""" /> + <param index="0" name="string" type="String" /> + <param index="1" name="language" type="String" default="""" /> <description> Returns the string converted to lowercase. [b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]). @@ -1514,8 +1514,8 @@ </method> <method name="string_to_upper" qualifiers="const"> <return type="String" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="language" type="String" default="""" /> + <param index="0" name="string" type="String" /> + <param index="1" name="language" type="String" default="""" /> <description> Returns the string converted to uppercase. [b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]). @@ -1524,7 +1524,7 @@ </method> <method name="strip_diacritics" qualifiers="const"> <return type="String" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Strips diacritics from the string. [b]Note:[/b] The result may be longer or shorter than the original. @@ -1532,7 +1532,7 @@ </method> <method name="tag_to_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="tag" type="int" /> + <param index="0" name="tag" type="int" /> <description> Converts OpenType tag to readable feature, variation, script or language name. </description> diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml index c686a06e5e..acf6e5833d 100644 --- a/doc/classes/TextServerExtension.xml +++ b/doc/classes/TextServerExtension.xml @@ -17,19 +17,19 @@ </method> <method name="create_shaped_text" qualifiers="virtual"> <return type="RID" /> - <argument index="0" name="direction" type="int" enum="TextServer.Direction" /> - <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" /> + <param index="0" name="direction" type="int" enum="TextServer.Direction" /> + <param index="1" name="orientation" type="int" enum="TextServer.Orientation" /> <description> Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method free_rid] method. </description> </method> <method name="draw_hex_code_box" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="pos" type="Vector2" /> - <argument index="3" name="index" type="int" /> - <argument index="4" name="color" type="Color" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="pos" type="Vector2" /> + <param index="3" name="index" type="int" /> + <param index="4" name="color" type="Color" /> <description> Draws box displaying character hexadecimal code. Used for replacing missing characters. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -37,107 +37,107 @@ </method> <method name="font_clear_glyphs" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes all rendered glyphs information from the cache entry. </description> </method> <method name="font_clear_kerning_map" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Removes all kerning overrides. </description> </method> <method name="font_clear_size_cache" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Removes all font sizes from the cache entry. </description> </method> <method name="font_clear_textures" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes all textures from font cache entry. </description> </method> <method name="font_draw_glyph" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="size" type="int" /> - <argument index="3" name="pos" type="Vector2" /> - <argument index="4" name="index" type="int" /> - <argument index="5" name="color" type="Color" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="size" type="int" /> + <param index="3" name="pos" type="Vector2" /> + <param index="4" name="index" type="int" /> + <param index="5" name="color" type="Color" /> <description> Draws single glyph into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. </description> </method> <method name="font_draw_glyph_outline" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="size" type="int" /> - <argument index="3" name="outline_size" type="int" /> - <argument index="4" name="pos" type="Vector2" /> - <argument index="5" name="index" type="int" /> - <argument index="6" name="color" type="Color" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="size" type="int" /> + <param index="3" name="outline_size" type="int" /> + <param index="4" name="pos" type="Vector2" /> + <param index="5" name="index" type="int" /> + <param index="6" name="color" type="Color" /> <description> Draws single glyph outline of size [code]outline_size[/code] into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. </description> </method> <method name="font_get_ascent" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns the font ascent (number of pixels above the baseline). </description> </method> <method name="font_get_descent" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns the font descent (number of pixels below the baseline). </description> </method> <method name="font_get_embolden" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font embolden strength. </description> </method> <method name="font_get_face_count" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns number of faces in the TrueType / OpenType collection. </description> </method> <method name="font_get_face_index" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns an active face index in the TrueType / OpenType collection. </description> </method> <method name="font_get_fixed_size" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns bitmap font fixed size. </description> </method> <method name="font_get_generate_mipmaps" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns [code]true[/code] if font texture mipmap generation is enabled. </description> @@ -150,18 +150,18 @@ </method> <method name="font_get_glyph_advance" qualifiers="virtual const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph" type="int" /> <description> Returns glyph advance (offset of the next glyph). </description> </method> <method name="font_get_glyph_contours" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="index" type="int" /> <description> Returns outline contours of the glyph as a [code]Dictionary[/code] with the following contents: [code]points[/code] - [PackedVector3Array], containing outline points. [code]x[/code] and [code]y[/code] are point coordinates. [code]z[/code] is the type of the point, using the [enum TextServer.ContourPointTag] values. @@ -171,465 +171,465 @@ </method> <method name="font_get_glyph_index" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="char" type="int" /> - <argument index="3" name="variation_selector" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="char" type="int" /> + <param index="3" name="variation_selector" type="int" /> <description> Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. </description> </method> <method name="font_get_glyph_list" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Returns list of rendered glyphs in the cache entry. </description> </method> <method name="font_get_glyph_offset" qualifiers="virtual const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns glyph offset from the baseline. </description> </method> <method name="font_get_glyph_size" qualifiers="virtual const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns size of the glyph. </description> </method> <method name="font_get_glyph_texture_idx" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns index of the cache texture containing the glyph. </description> </method> <method name="font_get_glyph_texture_rid" qualifiers="virtual const"> <return type="RID" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns resource id of the cache texture containing the glyph. </description> </method> <method name="font_get_glyph_texture_size" qualifiers="virtual const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns size of the cache texture containing the glyph. </description> </method> <method name="font_get_glyph_uv_rect" qualifiers="virtual const"> <return type="Rect2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Returns rectangle in the cache texture containing the glyph. </description> </method> <method name="font_get_hinting" qualifiers="virtual const"> <return type="int" enum="TextServer.Hinting" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns the font hinting mode. Used by dynamic fonts only. </description> </method> <method name="font_get_kerning" qualifiers="virtual const"> <return type="Vector2" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> <description> Returns kerning for the pair of glyphs. </description> </method> <method name="font_get_kerning_list" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns list of the kerning overrides. </description> </method> <method name="font_get_language_support_override" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="language" type="String" /> <description> Returns [code]true[/code] if support override is enabled for the [code]language[/code]. </description> </method> <method name="font_get_language_support_overrides" qualifiers="virtual"> <return type="PackedStringArray" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns list of language support overrides. </description> </method> <method name="font_get_msdf_pixel_range" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns the width of the range around the shape between the minimum and maximum representable signed distance. </description> </method> <method name="font_get_msdf_size" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns source font size used to generate MSDF textures. </description> </method> <method name="font_get_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font family name. </description> </method> <method name="font_get_opentype_feature_overrides" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font OpenType feature set override. </description> </method> <method name="font_get_oversampling" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. </description> </method> <method name="font_get_scale" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns scaling factor of the color bitmap font. </description> </method> <method name="font_get_script_support_override" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="script" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="script" type="String" /> <description> Returns [code]true[/code] if support override is enabled for the [code]script[/code]. </description> </method> <method name="font_get_script_support_overrides" qualifiers="virtual"> <return type="PackedStringArray" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns list of script support overrides. </description> </method> <method name="font_get_size_cache_list" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. </description> </method> <method name="font_get_style" qualifiers="virtual const"> <return type="int" enum="TextServer.FontStyle" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font style flags, see [enum TextServer.FontStyle]. </description> </method> <method name="font_get_style_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font style name. </description> </method> <method name="font_get_subpixel_positioning" qualifiers="virtual const"> <return type="int" enum="TextServer.SubpixelPositioning" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns font sub-pixel glyph positioning mode. </description> </method> <method name="font_get_supported_chars" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns a string containing all the characters available in the font. </description> </method> <method name="font_get_texture_count" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Returns number of textures used by font cache entry. </description> </method> <method name="font_get_texture_image" qualifiers="virtual const"> <return type="Image" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Returns font cache texture image data. </description> </method> <method name="font_get_texture_offsets" qualifiers="virtual const"> <return type="PackedInt32Array" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Returns array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. </description> </method> <method name="font_get_transform" qualifiers="virtual const"> <return type="Transform2D" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns 2D transform applied to the font outlines. </description> </method> <method name="font_get_underline_position" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns pixel offset of the underline below the baseline. </description> </method> <method name="font_get_underline_thickness" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> <description> Returns thickness of the underline in pixels. </description> </method> <method name="font_get_variation_coordinates" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info. </description> </method> <method name="font_has_char" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="char" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="char" type="int" /> <description> Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. </description> </method> <method name="font_is_antialiased" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns [code]true[/code] if font 8-bit anitialiased glyph rendering is supported and enabled. </description> </method> <method name="font_is_force_autohinter" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns [code]true[/code] if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only. </description> </method> <method name="font_is_language_supported" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="language" type="String" /> <description> Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). </description> </method> <method name="font_is_multichannel_signed_distance_field" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. </description> </method> <method name="font_is_script_supported" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="script" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="script" type="String" /> <description> Returns [code]true[/code], if font supports given script (ISO 15924 code). </description> </method> <method name="font_remove_glyph" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> <description> Removes specified rendered glyph information from the cache entry. </description> </method> <method name="font_remove_kerning" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> <description> Removes kerning override for the pair of glyphs. </description> </method> <method name="font_remove_language_support_override" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="language" type="String" /> <description> Remove language support override. </description> </method> <method name="font_remove_script_support_override" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="script" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="script" type="String" /> <description> Removes script support override. </description> </method> <method name="font_remove_size_cache" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> <description> Removes specified font size from the cache entry. </description> </method> <method name="font_remove_texture" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> <description> Removes specified texture from the cache entry. </description> </method> <method name="font_render_glyph" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="index" type="int" /> <description> Renders specified glyph to the font cache texture. </description> </method> <method name="font_render_range" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="start" type="int" /> - <argument index="3" name="end" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="start" type="int" /> + <param index="3" name="end" type="int" /> <description> Renders the range of characters to the font cache texture. </description> </method> <method name="font_set_antialiased" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="antialiased" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="antialiased" type="bool" /> <description> If set to [code]true[/code], 8-bit antialiased glyph rendering is used, otherwise 1-bit rendering is used. Used by dynamic fonts only. </description> </method> <method name="font_set_ascent" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="ascent" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="ascent" type="float" /> <description> Sets the font ascent (number of pixels above the baseline). </description> </method> <method name="font_set_data" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="data" type="PackedByteArray" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="data" type="PackedByteArray" /> <description> Sets font source data, e.g contents of the dynamic font source file. </description> </method> <method name="font_set_data_ptr" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="data_ptr" type="const uint8_t*" /> - <argument index="2" name="data_size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="data_ptr" type="const uint8_t*" /> + <param index="2" name="data_size" type="int" /> <description> Sets font source data, e.g contents of the dynamic font source file. [code]data_ptr[/code] memory buffer must remain accessible during font lifetime. </description> </method> <method name="font_set_descent" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="descent" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="descent" type="float" /> <description> Sets the font descent (number of pixels below the baseline). </description> </method> <method name="font_set_embolden" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="strength" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="strength" type="float" /> <description> Sets font embolden strength. If [code]strength[/code] is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. </description> </method> <method name="font_set_face_index" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="face_index" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="face_index" type="int" /> <description> Sets an active face index in the TrueType / OpenType collection. </description> </method> <method name="font_set_fixed_size" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="fixed_size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="fixed_size" type="int" /> <description> Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. </description> </method> <method name="font_set_force_autohinter" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="force_autohinter" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="force_autohinter" type="bool" /> <description> If set to [code]true[/code] auto-hinting is preferred over font built-in hinting. </description> </method> <method name="font_set_generate_mipmaps" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="generate_mipmaps" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="generate_mipmaps" type="bool" /> <description> If set to [code]true[/code] font texture mipmap generation is enabled. </description> </method> <method name="font_set_global_oversampling" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="oversampling" type="float" /> + <param index="0" name="oversampling" type="float" /> <description> Sets oversampling factor, shared by all font in the TextServer. [b]Note:[/b] This value can be automatically changed by display server. @@ -637,101 +637,101 @@ </method> <method name="font_set_glyph_advance" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="advance" type="Vector2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="advance" type="Vector2" /> <description> Sets glyph advance (offset of the next glyph). </description> </method> <method name="font_set_glyph_offset" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="offset" type="Vector2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="offset" type="Vector2" /> <description> Sets glyph offset from the baseline. </description> </method> <method name="font_set_glyph_size" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="gl_size" type="Vector2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="gl_size" type="Vector2" /> <description> Sets size of the glyph. </description> </method> <method name="font_set_glyph_texture_idx" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="texture_idx" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="texture_idx" type="int" /> <description> Sets index of the cache texture containing the glyph. </description> </method> <method name="font_set_glyph_uv_rect" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="glyph" type="int" /> - <argument index="3" name="uv_rect" type="Rect2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="glyph" type="int" /> + <param index="3" name="uv_rect" type="Rect2" /> <description> Sets rectangle in the cache texture containing the glyph. </description> </method> <method name="font_set_hinting" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="hinting" type="int" enum="TextServer.Hinting" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="hinting" type="int" enum="TextServer.Hinting" /> <description> Sets font hinting mode. Used by dynamic fonts only. </description> </method> <method name="font_set_kerning" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="glyph_pair" type="Vector2i" /> - <argument index="3" name="kerning" type="Vector2" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="glyph_pair" type="Vector2i" /> + <param index="3" name="kerning" type="Vector2" /> <description> Sets kerning for the pair of glyphs. </description> </method> <method name="font_set_language_support_override" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="language" type="String" /> - <argument index="2" name="supported" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="language" type="String" /> + <param index="2" name="supported" type="bool" /> <description> Adds override for [method font_is_language_supported]. </description> </method> <method name="font_set_msdf_pixel_range" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="msdf_pixel_range" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="msdf_pixel_range" type="int" /> <description> Sets the width of the range around the shape between the minimum and maximum representable signed distance. </description> </method> <method name="font_set_msdf_size" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="msdf_size" type="int" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="msdf_size" type="int" /> <description> Sets source font size used to generate MSDF textures. </description> </method> <method name="font_set_multichannel_signed_distance_field" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="msdf" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="msdf" type="bool" /> <description> If set to [code]true[/code], glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. [b]Note:[/b] MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts. @@ -739,94 +739,94 @@ </method> <method name="font_set_name" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="name" type="String" /> <description> Sets the font family name. </description> </method> <method name="font_set_opentype_feature_overrides" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="overrides" type="Dictionary" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="overrides" type="Dictionary" /> <description> Sets font OpenType feature set override. </description> </method> <method name="font_set_oversampling" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="oversampling" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="oversampling" type="float" /> <description> Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. </description> </method> <method name="font_set_scale" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="scale" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="scale" type="float" /> <description> Sets scaling factor of the color bitmap font. </description> </method> <method name="font_set_script_support_override" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="script" type="String" /> - <argument index="2" name="supported" type="bool" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="script" type="String" /> + <param index="2" name="supported" type="bool" /> <description> Adds override for [method font_is_script_supported]. </description> </method> <method name="font_set_style" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="style" type="int" enum="TextServer.FontStyle" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="style" type="int" enum="TextServer.FontStyle" /> <description> Sets the font style flags, see [enum TextServer.FontStyle]. </description> </method> <method name="font_set_style_name" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="name_style" type="String" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="name_style" type="String" /> <description> Sets the font style name. </description> </method> <method name="font_set_subpixel_positioning" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="subpixel_positioning" type="int" enum="TextServer.SubpixelPositioning" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="subpixel_positioning" type="int" enum="TextServer.SubpixelPositioning" /> <description> Sets font sub-pixel glyph positioning mode. </description> </method> <method name="font_set_texture_image" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> - <argument index="3" name="image" type="Image" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> + <param index="3" name="image" type="Image" /> <description> Sets font cache texture image data. </description> </method> <method name="font_set_texture_offsets" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="texture_index" type="int" /> - <argument index="3" name="offset" type="PackedInt32Array" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="texture_index" type="int" /> + <param index="3" name="offset" type="PackedInt32Array" /> <description> Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. </description> </method> <method name="font_set_transform" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="transform" type="Transform2D" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="transform" type="Transform2D" /> <description> Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. For example, to simulate italic typeface by slanting, apply the following transform [code]Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)[/code]. @@ -834,55 +834,55 @@ </method> <method name="font_set_underline_position" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="underline_position" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="underline_position" type="float" /> <description> Sets pixel offset of the underline below the baseline. </description> </method> <method name="font_set_underline_thickness" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="size" type="int" /> - <argument index="2" name="underline_thickness" type="float" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="size" type="int" /> + <param index="2" name="underline_thickness" type="float" /> <description> Sets thickness of the underline in pixels. </description> </method> <method name="font_set_variation_coordinates" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="font_rid" type="RID" /> - <argument index="1" name="variation_coordinates" type="Dictionary" /> + <param index="0" name="font_rid" type="RID" /> + <param index="1" name="variation_coordinates" type="Dictionary" /> <description> Sets variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info. </description> </method> <method name="font_supported_feature_list" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns the dictionary of the supported OpenType features. </description> </method> <method name="font_supported_variation_list" qualifiers="virtual const"> <return type="Dictionary" /> - <argument index="0" name="font_rid" type="RID" /> + <param index="0" name="font_rid" type="RID" /> <description> Returns the dictionary of the supported OpenType variation coordinates. </description> </method> <method name="format_number" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="string" type="String" /> + <param index="1" name="language" type="String" /> <description> Converts a number from the Western Arabic (0..9) to the numeral systems used in [code]language[/code]. </description> </method> <method name="free_rid" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Frees an object created by this [TextServer]. </description> @@ -895,8 +895,8 @@ </method> <method name="get_hex_code_box_size" qualifiers="virtual const"> <return type="Vector2" /> - <argument index="0" name="size" type="int" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="size" type="int" /> + <param index="1" name="index" type="int" /> <description> Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -922,80 +922,80 @@ </method> <method name="has" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="rid" type="RID" /> + <param index="0" name="rid" type="RID" /> <description> Returns [code]true[/code] if [code]rid[/code] is valid resource owned by this text server. </description> </method> <method name="has_feature" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="feature" type="int" enum="TextServer.Feature" /> + <param index="0" name="feature" type="int" enum="TextServer.Feature" /> <description> Returns [code]true[/code] if the server supports a feature. </description> </method> <method name="is_confusable" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="dict" type="PackedStringArray" /> + <param index="0" name="string" type="String" /> + <param index="1" name="dict" type="PackedStringArray" /> <description> Returns index of the first string in [code]dict[/dict] which is visually confusable with the [code]string[/string], or [code]-1[/code] if none is found. </description> </method> <method name="is_locale_right_to_left" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="locale" type="String" /> + <param index="0" name="locale" type="String" /> <description> Returns [code]true[/code] if locale is right-to-left. </description> </method> <method name="is_valid_identifier" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Returns [code]true[/code] is [code]string[/code] is a valid identifier. </description> </method> <method name="load_support_data" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="filename" type="String" /> + <param index="0" name="filename" type="String" /> <description> Loads optional TextServer database (e.g. ICU break iterators and dictionaries). </description> </method> <method name="name_to_tag" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Converts readable feature, variation, script or language name to OpenType tag. </description> </method> <method name="parse_number" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="string" type="String" /> + <param index="1" name="language" type="String" /> <description> Converts a number from the numeral systems used in [code]language[/code] to Western Arabic (0..9). </description> </method> <method name="parse_structured_text" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="parser_type" type="int" enum="TextServer.StructuredTextParser" /> - <argument index="1" name="args" type="Array" /> - <argument index="2" name="text" type="String" /> + <param index="0" name="parser_type" type="int" enum="TextServer.StructuredTextParser" /> + <param index="1" name="args" type="Array" /> + <param index="2" name="text" type="String" /> <description> </description> </method> <method name="percent_sign" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="language" type="String" /> + <param index="0" name="language" type="String" /> <description> Returns percent sign used in the [code]language[/code]. </description> </method> <method name="save_support_data" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="filename" type="String" /> + <param index="0" name="filename" type="String" /> <description> Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. [b]Note:[/b] This function is used by during project export, to include TextServer database. @@ -1003,69 +1003,69 @@ </method> <method name="shaped_get_span_count" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns number of text spans added using [method shaped_text_add_string] or [method shaped_text_add_object]. </description> </method> <method name="shaped_get_span_meta" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="index" type="int" /> <description> Returns text span metadata. </description> </method> <method name="shaped_set_span_update_font" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="index" type="int" /> - <argument index="2" name="fonts" type="Array" /> - <argument index="3" name="size" type="int" /> - <argument index="4" name="opentype_features" type="Dictionary" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="index" type="int" /> + <param index="2" name="fonts" type="Array" /> + <param index="3" name="size" type="int" /> + <param index="4" name="opentype_features" type="Dictionary" /> <description> Changes text span font, font size and OpenType features, without changing the text. </description> </method> <method name="shaped_text_add_object" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="key" type="Variant" /> - <argument index="2" name="size" type="Vector2" /> - <argument index="3" name="inline_align" type="int" enum="InlineAlignment" /> - <argument index="4" name="length" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="key" type="Variant" /> + <param index="2" name="size" type="Vector2" /> + <param index="3" name="inline_align" type="int" enum="InlineAlignment" /> + <param index="4" name="length" type="int" /> <description> Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. </description> </method> <method name="shaped_text_add_string" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="text" type="String" /> - <argument index="2" name="fonts" type="Array" /> - <argument index="3" name="size" type="int" /> - <argument index="4" name="opentype_features" type="Dictionary" /> - <argument index="5" name="language" type="String" /> - <argument index="6" name="meta" type="Variant" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="text" type="String" /> + <param index="2" name="fonts" type="Array" /> + <param index="3" name="size" type="int" /> + <param index="4" name="opentype_features" type="Dictionary" /> + <param index="5" name="language" type="String" /> + <param index="6" name="meta" type="Variant" /> <description> Adds text span and font to draw it to the text buffer. </description> </method> <method name="shaped_text_clear" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Clears text buffer (removes text and inline objects). </description> </method> <method name="shaped_text_draw" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="pos" type="Vector2" /> - <argument index="3" name="clip_l" type="float" /> - <argument index="4" name="clip_r" type="float" /> - <argument index="5" name="color" type="Color" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="pos" type="Vector2" /> + <param index="3" name="clip_l" type="float" /> + <param index="4" name="clip_r" type="float" /> + <param index="5" name="color" type="Color" /> <description> Draw shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1073,13 +1073,13 @@ </method> <method name="shaped_text_draw_outline" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="canvas" type="RID" /> - <argument index="2" name="pos" type="Vector2" /> - <argument index="3" name="clip_l" type="float" /> - <argument index="4" name="clip_r" type="float" /> - <argument index="5" name="outline_size" type="int" /> - <argument index="6" name="color" type="Color" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="canvas" type="RID" /> + <param index="2" name="pos" type="Vector2" /> + <param index="3" name="clip_l" type="float" /> + <param index="4" name="clip_r" type="float" /> + <param index="5" name="outline_size" type="int" /> + <param index="6" name="color" type="Color" /> <description> Draw the outline of the shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1087,25 +1087,25 @@ </method> <method name="shaped_text_fit_to_width" qualifiers="virtual"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="width" type="float" /> - <argument index="2" name="jst_flags" type="int" enum="TextServer.JustificationFlag" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="width" type="float" /> + <param index="2" name="jst_flags" type="int" enum="TextServer.JustificationFlag" /> <description> Adjusts text with to fit to specified width, returns new text width. </description> </method> <method name="shaped_text_get_ascent" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). </description> </method> <method name="shaped_text_get_carets" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="position" type="int" /> - <argument index="2" name="caret" type="CaretInfo*" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="position" type="int" /> + <param index="2" name="caret" type="CaretInfo*" /> <description> Returns shapes of the carets corresponding to the character offset [code]position[/code] in the text. Returned caret shape is 1 pixel wide rectangle. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1113,30 +1113,30 @@ </method> <method name="shaped_text_get_custom_punctuation" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. </description> </method> <method name="shaped_text_get_descent" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). </description> </method> <method name="shaped_text_get_direction" qualifiers="virtual const"> <return type="int" enum="TextServer.Direction" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns direction of the text. </description> </method> <method name="shaped_text_get_dominant_direction_in_range" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="start" type="int" /> - <argument index="2" name="end" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="start" type="int" /> + <param index="2" name="end" type="int" /> <description> Returns dominant direction of in the range of text. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1144,43 +1144,43 @@ </method> <method name="shaped_text_get_ellipsis_glyph_count" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns number of glyphs in the ellipsis. </description> </method> <method name="shaped_text_get_ellipsis_glyphs" qualifiers="virtual const"> <return type="const Glyph*" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns array of the glyphs in the ellipsis. </description> </method> <method name="shaped_text_get_ellipsis_pos" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns position of the ellipsis. </description> </method> <method name="shaped_text_get_glyph_count" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns number of glyphs in the buffer. </description> </method> <method name="shaped_text_get_glyphs" qualifiers="virtual const"> <return type="const Glyph*" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns an array of glyphs in the visual order. </description> </method> <method name="shaped_text_get_grapheme_bounds" qualifiers="virtual const"> <return type="Vector2" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="pos" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="pos" type="int" /> <description> Returns composite character's bounds as offsets from the start of the line. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1188,17 +1188,17 @@ </method> <method name="shaped_text_get_inferred_direction" qualifiers="virtual const"> <return type="int" enum="TextServer.Direction" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns direction of the text, inferred by the BiDi algorithm. </description> </method> <method name="shaped_text_get_line_breaks" qualifiers="virtual const"> <return type="PackedInt32Array" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="width" type="float" /> - <argument index="2" name="start" type="int" /> - <argument index="3" name="break_flags" type="int" enum="TextServer.LineBreakFlag" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="width" type="float" /> + <param index="2" name="start" type="int" /> + <param index="3" name="break_flags" type="int" enum="TextServer.LineBreakFlag" /> <description> Breaks text to the lines and returns character ranges for each line. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1206,11 +1206,11 @@ </method> <method name="shaped_text_get_line_breaks_adv" qualifiers="virtual const"> <return type="PackedInt32Array" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="width" type="PackedFloat32Array" /> - <argument index="2" name="start" type="int" /> - <argument index="3" name="once" type="bool" /> - <argument index="4" name="break_flags" type="int" enum="TextServer.LineBreakFlag" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="width" type="PackedFloat32Array" /> + <param index="2" name="start" type="int" /> + <param index="3" name="once" type="bool" /> + <param index="4" name="break_flags" type="int" enum="TextServer.LineBreakFlag" /> <description> Breaks text to the lines and columns. Returns character ranges for each segment. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1218,43 +1218,43 @@ </method> <method name="shaped_text_get_object_rect" qualifiers="virtual const"> <return type="Rect2" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="key" type="Variant" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="key" type="Variant" /> <description> Returns bounding rectangle of the inline object. </description> </method> <method name="shaped_text_get_objects" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns array of inline objects. </description> </method> <method name="shaped_text_get_orientation" qualifiers="virtual const"> <return type="int" enum="TextServer.Orientation" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> eturns text orientation. </description> </method> <method name="shaped_text_get_parent" qualifiers="virtual const"> <return type="RID" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns the parent buffer from which the substring originates. </description> </method> <method name="shaped_text_get_preserve_control" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns [code]true[/code] if text buffer is configured to display control characters. </description> </method> <method name="shaped_text_get_preserve_invalid" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters. [b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters. @@ -1262,16 +1262,16 @@ </method> <method name="shaped_text_get_range" qualifiers="virtual const"> <return type="Vector2i" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns substring buffer character range in the parent buffer. </description> </method> <method name="shaped_text_get_selection" qualifiers="virtual const"> <return type="PackedVector2Array" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="start" type="int" /> - <argument index="2" name="end" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="start" type="int" /> + <param index="2" name="end" type="int" /> <description> Returns selection rectangles for the specified character range. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1279,51 +1279,51 @@ </method> <method name="shaped_text_get_size" qualifiers="virtual const"> <return type="Vector2" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns size of the text. </description> </method> <method name="shaped_text_get_spacing" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="spacing" type="int" enum="TextServer.SpacingType" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="spacing" type="int" enum="TextServer.SpacingType" /> <description> Returns extra spacing added between glyphs or lines in pixels. </description> </method> <method name="shaped_text_get_trim_pos" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns the position of the overrun trim. </description> </method> <method name="shaped_text_get_underline_position" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns pixel offset of the underline below the baseline. </description> </method> <method name="shaped_text_get_underline_thickness" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns thickness of the underline. </description> </method> <method name="shaped_text_get_width" qualifiers="virtual const"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns width (for horizontal layout) or height (for vertical) of the text. </description> </method> <method name="shaped_text_get_word_breaks" qualifiers="virtual const"> <return type="PackedInt32Array" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="grapheme_flags" type="int" enum="TextServer.GraphemeFlag" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="grapheme_flags" type="int" enum="TextServer.GraphemeFlag" /> <description> Breaks text into words and returns array of character ranges. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1331,8 +1331,8 @@ </method> <method name="shaped_text_hit_test_grapheme" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="coord" type="float" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="coord" type="float" /> <description> Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1340,8 +1340,8 @@ </method> <method name="shaped_text_hit_test_position" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="coord" type="float" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="coord" type="float" /> <description> Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1349,15 +1349,15 @@ </method> <method name="shaped_text_is_ready" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns [code]true[/code] if buffer is successfully shaped. </description> </method> <method name="shaped_text_next_grapheme_pos" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="pos" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="pos" type="int" /> <description> Returns composite character end position closest to the [code]pos[/code]. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1365,17 +1365,17 @@ </method> <method name="shaped_text_overrun_trim_to_width" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="width" type="float" /> - <argument index="2" name="trim_flags" type="int" enum="TextServer.TextOverrunFlag" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="width" type="float" /> + <param index="2" name="trim_flags" type="int" enum="TextServer.TextOverrunFlag" /> <description> Trims text if it exceeds the given width. </description> </method> <method name="shaped_text_prev_grapheme_pos" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="pos" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="pos" type="int" /> <description> Returns composite character start position closest to the [code]pos[/code]. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1383,18 +1383,18 @@ </method> <method name="shaped_text_resize_object" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="key" type="Variant" /> - <argument index="2" name="size" type="Vector2" /> - <argument index="3" name="inline_align" type="int" enum="InlineAlignment" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="key" type="Variant" /> + <param index="2" name="size" type="Vector2" /> + <param index="3" name="inline_align" type="int" enum="InlineAlignment" /> <description> Sets new size and alignment of embedded object. </description> </method> <method name="shaped_text_set_bidi_override" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="override" type="Array" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="override" type="Array" /> <description> Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -1402,87 +1402,87 @@ </method> <method name="shaped_text_set_custom_punctuation" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="punct" type="String" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="punct" type="String" /> <description> Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. </description> </method> <method name="shaped_text_set_direction" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="direction" type="int" enum="TextServer.Direction" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="direction" type="int" enum="TextServer.Direction" /> <description> Sets desired text direction. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale. </description> </method> <method name="shaped_text_set_orientation" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="orientation" type="int" enum="TextServer.Orientation" /> <description> Sets desired text orientation. </description> </method> <method name="shaped_text_set_preserve_control" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If set to [code]true[/code] text buffer will display control characters. </description> </method> <method name="shaped_text_set_preserve_invalid" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="enabled" type="bool" /> <description> If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. </description> </method> <method name="shaped_text_set_spacing" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="spacing" type="int" enum="TextServer.SpacingType" /> - <argument index="2" name="value" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="spacing" type="int" enum="TextServer.SpacingType" /> + <param index="2" name="value" type="int" /> <description> Sets extra spacing added between glyphs or lines in pixels. </description> </method> <method name="shaped_text_shape" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. </description> </method> <method name="shaped_text_sort_logical" qualifiers="virtual"> <return type="const Glyph*" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Returns text glyphs in the logical order. </description> </method> <method name="shaped_text_substr" qualifiers="virtual const"> <return type="RID" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="start" type="int" /> - <argument index="2" name="length" type="int" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="start" type="int" /> + <param index="2" name="length" type="int" /> <description> Returns text buffer for the substring of the text in the [code]shaped[/code] text buffer (including inline objects). </description> </method> <method name="shaped_text_tab_align" qualifiers="virtual"> <return type="float" /> - <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="tab_stops" type="PackedFloat32Array" /> + <param index="0" name="shaped" type="RID" /> + <param index="1" name="tab_stops" type="PackedFloat32Array" /> <description> Aligns shaped text to the given tab-stops. </description> </method> <method name="shaped_text_update_breaks" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Updates line breaking positions in the text buffer. [b]Note:[/b] This method is used by default line/word breaking methods, and its implementation might be omitted if custom line breaking in implemented. @@ -1490,7 +1490,7 @@ </method> <method name="shaped_text_update_justification_ops" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="shaped" type="RID" /> + <param index="0" name="shaped" type="RID" /> <description> Updates line justification positions (word breaks and elongations) in the text buffer. [b]Note:[/b] This method is used by default line/word breaking methods, and its implementation might be omitted if custom line breaking in implemented. @@ -1498,38 +1498,38 @@ </method> <method name="spoof_check" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Returns [code]true[/code] if [code]string[/code] is likely to be an attempt at confusing the reader. </description> </method> <method name="string_get_word_breaks" qualifiers="virtual const"> <return type="PackedInt32Array" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="string" type="String" /> + <param index="1" name="language" type="String" /> <description> Returns array of the word break character offsets. </description> </method> <method name="string_to_lower" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="string" type="String" /> + <param index="1" name="language" type="String" /> <description> Returns the string converted to lowercase. </description> </method> <method name="string_to_upper" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="string" type="String" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="string" type="String" /> + <param index="1" name="language" type="String" /> <description> Returns the string converted to uppercase. </description> </method> <method name="strip_diacritics" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="string" type="String" /> + <param index="0" name="string" type="String" /> <description> Strips diacritics from the string. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1537,7 +1537,7 @@ </method> <method name="tag_to_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="tag" type="int" /> + <param index="0" name="tag" type="int" /> <description> Converts OpenType tag to readable feature, variation, script or language name. </description> diff --git a/doc/classes/TextServerManager.xml b/doc/classes/TextServerManager.xml index 7eff19038c..19b0e9e6f2 100644 --- a/doc/classes/TextServerManager.xml +++ b/doc/classes/TextServerManager.xml @@ -12,21 +12,21 @@ <methods> <method name="add_interface"> <return type="void" /> - <argument index="0" name="interface" type="TextServer" /> + <param index="0" name="interface" type="TextServer" /> <description> Registers an [TextServer] interface. </description> </method> <method name="find_interface" qualifiers="const"> <return type="TextServer" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Finds an interface by its name. </description> </method> <method name="get_interface" qualifiers="const"> <return type="TextServer" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the interface registered at a given index. </description> @@ -51,14 +51,14 @@ </method> <method name="remove_interface"> <return type="void" /> - <argument index="0" name="interface" type="TextServer" /> + <param index="0" name="interface" type="TextServer" /> <description> Removes interface. All fonts and shaped text caches should be freed before removing interface. </description> </method> <method name="set_primary_interface"> <return type="void" /> - <argument index="0" name="index" type="TextServer" /> + <param index="0" name="index" type="TextServer" /> <description> Sets the primary [TextServer] interface. </description> @@ -66,13 +66,13 @@ </methods> <signals> <signal name="interface_added"> - <argument index="0" name="interface_name" type="StringName" /> + <param index="0" name="interface_name" type="StringName" /> <description> Emitted when a new interface has been added. </description> </signal> <signal name="interface_removed"> - <argument index="0" name="interface_name" type="StringName" /> + <param index="0" name="interface_name" type="StringName" /> <description> Emitted when an interface is removed. </description> diff --git a/doc/classes/Texture2D.xml b/doc/classes/Texture2D.xml index 3721058d25..a8ec2a7f06 100644 --- a/doc/classes/Texture2D.xml +++ b/doc/classes/Texture2D.xml @@ -14,31 +14,31 @@ <methods> <method name="_draw" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="to_canvas_item" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="modulate" type="Color" /> - <argument index="3" name="transpose" type="bool" /> + <param index="0" name="to_canvas_item" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="modulate" type="Color" /> + <param index="3" name="transpose" type="bool" /> <description> </description> </method> <method name="_draw_rect" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="to_canvas_item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="tile" type="bool" /> - <argument index="3" name="modulate" type="Color" /> - <argument index="4" name="transpose" type="bool" /> + <param index="0" name="to_canvas_item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="tile" type="bool" /> + <param index="3" name="modulate" type="Color" /> + <param index="4" name="transpose" type="bool" /> <description> </description> </method> <method name="_draw_rect_region" qualifiers="virtual const"> <return type="void" /> - <argument index="0" name="tp_canvas_item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="src_rect" type="Rect2" /> - <argument index="3" name="modulate" type="Color" /> - <argument index="4" name="transpose" type="bool" /> - <argument index="5" name="clip_uv" type="bool" /> + <param index="0" name="tp_canvas_item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="src_rect" type="Rect2" /> + <param index="3" name="modulate" type="Color" /> + <param index="4" name="transpose" type="bool" /> + <param index="5" name="clip_uv" type="bool" /> <description> </description> </method> @@ -59,40 +59,40 @@ </method> <method name="_is_pixel_opaque" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> <description> </description> </method> <method name="draw" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="position" type="Vector2" /> - <argument index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="3" name="transpose" type="bool" default="false" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="position" type="Vector2" /> + <param index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="3" name="transpose" type="bool" default="false" /> <description> Draws the texture using a [CanvasItem] with the [RenderingServer] API at the specified [code]position[/code]. </description> </method> <method name="draw_rect" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="tile" type="bool" /> - <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="transpose" type="bool" default="false" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="tile" type="bool" /> + <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="transpose" type="bool" default="false" /> <description> Draws the texture using a [CanvasItem] with the [RenderingServer] API. </description> </method> <method name="draw_rect_region" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="rect" type="Rect2" /> - <argument index="2" name="src_rect" type="Rect2" /> - <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="transpose" type="bool" default="false" /> - <argument index="5" name="clip_uv" type="bool" default="true" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="rect" type="Rect2" /> + <param index="2" name="src_rect" type="Rect2" /> + <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="transpose" type="bool" default="false" /> + <param index="5" name="clip_uv" type="bool" default="true" /> <description> Draws a part of the texture using a [CanvasItem] with the [RenderingServer] API. </description> diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index 3445329f32..8d54521095 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -21,7 +21,7 @@ </method> <method name="_get_layer_data" qualifiers="virtual const"> <return type="Image" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> </description> </method> @@ -59,7 +59,7 @@ </method> <method name="get_layer_data" qualifiers="const"> <return type="Image" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Returns an [Image] resource with the data from specified [code]layer[/code]. </description> diff --git a/doc/classes/TextureProgressBar.xml b/doc/classes/TextureProgressBar.xml index 4ea072a25f..fcdb18e10d 100644 --- a/doc/classes/TextureProgressBar.xml +++ b/doc/classes/TextureProgressBar.xml @@ -11,14 +11,14 @@ <methods> <method name="get_stretch_margin" qualifiers="const"> <return type="int" /> - <argument index="0" name="margin" type="int" enum="Side" /> + <param index="0" name="margin" type="int" enum="Side" /> <description> </description> </method> <method name="set_stretch_margin"> <return type="void" /> - <argument index="0" name="margin" type="int" enum="Side" /> - <argument index="1" name="value" type="int" /> + <param index="0" name="margin" type="int" enum="Side" /> + <param index="1" name="value" type="int" /> <description> </description> </method> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index 7f4e0645c8..b310233780 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -15,7 +15,7 @@ <methods> <method name="add_type"> <return type="void" /> - <argument index="0" name="theme_type" type="StringName" /> + <param index="0" name="theme_type" type="StringName" /> <description> Adds an empty theme type for every valid data type. [b]Note:[/b] Empty types are not saved with the theme. This method only exists to perform in-memory changes to the resource. Use available [code]set_*[/code] methods to add theme items. @@ -29,8 +29,8 @@ </method> <method name="clear_color"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Removes the [Color] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_color] to check for existence. @@ -38,8 +38,8 @@ </method> <method name="clear_constant"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Removes the constant property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_constant] to check for existence. @@ -47,8 +47,8 @@ </method> <method name="clear_font"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Removes the [Font] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_font] to check for existence. @@ -56,8 +56,8 @@ </method> <method name="clear_font_size"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Removes the font size property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_font_size] to check for existence. @@ -65,8 +65,8 @@ </method> <method name="clear_icon"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Removes the icon property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_icon] to check for existence. @@ -74,8 +74,8 @@ </method> <method name="clear_stylebox"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Removes the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_stylebox] to check for existence. @@ -83,9 +83,9 @@ </method> <method name="clear_theme_item"> <return type="void" /> - <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="data_type" type="int" enum="Theme.DataType" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Removes the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_theme_item] to check for existence. @@ -94,15 +94,15 @@ </method> <method name="clear_type_variation"> <return type="void" /> - <argument index="0" name="theme_type" type="StringName" /> + <param index="0" name="theme_type" type="StringName" /> <description> Unmarks [code]theme_type[/code] as being a variation of another theme type. See [method set_type_variation]. </description> </method> <method name="get_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns the [Color] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the default color value if the property doesn't exist. Use [method has_color] to check for existence. @@ -110,7 +110,7 @@ </method> <method name="get_color_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="theme_type" type="String" /> + <param index="0" name="theme_type" type="String" /> <description> Returns a list of names for [Color] properties defined with [code]theme_type[/code]. Use [method get_color_type_list] to get a list of possible theme type names. </description> @@ -123,8 +123,8 @@ </method> <method name="get_constant" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns the constant property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns [code]0[/code] if the property doesn't exist. Use [method has_constant] to check for existence. @@ -132,7 +132,7 @@ </method> <method name="get_constant_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="theme_type" type="String" /> + <param index="0" name="theme_type" type="String" /> <description> Returns a list of names for constant properties defined with [code]theme_type[/code]. Use [method get_constant_type_list] to get a list of possible theme type names. </description> @@ -145,8 +145,8 @@ </method> <method name="get_font" qualifiers="const"> <return type="Font" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns the [Font] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the default theme font if the property doesn't exist and the default theme font is set up (see [member default_font]). Use [method has_font] to check for existence of the property and [method has_default_font] to check for existence of the default theme font. @@ -155,15 +155,15 @@ </method> <method name="get_font_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="theme_type" type="String" /> + <param index="0" name="theme_type" type="String" /> <description> Returns a list of names for [Font] properties defined with [code]theme_type[/code]. Use [method get_font_type_list] to get a list of possible theme type names. </description> </method> <method name="get_font_size" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns the font size property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the default theme font size if the property doesn't exist and the default theme font size is set up (see [member default_font_size]). Use [method has_font_size] to check for existence of the property and [method has_default_font_size] to check for existence of the default theme font. @@ -172,7 +172,7 @@ </method> <method name="get_font_size_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="theme_type" type="String" /> + <param index="0" name="theme_type" type="String" /> <description> Returns a list of names for font size properties defined with [code]theme_type[/code]. Use [method get_font_size_type_list] to get a list of possible theme type names. </description> @@ -191,8 +191,8 @@ </method> <method name="get_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns the icon property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the engine fallback icon value if the property doesn't exist. Use [method has_icon] to check for existence. @@ -200,7 +200,7 @@ </method> <method name="get_icon_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="theme_type" type="String" /> + <param index="0" name="theme_type" type="String" /> <description> Returns a list of names for icon properties defined with [code]theme_type[/code]. Use [method get_icon_type_list] to get a list of possible theme type names. </description> @@ -213,8 +213,8 @@ </method> <method name="get_stylebox" qualifiers="const"> <return type="StyleBox" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the engine fallback stylebox value if the property doesn't exist. Use [method has_stylebox] to check for existence. @@ -222,7 +222,7 @@ </method> <method name="get_stylebox_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="theme_type" type="String" /> + <param index="0" name="theme_type" type="String" /> <description> Returns a list of names for [StyleBox] properties defined with [code]theme_type[/code]. Use [method get_stylebox_type_list] to get a list of possible theme type names. </description> @@ -235,9 +235,9 @@ </method> <method name="get_theme_item" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="data_type" type="int" enum="Theme.DataType" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Returns the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the engine fallback icon value if the property doesn't exist. Use [method has_theme_item] to check for existence. @@ -246,8 +246,8 @@ </method> <method name="get_theme_item_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> - <argument index="1" name="theme_type" type="String" /> + <param index="0" name="data_type" type="int" enum="Theme.DataType" /> + <param index="1" name="theme_type" type="String" /> <description> Returns a list of names for properties of [code]data_type[/code] defined with [code]theme_type[/code]. Use [method get_theme_item_type_list] to get a list of possible theme type names. [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. @@ -255,7 +255,7 @@ </method> <method name="get_theme_item_type_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> + <param index="0" name="data_type" type="int" enum="Theme.DataType" /> <description> Returns a list of all unique theme type names for [code]data_type[/code] properties. Use [method get_type_list] to get a list of all unique theme types. [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. @@ -269,22 +269,22 @@ </method> <method name="get_type_variation_base" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="theme_type" type="StringName" /> + <param index="0" name="theme_type" type="StringName" /> <description> Returns the name of the base theme type if [code]theme_type[/code] is a valid variation type. Returns an empty string otherwise. </description> </method> <method name="get_type_variation_list" qualifiers="const"> <return type="PackedStringArray" /> - <argument index="0" name="base_type" type="StringName" /> + <param index="0" name="base_type" type="StringName" /> <description> Returns a list of all type variations for the given [code]base_type[/code]. </description> </method> <method name="has_color" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns [code]true[/code] if the [Color] property defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_color] to define it. @@ -292,8 +292,8 @@ </method> <method name="has_constant" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns [code]true[/code] if the constant property defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_constant] to define it. @@ -322,8 +322,8 @@ </method> <method name="has_font" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns [code]true[/code] if the [Font] property defined by [code]name[/code] and [code]theme_type[/code] exists, or if the default theme font is set up (see [method has_default_font]). Returns [code]false[/code] if neither exist. Use [method set_font] to define the property. @@ -331,8 +331,8 @@ </method> <method name="has_font_size" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns [code]true[/code] if [member default_font_size] has a valid value. Returns [code]false[/code] if it doesn't. The value must be greater than [code]0[/code] to be considered valid. @@ -340,8 +340,8 @@ </method> <method name="has_icon" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns [code]true[/code] if the icon property defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_icon] to define it. @@ -349,8 +349,8 @@ </method> <method name="has_stylebox" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> <description> Returns [code]true[/code] if the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_stylebox] to define it. @@ -358,9 +358,9 @@ </method> <method name="has_theme_item" qualifiers="const"> <return type="bool" /> - <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="data_type" type="int" enum="Theme.DataType" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Returns [code]true[/code] if the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_theme_item] to define it. @@ -369,15 +369,15 @@ </method> <method name="is_type_variation" qualifiers="const"> <return type="bool" /> - <argument index="0" name="theme_type" type="StringName" /> - <argument index="1" name="base_type" type="StringName" /> + <param index="0" name="theme_type" type="StringName" /> + <param index="1" name="base_type" type="StringName" /> <description> Returns [code]true[/code] if [code]theme_type[/code] is marked as a variation of [code]base_type[/code]. </description> </method> <method name="merge_with"> <return type="void" /> - <argument index="0" name="other" type="Theme" /> + <param index="0" name="other" type="Theme" /> <description> Adds missing and overrides existing definitions with values from the [code]other[/code] theme resource. [b]Note:[/b] This modifies the current theme. If you want to merge two themes together without modifying either one, create a new empty theme and merge the other two into it one after another. @@ -385,16 +385,16 @@ </method> <method name="remove_type"> <return type="void" /> - <argument index="0" name="theme_type" type="StringName" /> + <param index="0" name="theme_type" type="StringName" /> <description> Removes the theme type, gracefully discarding defined theme items. If the type is a variation, this information is also erased. If the type is a base for type variations, those variations lose their base. </description> </method> <method name="rename_color"> <return type="void" /> - <argument index="0" name="old_name" type="StringName" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="old_name" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Renames the [Color] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_color] to check for existence, and [method clear_color] to remove the existing property. @@ -402,9 +402,9 @@ </method> <method name="rename_constant"> <return type="void" /> - <argument index="0" name="old_name" type="StringName" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="old_name" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Renames the constant property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_constant] to check for existence, and [method clear_constant] to remove the existing property. @@ -412,9 +412,9 @@ </method> <method name="rename_font"> <return type="void" /> - <argument index="0" name="old_name" type="StringName" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="old_name" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Renames the [Font] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_font] to check for existence, and [method clear_font] to remove the existing property. @@ -422,9 +422,9 @@ </method> <method name="rename_font_size"> <return type="void" /> - <argument index="0" name="old_name" type="StringName" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="old_name" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Returns [code]true[/code] if the font size property defined by [code]name[/code] and [code]theme_type[/code] exists, or if the default theme font size is set up (see [method has_default_font_size]). Returns [code]false[/code] if neither exist. Use [method set_font_size] to define the property. @@ -432,9 +432,9 @@ </method> <method name="rename_icon"> <return type="void" /> - <argument index="0" name="old_name" type="StringName" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="old_name" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Renames the icon property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_icon] to check for existence, and [method clear_icon] to remove the existing property. @@ -442,9 +442,9 @@ </method> <method name="rename_stylebox"> <return type="void" /> - <argument index="0" name="old_name" type="StringName" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> + <param index="0" name="old_name" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> <description> Renames the [StyleBox] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_stylebox] to check for existence, and [method clear_stylebox] to remove the existing property. @@ -452,10 +452,10 @@ </method> <method name="rename_theme_item"> <return type="void" /> - <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> - <argument index="1" name="old_name" type="StringName" /> - <argument index="2" name="name" type="StringName" /> - <argument index="3" name="theme_type" type="StringName" /> + <param index="0" name="data_type" type="int" enum="Theme.DataType" /> + <param index="1" name="old_name" type="StringName" /> + <param index="2" name="name" type="StringName" /> + <param index="3" name="theme_type" type="StringName" /> <description> Renames the theme property of [code]data_type[/code] defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_theme_item] to check for existence, and [method clear_theme_item] to remove the existing property. @@ -464,36 +464,36 @@ </method> <method name="set_color"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> - <argument index="2" name="color" type="Color" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> + <param index="2" name="color" type="Color" /> <description> Creates or changes the value of the [Color] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_color] to remove the property. </description> </method> <method name="set_constant"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> - <argument index="2" name="constant" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> + <param index="2" name="constant" type="int" /> <description> Creates or changes the value of the constant property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_constant] to remove the property. </description> </method> <method name="set_font"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> - <argument index="2" name="font" type="Font" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> + <param index="2" name="font" type="Font" /> <description> Creates or changes the value of the [Font] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_font] to remove the property. </description> </method> <method name="set_font_size"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> - <argument index="2" name="font_size" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> + <param index="2" name="font_size" type="int" /> <description> Renames the font size property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_font_size] to check for existence, and [method clear_font_size] to remove the existing property. @@ -501,28 +501,28 @@ </method> <method name="set_icon"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> - <argument index="2" name="texture" type="Texture2D" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> + <param index="2" name="texture" type="Texture2D" /> <description> Creates or changes the value of the icon property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_icon] to remove the property. </description> </method> <method name="set_stylebox"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" /> - <argument index="2" name="texture" type="StyleBox" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" /> + <param index="2" name="texture" type="StyleBox" /> <description> Creates or changes the value of the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_stylebox] to remove the property. </description> </method> <method name="set_theme_item"> <return type="void" /> - <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> - <argument index="1" name="name" type="StringName" /> - <argument index="2" name="theme_type" type="StringName" /> - <argument index="3" name="value" type="Variant" /> + <param index="0" name="data_type" type="int" enum="Theme.DataType" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="theme_type" type="StringName" /> + <param index="3" name="value" type="Variant" /> <description> Creates or changes the value of the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_theme_item] to remove the property. Fails if the [code]value[/code] type is not accepted by [code]data_type[/code]. @@ -531,8 +531,8 @@ </method> <method name="set_type_variation"> <return type="void" /> - <argument index="0" name="theme_type" type="StringName" /> - <argument index="1" name="base_type" type="StringName" /> + <param index="0" name="theme_type" type="StringName" /> + <param index="1" name="base_type" type="StringName" /> <description> Marks [code]theme_type[/code] as a variation of [code]base_type[/code]. This adds [code]theme_type[/code] as a suggested option for [member Control.theme_type_variation] on a [Control] that is of the [code]base_type[/code] class. diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 513daff37c..6bc34ed8dd 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -34,8 +34,8 @@ </method> <method name="start"> <return type="int" enum="Error" /> - <argument index="0" name="callable" type="Callable" /> - <argument index="1" name="priority" type="int" enum="Thread.Priority" default="1" /> + <param index="0" name="callable" type="Callable" /> + <param index="1" name="priority" type="int" enum="Thread.Priority" default="1" /> <description> Starts a new [Thread] that calls [code]callable[/code]. If the method takes some arguments, you can pass them using [method Callable.bind]. diff --git a/doc/classes/TileData.xml b/doc/classes/TileData.xml index 66cf602e5d..b61ed1ea28 100644 --- a/doc/classes/TileData.xml +++ b/doc/classes/TileData.xml @@ -9,186 +9,186 @@ <methods> <method name="add_collision_polygon"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> + <param index="0" name="layer_id" type="int" /> <description> Adds a collision polygon to the tile on the given TileSet physics layer. </description> </method> <method name="get_collision_polygon_one_way_margin" qualifiers="const"> <return type="float" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="polygon_index" type="int" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="polygon_index" type="int" /> <description> Returns the one-way margin (for one-way platforms) of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="get_collision_polygon_points" qualifiers="const"> <return type="PackedVector2Array" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="polygon_index" type="int" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="polygon_index" type="int" /> <description> Returns the points of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="get_collision_polygons_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer_id" type="int" /> + <param index="0" name="layer_id" type="int" /> <description> Returns how many polygons the tile has for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="get_constant_angular_velocity" qualifiers="const"> <return type="float" /> - <argument index="0" name="layer_id" type="int" /> + <param index="0" name="layer_id" type="int" /> <description> Returns the constant angular velocity applied to objects colliding with this tile. </description> </method> <method name="get_constant_linear_velocity" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="layer_id" type="int" /> + <param index="0" name="layer_id" type="int" /> <description> Returns the constant linear velocity applied to objects colliding with this tile. </description> </method> <method name="get_custom_data" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="layer_name" type="String" /> + <param index="0" name="layer_name" type="String" /> <description> Returns the custom data value for custom data layer named [code]layer_name[/code]. </description> </method> <method name="get_custom_data_by_layer_id" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="layer_id" type="int" /> + <param index="0" name="layer_id" type="int" /> <description> Returns the custom data value for custom data layer with index [code]layer_id[/code]. </description> </method> <method name="get_navigation_polygon" qualifiers="const"> <return type="NavigationPolygon" /> - <argument index="0" name="layer_id" type="int" /> + <param index="0" name="layer_id" type="int" /> <description> Returns the navigation polygon of the tile for the TileSet navigation layer with index [code]layer_id[/code]. </description> </method> <method name="get_occluder" qualifiers="const"> <return type="OccluderPolygon2D" /> - <argument index="0" name="layer_id" type="int" /> + <param index="0" name="layer_id" type="int" /> <description> Returns the occluder polygon of the tile for the TileSet occlusion layer with index [code]layer_id[/code]. </description> </method> <method name="get_terrain_peering_bit" qualifiers="const"> <return type="int" /> - <argument index="0" name="peering_bit" type="int" enum="TileSet.CellNeighbor" /> + <param index="0" name="peering_bit" type="int" enum="TileSet.CellNeighbor" /> <description> Returns the tile's terrain bit for the given [code]peering_bit[/code] direction. </description> </method> <method name="is_collision_polygon_one_way" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="polygon_index" type="int" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="polygon_index" type="int" /> <description> Returns whether one-way collisions are enabled for the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="remove_collision_polygon"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="polygon_index" type="int" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="polygon_index" type="int" /> <description> Removes the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="set_collision_polygon_one_way"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="polygon_index" type="int" /> - <argument index="2" name="one_way" type="bool" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="polygon_index" type="int" /> + <param index="2" name="one_way" type="bool" /> <description> Enables/disables one-way collisions on the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="set_collision_polygon_one_way_margin"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="polygon_index" type="int" /> - <argument index="2" name="one_way_margin" type="float" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="polygon_index" type="int" /> + <param index="2" name="one_way_margin" type="float" /> <description> Enables/disables one-way collisions on the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="set_collision_polygon_points"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="polygon_index" type="int" /> - <argument index="2" name="polygon" type="PackedVector2Array" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="polygon_index" type="int" /> + <param index="2" name="polygon" type="PackedVector2Array" /> <description> Sets the points of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="set_collision_polygons_count"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="polygons_count" type="int" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="polygons_count" type="int" /> <description> Sets the polygons count for TileSet physics layer with index [code]layer_id[/code]. </description> </method> <method name="set_constant_angular_velocity"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="velocity" type="float" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="velocity" type="float" /> <description> Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile. </description> </method> <method name="set_constant_linear_velocity"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="velocity" type="Vector2" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="velocity" type="Vector2" /> <description> Sets the constant linear velocity. This does not move the tile. This linear velocity is applied to objects colliding with this tile. This is useful to create conveyor belts. </description> </method> <method name="set_custom_data"> <return type="void" /> - <argument index="0" name="layer_name" type="String" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="layer_name" type="String" /> + <param index="1" name="value" type="Variant" /> <description> Sets the tile's custom data value for the TileSet custom data layer with name [code]layer_name[/code]. </description> </method> <method name="set_custom_data_by_layer_id"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="value" type="Variant" /> <description> Sets the tile's custom data value for the TileSet custom data layer with index [code]layer_id[/code]. </description> </method> <method name="set_navigation_polygon"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="navigation_polygon" type="NavigationPolygon" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="navigation_polygon" type="NavigationPolygon" /> <description> Sets the navigation polygon for the TileSet navigation layer with index [code]layer_id[/code]. </description> </method> <method name="set_occluder"> <return type="void" /> - <argument index="0" name="layer_id" type="int" /> - <argument index="1" name="occluder_polygon" type="OccluderPolygon2D" /> + <param index="0" name="layer_id" type="int" /> + <param index="1" name="occluder_polygon" type="OccluderPolygon2D" /> <description> Sets the occluder for the TileSet occlusion layer with index [code]layer_id[/code]. </description> </method> <method name="set_terrain_peering_bit"> <return type="void" /> - <argument index="0" name="peering_bit" type="int" enum="TileSet.CellNeighbor" /> - <argument index="1" name="terrain" type="int" /> + <param index="0" name="peering_bit" type="int" enum="TileSet.CellNeighbor" /> + <param index="1" name="terrain" type="int" /> <description> Sets the tile's terrain bit for the given [code]peering_bit[/code] direction. </description> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index d532f583e6..d13276ad54 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -18,9 +18,9 @@ <methods> <method name="_tile_data_runtime_update" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="coords" type="Vector2i" /> - <argument index="2" name="tile_data" type="TileData" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="coords" type="Vector2i" /> + <param index="2" name="tile_data" type="TileData" /> <description> Called with a TileData object about to be used internally by the TileMap, allowing its modification at runtime. This method is only called if [method _use_tile_data_runtime_update] is implemented and returns [code]true[/code] for the given tile [code]coords[/coords] and [code]layer[/code]. @@ -30,8 +30,8 @@ </method> <method name="_use_tile_data_runtime_update" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="coords" type="Vector2i" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="coords" type="Vector2i" /> <description> Should return [code]true[/code] if the tile at coordinates [code]coords[/coords] on layer [code]layer[/code] requires a runtime update. [b]Warning:[/b] Make sure this function only return [code]true[/code] when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty. @@ -39,7 +39,7 @@ </method> <method name="add_layer"> <return type="void" /> - <argument index="0" name="to_position" type="int" /> + <param index="0" name="to_position" type="int" /> <description> Adds a layer at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. </description> @@ -52,15 +52,15 @@ </method> <method name="clear_layer"> <return type="void" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Clears all cells on the given layer. </description> </method> <method name="erase_cell"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="coords" type="Vector2i" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="coords" type="Vector2i" /> <description> Erases the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. </description> @@ -73,7 +73,7 @@ </method> <method name="force_update"> <return type="void" /> - <argument index="0" name="layer" type="int" default="-1" /> + <param index="0" name="layer" type="int" default="-1" /> <description> Triggers an update of the TileMap. If [code]layer[/code] is provided, only updates the given layer. [b]Note:[/b] The TileMap node updates automatically when one of its properties is modified. A manual update is only needed if runtime modifications (implemented in [method _tile_data_runtime_update]) need to be applied. @@ -82,62 +82,62 @@ </method> <method name="get_cell_alternative_tile" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="coords" type="Vector2i" /> - <argument index="2" name="use_proxies" type="bool" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="coords" type="Vector2i" /> + <param index="2" name="use_proxies" type="bool" /> <description> Returns the tile alternative ID of the cell on layer [code]layer[/code] at [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy]. </description> </method> <method name="get_cell_atlas_coords" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="coords" type="Vector2i" /> - <argument index="2" name="use_proxies" type="bool" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="coords" type="Vector2i" /> + <param index="2" name="use_proxies" type="bool" /> <description> Returns the tile atlas coordinates ID of the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy]. </description> </method> <method name="get_cell_source_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="coords" type="Vector2i" /> - <argument index="2" name="use_proxies" type="bool" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="coords" type="Vector2i" /> + <param index="2" name="use_proxies" type="bool" /> <description> Returns the tile source ID of the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy]. </description> </method> <method name="get_coords_for_body_rid"> <return type="Vector2i" /> - <argument index="0" name="body" type="RID" /> + <param index="0" name="body" type="RID" /> <description> Returns the coordinates of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile. </description> </method> <method name="get_layer_modulate" qualifiers="const"> <return type="Color" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Returns a TileMap layer's modulate. </description> </method> <method name="get_layer_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Returns a TileMap layer's name. </description> </method> <method name="get_layer_y_sort_origin" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Returns a TileMap layer's Y sort origin. </description> </method> <method name="get_layer_z_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Returns a TileMap layer's Z-index value. </description> @@ -149,30 +149,30 @@ </method> <method name="get_neighbor_cell" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="coords" type="Vector2i" /> - <argument index="1" name="neighbor" type="int" enum="TileSet.CellNeighbor" /> + <param index="0" name="coords" type="Vector2i" /> + <param index="1" name="neighbor" type="int" enum="TileSet.CellNeighbor" /> <description> Returns the neighboring cell to the one at coordinates [code]coords[/code], identified by the [code]neighbor[/code] direction. This method takes into account the different layouts a TileMap can take. </description> </method> <method name="get_pattern"> <return type="TileMapPattern" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="coords_array" type="Vector2i[]" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="coords_array" type="Vector2i[]" /> <description> Creates a new [TileMapPattern] from the given layer and set of cells. </description> </method> <method name="get_surrounding_tiles"> <return type="Vector2i[]" /> - <argument index="0" name="coords" type="Vector2i" /> + <param index="0" name="coords" type="Vector2i" /> <description> Returns the list of all neighbourings cells to the one at [code]coords[/code] </description> </method> <method name="get_used_cells" qualifiers="const"> <return type="Vector2i[]" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Returns a [Vector2] array with the positions of all cells containing a tile in the given layer. A cell is considered empty if its source identifier equals -1, its atlas coordinates identifiers is [code]Vector2(-1, -1)[/code] and its alternative identifier is -1. </description> @@ -185,30 +185,30 @@ </method> <method name="is_layer_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Returns if a layer is enabled. </description> </method> <method name="is_layer_y_sort_enabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Returns if a layer Y-sorts its tiles. </description> </method> <method name="map_pattern"> <return type="Vector2i" /> - <argument index="0" name="position_in_tilemap" type="Vector2i" /> - <argument index="1" name="coords_in_pattern" type="Vector2i" /> - <argument index="2" name="pattern" type="TileMapPattern" /> + <param index="0" name="position_in_tilemap" type="Vector2i" /> + <param index="1" name="coords_in_pattern" type="Vector2i" /> + <param index="2" name="pattern" type="TileMapPattern" /> <description> Returns for the given coordinate [code]coords_in_pattern[/code] in a [TileMapPattern] the corresponding cell coordinates if the pattern was pasted at the [code]position_in_tilemap[/code] coordinates (see [method set_pattern]). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating [code]position_in_tile_map + coords_in_pattern[/code] </description> </method> <method name="map_to_world" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="map_position" type="Vector2i" /> + <param index="0" name="map_position" type="Vector2i" /> <description> Returns a local position of the center of the cell at the given tilemap (grid-based) coordinates. [b]Note:[/b] This doesn't correspond to the visual position of the tile, i.e. it ignores the [member TileData.texture_offset] property of individual tiles. @@ -216,26 +216,26 @@ </method> <method name="move_layer"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="to_position" type="int" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="to_position" type="int" /> <description> Moves the layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. </description> </method> <method name="remove_layer"> <return type="void" /> - <argument index="0" name="layer" type="int" /> + <param index="0" name="layer" type="int" /> <description> Removes the layer at index [code]layer[/code]. </description> </method> <method name="set_cell"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="coords" type="Vector2i" /> - <argument index="2" name="source_id" type="int" default="-1" /> - <argument index="3" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> - <argument index="4" name="alternative_tile" type="int" default="0" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="coords" type="Vector2i" /> + <param index="2" name="source_id" type="int" default="-1" /> + <param index="3" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> + <param index="4" name="alternative_tile" type="int" default="0" /> <description> Sets the tile indentifiers for the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. Each tile of the [TileSet] is identified using three parts: - The source identifier [code]source_id[/code] identifies a [TileSetSource] identifier. See [method TileSet.set_source_id], @@ -245,11 +245,11 @@ </method> <method name="set_cells_terrain_connect"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="cells" type="Vector2i[]" /> - <argument index="2" name="terrain_set" type="int" /> - <argument index="3" name="terrain" type="int" /> - <argument index="4" name="ignore_empty_terrains" type="bool" default="true" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="cells" type="Vector2i[]" /> + <param index="2" name="terrain_set" type="int" /> + <param index="3" name="terrain" type="int" /> + <param index="4" name="ignore_empty_terrains" type="bool" default="true" /> <description> Update all the cells in the [code]cells[/code] coordinates array so that they use the given [code]terrain[/code] for the given [code]terrain_set[/code]. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions. If [code]ignore_empty_terrains[/code] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. If [code]ignore_empty_terrains[/code] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. @@ -258,11 +258,11 @@ </method> <method name="set_cells_terrain_path"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="path" type="Vector2i[]" /> - <argument index="2" name="terrain_set" type="int" /> - <argument index="3" name="terrain" type="int" /> - <argument index="4" name="ignore_empty_terrains" type="bool" default="true" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="path" type="Vector2i[]" /> + <param index="2" name="terrain_set" type="int" /> + <param index="3" name="terrain" type="int" /> + <param index="4" name="ignore_empty_terrains" type="bool" default="true" /> <description> Update all the cells in the [code]cells[/code] coordinates array so that they use the given [code]terrain[/code] for the given [code]terrain_set[/code]. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions. If [code]ignore_empty_terrains[/code] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. @@ -271,32 +271,32 @@ </method> <method name="set_layer_enabled"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="enabled" type="bool" /> <description> Enables or disables the layer [code]layer[/code]. A disabled layer is not processed at all (no rendering, no physics, etc...). </description> </method> <method name="set_layer_modulate"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="enabled" type="Color" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="enabled" type="Color" /> <description> Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate. </description> </method> <method name="set_layer_name"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets a layer's name. This is mostly useful in the editor. </description> </method> <method name="set_layer_y_sort_enabled"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="y_sort_enabled" type="bool" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="y_sort_enabled" type="bool" /> <description> Enables or disables a layer's Y-sorting. If a layer is Y-sorted, the layer will behave as a CanvasItem node where each of its tile gets Y-sorted. Y-sorted layers should usually be on different Z-index values than not Y-sorted layers, otherwise, each of those layer will be Y-sorted as whole with the Y-sorted one. This is usually an undesired behvaior. @@ -304,8 +304,8 @@ </method> <method name="set_layer_y_sort_origin"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="y_sort_origin" type="int" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="y_sort_origin" type="int" /> <description> Sets a layer's Y-sort origin value. This Y-sort origin value is added to each tile's Y-sort origin value. This allows, for example, to fake a different height level on each layer. This can be useful for top-down view games. @@ -313,24 +313,24 @@ </method> <method name="set_layer_z_index"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="z_index" type="int" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="z_index" type="int" /> <description> Sets a layers Z-index value. This Z-index is added to each tile's Z-index value. </description> </method> <method name="set_pattern"> <return type="void" /> - <argument index="0" name="layer" type="int" /> - <argument index="1" name="position" type="Vector2i" /> - <argument index="2" name="pattern" type="TileMapPattern" /> + <param index="0" name="layer" type="int" /> + <param index="1" name="position" type="Vector2i" /> + <param index="2" name="pattern" type="TileMapPattern" /> <description> Paste the given [TileMapPattern] at the given [code]position[/code] and [code]layer[/code] in the tile map. </description> </method> <method name="world_to_map" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="world_position" type="Vector2" /> + <param index="0" name="world_position" type="Vector2" /> <description> Returns the tilemap (grid-based) coordinates corresponding to the given local position. </description> diff --git a/doc/classes/TileMapPattern.xml b/doc/classes/TileMapPattern.xml index 5fe514d3da..a499b31503 100644 --- a/doc/classes/TileMapPattern.xml +++ b/doc/classes/TileMapPattern.xml @@ -12,21 +12,21 @@ <methods> <method name="get_cell_alternative_tile" qualifiers="const"> <return type="int" /> - <argument index="0" name="coords" type="Vector2i" /> + <param index="0" name="coords" type="Vector2i" /> <description> Returns the tile alternative ID of the cell at [code]coords[/code]. </description> </method> <method name="get_cell_atlas_coords" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="coords" type="Vector2i" /> + <param index="0" name="coords" type="Vector2i" /> <description> Returns the tile atlas coordinates ID of the cell at [code]coords[/code]. </description> </method> <method name="get_cell_source_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="coords" type="Vector2i" /> + <param index="0" name="coords" type="Vector2i" /> <description> Returns the tile source ID of the cell at [code]coords[/code]. </description> @@ -45,7 +45,7 @@ </method> <method name="has_cell" qualifiers="const"> <return type="bool" /> - <argument index="0" name="coords" type="Vector2i" /> + <param index="0" name="coords" type="Vector2i" /> <description> Returns whether the pattern has a tile at the given coordinates. </description> @@ -58,25 +58,25 @@ </method> <method name="remove_cell"> <return type="void" /> - <argument index="0" name="coords" type="Vector2i" /> - <argument index="1" name="update_size" type="bool" /> + <param index="0" name="coords" type="Vector2i" /> + <param index="1" name="update_size" type="bool" /> <description> Remove the cell at the given coordinates. </description> </method> <method name="set_cell"> <return type="void" /> - <argument index="0" name="coords" type="Vector2i" /> - <argument index="1" name="source_id" type="int" default="-1" /> - <argument index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> - <argument index="3" name="alternative_tile" type="int" default="-1" /> + <param index="0" name="coords" type="Vector2i" /> + <param index="1" name="source_id" type="int" default="-1" /> + <param index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> + <param index="3" name="alternative_tile" type="int" default="-1" /> <description> Sets the tile indentifiers for the cell at coordinates [code]coords[/code]. See [method TileMap.set_cell]. </description> </method> <method name="set_size"> <return type="void" /> - <argument index="0" name="size" type="Vector2i" /> + <param index="0" name="size" type="Vector2i" /> <description> Sets the size of the pattern. </description> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 180e868ef8..5e2b4b64fb 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -24,7 +24,7 @@ <methods> <method name="add_custom_data_layer"> <return type="void" /> - <argument index="0" name="to_position" type="int" default="-1" /> + <param index="0" name="to_position" type="int" default="-1" /> <description> Adds a custom data layer to the TileSet at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. Custom data layers allow assigning custom properties to atlas tiles. @@ -32,7 +32,7 @@ </method> <method name="add_navigation_layer"> <return type="void" /> - <argument index="0" name="to_position" type="int" default="-1" /> + <param index="0" name="to_position" type="int" default="-1" /> <description> Adds a navigation layer to the TileSet at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. Navigation layers allow assigning a navigable area to atlas tiles. @@ -40,7 +40,7 @@ </method> <method name="add_occlusion_layer"> <return type="void" /> - <argument index="0" name="to_position" type="int" default="-1" /> + <param index="0" name="to_position" type="int" default="-1" /> <description> Adds an occlusion layer to the TileSet at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. Occlusion layers allow assigning occlusion polygons to atlas tiles. @@ -48,15 +48,15 @@ </method> <method name="add_pattern"> <return type="int" /> - <argument index="0" name="pattern" type="TileMapPattern" /> - <argument index="1" name="index" type="int" default="-1" /> + <param index="0" name="pattern" type="TileMapPattern" /> + <param index="1" name="index" type="int" default="-1" /> <description> Adds a [TileMapPattern] to be stored in the TileSet resource. If provided, insert it at the given [code]index[/code]. </description> </method> <method name="add_physics_layer"> <return type="void" /> - <argument index="0" name="to_position" type="int" default="-1" /> + <param index="0" name="to_position" type="int" default="-1" /> <description> Adds a physics layer to the TileSet at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. Physics layers allow assigning collision polygons to atlas tiles. @@ -64,8 +64,8 @@ </method> <method name="add_source"> <return type="int" /> - <argument index="0" name="source" type="TileSetSource" /> - <argument index="1" name="atlas_source_id_override" type="int" default="-1" /> + <param index="0" name="source" type="TileSetSource" /> + <param index="1" name="atlas_source_id_override" type="int" default="-1" /> <description> Adds a [TileSetSource] to the TileSet. If [code]atlas_source_id_override[/code] is not -1, also set its source ID. Otherwise, a unique identifier is automatically generated. The function returns the added source source ID or -1 if the source could not be added. @@ -73,15 +73,15 @@ </method> <method name="add_terrain"> <return type="void" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="to_position" type="int" default="-1" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="to_position" type="int" default="-1" /> <description> Adds a new terrain to the given terrain set [code]terrain_set[/code] at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. </description> </method> <method name="add_terrain_set"> <return type="void" /> - <argument index="0" name="to_position" type="int" default="-1" /> + <param index="0" name="to_position" type="int" default="-1" /> <description> Adds a new terrain set at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. </description> @@ -100,9 +100,9 @@ </method> <method name="get_alternative_level_tile_proxy"> <return type="Array" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> - <argument index="2" name="alternative_from" type="int" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> + <param index="2" name="alternative_from" type="int" /> <description> Returns the alternative-level proxy for the given identifiers. The returned array contains the three proxie's target identifiers (source ID, atlas coords ID and alternative tile ID). If the TileSet has no proxy for the given identifiers, returns an empty Array. @@ -110,8 +110,8 @@ </method> <method name="get_coords_level_tile_proxy"> <return type="Array" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> <description> Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID). If the TileSet has no proxy for the given identifiers, returns an empty Array. @@ -119,21 +119,21 @@ </method> <method name="get_custom_data_layer_by_name" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer_name" type="String" /> + <param index="0" name="layer_name" type="String" /> <description> Returns the index of the custom data layer identified by the given name. </description> </method> <method name="get_custom_data_layer_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Returns the name of the custom data layer identified by the given index. </description> </method> <method name="get_custom_data_layer_type" qualifiers="const"> <return type="int" enum="Variant.Type" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Returns the type of the custom data layer identified by the given index. </description> @@ -146,7 +146,7 @@ </method> <method name="get_navigation_layer_layers" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Returns the navigation layers (as in the Navigation server) of the gives TileSet navigation layer. </description> @@ -165,14 +165,14 @@ </method> <method name="get_occlusion_layer_light_mask" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Returns the light mask of the occlusion layer. </description> </method> <method name="get_occlusion_layer_sdf_collision" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Returns if the occluders from this layer use [code]sdf_collision[/code]. </description> @@ -185,7 +185,7 @@ </method> <method name="get_pattern"> <return type="TileMapPattern" /> - <argument index="0" name="index" type="int" default="-1" /> + <param index="0" name="index" type="int" default="-1" /> <description> Returns the [TileMapPattern] at the given [code]index[/code]. </description> @@ -198,21 +198,21 @@ </method> <method name="get_physics_layer_collision_layer" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Returns the collision layer (as in the physics server) bodies on the given TileSet's physics layer are in. </description> </method> <method name="get_physics_layer_collision_mask" qualifiers="const"> <return type="int" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Returns the collision mask of bodies on the given TileSet's physics layer. </description> </method> <method name="get_physics_layer_physics_material" qualifiers="const"> <return type="PhysicsMaterial" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Returns the physics material of bodies on the given TileSet's physics layer. </description> @@ -225,7 +225,7 @@ </method> <method name="get_source" qualifiers="const"> <return type="TileSetSource" /> - <argument index="0" name="source_id" type="int" /> + <param index="0" name="source_id" type="int" /> <description> Returns the [TileSetSource] with ID [code]source_id[/code]. </description> @@ -238,14 +238,14 @@ </method> <method name="get_source_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the source ID for source with index [code]index[/code]. </description> </method> <method name="get_source_level_tile_proxy"> <return type="int" /> - <argument index="0" name="source_from" type="int" /> + <param index="0" name="source_from" type="int" /> <description> Returns the source-level proxy for the given source identifier. If the TileSet has no proxy for the given identifier, returns -1. @@ -253,23 +253,23 @@ </method> <method name="get_terrain_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="terrain_index" type="int" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="terrain_index" type="int" /> <description> Returns a terrain's color. </description> </method> <method name="get_terrain_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="terrain_index" type="int" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="terrain_index" type="int" /> <description> Returns a terrain's name. </description> </method> <method name="get_terrain_set_mode" qualifiers="const"> <return type="int" enum="TileSet.TerrainMode" /> - <argument index="0" name="terrain_set" type="int" /> + <param index="0" name="terrain_set" type="int" /> <description> Returns a terrain set mode. </description> @@ -282,47 +282,47 @@ </method> <method name="get_terrains_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="terrain_set" type="int" /> + <param index="0" name="terrain_set" type="int" /> <description> Returns the number of terrains in the given terrain set. </description> </method> <method name="has_alternative_level_tile_proxy"> <return type="bool" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> - <argument index="2" name="alternative_from" type="int" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> + <param index="2" name="alternative_from" type="int" /> <description> Returns if there is and alternative-level proxy for the given identifiers. </description> </method> <method name="has_coords_level_tile_proxy"> <return type="bool" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> <description> Returns if there is a coodinates-level proxy for the given identifiers. </description> </method> <method name="has_source" qualifiers="const"> <return type="bool" /> - <argument index="0" name="source_id" type="int" /> + <param index="0" name="source_id" type="int" /> <description> Returns if this TileSet has a source for the given source ID. </description> </method> <method name="has_source_level_tile_proxy"> <return type="bool" /> - <argument index="0" name="source_from" type="int" /> + <param index="0" name="source_from" type="int" /> <description> Returns if there is a source-level proxy for the given source ID. </description> </method> <method name="map_tile_proxy" qualifiers="const"> <return type="Array" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> - <argument index="2" name="alternative_from" type="int" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> + <param index="2" name="alternative_from" type="int" /> <description> According to the configured proxies, maps the provided indentifiers to a new set of identifiers. The source ID, atlas coordinates ID and alternative tile ID are returned as a 3 elements Array. This function first look for matching alternative-level proxies, then coordinates-level proxies, then source-level proxies. @@ -331,142 +331,142 @@ </method> <method name="move_custom_data_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="to_position" type="int" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="to_position" type="int" /> <description> Moves the custom data layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. </description> </method> <method name="move_navigation_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="to_position" type="int" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="to_position" type="int" /> <description> Moves the navigation layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. </description> </method> <method name="move_occlusion_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="to_position" type="int" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="to_position" type="int" /> <description> Moves the occlusion layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. </description> </method> <method name="move_physics_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="to_position" type="int" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="to_position" type="int" /> <description> Moves the physics layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. </description> </method> <method name="move_terrain"> <return type="void" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="terrain_index" type="int" /> - <argument index="2" name="to_position" type="int" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="terrain_index" type="int" /> + <param index="2" name="to_position" type="int" /> <description> Moves the terrain at index [code]terrain_index[/code] for terrain set [code]terrain_set[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. </description> </method> <method name="move_terrain_set"> <return type="void" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="to_position" type="int" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="to_position" type="int" /> <description> Moves the terrain set at index [code]terrain_set[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. </description> </method> <method name="remove_alternative_level_tile_proxy"> <return type="void" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> - <argument index="2" name="alternative_from" type="int" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> + <param index="2" name="alternative_from" type="int" /> <description> Removes an alternative-level proxy for the given identifiers. </description> </method> <method name="remove_coords_level_tile_proxy"> <return type="void" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> <description> Removes a coordinates-level proxy for the given identifiers. </description> </method> <method name="remove_custom_data_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Removes the custom data layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. </description> </method> <method name="remove_navigation_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Removes the navigation layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. </description> </method> <method name="remove_occlusion_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Removes the occlusion layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. </description> </method> <method name="remove_pattern"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Remove the [TileMapPattern] at the given index. </description> </method> <method name="remove_physics_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> + <param index="0" name="layer_index" type="int" /> <description> Removes the physics layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. </description> </method> <method name="remove_source"> <return type="void" /> - <argument index="0" name="source_id" type="int" /> + <param index="0" name="source_id" type="int" /> <description> Removes the source with the given source ID. </description> </method> <method name="remove_source_level_tile_proxy"> <return type="void" /> - <argument index="0" name="source_from" type="int" /> + <param index="0" name="source_from" type="int" /> <description> Removes a source-level tile proxy. </description> </method> <method name="remove_terrain"> <return type="void" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="terrain_index" type="int" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="terrain_index" type="int" /> <description> Removes the terrain at index [code]terrain_index[/code] in the given terrain set [code]terrain_set[/code]. Also updates the atlas tiles accordingly. </description> </method> <method name="remove_terrain_set"> <return type="void" /> - <argument index="0" name="terrain_set" type="int" /> + <param index="0" name="terrain_set" type="int" /> <description> Removes the terrain set at index [code]terrain_set[/code]. Also updates the atlas tiles accordingly. </description> </method> <method name="set_alternative_level_tile_proxy"> <return type="void" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> - <argument index="2" name="alternative_from" type="int" /> - <argument index="3" name="source_to" type="int" /> - <argument index="4" name="coords_to" type="Vector2i" /> - <argument index="5" name="alternative_to" type="int" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> + <param index="2" name="alternative_from" type="int" /> + <param index="3" name="source_to" type="int" /> + <param index="4" name="coords_to" type="Vector2i" /> + <param index="5" name="alternative_to" type="int" /> <description> Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. @@ -475,10 +475,10 @@ </method> <method name="set_coords_level_tile_proxy"> <return type="void" /> - <argument index="0" name="p_source_from" type="int" /> - <argument index="1" name="coords_from" type="Vector2i" /> - <argument index="2" name="source_to" type="int" /> - <argument index="3" name="coords_to" type="Vector2i" /> + <param index="0" name="p_source_from" type="int" /> + <param index="1" name="coords_from" type="Vector2i" /> + <param index="2" name="source_to" type="int" /> + <param index="3" name="coords_to" type="Vector2i" /> <description> Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies. This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. @@ -487,80 +487,80 @@ </method> <method name="set_custom_data_layer_name"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="layer_name" type="String" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="layer_name" type="String" /> <description> Sets the name of the custom data layer identified by the given index. Names are identifiers of the layer therefore if the name is already taken it will fail and raise an error. </description> </method> <method name="set_custom_data_layer_type"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="layer_type" type="int" enum="Variant.Type" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="layer_type" type="int" enum="Variant.Type" /> <description> Sets the type of the custom data layer identified by the given index. </description> </method> <method name="set_navigation_layer_layers"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="layers" type="int" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="layers" type="int" /> <description> Sets the navigation layers (as in the navigation server) for navigation regions is the given TileSet navigation layer. </description> </method> <method name="set_occlusion_layer_light_mask"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="light_mask" type="int" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="light_mask" type="int" /> <description> Sets the occlusion layer (as in the rendering server) for occluders in the given TileSet occlusion layer. </description> </method> <method name="set_occlusion_layer_sdf_collision"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="sdf_collision" type="bool" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="sdf_collision" type="bool" /> <description> Enables or disables sdf collision for occluders in the given TileSet occlusion layer. </description> </method> <method name="set_physics_layer_collision_layer"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="layer" type="int" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="layer" type="int" /> <description> Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer. </description> </method> <method name="set_physics_layer_collision_mask"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="mask" type="int" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="mask" type="int" /> <description> Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer. </description> </method> <method name="set_physics_layer_physics_material"> <return type="void" /> - <argument index="0" name="layer_index" type="int" /> - <argument index="1" name="physics_material" type="PhysicsMaterial" /> + <param index="0" name="layer_index" type="int" /> + <param index="1" name="physics_material" type="PhysicsMaterial" /> <description> Sets the physics material for bodies in the given TileSet physics layer. </description> </method> <method name="set_source_id"> <return type="void" /> - <argument index="0" name="source_id" type="int" /> - <argument index="1" name="new_source_id" type="int" /> + <param index="0" name="source_id" type="int" /> + <param index="1" name="new_source_id" type="int" /> <description> Changes a source's ID. </description> </method> <method name="set_source_level_tile_proxy"> <return type="void" /> - <argument index="0" name="source_from" type="int" /> - <argument index="1" name="source_to" type="int" /> + <param index="0" name="source_from" type="int" /> + <param index="1" name="source_to" type="int" /> <description> Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlac coordinates ID and the alternative tile ID are kept the same when using source-level proxies. This can be used to replace a source in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target source when one is available. @@ -569,26 +569,26 @@ </method> <method name="set_terrain_color"> <return type="void" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="terrain_index" type="int" /> - <argument index="2" name="color" type="Color" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="terrain_index" type="int" /> + <param index="2" name="color" type="Color" /> <description> Sets a terrain's color. This color is used for identifying the different terrains in the TileSet editor. </description> </method> <method name="set_terrain_name"> <return type="void" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="terrain_index" type="int" /> - <argument index="2" name="name" type="String" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="terrain_index" type="int" /> + <param index="2" name="name" type="String" /> <description> Sets a terrain's name. </description> </method> <method name="set_terrain_set_mode"> <return type="void" /> - <argument index="0" name="terrain_set" type="int" /> - <argument index="1" name="mode" type="int" enum="TileSet.TerrainMode" /> + <param index="0" name="terrain_set" type="int" /> + <param index="1" name="mode" type="int" enum="TileSet.TerrainMode" /> <description> Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighbouring tiles' terrains. </description> diff --git a/doc/classes/TileSetAtlasSource.xml b/doc/classes/TileSetAtlasSource.xml index db4e52f661..9053a81628 100644 --- a/doc/classes/TileSetAtlasSource.xml +++ b/doc/classes/TileSetAtlasSource.xml @@ -17,8 +17,8 @@ <methods> <method name="create_alternative_tile"> <return type="int" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="alternative_id_override" type="int" default="-1" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="alternative_id_override" type="int" default="-1" /> <description> Creates an alternative tile for the tile at coords [code]atlas_coords[/code]. If [code]alternative_id_override[/code] is -1, give it an automatically generated unique ID, or assigns it the given ID otherwise. Returns the new alternative identifier, or -1 if the alternative could not be created with a provided [code]alternative_id_override[/code]. @@ -26,8 +26,8 @@ </method> <method name="create_tile"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="size" type="Vector2i" default="Vector2i(1, 1)" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="size" type="Vector2i" default="Vector2i(1, 1)" /> <description> Creates a new tile at coords [code]atlas_coords[/code] with size [code]size[/code]. </description> @@ -40,7 +40,7 @@ </method> <method name="get_next_alternative_tile_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns the alternative ID a following call to [method create_alternative_tile] would return. </description> @@ -53,8 +53,8 @@ </method> <method name="get_runtime_tile_texture_region" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="frame" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="frame" type="int" /> <description> Returns the region of the tile at coordinates [code]atlas_coords[/code] for frame [code]frame[/code] inside the texture returned by [method get_runtime_texture]. [b]Note:[/b] If [member use_texture_padding] is [code]false[/code], returns the same as [method get_tile_texture_region]. @@ -62,104 +62,104 @@ </method> <method name="get_tile_animation_columns" qualifiers="const"> <return type="int" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns how many columns the tile at [code]atlas_coords[/code] has in its animation layout. </description> </method> <method name="get_tile_animation_frame_duration" qualifiers="const"> <return type="float" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="frame_index" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="frame_index" type="int" /> <description> Returns the animation frame duration of frame [code]frame_index[/code] for the tile at coordinates [code]atlas_coords[/code]. </description> </method> <method name="get_tile_animation_frames_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns how many animation frames has the tile at coordinates [code]atlas_coords[/code]. </description> </method> <method name="get_tile_animation_separation" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns the separation (as in the atlas grid) between each frame of an animated tile at coordinates [code]atlas_coords[/code]. </description> </method> <method name="get_tile_animation_speed" qualifiers="const"> <return type="float" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns the animation speed of the tile at coordinates [code]atlas_coords[/code]. </description> </method> <method name="get_tile_animation_total_duration" qualifiers="const"> <return type="float" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns the sum of the sum of the frame durations of the tile at coordinates [code]atlas_coords[/code]. This value needs to be divided by the animation speed to get the actual animation loop duration. </description> </method> <method name="get_tile_at_coords" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> If there is a tile covering the [code]atlas_coords[/code] coordinates, returns the top-left coordinates of the tile (thus its coordinate ID). Returns [code]Vector2i(-1, -1)[/code] otherwise. </description> </method> <method name="get_tile_data" qualifiers="const"> <return type="TileData" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="alternative_tile" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="alternative_tile" type="int" /> <description> Returns the [TileData] object for the given atlas coordinates and alternative ID. </description> </method> <method name="get_tile_size_in_atlas" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns the size of the tile (in the grid coordinates system) at coordinates [code]atlas_coords[/code]. </description> </method> <method name="get_tile_texture_region" qualifiers="const"> <return type="Rect2i" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="frame" type="int" default="0" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="frame" type="int" default="0" /> <description> Returns a tile's texture region in the atlas texture. For animated tiles, a [code]frame[/code] argument might be provided for the different frames of the animation. </description> </method> <method name="get_tiles_to_be_removed_on_change"> <return type="PackedVector2Array" /> - <argument index="0" name="texture" type="Texture2D" /> - <argument index="1" name="margins" type="Vector2i" /> - <argument index="2" name="separation" type="Vector2i" /> - <argument index="3" name="texture_region_size" type="Vector2i" /> + <param index="0" name="texture" type="Texture2D" /> + <param index="1" name="margins" type="Vector2i" /> + <param index="2" name="separation" type="Vector2i" /> + <param index="3" name="texture_region_size" type="Vector2i" /> <description> Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: [code]texture[/code], [code]margins[/code], [code]separation[/code] or [code]texture_region_size[/code]. This can be used to undo changes that would have caused tiles data loss. </description> </method> <method name="has_room_for_tile" qualifiers="const"> <return type="bool" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="size" type="Vector2i" /> - <argument index="2" name="animation_columns" type="int" /> - <argument index="3" name="animation_separation" type="Vector2i" /> - <argument index="4" name="frames_count" type="int" /> - <argument index="5" name="ignored_tile" type="Vector2i" default="Vector2i(-1, -1)" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="size" type="Vector2i" /> + <param index="2" name="animation_columns" type="int" /> + <param index="3" name="animation_separation" type="Vector2i" /> + <param index="4" name="frames_count" type="int" /> + <param index="5" name="ignored_tile" type="Vector2i" default="Vector2i(-1, -1)" /> <description> Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If [code]ignored_tile[/code] is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties. </description> </method> <method name="move_tile_in_atlas"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> - <argument index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> + <param index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)" /> <description> Move the tile and its alternatives at the [code]atlas_coords[/code] coordinates to the [code]new_atlas_coords[/code] coordinates with the [code]new_size[/code] size. This functions will fail if a tile is already present in the given area. If [code]new_atlas_coords[/code] is [code]Vector2i(-1, -1)[/code], keeps the tile's coordinates. If [code]new_size[/code] is [code]Vector2i(-1, -1)[/code], keeps the tile's size. @@ -168,8 +168,8 @@ </method> <method name="remove_alternative_tile"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="alternative_tile" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="alternative_tile" type="int" /> <description> Remove a tile's alternative with alternative ID [code]alternative_tile[/code]. Calling this function with [code]alternative_tile[/code] equals to 0 will fail, as the base tile alternative cannot be removed. @@ -177,16 +177,16 @@ </method> <method name="remove_tile"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Remove a tile and its alternative at coordinates [code]atlas_coords[/code]. </description> </method> <method name="set_alternative_tile_id"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="alternative_tile" type="int" /> - <argument index="2" name="new_id" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="alternative_tile" type="int" /> + <param index="2" name="new_id" type="int" /> <description> Change a tile's alternative ID from [code]alternative_tile[/code] to [code]new_id[/code]. Calling this function with [code]alternative_id[/code] equals to 0 will fail, as the base tile alternative cannot be moved. @@ -194,41 +194,41 @@ </method> <method name="set_tile_animation_columns"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="frame_columns" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="frame_columns" type="int" /> <description> Sets the number of columns in the animation layout of the tile at coordinates [code]atlas_coords[/code]. If set to 0, then the different frames of the animation are laid out as a single horizontal line in the atlas. </description> </method> <method name="set_tile_animation_frame_duration"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="frame_index" type="int" /> - <argument index="2" name="duration" type="float" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="frame_index" type="int" /> + <param index="2" name="duration" type="float" /> <description> Sets the animation frame duration of frame [code]frame_index[/code] for the tile at coordinates [code]atlas_coords[/code]. </description> </method> <method name="set_tile_animation_frames_count"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="frames_count" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="frames_count" type="int" /> <description> Sets how many animation frames the tile at coordinates [code]atlas_coords[/code] has. </description> </method> <method name="set_tile_animation_separation"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="separation" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="separation" type="Vector2i" /> <description> Sets the margin (in grid tiles) between each tile in the animation layout of the tile at coordinates [code]atlas_coords[/code] has. </description> </method> <method name="set_tile_animation_speed"> <return type="void" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="speed" type="float" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="speed" type="float" /> <description> Sets the animation speed of the tile at coordinates [code]atlas_coords[/code] has. </description> diff --git a/doc/classes/TileSetScenesCollectionSource.xml b/doc/classes/TileSetScenesCollectionSource.xml index a8ef253933..f6e13de060 100644 --- a/doc/classes/TileSetScenesCollectionSource.xml +++ b/doc/classes/TileSetScenesCollectionSource.xml @@ -12,8 +12,8 @@ <methods> <method name="create_scene_tile"> <return type="int" /> - <argument index="0" name="packed_scene" type="PackedScene" /> - <argument index="1" name="id_override" type="int" default="-1" /> + <param index="0" name="packed_scene" type="PackedScene" /> + <param index="1" name="id_override" type="int" default="-1" /> <description> Creates a scene-based tile out of the given scene. Returns a newly generated unique ID. @@ -27,21 +27,21 @@ </method> <method name="get_scene_tile_display_placeholder" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns whether the scene tile with id [code]id[/code] displays a placeholder in the editor. </description> </method> <method name="get_scene_tile_id"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the scene tile ID of the scene tile at index [code]index[/code]. </description> </method> <method name="get_scene_tile_scene" qualifiers="const"> <return type="PackedScene" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the [PackedScene] resource of scene tile with id [code]id[/code]. </description> @@ -54,38 +54,38 @@ </method> <method name="has_scene_tile_id"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns whether this TileSet source has a scene tile with id [code]id[/code]. </description> </method> <method name="remove_scene_tile"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Remove the scene tile with id [code]id[/code]. </description> </method> <method name="set_scene_tile_display_placeholder"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="display_placeholder" type="bool" /> + <param index="0" name="id" type="int" /> + <param index="1" name="display_placeholder" type="bool" /> <description> Sets whether or not the scene tile with id [code]id[/code] should display a placeholder in the editor. This might be useful for scenes that are not visible. </description> </method> <method name="set_scene_tile_id"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="new_id" type="int" /> + <param index="0" name="id" type="int" /> + <param index="1" name="new_id" type="int" /> <description> Changes a scene tile's ID from [code]id[/code] to [code]new_id[/code]. This will fail if there is already a tile with a ID equal to [code]new_id[/code]. </description> </method> <method name="set_scene_tile_scene"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="packed_scene" type="PackedScene" /> + <param index="0" name="id" type="int" /> + <param index="1" name="packed_scene" type="PackedScene" /> <description> Assigns a [PackedScene] resource to the scene tile with id [code]id[/code]. This will fail if the scene does not extend CanvasItem, as positioning properties are needed to place the scene on the TileMap. </description> diff --git a/doc/classes/TileSetSource.xml b/doc/classes/TileSetSource.xml index 3d23975e37..ae5c3717f2 100644 --- a/doc/classes/TileSetSource.xml +++ b/doc/classes/TileSetSource.xml @@ -15,15 +15,15 @@ <methods> <method name="get_alternative_tile_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="index" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="index" type="int" /> <description> Returns the alternative ID for the tile with coordinates ID [code]atlas_coords[/code] at index [code]index[/code]. </description> </method> <method name="get_alternative_tiles_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns the number of alternatives tiles for the coordinates ID [code]atlas_coords[/code]. For [TileSetAtlasSource], this always return at least 1, as the base tile with ID 0 is always part of the alternatives list. @@ -32,7 +32,7 @@ </method> <method name="get_tile_id" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the tile coordinates ID of the tile with index [code]index[/code]. </description> @@ -45,15 +45,15 @@ </method> <method name="has_alternative_tile" qualifiers="const"> <return type="bool" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> - <argument index="1" name="alternative_tile" type="int" /> + <param index="0" name="atlas_coords" type="Vector2i" /> + <param index="1" name="alternative_tile" type="int" /> <description> Returns if the base tile at coordinates [code]atlas_coords[/code] has an alternative with ID [code]alternative_tile[/code]. </description> </method> <method name="has_tile" qualifiers="const"> <return type="bool" /> - <argument index="0" name="atlas_coords" type="Vector2i" /> + <param index="0" name="atlas_coords" type="Vector2i" /> <description> Returns if this atlas has a tile with coordinates ID [code]atlas_coordinates[/code]. </description> diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml index 5fc85c869b..e213be2e12 100644 --- a/doc/classes/Time.xml +++ b/doc/classes/Time.xml @@ -15,7 +15,7 @@ <methods> <method name="get_date_dict_from_system" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="utc" type="bool" default="false" /> + <param index="0" name="utc" type="bool" default="false" /> <description> Returns the current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], and [code]dst[/code] (Daylight Savings Time). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -23,14 +23,14 @@ </method> <method name="get_date_dict_from_unix_time" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="unix_time_val" type="int" /> + <param index="0" name="unix_time_val" type="int" /> <description> Converts the given Unix timestamp to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], and [code]weekday[/code]. </description> </method> <method name="get_date_string_from_system" qualifiers="const"> <return type="String" /> - <argument index="0" name="utc" type="bool" default="false" /> + <param index="0" name="utc" type="bool" default="false" /> <description> Returns the current date as an ISO 8601 date string (YYYY-MM-DD). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -38,15 +38,15 @@ </method> <method name="get_date_string_from_unix_time" qualifiers="const"> <return type="String" /> - <argument index="0" name="unix_time_val" type="int" /> + <param index="0" name="unix_time_val" type="int" /> <description> Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD). </description> </method> <method name="get_datetime_dict_from_datetime_string" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="datetime" type="String" /> - <argument index="1" name="weekday" type="bool" /> + <param index="0" name="datetime" type="String" /> + <param index="1" name="weekday" type="bool" /> <description> Converts the given ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS) to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. If [code]weekday[/code] is false, then the [code]weekday[/code] entry is excluded (the calculation is relatively expensive). @@ -55,14 +55,14 @@ </method> <method name="get_datetime_dict_from_system" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="utc" type="bool" default="false" /> + <param index="0" name="utc" type="bool" default="false" /> <description> Returns the current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. </description> </method> <method name="get_datetime_dict_from_unix_time" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="unix_time_val" type="int" /> + <param index="0" name="unix_time_val" type="int" /> <description> Converts the given Unix timestamp to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], and [code]weekday[/code]. The returned Dictionary's values will be the same as the [method get_datetime_dict_from_system] if the Unix timestamp is the current time, with the exception of Daylight Savings Time as it cannot be determined from the epoch. @@ -70,8 +70,8 @@ </method> <method name="get_datetime_string_from_datetime_dict" qualifiers="const"> <return type="String" /> - <argument index="0" name="datetime" type="Dictionary" /> - <argument index="1" name="use_space" type="bool" /> + <param index="0" name="datetime" type="Dictionary" /> + <param index="1" name="use_space" type="bool" /> <description> Converts the given dictionary of keys to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). The given dictionary can be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. Any other entries (including [code]dst[/code]) are ignored. @@ -81,8 +81,8 @@ </method> <method name="get_datetime_string_from_system" qualifiers="const"> <return type="String" /> - <argument index="0" name="utc" type="bool" default="false" /> - <argument index="1" name="use_space" type="bool" default="false" /> + <param index="0" name="utc" type="bool" default="false" /> + <param index="1" name="use_space" type="bool" default="false" /> <description> Returns the current date and time as an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -91,8 +91,8 @@ </method> <method name="get_datetime_string_from_unix_time" qualifiers="const"> <return type="String" /> - <argument index="0" name="unix_time_val" type="int" /> - <argument index="1" name="use_space" type="bool" default="false" /> + <param index="0" name="unix_time_val" type="int" /> + <param index="1" name="use_space" type="bool" default="false" /> <description> Converts the given Unix timestamp to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). If [code]use_space[/code] is true, use a space instead of the letter T in the middle. @@ -100,7 +100,7 @@ </method> <method name="get_offset_string_from_offset_minutes" qualifiers="const"> <return type="String" /> - <argument index="0" name="offset_minutes" type="int" /> + <param index="0" name="offset_minutes" type="int" /> <description> Converts the given timezone offset in minutes to a timezone offset string. For example, -480 returns "-08:00", 345 returns "+05:45", and 0 returns "+00:00". </description> @@ -121,7 +121,7 @@ </method> <method name="get_time_dict_from_system" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="utc" type="bool" default="false" /> + <param index="0" name="utc" type="bool" default="false" /> <description> Returns the current time as a dictionary of keys: [code]hour[/code], [code]minute[/code], and [code]second[/code]. The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -129,14 +129,14 @@ </method> <method name="get_time_dict_from_unix_time" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="unix_time_val" type="int" /> + <param index="0" name="unix_time_val" type="int" /> <description> Converts the given time to a dictionary of keys: [code]hour[/code], [code]minute[/code], and [code]second[/code]. </description> </method> <method name="get_time_string_from_system" qualifiers="const"> <return type="String" /> - <argument index="0" name="utc" type="bool" default="false" /> + <param index="0" name="utc" type="bool" default="false" /> <description> Returns the current time as an ISO 8601 time string (HH:MM:SS). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -144,7 +144,7 @@ </method> <method name="get_time_string_from_unix_time" qualifiers="const"> <return type="String" /> - <argument index="0" name="unix_time_val" type="int" /> + <param index="0" name="unix_time_val" type="int" /> <description> Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS). </description> @@ -157,7 +157,7 @@ </method> <method name="get_unix_time_from_datetime_dict" qualifiers="const"> <return type="int" /> - <argument index="0" name="datetime" type="Dictionary" /> + <param index="0" name="datetime" type="Dictionary" /> <description> Converts a dictionary of time values to a Unix timestamp. The given dictionary can be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. Any other entries (including [code]dst[/code]) are ignored. @@ -168,7 +168,7 @@ </method> <method name="get_unix_time_from_datetime_string" qualifiers="const"> <return type="int" /> - <argument index="0" name="datetime" type="String" /> + <param index="0" name="datetime" type="String" /> <description> Converts the given ISO 8601 date and/or time string to a Unix timestamp. The string can contain a date only, a time only, or both. [b]Note:[/b] Unix timestamps are often in UTC. This method does not do any timezone conversion, so the timestamp will be in the same timezone as the given datetime string. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index ebe25ed55e..70325c0227 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -19,7 +19,7 @@ </method> <method name="start"> <return type="void" /> - <argument index="0" name="time_sec" type="float" default="-1" /> + <param index="0" name="time_sec" type="float" default="-1" /> <description> Starts the timer. Sets [member wait_time] to [code]time_sec[/code] if [code]time_sec > 0[/code]. This also resets the remaining time to [member wait_time]. [b]Note:[/b] This method will not resume a paused timer. See [member paused]. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 9979a73527..3b76348c09 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -22,34 +22,34 @@ </constructor> <constructor name="Transform2D"> <return type="Transform2D" /> - <argument index="0" name="from" type="Transform2D" /> + <param index="0" name="from" type="Transform2D" /> <description> Constructs a [Transform2D] as a copy of the given [Transform2D]. </description> </constructor> <constructor name="Transform2D"> <return type="Transform2D" /> - <argument index="0" name="rotation" type="float" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="rotation" type="float" /> + <param index="1" name="position" type="Vector2" /> <description> Constructs the transform from a given angle (in radians) and position. </description> </constructor> <constructor name="Transform2D"> <return type="Transform2D" /> - <argument index="0" name="rotation" type="float" /> - <argument index="1" name="scale" type="Vector2" /> - <argument index="2" name="skew" type="float" /> - <argument index="3" name="position" type="Vector2" /> + <param index="0" name="rotation" type="float" /> + <param index="1" name="scale" type="Vector2" /> + <param index="2" name="skew" type="float" /> + <param index="3" name="position" type="Vector2" /> <description> Constructs the transform from a given angle (in radians), scale, skew (in radians) and position. </description> </constructor> <constructor name="Transform2D"> <return type="Transform2D" /> - <argument index="0" name="x_axis" type="Vector2" /> - <argument index="1" name="y_axis" type="Vector2" /> - <argument index="2" name="origin" type="Vector2" /> + <param index="0" name="x_axis" type="Vector2" /> + <param index="1" name="y_axis" type="Vector2" /> + <param index="2" name="origin" type="Vector2" /> <description> Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors). </description> @@ -64,7 +64,7 @@ </method> <method name="basis_xform" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="v" type="Vector2" /> + <param index="0" name="v" type="Vector2" /> <description> Returns a vector transformed (multiplied) by the basis matrix. This method does not account for translation (the origin vector). @@ -72,7 +72,7 @@ </method> <method name="basis_xform_inv" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="v" type="Vector2" /> + <param index="0" name="v" type="Vector2" /> <description> Returns a vector transformed (multiplied) by the inverse basis matrix. This method does not account for translation (the origin vector). @@ -104,8 +104,8 @@ </method> <method name="interpolate_with" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="xform" type="Transform2D" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="xform" type="Transform2D" /> + <param index="1" name="weight" type="float" /> <description> Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0). </description> @@ -118,14 +118,14 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="xform" type="Transform2D" /> + <param index="0" name="xform" type="Transform2D" /> <description> Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. </description> </method> <method name="looking_at" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="target" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="target" type="Vector2" default="Vector2(0, 0)" /> <description> Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the [code]target[/code] position. Operations take place in global space. @@ -139,7 +139,7 @@ </method> <method name="rotated" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="angle" type="float" /> + <param index="0" name="angle" type="float" /> <description> Returns a copy of the transform rotated by the given [code]angle[/code] (in radians). This method is an optimized version of multiplying the given transform [code]X[/code] @@ -149,7 +149,7 @@ </method> <method name="rotated_local" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="angle" type="float" /> + <param index="0" name="angle" type="float" /> <description> Returns a copy of the transform rotated by the given [code]angle[/code] (in radians). This method is an optimized version of multiplying the given transform [code]X[/code] @@ -159,7 +159,7 @@ </method> <method name="scaled" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="scale" type="Vector2" /> + <param index="0" name="scale" type="Vector2" /> <description> Returns a copy of the transform scaled by the given [code]scale[/code] factor. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -169,7 +169,7 @@ </method> <method name="scaled_local" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="scale" type="Vector2" /> + <param index="0" name="scale" type="Vector2" /> <description> Returns a copy of the transform scaled by the given [code]scale[/code] factor. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -179,14 +179,14 @@ </method> <method name="set_rotation"> <return type="void" /> - <argument index="0" name="rotation" type="float" /> + <param index="0" name="rotation" type="float" /> <description> Sets the transform's rotation (in radians). </description> </method> <method name="set_scale"> <return type="void" /> - <argument index="0" name="scale" type="Vector2" /> + <param index="0" name="scale" type="Vector2" /> <description> Sets the transform's scale. [b]Note:[/b] Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed. @@ -194,14 +194,14 @@ </method> <method name="set_skew"> <return type="void" /> - <argument index="0" name="skew" type="float" /> + <param index="0" name="skew" type="float" /> <description> Sets the transform's skew (in radians). </description> </method> <method name="translated" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> <description> Returns a copy of the transform translated by the given [code]offset[/code]. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -211,7 +211,7 @@ </method> <method name="translated_local" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> <description> Returns a copy of the transform translated by the given [code]offset[/code]. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -245,7 +245,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Transform2D" /> + <param index="0" name="right" type="Transform2D" /> <description> Returns [code]true[/code] if the transforms are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -253,49 +253,49 @@ </operator> <operator name="operator *"> <return type="PackedVector2Array" /> - <argument index="0" name="right" type="PackedVector2Array" /> + <param index="0" name="right" type="PackedVector2Array" /> <description> Transforms (multiplies) each element of the [Vector2] array by the given [Transform2D] matrix. </description> </operator> <operator name="operator *"> <return type="Rect2" /> - <argument index="0" name="right" type="Rect2" /> + <param index="0" name="right" type="Rect2" /> <description> Transforms (multiplies) the [Rect2] by the given [Transform2D] matrix. </description> </operator> <operator name="operator *"> <return type="Transform2D" /> - <argument index="0" name="right" type="Transform2D" /> + <param index="0" name="right" type="Transform2D" /> <description> Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). </description> </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Transforms (multiplies) the [Vector2] by the given [Transform2D] matrix. </description> </operator> <operator name="operator *"> <return type="Transform2D" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. </description> </operator> <operator name="operator *"> <return type="Transform2D" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Transform2D" /> + <param index="0" name="right" type="Transform2D" /> <description> Returns [code]true[/code] if the transforms are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -303,7 +303,7 @@ </operator> <operator name="operator []"> <return type="Vector2" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access transform components using their index. [code]t[0][/code] is equivalent to [code]t.x[/code], [code]t[1][/code] is equivalent to [code]t.y[/code], and [code]t[2][/code] is equivalent to [code]t.origin[/code]. </description> diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index cefc74867c..b7fd5213aa 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -24,31 +24,31 @@ </constructor> <constructor name="Transform3D"> <return type="Transform3D" /> - <argument index="0" name="from" type="Transform3D" /> + <param index="0" name="from" type="Transform3D" /> <description> Constructs a [Transform3D] as a copy of the given [Transform3D]. </description> </constructor> <constructor name="Transform3D"> <return type="Transform3D" /> - <argument index="0" name="basis" type="Basis" /> - <argument index="1" name="origin" type="Vector3" /> + <param index="0" name="basis" type="Basis" /> + <param index="1" name="origin" type="Vector3" /> <description> Constructs a Transform3D from a [Basis] and [Vector3]. </description> </constructor> <constructor name="Transform3D"> <return type="Transform3D" /> - <argument index="0" name="from" type="Projection" /> + <param index="0" name="from" type="Projection" /> <description> </description> </constructor> <constructor name="Transform3D"> <return type="Transform3D" /> - <argument index="0" name="x_axis" type="Vector3" /> - <argument index="1" name="y_axis" type="Vector3" /> - <argument index="2" name="z_axis" type="Vector3" /> - <argument index="3" name="origin" type="Vector3" /> + <param index="0" name="x_axis" type="Vector3" /> + <param index="1" name="y_axis" type="Vector3" /> + <param index="2" name="z_axis" type="Vector3" /> + <param index="3" name="origin" type="Vector3" /> <description> Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). </description> @@ -63,8 +63,8 @@ </method> <method name="interpolate_with" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="xform" type="Transform3D" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="xform" type="Transform3D" /> + <param index="1" name="weight" type="float" /> <description> Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0). </description> @@ -77,15 +77,15 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="xform" type="Transform3D" /> + <param index="0" name="xform" type="Transform3D" /> <description> Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. </description> </method> <method name="looking_at" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="target" type="Vector3" /> - <argument index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" /> + <param index="0" name="target" type="Vector3" /> + <param index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" /> <description> Returns a copy of the transform rotated such that the forward axis (-Z) points towards the [code]target[/code] position. The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting transform is orthonormalized. The existing rotation, scale, and skew information from the original transform is discarded. The [code]target[/code] and [code]up[/code] vectors cannot be zero, cannot be parallel to each other, and are defined in global/parent space. @@ -99,8 +99,8 @@ </method> <method name="rotated" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians). The [code]axis[/code] must be a normalized vector. @@ -111,8 +111,8 @@ </method> <method name="rotated_local" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians). The [code]axis[/code] must be a normalized vector. @@ -123,7 +123,7 @@ </method> <method name="scaled" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="scale" type="Vector3" /> + <param index="0" name="scale" type="Vector3" /> <description> Returns a copy of the transform scaled by the given [code]scale[/code] factor. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -133,7 +133,7 @@ </method> <method name="scaled_local" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="scale" type="Vector3" /> + <param index="0" name="scale" type="Vector3" /> <description> Returns a copy of the transform scaled by the given [code]scale[/code] factor. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -143,15 +143,15 @@ </method> <method name="spherical_interpolate_with" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="xform" type="Transform3D" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="xform" type="Transform3D" /> + <param index="1" name="weight" type="float" /> <description> Returns a transform spherically interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0). </description> </method> <method name="translated" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="offset" type="Vector3" /> + <param index="0" name="offset" type="Vector3" /> <description> Returns a copy of the transform translated by the given [code]offset[/code]. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -161,7 +161,7 @@ </method> <method name="translated_local" qualifiers="const"> <return type="Transform3D" /> - <argument index="0" name="offset" type="Vector3" /> + <param index="0" name="offset" type="Vector3" /> <description> Returns a copy of the transform translated by the given [code]offset[/code]. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -195,7 +195,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Transform3D" /> + <param index="0" name="right" type="Transform3D" /> <description> Returns [code]true[/code] if the transforms are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -203,56 +203,56 @@ </operator> <operator name="operator *"> <return type="AABB" /> - <argument index="0" name="right" type="AABB" /> + <param index="0" name="right" type="AABB" /> <description> Transforms (multiplies) the [AABB] by the given [Transform3D] matrix. </description> </operator> <operator name="operator *"> <return type="PackedVector3Array" /> - <argument index="0" name="right" type="PackedVector3Array" /> + <param index="0" name="right" type="PackedVector3Array" /> <description> Transforms (multiplies) each element of the [Vector3] array by the given [Transform3D] matrix. </description> </operator> <operator name="operator *"> <return type="Plane" /> - <argument index="0" name="right" type="Plane" /> + <param index="0" name="right" type="Plane" /> <description> Transforms (multiplies) the [Plane] by the given [Transform3D] transformation matrix. </description> </operator> <operator name="operator *"> <return type="Transform3D" /> - <argument index="0" name="right" type="Transform3D" /> + <param index="0" name="right" type="Transform3D" /> <description> Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Transforms (multiplies) the [Vector3] by the given [Transform3D] matrix. </description> </operator> <operator name="operator *"> <return type="Transform3D" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. </description> </operator> <operator name="operator *"> <return type="Transform3D" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Transform3D" /> + <param index="0" name="right" type="Transform3D" /> <description> Returns [code]true[/code] if the transforms are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index 7aafbc68c6..3da778335d 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -13,27 +13,27 @@ <methods> <method name="_get_message" qualifiers="virtual const"> <return type="StringName" /> - <argument index="0" name="src_message" type="StringName" /> - <argument index="1" name="context" type="StringName" /> + <param index="0" name="src_message" type="StringName" /> + <param index="1" name="context" type="StringName" /> <description> Virtual method to override [method get_message]. </description> </method> <method name="_get_plural_message" qualifiers="virtual const"> <return type="StringName" /> - <argument index="0" name="src_message" type="StringName" /> - <argument index="1" name="src_plural_message" type="StringName" /> - <argument index="2" name="n" type="int" /> - <argument index="3" name="context" type="StringName" /> + <param index="0" name="src_message" type="StringName" /> + <param index="1" name="src_plural_message" type="StringName" /> + <param index="2" name="n" type="int" /> + <param index="3" name="context" type="StringName" /> <description> Virtual method to override [method get_plural_message]. </description> </method> <method name="add_message"> <return type="void" /> - <argument index="0" name="src_message" type="StringName" /> - <argument index="1" name="xlated_message" type="StringName" /> - <argument index="2" name="context" type="StringName" default="""" /> + <param index="0" name="src_message" type="StringName" /> + <param index="1" name="xlated_message" type="StringName" /> + <param index="2" name="context" type="StringName" default="""" /> <description> Adds a message if nonexistent, followed by its translation. An additional context could be used to specify the translation context or differentiate polysemic words. @@ -41,9 +41,9 @@ </method> <method name="add_plural_message"> <return type="void" /> - <argument index="0" name="src_message" type="StringName" /> - <argument index="1" name="xlated_messages" type="PackedStringArray" /> - <argument index="2" name="context" type="StringName" default="""" /> + <param index="0" name="src_message" type="StringName" /> + <param index="1" name="xlated_messages" type="PackedStringArray" /> + <param index="2" name="context" type="StringName" default="""" /> <description> Adds a message involving plural translation if nonexistent, followed by its translation. An additional context could be used to specify the translation context or differentiate polysemic words. @@ -51,16 +51,16 @@ </method> <method name="erase_message"> <return type="void" /> - <argument index="0" name="src_message" type="StringName" /> - <argument index="1" name="context" type="StringName" default="""" /> + <param index="0" name="src_message" type="StringName" /> + <param index="1" name="context" type="StringName" default="""" /> <description> Erases a message. </description> </method> <method name="get_message" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="src_message" type="StringName" /> - <argument index="1" name="context" type="StringName" default="""" /> + <param index="0" name="src_message" type="StringName" /> + <param index="1" name="context" type="StringName" default="""" /> <description> Returns a message's translation. </description> @@ -79,10 +79,10 @@ </method> <method name="get_plural_message" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="src_message" type="StringName" /> - <argument index="1" name="src_plural_message" type="StringName" /> - <argument index="2" name="n" type="int" /> - <argument index="3" name="context" type="StringName" default="""" /> + <param index="0" name="src_message" type="StringName" /> + <param index="1" name="src_plural_message" type="StringName" /> + <param index="2" name="n" type="int" /> + <param index="3" name="context" type="StringName" default="""" /> <description> Returns a message's translation involving plurals. The number [code]n[/code] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index a4cf070ede..53ce5894eb 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -13,7 +13,7 @@ <methods> <method name="add_translation"> <return type="void" /> - <argument index="0" name="translation" type="Translation" /> + <param index="0" name="translation" type="Translation" /> <description> Adds a [Translation] resource. </description> @@ -26,8 +26,8 @@ </method> <method name="compare_locales" qualifiers="const"> <return type="int" /> - <argument index="0" name="locale_a" type="String" /> - <argument index="1" name="locale_b" type="String" /> + <param index="0" name="locale_a" type="String" /> + <param index="1" name="locale_b" type="String" /> <description> Compares two locales and return similarity score between [code]0[/code](no match) and [code]10[/code](full match). </description> @@ -52,14 +52,14 @@ </method> <method name="get_country_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="country" type="String" /> + <param index="0" name="country" type="String" /> <description> Returns readable country name for the [code]country[/code] code. </description> </method> <method name="get_language_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="language" type="String" /> + <param index="0" name="language" type="String" /> <description> Returns readable language name for the [code]language[/code] code. </description> @@ -79,14 +79,14 @@ </method> <method name="get_locale_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="locale" type="String" /> + <param index="0" name="locale" type="String" /> <description> Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]). </description> </method> <method name="get_script_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="script" type="String" /> + <param index="0" name="script" type="String" /> <description> Returns readable script name for the [code]script[/code] code. </description> @@ -100,7 +100,7 @@ </method> <method name="get_translation_object"> <return type="Translation" /> - <argument index="0" name="locale" type="String" /> + <param index="0" name="locale" type="String" /> <description> Returns the [Translation] instance based on the [code]locale[/code] passed in. It will return [code]null[/code] if there is no [Translation] instance that matches the [code]locale[/code]. @@ -108,7 +108,7 @@ </method> <method name="pseudolocalize" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="message" type="StringName" /> + <param index="0" name="message" type="StringName" /> <description> Returns the pseudolocalized string based on the [code]p_message[/code] passed in. </description> @@ -121,14 +121,14 @@ </method> <method name="remove_translation"> <return type="void" /> - <argument index="0" name="translation" type="Translation" /> + <param index="0" name="translation" type="Translation" /> <description> Removes the given translation from the server. </description> </method> <method name="set_locale"> <return type="void" /> - <argument index="0" name="locale" type="String" /> + <param index="0" name="locale" type="String" /> <description> Sets the locale of the project. The [code]locale[/code] string will be standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]). If translations have been loaded beforehand for the new locale, they will be applied. @@ -136,25 +136,25 @@ </method> <method name="standardize_locale" qualifiers="const"> <return type="String" /> - <argument index="0" name="locale" type="String" /> + <param index="0" name="locale" type="String" /> <description> Returns [code]locale[/code] string standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]). </description> </method> <method name="translate" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="message" type="StringName" /> - <argument index="1" name="context" type="StringName" default="""" /> + <param index="0" name="message" type="StringName" /> + <param index="1" name="context" type="StringName" default="""" /> <description> Returns the current locale's translation for the given message (key) and context. </description> </method> <method name="translate_plural" qualifiers="const"> <return type="StringName" /> - <argument index="0" name="message" type="StringName" /> - <argument index="1" name="plural_message" type="StringName" /> - <argument index="2" name="n" type="int" /> - <argument index="3" name="context" type="StringName" default="""" /> + <param index="0" name="message" type="StringName" /> + <param index="1" name="plural_message" type="StringName" /> + <param index="2" name="n" type="int" /> + <param index="3" name="context" type="StringName" default="""" /> <description> Returns the current locale's translation for the given message (key), plural_message and context. The number [code]n[/code] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index f326948e9c..7825f2210f 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -44,8 +44,8 @@ </method> <method name="create_item"> <return type="TreeItem" /> - <argument index="0" name="parent" type="TreeItem" default="null" /> - <argument index="1" name="idx" type="int" default="-1" /> + <param index="0" name="parent" type="TreeItem" default="null" /> + <param index="1" name="idx" type="int" default="-1" /> <description> Creates an item in the tree and adds it as a child of [code]parent[/code], which can be either a valid [TreeItem] or [code]null[/code]. If [code]parent[/code] is [code]null[/code], the root item will be the parent, or the new item will be the root itself if the tree is empty. @@ -68,48 +68,48 @@ </method> <method name="get_button_id_at_position" qualifiers="const"> <return type="int" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Returns the button id at [code]position[/code], or -1 if no button is there. </description> </method> <method name="get_column_at_position" qualifiers="const"> <return type="int" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Returns the column index at [code]position[/code], or -1 if no item is there. </description> </method> <method name="get_column_expand_ratio" qualifiers="const"> <return type="int" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> </description> </method> <method name="get_column_title" qualifiers="const"> <return type="String" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the column's title. </description> </method> <method name="get_column_title_direction" qualifiers="const"> <return type="int" enum="Control.TextDirection" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns column title base writing direction. </description> </method> <method name="get_column_title_language" qualifiers="const"> <return type="String" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns column title language code. </description> </method> <method name="get_column_width" qualifiers="const"> <return type="int" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the column's width in pixels. </description> @@ -122,7 +122,7 @@ </method> <method name="get_drop_section_at_position" qualifiers="const"> <return type="int" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Returns the drop section at [code]position[/code], or -100 if no item is there. Values -1, 0, or 1 will be returned for the "above item", "on item", and "below item" drop sections, respectively. See [enum DropModeFlags] for a description of each drop section. @@ -163,23 +163,23 @@ </method> <method name="get_item_area_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="item" type="TreeItem" /> - <argument index="1" name="column" type="int" default="-1" /> - <argument index="2" name="button_index" type="int" default="-1" /> + <param index="0" name="item" type="TreeItem" /> + <param index="1" name="column" type="int" default="-1" /> + <param index="2" name="button_index" type="int" default="-1" /> <description> Returns the rectangle area for the specified [TreeItem]. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. If a button index is specified, the rectangle of that button will be returned. </description> </method> <method name="get_item_at_position" qualifiers="const"> <return type="TreeItem" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Returns the tree item at the specified position (relative to the tree origin position). </description> </method> <method name="get_next_selected"> <return type="TreeItem" /> - <argument index="0" name="from" type="TreeItem" /> + <param index="0" name="from" type="TreeItem" /> <description> Returns the next selected [TreeItem] after the given one, or [code]null[/code] if the end is reached. If [code]from[/code] is [code]null[/code], this returns the first selected item. @@ -221,74 +221,74 @@ </method> <method name="is_column_clipping_content" qualifiers="const"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> </description> </method> <method name="is_column_expanding" qualifiers="const"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> </description> </method> <method name="scroll_to_item"> <return type="void" /> - <argument index="0" name="item" type="TreeItem" /> - <argument index="1" name="center_on_item" type="bool" default="false" /> + <param index="0" name="item" type="TreeItem" /> + <param index="1" name="center_on_item" type="bool" default="false" /> <description> Causes the [Tree] to jump to the specified [TreeItem]. </description> </method> <method name="set_column_clip_content"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="set_column_custom_minimum_width"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="min_width" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="min_width" type="int" /> <description> Overrides the calculated minimum width of a column. It can be set to `0` to restore the default behavior. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio]. </description> </method> <method name="set_column_expand"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="expand" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="expand" type="bool" /> <description> If [code]true[/code], the column will have the "Expand" flag of [Control]. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio]. </description> </method> <method name="set_column_expand_ratio"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="ratio" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="ratio" type="int" /> <description> </description> </method> <method name="set_column_title"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="title" type="String" /> + <param index="0" name="column" type="int" /> + <param index="1" name="title" type="String" /> <description> Sets the title of a column. </description> </method> <method name="set_column_title_direction"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="direction" type="int" enum="Control.TextDirection" /> + <param index="0" name="column" type="int" /> + <param index="1" name="direction" type="int" enum="Control.TextDirection" /> <description> Sets column title base writing direction. </description> </method> <method name="set_column_title_language"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="column" type="int" /> + <param index="1" name="language" type="String" /> <description> Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. </description> @@ -331,10 +331,10 @@ </members> <signals> <signal name="button_clicked"> - <argument index="0" name="item" type="TreeItem" /> - <argument index="1" name="column" type="int" /> - <argument index="2" name="id" type="int" /> - <argument index="3" name="mouse_button_index" type="int" /> + <param index="0" name="item" type="TreeItem" /> + <param index="1" name="column" type="int" /> + <param index="2" name="id" type="int" /> + <param index="3" name="mouse_button_index" type="int" /> <description> Emitted when a button on the tree was pressed (see [method TreeItem.add_button]). </description> @@ -345,33 +345,33 @@ </description> </signal> <signal name="check_propagated_to_item"> - <argument index="0" name="item" type="TreeItem" /> - <argument index="1" name="column" type="int" /> + <param index="0" name="item" type="TreeItem" /> + <param index="1" name="column" type="int" /> <description> Emitted when [method TreeItem.propagate_check] is called. Connect to this signal to process the items that are affected when [method TreeItem.propagate_check] is invoked. The order that the items affected will be processed is as follows: the item that invoked the method, children of that item, and finally parents of that item. </description> </signal> <signal name="column_title_pressed"> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Emitted when a column's title is pressed. </description> </signal> <signal name="custom_item_clicked"> - <argument index="0" name="mouse_button_index" type="int" /> + <param index="0" name="mouse_button_index" type="int" /> <description> Emitted when an item with [constant TreeItem.CELL_MODE_CUSTOM] is clicked with a mouse button. </description> </signal> <signal name="custom_popup_edited"> - <argument index="0" name="arrow_clicked" type="bool" /> + <param index="0" name="arrow_clicked" type="bool" /> <description> Emitted when a cell with the [constant TreeItem.CELL_MODE_CUSTOM] is clicked to be edited. </description> </signal> <signal name="empty_clicked"> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="mouse_button_index" type="int" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="mouse_button_index" type="int" /> <description> Emitted when a mouse button is clicked in the empty space of the tree. </description> @@ -382,7 +382,7 @@ </description> </signal> <signal name="item_collapsed"> - <argument index="0" name="item" type="TreeItem" /> + <param index="0" name="item" type="TreeItem" /> <description> Emitted when an item is collapsed by a click on the folding arrow. </description> @@ -403,8 +403,8 @@ </description> </signal> <signal name="item_mouse_selected"> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="mouse_button_index" type="int" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="mouse_button_index" type="int" /> <description> Emitted when an item is selected with a mouse button. </description> @@ -415,9 +415,9 @@ </description> </signal> <signal name="multi_selected"> - <argument index="0" name="item" type="TreeItem" /> - <argument index="1" name="column" type="int" /> - <argument index="2" name="selected" type="bool" /> + <param index="0" name="item" type="TreeItem" /> + <param index="1" name="column" type="int" /> + <param index="2" name="selected" type="bool" /> <description> Emitted instead of [code]item_selected[/code] if [code]select_mode[/code] is [constant SELECT_MULTI]. </description> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index fbba1147a2..519c3afadb 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -12,39 +12,39 @@ <methods> <method name="add_button"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="button" type="Texture2D" /> - <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="disabled" type="bool" default="false" /> - <argument index="4" name="tooltip" type="String" default="""" /> + <param index="0" name="column" type="int" /> + <param index="1" name="button" type="Texture2D" /> + <param index="2" name="id" type="int" default="-1" /> + <param index="3" name="disabled" type="bool" default="false" /> + <param index="4" name="tooltip" type="String" default="""" /> <description> Adds a button with [Texture2D] [code]button[/code] at column [code]column[/code]. The [code]id[/code] is used to identify the button. If not specified, the next available index is used, which may be retrieved by calling [method get_button_count] immediately before this method. Optionally, the button can be [code]disabled[/code] and have a [code]tooltip[/code]. </description> </method> <method name="call_recursive" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="method" type="StringName" /> + <param index="0" name="method" type="StringName" /> <description> Calls the [code]method[/code] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. </description> </method> <method name="clear_custom_bg_color"> <return type="void" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Resets the background color for the given column to default. </description> </method> <method name="clear_custom_color"> <return type="void" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Resets the color for the given column to default. </description> </method> <method name="create_child"> <return type="TreeItem" /> - <argument index="0" name="idx" type="int" default="-1" /> + <param index="0" name="idx" type="int" default="-1" /> <description> Creates an item and adds it as a child. The new item will be inserted as position [code]idx[/code] (the default value [code]-1[/code] means the last position), or it will be the last child if [code]idx[/code] is higher than the child count. @@ -52,68 +52,68 @@ </method> <method name="deselect"> <return type="void" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Deselects the given column. </description> </method> <method name="erase_button"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="button_idx" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="button_idx" type="int" /> <description> Removes the button at index [code]button_idx[/code] in column [code]column[/code]. </description> </method> <method name="get_button" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="button_idx" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="button_idx" type="int" /> <description> Returns the [Texture2D] of the button at index [code]button_idx[/code] in column [code]column[/code]. </description> </method> <method name="get_button_by_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="id" type="int" /> <description> Returns the button index if there is a button with id [code]id[/code] in column [code]column[/code], otherwise returns -1. </description> </method> <method name="get_button_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the number of buttons in column [code]column[/code]. </description> </method> <method name="get_button_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="button_idx" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="button_idx" type="int" /> <description> Returns the id for the button at index [code]button_idx[/code] in column [code]column[/code]. </description> </method> <method name="get_button_tooltip" qualifiers="const"> <return type="String" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="button_idx" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="button_idx" type="int" /> <description> Returns the tooltip string for the button at index [code]button_idx[/code] in column [code]column[/code]. </description> </method> <method name="get_cell_mode" qualifiers="const"> <return type="int" enum="TreeItem.TreeCellMode" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the column's cell mode. </description> </method> <method name="get_child"> <return type="TreeItem" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns a child item by its index (see [method get_child_count]). This method is often used for iterating all children of an item. Negative indices access the children from the last one. @@ -133,35 +133,35 @@ </method> <method name="get_custom_bg_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the custom background color of column [code]column[/code]. </description> </method> <method name="get_custom_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the custom color of column [code]column[/code]. </description> </method> <method name="get_custom_font" qualifiers="const"> <return type="Font" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns custom font used to draw text in the column [code]column[/code]. </description> </method> <method name="get_custom_font_size" qualifiers="const"> <return type="int" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns custom font size used to draw text in the column [code]column[/code]. </description> </method> <method name="get_expand_right" qualifiers="const"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns [code]true[/code] if [code]expand_right[/code] is set. </description> @@ -174,28 +174,28 @@ </method> <method name="get_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the given column's icon [Texture2D]. Error if no icon is set. </description> </method> <method name="get_icon_max_width" qualifiers="const"> <return type="int" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the column's icon's maximum width. </description> </method> <method name="get_icon_modulate" qualifiers="const"> <return type="Color" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the [Color] modulating the column's icon. </description> </method> <method name="get_icon_region" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the icon [Texture2D] region as [Rect2]. </description> @@ -208,14 +208,14 @@ </method> <method name="get_language" qualifiers="const"> <return type="String" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns item's text language code. </description> </method> <method name="get_metadata" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the metadata value that was set for the given column using [method set_metadata]. </description> @@ -228,7 +228,7 @@ </method> <method name="get_next_visible"> <return type="TreeItem" /> - <argument index="0" name="wrap" type="bool" default="false" /> + <param index="0" name="wrap" type="bool" default="false" /> <description> Returns the next visible sibling TreeItem in the tree or a null object if there is none. If [code]wrap[/code] is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns [code]null[/code]. @@ -248,7 +248,7 @@ </method> <method name="get_prev_visible"> <return type="TreeItem" /> - <argument index="0" name="wrap" type="bool" default="false" /> + <param index="0" name="wrap" type="bool" default="false" /> <description> Returns the previous visible sibling TreeItem in the tree or a null object if there is none. If [code]wrap[/code] is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns [code]null[/code]. @@ -256,61 +256,61 @@ </method> <method name="get_range" qualifiers="const"> <return type="float" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the value of a [constant CELL_MODE_RANGE] column. </description> </method> <method name="get_range_config"> <return type="Dictionary" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr". </description> </method> <method name="get_structured_text_bidi_override" qualifiers="const"> <return type="int" enum="TextServer.StructuredTextParser" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> </description> </method> <method name="get_structured_text_bidi_override_options" qualifiers="const"> <return type="Array" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> </description> </method> <method name="get_suffix" qualifiers="const"> <return type="String" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Gets the suffix string shown after the column value. </description> </method> <method name="get_text" qualifiers="const"> <return type="String" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the given column's text. </description> </method> <method name="get_text_alignment" qualifiers="const"> <return type="int" enum="HorizontalAlignment" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the given column's text alignment. </description> </method> <method name="get_text_direction" qualifiers="const"> <return type="int" enum="Control.TextDirection" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns item's text base writing direction. </description> </method> <method name="get_tooltip" qualifiers="const"> <return type="String" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns the given column's tooltip. </description> @@ -323,56 +323,56 @@ </method> <method name="is_button_disabled" qualifiers="const"> <return type="bool" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="button_idx" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="button_idx" type="int" /> <description> Returns [code]true[/code] if the button at index [code]button_idx[/code] for the given column is disabled. </description> </method> <method name="is_checked" qualifiers="const"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns [code]true[/code] if the given column is checked. </description> </method> <method name="is_custom_set_as_button" qualifiers="const"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> </description> </method> <method name="is_editable"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns [code]true[/code] if column [code]column[/code] is editable. </description> </method> <method name="is_indeterminate" qualifiers="const"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns [code]true[/code] if the given column is indeterminate. </description> </method> <method name="is_selectable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns [code]true[/code] if column [code]column[/code] is selectable. </description> </method> <method name="is_selected"> <return type="bool" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Returns [code]true[/code] if column [code]column[/code] is selected. </description> </method> <method name="move_after"> <return type="void" /> - <argument index="0" name="item" type="TreeItem" /> + <param index="0" name="item" type="TreeItem" /> <description> Moves this TreeItem right after the given [code]item[/code]. [b]Note:[/b] You can't move to the root or move the root. @@ -380,7 +380,7 @@ </method> <method name="move_before"> <return type="void" /> - <argument index="0" name="item" type="TreeItem" /> + <param index="0" name="item" type="TreeItem" /> <description> Moves this TreeItem right before the given [code]item[/code]. [b]Note:[/b] You can't move to the root or move the root. @@ -388,89 +388,89 @@ </method> <method name="propagate_check"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="emit_signal" type="bool" default="true" /> + <param index="0" name="column" type="int" /> + <param index="1" name="emit_signal" type="bool" default="true" /> <description> Propagates this item's checked status to its children and parents for the given [code]column[/code]. It is possible to process the items affected by this method call by connecting to [signal Tree.check_propagated_to_item]. The order that the items affected will be processed is as follows: the item invoking this method, children of that item, and finally parents of that item. If [code]emit_signal[/code] is [code]false[/code], then [signal Tree.check_propagated_to_item] will not be emitted. </description> </method> <method name="remove_child"> <return type="void" /> - <argument index="0" name="child" type="TreeItem" /> + <param index="0" name="child" type="TreeItem" /> <description> Removes the given child [TreeItem] and all its children from the [Tree]. Note that it doesn't free the item from memory, so it can be reused later. To completely remove a [TreeItem] use [method Object.free]. </description> </method> <method name="select"> <return type="void" /> - <argument index="0" name="column" type="int" /> + <param index="0" name="column" type="int" /> <description> Selects the column [code]column[/code]. </description> </method> <method name="set_button"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="button_idx" type="int" /> - <argument index="2" name="button" type="Texture2D" /> + <param index="0" name="column" type="int" /> + <param index="1" name="button_idx" type="int" /> + <param index="2" name="button" type="Texture2D" /> <description> Sets the given column's button [Texture2D] at index [code]button_idx[/code] to [code]button[/code]. </description> </method> <method name="set_button_disabled"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="button_idx" type="int" /> - <argument index="2" name="disabled" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="button_idx" type="int" /> + <param index="2" name="disabled" type="bool" /> <description> If [code]true[/code], disables the button at index [code]button_idx[/code] in column [code]column[/code]. </description> </method> <method name="set_cell_mode"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="mode" type="int" enum="TreeItem.TreeCellMode" /> + <param index="0" name="column" type="int" /> + <param index="1" name="mode" type="int" enum="TreeItem.TreeCellMode" /> <description> Sets the given column's cell mode to [code]mode[/code]. See [enum TreeCellMode] constants. </description> </method> <method name="set_checked"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="checked" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="checked" type="bool" /> <description> If [code]true[/code], the column [code]column[/code] is checked. Clears column's indeterminate status. </description> </method> <method name="set_custom_as_button"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="enable" type="bool" /> <description> </description> </method> <method name="set_custom_bg_color"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="color" type="Color" /> - <argument index="2" name="just_outline" type="bool" default="false" /> + <param index="0" name="column" type="int" /> + <param index="1" name="color" type="Color" /> + <param index="2" name="just_outline" type="bool" default="false" /> <description> Sets the given column's custom background color and whether to just use it as an outline. </description> </method> <method name="set_custom_color"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="column" type="int" /> + <param index="1" name="color" type="Color" /> <description> Sets the given column's custom color. </description> </method> <method name="set_custom_draw"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="object" type="Object" /> - <argument index="2" name="callback" type="StringName" /> + <param index="0" name="column" type="int" /> + <param index="1" name="object" type="Object" /> + <param index="2" name="callback" type="StringName" /> <description> Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code]. The [code]callback[/code] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2]. @@ -478,72 +478,72 @@ </method> <method name="set_custom_font"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="font" type="Font" /> + <param index="0" name="column" type="int" /> + <param index="1" name="font" type="Font" /> <description> Sets custom font used to draw text in the column [code]column[/code]. </description> </method> <method name="set_custom_font_size"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="font_size" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="font_size" type="int" /> <description> Sets custom font size used to draw text in the column [code]column[/code]. </description> </method> <method name="set_editable"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="enabled" type="bool" /> <description> If [code]true[/code], column [code]column[/code] is editable. </description> </method> <method name="set_expand_right"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="enable" type="bool" /> <description> If [code]true[/code], column [code]column[/code] is expanded to the right. </description> </method> <method name="set_icon"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="column" type="int" /> + <param index="1" name="texture" type="Texture2D" /> <description> Sets the given column's icon [Texture2D]. </description> </method> <method name="set_icon_max_width"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="width" type="int" /> + <param index="0" name="column" type="int" /> + <param index="1" name="width" type="int" /> <description> Sets the given column's icon's maximum width. </description> </method> <method name="set_icon_modulate"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="modulate" type="Color" /> + <param index="0" name="column" type="int" /> + <param index="1" name="modulate" type="Color" /> <description> Modulates the given column's icon with [code]modulate[/code]. </description> </method> <method name="set_icon_region"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="region" type="Rect2" /> + <param index="0" name="column" type="int" /> + <param index="1" name="region" type="Rect2" /> <description> Sets the given column's icon's texture region. </description> </method> <method name="set_indeterminate"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="indeterminate" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="indeterminate" type="bool" /> <description> If [code]true[/code], the column [code]column[/code] is marked indeterminate. [b]Note:[/b] If set [code]true[/code] from [code]false[/code], then column is cleared of checked status. @@ -551,35 +551,35 @@ </method> <method name="set_language"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="language" type="String" /> + <param index="0" name="column" type="int" /> + <param index="1" name="language" type="String" /> <description> Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. </description> </method> <method name="set_metadata"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="meta" type="Variant" /> + <param index="0" name="column" type="int" /> + <param index="1" name="meta" type="Variant" /> <description> Sets the metadata value for the given column, which can be retrieved later using [method get_metadata]. This can be used, for example, to store a reference to the original data. </description> </method> <method name="set_range"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="column" type="int" /> + <param index="1" name="value" type="float" /> <description> Sets the value of a [constant CELL_MODE_RANGE] column. </description> </method> <method name="set_range_config"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="min" type="float" /> - <argument index="2" name="max" type="float" /> - <argument index="3" name="step" type="float" /> - <argument index="4" name="expr" type="bool" default="false" /> + <param index="0" name="column" type="int" /> + <param index="1" name="min" type="float" /> + <param index="2" name="max" type="float" /> + <param index="3" name="step" type="float" /> + <param index="4" name="expr" type="bool" default="false" /> <description> Sets the range of accepted values for a column. The column must be in the [constant CELL_MODE_RANGE] mode. If [code]expr[/code] is [code]true[/code], the edit mode slider will use an exponential scale as with [member Range.exp_edit]. @@ -587,62 +587,62 @@ </method> <method name="set_selectable"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="selectable" type="bool" /> + <param index="0" name="column" type="int" /> + <param index="1" name="selectable" type="bool" /> <description> If [code]true[/code], the given column is selectable. </description> </method> <method name="set_structured_text_bidi_override"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="parser" type="int" enum="TextServer.StructuredTextParser" /> + <param index="0" name="column" type="int" /> + <param index="1" name="parser" type="int" enum="TextServer.StructuredTextParser" /> <description> </description> </method> <method name="set_structured_text_bidi_override_options"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="args" type="Array" /> + <param index="0" name="column" type="int" /> + <param index="1" name="args" type="Array" /> <description> </description> </method> <method name="set_suffix"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="text" type="String" /> + <param index="0" name="column" type="int" /> + <param index="1" name="text" type="String" /> <description> Sets a string to be shown after a column's value (for example, a unit abbreviation). </description> </method> <method name="set_text"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="text" type="String" /> + <param index="0" name="column" type="int" /> + <param index="1" name="text" type="String" /> <description> Sets the given column's text value. </description> </method> <method name="set_text_alignment"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="text_alignment" type="int" enum="HorizontalAlignment" /> + <param index="0" name="column" type="int" /> + <param index="1" name="text_alignment" type="int" enum="HorizontalAlignment" /> <description> Sets the given column's text alignment. See [enum HorizontalAlignment] for possible values. </description> </method> <method name="set_text_direction"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="direction" type="int" enum="Control.TextDirection" /> + <param index="0" name="column" type="int" /> + <param index="1" name="direction" type="int" enum="Control.TextDirection" /> <description> Sets item's text base writing direction. </description> </method> <method name="set_tooltip"> <return type="void" /> - <argument index="0" name="column" type="int" /> - <argument index="1" name="tooltip" type="String" /> + <param index="0" name="column" type="int" /> + <param index="1" name="tooltip" type="String" /> <description> Sets the given column's tooltip text. </description> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index b18232f5c3..a808a996b7 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -45,7 +45,7 @@ <methods> <method name="bind_node"> <return type="Tween" /> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Binds this [Tween] with the given [code]node[/code]. [Tween]s are processed directly by the [SceneTree], so they run independently of the animated nodes. When you bind a [Node] with the [Tween], the [Tween] will halt the animation when the object is not inside tree and the [Tween] will be automatically killed when the bound object is freed. Also [constant TWEEN_PAUSE_BOUND] will make the pausing behavior dependent on the bound node. For a shorter way to create and bind a [Tween], you can use [method Node.create_tween]. @@ -65,7 +65,7 @@ </method> <method name="custom_step"> <return type="bool" /> - <argument index="0" name="delta" type="float" /> + <param index="0" name="delta" type="float" /> <description> Processes the [Tween] by the given [code]delta[/code] value, in seconds. This is mostly useful for manual control when the [Tween] is paused. It can also be used to end the [Tween] animation immediately, by setting [code]delta[/code] longer than the whole duration of the [Tween] animation. Returns [code]true[/code] if the [Tween] still has [Tweener]s that haven't finished. @@ -81,12 +81,12 @@ </method> <method name="interpolate_value" qualifiers="static"> <return type="Variant" /> - <argument index="0" name="initial_value" type="Variant" /> - <argument index="1" name="delta_value" type="Variant" /> - <argument index="2" name="elapsed_time" type="float" /> - <argument index="3" name="duration" type="float" /> - <argument index="4" name="trans_type" type="int" enum="Tween.TransitionType" /> - <argument index="5" name="ease_type" type="int" enum="Tween.EaseType" /> + <param index="0" name="initial_value" type="Variant" /> + <param index="1" name="delta_value" type="Variant" /> + <param index="2" name="elapsed_time" type="float" /> + <param index="3" name="duration" type="float" /> + <param index="4" name="trans_type" type="int" enum="Tween.TransitionType" /> + <param index="5" name="ease_type" type="int" enum="Tween.EaseType" /> <description> This method can be used for manual interpolation of a value, when you don't want [Tween] to do animating for you. It's similar to [method @GlobalScope.lerp], but with support for custom transition and easing. [code]initial_value[/code] is the starting value of the interpolation. @@ -142,14 +142,14 @@ </method> <method name="set_ease"> <return type="Tween" /> - <argument index="0" name="ease" type="int" enum="Tween.EaseType" /> + <param index="0" name="ease" type="int" enum="Tween.EaseType" /> <description> Sets the default ease type for [PropertyTweener]s and [MethodTweener]s animated by this [Tween]. </description> </method> <method name="set_loops"> <return type="Tween" /> - <argument index="0" name="loops" type="int" default="0" /> + <param index="0" name="loops" type="int" default="0" /> <description> Sets the number of times the tweening sequence will be repeated, i.e. [code]set_loops(2)[/code] will run the animation twice. Calling this method without arguments will make the [Tween] run infinitely, until either it is killed with [method kill], the [Tween]'s bound node is freed, or all the animated objects have been freed (which makes further animation impossible). @@ -158,14 +158,14 @@ </method> <method name="set_parallel"> <return type="Tween" /> - <argument index="0" name="parallel" type="bool" default="true" /> + <param index="0" name="parallel" type="bool" default="true" /> <description> If [code]parallel[/code] is [code]true[/code], the [Tweener]s appended after this method will by default run simultaneously, as opposed to sequentially. </description> </method> <method name="set_pause_mode"> <return type="Tween" /> - <argument index="0" name="mode" type="int" enum="Tween.TweenPauseMode" /> + <param index="0" name="mode" type="int" enum="Tween.TweenPauseMode" /> <description> Determines the behavior of the [Tween] when the [SceneTree] is paused. Check [enum TweenPauseMode] for options. Default value is [constant TWEEN_PAUSE_BOUND]. @@ -173,7 +173,7 @@ </method> <method name="set_process_mode"> <return type="Tween" /> - <argument index="0" name="mode" type="int" enum="Tween.TweenProcessMode" /> + <param index="0" name="mode" type="int" enum="Tween.TweenProcessMode" /> <description> Determines whether the [Tween] should run during idle frame (see [method Node._process]) or physics frame (see [method Node._physics_process]. Default value is [constant TWEEN_PROCESS_IDLE]. @@ -181,14 +181,14 @@ </method> <method name="set_speed_scale"> <return type="Tween" /> - <argument index="0" name="speed" type="float" /> + <param index="0" name="speed" type="float" /> <description> Scales the speed of tweening. This affects all [Tweener]s and their delays. </description> </method> <method name="set_trans"> <return type="Tween" /> - <argument index="0" name="trans" type="int" enum="Tween.TransitionType" /> + <param index="0" name="trans" type="int" enum="Tween.TransitionType" /> <description> Sets the default transition type for [PropertyTweener]s and [MethodTweener]s animated by this [Tween]. </description> @@ -201,7 +201,7 @@ </method> <method name="tween_callback"> <return type="CallbackTweener" /> - <argument index="0" name="callback" type="Callable" /> + <param index="0" name="callback" type="Callable" /> <description> Creates and appends a [CallbackTweener]. This method can be used to call an arbitrary method in any object. Use [method Callable.bind] to bind additional arguments for the call. Example: object that keeps shooting every 1 second. @@ -219,7 +219,7 @@ </method> <method name="tween_interval"> <return type="IntervalTweener" /> - <argument index="0" name="time" type="float" /> + <param index="0" name="time" type="float" /> <description> Creates and appends an [IntervalTweener]. This method can be used to create delays in the tween animation, as an alternative to using the delay in other [Tweener]s, or when there's no animation (in which case the [Tween] acts as a timer). [code]time[/code] is the length of the interval, in seconds. Example: creating an interval in code execution. @@ -242,10 +242,10 @@ </method> <method name="tween_method"> <return type="MethodTweener" /> - <argument index="0" name="method" type="Callable" /> - <argument index="1" name="from" type="Variant" /> - <argument index="2" name="to" type="Variant" /> - <argument index="3" name="duration" type="float" /> + <param index="0" name="method" type="Callable" /> + <param index="1" name="from" type="Variant" /> + <param index="2" name="to" type="Variant" /> + <param index="3" name="duration" type="float" /> <description> Creates and appends a [MethodTweener]. This method is similar to a combination of [method tween_callback] and [method tween_property]. It calls a method over time with a tweened value provided as an argument. The value is tweened between [code]from[/code] and [code]to[/code] over the time specified by [code]duration[/code], in seconds. Use [method Callable.bind] to bind additional arguments for the call. You can use [method MethodTweener.set_ease] and [method MethodTweener.set_trans] to tweak the easing and transition of the value or [method MethodTweener.set_delay] to delay the tweening. Example: making a 3D object look from one point to another point. @@ -266,10 +266,10 @@ </method> <method name="tween_property"> <return type="PropertyTweener" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="property" type="NodePath" /> - <argument index="2" name="final_val" type="Variant" /> - <argument index="3" name="duration" type="float" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="property" type="NodePath" /> + <param index="2" name="final_val" type="Variant" /> + <param index="3" name="duration" type="float" /> <description> Creates and appends a [PropertyTweener]. This method tweens a [code]property[/code] of an [code]object[/code] between an initial value and [code]final_val[/code] in a span of time equal to [code]duration[/code], in seconds. The initial value by default is the property's value at the time the tweening of the [PropertyTweener] starts. For example: [codeblock] @@ -296,13 +296,13 @@ </description> </signal> <signal name="loop_finished"> - <argument index="0" name="loop_count" type="int" /> + <param index="0" name="loop_count" type="int" /> <description> Emitted when a full loop is complete (see [method set_loops]), providing the loop index. This signal is not emitted after the final loop, use [signal finished] instead for this case. </description> </signal> <signal name="step_finished"> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Emitted when one step of the [Tween] is complete, providing the step index. One step is either a single [Tweener] or a group of [Tweener]s running in parallel. </description> diff --git a/doc/classes/UDPServer.xml b/doc/classes/UDPServer.xml index 6fb4d50c0c..49dee4d132 100644 --- a/doc/classes/UDPServer.xml +++ b/doc/classes/UDPServer.xml @@ -143,8 +143,8 @@ </method> <method name="listen"> <return type="int" enum="Error" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="bind_address" type="String" default=""*"" /> + <param index="0" name="port" type="int" /> + <param index="1" name="bind_address" type="String" default=""*"" /> <description> Starts the server by opening a UDP socket listening on the given port. You can optionally specify a [code]bind_address[/code] to only listen for packets sent to that address. See also [method PacketPeerUDP.bind]. </description> diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 80a548ceaf..4c955a7322 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -64,55 +64,55 @@ <methods> <method name="add_do_method" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="method" type="StringName" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="method" type="StringName" /> <description> Register a method that will be called when the action is committed. </description> </method> <method name="add_do_property"> <return type="void" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="property" type="StringName" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="property" type="StringName" /> + <param index="2" name="value" type="Variant" /> <description> Register a property value change for "do". </description> </method> <method name="add_do_reference"> <return type="void" /> - <argument index="0" name="object" type="Object" /> + <param index="0" name="object" type="Object" /> <description> Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources. </description> </method> <method name="add_undo_method" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="method" type="StringName" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="method" type="StringName" /> <description> Register a method that will be called when the action is undone. </description> </method> <method name="add_undo_property"> <return type="void" /> - <argument index="0" name="object" type="Object" /> - <argument index="1" name="property" type="StringName" /> - <argument index="2" name="value" type="Variant" /> + <param index="0" name="object" type="Object" /> + <param index="1" name="property" type="StringName" /> + <param index="2" name="value" type="Variant" /> <description> Register a property value change for "undo". </description> </method> <method name="add_undo_reference"> <return type="void" /> - <argument index="0" name="object" type="Object" /> + <param index="0" name="object" type="Object" /> <description> Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!). </description> </method> <method name="clear_history"> <return type="void" /> - <argument index="0" name="increase_version" type="bool" default="true" /> + <param index="0" name="increase_version" type="bool" default="true" /> <description> Clear the undo/redo history and associated references. Passing [code]false[/code] to [code]increase_version[/code] will prevent the version number to be increased from this. @@ -120,15 +120,15 @@ </method> <method name="commit_action"> <return type="void" /> - <argument index="0" name="execute" type="bool" default="true" /> + <param index="0" name="execute" type="bool" default="true" /> <description> Commit the action. If [code]execute[/code] is true (default), all "do" methods/properties are called/set when this function is called. </description> </method> <method name="create_action"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="merge_mode" type="int" enum="UndoRedo.MergeMode" default="0" /> + <param index="0" name="name" type="String" /> + <param index="1" name="merge_mode" type="int" enum="UndoRedo.MergeMode" default="0" /> <description> Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action]. The way actions are merged is dictated by the [code]merge_mode[/code] argument. See [enum MergeMode] for details. @@ -142,7 +142,7 @@ </method> <method name="get_action_name"> <return type="String" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Gets the action name from its index. </description> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 454db51919..56c107f5cd 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -25,22 +25,22 @@ </constructor> <constructor name="Vector2"> <return type="Vector2" /> - <argument index="0" name="from" type="Vector2" /> + <param index="0" name="from" type="Vector2" /> <description> Constructs a [Vector2] as a copy of the given [Vector2]. </description> </constructor> <constructor name="Vector2"> <return type="Vector2" /> - <argument index="0" name="from" type="Vector2i" /> + <param index="0" name="from" type="Vector2i" /> <description> Constructs a new [Vector2] from [Vector2i]. </description> </constructor> <constructor name="Vector2"> <return type="Vector2" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> <description> Constructs a new [Vector2] from the given [code]x[/code] and [code]y[/code]. </description> @@ -64,7 +64,7 @@ </method> <method name="angle_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector2" /> + <param index="0" name="to" type="Vector2" /> <description> Returns the angle to the given vector, in radians. [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/vector2_angle_to.png]Illustration of the returned angle.[/url] @@ -72,7 +72,7 @@ </method> <method name="angle_to_point" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector2" /> + <param index="0" name="to" type="Vector2" /> <description> Returns the angle between the line connecting the two points and the X axis, in radians. [code]a.angle_to_point(b)[/code] is equivalent of doing [code](b - a).angle()[/code]. @@ -87,17 +87,17 @@ </method> <method name="bezier_interpolate" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="control_1" type="Vector2" /> - <argument index="1" name="control_2" type="Vector2" /> - <argument index="2" name="end" type="Vector2" /> - <argument index="3" name="t" type="float" /> + <param index="0" name="control_1" type="Vector2" /> + <param index="1" name="control_2" type="Vector2" /> + <param index="2" name="end" type="Vector2" /> + <param index="3" name="t" type="float" /> <description> Returns the point at the given [code]t[/code] on the [url=https://en.wikipedia.org/wiki/B%C3%A9zier_curve]Bezier curve[/url] defined by this vector and the given [code]control_1[/code], [code]control_2[/code], and [code]end[/code] points. </description> </method> <method name="bounce" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="n" type="Vector2" /> + <param index="0" name="n" type="Vector2" /> <description> Returns the vector "bounced off" from a plane defined by the given normal. </description> @@ -110,15 +110,15 @@ </method> <method name="clamp" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="min" type="Vector2" /> - <argument index="1" name="max" type="Vector2" /> + <param index="0" name="min" type="Vector2" /> + <param index="1" name="max" type="Vector2" /> <description> Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> </method> <method name="cross" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Vector2" /> + <param index="0" name="with" type="Vector2" /> <description> Returns the 2D analog of the cross product for this vector and [code]with[/code]. This is the signed area of the parallelogram formed by the two vectors. If the second vector is clockwise from the first vector, then the cross product is the positive area. If counter-clockwise, the cross product is the negative area. @@ -127,24 +127,24 @@ </method> <method name="cubic_interpolate" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="b" type="Vector2" /> - <argument index="1" name="pre_a" type="Vector2" /> - <argument index="2" name="post_b" type="Vector2" /> - <argument index="3" name="weight" type="float" /> + <param index="0" name="b" type="Vector2" /> + <param index="1" name="pre_a" type="Vector2" /> + <param index="2" name="post_b" type="Vector2" /> + <param index="3" name="weight" type="float" /> <description> Cubically interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. </description> </method> <method name="direction_to" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="to" type="Vector2" /> + <param index="0" name="to" type="Vector2" /> <description> Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code]. </description> </method> <method name="distance_squared_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector2" /> + <param index="0" name="to" type="Vector2" /> <description> Returns the squared distance between this vector and [code]to[/code]. This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula. @@ -152,14 +152,14 @@ </method> <method name="distance_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector2" /> + <param index="0" name="to" type="Vector2" /> <description> Returns the distance between this vector and [code]to[/code]. </description> </method> <method name="dot" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Vector2" /> + <param index="0" name="with" type="Vector2" /> <description> Returns the dot product of this vector and [code]with[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. @@ -175,7 +175,7 @@ </method> <method name="from_angle" qualifiers="static"> <return type="Vector2" /> - <argument index="0" name="angle" type="float" /> + <param index="0" name="angle" type="float" /> <description> Creates a unit [Vector2] rotated to the given [code]angle[/code] in radians. This is equivalent to doing [code]Vector2(cos(angle), sin(angle))[/code] or [code]Vector2.RIGHT.rotated(angle)[/code]. [codeblock] @@ -187,7 +187,7 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="to" type="Vector2" /> + <param index="0" name="to" type="Vector2" /> <description> Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> @@ -213,15 +213,15 @@ </method> <method name="lerp" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="to" type="Vector2" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Vector2" /> + <param index="1" name="weight" type="float" /> <description> Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. </description> </method> <method name="limit_length" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="length" type="float" default="1.0" /> + <param index="0" name="length" type="float" default="1.0" /> <description> Returns the vector with a maximum length by limiting its length to [code]length[/code]. </description> @@ -240,8 +240,8 @@ </method> <method name="move_toward" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="to" type="Vector2" /> - <argument index="1" name="delta" type="float" /> + <param index="0" name="to" type="Vector2" /> + <param index="1" name="delta" type="float" /> <description> Returns a new vector moved toward [code]to[/code] by the fixed [code]delta[/code] amount. Will not go past the final value. </description> @@ -260,35 +260,35 @@ </method> <method name="posmod" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="mod" type="float" /> + <param index="0" name="mod" type="float" /> <description> Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code]. </description> </method> <method name="posmodv" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="modv" type="Vector2" /> + <param index="0" name="modv" type="Vector2" /> <description> Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components. </description> </method> <method name="project" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="b" type="Vector2" /> + <param index="0" name="b" type="Vector2" /> <description> Returns this vector projected onto the vector [code]b[/code]. </description> </method> <method name="reflect" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="n" type="Vector2" /> + <param index="0" name="n" type="Vector2" /> <description> Returns the vector reflected (i.e. mirrored, or symmetric) over a line defined by the given direction vector [code]n[/code]. </description> </method> <method name="rotated" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="angle" type="float" /> + <param index="0" name="angle" type="float" /> <description> Returns the vector rotated by [code]angle[/code] (in radians). See also [method @GlobalScope.deg2rad]. </description> @@ -307,8 +307,8 @@ </method> <method name="slerp" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="to" type="Vector2" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Vector2" /> + <param index="1" name="weight" type="float" /> <description> Returns the result of spherical linear interpolation between this vector and [code]to[/code], by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. This method also handles interpolating the lengths if the input vectors have different lengths. For the special case of one or both input vectors having zero length, this method behaves like [method lerp]. @@ -316,14 +316,14 @@ </method> <method name="slide" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="n" type="Vector2" /> + <param index="0" name="n" type="Vector2" /> <description> Returns this vector slid along a plane defined by the given normal. </description> </method> <method name="snapped" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="step" type="Vector2" /> + <param index="0" name="step" type="Vector2" /> <description> Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. </description> @@ -369,7 +369,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Returns [code]true[/code] if the vectors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -377,14 +377,14 @@ </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="Transform2D" /> + <param index="0" name="right" type="Transform2D" /> <description> Inversely transforms (multiplies) the [Vector2] by the given [Transform2D] transformation matrix. </description> </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Multiplies each component of the [Vector2] by the components of the given [Vector2]. [codeblock] @@ -394,21 +394,21 @@ </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies each component of the [Vector2] by the given [float]. </description> </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies each component of the [Vector2] by the given [int]. </description> </operator> <operator name="operator +"> <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Adds each component of the [Vector2] by the components of the given [Vector2]. [codeblock] @@ -418,7 +418,7 @@ </operator> <operator name="operator -"> <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Subtracts each component of the [Vector2] by the components of the given [Vector2]. [codeblock] @@ -428,7 +428,7 @@ </operator> <operator name="operator /"> <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Divides each component of the [Vector2] by the components of the given [Vector2]. [codeblock] @@ -438,35 +438,35 @@ </operator> <operator name="operator /"> <return type="Vector2" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides each component of the [Vector2] by the given [float]. </description> </operator> <operator name="operator /"> <return type="Vector2" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides each component of the [Vector2] by the given [int]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Compares two [Vector2] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Compares two [Vector2] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Returns [code]true[/code] if the vectors are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -474,21 +474,21 @@ </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Compares two [Vector2] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Compares two [Vector2] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> </operator> <operator name="operator []"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], and [code]v[1][/code] is equivalent to [code]v.y[/code]. </description> diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml index 28d68b6e44..a60fd09a48 100644 --- a/doc/classes/Vector2i.xml +++ b/doc/classes/Vector2i.xml @@ -22,22 +22,22 @@ </constructor> <constructor name="Vector2i"> <return type="Vector2i" /> - <argument index="0" name="from" type="Vector2i" /> + <param index="0" name="from" type="Vector2i" /> <description> Constructs a [Vector2i] as a copy of the given [Vector2i]. </description> </constructor> <constructor name="Vector2i"> <return type="Vector2i" /> - <argument index="0" name="from" type="Vector2" /> + <param index="0" name="from" type="Vector2" /> <description> Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated. </description> </constructor> <constructor name="Vector2i"> <return type="Vector2i" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> <description> Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code]. </description> @@ -58,8 +58,8 @@ </method> <method name="clamp" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="min" type="Vector2i" /> - <argument index="1" name="max" type="Vector2i" /> + <param index="0" name="min" type="Vector2i" /> + <param index="1" name="max" type="Vector2i" /> <description> Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> @@ -133,14 +133,14 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Returns [code]true[/code] if the vectors are not equal. </description> </operator> <operator name="operator %"> <return type="Vector2i" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Gets the remainder of each component of the [Vector2i] with the components of the given [Vector2i]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -150,7 +150,7 @@ </operator> <operator name="operator %"> <return type="Vector2i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Gets the remainder of each component of the [Vector2i] with the the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -160,7 +160,7 @@ </operator> <operator name="operator *"> <return type="Vector2i" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Multiplies each component of the [Vector2i] by the components of the given [Vector2i]. [codeblock] @@ -170,7 +170,7 @@ </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies each component of the [Vector2i] by the given [float]. Returns a [Vector2]. [codeblock] @@ -180,14 +180,14 @@ </operator> <operator name="operator *"> <return type="Vector2i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies each component of the [Vector2i] by the given [int]. </description> </operator> <operator name="operator +"> <return type="Vector2i" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Adds each component of the [Vector2i] by the components of the given [Vector2i]. [codeblock] @@ -197,7 +197,7 @@ </operator> <operator name="operator -"> <return type="Vector2i" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Subtracts each component of the [Vector2i] by the components of the given [Vector2i]. [codeblock] @@ -207,7 +207,7 @@ </operator> <operator name="operator /"> <return type="Vector2i" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Divides each component of the [Vector2i] by the components of the given [Vector2i]. [codeblock] @@ -217,7 +217,7 @@ </operator> <operator name="operator /"> <return type="Vector2" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides each component of the [Vector2i] by the given [float]. Returns a [Vector2]. [codeblock] @@ -227,49 +227,49 @@ </operator> <operator name="operator /"> <return type="Vector2i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides each component of the [Vector2i] by the given [int]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Compares two [Vector2i] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Compares two [Vector2i] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Returns [code]true[/code] if the vectors are equal. </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Compares two [Vector2i] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Compares two [Vector2i] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> </operator> <operator name="operator []"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], and [code]v[1][/code] is equivalent to [code]v.y[/code]. </description> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index c181720a66..49aeb3e754 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -25,23 +25,23 @@ </constructor> <constructor name="Vector3"> <return type="Vector3" /> - <argument index="0" name="from" type="Vector3" /> + <param index="0" name="from" type="Vector3" /> <description> Constructs a [Vector3] as a copy of the given [Vector3]. </description> </constructor> <constructor name="Vector3"> <return type="Vector3" /> - <argument index="0" name="from" type="Vector3i" /> + <param index="0" name="from" type="Vector3i" /> <description> Constructs a new [Vector3] from [Vector3i]. </description> </constructor> <constructor name="Vector3"> <return type="Vector3" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> - <argument index="2" name="z" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> + <param index="2" name="z" type="float" /> <description> Returns a [Vector3] with the given components. </description> @@ -56,24 +56,24 @@ </method> <method name="angle_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector3" /> + <param index="0" name="to" type="Vector3" /> <description> Returns the unsigned minimum angle to the given vector, in radians. </description> </method> <method name="bezier_interpolate" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="control_1" type="Vector3" /> - <argument index="1" name="control_2" type="Vector3" /> - <argument index="2" name="end" type="Vector3" /> - <argument index="3" name="t" type="float" /> + <param index="0" name="control_1" type="Vector3" /> + <param index="1" name="control_2" type="Vector3" /> + <param index="2" name="end" type="Vector3" /> + <param index="3" name="t" type="float" /> <description> Returns the point at the given [code]t[/code] on the [url=https://en.wikipedia.org/wiki/B%C3%A9zier_curve]Bezier curve[/url] defined by this vector and the given [code]control_1[/code], [code]control_2[/code], and [code]end[/code] points. </description> </method> <method name="bounce" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="n" type="Vector3" /> + <param index="0" name="n" type="Vector3" /> <description> Returns the vector "bounced off" from a plane defined by the given normal. </description> @@ -86,39 +86,39 @@ </method> <method name="clamp" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="min" type="Vector3" /> - <argument index="1" name="max" type="Vector3" /> + <param index="0" name="min" type="Vector3" /> + <param index="1" name="max" type="Vector3" /> <description> Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> </method> <method name="cross" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="with" type="Vector3" /> + <param index="0" name="with" type="Vector3" /> <description> Returns the cross product of this vector and [code]with[/code]. </description> </method> <method name="cubic_interpolate" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="b" type="Vector3" /> - <argument index="1" name="pre_a" type="Vector3" /> - <argument index="2" name="post_b" type="Vector3" /> - <argument index="3" name="weight" type="float" /> + <param index="0" name="b" type="Vector3" /> + <param index="1" name="pre_a" type="Vector3" /> + <param index="2" name="post_b" type="Vector3" /> + <param index="3" name="weight" type="float" /> <description> Performs a cubic interpolation between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. </description> </method> <method name="direction_to" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="to" type="Vector3" /> + <param index="0" name="to" type="Vector3" /> <description> Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code]. </description> </method> <method name="distance_squared_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector3" /> + <param index="0" name="to" type="Vector3" /> <description> Returns the squared distance between this vector and [code]to[/code]. This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula. @@ -126,14 +126,14 @@ </method> <method name="distance_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector3" /> + <param index="0" name="to" type="Vector3" /> <description> Returns the distance between this vector and [code]to[/code]. </description> </method> <method name="dot" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Vector3" /> + <param index="0" name="with" type="Vector3" /> <description> Returns the dot product of this vector and [code]with[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. @@ -155,7 +155,7 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="to" type="Vector3" /> + <param index="0" name="to" type="Vector3" /> <description> Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> @@ -181,15 +181,15 @@ </method> <method name="lerp" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="to" type="Vector3" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Vector3" /> + <param index="1" name="weight" type="float" /> <description> Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. </description> </method> <method name="limit_length" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="length" type="float" default="1.0" /> + <param index="0" name="length" type="float" default="1.0" /> <description> Returns the vector with a maximum length by limiting its length to [code]length[/code]. </description> @@ -208,8 +208,8 @@ </method> <method name="move_toward" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="to" type="Vector3" /> - <argument index="1" name="delta" type="float" /> + <param index="0" name="to" type="Vector3" /> + <param index="1" name="delta" type="float" /> <description> Returns a new vector moved toward [code]to[/code] by the fixed [code]delta[/code] amount. Will not go past the final value. </description> @@ -222,7 +222,7 @@ </method> <method name="octahedron_decode" qualifiers="static"> <return type="Vector3" /> - <argument index="0" name="uv" type="Vector2" /> + <param index="0" name="uv" type="Vector2" /> <description> </description> </method> @@ -233,43 +233,43 @@ </method> <method name="outer" qualifiers="const"> <return type="Basis" /> - <argument index="0" name="with" type="Vector3" /> + <param index="0" name="with" type="Vector3" /> <description> Returns the outer product with [code]with[/code]. </description> </method> <method name="posmod" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="mod" type="float" /> + <param index="0" name="mod" type="float" /> <description> Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code]. </description> </method> <method name="posmodv" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="modv" type="Vector3" /> + <param index="0" name="modv" type="Vector3" /> <description> Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components. </description> </method> <method name="project" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="b" type="Vector3" /> + <param index="0" name="b" type="Vector3" /> <description> Returns this vector projected onto the vector [code]b[/code]. </description> </method> <method name="reflect" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="n" type="Vector3" /> + <param index="0" name="n" type="Vector3" /> <description> Returns this vector reflected from a plane defined by the given normal. </description> </method> <method name="rotated" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="angle" type="float" /> + <param index="0" name="axis" type="Vector3" /> + <param index="1" name="angle" type="float" /> <description> Rotates this vector around a given axis by [code]angle[/code] (in radians). The axis must be a normalized vector. </description> @@ -288,16 +288,16 @@ </method> <method name="signed_angle_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector3" /> - <argument index="1" name="axis" type="Vector3" /> + <param index="0" name="to" type="Vector3" /> + <param index="1" name="axis" type="Vector3" /> <description> Returns the signed angle to the given vector, in radians. The sign of the angle is positive in a counter-clockwise direction and negative in a clockwise direction when viewed from the side specified by the [code]axis[/code]. </description> </method> <method name="slerp" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="to" type="Vector3" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Vector3" /> + <param index="1" name="weight" type="float" /> <description> Returns the result of spherical linear interpolation between this vector and [code]to[/code], by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. This method also handles interpolating the lengths if the input vectors have different lengths. For the special case of one or both input vectors having zero length, this method behaves like [method lerp]. @@ -305,14 +305,14 @@ </method> <method name="slide" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="n" type="Vector3" /> + <param index="0" name="n" type="Vector3" /> <description> Returns this vector slid along a plane defined by the given normal. </description> </method> <method name="snapped" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="step" type="Vector3" /> + <param index="0" name="step" type="Vector3" /> <description> Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. </description> @@ -370,7 +370,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Returns [code]true[/code] if the vectors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -378,28 +378,28 @@ </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Basis" /> + <param index="0" name="right" type="Basis" /> <description> Inversely transforms (multiplies) the [Vector3] by the given [Basis] matrix. </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Inversely transforms (multiplies) the [Vector3] by the given [Quaternion]. </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Transform3D" /> + <param index="0" name="right" type="Transform3D" /> <description> Inversely transforms (multiplies) the [Vector3] by the given [Transform3D] transformation matrix. </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Multiplies each component of the [Vector3] by the components of the given [Vector3]. [codeblock] @@ -409,21 +409,21 @@ </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies each component of the [Vector3] by the given [float]. </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies each component of the [Vector3] by the given [int]. </description> </operator> <operator name="operator +"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Adds each component of the [Vector3] by the components of the given [Vector3]. [codeblock] @@ -433,7 +433,7 @@ </operator> <operator name="operator -"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Subtracts each component of the [Vector3] by the components of the given [Vector3]. [codeblock] @@ -443,7 +443,7 @@ </operator> <operator name="operator /"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Divides each component of the [Vector3] by the components of the given [Vector3]. [codeblock] @@ -453,35 +453,35 @@ </operator> <operator name="operator /"> <return type="Vector3" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides each component of the [Vector3] by the given [float]. </description> </operator> <operator name="operator /"> <return type="Vector3" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides each component of the [Vector3] by the given [int]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Compares two [Vector3] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Compares two [Vector3] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Returns [code]true[/code] if the vectors are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -489,21 +489,21 @@ </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Compares two [Vector3] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Compares two [Vector3] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator []"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code]. </description> diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml index ebb518792f..6c61bf8736 100644 --- a/doc/classes/Vector3i.xml +++ b/doc/classes/Vector3i.xml @@ -22,23 +22,23 @@ </constructor> <constructor name="Vector3i"> <return type="Vector3i" /> - <argument index="0" name="from" type="Vector3i" /> + <param index="0" name="from" type="Vector3i" /> <description> Constructs a [Vector3i] as a copy of the given [Vector3i]. </description> </constructor> <constructor name="Vector3i"> <return type="Vector3i" /> - <argument index="0" name="from" type="Vector3" /> + <param index="0" name="from" type="Vector3" /> <description> Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated. </description> </constructor> <constructor name="Vector3i"> <return type="Vector3i" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> - <argument index="2" name="z" type="int" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> + <param index="2" name="z" type="int" /> <description> Returns a [Vector3i] with the given components. </description> @@ -53,8 +53,8 @@ </method> <method name="clamp" qualifiers="const"> <return type="Vector3i" /> - <argument index="0" name="min" type="Vector3i" /> - <argument index="1" name="max" type="Vector3i" /> + <param index="0" name="min" type="Vector3i" /> + <param index="1" name="max" type="Vector3i" /> <description> Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> @@ -140,14 +140,14 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Returns [code]true[/code] if the vectors are not equal. </description> </operator> <operator name="operator %"> <return type="Vector3i" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Gets the remainder of each component of the [Vector3i] with the components of the given [Vector3i]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -157,7 +157,7 @@ </operator> <operator name="operator %"> <return type="Vector3i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Gets the remainder of each component of the [Vector3i] with the the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -167,7 +167,7 @@ </operator> <operator name="operator *"> <return type="Vector3i" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Multiplies each component of the [Vector3i] by the components of the given [Vector3i]. [codeblock] @@ -177,7 +177,7 @@ </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies each component of the [Vector3i] by the given [float]. Returns a [Vector3]. [codeblock] @@ -187,14 +187,14 @@ </operator> <operator name="operator *"> <return type="Vector3i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies each component of the [Vector3i] by the given [int]. </description> </operator> <operator name="operator +"> <return type="Vector3i" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Adds each component of the [Vector3i] by the components of the given [Vector3i]. [codeblock] @@ -204,7 +204,7 @@ </operator> <operator name="operator -"> <return type="Vector3i" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Subtracts each component of the [Vector3i] by the components of the given [Vector3i]. [codeblock] @@ -214,7 +214,7 @@ </operator> <operator name="operator /"> <return type="Vector3i" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Divides each component of the [Vector3i] by the components of the given [Vector3i]. [codeblock] @@ -224,7 +224,7 @@ </operator> <operator name="operator /"> <return type="Vector3" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides each component of the [Vector3i] by the given [float]. Returns a [Vector3]. [codeblock] @@ -234,49 +234,49 @@ </operator> <operator name="operator /"> <return type="Vector3i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides each component of the [Vector3i] by the given [int]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Compares two [Vector3i] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Compares two [Vector3i] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Returns [code]true[/code] if the vectors are equal. </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Compares two [Vector3i] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Compares two [Vector3i] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator []"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code]. </description> diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index ee9d97019e..b5658f074a 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -19,24 +19,24 @@ </constructor> <constructor name="Vector4"> <return type="Vector4" /> - <argument index="0" name="from" type="Vector4" /> + <param index="0" name="from" type="Vector4" /> <description> Constructs a [Vector4] as a copy of the given [Vector4]. </description> </constructor> <constructor name="Vector4"> <return type="Vector4" /> - <argument index="0" name="from" type="Vector4i" /> + <param index="0" name="from" type="Vector4i" /> <description> Constructs a new [Vector4] from [Vector4i]. </description> </constructor> <constructor name="Vector4"> <return type="Vector4" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> - <argument index="2" name="z" type="float" /> - <argument index="3" name="w" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> + <param index="2" name="z" type="float" /> + <param index="3" name="w" type="float" /> <description> Returns a [Vector4] with the given components. </description> @@ -57,39 +57,39 @@ </method> <method name="clamp" qualifiers="const"> <return type="Vector4" /> - <argument index="0" name="min" type="Vector4" /> - <argument index="1" name="max" type="Vector4" /> + <param index="0" name="min" type="Vector4" /> + <param index="1" name="max" type="Vector4" /> <description> Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> </method> <method name="cubic_interpolate" qualifiers="const"> <return type="Vector4" /> - <argument index="0" name="b" type="Vector4" /> - <argument index="1" name="pre_a" type="Vector4" /> - <argument index="2" name="post_b" type="Vector4" /> - <argument index="3" name="weight" type="float" /> + <param index="0" name="b" type="Vector4" /> + <param index="1" name="pre_a" type="Vector4" /> + <param index="2" name="post_b" type="Vector4" /> + <param index="3" name="weight" type="float" /> <description> Performs a cubic interpolation between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. </description> </method> <method name="direction_to" qualifiers="const"> <return type="Vector4" /> - <argument index="0" name="to" type="Vector4" /> + <param index="0" name="to" type="Vector4" /> <description> Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code]. </description> </method> <method name="distance_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Vector4" /> + <param index="0" name="to" type="Vector4" /> <description> Returns the distance between this vector and [code]to[/code]. </description> </method> <method name="dot" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Vector4" /> + <param index="0" name="with" type="Vector4" /> <description> Returns the dot product of this vector and [code]with[/code]. </description> @@ -108,7 +108,7 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="with" type="Vector4" /> + <param index="0" name="with" type="Vector4" /> <description> Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> @@ -133,8 +133,8 @@ </method> <method name="lerp" qualifiers="const"> <return type="Vector4" /> - <argument index="0" name="to" type="Vector4" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Vector4" /> + <param index="1" name="weight" type="float" /> <description> Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. </description> @@ -159,14 +159,14 @@ </method> <method name="posmod" qualifiers="const"> <return type="Vector4" /> - <argument index="0" name="mod" type="float" /> + <param index="0" name="mod" type="float" /> <description> Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code]. </description> </method> <method name="posmodv" qualifiers="const"> <return type="Vector4" /> - <argument index="0" name="modv" type="Vector4" /> + <param index="0" name="modv" type="Vector4" /> <description> Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components. </description> @@ -185,7 +185,7 @@ </method> <method name="snapped" qualifiers="const"> <return type="Vector4" /> - <argument index="0" name="step" type="Vector4" /> + <param index="0" name="step" type="Vector4" /> <description> Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. </description> @@ -231,7 +231,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Returns [code]true[/code] if the vectors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -239,14 +239,14 @@ </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="Projection" /> + <param index="0" name="right" type="Projection" /> <description> Inversely transforms (multiplies) the [Vector4] by the given [Projection] matrix. </description> </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Multiplies each component of the [Vector4] by the components of the given [Vector4]. [codeblock] @@ -256,7 +256,7 @@ </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies each component of the [Vector4] by the given [float]. [codeblock] @@ -266,14 +266,14 @@ </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies each component of the [Vector4] by the given [int]. </description> </operator> <operator name="operator +"> <return type="Vector4" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Adds each component of the [Vector4] by the components of the given [Vector4]. [codeblock] @@ -283,7 +283,7 @@ </operator> <operator name="operator -"> <return type="Vector4" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Subtracts each component of the [Vector4] by the components of the given [Vector4]. [codeblock] @@ -293,7 +293,7 @@ </operator> <operator name="operator /"> <return type="Vector4" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Divides each component of the [Vector4] by the components of the given [Vector4]. [codeblock] @@ -303,7 +303,7 @@ </operator> <operator name="operator /"> <return type="Vector4" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides each component of the [Vector4] by the given [float]. [codeblock] @@ -313,28 +313,28 @@ </operator> <operator name="operator /"> <return type="Vector4" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides each component of the [Vector4] by the given [int]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Compares two [Vector4] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Compares two [Vector4] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Returns [code]true[/code] if the vectors are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -342,21 +342,21 @@ </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Compares two [Vector4] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code]. </description> </operator> <operator name="operator []"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], [code]v[2][/code] is equivalent to [code]v.z[/code], and [code]v[3][/code] is equivalent to [code]v.w[/code]. </description> diff --git a/doc/classes/Vector4i.xml b/doc/classes/Vector4i.xml index 6acce12e9f..9a36c3c4fa 100644 --- a/doc/classes/Vector4i.xml +++ b/doc/classes/Vector4i.xml @@ -14,22 +14,22 @@ </constructor> <constructor name="Vector4i"> <return type="Vector4i" /> - <argument index="0" name="from" type="Vector4i" /> + <param index="0" name="from" type="Vector4i" /> <description> </description> </constructor> <constructor name="Vector4i"> <return type="Vector4i" /> - <argument index="0" name="from" type="Vector4" /> + <param index="0" name="from" type="Vector4" /> <description> </description> </constructor> <constructor name="Vector4i"> <return type="Vector4i" /> - <argument index="0" name="x" type="int" /> - <argument index="1" name="y" type="int" /> - <argument index="2" name="z" type="int" /> - <argument index="3" name="w" type="int" /> + <param index="0" name="x" type="int" /> + <param index="1" name="y" type="int" /> + <param index="2" name="z" type="int" /> + <param index="3" name="w" type="int" /> <description> </description> </constructor> @@ -42,8 +42,8 @@ </method> <method name="clamp" qualifiers="const"> <return type="Vector4i" /> - <argument index="0" name="min" type="Vector4i" /> - <argument index="1" name="max" type="Vector4i" /> + <param index="0" name="min" type="Vector4i" /> + <param index="1" name="max" type="Vector4i" /> <description> </description> </method> @@ -100,103 +100,103 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator %"> <return type="Vector4i" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator %"> <return type="Vector4i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> </description> </operator> <operator name="operator *"> <return type="Vector4i" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> </description> </operator> <operator name="operator *"> <return type="Vector4i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> </description> </operator> <operator name="operator +"> <return type="Vector4i" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator -"> <return type="Vector4i" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator /"> <return type="Vector4i" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator /"> <return type="Vector4" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> </description> </operator> <operator name="operator /"> <return type="Vector4i" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator []"> <return type="int" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> </description> </operator> diff --git a/doc/classes/VelocityTracker3D.xml b/doc/classes/VelocityTracker3D.xml index 45ded446eb..56b60ba13c 100644 --- a/doc/classes/VelocityTracker3D.xml +++ b/doc/classes/VelocityTracker3D.xml @@ -14,13 +14,13 @@ </method> <method name="reset"> <return type="void" /> - <argument index="0" name="position" type="Vector3" /> + <param index="0" name="position" type="Vector3" /> <description> </description> </method> <method name="update_position"> <return type="void" /> - <argument index="0" name="position" type="Vector3" /> + <param index="0" name="position" type="Vector3" /> <description> </description> </method> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 0808a8f1cf..f3db437b79 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -59,15 +59,15 @@ </method> <method name="get_positional_shadow_atlas_quadrant_subdiv" qualifiers="const"> <return type="int" enum="Viewport.PositionalShadowAtlasQuadrantSubdiv" /> - <argument index="0" name="quadrant" type="int" /> + <param index="0" name="quadrant" type="int" /> <description> Returns the [enum PositionalShadowAtlasQuadrantSubdiv] of the specified quadrant. </description> </method> <method name="get_render_info"> <return type="int" /> - <argument index="0" name="type" type="int" enum="Viewport.RenderInfoType" /> - <argument index="1" name="info" type="int" enum="Viewport.RenderInfo" /> + <param index="0" name="type" type="int" enum="Viewport.RenderInfoType" /> + <param index="1" name="info" type="int" enum="Viewport.RenderInfo" /> <description> </description> </method> @@ -133,22 +133,22 @@ </method> <method name="push_input"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> - <argument index="1" name="in_local_coords" type="bool" default="false" /> + <param index="0" name="event" type="InputEvent" /> + <param index="1" name="in_local_coords" type="bool" default="false" /> <description> </description> </method> <method name="push_text_input"> <return type="void" /> - <argument index="0" name="text" type="String" /> + <param index="0" name="text" type="String" /> <description> Returns [code]true[/code] if the viewport is currently embedding windows. </description> </method> <method name="push_unhandled_input"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> - <argument index="1" name="in_local_coords" type="bool" default="false" /> + <param index="0" name="event" type="InputEvent" /> + <param index="1" name="in_local_coords" type="bool" default="false" /> <description> </description> </method> @@ -160,15 +160,15 @@ </method> <method name="set_positional_shadow_atlas_quadrant_subdiv"> <return type="void" /> - <argument index="0" name="quadrant" type="int" /> - <argument index="1" name="subdiv" type="int" enum="Viewport.PositionalShadowAtlasQuadrantSubdiv" /> + <param index="0" name="quadrant" type="int" /> + <param index="1" name="subdiv" type="int" enum="Viewport.PositionalShadowAtlasQuadrantSubdiv" /> <description> Sets the number of subdivisions to use in the specified quadrant. A higher number of subdivisions allows you to have more shadows in the scene at once, but reduces the quality of the shadows. A good practice is to have quadrants with a varying number of subdivisions and to have as few subdivisions as possible. </description> </method> <method name="warp_mouse"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Moves the mouse pointer to the specified position in this [Viewport] using the coordinate system of this [Viewport]. </description> @@ -302,7 +302,7 @@ </members> <signals> <signal name="gui_focus_changed"> - <argument index="0" name="node" type="Control" /> + <param index="0" name="node" type="Control" /> <description> Emitted when a Control node grabs keyboard focus. </description> diff --git a/doc/classes/VisualInstance3D.xml b/doc/classes/VisualInstance3D.xml index 2468042850..3e23996173 100644 --- a/doc/classes/VisualInstance3D.xml +++ b/doc/classes/VisualInstance3D.xml @@ -34,7 +34,7 @@ </method> <method name="get_layer_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member layers] is enabled, given a [code]layer_number[/code] between 1 and 20. </description> @@ -48,15 +48,15 @@ </method> <method name="set_base"> <return type="void" /> - <argument index="0" name="base" type="RID" /> + <param index="0" name="base" type="RID" /> <description> Sets the resource that is instantiated by this [VisualInstance3D], which changes how the engine handles the [VisualInstance3D] under the hood. Equivalent to [method RenderingServer.instance_set_base]. </description> </method> <method name="set_layer_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member layers], given a [code]layer_number[/code] between 1 and 20. </description> diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 64d901cd79..bf95a414f6 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -12,154 +12,154 @@ <methods> <method name="add_node"> <return type="void" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="node" type="VisualShaderNode" /> - <argument index="2" name="position" type="Vector2" /> - <argument index="3" name="id" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="node" type="VisualShaderNode" /> + <param index="2" name="position" type="Vector2" /> + <param index="3" name="id" type="int" /> <description> Adds the specified node to the shader. </description> </method> <method name="add_varying"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="mode" type="int" enum="VisualShader.VaryingMode" /> - <argument index="2" name="type" type="int" enum="VisualShader.VaryingType" /> + <param index="0" name="name" type="String" /> + <param index="1" name="mode" type="int" enum="VisualShader.VaryingMode" /> + <param index="2" name="type" type="int" enum="VisualShader.VaryingType" /> <description> </description> </method> <method name="can_connect_nodes" qualifiers="const"> <return type="bool" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="from_node" type="int" /> - <argument index="2" name="from_port" type="int" /> - <argument index="3" name="to_node" type="int" /> - <argument index="4" name="to_port" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="from_node" type="int" /> + <param index="2" name="from_port" type="int" /> + <param index="3" name="to_node" type="int" /> + <param index="4" name="to_port" type="int" /> <description> Returns [code]true[/code] if the specified nodes and ports can be connected together. </description> </method> <method name="connect_nodes"> <return type="int" enum="Error" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="from_node" type="int" /> - <argument index="2" name="from_port" type="int" /> - <argument index="3" name="to_node" type="int" /> - <argument index="4" name="to_port" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="from_node" type="int" /> + <param index="2" name="from_port" type="int" /> + <param index="3" name="to_node" type="int" /> + <param index="4" name="to_port" type="int" /> <description> Connects the specified nodes and ports. </description> </method> <method name="connect_nodes_forced"> <return type="void" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="from_node" type="int" /> - <argument index="2" name="from_port" type="int" /> - <argument index="3" name="to_node" type="int" /> - <argument index="4" name="to_port" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="from_node" type="int" /> + <param index="2" name="from_port" type="int" /> + <param index="3" name="to_node" type="int" /> + <param index="4" name="to_port" type="int" /> <description> Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. </description> </method> <method name="disconnect_nodes"> <return type="void" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="from_node" type="int" /> - <argument index="2" name="from_port" type="int" /> - <argument index="3" name="to_node" type="int" /> - <argument index="4" name="to_port" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="from_node" type="int" /> + <param index="2" name="from_port" type="int" /> + <param index="3" name="to_node" type="int" /> + <param index="4" name="to_port" type="int" /> <description> Connects the specified nodes and ports. </description> </method> <method name="get_node" qualifiers="const"> <return type="VisualShaderNode" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="id" type="int" /> <description> Returns the shader node instance with specified [code]type[/code] and [code]id[/code]. </description> </method> <method name="get_node_connections" qualifiers="const"> <return type="Array" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> <description> Returns the list of connected nodes with the specified type. </description> </method> <method name="get_node_list" qualifiers="const"> <return type="PackedInt32Array" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> <description> Returns the list of all nodes in the shader with the specified type. </description> </method> <method name="get_node_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="id" type="int" /> <description> Returns the position of the specified node within the shader graph. </description> </method> <method name="get_valid_node_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> <description> </description> </method> <method name="has_varying" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> </description> </method> <method name="is_node_connection" qualifiers="const"> <return type="bool" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="from_node" type="int" /> - <argument index="2" name="from_port" type="int" /> - <argument index="3" name="to_node" type="int" /> - <argument index="4" name="to_port" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="from_node" type="int" /> + <param index="2" name="from_port" type="int" /> + <param index="3" name="to_node" type="int" /> + <param index="4" name="to_port" type="int" /> <description> Returns [code]true[/code] if the specified node and port connection exist. </description> </method> <method name="remove_node"> <return type="void" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="id" type="int" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="id" type="int" /> <description> Removes the specified node from the shader. </description> </method> <method name="remove_varying"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> </description> </method> <method name="replace_node"> <return type="void" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="id" type="int" /> - <argument index="2" name="new_class" type="StringName" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="id" type="int" /> + <param index="2" name="new_class" type="StringName" /> <description> Replaces the specified node with a node of new class type. </description> </method> <method name="set_mode"> <return type="void" /> - <argument index="0" name="mode" type="int" enum="Shader.Mode" /> + <param index="0" name="mode" type="int" enum="Shader.Mode" /> <description> Sets the mode of this shader. </description> </method> <method name="set_node_position"> <return type="void" /> - <argument index="0" name="type" type="int" enum="VisualShader.Type" /> - <argument index="1" name="id" type="int" /> - <argument index="2" name="position" type="Vector2" /> + <param index="0" name="type" type="int" enum="VisualShader.Type" /> + <param index="1" name="id" type="int" /> + <param index="2" name="position" type="Vector2" /> <description> Sets the position of the specified node. </description> diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index 7220731a8a..6ab9c3717a 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -24,30 +24,30 @@ </method> <method name="get_input_port_default_value" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="port" type="int" /> + <param index="0" name="port" type="int" /> <description> Returns the default value of the input [code]port[/code]. </description> </method> <method name="remove_input_port_default_value"> <return type="void" /> - <argument index="0" name="port" type="int" /> + <param index="0" name="port" type="int" /> <description> Removes the default value of the input [code]port[/code]. </description> </method> <method name="set_default_input_values"> <return type="void" /> - <argument index="0" name="values" type="Array" /> + <param index="0" name="values" type="Array" /> <description> Sets the default input ports values using an [Array] of the form [code][index0, value0, index1, value1, ...][/code]. For example: [code][0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)][/code]. </description> </method> <method name="set_input_port_default_value"> <return type="void" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="value" type="Variant" /> - <argument index="2" name="prev_value" type="Variant" default="null" /> + <param index="0" name="port" type="int" /> + <param index="1" name="value" type="Variant" /> + <param index="2" name="prev_value" type="Variant" default="null" /> <description> Sets the default value for the selected input [code]port[/code]. </description> diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml index 0a962a4aa4..8a2f607b75 100644 --- a/doc/classes/VisualShaderNodeCustom.xml +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -25,10 +25,10 @@ </method> <method name="_get_code" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="input_vars" type="String[]" /> - <argument index="1" name="output_vars" type="String[]" /> - <argument index="2" name="mode" type="int" enum="Shader.Mode" /> - <argument index="3" name="type" type="int" enum="VisualShader.Type" /> + <param index="0" name="input_vars" type="String[]" /> + <param index="1" name="output_vars" type="String[]" /> + <param index="2" name="mode" type="int" enum="Shader.Mode" /> + <param index="3" name="type" type="int" enum="VisualShader.Type" /> <description> Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). The [code]input_vars[/code] and [code]output_vars[/code] arrays contain the string names of the various input and output variables, as defined by [code]_get_input_*[/code] and [code]_get_output_*[/code] virtual methods in this class. @@ -46,8 +46,8 @@ </method> <method name="_get_func_code" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="mode" type="int" enum="Shader.Mode" /> - <argument index="1" name="type" type="int" enum="VisualShader.Type" /> + <param index="0" name="mode" type="int" enum="Shader.Mode" /> + <param index="1" name="type" type="int" enum="VisualShader.Type" /> <description> Override this method to add a shader code to the beginning of each shader function (once). The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). If there are multiple custom nodes of different types which use this feature the order of each insertion is undefined. @@ -57,7 +57,7 @@ </method> <method name="_get_global_code" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="mode" type="int" enum="Shader.Mode" /> + <param index="0" name="mode" type="int" enum="Shader.Mode" /> <description> Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). Be careful with this functionality as it can cause name conflicts with other custom nodes, so be sure to give the defined entities unique names. @@ -74,7 +74,7 @@ </method> <method name="_get_input_port_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="port" type="int" /> + <param index="0" name="port" type="int" /> <description> Override this method to define the names of input ports of the associated custom node. The names are used both for the input slots in the editor and as identifiers in the shader code, and are passed in the [code]input_vars[/code] array in [method _get_code]. Defining this method is [b]optional[/b], but recommended. If not overridden, input ports are named as [code]"in" + str(port)[/code]. @@ -82,7 +82,7 @@ </method> <method name="_get_input_port_type" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="port" type="int" /> + <param index="0" name="port" type="int" /> <description> Override this method to define the returned type of each input port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). Defining this method is [b]optional[/b], but recommended. If not overridden, input ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. @@ -104,7 +104,7 @@ </method> <method name="_get_output_port_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="port" type="int" /> + <param index="0" name="port" type="int" /> <description> Override this method to define the names of output ports of the associated custom node. The names are used both for the output slots in the editor and as identifiers in the shader code, and are passed in the [code]output_vars[/code] array in [method _get_code]. Defining this method is [b]optional[/b], but recommended. If not overridden, output ports are named as [code]"out" + str(port)[/code]. @@ -112,7 +112,7 @@ </method> <method name="_get_output_port_type" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="port" type="int" /> + <param index="0" name="port" type="int" /> <description> Override this method to define the returned type of each output port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). Defining this method is [b]optional[/b], but recommended. If not overridden, output ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. @@ -127,8 +127,8 @@ </method> <method name="_is_available" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="mode" type="int" enum="Shader.Mode" /> - <argument index="1" name="type" type="int" enum="VisualShader.Type" /> + <param index="0" name="mode" type="int" enum="Shader.Mode" /> + <param index="1" name="type" type="int" enum="VisualShader.Type" /> <description> Override this method to prevent the node to be visible in the member dialog for the certain [code]mode[/code] (see [enum Shader.Mode]) and/or [code]type[/code] (see [enum VisualShader.Type]). Defining this method is [b]optional[/b]. If not overridden, it's [code]true[/code]. diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml index 1b724b00d6..9508aaba27 100644 --- a/doc/classes/VisualShaderNodeGroupBase.xml +++ b/doc/classes/VisualShaderNodeGroupBase.xml @@ -11,18 +11,18 @@ <methods> <method name="add_input_port"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="type" type="int" /> - <argument index="2" name="name" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="type" type="int" /> + <param index="2" name="name" type="String" /> <description> Adds an input port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code]. </description> </method> <method name="add_output_port"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="type" type="int" /> - <argument index="2" name="name" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="type" type="int" /> + <param index="2" name="name" type="String" /> <description> Adds an output port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code]. </description> @@ -77,81 +77,81 @@ </method> <method name="has_input_port" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns [code]true[/code] if the specified input port exists. </description> </method> <method name="has_output_port" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns [code]true[/code] if the specified output port exists. </description> </method> <method name="is_valid_port_name" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Returns [code]true[/code] if the specified port name does not override an existed port name and is valid within the shader. </description> </method> <method name="remove_input_port"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Removes the specified input port. </description> </method> <method name="remove_output_port"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Removes the specified output port. </description> </method> <method name="set_input_port_name"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="name" type="String" /> <description> Renames the specified input port. </description> </method> <method name="set_input_port_type"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="type" type="int" /> + <param index="0" name="id" type="int" /> + <param index="1" name="type" type="int" /> <description> Sets the specified input port's type (see [enum VisualShaderNode.PortType]). </description> </method> <method name="set_inputs"> <return type="void" /> - <argument index="0" name="inputs" type="String" /> + <param index="0" name="inputs" type="String" /> <description> Defines all input ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_input_port]). </description> </method> <method name="set_output_port_name"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="name" type="String" /> <description> Renames the specified output port. </description> </method> <method name="set_output_port_type"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="type" type="int" /> + <param index="0" name="id" type="int" /> + <param index="1" name="type" type="int" /> <description> Sets the specified output port's type (see [enum VisualShaderNode.PortType]). </description> </method> <method name="set_outputs"> <return type="void" /> - <argument index="0" name="outputs" type="String" /> + <param index="0" name="outputs" type="String" /> <description> Defines all output ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_output_port]). </description> diff --git a/doc/classes/VoxelGI.xml b/doc/classes/VoxelGI.xml index d941185d33..ba4995a5fb 100644 --- a/doc/classes/VoxelGI.xml +++ b/doc/classes/VoxelGI.xml @@ -16,8 +16,8 @@ <methods> <method name="bake"> <return type="void" /> - <argument index="0" name="from_node" type="Node" default="null" /> - <argument index="1" name="create_visual_debug" type="bool" default="false" /> + <param index="0" name="from_node" type="Node" default="null" /> + <param index="1" name="create_visual_debug" type="bool" default="false" /> <description> Bakes the effect from all [GeometryInstance3D]s marked with [constant GeometryInstance3D.GI_MODE_STATIC] and [Light3D]s marked with either [constant Light3D.BAKE_STATIC] or [constant Light3D.BAKE_DYNAMIC]. If [code]create_visual_debug[/code] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [VoxelGI]'s data and debug any issues that may be occurring. [b]Note:[/b] [method bake] works from the editor and in exported projects. This makes it suitable for procedurally generated or user-built levels. Baking a [VoxelGI] node generally takes from 5 to 20 seconds in most scenes. Reducing [member subdiv] can speed up baking. diff --git a/doc/classes/VoxelGIData.xml b/doc/classes/VoxelGIData.xml index 9198da4bc6..92b2e66e5a 100644 --- a/doc/classes/VoxelGIData.xml +++ b/doc/classes/VoxelGIData.xml @@ -13,13 +13,13 @@ <methods> <method name="allocate"> <return type="void" /> - <argument index="0" name="to_cell_xform" type="Transform3D" /> - <argument index="1" name="aabb" type="AABB" /> - <argument index="2" name="octree_size" type="Vector3" /> - <argument index="3" name="octree_cells" type="PackedByteArray" /> - <argument index="4" name="data_cells" type="PackedByteArray" /> - <argument index="5" name="distance_field" type="PackedByteArray" /> - <argument index="6" name="level_counts" type="PackedInt32Array" /> + <param index="0" name="to_cell_xform" type="Transform3D" /> + <param index="1" name="aabb" type="AABB" /> + <param index="2" name="octree_size" type="Vector3" /> + <param index="3" name="octree_cells" type="PackedByteArray" /> + <param index="4" name="data_cells" type="PackedByteArray" /> + <param index="5" name="distance_field" type="PackedByteArray" /> + <param index="6" name="level_counts" type="PackedInt32Array" /> <description> </description> </method> diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 84f3b6a4b1..3ceff8a6ed 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -30,7 +30,7 @@ </method> <method name="get_flag" qualifiers="const"> <return type="bool" /> - <argument index="0" name="flag" type="int" enum="Window.Flags" /> + <param index="0" name="flag" type="int" enum="Window.Flags" /> <description> Returns [code]true[/code] if the flag is set. </description> @@ -49,8 +49,8 @@ </method> <method name="get_theme_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns the [Color] at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -58,8 +58,8 @@ </method> <method name="get_theme_constant" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns the constant at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -88,8 +88,8 @@ </method> <method name="get_theme_font" qualifiers="const"> <return type="Font" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns the [Font] at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -97,8 +97,8 @@ </method> <method name="get_theme_font_size" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns the font size at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -106,8 +106,8 @@ </method> <method name="get_theme_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns the icon at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -115,8 +115,8 @@ </method> <method name="get_theme_stylebox" qualifiers="const"> <return type="StyleBox" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns the [StyleBox] at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -136,48 +136,48 @@ </method> <method name="has_theme_color" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]theme_type[/code]. </description> </method> <method name="has_theme_constant" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if constant with [code]name[/code] is in [code]theme_type[/code]. </description> </method> <method name="has_theme_font" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]theme_type[/code]. </description> </method> <method name="has_theme_font_size" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if font size with [code]name[/code] is in [code]theme_type[/code]. </description> </method> <method name="has_theme_icon" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if icon with [code]name[/code] is in [code]theme_type[/code]. </description> </method> <method name="has_theme_stylebox" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]theme_type[/code]. </description> @@ -220,7 +220,7 @@ </method> <method name="popup"> <return type="void" /> - <argument index="0" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" /> + <param index="0" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" /> <description> Shows the [Window] and makes it transient (see [member transient]). If [code]rect[/code] is provided, it will be set as the [Window]'s size. Fails if called on the main window. @@ -228,7 +228,7 @@ </method> <method name="popup_centered"> <return type="void" /> - <argument index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" /> + <param index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" /> <description> Popups the [Window] at the center of the current screen, with optionally given minimum size. If the [Window] is embedded, it will be centered in the parent [Viewport] instead. @@ -236,8 +236,8 @@ </method> <method name="popup_centered_clamped"> <return type="void" /> - <argument index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" /> - <argument index="1" name="fallback_ratio" type="float" default="0.75" /> + <param index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" /> + <param index="1" name="fallback_ratio" type="float" default="0.75" /> <description> Popups the [Window] centered inside its parent [Window]. [code]fallback_ratio[/code] determines the maximum size of the [Window], in relation to its parent. @@ -245,14 +245,14 @@ </method> <method name="popup_centered_ratio"> <return type="void" /> - <argument index="0" name="ratio" type="float" default="0.8" /> + <param index="0" name="ratio" type="float" default="0.8" /> <description> Popups the [Window] centered inside its parent [Window] and sets its size as a [code]ratio[/code] of parent's size. </description> </method> <method name="popup_on_parent"> <return type="void" /> - <argument index="0" name="parent_rect" type="Rect2i" /> + <param index="0" name="parent_rect" type="Rect2i" /> <description> Popups the [Window] with a position shifted by parent [Window]'s position. If the [Window] is embedded, has the same effect as [method popup]. @@ -272,36 +272,36 @@ </method> <method name="set_flag"> <return type="void" /> - <argument index="0" name="flag" type="int" enum="Window.Flags" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="flag" type="int" enum="Window.Flags" /> + <param index="1" name="enabled" type="bool" /> <description> Sets a specified window flag. </description> </method> <method name="set_ime_active"> <return type="void" /> - <argument index="0" name="active" type="bool" /> + <param index="0" name="active" type="bool" /> <description> If [code]active[/code] is [code]true[/code], enables system's native IME (Input Method Editor). </description> </method> <method name="set_ime_position"> <return type="void" /> - <argument index="0" name="position" type="Vector2i" /> + <param index="0" name="position" type="Vector2i" /> <description> Moves IME to the given position. </description> </method> <method name="set_layout_direction"> <return type="void" /> - <argument index="0" name="direction" type="int" enum="Window.LayoutDirection" /> + <param index="0" name="direction" type="int" enum="Window.LayoutDirection" /> <description> Sets layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew). </description> </method> <method name="set_use_font_oversampling"> <return type="void" /> - <argument index="0" name="enable" type="bool" /> + <param index="0" name="enable" type="bool" /> <description> Enables font oversampling. This makes fonts look better when they are scaled up. </description> @@ -407,7 +407,7 @@ </description> </signal> <signal name="files_dropped"> - <argument index="0" name="files" type="PackedStringArray" /> + <param index="0" name="files" type="PackedStringArray" /> <description> Emitted when files are dragged from the OS file manager and dropped in the game window. The argument is a list of file paths. Note that this method only works with non-embedded windows, i.e. the main window and [Window]-derived nodes when [member Viewport.gui_embed_subwindows] is disabled in the main viewport. @@ -457,7 +457,7 @@ </description> </signal> <signal name="window_input"> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Emitted when the [Window] is currently focused and receives any input, passing the received event as an argument. </description> diff --git a/doc/classes/WorkerThreadPool.xml b/doc/classes/WorkerThreadPool.xml index 4f614bdadb..fced54ae7f 100644 --- a/doc/classes/WorkerThreadPool.xml +++ b/doc/classes/WorkerThreadPool.xml @@ -9,49 +9,49 @@ <methods> <method name="add_group_task"> <return type="int" /> - <argument index="0" name="action" type="Callable" /> - <argument index="1" name="elements" type="int" /> - <argument index="2" name="tasks_needed" type="int" default="-1" /> - <argument index="3" name="high_priority" type="bool" default="false" /> - <argument index="4" name="description" type="String" default="""" /> + <param index="0" name="action" type="Callable" /> + <param index="1" name="elements" type="int" /> + <param index="2" name="tasks_needed" type="int" default="-1" /> + <param index="3" name="high_priority" type="bool" default="false" /> + <param index="4" name="description" type="String" default="""" /> <description> </description> </method> <method name="add_task"> <return type="int" /> - <argument index="0" name="action" type="Callable" /> - <argument index="1" name="high_priority" type="bool" default="false" /> - <argument index="2" name="description" type="String" default="""" /> + <param index="0" name="action" type="Callable" /> + <param index="1" name="high_priority" type="bool" default="false" /> + <param index="2" name="description" type="String" default="""" /> <description> </description> </method> <method name="get_group_processed_element_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="group_id" type="int" /> + <param index="0" name="group_id" type="int" /> <description> </description> </method> <method name="is_group_task_completed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="group_id" type="int" /> + <param index="0" name="group_id" type="int" /> <description> </description> </method> <method name="is_task_completed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="task_id" type="int" /> + <param index="0" name="task_id" type="int" /> <description> </description> </method> <method name="wait_for_group_task_completion"> <return type="void" /> - <argument index="0" name="group_id" type="int" /> + <param index="0" name="group_id" type="int" /> <description> </description> </method> <method name="wait_for_task_completion"> <return type="void" /> - <argument index="0" name="task_id" type="int" /> + <param index="0" name="task_id" type="int" /> <description> </description> </method> diff --git a/doc/classes/X509Certificate.xml b/doc/classes/X509Certificate.xml index 581aba05e4..3082274123 100644 --- a/doc/classes/X509Certificate.xml +++ b/doc/classes/X509Certificate.xml @@ -12,14 +12,14 @@ <methods> <method name="load"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Loads a certificate from [code]path[/code] ("*.crt" file). </description> </method> <method name="save"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Saves a certificate to the given [code]path[/code] (should be a "*.crt" file). </description> diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 79ab33045f..ce58257817 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -17,14 +17,14 @@ </method> <method name="get_attribute_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Gets the name of the attribute specified by the index in [code]idx[/code] argument. </description> </method> <method name="get_attribute_value" qualifiers="const"> <return type="String" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Gets the value of the attribute specified by the index in [code]idx[/code] argument. </description> @@ -37,14 +37,14 @@ </method> <method name="get_named_attribute_value" qualifiers="const"> <return type="String" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Gets the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. </description> </method> <method name="get_named_attribute_value_safe" qualifiers="const"> <return type="String" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Gets the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found. </description> @@ -75,7 +75,7 @@ </method> <method name="has_attribute" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Check whether the current element has a certain attribute. </description> @@ -88,14 +88,14 @@ </method> <method name="open"> <return type="int" enum="Error" /> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> Opens an XML file for parsing. This returns an error code. </description> </method> <method name="open_buffer"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Opens an XML raw buffer for parsing. This returns an error code. </description> @@ -108,7 +108,7 @@ </method> <method name="seek"> <return type="int" enum="Error" /> - <argument index="0" name="position" type="int" /> + <param index="0" name="position" type="int" /> <description> Moves the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. </description> diff --git a/doc/classes/XRController3D.xml b/doc/classes/XRController3D.xml index ff4aec46e1..b1f498c8e3 100644 --- a/doc/classes/XRController3D.xml +++ b/doc/classes/XRController3D.xml @@ -15,7 +15,7 @@ <methods> <method name="get_axis" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns a [Vector2] for the input with the given [code]name[/code]. This is used for thumbsticks and thumbpads found on many controllers. </description> @@ -28,14 +28,14 @@ </method> <method name="get_value" qualifiers="const"> <return type="float" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns a numeric value for the input with the given [code]name[/code]. This is used for triggers and grip sensors. </description> </method> <method name="is_button_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the button with the given [code]name[/code] is pressed. </description> @@ -43,27 +43,27 @@ </methods> <signals> <signal name="button_pressed"> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Emitted when a button on this controller is pressed. </description> </signal> <signal name="button_released"> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Emitted when a button on this controller is released. </description> </signal> <signal name="input_axis_changed"> - <argument index="0" name="name" type="String" /> - <argument index="1" name="value" type="Vector2" /> + <param index="0" name="name" type="String" /> + <param index="1" name="value" type="Vector2" /> <description> Emitted when a thumbstick or thumbpad on this controller is moved. </description> </signal> <signal name="input_value_changed"> - <argument index="0" name="name" type="String" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="name" type="String" /> + <param index="1" name="value" type="float" /> <description> Emitted when a trigger or similar input on this controller changes value. </description> diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 26b7699af2..1fd62fc8a6 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -71,26 +71,26 @@ </method> <method name="set_play_area_mode"> <return type="bool" /> - <argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> + <param index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> <description> Sets the active play area mode, will return [code]false[/code] if the mode can't be used with this interface. </description> </method> <method name="supports_play_area_mode"> <return type="bool" /> - <argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> + <param index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> <description> Call this to find out if a given play area mode is supported by this interface. </description> </method> <method name="trigger_haptic_pulse"> <return type="void" /> - <argument index="0" name="action_name" type="String" /> - <argument index="1" name="tracker_name" type="StringName" /> - <argument index="2" name="frequency" type="float" /> - <argument index="3" name="amplitude" type="float" /> - <argument index="4" name="duration_sec" type="float" /> - <argument index="5" name="delay_sec" type="float" /> + <param index="0" name="action_name" type="String" /> + <param index="1" name="tracker_name" type="StringName" /> + <param index="2" name="frequency" type="float" /> + <param index="3" name="amplitude" type="float" /> + <param index="4" name="duration_sec" type="float" /> + <param index="5" name="delay_sec" type="float" /> <description> Triggers a haptic pulse on a device associated with this interface. [code]action_name[/code] is the name of the action for this pulse. @@ -117,7 +117,7 @@ </members> <signals> <signal name="play_area_changed"> - <argument index="0" name="mode" type="int" /> + <param index="0" name="mode" type="int" /> <description> Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation. </description> diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index 1642ae61f7..06ef18b534 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -59,10 +59,10 @@ </method> <method name="_get_projection_for_view" qualifiers="virtual"> <return type="PackedFloat64Array" /> - <argument index="0" name="view" type="int" /> - <argument index="1" name="aspect" type="float" /> - <argument index="2" name="z_near" type="float" /> - <argument index="3" name="z_far" type="float" /> + <param index="0" name="view" type="int" /> + <param index="1" name="aspect" type="float" /> + <param index="2" name="z_near" type="float" /> + <param index="3" name="z_far" type="float" /> <description> Returns the projection matrix for the given view as a [PackedFloat64Array]. </description> @@ -75,7 +75,7 @@ </method> <method name="_get_suggested_pose_names" qualifiers="virtual const"> <return type="PackedStringArray" /> - <argument index="0" name="tracker_name" type="StringName" /> + <param index="0" name="tracker_name" type="StringName" /> <description> Returns a [PackedStringArray] with pose names configured by this interface. Note that user configuration can override this list. </description> @@ -94,8 +94,8 @@ </method> <method name="_get_transform_for_view" qualifiers="virtual"> <return type="Transform3D" /> - <argument index="0" name="view" type="int" /> - <argument index="1" name="cam_transform" type="Transform3D" /> + <param index="0" name="view" type="int" /> + <param index="1" name="cam_transform" type="Transform3D" /> <description> Returns a [Transform3D] for a given view. </description> @@ -125,22 +125,22 @@ </method> <method name="_notification" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="what" type="int" /> + <param index="0" name="what" type="int" /> <description> Informs the interface of an applicable system notification. </description> </method> <method name="_post_draw_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="render_target" type="RID" /> - <argument index="1" name="screen_rect" type="Rect2" /> + <param index="0" name="render_target" type="RID" /> + <param index="1" name="screen_rect" type="Rect2" /> <description> Called after the XR [Viewport] draw logic has completed. </description> </method> <method name="_pre_draw_viewport" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="render_target" type="RID" /> + <param index="0" name="render_target" type="RID" /> <description> Called if this is our primary [XRInterfaceExtension] before we start processing a [Viewport] for every active XR [Viewport], returns [code]true[/code] if that viewport should be rendered. An XR interface may return [code]false[/code] if the user has taken off their headset and we can pause rendering. </description> @@ -159,33 +159,33 @@ </method> <method name="_set_anchor_detection_is_enabled" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Enables anchor detection on this interface if supported. </description> </method> <method name="_set_play_area_mode" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="mode" type="int" /> + <param index="0" name="mode" type="int" /> <description> Set the play area mode for this interface. </description> </method> <method name="_supports_play_area_mode" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> + <param index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> <description> Returns [code]true[/code] if this interface supports this play area mode. </description> </method> <method name="_trigger_haptic_pulse" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="action_name" type="String" /> - <argument index="1" name="tracker_name" type="StringName" /> - <argument index="2" name="frequency" type="float" /> - <argument index="3" name="amplitude" type="float" /> - <argument index="4" name="duration_sec" type="float" /> - <argument index="5" name="delay_sec" type="float" /> + <param index="0" name="action_name" type="String" /> + <param index="1" name="tracker_name" type="StringName" /> + <param index="2" name="frequency" type="float" /> + <param index="3" name="amplitude" type="float" /> + <param index="4" name="duration_sec" type="float" /> + <param index="5" name="delay_sec" type="float" /> <description> Triggers a haptic pulse to be emitted on the specified tracker. </description> @@ -198,24 +198,24 @@ </method> <method name="add_blit"> <return type="void" /> - <argument index="0" name="render_target" type="RID" /> - <argument index="1" name="src_rect" type="Rect2" /> - <argument index="2" name="dst_rect" type="Rect2i" /> - <argument index="3" name="use_layer" type="bool" /> - <argument index="4" name="layer" type="int" /> - <argument index="5" name="apply_lens_distortion" type="bool" /> - <argument index="6" name="eye_center" type="Vector2" /> - <argument index="7" name="k1" type="float" /> - <argument index="8" name="k2" type="float" /> - <argument index="9" name="upscale" type="float" /> - <argument index="10" name="aspect_ratio" type="float" /> + <param index="0" name="render_target" type="RID" /> + <param index="1" name="src_rect" type="Rect2" /> + <param index="2" name="dst_rect" type="Rect2i" /> + <param index="3" name="use_layer" type="bool" /> + <param index="4" name="layer" type="int" /> + <param index="5" name="apply_lens_distortion" type="bool" /> + <param index="6" name="eye_center" type="Vector2" /> + <param index="7" name="k1" type="float" /> + <param index="8" name="k2" type="float" /> + <param index="9" name="upscale" type="float" /> + <param index="10" name="aspect_ratio" type="float" /> <description> Blits our render results to screen optionally applying lens distortion. This can only be called while processing [code]_commit_views[/code]. </description> </method> <method name="get_render_target_texture"> <return type="RID" /> - <argument index="0" name="render_target" type="RID" /> + <param index="0" name="render_target" type="RID" /> <description> Returns a valid [RID] for a texture to which we should render the current frame if supported by the interface. </description> diff --git a/doc/classes/XRNode3D.xml b/doc/classes/XRNode3D.xml index bb9dccc2e0..21d0d20b3f 100644 --- a/doc/classes/XRNode3D.xml +++ b/doc/classes/XRNode3D.xml @@ -29,11 +29,11 @@ </method> <method name="trigger_haptic_pulse"> <return type="void" /> - <argument index="0" name="action_name" type="String" /> - <argument index="1" name="frequency" type="float" /> - <argument index="2" name="amplitude" type="float" /> - <argument index="3" name="duration_sec" type="float" /> - <argument index="4" name="delay_sec" type="float" /> + <param index="0" name="action_name" type="String" /> + <param index="1" name="frequency" type="float" /> + <param index="2" name="amplitude" type="float" /> + <param index="3" name="duration_sec" type="float" /> + <param index="4" name="delay_sec" type="float" /> <description> Triggers a haptic pulse on a device associated with this interface. [code]action_name[/code] is the name of the action for this pulse. diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml index c146b27fcb..5f116de529 100644 --- a/doc/classes/XRPositionalTracker.xml +++ b/doc/classes/XRPositionalTracker.xml @@ -14,47 +14,47 @@ <methods> <method name="get_input" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns an input for this tracker. It can return a boolean, float or [Vector2] value depending on whether the input is a button, trigger or thumbstick/thumbpad. </description> </method> <method name="get_pose" qualifiers="const"> <return type="XRPose" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the current [XRPose] state object for the bound [code]pose[/code]. </description> </method> <method name="has_pose" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the bound [code]tracker[/code] is available and is currently tracking the bound [code]pose[/code]. </description> </method> <method name="invalidate_pose"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Marks this pose as invalid, we don't clear the last reported state but it allows users to decide if trackers need to be hidden if we loose tracking or just remain at their last known position. </description> </method> <method name="set_input"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Changes the value for the given input. This method is called by a [XRInterface] implementation and should not be used directly. </description> </method> <method name="set_pose"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="transform" type="Transform3D" /> - <argument index="2" name="linear_velocity" type="Vector3" /> - <argument index="3" name="angular_velocity" type="Vector3" /> - <argument index="4" name="tracking_confidence" type="int" enum="XRPose.TrackingConfidence" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="transform" type="Transform3D" /> + <param index="2" name="linear_velocity" type="Vector3" /> + <param index="3" name="angular_velocity" type="Vector3" /> + <param index="4" name="tracking_confidence" type="int" enum="XRPose.TrackingConfidence" /> <description> Sets the transform, linear velocity, angular velocity and tracking confidence for the given pose. This method is called by a [XRInterface] implementation and should not be used directly. </description> @@ -81,39 +81,39 @@ </members> <signals> <signal name="button_pressed"> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Emitted when a button on this tracker is pressed. Note that many XR runtimes allow other inputs to be mapped to buttons. </description> </signal> <signal name="button_released"> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Emitted when a button on this tracker is released. </description> </signal> <signal name="input_axis_changed"> - <argument index="0" name="name" type="String" /> - <argument index="1" name="vector" type="Vector2" /> + <param index="0" name="name" type="String" /> + <param index="1" name="vector" type="Vector2" /> <description> Emitted when a thumbstick or thumbpad on this tracker moves. </description> </signal> <signal name="input_value_changed"> - <argument index="0" name="name" type="String" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="name" type="String" /> + <param index="1" name="value" type="float" /> <description> Emitted when a trigger or similar input on this tracker changes value. </description> </signal> <signal name="pose_changed"> - <argument index="0" name="pose" type="XRPose" /> + <param index="0" name="pose" type="XRPose" /> <description> Emitted when the state of a pose tracked by this tracker changes. </description> </signal> <signal name="profile_changed"> - <argument index="0" name="role" type="String" /> + <param index="0" name="role" type="String" /> <description> Emitted when the profile of our tracker changes. </description> diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index d3cb958cbc..3be252617c 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -12,22 +12,22 @@ <methods> <method name="add_interface"> <return type="void" /> - <argument index="0" name="interface" type="XRInterface" /> + <param index="0" name="interface" type="XRInterface" /> <description> Registers an [XRInterface] object. </description> </method> <method name="add_tracker"> <return type="void" /> - <argument index="0" name="tracker" type="XRPositionalTracker" /> + <param index="0" name="tracker" type="XRPositionalTracker" /> <description> Registers a new [XRPositionalTracker] that tracks a spatial location in real space. </description> </method> <method name="center_on_hmd"> <return type="void" /> - <argument index="0" name="rotation_mode" type="int" enum="XRServer.RotationMode" /> - <argument index="1" name="keep_height" type="bool" /> + <param index="0" name="rotation_mode" type="int" enum="XRServer.RotationMode" /> + <param index="1" name="keep_height" type="bool" /> <description> This is an important function to understand correctly. AR and VR platforms all handle positioning slightly differently. For platforms that do not offer spatial tracking, our origin point (0,0,0) is the location of our HMD, but you have little control over the direction the player is facing in the real world. @@ -39,7 +39,7 @@ </method> <method name="find_interface" qualifiers="const"> <return type="XRInterface" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Finds an interface by its name. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it. </description> @@ -52,7 +52,7 @@ </method> <method name="get_interface" qualifiers="const"> <return type="XRInterface" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Returns the interface registered at a given index in our list of interfaces. </description> @@ -77,28 +77,28 @@ </method> <method name="get_tracker" qualifiers="const"> <return type="XRPositionalTracker" /> - <argument index="0" name="tracker_name" type="StringName" /> + <param index="0" name="tracker_name" type="StringName" /> <description> Returns the positional tracker with this name. </description> </method> <method name="get_trackers"> <return type="Dictionary" /> - <argument index="0" name="tracker_types" type="int" /> + <param index="0" name="tracker_types" type="int" /> <description> Returns a dictionary of trackers for this type. </description> </method> <method name="remove_interface"> <return type="void" /> - <argument index="0" name="interface" type="XRInterface" /> + <param index="0" name="interface" type="XRInterface" /> <description> Removes this interface. </description> </method> <method name="remove_tracker"> <return type="void" /> - <argument index="0" name="tracker" type="XRPositionalTracker" /> + <param index="0" name="tracker" type="XRPositionalTracker" /> <description> Removes this positional tracker. </description> @@ -114,34 +114,34 @@ </members> <signals> <signal name="interface_added"> - <argument index="0" name="interface_name" type="StringName" /> + <param index="0" name="interface_name" type="StringName" /> <description> Emitted when a new interface has been added. </description> </signal> <signal name="interface_removed"> - <argument index="0" name="interface_name" type="StringName" /> + <param index="0" name="interface_name" type="StringName" /> <description> Emitted when an interface is removed. </description> </signal> <signal name="tracker_added"> - <argument index="0" name="tracker_name" type="StringName" /> - <argument index="1" name="type" type="int" /> + <param index="0" name="tracker_name" type="StringName" /> + <param index="1" name="type" type="int" /> <description> Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using [XRAnchor3D]s for an AR solution, it is important to react to this signal to add the appropriate [XRController3D] or [XRAnchor3D] nodes related to this new tracker. </description> </signal> <signal name="tracker_removed"> - <argument index="0" name="tracker_name" type="StringName" /> - <argument index="1" name="type" type="int" /> + <param index="0" name="tracker_name" type="StringName" /> + <param index="1" name="type" type="int" /> <description> Emitted when a tracker is removed. You should remove any [XRController3D] or [XRAnchor3D] points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). </description> </signal> <signal name="tracker_updated"> - <argument index="0" name="tracker_name" type="StringName" /> - <argument index="1" name="type" type="int" /> + <param index="0" name="tracker_name" type="StringName" /> + <param index="1" name="type" type="int" /> <description> Emitted when an existing tracker has been updated. This can happen if the user switches controllers. </description> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 374b703636..d0ef664281 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -100,21 +100,21 @@ </constructor> <constructor name="bool"> <return type="bool" /> - <argument index="0" name="from" type="bool" /> + <param index="0" name="from" type="bool" /> <description> Constructs a [bool] as a copy of the given [bool]. </description> </constructor> <constructor name="bool"> <return type="bool" /> - <argument index="0" name="from" type="float" /> + <param index="0" name="from" type="float" /> <description> Cast a [float] value to a boolean value, this method will return [code]false[/code] if [code]0.0[/code] is passed in, and [code]true[/code] for all other floats. </description> </constructor> <constructor name="bool"> <return type="bool" /> - <argument index="0" name="from" type="int" /> + <param index="0" name="from" type="int" /> <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. </description> @@ -123,28 +123,28 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="bool" /> + <param index="0" name="right" type="bool" /> <description> Returns [code]true[/code] if two bools are different, i.e. one is [code]true[/code] and the other is [code]false[/code]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="bool" /> + <param index="0" name="right" type="bool" /> <description> Returns [code]true[/code] if the left operand is [code]false[/code] and the right operand is [code]true[/code]. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="bool" /> + <param index="0" name="right" type="bool" /> <description> Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code]. </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="bool" /> + <param index="0" name="right" type="bool" /> <description> Returns [code]true[/code] if the left operand is [code]true[/code] and the right operand is [code]false[/code]. </description> diff --git a/doc/classes/float.xml b/doc/classes/float.xml index a7c6533ef5..9d685b9cd0 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -21,21 +21,21 @@ </constructor> <constructor name="float"> <return type="float" /> - <argument index="0" name="from" type="float" /> + <param index="0" name="from" type="float" /> <description> Constructs a [float] as a copy of the given [float]. </description> </constructor> <constructor name="float"> <return type="float" /> - <argument index="0" name="from" type="bool" /> + <param index="0" name="from" type="bool" /> <description> Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. </description> </constructor> <constructor name="float"> <return type="float" /> - <argument index="0" name="from" type="int" /> + <param index="0" name="from" type="int" /> <description> Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to [code]1.0[/code]. </description> @@ -44,21 +44,21 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] if two floats are different from each other. </description> </operator> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] if the integer has different value than the float. </description> </operator> <operator name="operator *"> <return type="Color" /> - <argument index="0" name="right" type="Color" /> + <param index="0" name="right" type="Color" /> <description> Multiplies each component of the [Color] by the given [float]. [codeblock] @@ -68,14 +68,14 @@ </operator> <operator name="operator *"> <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Multiplies each component of the [Quaternion] by the given [float]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Multiplies each component of the [Vector2] by the given [float]. [codeblock] @@ -85,7 +85,7 @@ </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Multiplies each component of the [Vector2i] by the given [float]. Returns a [Vector2]. [codeblock] @@ -95,14 +95,14 @@ </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Multiplies each component of the [Vector3] by the given [float]. </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Multiplies each component of the [Vector3i] by the given [float]. Returns a [Vector3]. [codeblock] @@ -112,115 +112,115 @@ </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> </description> </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator *"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies two [float]s. </description> </operator> <operator name="operator *"> <return type="float" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies a [float] and an [int]. The result is a [float]. </description> </operator> <operator name="operator **"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> </description> </operator> <operator name="operator **"> <return type="float" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> </description> </operator> <operator name="operator +"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Adds two floats. </description> </operator> <operator name="operator +"> <return type="float" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Adds a [float] and an [int]. The result is a [float]. </description> </operator> <operator name="operator -"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Subtracts a float from a float. </description> </operator> <operator name="operator -"> <return type="float" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Subtracts an [int] from a [float]. The result is a [float]. </description> </operator> <operator name="operator /"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides two floats. </description> </operator> <operator name="operator /"> <return type="float" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides a [float] by an [int]. The result is a [float]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is less than the right one. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is less than the given [int]. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left integer is less than or equal to the right one. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is less than or equal to the given [int]. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] if both floats are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method @GlobalScope.is_equal_approx] or [method @GlobalScope.is_zero_approx] instead, which are more reliable. @@ -228,35 +228,35 @@ </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] if the [float] and the given [int] are equal. </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is greater than the right one. </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is greater than the given [int]. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is greater than or equal to the right one. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is greater than or equal to the given [int]. </description> diff --git a/doc/classes/int.xml b/doc/classes/int.xml index 6b492ca923..98c200c114 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -47,21 +47,21 @@ </constructor> <constructor name="int"> <return type="int" /> - <argument index="0" name="from" type="int" /> + <param index="0" name="from" type="int" /> <description> Constructs an [int] as a copy of the given [int]. </description> </constructor> <constructor name="int"> <return type="int" /> - <argument index="0" name="from" type="bool" /> + <param index="0" name="from" type="bool" /> <description> Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. </description> </constructor> <constructor name="int"> <return type="int" /> - <argument index="0" name="from" type="float" /> + <param index="0" name="from" type="float" /> <description> Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds [code]from[/code] towards zero), so for example [code]int(2.7)[/code] will be equals to 2, [code]int(0.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. This operation is also called truncation. </description> @@ -70,21 +70,21 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] if operands are different from each other. </description> </operator> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] if operands are different from each other. </description> </operator> <operator name="operator %"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns the remainder after dividing two integers. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -96,7 +96,7 @@ </operator> <operator name="operator &"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns the result of bitwise [code]AND[/code] operation for two integers. [codeblock] @@ -114,21 +114,21 @@ </operator> <operator name="operator *"> <return type="Color" /> - <argument index="0" name="right" type="Color" /> + <param index="0" name="right" type="Color" /> <description> Multiplies each component of the [Color] by the given [int]. </description> </operator> <operator name="operator *"> <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Multiplies each component of the [Quaternion] by the given [int]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator *"> <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> + <param index="0" name="right" type="Vector2" /> <description> Multiplies each component of the [Vector2] by the given [int]. [codeblock] @@ -138,101 +138,101 @@ </operator> <operator name="operator *"> <return type="Vector2i" /> - <argument index="0" name="right" type="Vector2i" /> + <param index="0" name="right" type="Vector2i" /> <description> Multiplies each component of the [Vector2i] by the given [int]. </description> </operator> <operator name="operator *"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <param index="0" name="right" type="Vector3" /> <description> Multiplies each component of the [Vector3] by the given [int]. </description> </operator> <operator name="operator *"> <return type="Vector3i" /> - <argument index="0" name="right" type="Vector3i" /> + <param index="0" name="right" type="Vector3i" /> <description> Multiplies each component of the [Vector3i] by the given [int]. </description> </operator> <operator name="operator *"> <return type="Vector4" /> - <argument index="0" name="right" type="Vector4" /> + <param index="0" name="right" type="Vector4" /> <description> </description> </operator> <operator name="operator *"> <return type="Vector4i" /> - <argument index="0" name="right" type="Vector4i" /> + <param index="0" name="right" type="Vector4i" /> <description> </description> </operator> <operator name="operator *"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies an [int] and a [float]. The result is a [float]. </description> </operator> <operator name="operator *"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies two [int]s. </description> </operator> <operator name="operator **"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> </description> </operator> <operator name="operator **"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> </description> </operator> <operator name="operator +"> <return type="String" /> - <argument index="0" name="right" type="String" /> + <param index="0" name="right" type="String" /> <description> Adds Unicode character with code [int] to the [String]. </description> </operator> <operator name="operator +"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Adds an [int] and a [float]. The result is a [float]. </description> </operator> <operator name="operator +"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Adds two integers. </description> </operator> <operator name="operator -"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Subtracts a [float] from an [int]. The result is a [float]. </description> </operator> <operator name="operator -"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Subtracts two integers. </description> </operator> <operator name="operator /"> <return type="float" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides an [int] by a [float]. The result is a [float]. [codeblock] @@ -242,7 +242,7 @@ </operator> <operator name="operator /"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides two integers. The decimal part of the result is discarded (truncated). [codeblock] @@ -253,21 +253,21 @@ </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is less than the given [float]. </description> </operator> <operator name="operator <"> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is less than the right one. </description> </operator> <operator name="operator <<"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Performs bitwise shift left operation on the integer. Effectively the same as multiplying by a power of 2. [codeblock] @@ -278,63 +278,63 @@ </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is less than or equal to the given [float]. </description> </operator> <operator name="operator <="> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is less than or equal to the right one. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] if the integer is equal to the given [float]. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] if both integers are equal. </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is greater than the given [float]. </description> </operator> <operator name="operator >"> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is greater than the right one. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is greater than or equal to the given [float]. </description> </operator> <operator name="operator >="> <return type="bool" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is greater than or equal to the right one. </description> </operator> <operator name="operator >>"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Performs bitwise shift right operation on the integer. Effectively the same as dividing by a power of 2. [codeblock] @@ -345,7 +345,7 @@ </operator> <operator name="operator ^"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns the result of bitwise [code]XOR[/code] operation for two integers. [codeblock] @@ -368,7 +368,7 @@ </operator> <operator name="operator |"> <return type="int" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Returns the result of bitwise [code]OR[/code] operation for two integers. [codeblock] diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py index a69c459743..207eb7fabd 100755 --- a/doc/tools/make_rst.py +++ b/doc/tools/make_rst.py @@ -127,7 +127,7 @@ class State: else: return_type = TypeName("void") - params = self.parse_arguments(constructor, "constructor") + params = self.parse_params(constructor, "constructor") desc_element = constructor.find("description") method_desc = None @@ -156,7 +156,7 @@ class State: else: return_type = TypeName("void") - params = self.parse_arguments(method, "method") + params = self.parse_params(method, "method") desc_element = method.find("description") method_desc = None @@ -184,7 +184,7 @@ class State: else: return_type = TypeName("void") - params = self.parse_arguments(operator, "operator") + params = self.parse_params(operator, "operator") desc_element = operator.find("description") method_desc = None @@ -233,7 +233,7 @@ class State: annotation_name = annotation.attrib["name"] qualifiers = annotation.get("qualifiers") - params = self.parse_arguments(annotation, "annotation") + params = self.parse_params(annotation, "annotation") desc_element = annotation.find("description") annotation_desc = None @@ -257,7 +257,7 @@ class State: print_error('{}.xml: Duplicate signal "{}".'.format(class_name, signal_name), self) continue - params = self.parse_arguments(signal, "signal") + params = self.parse_params(signal, "signal") desc_element = signal.find("description") signal_desc = None @@ -307,8 +307,8 @@ class State: self.current_class = "" - def parse_arguments(self, root: ET.Element, context: str) -> List["ParameterDef"]: - param_elements = root.findall("argument") + def parse_params(self, root: ET.Element, context: str) -> List["ParameterDef"]: + param_elements = root.findall("param") params: Any = [None] * len(param_elements) for param_index, param_element in enumerate(param_elements): diff --git a/editor/doc_tools.cpp b/editor/doc_tools.cpp index 46a2a0719a..864871bb7e 100644 --- a/editor/doc_tools.cpp +++ b/editor/doc_tools.cpp @@ -1019,7 +1019,7 @@ static Error _parse_methods(Ref<XMLParser> &parser, Vector<DocData::MethodDoc> & } else if (name == "returns_error") { ERR_FAIL_COND_V(!parser->has_attribute("number"), ERR_FILE_CORRUPT); method.errors_returned.push_back(parser->get_attribute_value("number").to_int()); - } else if (name == "argument") { + } else if (name == "param") { DocData::ArgumentDoc argument; ERR_FAIL_COND_V(!parser->has_attribute("name"), ERR_FILE_CORRUPT); argument.name = parser->get_attribute_value("name"); @@ -1350,9 +1350,9 @@ static void _write_method_doc(Ref<FileAccess> f, const String &p_name, Vector<Do } if (!a.default_value.is_empty()) { - _write_string(f, 3, "<argument index=\"" + itos(j) + "\" name=\"" + a.name.xml_escape() + "\" type=\"" + a.type.xml_escape() + "\"" + enum_text + " default=\"" + a.default_value.xml_escape(true) + "\" />"); + _write_string(f, 3, "<param index=\"" + itos(j) + "\" name=\"" + a.name.xml_escape() + "\" type=\"" + a.type.xml_escape() + "\"" + enum_text + " default=\"" + a.default_value.xml_escape(true) + "\" />"); } else { - _write_string(f, 3, "<argument index=\"" + itos(j) + "\" name=\"" + a.name.xml_escape() + "\" type=\"" + a.type.xml_escape() + "\"" + enum_text + " />"); + _write_string(f, 3, "<param index=\"" + itos(j) + "\" name=\"" + a.name.xml_escape() + "\" type=\"" + a.type.xml_escape() + "\"" + enum_text + " />"); } } diff --git a/modules/csg/doc_classes/CSGShape3D.xml b/modules/csg/doc_classes/CSGShape3D.xml index f1cd28e00f..4fd4a12a1d 100644 --- a/modules/csg/doc_classes/CSGShape3D.xml +++ b/modules/csg/doc_classes/CSGShape3D.xml @@ -13,14 +13,14 @@ <methods> <method name="get_collision_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -39,16 +39,16 @@ </method> <method name="set_collision_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> diff --git a/modules/enet/doc_classes/ENetConnection.xml b/modules/enet/doc_classes/ENetConnection.xml index 14aad0cb39..c9bf1c65e1 100644 --- a/modules/enet/doc_classes/ENetConnection.xml +++ b/modules/enet/doc_classes/ENetConnection.xml @@ -12,31 +12,31 @@ <methods> <method name="bandwidth_limit"> <return type="void" /> - <argument index="0" name="in_bandwidth" type="int" default="0" /> - <argument index="1" name="out_bandwidth" type="int" default="0" /> + <param index="0" name="in_bandwidth" type="int" default="0" /> + <param index="1" name="out_bandwidth" type="int" default="0" /> <description> Adjusts the bandwidth limits of a host. </description> </method> <method name="broadcast"> <return type="void" /> - <argument index="0" name="channel" type="int" /> - <argument index="1" name="packet" type="PackedByteArray" /> - <argument index="2" name="flags" type="int" /> + <param index="0" name="channel" type="int" /> + <param index="1" name="packet" type="PackedByteArray" /> + <param index="2" name="flags" type="int" /> <description> Queues a [code]packet[/code] to be sent to all peers associated with the host over the specified [code]channel[/code]. See [ENetPacketPeer] [code]FLAG_*[/code] constants for available packet flags. </description> </method> <method name="channel_limit"> <return type="void" /> - <argument index="0" name="limit" type="int" /> + <param index="0" name="limit" type="int" /> <description> Limits the maximum allowed channels of future incoming connections. </description> </method> <method name="compress"> <return type="void" /> - <argument index="0" name="mode" type="int" enum="ENetConnection.CompressionMode" /> + <param index="0" name="mode" type="int" enum="ENetConnection.CompressionMode" /> <description> Sets the compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. [b]Note:[/b] Most games' network design involve sending many small packets frequently (smaller than 4 KB each). If in doubt, it is recommended to keep the default compression algorithm as it works best on these small packets. @@ -45,10 +45,10 @@ </method> <method name="connect_to_host"> <return type="ENetPacketPeer" /> - <argument index="0" name="address" type="String" /> - <argument index="1" name="port" type="int" /> - <argument index="2" name="channels" type="int" default="0" /> - <argument index="3" name="data" type="int" default="0" /> + <param index="0" name="address" type="String" /> + <param index="1" name="port" type="int" /> + <param index="2" name="channels" type="int" default="0" /> + <param index="3" name="data" type="int" default="0" /> <description> Initiates a connection to a foreign [code]address[/code] using the specified [code]port[/code] and allocating the requested [code]channels[/code]. Optional [code]data[/code] can be passed during connection in the form of a 32 bit integer. [b]Note:[/b] You must call either [method create_host] or [method create_host_bound] before calling this method. @@ -56,22 +56,22 @@ </method> <method name="create_host"> <return type="int" enum="Error" /> - <argument index="0" name="max_peers" type="int" default="32" /> - <argument index="1" name="max_channels" type="int" default="0" /> - <argument index="2" name="in_bandwidth" type="int" default="0" /> - <argument index="3" name="out_bandwidth" type="int" default="0" /> + <param index="0" name="max_peers" type="int" default="32" /> + <param index="1" name="max_channels" type="int" default="0" /> + <param index="2" name="in_bandwidth" type="int" default="0" /> + <param index="3" name="out_bandwidth" type="int" default="0" /> <description> Create an ENetHost that will allow up to [code]max_peers[/code] connected peers, each allocating up to [code]max_channels[/code] channels, optionally limiting bandwidth to [code]in_bandwidth[/code] and [code]out_bandwidth[/code]. </description> </method> <method name="create_host_bound"> <return type="int" enum="Error" /> - <argument index="0" name="bind_address" type="String" /> - <argument index="1" name="bind_port" type="int" /> - <argument index="2" name="max_peers" type="int" default="32" /> - <argument index="3" name="max_channels" type="int" default="0" /> - <argument index="4" name="in_bandwidth" type="int" default="0" /> - <argument index="5" name="out_bandwidth" type="int" default="0" /> + <param index="0" name="bind_address" type="String" /> + <param index="1" name="bind_port" type="int" /> + <param index="2" name="max_peers" type="int" default="32" /> + <param index="3" name="max_channels" type="int" default="0" /> + <param index="4" name="in_bandwidth" type="int" default="0" /> + <param index="5" name="out_bandwidth" type="int" default="0" /> <description> Create an ENetHost like [method create_host] which is also bound to the given [code]bind_address[/code] and [code]bind_port[/code]. </description> @@ -84,17 +84,17 @@ </method> <method name="dtls_client_setup"> <return type="int" enum="Error" /> - <argument index="0" name="certificate" type="X509Certificate" /> - <argument index="1" name="hostname" type="String" /> - <argument index="2" name="verify" type="bool" default="true" /> + <param index="0" name="certificate" type="X509Certificate" /> + <param index="1" name="hostname" type="String" /> + <param index="2" name="verify" type="bool" default="true" /> <description> Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet clients. Call this before [method connect_to_host] to have ENet connect using DTLS with [code]certificate[/code] and [code]hostname[/code] verification. Verification can be optionally turned off via the [code]verify[/code] parameter. </description> </method> <method name="dtls_server_setup"> <return type="int" enum="Error" /> - <argument index="0" name="key" type="CryptoKey" /> - <argument index="1" name="certificate" type="X509Certificate" /> + <param index="0" name="key" type="CryptoKey" /> + <param index="1" name="certificate" type="X509Certificate" /> <description> Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet servers. Call this right after [method create_host_bound] to have ENet expect peers to connect using DTLS. </description> @@ -126,14 +126,14 @@ </method> <method name="pop_statistic"> <return type="float" /> - <argument index="0" name="statistic" type="int" enum="ENetConnection.HostStatistic" /> + <param index="0" name="statistic" type="int" enum="ENetConnection.HostStatistic" /> <description> Returns and resets host statistics. See [enum HostStatistic] for more info. </description> </method> <method name="refuse_new_connections"> <return type="void" /> - <argument index="0" name="refuse" type="bool" /> + <param index="0" name="refuse" type="bool" /> <description> Configures the DTLS server to automatically drop new connections. [b]Note:[/b] This method is only relevant after calling [method dtls_server_setup]. @@ -141,7 +141,7 @@ </method> <method name="service"> <return type="Array" /> - <argument index="0" name="timeout" type="int" default="0" /> + <param index="0" name="timeout" type="int" default="0" /> <description> Waits for events on the host specified and shuttles packets between the host and its peers. The returned [Array] will have 4 elements. An [enum EventType], the [ENetPacketPeer] which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is [constant EVENT_RECEIVE], the received packet will be queued to the associated [ENetPacketPeer]. Call this function regularly to handle connections, disconnections, and to receive new packets. diff --git a/modules/enet/doc_classes/ENetMultiplayerPeer.xml b/modules/enet/doc_classes/ENetMultiplayerPeer.xml index 2ecf6b4122..5181ae76ce 100644 --- a/modules/enet/doc_classes/ENetMultiplayerPeer.xml +++ b/modules/enet/doc_classes/ENetMultiplayerPeer.xml @@ -14,8 +14,8 @@ <methods> <method name="add_mesh_peer"> <return type="int" enum="Error" /> - <argument index="0" name="peer_id" type="int" /> - <argument index="1" name="host" type="ENetConnection" /> + <param index="0" name="peer_id" type="int" /> + <param index="1" name="host" type="ENetConnection" /> <description> Add a new remote peer with the given [code]peer_id[/code] connected to the given [code]host[/code]. [b]Note:[/b] The [code]host[/code] must have exactly one peer in the [constant ENetPacketPeer.STATE_CONNECTED] state. @@ -23,51 +23,51 @@ </method> <method name="close_connection"> <return type="void" /> - <argument index="0" name="wait_usec" type="int" default="100" /> + <param index="0" name="wait_usec" type="int" default="100" /> <description> Closes the connection. Ignored if no connection is currently established. If this is a server it tries to notify all clients before forcibly disconnecting them. If this is a client it simply closes the connection to the server. </description> </method> <method name="create_client"> <return type="int" enum="Error" /> - <argument index="0" name="address" type="String" /> - <argument index="1" name="port" type="int" /> - <argument index="2" name="channel_count" type="int" default="0" /> - <argument index="3" name="in_bandwidth" type="int" default="0" /> - <argument index="4" name="out_bandwidth" type="int" default="0" /> - <argument index="5" name="local_port" type="int" default="0" /> + <param index="0" name="address" type="String" /> + <param index="1" name="port" type="int" /> + <param index="2" name="channel_count" type="int" default="0" /> + <param index="3" name="in_bandwidth" type="int" default="0" /> + <param index="4" name="out_bandwidth" type="int" default="0" /> + <param index="5" name="local_port" type="int" default="0" /> <description> Create client that connects to a server at [code]address[/code] using specified [code]port[/code]. The given address needs to be either a fully qualified domain name (e.g. [code]"www.example.com"[/code]) or an IP address in IPv4 or IPv6 format (e.g. [code]"192.168.1.1"[/code]). The [code]port[/code] is the port the server is listening on. The [code]channel_count[/code] parameter can be used to specify the number of ENet channels allocated for the connection. The [code]in_bandwidth[/code] and [code]out_bandwidth[/code] parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [constant OK] if a client was created, [constant ERR_ALREADY_IN_USE] if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the client could not be created. If [code]local_port[/code] is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques. </description> </method> <method name="create_mesh"> <return type="int" enum="Error" /> - <argument index="0" name="unique_id" type="int" /> + <param index="0" name="unique_id" type="int" /> <description> Initialize this [MultiplayerPeer] in mesh mode. The provided [code]unique_id[/code] will be used as the local peer network unique ID once assigned as the [member MultiplayerAPI.multiplayer_peer]. In the mesh configuration you will need to set up each new peer manually using [ENetConnection] before calling [method add_mesh_peer]. While this technique is more advanced, it allows for better control over the connection process (e.g. when dealing with NAT punch-through) and for better distribution of the network load (which would otherwise be more taxing on the server). </description> </method> <method name="create_server"> <return type="int" enum="Error" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="max_clients" type="int" default="32" /> - <argument index="2" name="max_channels" type="int" default="0" /> - <argument index="3" name="in_bandwidth" type="int" default="0" /> - <argument index="4" name="out_bandwidth" type="int" default="0" /> + <param index="0" name="port" type="int" /> + <param index="1" name="max_clients" type="int" default="32" /> + <param index="2" name="max_channels" type="int" default="0" /> + <param index="3" name="in_bandwidth" type="int" default="0" /> + <param index="4" name="out_bandwidth" type="int" default="0" /> <description> Create server that listens to connections via [code]port[/code]. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use [method set_bind_ip]. The default IP is the wildcard [code]"*"[/code], which listens on all available interfaces. [code]max_clients[/code] is the maximum number of clients that are allowed at once, any number up to 4095 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see [method create_client]. Returns [constant OK] if a server was created, [constant ERR_ALREADY_IN_USE] if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the server could not be created. </description> </method> <method name="get_peer" qualifiers="const"> <return type="ENetPacketPeer" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the [ENetPacketPeer] associated to the given [code]id[/code]. </description> </method> <method name="set_bind_ip"> <return type="void" /> - <argument index="0" name="ip" type="String" /> + <param index="0" name="ip" type="String" /> <description> The IP used when creating a server. This is set to the wildcard [code]"*"[/code] by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: [code]"192.168.1.1"[/code]. </description> diff --git a/modules/enet/doc_classes/ENetPacketPeer.xml b/modules/enet/doc_classes/ENetPacketPeer.xml index 5de5a60853..46008317a2 100644 --- a/modules/enet/doc_classes/ENetPacketPeer.xml +++ b/modules/enet/doc_classes/ENetPacketPeer.xml @@ -26,7 +26,7 @@ </method> <method name="get_statistic"> <return type="float" /> - <argument index="0" name="statistic" type="int" enum="ENetPacketPeer.PeerStatistic" /> + <param index="0" name="statistic" type="int" enum="ENetPacketPeer.PeerStatistic" /> <description> Returns the requested [code]statistic[/code] for this peer. See [enum PeerStatistic]. </description> @@ -39,21 +39,21 @@ </method> <method name="peer_disconnect"> <return type="void" /> - <argument index="0" name="data" type="int" default="0" /> + <param index="0" name="data" type="int" default="0" /> <description> Request a disconnection from a peer. An [constant ENetConnection.EVENT_DISCONNECT] will be generated during [method ENetConnection.service] once the disconnection is complete. </description> </method> <method name="peer_disconnect_later"> <return type="void" /> - <argument index="0" name="data" type="int" default="0" /> + <param index="0" name="data" type="int" default="0" /> <description> Request a disconnection from a peer, but only after all queued outgoing packets are sent. An [constant ENetConnection.EVENT_DISCONNECT] will be generated during [method ENetConnection.service] once the disconnection is complete. </description> </method> <method name="peer_disconnect_now"> <return type="void" /> - <argument index="0" name="data" type="int" default="0" /> + <param index="0" name="data" type="int" default="0" /> <description> Force an immediate disconnection from a peer. No [constant ENetConnection.EVENT_DISCONNECT] will be generated. The foreign peer is not guaranteed to receive the disconnect notification, and is reset immediately upon return from this function. </description> @@ -66,7 +66,7 @@ </method> <method name="ping_interval"> <return type="void" /> - <argument index="0" name="ping_interval" type="int" /> + <param index="0" name="ping_interval" type="int" /> <description> Sets the [code]ping_interval[/code] in milliseconds at which pings will be sent to a peer. Pings are used both to monitor the liveness of the connection and also to dynamically adjust the throttle during periods of low traffic so that the throttle has reasonable responsiveness during traffic spikes. </description> @@ -79,18 +79,18 @@ </method> <method name="send"> <return type="int" enum="Error" /> - <argument index="0" name="channel" type="int" /> - <argument index="1" name="packet" type="PackedByteArray" /> - <argument index="2" name="flags" type="int" /> + <param index="0" name="channel" type="int" /> + <param index="1" name="packet" type="PackedByteArray" /> + <param index="2" name="flags" type="int" /> <description> Queues a [code]packet[/code] to be sent over the specified [code]channel[/code]. See [code]FLAG_*[/code] constants for available packet flags. </description> </method> <method name="set_timeout"> <return type="void" /> - <argument index="0" name="timeout" type="int" /> - <argument index="1" name="timeout_min" type="int" /> - <argument index="2" name="timeout_max" type="int" /> + <param index="0" name="timeout" type="int" /> + <param index="1" name="timeout_min" type="int" /> + <param index="2" name="timeout_max" type="int" /> <description> Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds. The [code]timeout_limit[/code] is a factor that, multiplied by a value based on the average round trip time, will determine the timeout limit for a reliable packet. When that limit is reached, the timeout will be doubled, and the peer will be disconnected if that limit has reached [code]timeout_min[/code]. The [code]timeout_max[/code] parameter, on the other hand, defines a fixed timeout for which any packet must be acknowledged or the peer will be dropped. @@ -98,9 +98,9 @@ </method> <method name="throttle_configure"> <return type="void" /> - <argument index="0" name="interval" type="int" /> - <argument index="1" name="acceleration" type="int" /> - <argument index="2" name="deceleration" type="int" /> + <param index="0" name="interval" type="int" /> + <param index="1" name="acceleration" type="int" /> + <param index="2" name="deceleration" type="int" /> <description> Configures throttle parameter for a peer. Unreliable packets are dropped by ENet in response to the varying conditions of the Internet connection to the peer. The throttle represents a probability that an unreliable packet should not be dropped and thus sent by ENet to the peer. By measuring fluctuations in round trip times of reliable packets over the specified [code]interval[/code], ENet will either increase the probably by the amount specified in the [code]acceleration[/code] parameter, or decrease it by the amount specified in the [code]deceleration[/code] parameter (both are ratios to [constant PACKET_THROTTLE_SCALE]). diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index 8ca65f0004..4fbf8c6936 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -12,10 +12,10 @@ <methods> <method name="Color8"> <return type="Color" /> - <argument index="0" name="r8" type="int" /> - <argument index="1" name="g8" type="int" /> - <argument index="2" name="b8" type="int" /> - <argument index="3" name="a8" type="int" default="255" /> + <param index="0" name="r8" type="int" /> + <param index="1" name="g8" type="int" /> + <param index="2" name="b8" type="int" /> + <param index="3" name="a8" type="int" default="255" /> <description> Returns a color constructed from integer red, green, blue, and alpha channels. Each channel should have 8 bits of information ranging from 0 to 255. [code]r8[/code] red channel @@ -29,8 +29,8 @@ </method> <method name="assert"> <return type="void" /> - <argument index="0" name="condition" type="bool" /> - <argument index="1" name="message" type="String" default="""" /> + <param index="0" name="condition" type="bool" /> + <param index="1" name="message" type="String" default="""" /> <description> Asserts that the [code]condition[/code] is [code]true[/code]. If the [code]condition[/code] is [code]false[/code], an error is generated. When running from the editor, the running project will also be paused until you resume it. This can be used as a stronger form of [method @GlobalScope.push_error] for reporting errors to project developers or add-on users. [b]Note:[/b] For performance reasons, the code inside [method assert] is only executed in debug builds or when running the project from the editor. Don't include code that has side effects in an [method assert] call. Otherwise, the project will behave differently when exported in release mode. @@ -47,7 +47,7 @@ </method> <method name="char"> <return type="String" /> - <argument index="0" name="char" type="int" /> + <param index="0" name="char" type="int" /> <description> Returns a character as a String of the given Unicode code point (which is compatible with ASCII code). [codeblock] @@ -59,8 +59,8 @@ </method> <method name="convert"> <return type="Variant" /> - <argument index="0" name="what" type="Variant" /> - <argument index="1" name="type" type="int" /> + <param index="0" name="what" type="Variant" /> + <param index="1" name="type" type="int" /> <description> Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the [enum Variant.Type] values. [codeblock] @@ -75,7 +75,7 @@ </method> <method name="dict2inst"> <return type="Object" /> - <argument index="0" name="dictionary" type="Dictionary" /> + <param index="0" name="dictionary" type="Dictionary" /> <description> Converts a dictionary (previously created with [method inst2dict]) back to an instance. Useful for deserializing. </description> @@ -103,7 +103,7 @@ </method> <method name="inst2dict"> <return type="Dictionary" /> - <argument index="0" name="instance" type="Object" /> + <param index="0" name="instance" type="Object" /> <description> Returns the passed instance converted to a dictionary (useful for serializing). [codeblock] @@ -122,7 +122,7 @@ </method> <method name="len"> <return type="int" /> - <argument index="0" name="var" type="Variant" /> + <param index="0" name="var" type="Variant" /> <description> Returns length of Variant [code]var[/code]. Length is the character count of String, element count of Array, size of Dictionary, etc. [b]Note:[/b] Generates a fatal error if Variant can not provide a length. @@ -134,7 +134,7 @@ </method> <method name="load"> <return type="Resource" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Loads a resource from the filesystem located at [code]path[/code]. The resource is loaded on the method call (unless it's referenced already elsewhere, e.g. in another script or in the scene), which might cause slight delay, especially when loading scenes. To avoid unnecessary delays when loading something multiple times, either store the resource in a variable or use [method preload]. [b]Note:[/b] Resource paths can be obtained by right-clicking on a resource in the FileSystem dock and choosing "Copy Path" or by dragging the file from the FileSystem dock into the script. @@ -149,7 +149,7 @@ </method> <method name="preload"> <return type="Resource" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns a [Resource] from the filesystem located at [code]path[/code]. The resource is loaded during script parsing, i.e. is loaded with the script and [method preload] effectively acts as a reference to that resource. Note that the method requires a constant path. If you want to load a resource from a dynamic/variable path, use [method load]. [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path" or by dragging the file from the FileSystem dock into the script. @@ -237,7 +237,7 @@ </method> <method name="type_exists"> <return type="bool" /> - <argument index="0" name="type" type="StringName" /> + <param index="0" name="type" type="StringName" /> <description> Returns whether the given [Object]-derived class exists in [ClassDB]. Note that [Variant] data types are not registered in [ClassDB]. [codeblock] @@ -271,7 +271,7 @@ </annotation> <annotation name="@export_category"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> </description> </annotation> @@ -287,25 +287,25 @@ </annotation> <annotation name="@export_enum" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="names" type="String" /> + <param index="0" name="names" type="String" /> <description> </description> </annotation> <annotation name="@export_exp_easing" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="hints" type="String" default="""" /> + <param index="0" name="hints" type="String" default="""" /> <description> </description> </annotation> <annotation name="@export_file" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="filter" type="String" default="""" /> + <param index="0" name="filter" type="String" default="""" /> <description> </description> </annotation> <annotation name="@export_flags" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="names" type="String" /> + <param index="0" name="names" type="String" /> <description> </description> </annotation> @@ -346,14 +346,14 @@ </annotation> <annotation name="@export_global_file" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="filter" type="String" default="""" /> + <param index="0" name="filter" type="String" default="""" /> <description> </description> </annotation> <annotation name="@export_group"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="prefix" type="String" default="""" /> + <param index="0" name="name" type="String" /> + <param index="1" name="prefix" type="String" default="""" /> <description> </description> </annotation> @@ -364,7 +364,7 @@ </annotation> <annotation name="@export_node_path" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="type" type="String" default="""" /> + <param index="0" name="type" type="String" default="""" /> <description> </description> </annotation> @@ -375,23 +375,23 @@ </annotation> <annotation name="@export_range" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="min" type="float" /> - <argument index="1" name="max" type="float" /> - <argument index="2" name="step" type="float" default="1.0" /> - <argument index="3" name="extra_hints" type="String" default="""" /> + <param index="0" name="min" type="float" /> + <param index="1" name="max" type="float" /> + <param index="2" name="step" type="float" default="1.0" /> + <param index="3" name="extra_hints" type="String" default="""" /> <description> </description> </annotation> <annotation name="@export_subgroup"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="prefix" type="String" default="""" /> + <param index="0" name="name" type="String" /> + <param index="1" name="prefix" type="String" default="""" /> <description> </description> </annotation> <annotation name="@icon"> <return type="void" /> - <argument index="0" name="icon_path" type="String" /> + <param index="0" name="icon_path" type="String" /> <description> </description> </annotation> @@ -402,10 +402,10 @@ </annotation> <annotation name="@rpc" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="mode" type="String" default="""" /> - <argument index="1" name="sync" type="String" default="""" /> - <argument index="2" name="transfer_mode" type="String" default="""" /> - <argument index="3" name="transfer_channel" type="int" default="0" /> + <param index="0" name="mode" type="String" default="""" /> + <param index="1" name="sync" type="String" default="""" /> + <param index="2" name="transfer_mode" type="String" default="""" /> + <param index="3" name="transfer_channel" type="int" default="0" /> <description> </description> </annotation> @@ -416,7 +416,7 @@ </annotation> <annotation name="@warning_ignore" qualifiers="vararg"> <return type="void" /> - <argument index="0" name="warning" type="String" /> + <param index="0" name="warning" type="String" /> <description> </description> </annotation> diff --git a/modules/gltf/doc_classes/GLTFDocument.xml b/modules/gltf/doc_classes/GLTFDocument.xml index cb0e3b6754..3cd0f5c0f9 100644 --- a/modules/gltf/doc_classes/GLTFDocument.xml +++ b/modules/gltf/doc_classes/GLTFDocument.xml @@ -10,50 +10,50 @@ <methods> <method name="append_from_buffer"> <return type="int" enum="Error" /> - <argument index="0" name="bytes" type="PackedByteArray" /> - <argument index="1" name="base_path" type="String" /> - <argument index="2" name="state" type="GLTFState" /> - <argument index="3" name="flags" type="int" default="0" /> - <argument index="4" name="bake_fps" type="int" default="30" /> + <param index="0" name="bytes" type="PackedByteArray" /> + <param index="1" name="base_path" type="String" /> + <param index="2" name="state" type="GLTFState" /> + <param index="3" name="flags" type="int" default="0" /> + <param index="4" name="bake_fps" type="int" default="30" /> <description> </description> </method> <method name="append_from_file"> <return type="int" enum="Error" /> - <argument index="0" name="path" type="String" /> - <argument index="1" name="state" type="GLTFState" /> - <argument index="2" name="flags" type="int" default="0" /> - <argument index="3" name="bake_fps" type="int" default="30" /> - <argument index="4" name="base_path" type="String" default="""" /> + <param index="0" name="path" type="String" /> + <param index="1" name="state" type="GLTFState" /> + <param index="2" name="flags" type="int" default="0" /> + <param index="3" name="bake_fps" type="int" default="30" /> + <param index="4" name="base_path" type="String" default="""" /> <description> </description> </method> <method name="append_from_scene"> <return type="int" enum="Error" /> - <argument index="0" name="node" type="Node" /> - <argument index="1" name="state" type="GLTFState" /> - <argument index="2" name="flags" type="int" default="0" /> - <argument index="3" name="bake_fps" type="int" default="30" /> + <param index="0" name="node" type="Node" /> + <param index="1" name="state" type="GLTFState" /> + <param index="2" name="flags" type="int" default="0" /> + <param index="3" name="bake_fps" type="int" default="30" /> <description> </description> </method> <method name="generate_buffer"> <return type="PackedByteArray" /> - <argument index="0" name="state" type="GLTFState" /> + <param index="0" name="state" type="GLTFState" /> <description> </description> </method> <method name="generate_scene"> <return type="Node" /> - <argument index="0" name="state" type="GLTFState" /> - <argument index="1" name="bake_fps" type="int" default="30" /> + <param index="0" name="state" type="GLTFState" /> + <param index="1" name="bake_fps" type="int" default="30" /> <description> </description> </method> <method name="write_to_filesystem"> <return type="int" enum="Error" /> - <argument index="0" name="state" type="GLTFState" /> - <argument index="1" name="path" type="String" /> + <param index="0" name="state" type="GLTFState" /> + <param index="1" name="path" type="String" /> <description> </description> </method> diff --git a/modules/gltf/doc_classes/GLTFDocumentExtension.xml b/modules/gltf/doc_classes/GLTFDocumentExtension.xml index 3c28546ad7..d2a9022445 100644 --- a/modules/gltf/doc_classes/GLTFDocumentExtension.xml +++ b/modules/gltf/doc_classes/GLTFDocumentExtension.xml @@ -9,50 +9,50 @@ <methods> <method name="_export_node" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="state" type="GLTFState" /> - <argument index="1" name="gltf_node" type="GLTFNode" /> - <argument index="2" name="json" type="Dictionary" /> - <argument index="3" name="node" type="Node" /> + <param index="0" name="state" type="GLTFState" /> + <param index="1" name="gltf_node" type="GLTFNode" /> + <param index="2" name="json" type="Dictionary" /> + <param index="3" name="node" type="Node" /> <description> </description> </method> <method name="_export_post" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="state" type="GLTFState" /> + <param index="0" name="state" type="GLTFState" /> <description> </description> </method> <method name="_export_preflight" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="root" type="Node" /> + <param index="0" name="root" type="Node" /> <description> </description> </method> <method name="_import_node" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="state" type="GLTFState" /> - <argument index="1" name="gltf_node" type="GLTFNode" /> - <argument index="2" name="json" type="Dictionary" /> - <argument index="3" name="node" type="Node" /> + <param index="0" name="state" type="GLTFState" /> + <param index="1" name="gltf_node" type="GLTFNode" /> + <param index="2" name="json" type="Dictionary" /> + <param index="3" name="node" type="Node" /> <description> </description> </method> <method name="_import_post" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="state" type="GLTFState" /> - <argument index="1" name="root" type="Node" /> + <param index="0" name="state" type="GLTFState" /> + <param index="1" name="root" type="Node" /> <description> </description> </method> <method name="_import_post_parse" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="state" type="GLTFState" /> + <param index="0" name="state" type="GLTFState" /> <description> </description> </method> <method name="_import_preflight" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="state" type="GLTFState" /> + <param index="0" name="state" type="GLTFState" /> <description> </description> </method> diff --git a/modules/gltf/doc_classes/GLTFSkeleton.xml b/modules/gltf/doc_classes/GLTFSkeleton.xml index dad985e886..e1276d0e21 100644 --- a/modules/gltf/doc_classes/GLTFSkeleton.xml +++ b/modules/gltf/doc_classes/GLTFSkeleton.xml @@ -9,7 +9,7 @@ <methods> <method name="get_bone_attachment"> <return type="BoneAttachment3D" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> @@ -35,13 +35,13 @@ </method> <method name="set_godot_bone_node"> <return type="void" /> - <argument index="0" name="godot_bone_node" type="Dictionary" /> + <param index="0" name="godot_bone_node" type="Dictionary" /> <description> </description> </method> <method name="set_unique_names"> <return type="void" /> - <argument index="0" name="unique_names" type="Array" /> + <param index="0" name="unique_names" type="Array" /> <description> </description> </method> diff --git a/modules/gltf/doc_classes/GLTFSkin.xml b/modules/gltf/doc_classes/GLTFSkin.xml index b6a2bdb957..5abdf33360 100644 --- a/modules/gltf/doc_classes/GLTFSkin.xml +++ b/modules/gltf/doc_classes/GLTFSkin.xml @@ -24,19 +24,19 @@ </method> <method name="set_inverse_binds"> <return type="void" /> - <argument index="0" name="inverse_binds" type="Array" /> + <param index="0" name="inverse_binds" type="Array" /> <description> </description> </method> <method name="set_joint_i_to_bone_i"> <return type="void" /> - <argument index="0" name="joint_i_to_bone_i" type="Dictionary" /> + <param index="0" name="joint_i_to_bone_i" type="Dictionary" /> <description> </description> </method> <method name="set_joint_i_to_name"> <return type="void" /> - <argument index="0" name="joint_i_to_name" type="Dictionary" /> + <param index="0" name="joint_i_to_name" type="Dictionary" /> <description> </description> </method> diff --git a/modules/gltf/doc_classes/GLTFState.xml b/modules/gltf/doc_classes/GLTFState.xml index 44a1723563..a168e6108f 100644 --- a/modules/gltf/doc_classes/GLTFState.xml +++ b/modules/gltf/doc_classes/GLTFState.xml @@ -14,13 +14,13 @@ </method> <method name="get_animation_player"> <return type="AnimationPlayer" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> <method name="get_animation_players_count"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> @@ -66,7 +66,7 @@ </method> <method name="get_scene_node"> <return type="Node" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> @@ -102,91 +102,91 @@ </method> <method name="set_accessors"> <return type="void" /> - <argument index="0" name="accessors" type="Array" /> + <param index="0" name="accessors" type="Array" /> <description> </description> </method> <method name="set_animations"> <return type="void" /> - <argument index="0" name="animations" type="Array" /> + <param index="0" name="animations" type="Array" /> <description> </description> </method> <method name="set_buffer_views"> <return type="void" /> - <argument index="0" name="buffer_views" type="Array" /> + <param index="0" name="buffer_views" type="Array" /> <description> </description> </method> <method name="set_cameras"> <return type="void" /> - <argument index="0" name="cameras" type="Array" /> + <param index="0" name="cameras" type="Array" /> <description> </description> </method> <method name="set_images"> <return type="void" /> - <argument index="0" name="images" type="Array" /> + <param index="0" name="images" type="Array" /> <description> </description> </method> <method name="set_lights"> <return type="void" /> - <argument index="0" name="lights" type="Array" /> + <param index="0" name="lights" type="Array" /> <description> </description> </method> <method name="set_materials"> <return type="void" /> - <argument index="0" name="materials" type="Array" /> + <param index="0" name="materials" type="Array" /> <description> </description> </method> <method name="set_meshes"> <return type="void" /> - <argument index="0" name="meshes" type="Array" /> + <param index="0" name="meshes" type="Array" /> <description> </description> </method> <method name="set_nodes"> <return type="void" /> - <argument index="0" name="nodes" type="Array" /> + <param index="0" name="nodes" type="Array" /> <description> </description> </method> <method name="set_skeleton_to_node"> <return type="void" /> - <argument index="0" name="skeleton_to_node" type="Dictionary" /> + <param index="0" name="skeleton_to_node" type="Dictionary" /> <description> </description> </method> <method name="set_skeletons"> <return type="void" /> - <argument index="0" name="skeletons" type="Array" /> + <param index="0" name="skeletons" type="Array" /> <description> </description> </method> <method name="set_skins"> <return type="void" /> - <argument index="0" name="skins" type="Array" /> + <param index="0" name="skins" type="Array" /> <description> </description> </method> <method name="set_textures"> <return type="void" /> - <argument index="0" name="textures" type="Array" /> + <param index="0" name="textures" type="Array" /> <description> </description> </method> <method name="set_unique_animation_names"> <return type="void" /> - <argument index="0" name="unique_animation_names" type="Array" /> + <param index="0" name="unique_animation_names" type="Array" /> <description> </description> </method> <method name="set_unique_names"> <return type="void" /> - <argument index="0" name="unique_names" type="Array" /> + <param index="0" name="unique_names" type="Array" /> <description> </description> </method> diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index 499f54e3ba..5552b5b009 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -29,7 +29,7 @@ </method> <method name="get_bake_mesh_instance"> <return type="RID" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> </description> </method> @@ -41,28 +41,28 @@ </method> <method name="get_cell_item" qualifiers="const"> <return type="int" /> - <argument index="0" name="position" type="Vector3i" /> + <param index="0" name="position" type="Vector3i" /> <description> The [MeshLibrary] item index located at the given grid coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned. </description> </method> <method name="get_cell_item_orientation" qualifiers="const"> <return type="int" /> - <argument index="0" name="position" type="Vector3i" /> + <param index="0" name="position" type="Vector3i" /> <description> The orientation of the cell at the given grid coordinates. [code]-1[/code] is returned if the cell is empty. </description> </method> <method name="get_collision_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="get_collision_mask_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -75,7 +75,7 @@ </method> <method name="get_navigation_layer_value" qualifiers="const"> <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> + <param index="0" name="layer_number" type="int" /> <description> Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. </description> @@ -88,36 +88,36 @@ </method> <method name="get_used_cells_by_item" qualifiers="const"> <return type="Array" /> - <argument index="0" name="item" type="int" /> + <param index="0" name="item" type="int" /> <description> Returns an array of all cells with the given item index specified in [code]item[/code]. </description> </method> <method name="make_baked_meshes"> <return type="void" /> - <argument index="0" name="gen_lightmap_uv" type="bool" default="false" /> - <argument index="1" name="lightmap_uv_texel_size" type="float" default="0.1" /> + <param index="0" name="gen_lightmap_uv" type="bool" default="false" /> + <param index="1" name="lightmap_uv_texel_size" type="float" default="0.1" /> <description> </description> </method> <method name="map_to_world" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="map_position" type="Vector3i" /> + <param index="0" name="map_position" type="Vector3i" /> <description> Returns the position of a grid cell in the GridMap's local coordinate space. </description> </method> <method name="resource_changed"> <return type="void" /> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> </description> </method> <method name="set_cell_item"> <return type="void" /> - <argument index="0" name="position" type="Vector3i" /> - <argument index="1" name="item" type="int" /> - <argument index="2" name="orientation" type="int" default="0" /> + <param index="0" name="position" type="Vector3i" /> + <param index="1" name="item" type="int" /> + <param index="2" name="orientation" type="int" default="0" /> <description> Sets the mesh index for the cell referenced by its grid coordinates. A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell. @@ -126,31 +126,31 @@ </method> <method name="set_collision_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_collision_mask_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="set_navigation_layer_value"> <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> + <param index="0" name="layer_number" type="int" /> + <param index="1" name="value" type="bool" /> <description> Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. </description> </method> <method name="world_to_map" qualifiers="const"> <return type="Vector3i" /> - <argument index="0" name="world_position" type="Vector3" /> + <param index="0" name="world_position" type="Vector3" /> <description> Returns the coordinates of the grid cell containing the given point. [code]pos[/code] should be in the GridMap's local coordinate space. @@ -200,7 +200,7 @@ </members> <signals> <signal name="cell_size_changed"> - <argument index="0" name="cell_size" type="Vector3" /> + <param index="0" name="cell_size" type="Vector3" /> <description> Emitted when [member cell_size] changes. </description> diff --git a/modules/mono/doc_classes/GodotSharp.xml b/modules/mono/doc_classes/GodotSharp.xml index 9de6b48e9e..b981542801 100644 --- a/modules/mono/doc_classes/GodotSharp.xml +++ b/modules/mono/doc_classes/GodotSharp.xml @@ -38,7 +38,7 @@ </method> <method name="is_domain_finalizing_for_unload"> <return type="bool" /> - <argument index="0" name="domain_id" type="int" /> + <param index="0" name="domain_id" type="int" /> <description> Returns [code]true[/code] if the domain is being finalized, [code]false[/code] otherwise. </description> diff --git a/modules/multiplayer/doc_classes/MultiplayerSpawner.xml b/modules/multiplayer/doc_classes/MultiplayerSpawner.xml index 881796ed26..c0265c9161 100644 --- a/modules/multiplayer/doc_classes/MultiplayerSpawner.xml +++ b/modules/multiplayer/doc_classes/MultiplayerSpawner.xml @@ -14,7 +14,7 @@ <methods> <method name="_spawn_custom" qualifiers="virtual"> <return type="Node" /> - <argument index="0" name="data" type="Variant" /> + <param index="0" name="data" type="Variant" /> <description> Method called on all peers when a custom spawn was requested by the authority using [method spawn]. Should return a [Node] that is not in the scene tree. @@ -23,7 +23,7 @@ </method> <method name="add_spawnable_scene"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Adds a scene path to spawnable scenes, making it automatically replicated from the multiplayer authority to other peers when added as children of the node pointed by [member spawn_path]. </description> @@ -36,7 +36,7 @@ </method> <method name="get_spawnable_scene" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the spawnable scene path by index. </description> @@ -49,7 +49,7 @@ </method> <method name="spawn"> <return type="Node" /> - <argument index="0" name="data" type="Variant" default="null" /> + <param index="0" name="data" type="Variant" default="null" /> <description> Requests a custom spawn, with [code]data[/code] passed to [method _spawn_custom] on all peers. Returns the locally spawned node instance already inside the scene tree, and added as a child of the node pointed by [member spawn_path]. @@ -69,13 +69,13 @@ </members> <signals> <signal name="despawned"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted when a spawnable scene or custom spawn was despawned by the multiplayer authority. Only called on puppets. </description> </signal> <signal name="spawned"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted when a spawnable scene or custom spawn was spawned by the multiplayer authority. Only called on puppets. </description> diff --git a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml index a2ea64061c..9a4d755d64 100644 --- a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml +++ b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml @@ -16,7 +16,7 @@ <methods> <method name="add_visibility_filter"> <return type="void" /> - <argument index="0" name="filter" type="Callable" /> + <param index="0" name="filter" type="Callable" /> <description> Adds a peer visibility filter for this synchronizer. @@ -25,29 +25,29 @@ </method> <method name="get_visibility_for" qualifiers="const"> <return type="bool" /> - <argument index="0" name="peer" type="int" /> + <param index="0" name="peer" type="int" /> <description> Queries the current visibility for peer [code]peer[/code]. </description> </method> <method name="remove_visibility_filter"> <return type="void" /> - <argument index="0" name="filter" type="Callable" /> + <param index="0" name="filter" type="Callable" /> <description> Removes a peer visiblity filter from this synchronizer. </description> </method> <method name="set_visibility_for"> <return type="void" /> - <argument index="0" name="peer" type="int" /> - <argument index="1" name="visible" type="bool" /> + <param index="0" name="peer" type="int" /> + <param index="1" name="visible" type="bool" /> <description> Sets the visibility of [code]peer[/code] to [code]visible[/code]. If [code]peer[/code] is [code]0[/code], the value of [member public_visibility] will be updated instead. </description> </method> <method name="update_visibility"> <return type="void" /> - <argument index="0" name="for_peer" type="int" default="0" /> + <param index="0" name="for_peer" type="int" default="0" /> <description> Updates the visibility of [code]peer[/code] according to visibility filters. If [code]peer[/code] is [code]0[/code] (the default), all peers' visibilties are updated. </description> @@ -73,7 +73,7 @@ </members> <signals> <signal name="visibility_changed"> - <argument index="0" name="for_peer" type="int" /> + <param index="0" name="for_peer" type="int" /> <description> Emitted when visibility of [code]for_peer[/code] is updated. See [method update_visibility]. </description> diff --git a/modules/multiplayer/doc_classes/SceneMultiplayer.xml b/modules/multiplayer/doc_classes/SceneMultiplayer.xml index 0c3ed2d784..62bb396d15 100644 --- a/modules/multiplayer/doc_classes/SceneMultiplayer.xml +++ b/modules/multiplayer/doc_classes/SceneMultiplayer.xml @@ -21,10 +21,10 @@ </method> <method name="send_bytes"> <return type="int" enum="Error" /> - <argument index="0" name="bytes" type="PackedByteArray" /> - <argument index="1" name="id" type="int" default="0" /> - <argument index="2" name="mode" type="int" enum="MultiplayerPeer.TransferMode" default="2" /> - <argument index="3" name="channel" type="int" default="0" /> + <param index="0" name="bytes" type="PackedByteArray" /> + <param index="1" name="id" type="int" default="0" /> + <param index="2" name="mode" type="int" enum="MultiplayerPeer.TransferMode" default="2" /> + <param index="3" name="channel" type="int" default="0" /> <description> Sends the given raw [code]bytes[/code] to a specific peer identified by [code]id[/code] (see [method MultiplayerPeer.set_target_peer]). Default ID is [code]0[/code], i.e. broadcast to all peers. </description> @@ -45,8 +45,8 @@ </members> <signals> <signal name="peer_packet"> - <argument index="0" name="id" type="int" /> - <argument index="1" name="packet" type="PackedByteArray" /> + <param index="0" name="id" type="int" /> + <param index="1" name="packet" type="PackedByteArray" /> <description> Emitted when this MultiplayerAPI's [member MultiplayerAPI.multiplayer_peer] receives a [code]packet[/code] with custom data (see [method send_bytes]). ID is the peer ID of the peer that sent the packet. </description> diff --git a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml index fc91592c7a..fdc441e9c3 100644 --- a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml +++ b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml @@ -10,8 +10,8 @@ <methods> <method name="add_property"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="index" type="int" default="-1" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="index" type="int" default="-1" /> <description> Adds the property identified by the given [code]path[/code] to the list of the properties being synchronized, optionally passing an [code]index[/code]. </description> @@ -24,51 +24,51 @@ </method> <method name="has_property" qualifiers="const"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns whether the given [code]path[/code] is configured for synchronization. </description> </method> <method name="property_get_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Finds the index of the given [code]path[/code]. </description> </method> <method name="property_get_spawn"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn. </description> </method> <method name="property_get_sync"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on process. </description> </method> <method name="property_set_spawn"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="enabled" type="bool" /> <description> Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn. </description> </method> <method name="property_set_sync"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="enabled" type="bool" /> <description> Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on process. </description> </method> <method name="remove_property"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Removes the property identified by the given [code]path[/code] from the configuration. </description> diff --git a/modules/noise/doc_classes/Noise.xml b/modules/noise/doc_classes/Noise.xml index 5af204575c..735ca388de 100644 --- a/modules/noise/doc_classes/Noise.xml +++ b/modules/noise/doc_classes/Noise.xml @@ -13,59 +13,59 @@ <methods> <method name="get_image" qualifiers="const"> <return type="Image" /> - <argument index="0" name="width" type="int" /> - <argument index="1" name="height" type="int" /> - <argument index="2" name="invert" type="bool" default="false" /> - <argument index="3" name="in_3d_space" type="bool" default="false" /> + <param index="0" name="width" type="int" /> + <param index="1" name="height" type="int" /> + <param index="2" name="invert" type="bool" default="false" /> + <param index="3" name="in_3d_space" type="bool" default="false" /> <description> Returns a 2D [Image] noise image. </description> </method> <method name="get_noise_1d" qualifiers="const"> <return type="float" /> - <argument index="0" name="x" type="float" /> + <param index="0" name="x" type="float" /> <description> Returns the 1D noise value at the given (x) coordinate. </description> </method> <method name="get_noise_2d" qualifiers="const"> <return type="float" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> <description> Returns the 2D noise value at the given position. </description> </method> <method name="get_noise_2dv" qualifiers="const"> <return type="float" /> - <argument index="0" name="v" type="Vector2" /> + <param index="0" name="v" type="Vector2" /> <description> Returns the 2D noise value at the given position. </description> </method> <method name="get_noise_3d" qualifiers="const"> <return type="float" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> - <argument index="2" name="z" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> + <param index="2" name="z" type="float" /> <description> Returns the 3D noise value at the given position. </description> </method> <method name="get_noise_3dv" qualifiers="const"> <return type="float" /> - <argument index="0" name="v" type="Vector3" /> + <param index="0" name="v" type="Vector3" /> <description> Returns the 3D noise value at the given position. </description> </method> <method name="get_seamless_image" qualifiers="const"> <return type="Image" /> - <argument index="0" name="width" type="int" /> - <argument index="1" name="height" type="int" /> - <argument index="2" name="invert" type="bool" default="false" /> - <argument index="3" name="in_3d_space" type="bool" default="false" /> - <argument index="4" name="skirt" type="float" default="0.1" /> + <param index="0" name="width" type="int" /> + <param index="1" name="height" type="int" /> + <param index="2" name="invert" type="bool" default="false" /> + <param index="3" name="in_3d_space" type="bool" default="false" /> + <param index="4" name="skirt" type="float" default="0.1" /> <description> Returns a seamless 2D [Image] noise image. </description> diff --git a/modules/openxr/doc_classes/OpenXRActionMap.xml b/modules/openxr/doc_classes/OpenXRActionMap.xml index a29d10be41..8a2f666e3f 100644 --- a/modules/openxr/doc_classes/OpenXRActionMap.xml +++ b/modules/openxr/doc_classes/OpenXRActionMap.xml @@ -13,14 +13,14 @@ <methods> <method name="add_action_set"> <return type="void" /> - <argument index="0" name="action_set" type="OpenXRActionSet" /> + <param index="0" name="action_set" type="OpenXRActionSet" /> <description> Add an action set. </description> </method> <method name="add_interaction_profile"> <return type="void" /> - <argument index="0" name="interaction_profile" type="OpenXRInteractionProfile" /> + <param index="0" name="interaction_profile" type="OpenXRInteractionProfile" /> <description> Add an interaction profile. </description> @@ -33,21 +33,21 @@ </method> <method name="find_action_set" qualifiers="const"> <return type="OpenXRActionSet" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Retrieve an action set by name. </description> </method> <method name="find_interaction_profile" qualifiers="const"> <return type="OpenXRInteractionProfile" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> Find an interaction profile by its name (path). </description> </method> <method name="get_action_set" qualifiers="const"> <return type="OpenXRActionSet" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Retrieve the action set at this index. </description> @@ -60,7 +60,7 @@ </method> <method name="get_interaction_profile" qualifiers="const"> <return type="OpenXRInteractionProfile" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Get the interaction profile at this index. </description> @@ -73,14 +73,14 @@ </method> <method name="remove_action_set"> <return type="void" /> - <argument index="0" name="action_set" type="OpenXRActionSet" /> + <param index="0" name="action_set" type="OpenXRActionSet" /> <description> Remove an action set. </description> </method> <method name="remove_interaction_profile"> <return type="void" /> - <argument index="0" name="interaction_profile" type="OpenXRInteractionProfile" /> + <param index="0" name="interaction_profile" type="OpenXRInteractionProfile" /> <description> Remove an interaction profile. </description> diff --git a/modules/openxr/doc_classes/OpenXRActionSet.xml b/modules/openxr/doc_classes/OpenXRActionSet.xml index 55cc0aaad4..db3259ec07 100644 --- a/modules/openxr/doc_classes/OpenXRActionSet.xml +++ b/modules/openxr/doc_classes/OpenXRActionSet.xml @@ -12,7 +12,7 @@ <methods> <method name="add_action"> <return type="void" /> - <argument index="0" name="action" type="OpenXRAction" /> + <param index="0" name="action" type="OpenXRAction" /> <description> Add an action to this action set. </description> @@ -25,7 +25,7 @@ </method> <method name="remove_action"> <return type="void" /> - <argument index="0" name="action" type="OpenXRAction" /> + <param index="0" name="action" type="OpenXRAction" /> <description> Remove an action from this action set. </description> diff --git a/modules/openxr/doc_classes/OpenXRIPBinding.xml b/modules/openxr/doc_classes/OpenXRIPBinding.xml index f96637f2f5..00806bda06 100644 --- a/modules/openxr/doc_classes/OpenXRIPBinding.xml +++ b/modules/openxr/doc_classes/OpenXRIPBinding.xml @@ -11,7 +11,7 @@ <methods> <method name="add_path"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Add an input/output path to this binding. </description> @@ -24,14 +24,14 @@ </method> <method name="has_path" qualifiers="const"> <return type="bool" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Returns [code]true[/code] if this input/output path is part of this binding. </description> </method> <method name="remove_path"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> Removes this input/output path from this binding. </description> diff --git a/modules/openxr/doc_classes/OpenXRInteractionProfile.xml b/modules/openxr/doc_classes/OpenXRInteractionProfile.xml index 71c0db44ed..950bde031f 100644 --- a/modules/openxr/doc_classes/OpenXRInteractionProfile.xml +++ b/modules/openxr/doc_classes/OpenXRInteractionProfile.xml @@ -12,7 +12,7 @@ <methods> <method name="get_binding" qualifiers="const"> <return type="OpenXRIPBinding" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Retrieve the binding at this index. </description> diff --git a/modules/regex/doc_classes/RegEx.xml b/modules/regex/doc_classes/RegEx.xml index 52a7fe492f..9adb6acd9c 100644 --- a/modules/regex/doc_classes/RegEx.xml +++ b/modules/regex/doc_classes/RegEx.xml @@ -57,14 +57,14 @@ </method> <method name="compile"> <return type="int" enum="Error" /> - <argument index="0" name="pattern" type="String" /> + <param index="0" name="pattern" type="String" /> <description> Compiles and assign the search pattern to use. Returns [constant OK] if the compilation is successful. If an error is encountered, details are printed to standard output and an error is returned. </description> </method> <method name="create_from_string" qualifiers="static"> <return type="RegEx" /> - <argument index="0" name="pattern" type="String" /> + <param index="0" name="pattern" type="String" /> <description> Creates and compiles a new [RegEx] object. </description> @@ -95,29 +95,29 @@ </method> <method name="search" qualifiers="const"> <return type="RegExMatch" /> - <argument index="0" name="subject" type="String" /> - <argument index="1" name="offset" type="int" default="0" /> - <argument index="2" name="end" type="int" default="-1" /> + <param index="0" name="subject" type="String" /> + <param index="1" name="offset" type="int" default="0" /> + <param index="2" name="end" type="int" default="-1" /> <description> Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching result if found, otherwise [code]null[/code]. The region to search within can be specified without modifying where the start and end anchor would be. </description> </method> <method name="search_all" qualifiers="const"> <return type="RegExMatch[]" /> - <argument index="0" name="subject" type="String" /> - <argument index="1" name="offset" type="int" default="0" /> - <argument index="2" name="end" type="int" default="-1" /> + <param index="0" name="subject" type="String" /> + <param index="1" name="offset" type="int" default="0" /> + <param index="2" name="end" type="int" default="-1" /> <description> Searches the text for the compiled pattern. Returns an array of [RegExMatch] containers for each non-overlapping result. If no results were found, an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. </description> </method> <method name="sub" qualifiers="const"> <return type="String" /> - <argument index="0" name="subject" type="String" /> - <argument index="1" name="replacement" type="String" /> - <argument index="2" name="all" type="bool" default="false" /> - <argument index="3" name="offset" type="int" default="0" /> - <argument index="4" name="end" type="int" default="-1" /> + <param index="0" name="subject" type="String" /> + <param index="1" name="replacement" type="String" /> + <param index="2" name="all" type="bool" default="false" /> + <param index="3" name="offset" type="int" default="0" /> + <param index="4" name="end" type="int" default="-1" /> <description> Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]$1[/code] and [code]$name[/code] are expanded and resolved. By default, only the first instance is replaced, but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. </description> diff --git a/modules/regex/doc_classes/RegExMatch.xml b/modules/regex/doc_classes/RegExMatch.xml index 530a541ae8..5bcf070e82 100644 --- a/modules/regex/doc_classes/RegExMatch.xml +++ b/modules/regex/doc_classes/RegExMatch.xml @@ -11,7 +11,7 @@ <methods> <method name="get_end" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="Variant" default="0" /> + <param index="0" name="name" type="Variant" default="0" /> <description> Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. Returns -1 if the group did not match or doesn't exist. @@ -25,7 +25,7 @@ </method> <method name="get_start" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="Variant" default="0" /> + <param index="0" name="name" type="Variant" default="0" /> <description> Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. Returns -1 if the group did not match or doesn't exist. @@ -33,7 +33,7 @@ </method> <method name="get_string" qualifiers="const"> <return type="String" /> - <argument index="0" name="name" type="Variant" default="0" /> + <param index="0" name="name" type="Variant" default="0" /> <description> Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. Returns an empty string if the group did not match or doesn't exist. diff --git a/modules/theora/doc_classes/VideoStreamTheora.xml b/modules/theora/doc_classes/VideoStreamTheora.xml index 0f2dece8e7..e07af8f169 100644 --- a/modules/theora/doc_classes/VideoStreamTheora.xml +++ b/modules/theora/doc_classes/VideoStreamTheora.xml @@ -18,7 +18,7 @@ </method> <method name="set_file"> <return type="void" /> - <argument index="0" name="file" type="String" /> + <param index="0" name="file" type="String" /> <description> Sets the Ogg Theora video file that this [VideoStreamTheora] resource handles. The [code]file[/code] name should have the [code].ogv[/code] extension. </description> diff --git a/modules/upnp/doc_classes/UPNP.xml b/modules/upnp/doc_classes/UPNP.xml index 066506922c..847110abd4 100644 --- a/modules/upnp/doc_classes/UPNP.xml +++ b/modules/upnp/doc_classes/UPNP.xml @@ -54,18 +54,18 @@ <methods> <method name="add_device"> <return type="void" /> - <argument index="0" name="device" type="UPNPDevice" /> + <param index="0" name="device" type="UPNPDevice" /> <description> Adds the given [UPNPDevice] to the list of discovered devices. </description> </method> <method name="add_port_mapping" qualifiers="const"> <return type="int" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="port_internal" type="int" default="0" /> - <argument index="2" name="desc" type="String" default="""" /> - <argument index="3" name="proto" type="String" default=""UDP"" /> - <argument index="4" name="duration" type="int" default="0" /> + <param index="0" name="port" type="int" /> + <param index="1" name="port_internal" type="int" default="0" /> + <param index="2" name="desc" type="String" default="""" /> + <param index="3" name="proto" type="String" default=""UDP"" /> + <param index="4" name="duration" type="int" default="0" /> <description> Adds a mapping to forward the external [code]port[/code] (between 1 and 65535) on the default gateway (see [method get_gateway]) to the [code]internal_port[/code] on the local machine for the given protocol [code]proto[/code] (either [code]TCP[/code] or [code]UDP[/code], with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with [method get_gateway] and call [method add_port_mapping] on it, if any. If [code]internal_port[/code] is [code]0[/code] (the default), the same port number is used for both the external and the internal port (the [code]port[/code] value). @@ -81,17 +81,17 @@ </method> <method name="delete_port_mapping" qualifiers="const"> <return type="int" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="proto" type="String" default=""UDP"" /> + <param index="0" name="port" type="int" /> + <param index="1" name="proto" type="String" default=""UDP"" /> <description> Deletes the port mapping for the given port and protocol combination on the default gateway (see [method get_gateway]) if one exists. [code]port[/code] must be a valid port between 1 and 65535, [code]proto[/code] can be either [code]TCP[/code] or [code]UDP[/code]. See [enum UPNPResult] for possible return values. </description> </method> <method name="discover"> <return type="int" /> - <argument index="0" name="timeout" type="int" default="2000" /> - <argument index="1" name="ttl" type="int" default="2" /> - <argument index="2" name="device_filter" type="String" default=""InternetGatewayDevice"" /> + <param index="0" name="timeout" type="int" default="2000" /> + <param index="1" name="ttl" type="int" default="2" /> + <param index="2" name="device_filter" type="String" default=""InternetGatewayDevice"" /> <description> Discovers local [UPNPDevice]s. Clears the list of previously discovered devices. Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. [code]timeout[/code] is the time to wait for responses in milliseconds. [code]ttl[/code] is the time-to-live; only touch this if you know what you're doing. @@ -100,7 +100,7 @@ </method> <method name="get_device" qualifiers="const"> <return type="UPNPDevice" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the [UPNPDevice] at the given [code]index[/code]. </description> @@ -125,15 +125,15 @@ </method> <method name="remove_device"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes the device at [code]index[/code] from the list of discovered devices. </description> </method> <method name="set_device"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="device" type="UPNPDevice" /> + <param index="0" name="index" type="int" /> + <param index="1" name="device" type="UPNPDevice" /> <description> Sets the device at [code]index[/code] from the list of discovered devices to [code]device[/code]. </description> diff --git a/modules/upnp/doc_classes/UPNPDevice.xml b/modules/upnp/doc_classes/UPNPDevice.xml index 7749ac18ab..b599acaba2 100644 --- a/modules/upnp/doc_classes/UPNPDevice.xml +++ b/modules/upnp/doc_classes/UPNPDevice.xml @@ -11,19 +11,19 @@ <methods> <method name="add_port_mapping" qualifiers="const"> <return type="int" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="port_internal" type="int" default="0" /> - <argument index="2" name="desc" type="String" default="""" /> - <argument index="3" name="proto" type="String" default=""UDP"" /> - <argument index="4" name="duration" type="int" default="0" /> + <param index="0" name="port" type="int" /> + <param index="1" name="port_internal" type="int" default="0" /> + <param index="2" name="desc" type="String" default="""" /> + <param index="3" name="proto" type="String" default=""UDP"" /> + <param index="4" name="duration" type="int" default="0" /> <description> Adds a port mapping to forward the given external port on this [UPNPDevice] for the given protocol to the local machine. See [method UPNP.add_port_mapping]. </description> </method> <method name="delete_port_mapping" qualifiers="const"> <return type="int" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="proto" type="String" default=""UDP"" /> + <param index="0" name="port" type="int" /> + <param index="1" name="proto" type="String" default=""UDP"" /> <description> Deletes the port mapping identified by the given port and protocol combination on this device. See [method UPNP.delete_port_mapping]. </description> diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml index 5807c98d32..ff6b7a8b5f 100644 --- a/modules/visual_script/doc_classes/VisualScript.xml +++ b/modules/visual_script/doc_classes/VisualScript.xml @@ -14,142 +14,142 @@ <methods> <method name="add_custom_signal"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Add a custom signal with the specified name to the VisualScript. </description> </method> <method name="add_function"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="func_node_id" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="func_node_id" type="int" /> <description> Add a function with the specified name to the VisualScript, and assign the root [VisualScriptFunction] node's id as [code]func_node_id[/code]. </description> </method> <method name="add_node"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="node" type="VisualScriptNode" /> - <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="id" type="int" /> + <param index="1" name="node" type="VisualScriptNode" /> + <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Add a node to the VisualScript. </description> </method> <method name="add_variable"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="default_value" type="Variant" default="null" /> - <argument index="2" name="export" type="bool" default="false" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="default_value" type="Variant" default="null" /> + <param index="2" name="export" type="bool" default="false" /> <description> Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. </description> </method> <method name="custom_signal_add_argument"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="type" type="int" enum="Variant.Type" /> - <argument index="2" name="argname" type="String" /> - <argument index="3" name="index" type="int" default="-1" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="type" type="int" enum="Variant.Type" /> + <param index="2" name="argname" type="String" /> + <param index="3" name="index" type="int" default="-1" /> <description> Add an argument to a custom signal added with [method add_custom_signal]. </description> </method> <method name="custom_signal_get_argument_count" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Get the count of a custom signal's arguments. </description> </method> <method name="custom_signal_get_argument_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="argidx" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="argidx" type="int" /> <description> Get the name of a custom signal's argument. </description> </method> <method name="custom_signal_get_argument_type" qualifiers="const"> <return type="int" enum="Variant.Type" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="argidx" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="argidx" type="int" /> <description> Get the type of a custom signal's argument. </description> </method> <method name="custom_signal_remove_argument"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="argidx" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="argidx" type="int" /> <description> Remove a specific custom signal's argument. </description> </method> <method name="custom_signal_set_argument_name"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="argidx" type="int" /> - <argument index="2" name="argname" type="String" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="argidx" type="int" /> + <param index="2" name="argname" type="String" /> <description> Rename a custom signal's argument. </description> </method> <method name="custom_signal_set_argument_type"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="argidx" type="int" /> - <argument index="2" name="type" type="int" enum="Variant.Type" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="argidx" type="int" /> + <param index="2" name="type" type="int" enum="Variant.Type" /> <description> Change the type of a custom signal's argument. </description> </method> <method name="custom_signal_swap_argument"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="argidx" type="int" /> - <argument index="2" name="withidx" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="argidx" type="int" /> + <param index="2" name="withidx" type="int" /> <description> Swap two of the arguments of a custom signal. </description> </method> <method name="data_connect"> <return type="void" /> - <argument index="0" name="from_node" type="int" /> - <argument index="1" name="from_port" type="int" /> - <argument index="2" name="to_node" type="int" /> - <argument index="3" name="to_port" type="int" /> + <param index="0" name="from_node" type="int" /> + <param index="1" name="from_port" type="int" /> + <param index="2" name="to_node" type="int" /> + <param index="3" name="to_port" type="int" /> <description> Connect two data ports. The value of [code]from_node[/code]'s [code]from_port[/code] would be fed into [code]to_node[/code]'s [code]to_port[/code]. </description> </method> <method name="data_disconnect"> <return type="void" /> - <argument index="0" name="from_node" type="int" /> - <argument index="1" name="from_port" type="int" /> - <argument index="2" name="to_node" type="int" /> - <argument index="3" name="to_port" type="int" /> + <param index="0" name="from_node" type="int" /> + <param index="1" name="from_port" type="int" /> + <param index="2" name="to_node" type="int" /> + <param index="3" name="to_port" type="int" /> <description> Disconnect two data ports previously connected with [method data_connect]. </description> </method> <method name="get_function_node_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the id of a function's entry point node. </description> </method> <method name="get_node" qualifiers="const"> <return type="VisualScriptNode" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns a node given its id. </description> </method> <method name="get_node_position" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns a node's position in pixels. </description> @@ -162,129 +162,129 @@ </method> <method name="get_variable_default_value" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the default (initial) value of a variable. </description> </method> <method name="get_variable_export" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns whether a variable is exported. </description> </method> <method name="get_variable_info" qualifiers="const"> <return type="Dictionary" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage. </description> </method> <method name="has_custom_signal" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns whether a signal exists with the specified name. </description> </method> <method name="has_data_connection" qualifiers="const"> <return type="bool" /> - <argument index="0" name="from_node" type="int" /> - <argument index="1" name="from_port" type="int" /> - <argument index="2" name="to_node" type="int" /> - <argument index="3" name="to_port" type="int" /> + <param index="0" name="from_node" type="int" /> + <param index="1" name="from_port" type="int" /> + <param index="2" name="to_node" type="int" /> + <param index="3" name="to_port" type="int" /> <description> Returns whether the specified data ports are connected. </description> </method> <method name="has_function" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns whether a function exists with the specified name. </description> </method> <method name="has_node" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns whether a node exists with the given id. </description> </method> <method name="has_sequence_connection" qualifiers="const"> <return type="bool" /> - <argument index="0" name="from_node" type="int" /> - <argument index="1" name="from_output" type="int" /> - <argument index="2" name="to_node" type="int" /> + <param index="0" name="from_node" type="int" /> + <param index="1" name="from_output" type="int" /> + <param index="2" name="to_node" type="int" /> <description> Returns whether the specified sequence ports are connected. </description> </method> <method name="has_variable" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Returns whether a variable exists with the specified name. </description> </method> <method name="remove_custom_signal"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Remove a custom signal with the given name. </description> </method> <method name="remove_function"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Remove a specific function and its nodes from the script. </description> </method> <method name="remove_node"> <return type="void" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Remove the node with the specified id. </description> </method> <method name="remove_variable"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> Remove a variable with the given name. </description> </method> <method name="rename_custom_signal"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="new_name" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="new_name" type="StringName" /> <description> Change the name of a custom signal. </description> </method> <method name="rename_function"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="new_name" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="new_name" type="StringName" /> <description> Change the name of a function. </description> </method> <method name="rename_variable"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="new_name" type="StringName" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="new_name" type="StringName" /> <description> Change the name of a variable. </description> </method> <method name="sequence_connect"> <return type="void" /> - <argument index="0" name="from_node" type="int" /> - <argument index="1" name="from_output" type="int" /> - <argument index="2" name="to_node" type="int" /> + <param index="0" name="from_node" type="int" /> + <param index="1" name="from_output" type="int" /> + <param index="2" name="to_node" type="int" /> <description> Connect two sequence ports. The execution will flow from of [code]from_node[/code]'s [code]from_output[/code] into [code]to_node[/code]. Unlike [method data_connect], there isn't a [code]to_port[/code], since the target node can have only one sequence port. @@ -292,55 +292,55 @@ </method> <method name="sequence_disconnect"> <return type="void" /> - <argument index="0" name="from_node" type="int" /> - <argument index="1" name="from_output" type="int" /> - <argument index="2" name="to_node" type="int" /> + <param index="0" name="from_node" type="int" /> + <param index="1" name="from_output" type="int" /> + <param index="2" name="to_node" type="int" /> <description> Disconnect two sequence ports previously connected with [method sequence_connect]. </description> </method> <method name="set_instance_base_type"> <return type="void" /> - <argument index="0" name="type" type="StringName" /> + <param index="0" name="type" type="StringName" /> <description> Set the base type of the script. </description> </method> <method name="set_node_position"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="id" type="int" /> + <param index="1" name="position" type="Vector2" /> <description> Set the node position in the VisualScript graph. </description> </method> <method name="set_scroll"> <return type="void" /> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> <description> Set the screen center to the given position. </description> </method> <method name="set_variable_default_value"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Variant" /> <description> Change the default (initial) value of a variable. </description> </method> <method name="set_variable_export"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="enable" type="bool" /> <description> Change whether a variable is exported. </description> </method> <method name="set_variable_info"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="value" type="Dictionary" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="value" type="Dictionary" /> <description> Set a variable's info, using the same format as [method get_variable_info]. </description> @@ -348,7 +348,7 @@ </methods> <signals> <signal name="node_ports_changed"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when the ports of a node are changed. </description> diff --git a/modules/visual_script/doc_classes/VisualScriptConstructor.xml b/modules/visual_script/doc_classes/VisualScriptConstructor.xml index 5ec17350bd..a003f21ab9 100644 --- a/modules/visual_script/doc_classes/VisualScriptConstructor.xml +++ b/modules/visual_script/doc_classes/VisualScriptConstructor.xml @@ -21,13 +21,13 @@ </method> <method name="set_constructor"> <return type="void" /> - <argument index="0" name="constructor" type="Dictionary" /> + <param index="0" name="constructor" type="Dictionary" /> <description> </description> </method> <method name="set_constructor_type"> <return type="void" /> - <argument index="0" name="type" type="int" enum="Variant.Type" /> + <param index="0" name="type" type="int" enum="Variant.Type" /> <description> </description> </method> diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml index 97b89fb987..6e522b2f84 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -29,28 +29,28 @@ </method> <method name="_get_input_value_port_hint" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="input_idx" type="int" /> + <param index="0" name="input_idx" type="int" /> <description> Returns the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints. </description> </method> <method name="_get_input_value_port_hint_string" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="input_idx" type="int" /> + <param index="0" name="input_idx" type="int" /> <description> Returns the specified input port's hint string. </description> </method> <method name="_get_input_value_port_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="input_idx" type="int" /> + <param index="0" name="input_idx" type="int" /> <description> Returns the specified input port's name. </description> </method> <method name="_get_input_value_port_type" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="input_idx" type="int" /> + <param index="0" name="input_idx" type="int" /> <description> Returns the specified input port's type. See the [enum Variant.Type] values. </description> @@ -63,7 +63,7 @@ </method> <method name="_get_output_sequence_port_text" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="seq_idx" type="int" /> + <param index="0" name="seq_idx" type="int" /> <description> Returns the specified [b]sequence[/b] output's name. </description> @@ -76,28 +76,28 @@ </method> <method name="_get_output_value_port_hint" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="output_idx" type="int" /> + <param index="0" name="output_idx" type="int" /> <description> Returns the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints. </description> </method> <method name="_get_output_value_port_hint_string" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="output_idx" type="int" /> + <param index="0" name="output_idx" type="int" /> <description> Returns the specified output port's hint string. </description> </method> <method name="_get_output_value_port_name" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="output_idx" type="int" /> + <param index="0" name="output_idx" type="int" /> <description> Returns the specified output port's name. </description> </method> <method name="_get_output_value_port_type" qualifiers="virtual const"> <return type="int" /> - <argument index="0" name="output_idx" type="int" /> + <param index="0" name="output_idx" type="int" /> <description> Returns the specified output port's type. See the [enum Variant.Type] values. </description> @@ -122,10 +122,10 @@ </method> <method name="_step" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="inputs" type="Array" /> - <argument index="1" name="outputs" type="Array" /> - <argument index="2" name="start_mode" type="int" /> - <argument index="3" name="working_mem" type="Array" /> + <param index="0" name="inputs" type="Array" /> + <param index="1" name="outputs" type="Array" /> + <param index="2" name="start_mode" type="int" /> + <param index="3" name="working_mem" type="Array" /> <description> Execute the custom node's logic, returning the index of the output sequence port to use or a [String] when there is an error. The [code]inputs[/code] array contains the values of the input ports. diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml b/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml index f04c862174..48d7975051 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml @@ -11,17 +11,17 @@ <methods> <method name="add_custom_node"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="category" type="String" /> - <argument index="2" name="script" type="Script" /> + <param index="0" name="name" type="String" /> + <param index="1" name="category" type="String" /> + <param index="2" name="script" type="Script" /> <description> Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter. </description> </method> <method name="remove_custom_node"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="category" type="String" /> + <param index="0" name="name" type="String" /> + <param index="1" name="category" type="String" /> <description> Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. </description> diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml index ef09c9d4a0..03fef9c13b 100644 --- a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml +++ b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml @@ -11,9 +11,9 @@ <methods> <method name="connect_to_signal"> <return type="void" /> - <argument index="0" name="obj" type="Object" /> - <argument index="1" name="signals" type="String" /> - <argument index="2" name="args" type="Array" /> + <param index="0" name="obj" type="Object" /> + <param index="1" name="signals" type="String" /> + <param index="2" name="args" type="Array" /> <description> Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted. </description> @@ -26,7 +26,7 @@ </method> <method name="resume"> <return type="Variant" /> - <argument index="0" name="args" type="Array" default="[]" /> + <param index="0" name="args" type="Array" default="[]" /> <description> Resumes the function to run from the point it was yielded. </description> diff --git a/modules/visual_script/doc_classes/VisualScriptLists.xml b/modules/visual_script/doc_classes/VisualScriptLists.xml index 27a81fce2f..607965bf71 100644 --- a/modules/visual_script/doc_classes/VisualScriptLists.xml +++ b/modules/visual_script/doc_classes/VisualScriptLists.xml @@ -11,64 +11,64 @@ <methods> <method name="add_input_data_port"> <return type="void" /> - <argument index="0" name="type" type="int" enum="Variant.Type" /> - <argument index="1" name="name" type="String" /> - <argument index="2" name="index" type="int" /> + <param index="0" name="type" type="int" enum="Variant.Type" /> + <param index="1" name="name" type="String" /> + <param index="2" name="index" type="int" /> <description> Adds an input port to the Visual Script node. </description> </method> <method name="add_output_data_port"> <return type="void" /> - <argument index="0" name="type" type="int" enum="Variant.Type" /> - <argument index="1" name="name" type="String" /> - <argument index="2" name="index" type="int" /> + <param index="0" name="type" type="int" enum="Variant.Type" /> + <param index="1" name="name" type="String" /> + <param index="2" name="index" type="int" /> <description> Adds an output port to the Visual Script node. </description> </method> <method name="remove_input_data_port"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an input port from the Visual Script node. </description> </method> <method name="remove_output_data_port"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an output port from the Visual Script node. </description> </method> <method name="set_input_data_port_name"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="index" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets the name of an input port. </description> </method> <method name="set_input_data_port_type"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="type" type="int" enum="Variant.Type" /> + <param index="0" name="index" type="int" /> + <param index="1" name="type" type="int" enum="Variant.Type" /> <description> Sets the type of an input port. </description> </method> <method name="set_output_data_port_name"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="name" type="String" /> + <param index="0" name="index" type="int" /> + <param index="1" name="name" type="String" /> <description> Sets the name of an output port. </description> </method> <method name="set_output_data_port_type"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="type" type="int" enum="Variant.Type" /> + <param index="0" name="index" type="int" /> + <param index="1" name="type" type="int" enum="Variant.Type" /> <description> Sets the type of an output port. </description> diff --git a/modules/visual_script/doc_classes/VisualScriptNode.xml b/modules/visual_script/doc_classes/VisualScriptNode.xml index 2eb99dc25f..97c4f8ce76 100644 --- a/modules/visual_script/doc_classes/VisualScriptNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptNode.xml @@ -11,7 +11,7 @@ <methods> <method name="get_default_input_value" qualifiers="const"> <return type="Variant" /> - <argument index="0" name="port_idx" type="int" /> + <param index="0" name="port_idx" type="int" /> <description> Returns the default value of a given port. The default value is used when nothing is connected to the port. </description> @@ -30,8 +30,8 @@ </method> <method name="set_default_input_value"> <return type="void" /> - <argument index="0" name="port_idx" type="int" /> - <argument index="1" name="value" type="Variant" /> + <param index="0" name="port_idx" type="int" /> + <param index="1" name="value" type="Variant" /> <description> Change the default value of a given port. </description> diff --git a/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml b/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml index f937fba9d6..5387deaa47 100644 --- a/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml +++ b/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml @@ -49,8 +49,8 @@ </method> <method name="_get_packet" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="r_buffer" type="const uint8_t **" /> - <argument index="1" name="r_buffer_size" type="int32_t*" /> + <param index="0" name="r_buffer" type="const uint8_t **" /> + <param index="1" name="r_buffer_size" type="int32_t*" /> <description> </description> </method> @@ -86,14 +86,14 @@ </method> <method name="_put_packet" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_buffer" type="const uint8_t*" /> - <argument index="1" name="p_buffer_size" type="int" /> + <param index="0" name="p_buffer" type="const uint8_t*" /> + <param index="1" name="p_buffer_size" type="int" /> <description> </description> </method> <method name="_set_write_mode" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="p_write_mode" type="int" /> + <param index="0" name="p_write_mode" type="int" /> <description> </description> </method> diff --git a/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml b/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml index df92097135..927888fe21 100644 --- a/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml +++ b/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml @@ -14,9 +14,9 @@ <methods> <method name="add_peer"> <return type="int" enum="Error" /> - <argument index="0" name="peer" type="WebRTCPeerConnection" /> - <argument index="1" name="peer_id" type="int" /> - <argument index="2" name="unreliable_lifetime" type="int" default="1" /> + <param index="0" name="peer" type="WebRTCPeerConnection" /> + <param index="1" name="peer_id" type="int" /> + <param index="2" name="unreliable_lifetime" type="int" default="1" /> <description> Add a new peer to the mesh with the given [code]peer_id[/code]. The [WebRTCPeerConnection] must be in state [constant WebRTCPeerConnection.STATE_NEW]. Three channels will be created for reliable, unreliable, and ordered transport. The value of [code]unreliable_lifetime[/code] will be passed to the [code]maxPacketLifetime[/code] option when creating unreliable and ordered channels (see [method WebRTCPeerConnection.create_data_channel]). @@ -30,7 +30,7 @@ </method> <method name="get_peer"> <return type="Dictionary" /> - <argument index="0" name="peer_id" type="int" /> + <param index="0" name="peer_id" type="int" /> <description> Returns a dictionary representation of the peer with given [code]peer_id[/code] with three keys. [code]connection[/code] containing the [WebRTCPeerConnection] to this peer, [code]channels[/code] an array of three [WebRTCDataChannel], and [code]connected[/code] a boolean representing if the peer connection is currently connected (all three channels are open). </description> @@ -43,16 +43,16 @@ </method> <method name="has_peer"> <return type="bool" /> - <argument index="0" name="peer_id" type="int" /> + <param index="0" name="peer_id" type="int" /> <description> Returns [code]true[/code] if the given [code]peer_id[/code] is in the peers map (it might not be connected though). </description> </method> <method name="initialize"> <return type="int" enum="Error" /> - <argument index="0" name="peer_id" type="int" /> - <argument index="1" name="server_compatibility" type="bool" default="false" /> - <argument index="2" name="channels_config" type="Array" default="[]" /> + <param index="0" name="peer_id" type="int" /> + <param index="1" name="server_compatibility" type="bool" default="false" /> + <param index="2" name="channels_config" type="Array" default="[]" /> <description> Initialize the multiplayer peer with the given [code]peer_id[/code] (must be between 1 and 2147483647). If [code]server_compatibilty[/code] is [code]false[/code] (default), the multiplayer peer will be immediately in state [constant MultiplayerPeer.CONNECTION_CONNECTED] and [signal MultiplayerPeer.connection_succeeded] will not be emitted. @@ -62,7 +62,7 @@ </method> <method name="remove_peer"> <return type="void" /> - <argument index="0" name="peer_id" type="int" /> + <param index="0" name="peer_id" type="int" /> <description> Remove the peer with given [code]peer_id[/code] from the mesh. If the peer was connected, and [signal MultiplayerPeer.peer_connected] was emitted for it, then [signal MultiplayerPeer.peer_disconnected] will be emitted. </description> diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index fed67397d1..e99aeb4f51 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -16,9 +16,9 @@ <methods> <method name="add_ice_candidate"> <return type="int" enum="Error" /> - <argument index="0" name="media" type="String" /> - <argument index="1" name="index" type="int" /> - <argument index="2" name="name" type="String" /> + <param index="0" name="media" type="String" /> + <param index="1" name="index" type="int" /> + <param index="2" name="name" type="String" /> <description> Add an ice candidate generated by a remote peer (and received over the signaling server). See [signal ice_candidate_created]. </description> @@ -32,8 +32,8 @@ </method> <method name="create_data_channel"> <return type="WebRTCDataChannel" /> - <argument index="0" name="label" type="String" /> - <argument index="1" name="options" type="Dictionary" default="{}" /> + <param index="0" name="label" type="String" /> + <param index="1" name="options" type="Dictionary" default="{}" /> <description> Returns a new [WebRTCDataChannel] (or [code]null[/code] on failure) with given [code]label[/code] and optionally configured via the [code]options[/code] dictionary. This method can only be called when the connection is in state [constant STATE_NEW]. There are two ways to create a working data channel: either call [method create_data_channel] on only one of the peer and listen to [signal data_channel_received] on the other, or call [method create_data_channel] on both peers, with the same values, and the [code]negotiated[/code] option set to [code]true[/code]. @@ -69,7 +69,7 @@ </method> <method name="initialize"> <return type="int" enum="Error" /> - <argument index="0" name="configuration" type="Dictionary" default="{}" /> + <param index="0" name="configuration" type="Dictionary" default="{}" /> <description> Re-initialize this peer connection, closing any previously active connection, and going back to state [constant STATE_NEW]. A dictionary of [code]options[/code] can be passed to configure the peer connection. Valid [code]options[/code] are: @@ -97,15 +97,15 @@ </method> <method name="set_default_extension" qualifiers="static"> <return type="void" /> - <argument index="0" name="extension_class" type="StringName" /> + <param index="0" name="extension_class" type="StringName" /> <description> Sets the [code]extension_class[/code] as the default [WebRTCPeerConnectionExtension] returned when creating a new [WebRTCPeerConnection]. </description> </method> <method name="set_local_description"> <return type="int" enum="Error" /> - <argument index="0" name="type" type="String" /> - <argument index="1" name="sdp" type="String" /> + <param index="0" name="type" type="String" /> + <param index="1" name="sdp" type="String" /> <description> Sets the SDP description of the local peer. This should be called in response to [signal session_description_created]. After calling this function the peer will start emitting [signal ice_candidate_created] (unless an [enum Error] different from [constant OK] is returned). @@ -113,8 +113,8 @@ </method> <method name="set_remote_description"> <return type="int" enum="Error" /> - <argument index="0" name="type" type="String" /> - <argument index="1" name="sdp" type="String" /> + <param index="0" name="type" type="String" /> + <param index="1" name="sdp" type="String" /> <description> Sets the SDP description of the remote peer. This should be called with the values generated by a remote peer and received over the signaling server. If [code]type[/code] is [code]offer[/code] the peer will emit [signal session_description_created] with the appropriate answer. @@ -124,23 +124,23 @@ </methods> <signals> <signal name="data_channel_received"> - <argument index="0" name="channel" type="WebRTCDataChannel" /> + <param index="0" name="channel" type="WebRTCDataChannel" /> <description> Emitted when a new in-band channel is received, i.e. when the channel was created with [code]negotiated: false[/code] (default). The object will be an instance of [WebRTCDataChannel]. You must keep a reference of it or it will be closed automatically. See [method create_data_channel]. </description> </signal> <signal name="ice_candidate_created"> - <argument index="0" name="media" type="String" /> - <argument index="1" name="index" type="int" /> - <argument index="2" name="name" type="String" /> + <param index="0" name="media" type="String" /> + <param index="1" name="index" type="int" /> + <param index="2" name="name" type="String" /> <description> Emitted when a new ICE candidate has been created. The three parameters are meant to be passed to the remote peer over the signaling server. </description> </signal> <signal name="session_description_created"> - <argument index="0" name="type" type="String" /> - <argument index="1" name="sdp" type="String" /> + <param index="0" name="type" type="String" /> + <param index="1" name="sdp" type="String" /> <description> Emitted after a successful call to [method create_offer] or [method set_remote_description] (when it generates an answer). The parameters are meant to be passed to [method set_local_description] on this object, and sent to the remote peer over the signaling server. </description> diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml b/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml index 163d939ac1..e22e939a66 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml @@ -9,9 +9,9 @@ <methods> <method name="_add_ice_candidate" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_sdp_mid_name" type="String" /> - <argument index="1" name="p_sdp_mline_index" type="int" /> - <argument index="2" name="p_sdp_name" type="String" /> + <param index="0" name="p_sdp_mid_name" type="String" /> + <param index="1" name="p_sdp_mline_index" type="int" /> + <param index="2" name="p_sdp_name" type="String" /> <description> </description> </method> @@ -22,8 +22,8 @@ </method> <method name="_create_data_channel" qualifiers="virtual"> <return type="Object" /> - <argument index="0" name="p_label" type="String" /> - <argument index="1" name="p_config" type="Dictionary" /> + <param index="0" name="p_label" type="String" /> + <param index="1" name="p_config" type="Dictionary" /> <description> </description> </method> @@ -39,7 +39,7 @@ </method> <method name="_initialize" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_config" type="Dictionary" /> + <param index="0" name="p_config" type="Dictionary" /> <description> </description> </method> @@ -50,15 +50,15 @@ </method> <method name="_set_local_description" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_type" type="String" /> - <argument index="1" name="p_sdp" type="String" /> + <param index="0" name="p_type" type="String" /> + <param index="1" name="p_sdp" type="String" /> <description> </description> </method> <method name="_set_remote_description" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="p_type" type="String" /> - <argument index="1" name="p_sdp" type="String" /> + <param index="0" name="p_type" type="String" /> + <param index="1" name="p_sdp" type="String" /> <description> </description> </method> diff --git a/modules/websocket/doc_classes/WebSocketClient.xml b/modules/websocket/doc_classes/WebSocketClient.xml index ad2acf8a21..f586c58302 100644 --- a/modules/websocket/doc_classes/WebSocketClient.xml +++ b/modules/websocket/doc_classes/WebSocketClient.xml @@ -15,10 +15,10 @@ <methods> <method name="connect_to_url"> <return type="int" enum="Error" /> - <argument index="0" name="url" type="String" /> - <argument index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" /> - <argument index="2" name="gd_mp_api" type="bool" default="false" /> - <argument index="3" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" /> + <param index="0" name="url" type="String" /> + <param index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" /> + <param index="2" name="gd_mp_api" type="bool" default="false" /> + <param index="3" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" /> <description> Connects to the given URL requesting one of the given [code]protocols[/code] as sub-protocol. If the list empty (default), no sub-protocol will be requested. If [code]true[/code] is passed as [code]gd_mp_api[/code], the client will behave like a multiplayer peer for the [MultiplayerAPI], connections to non-Godot servers will not work, and [signal data_received] will not be emitted. @@ -30,8 +30,8 @@ </method> <method name="disconnect_from_host"> <return type="void" /> - <argument index="0" name="code" type="int" default="1000" /> - <argument index="1" name="reason" type="String" default="""" /> + <param index="0" name="code" type="int" default="1000" /> + <param index="1" name="reason" type="String" default="""" /> <description> Disconnects this client from the connected host. See [method WebSocketPeer.close] for more information. </description> @@ -61,7 +61,7 @@ </members> <signals> <signal name="connection_closed"> - <argument index="0" name="was_clean_close" type="bool" /> + <param index="0" name="was_clean_close" type="bool" /> <description> Emitted when the connection to the server is closed. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly. </description> @@ -72,7 +72,7 @@ </description> </signal> <signal name="connection_established"> - <argument index="0" name="protocol" type="String" /> + <param index="0" name="protocol" type="String" /> <description> Emitted when a connection with the server is established, [code]protocol[/code] will contain the sub-protocol agreed with the server. </description> @@ -84,8 +84,8 @@ </description> </signal> <signal name="server_close_request"> - <argument index="0" name="code" type="int" /> - <argument index="1" name="reason" type="String" /> + <param index="0" name="code" type="int" /> + <param index="1" name="reason" type="String" /> <description> Emitted when the server requests a clean close. You should keep polling until you get a [signal connection_closed] signal to achieve the clean close. See [method WebSocketPeer.close] for more details. </description> diff --git a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml index 4a617f4c82..23aa6ba3db 100644 --- a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml +++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml @@ -12,17 +12,17 @@ <methods> <method name="get_peer" qualifiers="const"> <return type="WebSocketPeer" /> - <argument index="0" name="peer_id" type="int" /> + <param index="0" name="peer_id" type="int" /> <description> Returns the [WebSocketPeer] associated to the given [code]peer_id[/code]. </description> </method> <method name="set_buffers"> <return type="int" enum="Error" /> - <argument index="0" name="input_buffer_size_kb" type="int" /> - <argument index="1" name="input_max_packets" type="int" /> - <argument index="2" name="output_buffer_size_kb" type="int" /> - <argument index="3" name="output_max_packets" type="int" /> + <param index="0" name="input_buffer_size_kb" type="int" /> + <param index="1" name="input_max_packets" type="int" /> + <param index="2" name="output_buffer_size_kb" type="int" /> + <param index="3" name="output_max_packets" type="int" /> <description> Configures the buffer sizes for this WebSocket peer. Default values can be specified in the Project Settings under [code]network/limits[/code]. For server, values are meant per connected peer. The first two parameters define the size and queued packets limits of the input buffer, the last two of the output buffer. @@ -33,7 +33,7 @@ </methods> <signals> <signal name="peer_packet"> - <argument index="0" name="peer_source" type="int" /> + <param index="0" name="peer_source" type="int" /> <description> Emitted when a packet is received from a peer. [b]Note:[/b] This signal is only emitted when the client or server is configured to use Godot multiplayer API. diff --git a/modules/websocket/doc_classes/WebSocketPeer.xml b/modules/websocket/doc_classes/WebSocketPeer.xml index 6466654517..43b765d2fe 100644 --- a/modules/websocket/doc_classes/WebSocketPeer.xml +++ b/modules/websocket/doc_classes/WebSocketPeer.xml @@ -12,8 +12,8 @@ <methods> <method name="close"> <return type="void" /> - <argument index="0" name="code" type="int" default="1000" /> - <argument index="1" name="reason" type="String" default="""" /> + <param index="0" name="code" type="int" default="1000" /> + <param index="1" name="reason" type="String" default="""" /> <description> Closes this WebSocket connection. [code]code[/code] is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). [code]reason[/code] is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes). [b]Note:[/b] To achieve a clean close, you will need to keep polling until either [signal WebSocketClient.connection_closed] or [signal WebSocketServer.client_disconnected] is received. @@ -54,7 +54,7 @@ </method> <method name="set_no_delay"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Disable Nagle's algorithm on the underling TCP socket (default). See [method StreamPeerTCP.set_no_delay] for more information. [b]Note:[/b] Not available in the HTML5 export. @@ -62,7 +62,7 @@ </method> <method name="set_write_mode"> <return type="void" /> - <argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode" /> + <param index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode" /> <description> Sets the socket to use the given [enum WriteMode]. </description> diff --git a/modules/websocket/doc_classes/WebSocketServer.xml b/modules/websocket/doc_classes/WebSocketServer.xml index 46b0274de3..6a7bf8075c 100644 --- a/modules/websocket/doc_classes/WebSocketServer.xml +++ b/modules/websocket/doc_classes/WebSocketServer.xml @@ -14,30 +14,30 @@ <methods> <method name="disconnect_peer"> <return type="void" /> - <argument index="0" name="id" type="int" /> - <argument index="1" name="code" type="int" default="1000" /> - <argument index="2" name="reason" type="String" default="""" /> + <param index="0" name="id" type="int" /> + <param index="1" name="code" type="int" default="1000" /> + <param index="2" name="reason" type="String" default="""" /> <description> Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more information. </description> </method> <method name="get_peer_address" qualifiers="const"> <return type="String" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the IP address of the given peer. </description> </method> <method name="get_peer_port" qualifiers="const"> <return type="int" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns the remote port of the given peer. </description> </method> <method name="has_peer" qualifiers="const"> <return type="bool" /> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Returns [code]true[/code] if a peer with the given ID is connected. </description> @@ -50,9 +50,9 @@ </method> <method name="listen"> <return type="int" enum="Error" /> - <argument index="0" name="port" type="int" /> - <argument index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" /> - <argument index="2" name="gd_mp_api" type="bool" default="false" /> + <param index="0" name="port" type="int" /> + <param index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" /> + <param index="2" name="gd_mp_api" type="bool" default="false" /> <description> Starts listening on the given port. You can specify the desired subprotocols via the "protocols" array. If the list empty (default), no sub-protocol will be requested. @@ -62,7 +62,7 @@ </method> <method name="set_extra_headers"> <return type="void" /> - <argument index="0" name="headers" type="PackedStringArray" default="PackedStringArray()" /> + <param index="0" name="headers" type="PackedStringArray" default="PackedStringArray()" /> <description> Sets additional headers to be sent to clients during the HTTP handshake. </description> @@ -93,31 +93,31 @@ </members> <signals> <signal name="client_close_request"> - <argument index="0" name="id" type="int" /> - <argument index="1" name="code" type="int" /> - <argument index="2" name="reason" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="code" type="int" /> + <param index="2" name="reason" type="String" /> <description> Emitted when a client requests a clean close. You should keep polling until you get a [signal client_disconnected] signal with the same [code]id[/code] to achieve the clean close. See [method WebSocketPeer.close] for more details. </description> </signal> <signal name="client_connected"> - <argument index="0" name="id" type="int" /> - <argument index="1" name="protocol" type="String" /> - <argument index="2" name="resource_name" type="String" /> + <param index="0" name="id" type="int" /> + <param index="1" name="protocol" type="String" /> + <param index="2" name="resource_name" type="String" /> <description> Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client, and "resource_name" will be the resource name of the URI the peer used. "resource_name" is a path (at the very least a single forward slash) and potentially a query string. </description> </signal> <signal name="client_disconnected"> - <argument index="0" name="id" type="int" /> - <argument index="1" name="was_clean_close" type="bool" /> + <param index="0" name="id" type="int" /> + <param index="1" name="was_clean_close" type="bool" /> <description> Emitted when a client disconnects. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly. </description> </signal> <signal name="data_received"> - <argument index="0" name="id" type="int" /> + <param index="0" name="id" type="int" /> <description> Emitted when a new message is received. [b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer. diff --git a/modules/webxr/doc_classes/WebXRInterface.xml b/modules/webxr/doc_classes/WebXRInterface.xml index 48447eb074..01ad962b20 100644 --- a/modules/webxr/doc_classes/WebXRInterface.xml +++ b/modules/webxr/doc_classes/WebXRInterface.xml @@ -96,7 +96,7 @@ <methods> <method name="get_controller" qualifiers="const"> <return type="XRPositionalTracker" /> - <argument index="0" name="controller_id" type="int" /> + <param index="0" name="controller_id" type="int" /> <description> Gets an [XRPositionalTracker] for the given [code]controller_id[/code]. In the context of WebXR, a "controller" can be an advanced VR controller like the Oculus Touch or Index controllers, or even a tap on the screen, a spoken voice command or a button press on the device itself. When a non-traditional controller is used, interpret the position and orientation of the [XRPositionalTracker] as a ray pointing at the object the user wishes to interact with. @@ -111,7 +111,7 @@ </method> <method name="is_session_supported"> <return type="void" /> - <argument index="0" name="session_mode" type="String" /> + <param index="0" name="session_mode" type="String" /> <description> Checks if the given [code]session_mode[/code] is supported by the user's browser. Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode]WebXR's XRSessionMode[/url], including: [code]"immersive-vr"[/code], [code]"immersive-ar"[/code], and [code]"inline"[/code]. @@ -166,21 +166,21 @@ </description> </signal> <signal name="select"> - <argument index="0" name="controller_id" type="int" /> + <param index="0" name="controller_id" type="int" /> <description> Emitted after one of the "controllers" has finished its "primary action". Use [method get_controller] to get more information about the controller. </description> </signal> <signal name="selectend"> - <argument index="0" name="controller_id" type="int" /> + <param index="0" name="controller_id" type="int" /> <description> Emitted when one of the "controllers" has finished its "primary action". Use [method get_controller] to get more information about the controller. </description> </signal> <signal name="selectstart"> - <argument index="0" name="controller_id" type="int" /> + <param index="0" name="controller_id" type="int" /> <description> Emitted when one of the "controllers" has started its "primary action". Use [method get_controller] to get more information about the controller. @@ -193,7 +193,7 @@ </description> </signal> <signal name="session_failed"> - <argument index="0" name="message" type="String" /> + <param index="0" name="message" type="String" /> <description> Emitted by [method XRInterface.initialize] if the session fails to start. [code]message[/code] may optionally contain an error message from WebXR, or an empty string if no message is available. @@ -206,28 +206,28 @@ </description> </signal> <signal name="session_supported"> - <argument index="0" name="session_mode" type="String" /> - <argument index="1" name="supported" type="bool" /> + <param index="0" name="session_mode" type="String" /> + <param index="1" name="supported" type="bool" /> <description> Emitted by [method is_session_supported] to indicate if the given [code]session_mode[/code] is supported or not. </description> </signal> <signal name="squeeze"> - <argument index="0" name="controller_id" type="int" /> + <param index="0" name="controller_id" type="int" /> <description> Emitted after one of the "controllers" has finished its "primary squeeze action". Use [method get_controller] to get more information about the controller. </description> </signal> <signal name="squeezeend"> - <argument index="0" name="controller_id" type="int" /> + <param index="0" name="controller_id" type="int" /> <description> Emitted when one of the "controllers" has finished its "primary squeeze action". Use [method get_controller] to get more information about the controller. </description> </signal> <signal name="squeezestart"> - <argument index="0" name="controller_id" type="int" /> + <param index="0" name="controller_id" type="int" /> <description> Emitted when one of the "controllers" has started its "primary squeeze action". Use [method get_controller] to get more information about the controller. |