Class: Sprite_StateOverlay

Sprite_StateOverlay()

new Sprite_StateOverlay()

The sprite for displaying an overlay image for a state.

Extends

Methods

animationWait() → {Number}

Returns:
Type
Number

hide()

Hides the sprite.
Inherited From:

initialize()

Overrides:

initMembers()

Initialize the overlay sprite properties.

isAnimationPlaying() → {boolean}

Returns true if an animation is currently playing.
Inherited From:
Returns:
Type
boolean

loadBitmap()

Loads the bitmap of the overlay sprite.

setup(battler)

Parameters:
Name Type Description
battler Game_Battler

show()

Shows the sprite.
Inherited From:

startAnimation(animation, mirror, delay)

Starts a new animation on the current sprite by assigning a new Sprite_Animation object to the sprite's parent.
Parameters:
Name Type Description
animation RPG.Animation
mirror Boolean
delay Number
Inherited From:

update()

Overrides:

updateAnimationSprites()

Updates the animation sprites, cloning them; if the sprite is playing, pushes the sprites into animation sprites, otherwise the sprite is removed.
Inherited From:

updatePattern()

Updates the overlay sprite pattern.

updateVisibility()

Updadtes the visibility of the sprite based on the _hiding property.
Inherited From: