Class: Sprite_Actor

Sprite_Actor(battleropt)

new Sprite_Actor(battleropt)

The sprite for displaying an actor.
Parameters:
Name Type Attributes Description
battler Game_Battler <optional>
Properties:
Name Type Description
MOTIONS Object [static]
Properties
Name Type Description
walk MV.Motion
wait MV.Motion
chant MV.Motion
guard MV.Motion
damage MV.Motion
evade MV.Motion
thrust MV.Motion
swing MV.Motion
missile MV.Motion
skill MV.Motion
spell MV.Motion
item MV.Motion
escape MV.Motion
victory MV.Motion
dying MV.Motion
abnormal MV.Motion
sleep MV.Motion
dead MV.Motion

Extends

Methods

createMainSprite()

Creates the main sprite of the sprite actor.

createShadowSprite()

Creates the shadow sprite of the sprite actor.

createStateSprite()

Creates the state sprite of the sprite actor.

createWeaponSprite()

Sets the weapon sprite of the sprite actor.

damageOffsetX() → {Number}

Overrides:
Returns:
Type
Number

damageOffsetY() → {Number}

Overrides:
Returns:
Type
Number

hide()

Hides the sprite.
Inherited From:

inHomePosition() → {Boolean}

Returns true if the sprite battler is in the home position.
Inherited From:
Returns:
Type
Boolean

initialize(battleropt)

Creates an instance of Sprite_Actor; can be passed a battler on creation.
Parameters:
Name Type Attributes Description
battler Game_Actor <optional>
Overrides:

initMembers()

Overrides:

isAnimationPlaying() → {boolean}

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

isEffecting() → {Boolean}

Returns false for sprite battler.
Inherited From:
Returns:
Type
Boolean

isMoving() → {boolean}

Returns true if the sprite for the battler is moving.
Inherited From:
Returns:
Type
boolean

motionSpeed() → {Number}

Returns the speed of the motion for the sprite actor.
Returns:
Type
Number

moveToStartPosition()

Moves the sprite actor to the start position.

onMoveEnd()

Overrides:

refreshMotion()

Refreshes the motion of the sprite actor.

retreat()

Has the sprite actor retreat.

setActorHome(index)

Parameters:
Name Type Description
index Number

setBattler(battler)

Sets the battler of the sprite actor.
Parameters:
Name Type Description
battler Game_Actor
Overrides:

setHome(x, y)

Sets the home position of the sprite battler to the given x and y coordinates.
Parameters:
Name Type Description
x Number
y Number
Inherited From:

setupAnimation()

Sets up animation on the sprite battler.
Inherited From:

setupDamagePopup()

Sets up damage popup on the sprite battler.
Inherited From:

setupMotion()

Sets up motion on the sprite actor.

setupWeaponAnimation()

Sets up weapon animation on the sprite actor.

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:

startEntryMotion()

Starts the entry motion of the sprite actor.

startMotion(motionType)

Starts the motion given the specified motion type.
Parameters:
Name Type Description
motionType String

startMove(x, y, duration)

Parameters:
Name Type Description
x Number
y Number
duration Number
Inherited From:

stepBack()

Has the sprite actor step back.

stepForward()

Has the sprite actor step forward.

update()

Overrides:

updateAnimation()

Updates the sprite battler animation.
Inherited From:

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:

updateBitmap()

Updates the sprite actor's movement.
Overrides:

updateDamagePopup()

Updates the damage pop up for the sprite battler.
Inherited From:

updateFrame()

Overrides:

updateMain()

Overrides:

updateMotion()

Updates the sprite actor's motion.

updateMotionCount()

updateMove()

Overrides:

updatePosition()

Updates the position of the sprite battler.
Inherited From:

updateSelectionEffect()

Inherited From:

updateShadow()

updateTargetPosition()

updateVisibility()

Inherited From: