Interface Mask

All Superinterfaces:
me.hsgamer.hscore.ui.property.Initializable
All Known Implementing Classes:
AnimatedMask, BaseMask, ButtonMapMask, ButtonPaginatedMask, HybridMask, ListMask, MaskPaginatedMask, MultiSlotsMask, PaginatedMask, PlaceholderMask, PredicateMask, SequencePaginatedMask, SingleMask, StaticButtonPaginatedMask, StaticMaskPaginatedMask, StaticSequencePaginatedMask

public interface Mask extends me.hsgamer.hscore.ui.property.Initializable
The interface for all masks
  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    canView(@NotNull UUID uuid)
    Check if the target can view the mask
    static Mask
    empty(String name)
    Create an empty mask
    @NotNull Map<@NotNull Integer,@NotNull Button>
    generateButtons(@NotNull UUID uuid)
    Generate the buttons for the unique id
    @NotNull String
    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
    • canView

      default boolean canView(@NotNull @NotNull UUID uuid)
      Check if the target can view the mask
      Parameters:
      uuid - the unique id of the target
      Returns:
      true if the target can view the mask
    • generateButtons

      @NotNull @NotNull Map<@NotNull Integer,@NotNull Button> generateButtons(@NotNull @NotNull UUID uuid)
      Generate the buttons for the unique id
      Parameters:
      uuid - the unique id
      Returns:
      the map contains the slots and the buttons
    • getName

      @NotNull @NotNull String getName()
      Get the name of the mask