What it does
SpriteCategoryBits sets CategoryBits on a Sprite object. It takes iSpriteIndex (an integer) and categories (an integer), and returns nothing. 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
SpriteCategoryBits(iSpriteIndex integer, categories integer)2
SpriteCategoryBits(iSpriteIndex integer, categories integer, shapeID integer)Parameters
| Name | Type | In forms |
|---|---|---|
| iSpriteIndex | integer | all |
| categories | integer | all |
| shapeID | integer | 2 |
Every form returns
nothing
Example · generated
Form 1, the short one
image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)SpriteCategoryBits(sprite, 1)DO Sync()LOOPForm 2, with every argument
image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)SpriteCategoryBits(sprite, 1, 1)DO Sync()LOOPLoadImage and CreateSprite are there to give the call something to act on; SpriteCategoryBits 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.