Package net.megavex.scoreboardlibrary.api.sidebar.component.animation

Class CollectionSidebarAnimation<T>

java.lang.Object

net.megavex.scoreboardlibrary.api.sidebar.component.animation.CollectionSidebarAnimation<T>

Type Parameters:

T - frame type

All Implemented Interfaces:

FramedSidebarAnimation<T>, SidebarAnimation<T>

public final class CollectionSidebarAnimation<T>
extends Object
implements FramedSidebarAnimation<T>

Implementation of FramedSidebarAnimation using a predefined collection of frames.

Constructor Summary

Constructors

Constructor	Description
CollectionSidebarAnimation(@NotNull Collection<T> frames)

Method Summary

Modifier and Type	Method	Description
T	currentFrame()
int	currentFrameIndex()
@Unmodifiable @NotNull List<T>	frames()
void	nextFrame()	Advances to the next frame of the animation
void	switchFrame(int frameIndex)	Switches the current frame to specified index

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionSidebarAnimation

public CollectionSidebarAnimation(@NotNull
 @NotNull Collection<T> frames)

Method Details

frames

@NotNull
public @Unmodifiable @NotNull List<T> frames()

Specified by:

frames in interface FramedSidebarAnimation<T>

Returns:

all frames in this animation

currentFrameIndex

public int currentFrameIndex()

Specified by:

currentFrameIndex in interface FramedSidebarAnimation<T>

Returns:

the index of the current frame

switchFrame

public void switchFrame(int frameIndex)

Description copied from interface: FramedSidebarAnimation

Switches the current frame to specified index

Specified by:

switchFrame in interface FramedSidebarAnimation<T>

Parameters:

frameIndex - the index of the new current frame

currentFrame

@NotNull
public T currentFrame()

Specified by:

currentFrame in interface SidebarAnimation<T>

Returns:

the current frame of the animation

nextFrame

public void nextFrame()

Description copied from interface: SidebarAnimation

Advances to the next frame of the animation

Specified by:

nextFrame in interface SidebarAnimation<T>