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

Class BattleAnimationInstance

java.lang.Object

com.pixelmonmod.pixelmon.api.battles.animation.runtime.BattleAnimationInstance

All Implemented Interfaces:

ActiveBattleAnimation, ContextHolder

Direct Known Subclasses:

ClientBattleAnimationInstance, ContextualBattleAnimationInstance

public class BattleAnimationInstance
extends Object
implements ActiveBattleAnimation

Basic runtime animation instance that delegates behavior to a single action.

Field Summary

Fields

Modifier and Type	Field	Description
protected final BattleAnimationAction	action
protected final Attack	attack
protected final BattleController	controller
protected final PixelmonWrapper	target
protected int	ticks
protected final PixelmonWrapper	user

Constructor Summary

Constructors

Constructor	Description
BattleAnimationInstance(BattleAnimationAction action, BattleAnimationContext context)

Method Summary

Modifier and Type	Method	Description
BattleAnimationAction	action()	Returns the action driving this runtime animation.
protected void	advanceAnimationTicks()
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.
boolean	isFinished()	Returns whether this animation has finished.
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, getContext, isChannelBusy, isContextAlive

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

get, getOrDefault, has, remove, set, update

Field Details

action

protected final BattleAnimationAction action

controller

protected final BattleController controller

user

@Nullable
protected final PixelmonWrapper user

target

@Nullable
protected final PixelmonWrapper target

attack

@Nullable
protected final Attack attack

ticks

protected int ticks

Constructor Details

BattleAnimationInstance

public BattleAnimationInstance(BattleAnimationAction action,
 BattleAnimationContext context)

Method Details

action

public BattleAnimationAction action()

Returns the action driving this runtime animation.

Returns:

the backing animation action

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

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

tick

public void tick()

Description copied from interface: ActiveBattleAnimation

Advances this animation by one battle tick.

Specified by:

tick in interface ActiveBattleAnimation

advanceAnimationTicks

protected void advanceAnimationTicks()

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

cleanUp

public void cleanUp()

Description copied from interface: ActiveBattleAnimation

Cleans up state owned by this animation.

Specified by:

cleanUp in interface ActiveBattleAnimation

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