@robojs/xp

API reference documentation for @robojs/xp.

Interfaces

• AddXpOptions - Options for adding XP to a user.
• FlashcoreOptions - Options for Flashcore storage layer operations.
• GetXpOptions - Options for retrieving XP data.
• GuildConfig - Per-guild XP system configuration.
• LeaderboardEntry - Leaderboard entry with user rank information.
• LevelDownEvent - Event emitted when a user levels down (XP loss).
• LevelProgress - Level progress information from computeLevelFromTotalXp.
• LevelUpEvent - Event emitted when a user levels up.
• PluginOptions - Plugin configuration options for @robojs/xp.
• RecalcOptions - Options for recalculating user levels.
• RecalcResult
• RoleReward - Role reward configuration.
• StoreOptions - Options for specifying which data store to use.
• UserXp - User XP data stored per guild member.
• XpChangeEvent - Event emitted when a user's XP changes (without level change).
• XpChangeResult
• XpRemoveResult
• XpSetResult

Type Aliases

• GlobalConfig - Global configuration defaults applied to all guilds.
• RewardsMode - Role reward mode - determines how multiple role rewards are applied.

Functions

• FormatXp - Formats XP with commas and custom label.
• GetXpLabel - Extracts custom XP label from guild config with fallback to 'XP'.

Variables

• Config - Configuration management for XP system.
• Constants - Default configuration constants.
• Default_curve_a - Default quadratic curve coefficients.
• Default_curve_b
• Default_curve_c
• Events - Event system for XP changes and level progression.
• Leaderboard - Leaderboard API for ranking and leaderboard operations.
• Math - Standard level curve mathematics.
• Rewards - Role rewards reconciliation API.
• Xp1 - XP manipulation API for programmatic XP management.
• Xp