What it does
SpriteDepth takes iSpriteIndex (an integer), and answers an integer. That is the first of 2 forms. iSpriteIndex is the id of a Sprite object, the one CreateSprite returned: it is how the call knows what to act on.
Syntax
1
SpriteDepth(iSpriteIndex integer) → integer2
SpriteDepth(iSpriteIndex integer, iDepth integer)Parameters
| Name | Type | In forms |
|---|---|---|
| iSpriteIndex | integer | all |
| iDepth | integer | 2 |
What each form returns
| 1 | SpriteDepth(sprite) | integer |
| 2 | SpriteDepth(sprite, 1) | nothing |
Example · generated
Form 1, the command hands back the id
image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)DO Print(SpriteDepth(sprite)) Sync()LOOPForm 2, you choose the id yourself
image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)SpriteDepth(sprite, 1)DO Sync()LOOPLoadImage and CreateSprite are there to give the call something to act on; SpriteDepth is the line that matters. The DO … LOOP is not decoration: a classic BASIC program ends the moment it runs out of lines, and Sync() is what draws the frame.