AlonsoLevelsAPI

AlonsoLevelsAPI can be used to make some checks and modify player data easily.

com.alonsoaliaga.alonsolevels.api.AlonsoLevelsAPI

Available methods

boolean isLoaded(UUID uuid)

• Returns if player is loaded.

int getLevel(UUID uuid)

• Returns player's level. Returns -1 if player is not loaded.

String getColoredLevel(UUID uuid) (🔰 PREMIUM ONLY)

• Returns player's level with color code.

int getExperience(UUID uuid)

• Returns player's experience. Returns -1 if player is not loaded.

boolean isMaximumLevel(UUID uuid)

• Returns if player is in maximum level.

boolean addExperience(UUID uuid, int amount)

• Adds experience to player. Returns false if player is not loaded or amount is 0.

boolean removeExperience(UUID uuid, int amount)

• Remove experience from player. Returns false if player is not loaded or amount is 0.

boolean setExperience(UUID uuid, int experience)

• Set player's experience. Returns false if player is not loaded.

boolean addLevel(UUID uuid, int amount)

• Add levels to player. Returns false if player is not loaded or amount is 0.

boolean removeLevel(UUID uuid, int amount)

• Remove levels from player. Returns false if player is not loaded or amount is 0.

boolean setLevel(UUID uuid, int level)

• Set levels for a player. Returns false if player is not loaded. Doesn't call ExperienceChangeEvent.

int getProgressPercentage(UUID uuid)

• Returns level progress percentage. Returns -1 is player is not loaded.

String getProgressBar(UUID uuid)

• Returns progress bar for player. Returns empty bar if player is not loaded.

double getCoinMultiplier(UUID uuid)

• Returns multiplier amount. Returns 0.0 if player is not loaded. If multiplier is 3.0x returns 3.0

boolean openVeteranGUI(Player player)

• Open veteran gui for player. Returns whether success or not.

boolean openNormalGUI(Player player)

• Open normal gui for player. Returns whether success or not.

boolean openNormalGUI(Player player, int page)

• Open normal gui for player with page specified. Returns whether success or not.

[New methods added in 1.1-BETA]

boolean isVeteranEnabled()

• Returns if veteran mode is enabled in config.yml

double getAdditionalCoinMultiplier(UUID uuid)

• Returns the additional multiplier added. If multiplier is 3.0x it means player receives +2.0x so it returns 2.0

[New methods added in 2.2.4-BETA(-PRO)]

boolean setAutoClaim(@Nonnull Player player, boolean autoClaim)

• Set auto claim settings for a player. (Returns true if player is loaded, returns false if it isn't or plugin is Free version)

boolean hasAutoClaim(@Nonnull Player player)

• Set auto claim settings for a player. (Returns true if player has auto claim enabled, returns false if player is not loaded or plugin is Free version)

boolean isAutoClaimForceEnabled()

• Returns whether force auto-claim state is enabled. (Returns false if plugin is Free version)

boolean getAutoClaimForcedState()

• Returns the forced state for auto-claim. Make sure you check if isAutoClaimForceEnabled() returns true or not first. (Returns false if plugin is Free version)

Available events

PlayerRegisterEvent

• When player data is registered in database.

ResetDataEvent

• When player data is about to be deleted from database.

ExperienceChangeEvent

• When player experience is modified. (Not called if player level is set)

LevelChangeEvent

• When player level is changed.

RewardClaimEvent

• When player claims a reward.