Package io.github.projectunified.craftux.common

Interface Mask

All Known Implementing Classes:
AnimatedMask, ButtonPaginatedMask, HybridMask, ListMask, MaskPaginatedMask, MultiMask, MultiPositionMask, OneTimeAnimatedMask, PaginatedMask, PlaceholderMask, PredicateMask, SequencePaginatedMask, SimpleButtonMask, SingleMask
public interface Mask
The mask that maps positions to action item consumers

  • Method Details

    • apply

      @Nullable @Nullable Map<Position,Consumer<ActionItem>> apply(@NotNull @NotNull UUID uuid)
      Get a map of positions to action item consumers
      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)

    • getActionMap

      @Nullable default @Nullable Map<Position,ActionItem> getActionMap(UUID uuid)
      Get a map of positions to action items
      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)