Difference between revisions of "Sprite:swapChildrenAt"

Latest revision as of 14:33, 13 July 2023

Available since: Gideros 2015.04.04
Class: Sprite

Swaps two child sprites at specifed indexes. Can be used to sort sprites into a specific order much faster than adding and removing sprites.

Sprite:swapChildrenAt(index1,index2)

Each index must be between 1 and the index number of the last child

index1: (number) the child index of the first sprite to swap
index2: (number) the child index of the second sprite to swap

@@ Line 1: / Line 1: @@
 __NOTOC__
 '''Available since:''' Gideros 2015.04.04<br/>
+'''Class:''' [[Sprite]]<br/>
 === Description ===
-<br />
+Swaps two child sprites at specifed indexes. Can be used to sort sprites into a specific order much faster than adding and removing sprites.
-Swaps two child sprites at specifed indexes. Each index must be between 1<br />
+<syntaxhighlight lang="lua">
-and the index number of the last child.  Can be used to sort sprites into<br />
+Sprite:swapChildrenAt(index1,index2)
-a specific order much faster than adding and removing sprites.<br/>
+</syntaxhighlight>
-<br />
-<source lang="lua">
+ '''Each index must be between 1 and the index number of the last child'''
- Sprite:swapChildrenAt(index1,index2)
-</source>
+=== Parameters ===
-'''index1''': (number) The child index of the first sprite to swap. ''''''<br/>
+'''index1''': (number) the child index of the first sprite to swap<br/>
-'''index2''': (number) The child index of the second sprite to swap. ''''''<br/>
+'''index2''': (number) the child index of the second sprite to swap<br/>
+{{Sprite}}