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

Interface FramedSidebarAnimation<T>

Type Parameters:

T - frame type

All Superinterfaces:

SidebarAnimation<T>

All Known Implementing Classes:

CollectionSidebarAnimation

public interface FramedSidebarAnimation<T>
extends SidebarAnimation<T>

A SidebarAnimation with predetermined frames.

Method Summary

Modifier and Type	Method	Description
int	currentFrameIndex()
@Unmodifiable @NotNull List<T>	frames()
void	switchFrame(int frameIndex)	Switches the current frame

Methods inherited from interface net.megavex.scoreboardlibrary.api.sidebar.component.animation.SidebarAnimation

currentFrame, nextFrame

Method Details

frames

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

Returns:

all frames in this animation

currentFrameIndex

int currentFrameIndex()

Returns:

the index of the current frame

switchFrame

void switchFrame(int frameIndex)

Switches the current frame

Parameters:

frameIndex - the index of the new current frame

Throws:

ArrayIndexOutOfBoundsException - if frame is out of bounds