diff options
Diffstat (limited to 'doc/classes/PoolIntArray.xml')
| -rw-r--r-- | doc/classes/PoolIntArray.xml | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 347dcb09f2..28a28b2bba 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolIntArray" category="Built-In Types" version="3.1"> +<class name="PoolIntArray" category="Built-In Types" version="3.2"> <brief_description> - Integer Array. + A pooled [Array] of integers ([int]). </brief_description> <description> - Integer Array. Contains integers. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. + An [Array] specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory. + [b]Note:[/b] This type is passed by value and not by reference. + [b]Note:[/b] This type is limited to signed 32-bit integers, which means it can only take values in the interval [code][-2^31, 2^31 - 1][/code], i.e. [code][-2147483648, 2147483647][/code]. Exceeding those bounds will wrap around. In comparison, [int] uses signed 64-bit integers which can hold much larger values. </description> <tutorials> </tutorials> - <demos> - </demos> <methods> <method name="PoolIntArray"> <return type="PoolIntArray"> @@ -17,21 +17,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Create from a generic array. + Constructs a new [PoolIntArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> </method> <method name="append"> <argument index="0" name="integer" type="int"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="PoolIntArray"> </argument> <description> - Append an [code]PoolIntArray[/code] at the end of this array. + Appends a [PoolIntArray] at the end of this array. </description> </method> <method name="insert"> @@ -42,33 +42,33 @@ <argument index="1" name="integer" type="int"> </argument> <description> - Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Inserts a new int at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array. + Reverses the order of the elements in the array. </description> </method> <method name="push_back"> <argument index="0" name="integer" type="int"> </argument> <description> - Append a value to the array. + Appends a value to the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Removes an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. + 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> </method> <method name="set"> @@ -77,14 +77,14 @@ <argument index="1" name="integer" type="int"> </argument> <description> - Change the int at the given index. + Changes the int at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the array size. + Returns the array size. </description> </method> </methods> |