mirror of
https://github.com/itHotL/PlayerStats.git
synced 2025-01-23 21:51:19 +01:00
Small javadoc changes
This commit is contained in:
parent
f2b09198b0
commit
a3c9f66fd8
@ -8,14 +8,14 @@ import org.bukkit.entity.EntityType;
|
||||
import org.jetbrains.annotations.Contract;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
/** This is the outgoing API that you can use to access the core functionality of PlayerStats.
|
||||
/** The outgoing API that you can use to access the core functionality of PlayerStats!
|
||||
To work with it, you need to call PlayerStats.{@link #getAPI()} to get an instance of
|
||||
{@link PlayerStatsAPI}. You can then use this object to access any of the further methods.
|
||||
<br>
|
||||
<br>Since calculating a top or server statistics can take some time, I strongly
|
||||
encourage you to call all the getServerStat() and getTopStats() methods from the
|
||||
{@link StatCalculator} asynchronously. Otherwise, the main Thread will have to wait
|
||||
until all calculations are done, and this might severely impact server performance.
|
||||
until all calculations are done, and this can severely impact server performance.
|
||||
*/
|
||||
public interface PlayerStats {
|
||||
|
||||
|
@ -6,10 +6,12 @@ import org.bukkit.Material;
|
||||
import org.bukkit.Statistic;
|
||||
import org.bukkit.command.CommandSender;
|
||||
import org.bukkit.entity.EntityType;
|
||||
import org.jetbrains.annotations.ApiStatus.Internal;
|
||||
|
||||
/** Turns user input into a valid {@link StatRequest}. This StatRequest should hold all
|
||||
the information PlayerStats needs to work with, and is used by the {@link StatCalculator}
|
||||
to get the desired statistic data.*/
|
||||
@Internal
|
||||
public interface RequestGenerator {
|
||||
|
||||
/** This will create a {@link StatRequest} from the provided args, with the requesting Player (or Console)
|
||||
|
@ -2,6 +2,7 @@ package com.gmail.artemis.the.gr8.playerstats.api;
|
||||
|
||||
import com.gmail.artemis.the.gr8.playerstats.enums.Target;
|
||||
import com.gmail.artemis.the.gr8.playerstats.models.StatRequest;
|
||||
import org.jetbrains.annotations.ApiStatus.Internal;
|
||||
|
||||
import java.util.LinkedHashMap;
|
||||
|
||||
@ -17,6 +18,7 @@ import java.util.LinkedHashMap;
|
||||
<br>
|
||||
<br>For more information on how to create a valid StatRequest,
|
||||
see the class description for {@link StatRequest}.*/
|
||||
@Internal
|
||||
public interface StatCalculator {
|
||||
|
||||
/** Returns the requested Statistic*/
|
||||
|
@ -4,6 +4,7 @@ import com.gmail.artemis.the.gr8.playerstats.models.StatRequest;
|
||||
import com.gmail.artemis.the.gr8.playerstats.msg.msgutils.ComponentUtils;
|
||||
import net.kyori.adventure.platform.bukkit.BukkitAudiences;
|
||||
import net.kyori.adventure.text.*;
|
||||
import org.jetbrains.annotations.ApiStatus.Internal;
|
||||
|
||||
import java.util.LinkedHashMap;
|
||||
|
||||
@ -22,6 +23,7 @@ import java.util.LinkedHashMap;
|
||||
{@link #statResultComponentToString(TextComponent)}. Don't use Adventure's method .content()
|
||||
on your statResult to do this - because of the way the TextComponent is built by PlayerStats,
|
||||
you won't be able to get the full content that way.*/
|
||||
@Internal
|
||||
public interface StatFormatter {
|
||||
|
||||
/** Turns a TextComponent into its String representation. If you don't want to work with
|
||||
|
@ -19,8 +19,8 @@ public final class ConfigHandler {
|
||||
private File configFile;
|
||||
private FileConfiguration config;
|
||||
|
||||
public ConfigHandler(Main p) {
|
||||
plugin = p;
|
||||
public ConfigHandler(Main plugin) {
|
||||
ConfigHandler.plugin = plugin;
|
||||
configVersion = 6;
|
||||
|
||||
saveDefaultConfig();
|
||||
|
@ -12,7 +12,7 @@ import org.jetbrains.annotations.NotNull;
|
||||
|
||||
import java.util.Random;
|
||||
|
||||
/**This class is just for fun, and adds some silly names for players on my server.
|
||||
/**This class is just for fun and adds some silly names for players on my server.
|
||||
It does not impact the rest of the plugin, and will only be used for the players mentioned in here.*/
|
||||
public final class EasterEggProvider {
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user