Class: Sprite_Weapon

Sprite_Weapon

new Sprite_Weapon()

The sprite for displaying a weapon image for attacking.

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

animationWait()number

The time for animation to wait
Returns:
TypeDescription
numberAnimation wait time
Destroys the sprite

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)

initMembers()

Initialize the sprite's variables
Initializes the sprite
NameTypeDescription
bitmapBitmapThe bitmap of the sprite

isPlaying()boolean

Check if the sprite is playing
Returns:
TypeDescription
booleanTrue if the sprite is playing
Loads the sprite's bitmap
Sets the x and y coordiantes of the sprite
NameTypeDescription
xnumberThe x coordinate of the sprite
ynumberThe y coordinate of the sprite

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)

setup(weaponImageId)

Sets the sprite up
NameTypeDescription
weaponImageIdnumberThe id of the weapon image to use for the sprite
Removes the "hidden" state of the sprite, making it visible
Updates the sprite for each frame

updateFrame()

Updates the sprite's frame

updatePattern()

Updates the sprite's pattern

updateVisibility()inherited

Updates the visibility status of the sprite