Package io.github.rysefoxx.inventory.plugin.animator

Class IntelligentTitleAnimator.Builder

java.lang.Object

io.github.rysefoxx.inventory.plugin.animator.IntelligentTitleAnimator.Builder

Enclosing class:

IntelligentTitleAnimator

public static class IntelligentTitleAnimator.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IntelligentTitleAnimator	build(@NotNull InventoryContents contents)	This creates the animation class but does not start it yet!
@NotNull IntelligentTitleAnimator.Builder	color(char frame, @NotNull IntelligentItemColor color)	Assigns a color to a frame.
@NotNull IntelligentTitleAnimator.Builder	colors(@NotNull List<Character> frames, IntelligentItemColor @NotNull ... color)	Several frames are assigned individual colors.
@NotNull IntelligentTitleAnimator.Builder	colors(Character @NotNull [] frames, @NotNull List<IntelligentItemColor> color)	Several frames are assigned individual colors.
@NotNull IntelligentTitleAnimator.Builder	colors(Character @NotNull [] frames, IntelligentItemColor @NotNull ... color)	Several frames are assigned individual colors.
@NotNull IntelligentTitleAnimator.Builder	copy(@NotNull IntelligentTitleAnimator preset)	Takes over all properties of the passed animator.
@NotNull IntelligentTitleAnimator.Builder	delay(int time, @NotNull TimeSetting setting)	Specifies the delay before the animation starts.
@NotNull IntelligentTitleAnimator.Builder	frame(@NotNull String frame)	Adds another frame.
@NotNull IntelligentTitleAnimator.Builder	frames(@NotNull List<String> frames)	Adds several frames.
@NotNull IntelligentTitleAnimator.Builder	frames(String @NotNull ... frames)	Adds several frames.
@NotNull IntelligentTitleAnimator.Builder	identifier(@NotNull Object identifier)	Gives the Animation an identification
@NotNull IntelligentTitleAnimator.Builder	loop()	Keeps the animation running until the player closes the inventory.
@NotNull IntelligentTitleAnimator.Builder	period(int time, @NotNull TimeSetting setting)	Sets the speed of the animation in the scheduler.
@NotNull IntelligentTitleAnimator.Builder	type(@NotNull IntelligentItemAnimatorType type)	Decides how the name of the item should be animated.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

copy

@NotNull
public @NotNull IntelligentTitleAnimator.Builder copy(@NotNull
 @NotNull IntelligentTitleAnimator preset)

Takes over all properties of the passed animator.

Parameters:

preset - The animator to be copied.

Returns:

The Builder to perform further editing.

When copying the animator, the identification is not copied if present!

loop

@NotNull
public @NotNull IntelligentTitleAnimator.Builder loop()

Keeps the animation running until the player closes the inventory.

Returns:

The Builder to perform further editing.

type

@NotNull
public @NotNull IntelligentTitleAnimator.Builder type(@NotNull
 @NotNull IntelligentItemAnimatorType type)

Decides how the name of the item should be animated.

Parameters:

type - The animation type

Returns:

The Builder to perform further editing.

color

@NotNull
public @NotNull IntelligentTitleAnimator.Builder color(char frame,
 @NotNull
 @NotNull IntelligentItemColor color)

Assigns a color to a frame.

Parameters:

frame - The frame that should receive the color.

color - The color you want the frame to have.

Returns:

The Builder to perform further editing.

colors

@NotNull
public @NotNull IntelligentTitleAnimator.Builder colors(@NotNull
 @NotNull List<Character> frames,
 IntelligentItemColor @NotNull ... color)

Several frames are assigned individual colors.

Parameters:

frames - The frames that should receive the color.

color - The color you want the frames to have.

Returns:

The Builder to perform further editing.

Throws:

IllegalArgumentException - If the parameters are not equal.

colors

@NotNull
public @NotNull IntelligentTitleAnimator.Builder colors(Character @NotNull [] frames,
 IntelligentItemColor @NotNull ... color)

Several frames are assigned individual colors.

Parameters:

frames - The frames that should receive the color.

color - The color you want the frames to have.

Returns:

The Builder to perform further editing.

Throws:

IllegalArgumentException - If the parameters are not equal.

colors

@NotNull
public @NotNull IntelligentTitleAnimator.Builder colors(Character @NotNull [] frames,
 @NotNull
 @NotNull List<IntelligentItemColor> color)

Several frames are assigned individual colors.

Parameters:

frames - The frames that should receive the color.

color - The color you want the frames to have.

Returns:

The Builder to perform further editing.

Throws:

IllegalArgumentException - If the parameters are not equal.

frame

@NotNull
public @NotNull IntelligentTitleAnimator.Builder frame(@NotNull
 @NotNull String frame)
                                                throws IllegalArgumentException

Adds another frame.

Parameters:

frame - The frame to be added.

Returns:

The Builder to perform further editing.

Throws:

IllegalArgumentException - If no color has been assigned to the frame yet. e.g IntelligentItemNameAnimator.Builder.colors(List, IntelligentItemColor...)

frames

@NotNull
public @NotNull IntelligentTitleAnimator.Builder frames(String @NotNull ... frames)

Adds several frames.

Parameters:

frames - The frames to be added.

Returns:

The Builder to perform further editing.

Throws:

IllegalArgumentException - If no color has been assigned to the frame yet. e.g IntelligentItemNameAnimator.Builder.colors(List, IntelligentItemColor...)

frames

@NotNull
public @NotNull IntelligentTitleAnimator.Builder frames(@NotNull
 @NotNull List<String> frames)

Adds several frames.

Parameters:

frames - The frames to be added.

Returns:

The Builder to perform further editing.

Throws:

IllegalArgumentException - If no color has been assigned to the frame yet. e.g IntelligentItemNameAnimator.Builder.colors(List, IntelligentItemColor...)

period

@NotNull
public @NotNull IntelligentTitleAnimator.Builder period(@Nonnegative
 int time,
 @NotNull
 @NotNull TimeSetting setting)

Sets the speed of the animation in the scheduler.

Parameters:

time - The time.

setting - The time setting

Returns:

The Builder to perform further editing.

delay

@NotNull
public @NotNull IntelligentTitleAnimator.Builder delay(@Nonnegative
 int time,
 @NotNull
 @NotNull TimeSetting setting)

Specifies the delay before the animation starts.

Parameters:

time - The delay.

setting - The time setting

Returns:

The Builder to perform further editing.

identifier

@NotNull
public @NotNull IntelligentTitleAnimator.Builder identifier(@NotNull
 @NotNull Object identifier)

Gives the Animation an identification

Parameters:

identifier - The ID through which you can get the animation

Returns:

The Builder to perform further editing

build

public IntelligentTitleAnimator build(@NotNull
 @NotNull InventoryContents contents)
                               throws IllegalArgumentException

This creates the animation class but does not start it yet! IntelligentTitleAnimator.animate(Player)

Parameters:

contents - The contents of the inventory.

Returns:

The animation class

Throws:

IllegalArgumentException - if frameColor is empty, if frames is empty or if no color has been assigned to a frame.