Package io.github.projectunified.craftux.simple

Class SimpleButtonMask

java.lang.Object

io.github.projectunified.craftux.simple.SimpleButtonMask

All Implemented Interfaces:

Element, Mask

public class SimpleButtonMask
extends Object
implements Element, Mask

A simple mask that associates buttons with multiple positions in the GUI grid. Allows placing the same button in multiple slots or different buttons in various positions.

Example usage:

 SimpleButtonMask mask = new SimpleButtonMask();
 mask.setButton(Position.of(0, 0), new SimpleButton(new ItemStack(Material.GRASS_BLOCK)));
 mask.setButton(Position.of(1, 1), new SimpleButton(new ItemStack(Material.STONE)));
 mask.setButton(Position.of(0, 1), new SimpleButton(new ItemStack(Material.GRASS_BLOCK))); // Same button in multiple positions
 Map<Position, Consumer<ActionItem>> actions = mask.apply(playerUUID);
 

Constructor Summary

Constructors

Constructor	Description
SimpleButtonMask()

Method Summary

Modifier and Type	Method	Description
@NotNull Map<Position,Consumer<ActionItem>>	apply(@NotNull UUID uuid)	Get a map of positions to action item consumers
Map<Button,Collection<Position>>	getButtonSlotMap()	Get the button-to-slot map
void	init()	Initialize the element.
void	setButton(Position position, @NotNull Button button)	Set the button
void	setButton(Collection<Position> positions, @NotNull Button button)	Set the button
void	stop()	Stop the element.

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

SimpleButtonMask

public SimpleButtonMask()

Method Details

setButton

public void setButton(Position position,
 @NotNull
 @NotNull Button button)

Set the button

Parameters:

position - the position

button - the button

setButton

public void setButton(Collection<Position> positions,
 @NotNull
 @NotNull Button button)

Set the button

Parameters:

positions - the collection of position

button - the button

getButtonSlotMap

public Map<Button,Collection<Position>> getButtonSlotMap()

Get the button-to-slot map

Returns:

the button-to-slot map

init

public void init()

Description copied from interface: Element

Initialize the element. Should be called before adding to the GUI.

Specified by:

init in interface Element

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

apply

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

Description copied from interface: Mask

Get a map of positions to action item consumers

Specified by:

apply in interface Mask

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)