Package com.xebisco.yield

Class AnimationPlayer

java.lang.Object

com.xebisco.yield.AbstractBehavior

com.xebisco.yield.ComponentBehavior

com.xebisco.yield.AnimationPlayer

All Implemented Interfaces:

Behavior, Renderable, Closeable, AutoCloseable

public final class AnimationPlayer
extends ComponentBehavior

The AnimationPlayer class is a component behavior that handles the playing of animations by updating the texture rectangle with the current frame.

Constructor Summary

Constructors

Constructor	Description
AnimationPlayer()

Method Summary

Modifier and Type	Method	Description
int	actualFrame()	Returns the index of the current frame in the animation.
Animation	animation()	Returns the currently playing animation.
Animation	getAnimation()	Returns the currently playing animation.
void	onUpdate(ContextTime time)	This method is called every frame to update the animation player.
AnimationPlayer	setActualFrame(int actualFrame)	Sets the index of the current frame in the animation.
AnimationPlayer	setAnimation(Animation animation)	Sets the current animation to the given animation.
AnimationPlayer	setToChange(double toChange)	Sets the time since the last frame change.
AnimationPlayer	setToSwitchAnimation(Animation toSwitchAnimation)	Sets the animation that will be played after the current animation finishes.
double	toChange()	Returns the time since the last frame change.
Animation	toSwitchAnimation()	Returns the animation that will be played after the current animation finishes.

Methods inherited from class com.xebisco.yield.ComponentBehavior

application, close, component, component, entity, onCreate, onLateUpdate, onStart, render, renderIndex, setEntity, setRenderIndex, texture, texture, transform

Methods inherited from class com.xebisco.yield.AbstractBehavior

frames, tick

Methods inherited from class java.lang.Object

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

Constructor Details

AnimationPlayer

public AnimationPlayer()

Method Details

onUpdate

public void onUpdate(ContextTime time)

This method is called every frame to update the animation player.

Specified by:

onUpdate in interface Behavior

Overrides:

onUpdate in class ComponentBehavior

Parameters:

time - The context time, containing delta time.

getAnimation

public Animation getAnimation()

Returns the currently playing animation.

Returns:

The currently playing animation.

setAnimation

public AnimationPlayer setAnimation(Animation animation)

Sets the current animation to the given animation.

Parameters:

animation - The animation to set.

Returns:

This AnimationPlayer instance.

animation

public Animation animation()

Returns the currently playing animation.

Returns:

The currently playing animation.

toSwitchAnimation

public Animation toSwitchAnimation()

Returns the animation that will be played after the current animation finishes.

Returns:

The animation that will be played after the current animation finishes.

setToSwitchAnimation

public AnimationPlayer setToSwitchAnimation(Animation toSwitchAnimation)

Sets the animation that will be played after the current animation finishes.

Parameters:

toSwitchAnimation - The animation to set.

Returns:

This AnimationPlayer instance.

actualFrame

public int actualFrame()

Returns the index of the current frame in the animation.

Returns:

The index of the current frame in the animation.

setActualFrame

public AnimationPlayer setActualFrame(int actualFrame)

Sets the index of the current frame in the animation.

Parameters:

actualFrame - The index of the frame to set.

Returns:

This AnimationPlayer instance.

toChange

public double toChange()

Returns the time since the last frame change.

Returns:

The time since the last frame change.

setToChange

public AnimationPlayer setToChange(double toChange)

Sets the time since the last frame change.

Parameters:

toChange - The time to set.

Returns:

This AnimationPlayer instance.