Extends

• Sprite

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

animationWait()number

The time for animation to wait

Returns:

Type	Description
number	Animation wait time

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)

initMembers()

Initialize the sprite's variables

initialize(bitmap)inheritedoverrides

Initializes the sprite

Name	Type	Description
bitmap	Bitmap	The bitmap of the sprite

loadBitmap()

Loads the iconset bitmap

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

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

setHue(hue)inherited

Sets the hue rotation value

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

setup(battler)

Set the sprite up

Name	Type	Description
battler	Game_Battler	The battler to track

shouldDisplay()boolean

Check if the sprite should display

Returns:

Type	Description
boolean	True if should display

show()inherited

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

update()inheritedoverrides

Updates the sprite for each frame

updateFrame()

Update the sprite's frame

updateIcon()

Updates the icon

updateVisibility()inherited

Updates the visibility status of the sprite