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

Class SlideAnimation

java.lang.Object

io.github.rysefoxx.inventory.plugin.animator.SlideAnimation

public class SlideAnimation
extends Object

Since:

4/15/2022

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SlideAnimation.Builder

Constructor Summary

Constructors

Constructor	Description
SlideAnimation()

Method Summary

Modifier and Type	Method	Description
void	animate(@NotNull InventoryContents contents)	This starts the animation for the inventory.
static @NotNull SlideAnimation.Builder	builder(@NotNull org.bukkit.plugin.Plugin plugin)
void	clearTasks()
@Nullable Object	getIdentifier()	Returns the identifier of this object, or null if it has none.
@Unmodifiable @NotNull List<org.bukkit.scheduler.BukkitTask>	getTasks()	It returns a list of tasks that are currently running
boolean	isBlockClickEvent()	Returns true if the click event is blocked.

Methods inherited from class java.lang.Object

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

Constructor Details

SlideAnimation

public SlideAnimation()

Method Details

builder

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

animate

public void animate(@NotNull
 @NotNull InventoryContents contents)
             throws IllegalArgumentException

This starts the animation for the inventory.

Parameters:

contents - The inventory contents to animate.

Throws:

IllegalArgumentException - if invalid data was passed in the builder.

isBlockClickEvent

@Internal
public boolean isBlockClickEvent()

Returns true if the click event is blocked.

Returns:

The boolean value of the blockClickEvent variable.

getTasks

@Internal
@NotNull
public @Unmodifiable @NotNull List<org.bukkit.scheduler.BukkitTask> getTasks()
                                                                      throws UnsupportedOperationException

It returns a list of tasks that are currently running

Returns:

A list of BukkitTasks

Throws:

UnsupportedOperationException - If list gets modified

clearTasks

@Internal
public void clearTasks()

getIdentifier

@Nullable
public @Nullable Object getIdentifier()

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

Returns:

The identifier of the object.