Index
All Classes and Interfaces|All Packages
A
- addChild(ConfigurationNode<?>) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Ensures that the node's list of children includes the specified child node.
- appendUnderscoreToPrefix - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.Whether to automatically add an underscore between the prefix and the table name.
- appendUnderscoreToPrefix - Variable in class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
Whether to automatically add an underscore between the prefix and the table name.
- as(Class<T>, Object) - Static method in class dev.satyrn.papermc.api.util.v1.Cast
-
Safe-casts an object to another type.
- as(Class<T>, Object) - Static method in class dev.satyrn.papermc.api.util.v2.Cast
-
Deprecated.Safe-casts an object to another type.
- as(Object) - Static method in class dev.satyrn.papermc.api.util.v1.Cast
-
Performs an unsafe cast from an object to a generic type.
B
- BigDecimalNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configurable BigDecimal value.
- BigDecimalNode - Class in dev.satyrn.papermc.api.configuration.v3
-
Deprecated, for removal: This API element is subject to removal in a future version.
- BigDecimalNode(ConfigurationContainer, String) - Constructor for class dev.satyrn.papermc.api.configuration.v3.BigDecimalNode
-
Deprecated.Initializes a new Configuration node.
- BigDecimalNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.BigDecimalNode
-
Initializes a new Configuration node.
- BigIntegerNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configurable BigInteger value.
- BigIntegerNode - Class in dev.satyrn.papermc.api.configuration.v3
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.9.0 versioning refactor. To be removed in a future version; use
BigIntegerNode
instead. - BigIntegerNode(ConfigurationContainer, String) - Constructor for class dev.satyrn.papermc.api.configuration.v3.BigIntegerNode
-
Deprecated.Initializes a new Configuration node.
- BigIntegerNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.BigIntegerNode
-
Initializes a new Configuration node.
- BooleanNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configuration node with a boolean value.
- BooleanNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.BooleanNode
-
Creates a new configuration node with a boolean value.
C
- Cast - Class in dev.satyrn.papermc.api.util.v1
-
Utility for safe-casting between objects.
- Cast - Class in dev.satyrn.papermc.api.util.v2
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.9.0 versioning refactor. To be removed in a future version. Use
Cast
instead. - clamp(int, int, int) - Static method in class dev.satyrn.papermc.api.util.v1.MathHelper
-
Clamps an integer between a min and max value.
- clampd(double, double, double) - Static method in class dev.satyrn.papermc.api.util.v1.MathHelper
-
Clamps a double between a min and max value.
- clampf(float, float, float) - Static method in class dev.satyrn.papermc.api.util.v1.MathHelper
-
Clamps a float between a min and max value.
- CommandHandler - Class in dev.satyrn.papermc.api.commands.v1
-
Represents a basic command handler.
- CommandHandler(Plugin) - Constructor for class dev.satyrn.papermc.api.commands.v1.CommandHandler
-
Initializes a new instance of a command handler.
- ConfigurationConsumer<T extends ConfigurationNode<?>> - Interface in dev.satyrn.papermc.api.configuration.v1
-
Deprecated.Since 1.6.1. Use configuration node values directly.
- ConfigurationConsumer<T extends ConfigurationContainer> - Interface in dev.satyrn.papermc.api.configuration.v4
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.6.1. To be removed in a future version due to 1.9.0 versioning refactor. Use
ConfigurationConsumer
instead. - ConfigurationConsumerRegistry<T extends ConfigurationNode<?>> - Class in dev.satyrn.papermc.api.configuration.v1
-
Deprecated.Since 1.6.1. Use configuration node values directly.
- ConfigurationConsumerRegistry<T extends ConfigurationContainer> - Class in dev.satyrn.papermc.api.configuration.v4
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.6.1. To be removed due to 1.9.0 versioning refactor. Use
ConfigurationConsumerRegistry
instead. - ConfigurationConsumerRegistry() - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationConsumerRegistry
-
Deprecated.
- ConfigurationConsumerRegistry() - Constructor for class dev.satyrn.papermc.api.configuration.v4.ConfigurationConsumerRegistry
-
Deprecated.
- ConfigurationContainer - Class in dev.satyrn.papermc.api.configuration.v1
-
Deprecated.Since 1.9.0. Use
ContainerNode
andRootNode
instead. Will be removed in a future version. - ConfigurationContainer(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
-
Deprecated.Initializes the configuration container as a child of another container.
- ConfigurationContainer(Configuration) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.6.0. Use constructors which specify parent plugin instead. Will be removed in a future version.
- ConfigurationContainer(Plugin) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
-
Deprecated.Initializes the configuration container as a root container.
- ConfigurationContainer(Plugin, Configuration) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
-
Deprecated, for removal: This API element is subject to removal in a future version.since 1.9.0. To be removed in a future version.
- ConfigurationNode<T> - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a single configuration node.
- ConfigurationNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Initializes a new Configuration node.
- ConfigurationNode(ConfigurationNode<?>, String, Configuration) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.9.0. Use a constructor which does not use a
configuration
parameter, as the value of the parameter is ignored. - ConfigurationNode(Plugin, ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Initializes a new Configuration node.
- ConfigurationNode(Plugin, ConfigurationNode<?>, String, Configuration) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.9.0. Use a constructor which does not use a
configuration
parameter, as the value of the parameter is ignored. - connect() - Method in interface dev.satyrn.papermc.api.storage.v1.ConnectionManager
-
Opens a connection to the data source.
- connect() - Method in class dev.satyrn.papermc.api.storage.v1.MySQLConnectionManager
-
Deprecated.Opens a connection to the data source.
- connect() - Method in class dev.satyrn.papermc.api.storage.v2.MySQLConnectionManager
-
Opens a connection to the data source.
- ConnectionManager - Interface in dev.satyrn.papermc.api.storage.v1
-
Manages connections to a data source.
- ContainerNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a value-less node which contains other nodes.
- ContainerNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ContainerNode
-
Initializes the node as a child of another node.
- ContainerNode(Plugin) - Constructor for class dev.satyrn.papermc.api.configuration.v1.ContainerNode
-
Initializes the node without a parent.
D
- database - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.The name of the database to use.
- database - Variable in class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
The name of the database to use.
- DEFAULT_LOCALE - Static variable in class dev.satyrn.papermc.api.lang.v1.I18n
-
The default locale to use for translation.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.BigDecimalNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.BigIntegerNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.BooleanNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
-
Deprecated.Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.ContainerNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.DoubleNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.EnumListNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.EnumNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.IntegerNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.MapListNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.OptionalConfigurationNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.StringNode
-
Gets the default value of the node.
- defaultValue() - Method in class dev.satyrn.papermc.api.configuration.v1.TypedMapListNode
-
Gets the default value of the node.
- dev.satyrn.papermc.api.commands.v1 - package dev.satyrn.papermc.api.commands.v1
-
Provides implementations for commands.
- dev.satyrn.papermc.api.configuration.v1 - package dev.satyrn.papermc.api.configuration.v1
-
Provides implementations for configuration wrappers.
- dev.satyrn.papermc.api.configuration.v2 - package dev.satyrn.papermc.api.configuration.v2
-
Provides implementations for configuration wrappers.
- dev.satyrn.papermc.api.configuration.v3 - package dev.satyrn.papermc.api.configuration.v3
-
Provides implementations for configuration wrappers.
- dev.satyrn.papermc.api.configuration.v4 - package dev.satyrn.papermc.api.configuration.v4
-
Provides implementations for configuration wrappers.
- dev.satyrn.papermc.api.configuration.v5 - package dev.satyrn.papermc.api.configuration.v5
-
Provides implementations for configuration wrappers.
- dev.satyrn.papermc.api.lang.v1 - package dev.satyrn.papermc.api.lang.v1
- dev.satyrn.papermc.api.storage.v1 - package dev.satyrn.papermc.api.storage.v1
-
Provides implementations for storage access.
- dev.satyrn.papermc.api.storage.v2 - package dev.satyrn.papermc.api.storage.v2
-
Provides implementations for storage management.
- dev.satyrn.papermc.api.util.v1 - package dev.satyrn.papermc.api.util.v1
-
Contains commonly used utilities.
- dev.satyrn.papermc.api.util.v2 - package dev.satyrn.papermc.api.util.v2
-
Contains second-order breaking changes for classes in the
dev.datyrn.papermc.api.util.v1
package. - DifficultyDependentNode<T> - Class in dev.satyrn.papermc.api.configuration.v1
-
Deprecated.Since 1.9.1. Use
DifficultyDependentNode
instead. Default value is removed. - DifficultyDependentNode<T> - Class in dev.satyrn.papermc.api.configuration.v2
-
Represents a node which has a value dependent on difficulty.
- DifficultyDependentNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Initializes a new difficulty-dependent configuration node.
- DifficultyDependentNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Initializes a new difficulty-dependent configuration node.
- disable() - Method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Disables the internationalization handler.
- DoubleNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configuration node with a double-precision floating point value.
- DoubleNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.DoubleNode
-
Creates a new configuration node with a double-precision floating point value.
- DoubleNode(ConfigurationNode<?>, String, double, double) - Constructor for class dev.satyrn.papermc.api.configuration.v1.DoubleNode
-
Creates a new configuration node with a double-precision floating point value.
E
- enable() - Method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Enables the internationalization handler.
- enabled - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.Whether the MySQL server backend should be enabled.
- EnumListNode<E extends Enum<E>> - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configuration node with a list of enum values.
- EnumListNode<E extends Enum<E>> - Class in dev.satyrn.papermc.api.configuration.v2
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.9.0 versioning refactor. To be removed in a future version; use
EnumListNode
- EnumListNode(ConfigurationContainer, String) - Constructor for class dev.satyrn.papermc.api.configuration.v2.EnumListNode
-
Deprecated.Creates a new configuration node with a list of enum values.
- EnumListNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.EnumListNode
-
Creates a new configuration node with a list of enum values.
- EnumNode<E extends Enum<E>> - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configuration node with an enum value.
- EnumNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.EnumNode
-
Creates a new configuration node with an enum value.
- equals(Object) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class dev.satyrn.papermc.api.configuration.v1.RootNode
-
Indicates whether some other object is "equal to" this one.
F
- FileResourceClassLoader(ClassLoader, Plugin) - Constructor for class dev.satyrn.papermc.api.lang.v1.I18n.FileResourceClassLoader
-
Creates a new file resource class loader.
- flags - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.Options for the MySQL connection.
- flags - Variable in class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
Options for the MySQL connection.
- FLAT_FILE - Enum constant in enum class dev.satyrn.papermc.api.storage.v1.StorageType
-
Flat-file storage, such as YAML or text files.
G
- getActualValue() - Method in class dev.satyrn.papermc.api.configuration.v1.OptionalConfigurationNode
-
Gets the underlying value of the node.
- getBasePath() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the path of the base node.
- getBasePath(StringBuilder) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the path of the base node.
- getChildren() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets an unmodifiable list of children for this node.
- getChildren() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets an unmodifiable list of children for this node.
- getChildren() - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Gets an unmodifiable list of children for this node.
- getComments() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the comment list for the value node path.
- getComments(boolean) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the comment list for this node.
- getConfig() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the configuration instance for the plugin.
- getCurrentLocale() - Method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Gets the current locale.
- getDefault() - Method in class dev.satyrn.papermc.api.configuration.v1.EnumNode
-
Gets the default enum value.
- getDefault() - Method in class dev.satyrn.papermc.api.configuration.v1.StorageTypeNode
-
Gets the default enum value.
- getEasyNode() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets the node instance for the easy difficulty value.
- getEasyNode() - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Gets the node instance for the easy difficulty value.
- getHardNode() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets the node instance for the hard difficulty value.
- getHardNode() - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Gets the node instance for the hard difficulty value.
- getInlineComments() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the inline comment list for the value node path.
- getInlineComments(boolean) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the inline comment list for this node.
- getInstance() - Static method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Gets the current I18n instance.
- getKeyFor(Object) - Method in class dev.satyrn.papermc.api.configuration.v1.TypedMapListNode
-
Gets the value of a key in the map list.
- getLogger() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Returns the plugin logger associated with this server's logger.
- getName() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the name of the node.
- getNormalNode() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets the node instance for the normal difficulty value.
- getNormalNode() - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Gets the node instance for the normal difficulty value.
- getPath() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Deprecated.Since 1.9.0. Use
getValuePath()
orgetBasePath(StringBuilder)
instead. - getPath(StringBuilder) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Deprecated.Since 1.9.0. Use
getValuePath()
orgetBasePath(StringBuilder)
instead. - getPeacefulNode() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets the node instance for the peaceful difficulty value.
- getPeacefulNode() - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Gets the node instance for the peaceful difficulty value.
- getPlugin() - Method in class dev.satyrn.papermc.api.commands.v1.CommandHandler
-
Gets the plugin instance.
- getPlugin() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the plugin instance.
- getPlugin() - Method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Gets the plugin instance.
- getPriority() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the priority of this node.
- getResource(String) - Method in class dev.satyrn.papermc.api.lang.v1.I18n.FileResourceClassLoader
-
Finds the resource with the given name.
- getResourceAsStream(String) - Method in class dev.satyrn.papermc.api.lang.v1.I18n.FileResourceClassLoader
-
Returns an input stream for reading the specified resource.
- getResourceBundleForLocale(Locale) - Method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Gets a resource bundle for the current locale.
- getSLF4JLogger() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Returns the plugin logger associated with this server's logger.
- getUsage(CommandSender, Command) - Method in class dev.satyrn.papermc.api.commands.v1.CommandHandler
-
Gets the command usage hint.
- getValue() - Method in enum class dev.satyrn.papermc.api.configuration.v1.NodePriority
-
Gets the priority value of this enum entry.
- getValueFor(Object) - Method in class dev.satyrn.papermc.api.configuration.v1.TypedMapListNode
-
Gets the value of an object in the map list.
- getValueNodeName() - Method in class dev.satyrn.papermc.api.configuration.v1.BooleanNode
-
Gets the name of the "value" node, which will be used if this node contains children and a value.
- getValueNodeName() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the name of the value node, which will be used if this node contains children and a value.
- getValueNodeName() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets the name of the value node, which will be used if this node contains children and a value.
- getValueNodeName() - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Gets the name of the value node, which will be used if this node contains children and a value.
- getValuePath() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the path of the node that contains the value.
- getValuePath(StringBuilder) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the path of the node that contains the value.
- getVersion() - Method in class dev.satyrn.papermc.api.configuration.v1.RootNode
-
Gets the config version.
H
- hasChildren() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Whether the configuration node contains children.
- hasName() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Whether the configuration node is named.
- HIGH - Enum constant in enum class dev.satyrn.papermc.api.configuration.v1.NodePriority
-
The high priority value, which is only overwritten by
HIGHEST
priority nodes. - HIGHEST - Enum constant in enum class dev.satyrn.papermc.api.configuration.v1.NodePriority
-
The highest priority value, which is never overwritten.
- hostname - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.The MySQL server hostname.
- hostname - Variable in class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
The MySQL server hostname.
I
- I18n - Class in dev.satyrn.papermc.api.lang.v1
-
Provides internationalization support for a plugin.
- I18n(Plugin, String) - Constructor for class dev.satyrn.papermc.api.lang.v1.I18n
-
Initializes a new I18n instance.
- I18n(Plugin, ResourceBundle) - Constructor for class dev.satyrn.papermc.api.lang.v1.I18n
-
Initializes a new I18n instance.
- I18n.FileResourceClassLoader - Class in dev.satyrn.papermc.api.lang.v1
-
Custom class loader which loads locale bundles from the plugin data folder.
- I18n.Utf8LangFileControl - Class in dev.satyrn.papermc.api.lang.v1
-
Gathers a UTF-8 *.lang file into a resource bundle.
- IntegerNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configuration node with an integer value.
- IntegerNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.IntegerNode
-
Creates a new configuration node with an integer value.
- IntegerNode(ConfigurationNode<?>, String, int, int) - Constructor for class dev.satyrn.papermc.api.configuration.v1.IntegerNode
-
Creates a new configuration node with an integer value.
- isSubNode() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Whether the configuration node is a sub node or a root node.
L
- logb(double, double) - Static method in class dev.satyrn.papermc.api.util.v1.MathHelper
-
Gets the log of a value with the specified base.
- LOW - Enum constant in enum class dev.satyrn.papermc.api.configuration.v1.NodePriority
-
The low priority value, which is only overwritten by
NORMAL
toHIGHEST
priority nodes. - LOWEST - Enum constant in enum class dev.satyrn.papermc.api.configuration.v1.NodePriority
-
The lowest priority value, which is always overwritten, even by new
LOWEST
priority nodes.
M
- MapListNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configuration node with a map list value.
- MapListNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.MapListNode
-
Creates a new configuration node with a Map list value.
- MathHelper - Class in dev.satyrn.papermc.api.util.v1
-
Provides common math functions.
- MYSQL - Enum constant in enum class dev.satyrn.papermc.api.storage.v1.StorageType
-
Storage which is handled via a MySQL-like database.
- MySQLConfiguration - Class in dev.satyrn.papermc.api.configuration.v1
-
Deprecated.Since 1.9.0. Use
MySQLConfiguration
instead. - MySQLConfiguration - Class in dev.satyrn.papermc.api.configuration.v2
-
Represents a container of nodes which dictate the function of and options for the MySQL server backend.
- MySQLConfiguration - Class in dev.satyrn.papermc.api.configuration.v5
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.9.0 versioning refactor. To be removed in a future version; use
MySQLConfiguration
instead - MySQLConfiguration(ConfigurationContainer) - Constructor for class dev.satyrn.papermc.api.configuration.v5.MySQLConfiguration
-
Deprecated.Creates a new MySQL configuration container.
- MySQLConfiguration(ConfigurationNode<?>) - Constructor for class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.Creates a new MySQL configuration container.
- MySQLConfiguration(ConfigurationNode<?>) - Constructor for class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
Creates a new MySQL configuration container.
- MySQLConnectionManager - Class in dev.satyrn.papermc.api.storage.v1
-
Deprecated.
- MySQLConnectionManager - Class in dev.satyrn.papermc.api.storage.v2
-
Handles connections to a MySQL-like data source.
- MySQLConnectionManager(Plugin, MySQLConfiguration) - Constructor for class dev.satyrn.papermc.api.storage.v1.MySQLConnectionManager
-
Deprecated.Creates a new connection manager
- MySQLConnectionManager(Plugin, MySQLConfiguration) - Constructor for class dev.satyrn.papermc.api.storage.v2.MySQLConnectionManager
-
Creates a new MySQL connection manager
N
- newBundle(String, Locale, String, ClassLoader, boolean) - Method in class dev.satyrn.papermc.api.lang.v1.I18n.Utf8LangFileControl
-
Creates a new bundle from the *.lang file.
- NodePriority - Enum Class in dev.satyrn.papermc.api.configuration.v1
-
Used to determine whether a node should be superceded or supercede existing items in the node child list.
- NORMAL - Enum constant in enum class dev.satyrn.papermc.api.configuration.v1.NodePriority
-
The normal priority value, which is only overwritten by
HIGH
orHIGHEST
priority nodes.
O
- OptionalConfigurationNode<T> - Class in dev.satyrn.papermc.api.configuration.v1
-
A configuration node
- OptionalConfigurationNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.OptionalConfigurationNode
-
Initializes a new Configuration node.
P
- parse(String) - Method in class dev.satyrn.papermc.api.configuration.v1.EnumListNode
-
Parses the enum value.
- parse(String) - Method in class dev.satyrn.papermc.api.configuration.v1.EnumNode
-
Parses the enum value.
- parse(String) - Method in class dev.satyrn.papermc.api.configuration.v1.StorageTypeNode
-
Parses the enum value.
- password - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.The MySQL user password.
- password - Variable in class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
The MySQL user password.
- port - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.The MySQL server port.
- port - Variable in class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
The MySQL server port.
R
- register(K) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationConsumerRegistry
-
Deprecated.Registers a configuration consumer to the instance.
- reload(T) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationConsumerRegistry
-
Deprecated.Reloads the configuration for each consumer.
- reloadConfiguration(T) - Method in interface dev.satyrn.papermc.api.configuration.v1.ConfigurationConsumer
-
Deprecated.Reloads the configuration file.
- RootNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a value-less node which contains other nodes.
- RootNode(Plugin) - Constructor for class dev.satyrn.papermc.api.configuration.v1.RootNode
-
Initializes the configuration container as a root container.
S
- save() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Writes the value of the node to the config file.
- save() - Method in class dev.satyrn.papermc.api.configuration.v1.ContainerNode
-
Writes the value of the node to the config file.
- save() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Writes the value of the node and its children to the config file.
- save() - Method in class dev.satyrn.papermc.api.configuration.v1.OptionalConfigurationNode
-
Writes the value of the node to the config file.
- save() - Method in class dev.satyrn.papermc.api.configuration.v1.RootNode
-
Writes the value of the node to the config file.
- save() - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Writes the value of the node and its children to the config file.
- setComments(boolean, String...) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Sets the comment list for the node.
- setComments(String...) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Sets the comment list at the value node path.
- setConfigValue(Void) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
-
Deprecated.Sets the value of the node.
- setConfigValue(Void) - Method in class dev.satyrn.papermc.api.configuration.v1.ContainerNode
-
Sets the value of the node.
- setConfigValue(T) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Sets the value of the node in the configuration file.
- setInlineComments(boolean, String...) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Sets the inline comment list for the node.
- setInlineComments(String...) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Sets the inline comment list at the value node path.
- setLocale(String) - Method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Sets the current locale of the internationalization handler.
- setupCommand(PluginCommand) - Method in class dev.satyrn.papermc.api.commands.v1.CommandHandler
-
Sets up a plugin command.
- setupCommand(Plugin, String) - Method in class dev.satyrn.papermc.api.commands.v1.CommandHandler
-
Sets up a plugin command by name.
- setUsage(String) - Method in class dev.satyrn.papermc.api.commands.v1.CommandHandler
-
Sets the command usage hint.
- setValue(Difficulty, T) - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Sets the value of the node for a specific difficulty.
- setValue(Difficulty, T) - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Sets the value of the node for a specific difficulty.
- setValue(Boolean) - Method in class dev.satyrn.papermc.api.configuration.v1.BooleanNode
-
Sets the value of the node in the configuration file.
- setValue(Double) - Method in class dev.satyrn.papermc.api.configuration.v1.DoubleNode
-
Sets the value of the node.
- setValue(Integer) - Method in class dev.satyrn.papermc.api.configuration.v1.IntegerNode
-
Sets the value of the node.
- setValue(T) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.10.0. Use
setConfigValue(T)
instead. Will be removed in the future. - setVersion(int) - Method in class dev.satyrn.papermc.api.configuration.v1.RootNode
-
Sets the config version.
- StorageType - Enum Class in dev.satyrn.papermc.api.storage.v1
-
Indexes multiple types of storage.
- StorageTypeNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configuration node which stores a
StorageType
value. - StorageTypeNode - Class in dev.satyrn.papermc.api.configuration.v5
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.9.0 versioning refactor. To be removed in a future version; use
StorageTypeNode
instead. - StorageTypeNode(ConfigurationContainer, String) - Constructor for class dev.satyrn.papermc.api.configuration.v5.StorageTypeNode
-
Deprecated.Creates a new configuration node with a Log Level value.
- StorageTypeNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.StorageTypeNode
-
Creates a new configuration node with a Log Level value.
- StringNode - Class in dev.satyrn.papermc.api.configuration.v1
-
Represents a configuration node with a string value.
- StringNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.StringNode
-
Creates a new configuration node with a string value.
T
- tablePrefix - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.Optional prefix for any created table's names.
- tablePrefix - Variable in class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
Optional prefix for any created table's names.
- toBundleName(String, Locale) - Method in class dev.satyrn.papermc.api.lang.v1.I18n.Utf8LangFileControl
-
Gets the bundle name of this resource.
- toString() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Returns the string representation of this node.
- toString(StringBuilder) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
-
Deprecated.Builds the string representation of the node.
- toString(StringBuilder) - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Builds the string value of the node.
- toString(StringBuilder) - Method in class dev.satyrn.papermc.api.configuration.v1.ContainerNode
-
Builds the string representation of the node.
- toString(StringBuilder) - Method in class dev.satyrn.papermc.api.configuration.v1.RootNode
-
Builds the string representation of the node.
- tr(String, Object...) - Static method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Translates a resource key.
- translate(String, Object...) - Method in class dev.satyrn.papermc.api.lang.v1.I18n
-
Translates a string with the given formatting parts.
- TypedMapListNode<K,
V> - Class in dev.satyrn.papermc.api.configuration.v1 -
Gets a map list from the config, using specified types instead of rawtypes.
- TypedMapListNode<K,
V> - Class in dev.satyrn.papermc.api.configuration.v4 -
Deprecated, for removal: This API element is subject to removal in a future version.Since 1.9.0 versioning refactor. Use
TypedMapListNode
instead. - TypedMapListNode(ConfigurationContainer, String) - Constructor for class dev.satyrn.papermc.api.configuration.v4.TypedMapListNode
-
Deprecated.Creates a new typed map list node.
- TypedMapListNode(ConfigurationNode<?>, String) - Constructor for class dev.satyrn.papermc.api.configuration.v1.TypedMapListNode
-
Creates a new typed map list node.
U
- upgrade() - Method in class dev.satyrn.papermc.api.configuration.v1.RootNode
-
Upgrades the configuration to the latest version.
- userID - Variable in class dev.satyrn.papermc.api.configuration.v1.MySQLConfiguration
-
Deprecated.The MySQL user ID.
- userID - Variable in class dev.satyrn.papermc.api.configuration.v2.MySQLConfiguration
-
The MySQL user ID.
- Utf8LangFileControl() - Constructor for class dev.satyrn.papermc.api.lang.v1.I18n.Utf8LangFileControl
V
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.BigDecimalNode
-
Gets the value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.BigIntegerNode
-
Gets the value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.BooleanNode
-
Returns the boolean value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
-
Deprecated.Gets the current value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode
-
Gets the value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.ContainerNode
-
Gets the current value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets the value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.DoubleNode
-
Returns the double-precision floating point value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.EnumListNode
-
Gets the value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.EnumNode
-
Returns the enum value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.IntegerNode
-
Returns the integer value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.MapListNode
-
Returns the entire configuration node as a map list.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.OptionalConfigurationNode
-
Gets the value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.StringNode
-
Returns the string value of the node.
- value() - Method in class dev.satyrn.papermc.api.configuration.v1.TypedMapListNode
-
Gets the value of the configuration node.
- value(Difficulty) - Method in class dev.satyrn.papermc.api.configuration.v1.DifficultyDependentNode
-
Deprecated.Gets a value specific to the given difficulty value.
- value(Difficulty) - Method in class dev.satyrn.papermc.api.configuration.v2.DifficultyDependentNode
-
Gets a value specific to the given difficulty value.
- valueOf(String) - Static method in enum class dev.satyrn.papermc.api.configuration.v1.NodePriority
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.satyrn.papermc.api.storage.v1.StorageType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.satyrn.papermc.api.configuration.v1.NodePriority
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.satyrn.papermc.api.storage.v1.StorageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages
BigDecimalNode
instead.