team.unnamed.creative.metadata.animation

Interface AnimationMeta

All Superinterfaces:

net.kyori.examination.Examinable, MetadataPart

@ApiStatus.NonExtendable
public interface AnimationMeta
extends MetadataPart

Block and item textures support animation by placing each additional frame below the past. The animation is then controlled using this AnimationMeta type

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AnimationMeta.Builder Mutable and fluent-style builder for AnimationMeta and AnimationFrame instances

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FRAMETIME
static int	DEFAULT_HEIGHT
static boolean	DEFAULT_INTERPOLATE
static int	DEFAULT_WIDTH

Method Summary

Modifier and Type	Method and Description
static @NotNull AnimationMeta.Builder	animation() Returns a new instance of our builder implementation used to build AnimationMeta instances
static @NotNull AnimationMeta	animation(boolean interpolate, int width, int height, int frameTime, @NotNull java.util.List<AnimationFrame> frames) Creates a new AnimationMeta instance using the provided values
static @NotNull AnimationMeta.Builder	builder() Deprecated. Use animation() instead
@NotNull @Unmodifiable java.util.List<AnimationFrame>	frames() Returns an unmodifiable list of the animation AnimationFrame frames
int	frameTime() The global frame time for all frames, it can be overwritten by specific AnimationFrame elements
int	height() Returns the height of the tile as a ratio rather than in pixels.
boolean	interpolate() Determines if the animation is interpolated, in that case, Minecraft will generate frames between our frames
static @NotNull AnimationMeta	of(boolean interpolate, int width, int height, int frameTime, @NotNull java.util.List<AnimationFrame> frames) Deprecated. Use animation(boolean, int, int, int, List) instead
int	width() Returns the width of the tile, as a direct ratio rather than in pixels.

Methods inherited from interface team.unnamed.creative.metadata.MetadataPart

type

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

DEFAULT_FRAMETIME

static final int DEFAULT_FRAMETIME

See Also:

Constant Field Values

DEFAULT_WIDTH

static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_HEIGHT

static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

DEFAULT_INTERPOLATE

static final boolean DEFAULT_INTERPOLATE

See Also:

Constant Field Values

Method Detail

animation

@Contract(value="_, _, _, _, _ -> new")
 @NotNull
static @NotNull AnimationMeta animation(boolean interpolate,
                                                                                            int width,
                                                                                            int height,
                                                                                            int frameTime,
                                                                                            @NotNull
                                                                                            @NotNull java.util.List<AnimationFrame> frames)

Creates a new AnimationMeta instance using the provided values

Parameters:

interpolate - If frames must be interpolated

width - Frame-texture width ratio

height - Frame-texture height ratio

frameTime - Default frame time

frames - Animation frames

Returns:

A new AnimationMeta instance

Since:

1.3.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Contract(value="_, _, _, _, _ -> new")
 @NotNull
static @NotNull AnimationMeta of(boolean interpolate,
                                                                                                                                                       int width,
                                                                                                                                                       int height,
                                                                                                                                                       int frameTime,
                                                                                                                                                       @NotNull
                                                                                                                                                       @NotNull java.util.List<AnimationFrame> frames)

Deprecated. Use animation(boolean, int, int, int, List) instead

Creates a new AnimationMeta instance using the provided values

Parameters:

interpolate - If frames must be interpolated

width - Frame-texture width ratio

height - Frame-texture height ratio

frameTime - Default frame time

frames - Animation frames

Returns:

A new AnimationMeta instance

Since:

1.0.0

animation

@Contract(value="-> new")
 @NotNull
static @NotNull AnimationMeta.Builder animation()

Returns a new instance of our builder implementation used to build AnimationMeta instances

Returns:

A new builder instance

Since:

1.3.0

builder

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Contract(value="-> new")
 @NotNull
static @NotNull AnimationMeta.Builder builder()

Deprecated. Use animation() instead

Returns a new instance of our builder implementation used to build AnimationMeta instances

Returns:

A new builder instance

Since:

1.0.0

interpolate

boolean interpolate()

Determines if the animation is interpolated, in that case, Minecraft will generate frames between our frames

Returns:

True if animation is interpolated

Since:

1.0.0

width

int width()

Returns the width of the tile, as a direct ratio rather than in pixels. Can be used by resource packs to have frames that are not perfect squares

Returns:

The tile width

Since:

1.0.0

height

int height()

Returns the height of the tile as a ratio rather than in pixels. Can be used by resource packs to have frames that are not perfect squares

Returns:

The tile height

Since:

1.0.0

frameTime

int frameTime()

The global frame time for all frames, it can be overwritten by specific AnimationFrame elements

Returns:

The fallback frame-time for frames that don't specify one

Since:

1.0.0

frames

@NotNull
@NotNull @Unmodifiable java.util.List<AnimationFrame> frames()

Returns an unmodifiable list of the animation AnimationFrame frames

Returns:

The animation frames

Since:

1.0.0