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

opacitynumberinherited

The opacity of the sprite (0 to 255)

widthnumberinherited

The width of the sprite without the scale

Methods

checkBattler(battler)boolean

Check if the current battler is the same as the passed battler

Name	Type	Description
battler	Game_Battler	The battler to check

Returns:

Type	Description
boolean	True if the battler matches the current battler

createDamageSprite()

Creates a damage popup sprite

damageOffsetX()number

Get the damage offset x value

Returns:

Type	Description
number	The damage offset x value

damageOffsetY()number

Get the damage offset y value

Returns:

Type	Description
number	The damage offset y value

destroy()inherited

Destroys the sprite

destroyDamageSprite(sprite)

Destroy a damage popup sprite

Name	Type	Description
sprite	Sprite_Damage	The damage sprite to destroy

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

inHomePosition()boolean

Check if the sprite is in its home position

Returns:

Type	Description
boolean	True if the sprite is in its home position

initMembers()

Initialize sprite variables

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

isEffecting()boolean

Check if the sprite is effecting

Returns:

Type	Description
boolean	True if effecting. By default this will always return false when called from Sprite_Battler

isMoving()boolean

Check if the sprite is moving

Returns:

Type	Description
boolean	True if moving.

isPressed()booleaninherited

Check if the sprite is pressed

Returns:

Type	Description
boolean	True if the sprite is pressed

mainSprite()Sprite_Battler

Get the main battler sprite

Returns:

Type	Description
Sprite_Battler	The main battler sprite

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

Processing when the sprite is clicked

onMouseEnter()overrides

Processing when the mouse enters the sprite

onMouseExit()inherited

Handling for when the mouse exits the sprite

onMoveEnd()

Processing for when movement ends

onPress()overrides

Processing when the sprite is pressed

processTouch()inherited

Processing for touches

setBattler(battler)

Set the battler to a new battler

Name	Type	Description
battler	Game_Battler	The new battler for the sprite

setBlendColor(color)inherited

Sets the blend color for the sprite

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

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

setHome(x, y)

Set the sprite's home

Name	Type	Description
x	number	The X value for the sprite's home
y	number	The Y value for the sprite's home

setHue(hue)inherited

Sets the hue rotation value

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

setupDamagePopup()

Sets up a damage popup sprite

show()inherited

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

startMove(x, y, duration)

Starts a movement for the sprite

Name	Type	Description
x	number	The target x offset for the sprite
y	number	The target y offset for the sprite
duration	number	The duration of the movement in frames

update()inheritedoverrides

Updates the sprite for each frame

updateBitmap()

Update the sprite's bitmap

updateDamagePopup()

Update the sprite's damage popups

updateFrame()

Update the sprite's frame

updateMain()

Update the main elements of the sprite

updateMove()

Update sprite movement

updatePosition()

Update the sprite's position

updateSelectionEffect()

Update the selection effect for the sprite

updateVisibility()inheritedoverrides

Updates the visibility status of the sprite