Package net.blueva.arcade.api.store
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 categorydisplayName- the user-friendly name displayed in the store interfaceicon- the icon/material representing this category in menusdescription- a list of description lines shown to playersscope- 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 categorytype- the behavior type of this category (SELECTION, PURCHASE_ONLY, or GROUP)moduleId- the game module ID if scope is MODULE, or null for GLOBAL scopeenabled- whether this category is currently active and visible to playerssortOrder- the display order relative to other categories (lower values appear first)selectionEnabled- whether players can select an active item from this categoryrandomSelectionEnabled- whether a "random" option is available for selectionrandomItemDisplayName- the display name for the random selection optionrandomItemIcon- the icon/material for the random selection optionrandomItemDescription- the description lines for the random selection option
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 Summary
ConstructorsConstructorDescriptionStoreCategoryDefinition(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 Summary
-
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
-
displayName
-
icon
-
description
-
scope
-
parentCategoryId
-
type
-
moduleId
-
enabled
public boolean enabled() -
sortOrder
public int sortOrder() -
selectionEnabled
public boolean selectionEnabled() -
randomSelectionEnabled
public boolean randomSelectionEnabled() -
randomItemDisplayName
-
randomItemIcon
-
randomItemDescription
-
equals
-
hashCode
public int hashCode() -
toString
-