Extends

• Sprite_Clickable

Members

bitmapBitmapinheritedoverrides

The bitmap for the sprite

blendModenumberinherited

The blend mode to be applied to the sprite

heightnumberinherited

The height of the sprite without the scale

opacitynumberinheritedoverrides

The opacity of the sprite (0 to 255)

widthnumberinherited

The width of the sprite without the scale

Methods

blockHeight()number

Get the height of a block

Returns:

Type	Description
number	The block height

blockWidth()number

Get the width of a block

Returns:

Type	Description
number	The block width

buttonData()Object

Gets button data

Returns:

Type	Description
Object	An object with button x and width data for the button type

checkBitmap()

Check if the bitmap is a valid MZ button bitmap

destroy()inherited

Destroys the sprite

getBlendColor()arrayinherited

Gets the blend color for the sprite

Returns:

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

getColorTone()arrayinherited

Gets the color tone for the sprite

Returns:

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

hide()inherited

Makes the sprite "hidden" (not visible)

hitTest(x, y)booleaninherited

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

Initializes the sprite

Name	Type	Description
bitmap	Bitmap	The bitmap of the sprite

isBeingTouched()booleaninherited

Check if the sprite is being touched

Returns:

Type	Description
boolean	True if the sprite is touched

isClickEnabled()booleaninherited

Check if the sprite is clickable

Returns:

Type	Description
boolean	True if the sprite is clickable

isPressed()booleaninherited

Check if the sprite is pressed

Returns:

Type	Description
boolean	True if the sprite is pressed

loadButtonImage()

Loads the button bitmap image

move(x, y)inherited

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()inheritedoverrides

Handling for when the sprite is clicked

onMouseEnter()inherited

Handling for when the mouse enters the sprite

onMouseExit()inherited

Handling for when the mouse exits the sprite

onPress()inherited

Handling for when the sprite is pressed

processTouch()inherited

Processing for touches

setBlendColor(color)inherited

Sets the blend color for the sprite

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

setClickHandler(method)

Sets the handler to be called when the button is clicked

Name	Type	Description
method	function	The function to call when clicked

setColdFrame()

Sets the button's cold frame (not pressed)

setColorTone(tone)inherited

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

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

setHotFrame()

Sets the button's hot frame (pressed)

setHue(hue)inherited

Sets the hue rotation value

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

setupFrames()

Sets up the button's frames

show()inherited

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

update()inheritedoverrides

Updates the sprite for each frame

updateFrame()

Update the button's frame

updateOpacity()

Update the button's opacity

updateVisibility()inherited

Updates the visibility status of the sprite