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

Class BattleAnimationTimeline

java.lang.Object

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

All Implemented Interfaces:

ActiveBattleAnimation, ContextHolder

public class BattleAnimationTimeline
extends Object
implements ActiveBattleAnimation

Runtime animation that schedules and coordinates multiple animation actions.

Constructor Summary

Constructors

Constructor	Description
BattleAnimationTimeline(BattleAnimationContext context, BattleAnimation animation)
BattleAnimationTimeline(BattleAnimationContext animationContext, BattleAnimationAudience audience, Map<String,Integer> markers, List<ScheduledBattleAnimationAction> schedule, UUID groupId)

Method Summary

Modifier and Type	Method	Description
void	acknowledgeClient(UUID playerId, UUID acknowledgementId)	Records a client acknowledgement for this animation.
Attack	attack()	Returns the attack associated with this animation.
BattleAnimationAudience	audience()	Returns the audience scope for this animation.
boolean	blocksBattle()	Returns whether battle flow should wait for this animation.
void	cleanUp()	Cleans up state owned by this animation.
void	cleanUpChannel(String channel)	Cleans up queued or active work in a specific animation channel.
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	isChannelBusy(String channel)	Checks whether an animation channel is currently busy.
boolean	isContextAlive()	Checks whether the entities used by this animation are still present.
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

getContext

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

get, getOrDefault, has, remove, set, update

Constructor Details

BattleAnimationTimeline

public BattleAnimationTimeline(BattleAnimationContext context,
 BattleAnimation animation)

BattleAnimationTimeline

public BattleAnimationTimeline(BattleAnimationContext animationContext,
 BattleAnimationAudience audience,
 Map<String,Integer> markers,
 List<ScheduledBattleAnimationAction> schedule,
 UUID groupId)

Method Details

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

audience

public BattleAnimationAudience audience()

Description copied from interface: ActiveBattleAnimation

Returns the audience scope for this animation.

Specified by:

audience in interface ActiveBattleAnimation

Returns:

the animation audience

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

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

isChannelBusy

public boolean isChannelBusy(String channel)

Description copied from interface: ActiveBattleAnimation

Checks whether an animation channel is currently busy.

Specified by:

isChannelBusy in interface ActiveBattleAnimation

Parameters:

channel - the channel to check

Returns:

true when the channel is busy

cleanUpChannel

public void cleanUpChannel(String channel)

Description copied from interface: ActiveBattleAnimation

Cleans up queued or active work in a specific animation channel.

Specified by:

cleanUpChannel in interface ActiveBattleAnimation

Parameters:

channel - the channel to clean up

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

isContextAlive

public boolean isContextAlive()

Description copied from interface: ActiveBattleAnimation

Checks whether the entities used by this animation are still present.

Specified by:

isContextAlive in interface ActiveBattleAnimation

Returns:

true when the animation context is still valid

cleanUp

public void cleanUp()

Description copied from interface: ActiveBattleAnimation

Cleans up state owned by this animation.

Specified by:

cleanUp in interface ActiveBattleAnimation

blocksBattle

public boolean blocksBattle()

Description copied from interface: ActiveBattleAnimation

Returns whether battle flow should wait for this animation.

Specified by:

blocksBattle in interface ActiveBattleAnimation

Returns:

true when this animation blocks battle progression

acknowledgeClient

public void acknowledgeClient(UUID playerId,
 UUID acknowledgementId)

Description copied from interface: ActiveBattleAnimation

Records a client acknowledgement for this animation.

Specified by:

acknowledgeClient in interface ActiveBattleAnimation

Parameters:

playerId - the acknowledging player

acknowledgementId - the acknowledgement id