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

Class ClientBattleAnimationInstance

java.lang.Object

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

com.pixelmonmod.pixelmon.api.battles.animation.client.ClientBattleAnimationInstance

All Implemented Interfaces:

ActiveBattleAnimation, ContextHolder

public class ClientBattleAnimationInstance
extends BattleAnimationInstance

Server-side active animation instance for effects that are owned by the client renderer.

Field Summary

Fields inherited from class com.pixelmonmod.pixelmon.api.battles.animation.runtime.BattleAnimationInstance

action, attack, controller, target, ticks, user

Constructor Summary

Constructors

Constructor	Description
ClientBattleAnimationInstance(BattleAnimationAction action, BattleAnimationContext context)

Method Summary

Modifier and Type	Method	Description
UUID	animationId()	Returns the unique id used to pair start and stop packets for this client animation.
void	channel(String channel)	Sets the scheduling channel for this client animation.
void	cleanUp()	Cleans up state owned by this animation.
void	groupId(UUID groupId)	Sets the timeline group id shared by related client animations.
boolean	isContextAlive()	Checks whether the entities used by this animation are still present.
void	playOnClients()	Starts this animation on relevant clients if it has not already started.
boolean	started()	Returns whether the start packet has already been sent.

Methods inherited from class com.pixelmonmod.pixelmon.api.battles.animation.runtime.BattleAnimationInstance

action, advanceAnimationTicks, attack, controller, copy, isFinished, target, tick, ticks, user

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

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

get, getOrDefault, has, remove, set, update

Constructor Details

ClientBattleAnimationInstance

public ClientBattleAnimationInstance(BattleAnimationAction action,
 BattleAnimationContext context)

Method Details

animationId

public UUID animationId()

Returns the unique id used to pair start and stop packets for this client animation.

Returns:

the client animation id

started

public boolean started()

Returns whether the start packet has already been sent.

Returns:

true once playback has been started on clients

channel

public void channel(String channel)

Sets the scheduling channel for this client animation.

Parameters:

channel - the scheduling channel

groupId

public void groupId(UUID groupId)

Sets the timeline group id shared by related client animations.

Parameters:

groupId - the timeline group id

playOnClients

public void playOnClients()

Starts this animation on relevant clients if it has not already started.

cleanUp

public void cleanUp()

Description copied from interface: ActiveBattleAnimation

Cleans up state owned by this animation.

Specified by:

cleanUp in interface ActiveBattleAnimation

Overrides:

cleanUp in class BattleAnimationInstance

isContextAlive

public boolean isContextAlive()

Description copied from interface: ActiveBattleAnimation

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

Returns:

true when the animation context is still valid