public class MessagesOptions
extends xyz.srnyx.javautilities.parents.Stringable
AnnoyingPlugin.messages file| Modifier and Type | Class and Description |
|---|---|
static class |
MessagesOptions.MessageKeys
A class to hold the different default
AnnoyingPlugin.messages keys |
| Modifier and Type | Field and Description |
|---|---|
@NotNull java.lang.String |
fileName
OPTIONAL The file name of the messages file (usually messages.yml) |
AnnoyingResource.Options |
fileOptions
|
@NotNull MessagesOptions.MessageKeys |
keys
OPTIONAL The different message keys for some default messages in the messages file |
| Constructor and Description |
|---|
MessagesOptions()
Constructs a new
MessagesOptions instance with default values |
| Modifier and Type | Method and Description |
|---|---|
@NotNull MessagesOptions |
fileName(@NotNull java.lang.String fileName)
Sets
fileName |
@NotNull MessagesOptions |
fileOptions(AnnoyingResource.Options fileOptions)
Sets
fileOptions |
@NotNull MessagesOptions |
fileOptions(@NotNull java.util.function.Consumer<AnnoyingResource.Options> consumer)
Sets
fileOptions using the specified Consumer |
@NotNull MessagesOptions |
keys(@NotNull java.util.function.Consumer<MessagesOptions.MessageKeys> consumer)
Sets
keys |
@NotNull MessagesOptions |
keys(@NotNull MessagesOptions.MessageKeys keys)
Sets
keys |
static @NotNull MessagesOptions |
load(@NotNull org.bukkit.configuration.ConfigurationSection section)
Loads the options from the specified
ConfigurationSection |
@NotNull public @NotNull java.lang.String fileName
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.Options fileOptions
@NotNull public @NotNull MessagesOptions.MessageKeys keys
OPTIONAL The different message keys for some default messages in the messages filepublic MessagesOptions()
MessagesOptions instance with default values@NotNull public static @NotNull MessagesOptions load(@NotNull @NotNull org.bukkit.configuration.ConfigurationSection section)
ConfigurationSectionsection - the section to load the options from@NotNull public @NotNull MessagesOptions fileName(@NotNull @NotNull java.lang.String fileName)
fileNamefileName - the new fileNameMessagesOptions instance for chaining@NotNull public @NotNull MessagesOptions fileOptions(@Nullable AnnoyingResource.Options fileOptions)
fileOptionsfileOptions - the new fileOptionsMessagesOptions instance for chaining@NotNull public @NotNull MessagesOptions fileOptions(@NotNull @NotNull java.util.function.Consumer<AnnoyingResource.Options> consumer)
fileOptions using the specified Consumerconsumer - the consumer to accept the new fileOptionsMessagesOptions instance for chaining@NotNull public @NotNull MessagesOptions keys(@NotNull @NotNull MessagesOptions.MessageKeys keys)
keyskeys - the new keysMessagesOptions instance for chaining@NotNull public @NotNull MessagesOptions keys(@NotNull @NotNull java.util.function.Consumer<MessagesOptions.MessageKeys> consumer)
keysconsumer - the consumer to accept the new keysMessagesOptions instance for chaining