SpriteActive

Family: Sprite · 2 forms

What it does

SpriteActive 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
SpriteActive(iSpriteIndex integer) → integer
2
SpriteActive(iSpriteIndex integer, bActive integer)

Parameters

NameTypeIn forms
iSpriteIndexintegerall
bActiveinteger2

What each form returns

1SpriteActive(sprite)integer
2SpriteActive(sprite, 1)nothing

Example · generated

Form 1, the command hands back the id

image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)DO  Print(SpriteActive(sprite))  Sync()LOOP

Form 2, you choose the id yourself

image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)SpriteActive(sprite, 1)DO  Sync()LOOP

LoadImage and CreateSprite are there to give the call something to act on; SpriteActive 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.

135 commands in Sprite