Improve documentation for Array.get() and Packed*Array.get() methods

This commit is contained in:
Hugo Locurcio
2025-05-14 01:51:55 +02:00
parent be3ecaeb3c
commit 59a75babf8
11 changed files with 22 additions and 11 deletions

View File

@ -106,7 +106,8 @@
<return type="float" />
<param index="0" name="index" type="int" />
<description>
Returns the 64-bit float at the given [param index] in the array. This is the same as using the [code][][/code] operator ([code]array[index][/code]).
Returns the 64-bit float at the given [param index] in the array. If [param index] out-of-bounds or negative, this method fails and returns [code]0.0[/code].
This method is similar (but not identical) to the [code][][/code] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
</description>
</method>
<method name="has" qualifiers="const">