Class catan.gui.Sprite
Drawable objects with extra rendering information.
Every sprite carries a drawable object (e.g. an image), and rendering information (which are used when drawing the object onto the screen).
Methods
| catan.gui.sprite:new (img, t) | Create a sprite |
| catan.gui.sprite:getX () | Get top-left corner x-coordinate |
| catan.gui.sprite:getY () | Get top-left corner y-coordinate |
| catan.gui.sprite:getCoords () | Get top-left corner coordinates |
| catan.gui.sprite:getWidth () | Get sprite width |
| catan.gui.sprite:getHeight () | Get sprite height |
| catan.gui.sprite:getDimensions () | Get sprite dimensions, taking scale into account |
| catan.gui.sprite:draw () | Draw sprite on screen |
| catan.gui.sprite:contains (x, y) | Check if (x, y) is inside sprite |
| catan.gui.sprite:hasCallback () | Check if sprite has callback |
| catan.gui.sprite:leftclick (x, y) | If (x, y) is inside sprite, trigger any "left click" callback |
| catan.gui.sprite:rightclick (x, y) | If (x, y) is inside sprite, trigger any "right click" callback |
Methods
- catan.gui.sprite:new (img, t)
-
Create a sprite
Parameters:
- img Drawable drawable object
- t sprite metadata
- x number x-coordinate (default 0)
- y number y-coordinate (default 0)
- r number clockwise rotation in radians (default 0)
- sx number x-scale factor (default 1)
- sy number y-scale factor (default sx)
- ox number x-origin (default 0)
- oy number y-origin (default 0)
- center
boolean
center image, overwrites
xalignandyalign(default true) - xalign
string
how to align the image horizontally, overwrites
ox(can be 'left', 'center' or 'right') (default 'left') - yalign
string
how to align the image vertically, overwrites
oy(can be 'top', 'center', 'bottom') (default 'top') - onleftclick function callback for when sprite is clicked with left mouse button
- onrightclick function callback for when sprite is clicked with right mouse button
Returns:
-
catan.gui.Sprite
the newly-created sprite
See also:
- catan.gui.sprite:getX ()
-
Get top-left corner x-coordinate
Returns:
-
number
x-coordinate
- catan.gui.sprite:getY ()
-
Get top-left corner y-coordinate
Returns:
-
number
y-coordinate
- catan.gui.sprite:getCoords ()
-
Get top-left corner coordinates
Returns:
- number x-coordinate
- number y-coordinate
- catan.gui.sprite:getWidth ()
-
Get sprite width
Returns:
-
number
width
- catan.gui.sprite:getHeight ()
-
Get sprite height
Returns:
-
number
height
- catan.gui.sprite:getDimensions ()
-
Get sprite dimensions, taking scale into account
Returns:
- number width
- number height
- catan.gui.sprite:draw ()
- Draw sprite on screen
- catan.gui.sprite:contains (x, y)
-
Check if (x, y) is inside sprite
Parameters:
- x number x-coordinate
- y number y-coordinate
Returns:
-
boolean
whether point is inside sprite
- catan.gui.sprite:hasCallback ()
-
Check if sprite has callback
Returns:
-
boolean
whether sprite has callback
- catan.gui.sprite:leftclick (x, y)
-
If (x, y) is inside sprite, trigger any "left click" callback
Parameters:
- x number x-coordinate
- y number y-coordinate
Returns:
-
boolean
whether the callback was called
- catan.gui.sprite:rightclick (x, y)
-
If (x, y) is inside sprite, trigger any "right click" callback
Parameters:
- x number x-coordinate
- y number y-coordinate
Returns:
-
boolean
whether the callback was called