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

Class IntelligentTitleAnimator

java.lang.Object

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

public class IntelligentTitleAnimator
extends Object

Since:

4/12/2022

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IntelligentTitleAnimator.Builder

Constructor Summary

Constructors

Constructor	Description
IntelligentTitleAnimator()

Method Summary

Modifier and Type	Method	Description
void	animate(@NotNull org.bukkit.entity.Player player)
static @NotNull IntelligentTitleAnimator.Builder	builder(@NotNull org.bukkit.plugin.Plugin plugin)
@Nullable Object	getIdentifier()	Returns the identifier of this object, or null if it has none.
@NotNull org.bukkit.scheduler.BukkitTask	getTask()	This function returns the task that is currently running.
boolean	stop()	This stops the animation for the item.

Methods inherited from class java.lang.Object

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

Constructor Details

IntelligentTitleAnimator

public IntelligentTitleAnimator()

Method Details

builder

@Contract("_ -> new")
@NotNull
public static @NotNull IntelligentTitleAnimator.Builder builder(@NotNull
 @NotNull org.bukkit.plugin.Plugin plugin)

animate

public void animate(@NotNull
 @NotNull org.bukkit.entity.Player player)

Parameters:

player - the player to send the title to. This starts the animation for the item.

stop

public boolean stop()

This stops the animation for the item.

Returns:

true if the animation was stopped.

getTask

@Internal
@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask getTask()

This function returns the task that is currently running.

Returns:

The task that is being run.

getIdentifier

@Nullable
public @Nullable Object getIdentifier()

Returns the identifier of this object, or null if it has none.

Returns:

The identifier of the object.