Package me.hsgamer.hscore.minecraft.gui.mask

Class PlaceholderMask

java.lang.Object

me.hsgamer.hscore.minecraft.gui.mask.PlaceholderMask

All Implemented Interfaces:

Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>, GUIElement

public class PlaceholderMask
extends Object
implements GUIElement, Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>

The placeholder mask
Used for per-user masks

Field Summary

Fields

Modifier and Type	Field	Description
protected Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>	defaultMask
protected final Map<UUID,Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>>	userMasks

Constructor Summary

Constructors

Constructor	Description
PlaceholderMask()

Method Summary

Modifier and Type	Method	Description
@Nullable Map<Integer,ActionItem>	apply(@NotNull InventoryContext context)
@NotNull Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>	getDefaultMask()	Get the default mask
@Nullable Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>	getMask(@NotNull UUID uuid)	Get the mask for the unique id
@NotNull Map<@NotNull UUID,@NotNull Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>>	getUserMasks()	Get the user-mask map
void	init()	Initialize the element.
void	setDefaultMask(@NotNull Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> defaultMask)	Set the default mask
void	setMask(@NotNull UUID uuid, @Nullable Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> mask)	Set the mask for the unique id
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 java.util.function.Function

andThen, compose

Field Details

userMasks

protected final Map<UUID,Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>> userMasks

defaultMask

protected Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> defaultMask

Constructor Details

PlaceholderMask

public PlaceholderMask()

Method Details

init

public void init()

Description copied from interface: GUIElement

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

Specified by:

init in interface GUIElement

stop

public void stop()

Description copied from interface: GUIElement

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

Specified by:

stop in interface GUIElement

apply

@Nullable
public @Nullable Map<Integer,ActionItem> apply(@NotNull
 @NotNull InventoryContext context)

Specified by:

apply in interface Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>

setMask

public void setMask(@NotNull
 @NotNull UUID uuid,
 @Nullable
 @Nullable Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> mask)

Set the mask for the unique id

Parameters:

uuid - the unique id

mask - the mask

getMask

@Nullable
public @Nullable Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> getMask(@NotNull
 @NotNull UUID uuid)

Get the mask for the unique id

Parameters:

uuid - the unique id

Returns:

the mask

getDefaultMask

@NotNull
public @NotNull Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> getDefaultMask()

Get the default mask

Returns:

the default mask

setDefaultMask

public void setDefaultMask(@NotNull
 @NotNull Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> defaultMask)

Set the default mask

Parameters:

defaultMask - the default mask

getUserMasks

@NotNull
public @NotNull Map<@NotNull UUID,@NotNull Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>> getUserMasks()

Get the user-mask map

Returns:

the user-mask map