Class: Spriteset_Base

Spriteset_Base

new Spriteset_Base()

The superclass of Spriteset_Map and Spriteset_Battle.

Extends

Members

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

animationBaseDelay()number

Get animation base delay
Returns:
TypeDescription
numberBase delay of the animations

animationNextDelay()number

Get animation next delay
Returns:
TypeDescription
numberNext delay for animations

animationShouldMirror(target)boolean

Check if the animation should mirror
NameTypeDescription
targetGame_BattlerThe target to check for mirror
Returns:
TypeDescription
booleanTrue if should mirror

createAnimation(request)

Creates an animation
NameTypeDescription
requestObjectAn animation request object

createAnimationSprite(targets, animation, mirror, delay)

Creates an animation sprite
NameTypeDescription
targetsArrayThe array of animation targets
animationObjectThe data animation object
mirrorbooleanThe mirror property for an animation
delaynumberThe delay for the animation

createBaseFilters()

Creates the filters for the base sprite

createBaseSprite()

Creates the base sprite to display behind all other sprites

createLowerLayer()

Creates the lower layer of the spriteset

createOverallFilters()

Creates the overall filters

createPictures()

Creates a picture container and all necessary picture objects
Creates the timer sprite

createUpperLayer()

Creates the upper layer of the spriteset
Destroys the sprite

findTargetSprite()null

Finds a target sprite
Returns:
TypeDescription
nullWhen called from Spriteset_Base, this always returns null

getBlendColor()arrayinherited

Gets the blend color for the sprite
Returns:
TypeDescription
arrayThe blend color [r, g, b, a]

getColorTone()arrayinherited

Gets the color tone for the sprite
Returns:
TypeDescription
arrayThe color tone [r, g, b, gray]
Makes the sprite "hidden" (not visible)
Initializes the sprite
NameTypeDescription
bitmapBitmapThe bitmap of the sprite

isAnimationForEach()boolean

Check if the animation is for each
Returns:
TypeDescription
booleanTrue if for each

isAnimationPlaying()boolean

Check if there is an animation playing
Returns:
TypeDescription
booleanTrue if any animation is playing

isMVAnimation(animation)boolean

Check if the animation is MV or MZ type
NameTypeDescription
animationObjectThe data animation object
Returns:
TypeDescription
booleanTrue if MV animation type
Gets the last animation sprite
Returns:
TypeDescription
Sprite_Animation|Sprite_AnimationMVThe animation sprite object

loadSystemImages()

Loads required system images for the spriteset

makeTargetSprites(targets)Array

Gets the target sprites
NameTypeDescription
targetsArrayThe data objects of the targets
Returns:
TypeDescription
ArrayThe sprites of the data object targets
Sets the x and y coordiantes of the sprite
NameTypeDescription
xnumberThe x coordinate of the sprite
ynumberThe y coordinate of the sprite

pictureContainerRect()Rectangle

Get the rectangle where pictures can display
Returns:
TypeDescription
RectangleThe rectangle object of the picture container

processAnimationRequests()

Processes animation requests

removeAllAnimations()

Removes all animations

removeAnimation(sprite)

Removes an animation
NameTypeDescription
spriteSprite_Animation|Sprite_AnimationMVThe animation sprite to remove

setBlendColor(color)inherited

Sets the blend color for the sprite
NameTypeDescription
colorarrayThe blend color [r, g, b, a]

setColorTone(tone)inherited

Sets the color tone for the sprite
NameTypeDescription
tonearrayThe color tone [r, g, b, gray]

setFrame(x, y, width, height)inherited

Sets the rectagle of the bitmap that the sprite displays
NameTypeDescription
xnumberThe x coordinate of the frame
ynumberThe y coordinate of the frame
widthnumberThe width of the frame
heightnumberThe height of the frame
Sets the hue rotation value
NameTypeDescription
huenumberThe hue value (-360, 360)
Removes the "hidden" state of the sprite, making it visible
Updates the sprite for each frame

updateAnimations()

Updates the animations playing in the spriteset

updateBaseFilters()

Updates the base filters

updateOverallFilters()

Updates the overall filters

updatePosition()

Updates the position of the spriteset

updateVisibility()inherited

Updates the visibility status of the sprite