SequencePaginatedMask (HSCore 4.4.2 API)

java.lang.Object

me.hsgamer.hscore.minecraft.gui.mask.BaseMask

me.hsgamer.hscore.minecraft.gui.mask.impl.PaginatedMask

me.hsgamer.hscore.minecraft.gui.mask.impl.SequencePaginatedMask

All Implemented Interfaces:: Mask, Initializable

Direct Known Subclasses:: StaticSequencePaginatedMask

public abstract class SequencePaginatedMask extends PaginatedMask

A button paginated mask, where each Button is a page

Field Summary

Fields

Modifier and Type

Field

Description

protected final MaskSlot

maskSlot

Fields inherited from class me.hsgamer.hscore.minecraft.gui.mask.impl.PaginatedMask
cycle, pageNumberMap
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

SequencePaginatedMask(@NotNull String name, @NotNull MaskSlot maskSlot)

Create a new mask
Method Summary

Modifier and Type

Method

Description

Optional<Map<Integer,Button>>

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

Generate the buttons for the unique id

abstract @NotNull List<@NotNull Button>

getButtons(UUID uuid)

Get the buttons for the unique id

@NotNull MaskSlot

getMaskSlot()

Get the mask slot

void

stop()

Stop the object

Methods inherited from class me.hsgamer.hscore.minecraft.gui.mask.impl.PaginatedMask
generateButtons, getAndSetExactPage, getExactPage, getPage, isCycle, nextPage, previousPage, setCycle, setPage

Methods inherited from class me.hsgamer.hscore.minecraft.gui.mask.BaseMask
getName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Field Details
- maskSlot
  
  protected final MaskSlot maskSlot
Constructor Details
- SequencePaginatedMask
  
  protected SequencePaginatedMask(@NotNull @NotNull String name, @NotNull @NotNull MaskSlot maskSlot)
  
  Create a new mask
  
  Parameters:
  
  name - the name of the mask
  
  maskSlot - the mask slot
Method Details
- getMaskSlot
  
  @NotNull public @NotNull MaskSlot getMaskSlot()
  
  Get the mask slot
  
  Returns:
  
  the mask slot
- getButtons
  
  @NotNull public abstract @NotNull List<@NotNull Button> getButtons(UUID uuid)
  
  Get the buttons for the unique id
  
  Parameters:
  
  uuid - the unique id
  
  Returns:
  
  the buttons
- generateButtons
  
  public Optional<Map<Integer,Button>> generateButtons(@NotNull @NotNull UUID uuid, @NotNull @NotNull InventorySize inventorySize, int pageNumber)
  
  Description copied from class: PaginatedMask
  
  Generate the buttons for the unique id
  Specified by:
  
  generateButtons in class PaginatedMask
  
  Parameters:
  
  uuid - the unique id
  
  inventorySize - the size of the inventory
  
  pageNumber - the page number
  
  Returns:
  
  the map contains the slots and the buttons
  
  See Also:
  
  Mask.generateButtons(UUID, InventorySize)
- stop
  
  public void stop()
  
  Description copied from interface: Initializable
  
  Stop the object