Package io.github.projectunified.craftux.mask

Class OneTimeAnimatedMask

java.lang.Object

io.github.projectunified.craftux.mask.MultiMask<Mask>

io.github.projectunified.craftux.mask.OneTimeAnimatedMask

All Implemented Interfaces:

Element, Mask

public class OneTimeAnimatedMask
extends MultiMask<Mask>

The animated mask with child masks as frames, but only run once

Field Summary

Fields inherited from class io.github.projectunified.craftux.mask.MultiMask

elements

Constructor Summary

Constructors

Constructor	Description
OneTimeAnimatedMask()

Method Summary

Modifier and Type	Method	Description
@Nullable Map<Position,Consumer<ActionItem>>	apply(@NotNull UUID uuid)	Get a map of positions to action item consumers
void	reset(@NotNull UUID uuid)	Reset the animation for the unique id
void	setPeriodMillis(long periodMillis)	Set the period of the animation
void	setViewLast(boolean viewLast)	Set whether to view the last frame when the animation is finished
void	stop()	Stop the element.

Methods inherited from class io.github.projectunified.craftux.mask.MultiMask

add, add, getElements, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.projectunified.craftux.common.Mask

getActionMap

Constructor Details

OneTimeAnimatedMask

public OneTimeAnimatedMask()

Method Details

setPeriodMillis

public void setPeriodMillis(long periodMillis)

Set the period of the animation

Parameters:

periodMillis - the period in milliseconds

setViewLast

public void setViewLast(boolean viewLast)

Set whether to view the last frame when the animation is finished

Parameters:

viewLast - true to view the last frame

reset

public void reset(@NotNull
 @NotNull UUID uuid)

Reset the animation for the unique id

Parameters:

uuid - the unique id

stop

public void stop()

Description copied from interface: Element

Stop the element. Should be called after removing from the GUI.

Specified by:

stop in interface Element

Overrides:

stop in class MultiMask<Mask>

apply

@Nullable
public @Nullable Map<Position,Consumer<ActionItem>> apply(@NotNull
 @NotNull UUID uuid)

Description copied from interface: Mask

Get a map of positions to action item consumers

Parameters:

uuid - the uuid of the player

Returns:

the map, or null if no items should be displayed. Can return null in a conditional case (e.g. predicate mask)