Package com.pixelmonmod.pixelmon.api.battles.attack.animation

Class AttackAnimation

java.lang.Object

com.pixelmonmod.pixelmon.api.battles.attack.animation.AttackAnimation

All Implemented Interfaces:

ActiveBattleAnimation, ContextHolder

public class AttackAnimation
extends Object
implements ActiveBattleAnimation

Runtime instance of an attack animation being played in battle.

This stores the battle context for the animation, tracks its tick progress, and delegates update, cleanup, and completion checks to the configured AttackAnimationLogic. Additional animation-specific state can be stored in the attached StoredContext.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Attack	attack
protected final StoredContext	context
protected final BattleController	controller
protected int	delayTicks
protected final AttackAnimationLogic	logic
protected final PixelmonWrapper	target
protected int	ticks
protected final PixelmonWrapper	user

Constructor Summary

Constructors

Constructor	Description
AttackAnimation(AttackAnimationLogic logic, BattleController controller, PixelmonWrapper user, PixelmonWrapper target, Attack attack)

Method Summary

Modifier and Type	Method	Description
Attack	attack()	Returns the attack associated with this animation.
void	cleanUp()	Cleans up state owned by this animation.
BattleController	controller()	Returns the battle controller this animation is attached to.
ActiveBattleAnimation	copy(BattleController newController)	Creates a copy of this animation attached to another battle controller.
void	delay(int ticks)	Delays ticking the animation logic by the supplied number of ticks.
StoredContext	getContext()
boolean	isFinished()	Returns whether this animation has finished.
AttackAnimationLogic	logic()
PixelmonWrapper	target()	Returns the Pokemon targeted by the animated action.
void	tick()	Advances this animation by one battle tick.
int	ticks()	Returns the number of 20 TPS animation ticks this animation has been active.
PixelmonWrapper	user()	Returns the Pokemon using the animated action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pixelmonmod.pixelmon.api.battles.animation.runtime.ActiveBattleAnimation

acknowledgeClient, audience, blocksBattle, cleanUpChannel, isChannelBusy, isContextAlive

Methods inherited from interface com.pixelmonmod.pixelmon.battles.controller.context.ContextHolder

get, getOrDefault, has, remove, set, update

Field Details

context

protected final StoredContext context

logic

protected final AttackAnimationLogic logic

controller

protected final BattleController controller

user

protected final PixelmonWrapper user

target

protected final PixelmonWrapper target

attack

protected final Attack attack

ticks

protected int ticks

delayTicks

protected int delayTicks

Constructor Details

AttackAnimation

public AttackAnimation(AttackAnimationLogic logic,
 BattleController controller,
 PixelmonWrapper user,
 PixelmonWrapper target,
 Attack attack)

Method Details

logic

public AttackAnimationLogic logic()

Returns:

the logic controlling this animation

delay

public void delay(int ticks)

Delays ticking the animation logic by the supplied number of ticks.

Parameters:

ticks - the number of ticks to delay the animation

ticks

public int ticks()

Description copied from interface: ActiveBattleAnimation

Returns the number of 20 TPS animation ticks this animation has been active.

Specified by:

ticks in interface ActiveBattleAnimation

Returns:

the active animation tick count

controller

public BattleController controller()

Description copied from interface: ActiveBattleAnimation

Returns the battle controller this animation is attached to.

Specified by:

controller in interface ActiveBattleAnimation

Returns:

the owning battle controller

user

public PixelmonWrapper user()

Description copied from interface: ActiveBattleAnimation

Returns the Pokemon using the animated action.

Specified by:

user in interface ActiveBattleAnimation

Returns:

the user Pokemon, or null when not applicable

target

public PixelmonWrapper target()

Description copied from interface: ActiveBattleAnimation

Returns the Pokemon targeted by the animated action.

Specified by:

target in interface ActiveBattleAnimation

Returns:

the target Pokemon, or null when not applicable

attack

public Attack attack()

Description copied from interface: ActiveBattleAnimation

Returns the attack associated with this animation.

Specified by:

attack in interface ActiveBattleAnimation

Returns:

the attack, or null when not applicable

getContext

public StoredContext getContext()

Specified by:

getContext in interface ActiveBattleAnimation

Specified by:

getContext in interface ContextHolder

copy

public ActiveBattleAnimation copy(BattleController newController)

Description copied from interface: ActiveBattleAnimation

Creates a copy of this animation attached to another battle controller.

Specified by:

copy in interface ActiveBattleAnimation

Parameters:

newController - the replacement battle controller

Returns:

the copied animation

tick

public void tick()

Description copied from interface: ActiveBattleAnimation

Advances this animation by one battle tick.

Specified by:

tick in interface ActiveBattleAnimation

cleanUp

public void cleanUp()

Description copied from interface: ActiveBattleAnimation

Cleans up state owned by this animation.

Specified by:

cleanUp in interface ActiveBattleAnimation

isFinished

public boolean isFinished()

Description copied from interface: ActiveBattleAnimation

Returns whether this animation has finished.

Specified by:

isFinished in interface ActiveBattleAnimation

Returns:

true when the animation is finished