team.unnamed.creative.metadata.animation

Interface AnimationMeta.Builder

Enclosing interface:

AnimationMeta

public static interface AnimationMeta.Builder

Mutable and fluent-style builder for AnimationMeta and AnimationFrame instances

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
@NotNull AnimationMeta.Builder	addFrame(@NotNull AnimationFrame frame) Adds an animation AnimationFrame frame
default @NotNull AnimationMeta.Builder	addFrame(int index) Adds an animation AnimationFrame frame index
default @NotNull AnimationMeta.Builder	addFrame(int index, int frameTime) Adds an animation AnimationFrame frame index with a specific frame time
@NotNull AnimationMeta	build() Finishes building the AnimationMeta instance, this method may fail if values were not correctly provided
default @NotNull AnimationMeta.Builder	frames(AnimationFrame... frames) Sets the animation AnimationFrame frames
default @NotNull AnimationMeta.Builder	frames(int... indexes) Sets the animation AnimationFrame frames
@NotNull AnimationMeta.Builder	frames(@NotNull java.util.List<AnimationFrame> frames) Sets the animation AnimationFrame frames
@NotNull AnimationMeta.Builder	frameTime(int frameTime) Sets the global frame time for all frames, it can be overwritten by specific AnimationFrame elements
@NotNull AnimationMeta.Builder	height(int height) Sets the height of the tile as a ratio rather than in pixels.
@NotNull AnimationMeta.Builder	interpolate(boolean interpolate) Sets whether this animation should interpolate frames or not.
@NotNull AnimationMeta.Builder	width(int width) Sets the width of the tile, as a direct ratio rather than in pixels.

Method Detail

interpolate

@Contract(value="_ -> this")
 @NotNull
@NotNull AnimationMeta.Builder interpolate(boolean interpolate)

Sets whether this animation should interpolate frames or not.

Interpolated animations will have some generated keyframes between the specified ones for a smoother look.

Parameters:

interpolate - Whether this animation should interpolate frames or not

Returns:

This builder

Since:

1.0.0

width

@Contract(value="_ -> this")
 @NotNull
@NotNull AnimationMeta.Builder width(int width)

Sets 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

Parameters:

width - The tile width

Returns:

This builder

Since:

1.0.0

height

@Contract(value="_ -> this")
 @NotNull
@NotNull AnimationMeta.Builder height(int height)

Sets 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

Parameters:

height - The tile height

Returns:

This builder

Since:

1.0.0

frameTime

@Contract(value="_ -> this")
 @NotNull
@NotNull AnimationMeta.Builder frameTime(int frameTime)

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

Parameters:

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

Returns:

This builder

Since:

1.0.0

frames

@Contract(value="_ -> this")
 @NotNull
@NotNull AnimationMeta.Builder frames(@NotNull
                                                                               @NotNull java.util.List<AnimationFrame> frames)

Sets the animation AnimationFrame frames

Parameters:

frames - The animation frames

Returns:

This builder

Since:

1.0.0

frames

@Contract(value="_ -> this")
 @NotNull
default @NotNull AnimationMeta.Builder frames(@NotNull
                                                                                       AnimationFrame... frames)

Sets the animation AnimationFrame frames

Parameters:

frames - The animation frames

Returns:

This builder

Since:

1.0.0

frames

@Contract(value="_ -> this")
 @NotNull
default @NotNull AnimationMeta.Builder frames(int... indexes)

Sets the animation AnimationFrame frames

Parameters:

indexes - The animation frames indexes

Returns:

This builder

Since:

1.0.0

addFrame

@Contract(value="_ -> this")
 @NotNull
@NotNull AnimationMeta.Builder addFrame(@NotNull
                                                                                 @NotNull AnimationFrame frame)

Adds an animation AnimationFrame frame

Parameters:

frame - The animation frame

Returns:

This builder

Since:

1.3.0

addFrame

@Contract(value="_ -> this")
 @NotNull
default @NotNull AnimationMeta.Builder addFrame(int index)

Adds an animation AnimationFrame frame index

Parameters:

index - The animation frame index

Returns:

This builder

Since:

1.3.0

addFrame

@Contract(value="_, _ -> this")
 @NotNull
default @NotNull AnimationMeta.Builder addFrame(int index,
                                                                                            int frameTime)

Adds an animation AnimationFrame frame index with a specific frame time

Parameters:

index - The animation frame index

frameTime - The animation frame time

Returns:

This builder

Since:

1.3.0

build

@Contract(value="-> new")
 @NotNull
@NotNull AnimationMeta build()

Finishes building the AnimationMeta instance, this method may fail if values were not correctly provided

Returns:

The recently created animation meta

Since:

1.0.0