diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Array.xml | 8 | ||||
| -rw-r--r-- | doc/classes/Node.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Object.xml | 4 | ||||
| -rw-r--r-- | doc/classes/SceneTree.xml | 4 | ||||
| -rw-r--r-- | doc/classes/TreeItem.xml | 2 |
5 files changed, 15 insertions, 7 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 68cb615209..ddcb249f47 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -513,48 +513,56 @@ <return type="bool" /> <argument index="0" name="right" type="Array" /> <description> + Compares the current array against the array passed as argument: Returns [code]false[/code] if the compared arrays are the same object. Returns [code]true[/code] if the compared arrays have different sizes. Returns [code]false[/code] and prints an error if the comparison reaches the highest levels of nesting (100). Returns [code]true[/code] if the contents of the arrays are not equal, [code]false[/code] otherwise. </description> </operator> <operator name="operator +"> <return type="Array" /> <argument index="0" name="right" type="Array" /> <description> + This operator is actually provided by the [Variant] class. For further details, see the available documentation for [Variant] or refer to the Godot source code (core/variant/variant_op). </description> </operator> <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="Array" /> <description> + Performs a comparison for each index between the current array and the array passed as argument, 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 will be recursive. If all elements are equal it compares the length of both arrays, it returns [code]false[/code] if the current array has less elements, returns [code]true[/code] otherwise. </description> </operator> <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="Array" /> <description> + Performs a comparison for each index between the current array and the array passed as argument, 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 will be recursive. If all elements are equal it compares the length of both arrays, it returns [code]true[/code] if the current 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" /> <description> + Compares the current array against the array passed as argument: Returns [code]true[/code] if the compared arrays are the same object. Returns [code]false[/code] if the compared arrays have different sizes. Returns [code]true[/code] and prints an error if the comparison reaches the highest levels of nesting (100). Returns [code]false[/code] if the contents of the arrays are not equal, [code]true[/code] otherwise. </description> </operator> <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="Array" /> <description> + Performs a comparison for each index between the current array and the array passed as argument, 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 will be recursive. If all elements are equal it compares the length of both arrays, it returns [code]true[/code] if the array passed as argument has more elements, otherwise it returns [code]false[/code]. </description> </operator> <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="Array" /> <description> + Performs a comparison for each index between the current array and the array passed as argument, 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 will be recursive. If all elements are equal it compares the length of both arrays, it returns [code]true[/code] if the array passed as argument 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" /> <description> + Returns a reference to the element of type Variant at the specified location. </description> </operator> </operators> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 28b104e276..5d0a49c23b 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -586,7 +586,7 @@ </description> </method> <method name="rpc" qualifiers="vararg"> - <return type="Variant" /> + <return type="void" /> <argument 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 an empty [Variant]. @@ -605,7 +605,7 @@ </description> </method> <method name="rpc_id" qualifiers="vararg"> - <return type="Variant" /> + <return type="void" /> <argument index="0" name="peer_id" type="int" /> <argument index="1" name="method" type="StringName" /> <description> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 77927b9a8a..f7a3be48cf 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -107,7 +107,7 @@ </description> </method> <method name="call_deferred" qualifiers="vararg"> - <return type="void" /> + <return type="Variant" /> <argument 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: @@ -301,7 +301,7 @@ </description> </method> <method name="emit_signal" qualifiers="vararg"> - <return type="void" /> + <return type="int" enum="Error" /> <argument 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: diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index f3dfc727b0..77023d2126 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -14,7 +14,7 @@ </tutorials> <methods> <method name="call_group" qualifiers="vararg"> - <return type="Variant" /> + <return type="void" /> <argument index="0" name="group" type="StringName" /> <argument index="1" name="method" type="StringName" /> <description> @@ -24,7 +24,7 @@ </description> </method> <method name="call_group_flags" qualifiers="vararg"> - <return type="Variant" /> + <return type="void" /> <argument index="0" name="flags" type="int" /> <argument index="1" name="group" type="StringName" /> <argument index="2" name="method" type="StringName" /> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index c909a35ab5..396be2d9f8 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -22,7 +22,7 @@ </description> </method> <method name="call_recursive" qualifiers="vararg"> - <return type="Variant" /> + <return type="void" /> <argument 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. |