Mask (HSCore 4.4.2 API)

All Superinterfaces:: Initializable

All Known Implementing Classes:: AnimatedMask, BaseMask, ButtonMapMask, ButtonPaginatedMask, HybridMask, ListMask, MaskPaginatedMask, MultiSlotsMask, OneTimeAnimatedMask, PaginatedMask, PlaceholderMask, PredicateMask, SequencePaginatedMask, SingleMask, StaticButtonPaginatedMask, StaticMaskPaginatedMask, StaticSequencePaginatedMask

public interface Mask extends Initializable

The interface for all masks

Method Summary

Modifier and Type

Method

Description

static Mask

empty(String name)

Create an empty mask

Optional<Map<@NotNull Integer,@NotNull Button>>

generateButtons(@NotNull UUID uuid, @NotNull InventorySize inventorySize)

Generate the buttons for the unique id

@NotNull String

getName()

Get the name of the mask

Methods inherited from interface me.hsgamer.hscore.ui.property.Initializable
init, stop

Method Details
- empty
  
  static Mask empty(String name)
  
  Create an empty mask
  
  Parameters:
  
  name - the name of the mask
  
  Returns:
  
  the mask
- generateButtons
  
  Optional<Map<@NotNull Integer,@NotNull Button>> generateButtons(@NotNull @NotNull UUID uuid, @NotNull @NotNull InventorySize inventorySize)
  
  Generate the buttons for the unique id
  
  Parameters:
  
  uuid - the unique id
  
  inventorySize - the size of the inventory
  
  Returns:
  
  the map contains the slots and the buttons
- getName
  
  @NotNull @NotNull String getName()
  
  Get the name of the mask