asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Merge pull request #41812 from Calinou/doc-array-errors

Browse source 
Improve documentation related to Array error handling
This commit is contained in:
Rémi Verschelde 2020-09-09 15:24:34 +02:00 • committed by GitHub
commit e4a8b472cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/classes/Array.xml
View file

@ -119,7 +119,8 @@
<return type="Variant">
</return>
<description>
Returns the last element of the array. Throws an error and returns [code]null[/code] if the array is empty.
Returns the last element of the array. Prints an error and returns [code]null[/code] if the array is empty.
[b]Note:[/b] Calling this function is not the same as writing [code]array[-1][/code]. If the array is empty, accessing by index will pause project execution when running from the editor.
</description>
</method>
<method name="bsearch">
@ -216,7 +217,8 @@
<return type="Variant">
</return>
<description>
Returns the first element of the array. Throws an error and returns [code]null[/code] if the array is empty.
Returns the first element of the array. Prints an error and returns [code]null[/code] if the array is empty.
[b]Note:[/b] Calling this function is not the same as writing [code]array[0][/code]. If the array is empty, accessing by index will pause project execution when running from the editor.
</description>
</method>
<method name="has">
@ -283,14 +285,14 @@
<return type="Variant">
</return>
<description>
Removes and returns the last element of the array. Returns [code]null[/code] if the array is empty.
Removes and returns the last element of the array. Returns [code]null[/code] if the array is empty, without printing an error message.
</description>
</method>
<method name="pop_front">
<return type="Variant">
</return>
<description>
Removes and returns the first element of the array. Returns [code]null[/code] if the array is empty.
Removes and returns the first element of the array. Returns [code]null[/code] if the array is empty, wwithout printing an error message.
</description>
</method>
<method name="push_back">
@ -317,7 +319,7 @@
<argument index="0" name="position" type="int">
</argument>
<description>
Removes an element from the array by index.
Removes an element from the array by index. If the index does not exist in the array, nothing happens.
</description>
</method>
<method name="resize">