Skip to main contentBattle Pass Definition
Register a battle pass definition. The definition is stored in the BattlePassRegistry when instantiated.
Configuration
The id of this entry.
Name
The name of this entry.
Icon
Icon for the battle pass.
Description
Description of the battle pass.
Data
Artifact used to store runtime data.
Tiers
Configuration for battle pass tiers.
- Level: Display order of the tier (starting at 1).
- Permission: Permission required to access the tier.
- Priority: Priority controls which tier overrides another.
- Rewards: List of rewards for this tier.
- Slots: Slots used to display this tier’s rewards inside the menu.
Weeks
Configuration for battle pass weeks.
- Number: Week number (used for ordering).
- Title: Week title.
- Available: Whether the week is available.
- Description: Week description.
- Quests: Quests unlocked during this week.
- Unlock At: Explicit unlock date (ISO-8601).
- Unlock Offset Days: Unlock offset in days from the battle pass start date.
Layout
Menu layout configuration.
- Size: Menu size.
- Week Slots: Slots for weeks.
- Tier Button Slot: Slot for tier button.
- Quest Slots: Slots for quests.
- Navigation Slots: Previous/Next week, Previous/Next quest, etc.
- Back Command: Command executed when using the back button.
Schedule
Battle pass schedule configuration.
- Start: Battle pass start date (ISO-8601).
- End: Battle pass end date (ISO-8601).
- Week Duration Days: Duration of a week in days.
Configuration for menu buttons (Fill, Locked/Unlocked/Completed states for Tiers, Weeks, Quests, etc.).
XP configuration for the battle pass.
- Max: Max XP.
- Levels: XP required for each level.
