| Modifier and Type | Class and Description |
|---|---|
static class |
AnnoyingOptions.MessageKeys
A class to hold the different default
AnnoyingPlugin.messages keys |
| Modifier and Type | Field and Description |
|---|---|
@NotNull java.lang.String |
bStatsFileName
REQUIRED The name of the file to use for the bStats toggle |
@Nullable java.lang.Integer |
bStatsId
RECOMMENDED The ID of the plugin on bStats |
AnnoyingResource.ResourceOptions |
bStatsOptions
|
@NotNull java.util.Set<AnnoyingCommand> |
commandsToRegister
OPTIONAL The AnnoyingCommands to register (add commands to this in the plugin's constructor) |
@NotNull java.util.List<AnnoyingDependency> |
dependencies
OPTIONAL The AnnoyingDependencys to check for (add dependencies to this in the plugin's constructor) |
@NotNull java.util.Set<AnnoyingListener> |
listenersToRegister
OPTIONAL The AnnoyingListeners to register (add listeners to this in the plugin's constructor) |
@NotNull AnnoyingOptions.MessageKeys |
messageKeys
OPTIONAL The different message keys for some default messages in the messages file |
@NotNull java.lang.String |
messagesFileName
OPTIONAL The file name of the messages file (usually messages.yml) |
AnnoyingResource.ResourceOptions |
messagesOptions
|
@Nullable java.util.function.Supplier<java.lang.Object> |
papiExpansionToRegister
|
PluginPlatform.Multi |
updatePlatforms
RECOMMENDED The different platforms the plugin is available on |
| Constructor and Description |
|---|
AnnoyingOptions()
Constructs a new
AnnoyingOptions instance with default values |
| Modifier and Type | Method and Description |
|---|---|
@NotNull org.bukkit.configuration.ConfigurationSection |
dump(@NotNull org.bukkit.configuration.ConfigurationSection section)
Dumps the object to an object
|
@Nullable me.clip.placeholderapi.expansion.PlaceholderExpansion |
getPapiExpansionToRegister()
Casts the
papiExpansionToRegister to a PlaceholderExpansion and returns it |
static @NotNull AnnoyingOptions |
load(@NotNull org.bukkit.configuration.ConfigurationSection section)
Loads the options from the specified
ConfigurationSection |
static @NotNull AnnoyingOptions |
load(@NotNull java.io.Reader reader)
Loads the options from the specified
Reader |
static @NotNull AnnoyingOptions |
load(@NotNull org.bukkit.configuration.file.YamlConfiguration yaml)
Loads the options from the specified
YamlConfiguration |
@Nullable public @Nullable java.lang.Integer bStatsId
@NotNull public @NotNull java.lang.String bStatsFileName
REQUIRED The name of the file to use for the bStats toggle
This is required as bStats requires a way to disable metrics. Tampering with this in such a way that removes the ability to disable metrics will result in your plugin being banned from bStats
IF YOU CHANGE THIS: The file MUST have an enabled key for a boolean to toggle bStats. If it doesn't, bStats will always be disabled
@Nullable public AnnoyingResource.ResourceOptions bStatsOptions
@NotNull public @NotNull java.lang.String messagesFileName
OPTIONAL The file name of the messages file (usually messages.yml)
If not specified, no messages will be loaded (plugin will still enable)
@Nullable public AnnoyingResource.ResourceOptions messagesOptions
@NotNull public @NotNull AnnoyingOptions.MessageKeys messageKeys
OPTIONAL The different message keys for some default messages in the messages file@NotNull public final @NotNull java.util.Set<AnnoyingCommand> commandsToRegister
OPTIONAL The AnnoyingCommands to register (add commands to this in the plugin's constructor)
If you add a command to this OUTSIDE the constructor, it will not be registered
@NotNull public final @NotNull java.util.Set<AnnoyingListener> listenersToRegister
OPTIONAL The AnnoyingListeners to register (add listeners to this in the plugin's constructor)
If you add a listener to this OUTSIDE the constructor, it will not be registered
@Nullable public @Nullable java.util.function.Supplier<java.lang.Object> papiExpansionToRegister
@NotNull public final @NotNull java.util.List<AnnoyingDependency> dependencies
OPTIONAL The AnnoyingDependencys to check for (add dependencies to this in the plugin's constructor)
If you add a dependency to this OUTSIDE the constructor, it will not be checked
This is NOT meant for optional dependencies, all of these dependencies will be downloaded/installed (even if AnnoyingDependency.required is false)
@NotNull public PluginPlatform.Multi updatePlatforms
RECOMMENDED The different platforms the plugin is available on
If not specified, the plugin will not be able to check for updates
public AnnoyingOptions()
AnnoyingOptions instance with default values@NotNull public static @NotNull AnnoyingOptions load(@NotNull @NotNull org.bukkit.configuration.file.YamlConfiguration yaml)
YamlConfigurationyaml - the configuration to load the options from@NotNull public static @NotNull AnnoyingOptions load(@NotNull @NotNull java.io.Reader reader)
Readerreader - the reader to load the options from@NotNull public static @NotNull AnnoyingOptions load(@NotNull @NotNull org.bukkit.configuration.ConfigurationSection section)
ConfigurationSectionsection - the section to load the options from@NotNull
public @NotNull org.bukkit.configuration.ConfigurationSection dump(@NotNull
@NotNull org.bukkit.configuration.ConfigurationSection section)
Dumpable@Nullable public @Nullable me.clip.placeholderapi.expansion.PlaceholderExpansion getPapiExpansionToRegister()
papiExpansionToRegister to a PlaceholderExpansion and returns itpapiExpansionToRegister as a PlaceholderExpansion or null if it is not a PlaceholderExpansion