diff options
Diffstat (limited to 'doc/classes/Array.xml')
| -rw-r--r-- | doc/classes/Array.xml | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 4d282761fe..5f85751c13 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Array" category="Built-In Types" version="3.0-stable"> +<class name="Array" category="Built-In Types" version="3.1"> <brief_description> Generic array datatype. </brief_description> @@ -131,8 +131,11 @@ <method name="duplicate"> <return type="Array"> </return> + <argument index="0" name="deep" type="bool" default="False"> + </argument> <description> - Returns a copy of this [code]Array[/code]. + Returns a copy of the array. + If [code]deep[/code] is [code]true[/code], a deep copy is be 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. </description> </method> <method name="empty"> @@ -265,6 +268,11 @@ 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="shuffle"> + <description> + Shuffle the array such that the items will have a random order. + </description> + </method> <method name="size"> <return type="int"> </return> |