Class StoreCategoryDefinition<M>

java.lang.Object
net.blueva.arcade.api.store.StoreCategoryDefinition<M>
Type Parameters:
M - the material/icon type (platform-specific)
Record Components:
id - the unique identifier of this category
displayName - the user-friendly name displayed in the store interface
icon - the icon/material representing this category in menus
description - a list of description lines shown to players
scope - the visibility scope (GLOBAL for all games, MODULE for specific game)
parentCategoryId - the ID of the parent category, or null if this is a root category
type - the behavior type of this category (SELECTION, PURCHASE_ONLY, or GROUP)
moduleId - the game module ID if scope is MODULE, or null for GLOBAL scope
enabled - whether this category is currently active and visible to players
sortOrder - the display order relative to other categories (lower values appear first)
selectionEnabled - whether players can select an active item from this category
randomSelectionEnabled - whether a "random" option is available for selection
randomItemDisplayName - the display name for the random selection option
randomItemIcon - the icon/material for the random selection option
randomItemDescription - the description lines for the random selection option

public final class StoreCategoryDefinition<M> extends Object
Defines a store category available for players.

Store categories organize purchasable items into logical groups. Categories can be nested through parent-child relationships and can have different behaviors based on their type (selection, purchase-only, or group).

  • Constructor Details

    • StoreCategoryDefinition

      public StoreCategoryDefinition(String id, String displayName, M icon, List<String> description, StoreScope scope, String parentCategoryId, StoreCategoryType type, String moduleId, boolean enabled, int sortOrder, boolean selectionEnabled, boolean randomSelectionEnabled, String randomItemDisplayName, M randomItemIcon, List<String> randomItemDescription)
  • Method Details

    • id

      public String id()
    • displayName

      public String displayName()
    • icon

      public M icon()
    • description

      public List<String> description()
    • scope

      public StoreScope scope()
    • parentCategoryId

      public String parentCategoryId()
    • type

      public StoreCategoryType type()
    • moduleId

      public String moduleId()
    • enabled

      public boolean enabled()
    • sortOrder

      public int sortOrder()
    • selectionEnabled

      public boolean selectionEnabled()
    • randomSelectionEnabled

      public boolean randomSelectionEnabled()
    • randomItemDisplayName

      public String randomItemDisplayName()
    • randomItemIcon

      public M randomItemIcon()
    • randomItemDescription

      public List<String> randomItemDescription()
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object