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

Interface ClientBackedBattleAnimationAction

All Superinterfaces:

BattleAnimationAction

All Known Implementing Classes:

BattleCameraAnimationAction, BattleExitAnimationAction, BattleParticleAnimationAction, BattleSoundAnimationAction, PokemonAnimationAction, PokemonTerastalEffectAnimationAction, PokemonUiFaintAnimationAction, PokemonUiHealthAnimationAction, PokemonUiSwitchInAnimationAction, PokemonUiSwitchOutAnimationAction, PokemonVisibilityAnimationAction, SceneBlockAnimationAction, UiVisibilityAnimationAction

public interface ClientBackedBattleAnimationAction
extends BattleAnimationAction

Battle animation action whose visible effect is applied on each watching client.

Field Summary

Fields inherited from interface com.pixelmonmod.pixelmon.api.battles.animation.action.BattleAnimationAction

CODEC

Method Summary

Modifier and Type	Method	Description
default ActiveBattleAnimation	play(BattleAnimationContext context)	Creates the runtime animation instance for this action.
ClientBattleAnimationPlayback	play(ClientBattleAnimationContext context)	Starts the visible client-side playback for this action.
default boolean	sendsStopPacket()	Returns whether the server should send a stop packet for this action when the runtime instance is cleaned up.
default void	tick(BattleAnimationInstance animation)	Advances this action by one server tick.

Methods inherited from interface com.pixelmonmod.pixelmon.api.battles.animation.action.BattleAnimationAction

cleanUp, codec, isFinished, type

Method Details

play

default ActiveBattleAnimation play(BattleAnimationContext context)

Description copied from interface: BattleAnimationAction

Creates the runtime animation instance for this action.

Specified by:

play in interface BattleAnimationAction

Parameters:

context - the battle animation context

Returns:

the active runtime animation

tick

default void tick(BattleAnimationInstance animation)

Description copied from interface: BattleAnimationAction

Advances this action by one server tick.

Specified by:

tick in interface BattleAnimationAction

Parameters:

animation - the active runtime animation

play

ClientBattleAnimationPlayback play(ClientBattleAnimationContext context)

Starts the visible client-side playback for this action.

Parameters:

context - the client-side animation context

Returns:

the client playback handle

sendsStopPacket

default boolean sendsStopPacket()

Returns whether the server should send a stop packet for this action when the runtime instance is cleaned up.

Returns:

true when the client should receive a stop packet