Extends

• Sprite

Members

bitmapBitmapinherited

The bitmap for the sprite

blendModenumberinherited

The blend mode to be applied to the sprite

heightnumberinherited

The height of the sprite without the scale

opacitynumberinherited

The opacity of the sprite (0 to 255)

widthnumberinherited

The width of the sprite without the scale

Methods

destroy()inherited

Sprite.js:139

Destroys the sprite

getBlendColor()arrayinherited

Sprite.js:231

Gets the blend color for the sprite

Returns:

Type	Description
array	The blend color [r, g, b, a]

getColorTone()arrayinherited

Sprite.js:255

Gets the color tone for the sprite

Returns:

Type	Description
array	The color tone [r, g, b, gray]

hide()inherited

Sprite.js:158

Makes the sprite "hidden" (not visible)

hitTest(x, y)boolean

Sprite_Clickable.js:96

Check if the touch is within the sprite

Name	Type	Description
x	number	The x coordinate of the touch
y	number	The y coordinate of the touch

Returns:

Type	Description
boolean	True if the x and y coordinates are inside the sprite

initialize(bitmap)inheritedoverrides

Sprite.js:21

Initializes the sprite

Name	Type	Description
bitmap	Bitmap	The bitmap of the sprite

isBeingTouched()boolean

Sprite_Clickable.js:83

Check if the sprite is being touched

Returns:

Type	Description
boolean	True if the sprite is touched

isClickEnabled()boolean

Sprite_Clickable.js:74

Check if the sprite is clickable

Returns:

Type	Description
boolean	True if the sprite is clickable

isPressed()boolean

Sprite_Clickable.js:65

Check if the sprite is pressed

Returns:

Type	Description
boolean	True if the sprite is pressed

move(x, y)inherited

Sprite.js:184

Sets the x and y coordiantes of the sprite

Name	Type	Description
x	number	The x coordinate of the sprite
y	number	The y coordinate of the sprite

onClick()

Sprite_Clickable.js:130

Handling for when the sprite is clicked

onMouseEnter()

Sprite_Clickable.js:109

Handling for when the mouse enters the sprite

onMouseExit()

Sprite_Clickable.js:116

Handling for when the mouse exits the sprite

onPress()

Sprite_Clickable.js:123

Handling for when the sprite is pressed

processTouch()

Sprite_Clickable.js:32

Processing for touches

setBlendColor(color)inherited

Sprite.js:240

Sets the blend color for the sprite

Name	Type	Description
color	array	The blend color [r, g, b, a]

setColorTone(tone)inherited

Sprite.js:264

Sets the color tone for the sprite

Name	Type	Description
tone	array	The color tone [r, g, b, gray]

setFrame(x, y, width, height)inherited

Sprite.js:197

Sets the rectagle of the bitmap that the sprite displays

Name	Type	Description
x	number	The x coordinate of the frame
y	number	The y coordinate of the frame
width	number	The width of the frame
height	number	The height of the frame

setHue(hue)inherited

Sprite.js:219

Sets the hue rotation value

Name	Type	Description
hue	number	The hue value (-360, 360)

show()inherited

Sprite.js:166

Removes the "hidden" state of the sprite, making it visible

update()inheritedoverrides

Sprite.js:147

Updates the sprite for each frame

updateVisibility()inherited

Sprite.js:174

Updates the visibility status of the sprite