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_Gauge.js:66

Gets the height of the bitmap

Returns:

Type	Description
number	The bitmap height

bitmapWidth()number

Sprite_Gauge.js:57

Gets the width of the bitmap

Returns:

Type	Description
number	The bitmap width

createBitmap()

Sprite_Gauge.js:46

Creates a bitmap for the sprite

currentMaxValue()number

Sprite_Gauge.js:297

Get the gauge's max value

Returns:

Type	Description
number	The max value of the gauge

currentValue()number

Sprite_Gauge.js:276

Get the gauge's current value

Returns:

Type	Description
number	The current value of the gauge

destroy()inheritedoverrides

Sprite.js:139

Destroys the sprite

drawGauge()

Sprite_Gauge.js:463

Draws the gauge

drawGaugeRect(x, y, width, height)

Sprite_Gauge.js:479

Draws the gauge by x/y/width/height

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

drawLabel()

Sprite_Gauge.js:508

Draws the label

drawValue()

Sprite_Gauge.js:556

Draws the gauge value

flashingColor1()Array

Sprite_Gauge.js:242

Get the color 1 flash

Returns:

Type	Description
Array	An array representing a blend color

flashingColor2()Array

Sprite_Gauge.js:251

Get the color 2 flash

Returns:

Type	Description
Array	An array representing a blend color

gaugeBackColor()string

Sprite_Gauge.js:336

Get the gauge's back color

Returns:

Type	Description
string	The color of the back of the gauge

gaugeColor1()string

Sprite_Gauge.js:345

Get the gauge's color 1

Returns:

Type	Description
string	The color 1 of the gauge

gaugeColor2()string

Sprite_Gauge.js:365

Get the gauge's color 2

Returns:

Type	Description
string	The color 2 of the gauge

gaugeHeight()number

Sprite_Gauge.js:85

Gets the height of the gauge

Returns:

Type	Description
number	The gauge height

gaugeRate()number

Sprite_Gauge.js:495

Gets the gauge rate

Returns:

Type	Description
number	x - The rate of the gauge (how much is filled)

gaugeX()number

Sprite_Gauge.js:94

Gets X coordinate of the gauge

Returns:

Type	Description
number	The X coordinate of the gauge

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_Gauge.js:27

Initialize sprite variables

initialize(bitmap)inheritedoverrides

Sprite.js:21

Initializes the sprite

Name	Type	Description
bitmap	Bitmap	The bitmap of the sprite

isValid()boolean

Sprite_Gauge.js:260

Check if the gauge is valid

Returns:

Type	Description
boolean	True if the gauge is valid

label()string

Sprite_Gauge.js:318

Get the gauge's label

Returns:

Type	Description
string	The label

labelColor()string

Sprite_Gauge.js:385

Get the gauge label's color

Returns:

Type	Description
string	The color of the label

labelFontFace()string

Sprite_Gauge.js:116

Gets the font face for the label

Returns:

Type	Description
string	The font face

labelFontSize()number

Sprite_Gauge.js:125

Gets the font size for the label

Returns:

Type	Description
number	The font size

labelOpacity()number

Sprite_Gauge.js:549

Gets the opacity of the label

Returns:

Type	Description
number	The opacity

labelOutlineColor()string

Sprite_Gauge.js:394

Get the gauge label outline color

Returns:

Type	Description
string	The color of the label outline

labelOutlineWidth()number

Sprite_Gauge.js:403

Get the gauge label outline width

Returns:

Type	Description
number	The width of the label outline

labelY()number

Sprite_Gauge.js:107

Gets the Y coordinate of the gauge label

Returns:

Type	Description
number	The Y coordinate

measureLabelWidth()number

Sprite_Gauge.js:537

Gets the width of the label

Since:

• Version 1.1.0

Returns:

Type	Description
number	The width

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

redraw()

Sprite_Gauge.js:446

Redraws the gauge

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, statusType)

Sprite_Gauge.js:153

Sets the sprite up

Name	Type	Description
battler	Game_Battler	The battler object to track
statusType	string	The type of stat to show in the gauge

setupLabelFont()

Sprite_Gauge.js:523

Sets up the label's font

setupValueFont()

Sprite_Gauge.js:567

Sets up the value font

show()inherited

Sprite.js:166

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

smoothness()number

Sprite_Gauge.js:202

Get the smoothness of the effect

Returns:

Type	Description
number	The smoothness of the effect

textHeight()number

Sprite_Gauge.js:76

Gets the text height

Since:

• Version 1.3.3

Returns:

Type	Description
number	The text height

update()inheritedoverrides

Sprite.js:147

Updates the sprite for each frame

updateBitmap()

Sprite_Gauge.js:169

Updates the sprite's bitmap

updateFlashing()

Sprite_Gauge.js:222

Updates the gauge flash effect

updateGaugeAnimation()

Sprite_Gauge.js:209

Updates the gauge animation effect

updateTargetValue(value, maxValue)

Sprite_Gauge.js:185

Updates for the target value of the gauge

Name	Type	Description
value	number	The current value of the gauge
maxValue	number	The max value of the gauge

updateVisibility()inherited

Sprite.js:174

Updates the visibility status of the sprite

valueColor()string

Sprite_Gauge.js:412

Get the color for the value based on type

Returns:

Type	Description
string	The color of the value

valueFontFace()string

Sprite_Gauge.js:134

Gets the font face for the value

Returns:

Type	Description
string	The font face

valueFontSize()number

Sprite_Gauge.js:143

Gets the font size for the value

Returns:

Type	Description
number	The font size

valueOutlineColor()string

Sprite_Gauge.js:430

Get the color for the value outline

Returns:

Type	Description
string	The color of the outline

valueOutlineWidth()number

Sprite_Gauge.js:439

Get the width of the value outline

Returns:

Type	Description
number	The width of the outline