Objeck Documentation

All Bundles

TitledImageSprite

Titled image sprite

Operations

AddTile
AddX
AddY
Free
GetHeight
GetPosition
GetWidth
IsOk
LoadImage
RemoveTile
Render

AddTile

Adds a tile at the specified location

method : public : AddTile(x:Int, y:Int) ~ ImageSprite

Parameters

Name	Type	Description
x	Int	x coordinate
y	Int	y coordinate

Return

Type	Description
ImageSprite	image sprite

AddX

Increments the current x-position

method : public : AddX(x:Int) ~ Nil

Parameters

Name	Type	Description
x	Int	increment to the current x-position

AddY

Increments the current y-position

method : public : AddY(y:Int) ~ Nil

Parameters

Name	Type	Description
y	Int	increment to the current y-position

Free

Destroys and frees sprite resources

method : public : Free() ~ Nil

GetHeight

Gets sprite height

method : public : GetHeight() ~ Int

Return

Type	Description
Int	sprite height

GetPosition

Gets relative sprite positions from original creation

method : public : GetPosition() ~ Position

Return

Type	Description
Position	relative sprite position

GetWidth

Gets sprite width

method : public : GetWidth() ~ Int

Return

Type	Description
Int	sprite width

IsOk

Initialization status flag

method : public : IsOk() ~ Bool

Return

Type	Description
Bool	true if initialized, false otherwise

LoadImage

Loads an image

method : private : LoadImage(file:String, colorkey:Color) ~ Bool

Parameters

Name	Type	Description
file	String	image to load
colorkey	Color	key color

Return

Type	Description
Bool	true if success, false otherwise

RemoveTile

Removes sprite

method : public : RemoveTile(sprite:ImageSprite) ~ Bool

Parameters

Name	Type	Description
sprite	ImageSprite	sprite to remove

Return

Type	Description
Bool	true if found and removed, false otherwise

Render

Renders an images based upon position instances

method : public : Render() ~ Nil