mirror of
https://github.com/Sheldan/abstracto.git
synced 2026-03-07 08:33:59 +00:00
update JDA and jda Utilities version
fixed typos in the code
This commit is contained in:
@@ -7,14 +7,14 @@ import lombok.Setter;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Wrapper object containing a list of {@link LeaderBoardEntry} representing a leaderboard.
|
||||
* Wrapper object containing a list of {@link LeaderBoardEntry} representing a leader board.
|
||||
*/
|
||||
@Getter
|
||||
@Setter
|
||||
@Builder
|
||||
public class LeaderBoard {
|
||||
/**
|
||||
* List of {@link LeaderBoardEntry} representing the leaderboard.
|
||||
* List of {@link LeaderBoardEntry} representing the leader board.
|
||||
*/
|
||||
private List<LeaderBoardEntry> entries;
|
||||
}
|
||||
|
||||
@@ -29,7 +29,7 @@ public interface LeaderBoardEntryResult {
|
||||
Long getMessageCount();
|
||||
|
||||
/**
|
||||
* The current position of the {@link dev.sheldan.abstracto.core.models.database.AUserInAServer} in the leaderboard
|
||||
* The current position of the {@link dev.sheldan.abstracto.core.models.database.AUserInAServer} in the leader board
|
||||
* ordered by experience count
|
||||
*/
|
||||
Integer getRank();
|
||||
|
||||
@@ -7,7 +7,7 @@ import lombok.Setter;
|
||||
import net.dv8tion.jda.api.entities.Member;
|
||||
|
||||
/**
|
||||
* Model used in the list of members when rendering the leaderboard template. The reason this is necessary,
|
||||
* Model used in the list of members when rendering the leader board template. The reason this is necessary,
|
||||
* is because we need more than just the {@link AUserExperience} object, we also need the position of the user in this
|
||||
* guild and the {@link Member} for convenience in the templates.
|
||||
*/
|
||||
|
||||
@@ -8,8 +8,8 @@ import lombok.experimental.SuperBuilder;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Object containing the complete information passed to the leaderboard template. It contains the leaderboard
|
||||
* information of the requested page of the total users and the leaderboard information of the user executing the
|
||||
* Object containing the complete information passed to the leader board template. It contains the leader board
|
||||
* information of the requested page of the total users and the leader board information of the user executing the
|
||||
* command.
|
||||
*/
|
||||
@Getter
|
||||
|
||||
@@ -32,7 +32,7 @@ public interface ExperienceRoleService {
|
||||
* Calculates the appropriate {@link AExperienceRole} based on the provided list of {@link AExperienceRole}
|
||||
* @param userExperience The {@link AUserExperience} containing the level to calculate the {@link AExperienceRole}
|
||||
* @param roles The role configuration to be used when calculating the appropriate {@link AExperienceRole}
|
||||
* @return The best matching {@link AExperienceRole} accordign to the experience in the provided {@link AUserExperience}
|
||||
* @return The best matching {@link AExperienceRole} according to the experience in the provided {@link AUserExperience}
|
||||
*/
|
||||
AExperienceRole calculateRole(AUserExperience userExperience, List<AExperienceRole> roles);
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ import java.util.Optional;
|
||||
public interface ExperienceLevelManagementService {
|
||||
/**
|
||||
* Creates the level referenced by the level and the needed experience in the database.
|
||||
* @param level The unique level this level should reprsent.
|
||||
* @param level The unique level this level should represent.
|
||||
* @param neededExperience The total amount of experience required to reach this level.
|
||||
* @return A newly created {@link AExperienceLevel} instance.
|
||||
*/
|
||||
|
||||
@@ -44,7 +44,7 @@ public interface ExperienceRoleManagementService {
|
||||
AExperienceRole getRoleInServer(ARole role);
|
||||
|
||||
/**
|
||||
* Retrives all {@link AExperienceRole} configured in the given {@link AServer}
|
||||
* Retrieves all {@link AExperienceRole} configured in the given {@link AServer}
|
||||
* @param server The server to retrieve the list of {@link AExperienceRole} for
|
||||
* @return A list of {@link AExperienceRole} which are currently configured for the {@link AServer}
|
||||
*/
|
||||
|
||||
@@ -39,7 +39,7 @@ public interface UserExperienceManagementService {
|
||||
* are not changed.
|
||||
* @param user The {@link AUserInAServer} to increase the experience for
|
||||
* @param experience The experience amount to increase by
|
||||
* @param messageCount The amount of messags to increase the count by
|
||||
* @param messageCount The amount of messages to increase the count by
|
||||
* @return The changed/creates {@link AUserExperience} object containing the values.
|
||||
*/
|
||||
AUserExperience incrementExpForUser(AUserInAServer user, Long experience, Long messageCount);
|
||||
|
||||
Reference in New Issue
Block a user