Package io.github.projectunified.craftux.mask

Class AnimatedMask

java.lang.Object

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

io.github.projectunified.craftux.mask.AnimatedMask

All Implemented Interfaces:

Element, Mask

public class AnimatedMask
extends MultiMask<Mask>

A mask that cycles through a list of child masks as animation frames over time. Each frame is displayed for a configurable period, creating an animated GUI layout.

Example usage:

 AnimatedMask animatedMask = new AnimatedMask();
 animatedMask.add(
     new SingleMask(Position.of(0, 0), new SimpleButton(new ItemStack(Material.REDSTONE))),
     new SingleMask(Position.of(0, 0), new SimpleButton(new ItemStack(Material.LAPIS_LAZULI))),
     new SingleMask(Position.of(0, 0), new SimpleButton(new ItemStack(Material.GOLD_INGOT)))
 );
 animatedMask.setPeriodMillis(1000); // 1 second per frame
 Map<Position, Consumer<ActionItem>> actions = animatedMask.apply(playerUUID);
 

Field Summary

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

elements

Constructor Summary

Constructors

Constructor	Description
AnimatedMask()

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	setMode(AnimationMode mode)	Set the mode of the animation
void	setPeriodMillis(long periodMillis)	Set the period of the animation
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

AnimatedMask

public AnimatedMask()

Method Details

setPeriodMillis

public void setPeriodMillis(long periodMillis)

Set the period of the animation

Parameters:

periodMillis - the period in milliseconds

setMode

public void setMode(AnimationMode mode)

Set the mode of the animation

Parameters:

mode - the mode of the animation

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)