The sprite for displaying an actor.
| Name | Type | Description |
|---|---|---|
battler | Game_Battler | The battler object |
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
- Index and loop data for a motion
Methods
checkBattler(battler)booleaninherited
- Check if the current battler is the same as the passed battler
Name Type Description battlerGame_Battler The battler to check Returns:
Type Description boolean True if the battler matches the current battler createDamageSprite()inherited
- Creates a damage popup sprite
- Creates the main sprite. See Sprite
- Creates a shadow sprite. See Sprite
- Creates a state overlay sprite. See Sprite_StateOverlay
- Creates a weapon sprite. See Sprite_Weapon
- Get the damage offset x value
Returns:
Type Description number The damage offset x value - Get the damage offset y value
Returns:
Type Description number The damage offset y value destroy()inherited
- Destroys the sprite
destroyDamageSprite(sprite)inherited
- Destroy a damage popup sprite
Name Type Description spriteSprite_Damage The damage sprite to destroy getBlendColor()arrayinherited
- Gets the blend color for the sprite
Returns:
Type Description array The blend color [r, g, b, a] getColorTone()arrayinherited
- Gets the color tone for the sprite
Returns:
Type Description array The color tone [r, g, b, gray] hide()inherited
- Makes the sprite "hidden" (not visible)
hitTest(x, y)booleaninherited
- Check if the touch is within the sprite
Name Type Description xnumber The x coordinate of the touch ynumber The y coordinate of the touch Returns:
Type Description boolean True if the x and y coordinates are inside the sprite inHomePosition()booleaninherited
- Check if the sprite is in its home position
Returns:
Type Description boolean True if the sprite is in its home position - Initialize sprite variables
- Initializes the sprite
Name Type Description bitmapBitmap The bitmap of the sprite isBeingTouched()booleaninherited
- Check if the sprite is being touched
Returns:
Type Description boolean True if the sprite is touched isClickEnabled()booleaninherited
- Check if the sprite is clickable
Returns:
Type Description boolean True if the sprite is clickable isEffecting()booleaninherited
- Check if the sprite is effecting
Returns:
Type Description boolean True if effecting. By default this will always return false when called from Sprite_Battler isMoving()booleaninherited
- Check if the sprite is moving
Returns:
Type Description boolean True if moving. isPressed()booleaninherited
- Check if the sprite is pressed
Returns:
Type Description boolean True if the sprite is pressed mainSprite()Sprite_Battlerinheritedoverrides
- Get the main battler sprite
Returns:
Type Description Sprite_Battler The main battler sprite - Get the motion speed
Returns:
Type Description number The speed of the motion move(x, y)inherited
- Sets the x and y coordiantes of the sprite
Name Type Description xnumber The x coordinate of the sprite ynumber The y coordinate of the sprite - Move the sprite to the starting position
onClick()inherited
- Processing when the sprite is clicked
onMouseEnter()inherited
- Processing when the mouse enters the sprite
onMouseExit()inherited
- Handling for when the mouse exits the sprite
- Processing for when movement ends
onPress()inherited
- Processing when the sprite is pressed
processTouch()inherited
- Processing for touches
- Refresh method for the motion
- Retreats the actor sprite
- Sets the actor sprite's home
Name Type Description indexnumber The index of the battler - Set the battler to a new battler
Name Type Description battlerGame_Battler The new battler for the sprite setBlendColor(color)inherited
- Sets the blend color for the sprite
Name Type Description colorarray The blend color [r, g, b, a] setColorTone(tone)inherited
- Sets the color tone for the sprite
Name Type Description tonearray The color tone [r, g, b, gray] setFrame(x, y, width, height)inherited
- Sets the rectagle of the bitmap that the sprite displays
Name Type Description xnumber The x coordinate of the frame ynumber The y coordinate of the frame widthnumber The width of the frame heightnumber The height of the frame setHome(x, y)inherited
- Set the sprite's home
Name Type Description xnumber The X value for the sprite's home ynumber The Y value for the sprite's home setHue(hue)inherited
- Sets the hue rotation value
Name Type Description huenumber The hue value (-360, 360) setupDamagePopup()inherited
- Sets up a damage popup sprite
- Sets up a motion
- Sets up a weapon animation
- Check if the actor should be stepped forward
Returns:
Type Description boolean True if the actor should be stepped forward show()inherited
- Removes the "hidden" state of the sprite, making it visible
- Starts the entry motion
- Starts a motion of given type
Name Type Description motionTypestring The type of motion to start startMove(x, y, duration)inherited
- Starts a movement for the sprite
Name Type Description xnumber The target x offset for the sprite ynumber The target y offset for the sprite durationnumber The duration of the movement in frames - Steps the actor sprite backward
- Steps the actor sprite forward
- Updates the sprite for each frame
- Update the sprite's bitmap
updateDamagePopup()inherited
- Update the sprite's damage popups
- Update the sprite's frame
- Update the main elements of the sprite
- Update for sprite motions
- Update the motion count
- Update sprite movement
updatePosition()inherited
- Update the sprite's position
updateSelectionEffect()inherited
- Update the selection effect for the sprite
- Update the shadow sprite
- Updates the sprite's target position
updateVisibility()inherited
- Updates the visibility status of the sprite