team.unnamed.creative.metadata.animation

Interface AnimationFrame

All Superinterfaces:

net.kyori.examination.Examinable

public interface AnimationFrame
extends net.kyori.examination.Examinable

Represents a texture animation frame, includes the index of the frame and its specific but optional frame-time, it will use AnimationMeta.frameTime() if it is not specified

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DELEGATE_FRAME_TIME Special value for frameTime() to declare that the frameTime is delegated to the container AnimationMeta

Method Summary

Modifier and Type	Method and Description
static @NotNull AnimationFrame	frame(int index) Creates a new animation frame with the specified index, no frame time is specified here, it depends on AnimationMeta
static @NotNull AnimationFrame	frame(int index, int frameTime) Creates a new animation frame with the specified index and frame time
int	frameTime() Returns the animation frame time, specifies the time in ticks to show this frame, uses AnimationMeta.frameTime() when it is not specified.
int	index() Returns the animation frame index, which is number corresponding to position of a frame from the top, with the top frame being 0.
static @NotNull AnimationFrame	of(int index) Deprecated. Use frame(int) instead
static @NotNull AnimationFrame	of(int index, int frameTime) Deprecated. Use frame(int, int) instead

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

DELEGATE_FRAME_TIME

static final int DELEGATE_FRAME_TIME

Special value for frameTime() to declare that the frameTime is delegated to the container AnimationMeta

Since:

1.0.0

See Also:

Constant Field Values

Method Detail

frame

@Contract(value="_, _ -> new")
 @NotNull
static @NotNull AnimationFrame frame(int index,
                                                                                int frameTime)

Creates a new animation frame with the specified index and frame time

Parameters:

index - The frame index

frameTime - The frame specific time

Returns:

A new and independent AnimationFrame instance

Since:

1.3.0

of

@Contract(value="_, _ -> new")
 @Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull AnimationFrame of(int index,
                                                                                                                                               int frameTime)

Deprecated. Use frame(int, int) instead

Creates a new animation frame with the specified index and frame time

Parameters:

index - The frame index

frameTime - The frame specific time

Returns:

A new and independent AnimationFrame instance

Since:

1.0.0

frame

@Contract(value="_ -> new")
 @NotNull
static @NotNull AnimationFrame frame(int index)

Creates a new animation frame with the specified index, no frame time is specified here, it depends on AnimationMeta

Parameters:

index - The animation frame index

Returns:

A new, dependent AnimationFrame instance

Since:

1.3.0

of

@Contract(value="_ -> new")
 @Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull AnimationFrame of(int index)

Deprecated. Use frame(int) instead

Creates a new animation frame with the specified index, no frame time is specified here, it depends on AnimationMeta

Parameters:

index - The animation frame index

Returns:

A new, dependent AnimationFrame instance

Since:

1.0.0

index

int index()

Returns the animation frame index, which is number corresponding to position of a frame from the top, with the top frame being 0.

Returns:

The frame index

Since:

1.0.0

frameTime

int frameTime()

Returns the animation frame time, specifies the time in ticks to show this frame, uses AnimationMeta.frameTime() when it is not specified.

Returns:

The frame time in ticks

Since:

1.0.0