Home

TitledImageSprite

Titled image sprite

Implements: Shape

Operations

AddTile

Adds a tile at the specified location

method : public : AddTile(x:Int, y:Int) ~ ImageSprite
Parameters
NameTypeDescription
xIntx coordinate
yInty coordinate

Return
TypeDescription
ImageSpriteimage sprite

AddX

Increments the current x-position

method : public : AddX(x:Int) ~ Nil
Parameters
NameTypeDescription
xIntincrement to the current x-position

AddY

Increments the current y-position

method : public : AddY(y:Int) ~ Nil
Parameters
NameTypeDescription
yIntincrement to the current y-position

Free

Destroys and frees sprite resources

method : public : Free() ~ Nil

GetHeight

Gets sprite height

method : public : GetHeight() ~ Int
Return
TypeDescription
Intsprite height

GetPosition

Gets relative sprite positions from original creation

method : public : GetPosition() ~ Position
Return
TypeDescription
Positionrelative sprite position

GetWidth

Gets sprite width

method : public : GetWidth() ~ Int
Return
TypeDescription
Intsprite width

IsOk

Initialization status flag

method : public : IsOk() ~ Bool
Return
TypeDescription
Booltrue if initialized, false otherwise

LoadImage

Loads an image

method : public : LoadImage(file:String, colorkey:Color) ~ Bool
Parameters
NameTypeDescription
fileStringimage to load
colorkeyColorkey color

Return
TypeDescription
Booltrue if success, false otherwise

RemoveTile

Removes sprite

method : public : RemoveTile(sprite:ImageSprite) ~ Bool
Parameters
NameTypeDescription
spriteImageSpritesprite to remove

Return
TypeDescription
Booltrue if found and removed, false otherwise

Render

Renders an images based upon position instances

method : public : Render() ~ Nil