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

bitmapHeight()number

Sprite_Name.js:61

Get the height of the sprite's bitmap

Returns:

Type	Description
number	The bitmap height

bitmapWidth()number

Sprite_Name.js:52

Get the width of the sprite's bitmap

Returns:

Type	Description
number	The bitmap width

createBitmap()

Sprite_Name.js:41

Creates the sprite's bitmap

destroy()inheritedoverrides

Sprite.js:139

Destroys the sprite

fontFace()string

Sprite_Name.js:70

Get the sprite's font face

Returns:

Type	Description
string	The font face

fontSize()number

Sprite_Name.js:79

Get the sprite's font size

Returns:

Type	Description
number	The font size

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)

initMembers()

Sprite_Name.js:27

Initialize the sprite's variables

initialize(bitmap)inheritedoverrides

Sprite.js:21

Initializes the sprite

Name	Type	Description
bitmap	Bitmap	The bitmap of the sprite

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

name()string

Sprite_Name.js:116

The name to show

Returns:

Type	Description
string	The name

outlineColor()string

Sprite_Name.js:134

The text outline color

Returns:

Type	Description
string	The outline color

outlineWidth()number

Sprite_Name.js:143

The text outline width

Returns:

Type	Description
number	The width

redraw()

Sprite_Name.js:150

Redraws the bitmap

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)

setup(battler)

Sprite_Name.js:88

Sets the sprite up

Name	Type	Description
battler	Game_Battler	The battler to track for the sprite

setupFont()

Sprite_Name.js:162

Sets up the bitmap's font

show()inherited

Sprite.js:166

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

textColor()string

Sprite_Name.js:125

The color to make the text

Returns:

Type	Description
string	The text color

update()inheritedoverrides

Sprite.js:147

Updates the sprite for each frame

updateBitmap()

Sprite_Name.js:101

Updates the bitmap

updateVisibility()inherited

Sprite.js:174

Updates the visibility status of the sprite