What it does
PlaySprite makes something happen at once: it plays. It takes iSpriteIndex (an integer), and returns nothing. That is the first of 4 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
PlaySprite(iSpriteIndex integer)2
PlaySprite(iSpriteIndex integer, fFps float)3
PlaySprite(iSpriteIndex integer, fFps float, iLoop integer)4
PlaySprite(iSpriteIndex integer, fFps float, iLoop integer, iFromFrame integer, iToFrame integer)Parameters
| Name | Type | In forms |
|---|---|---|
| iSpriteIndex | integer | all |
| fFps | float | 2, 3, 4 |
| iLoop | integer | 3, 4 |
| iFromFrame | integer | 4 |
| iToFrame | integer | 4 |
Every form returns
nothing
Example · generated
Form 1, the short one
image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)PlaySprite(sprite)DO Sync()LOOPForm 4, with every argument
image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)PlaySprite(sprite, 1.0, 1, 1, 1)DO Sync()LOOPLoadImage and CreateSprite are there to give the call something to act on; PlaySprite 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.