Index
All Classes and Interfaces|All Packages
A
- addJarToClasspath(Path) - Method in class dev.magicmq.pyspigot.manager.libraries.JarClassLoader
-
Add a new Jar to the classpath.
- aliases() - Element in annotation interface dev.magicmq.pyspigot.command.SubCommandMeta
- async - Variable in class dev.magicmq.pyspigot.manager.task.Task
- async() - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Get the async protocol manager for working with asynchronous listeners.
- ASYNCHRONOUS - Enum constant in enum class dev.magicmq.pyspigot.manager.protocol.ListenerType
-
An asynchronous listener.
- ASYNCHRONOUS_TIMEOUT - Enum constant in enum class dev.magicmq.pyspigot.manager.protocol.ListenerType
-
An asynchronous timeout listener.
- AsyncProtocolManager - Class in dev.magicmq.pyspigot.manager.protocol
-
Manager to interface with ProtocolLib's AsynchronousManager.
- AsyncProtocolManager() - Constructor for class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
B
- BASIC - Enum constant in enum class dev.magicmq.pyspigot.manager.redis.ClientType
-
A basic client type, used for initiating a standard RedisClient for further custom usage.
- broadcastServerPacket(PacketContainer) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Broadcast a packet to the entire server.
- broadcastServerPacket(PacketContainer, Collection<? extends Player>) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Broadcast a packet to a specified list of players.
- broadcastServerPacket(PacketContainer, Entity) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Broadcast a packet to players receiving information about a particular entity.
- broadcastServerPacket(PacketContainer, Entity, boolean) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Broadcast a packet to players receiving information about a particular entity.
- broadcastServerPacket(PacketContainer, Location, int) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Broadcast a packet to all players within a given max observer distance from an origin location (center point).
C
- callToScript(PacketEvent) - Method in class dev.magicmq.pyspigot.manager.protocol.ScriptPacketListener
-
A helper method to call a script's packet listener function when the packet event occurs.
- canSee(CommandSender) - Method in class dev.magicmq.pyspigot.util.CommandAliasHelpTopic
- client - Variable in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
- ClientType - Enum Class in dev.magicmq.pyspigot.manager.redis
-
Utility enum to represent different types of redis clients available for scripts to use.
- close() - Method in class dev.magicmq.pyspigot.manager.database.Database
-
Closes a connection to the database.
- close() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Closes a connection to the database.
- close() - Method in class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
-
Closes a connection to the database.
- close() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Close the open to the remote redis server synchronously, blocking if necessary.
- close() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Closes this script's file logger and interpreter.
- closeAsync() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Close the open connection to the remote redis server asynchronously.
- closeFileHandler() - Method in class dev.magicmq.pyspigot.util.logging.ScriptLogger
-
Closes the FileHandler for this logger.
- closeRedisClient(ScriptRedisClient) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Close the specified ScriptRedisClient synchronously.
- closeRedisClientAsync(ScriptRedisClient) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Close the specified ScriptRedisClient asynchronously, without blocking.
- closeRedisClients(Script, boolean) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Close all ScriptRedisClients belonging to a script.
- command - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
CommandManager
. - command() - Element in annotation interface dev.magicmq.pyspigot.command.SubCommandMeta
- COMMAND - Enum constant in enum class dev.magicmq.pyspigot.manager.redis.ClientType
-
A command client type, used for executing redis commands.
- CommandAliasHelpTopic - Class in dev.magicmq.pyspigot.util
-
Represents a help topic for an alias of a command.
- CommandAliasHelpTopic(String, String, HelpMap) - Constructor for class dev.magicmq.pyspigot.util.CommandAliasHelpTopic
- CommandManager - Class in dev.magicmq.pyspigot.manager.command
-
Manager to interface with Bukkit's command framework.
- compareTo(Script) - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Compares this script to another script, using load order as the primary comparison.
- compareTo(StringUtils.Version) - Method in class dev.magicmq.pyspigot.util.StringUtils.Version
- config - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
ConfigManager
. - ConfigManager - Class in dev.magicmq.pyspigot.manager.config
-
Manager for scripts to interface with configuration files.
- connectMongo(MongoClientSettings) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with a Mongo database, using the provided client settings.
- connectMongo(String) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with a Mongo database, using the provided connection string URI.
- connectMongo(String, MongoClientSettings) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with a Mongo database, using the provided connection string URI and client settings.
- connectMongo(String, String, String, String) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with a Mongo database, using the default client settings.
- connectMongo(String, String, String, String, MongoClientSettings) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with a Mongo database, using the provided client settings.
- connectSql(HikariConfig) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with an SQL database, using the provided configuration.
- connectSql(String) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with an SQL database, using the provided connection URI.
- connectSql(String, HikariConfig) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with an SQL database, using the provided connection URI and configuration options.
- connectSql(String, String, String, String, String) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with an SQL database, using the default configuration options.
- connectSql(String, String, String, String, String, HikariConfig) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Open a new connection with an SQL database, using the specified configuration options.
- contains(String) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- contains(String) - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Check if a global variable exists with the given name.
- containsValue(Object) - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Check if a global variable exists with the given value.
- createCollection(String, String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Create a collection in the given database
- createCollectionIndex(String, String, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Create a collection with an index of the given keys.
- createDocument() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Create an empty
Document
. - createDocument(String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Create a
Document
out of the provided json. - createDocument(String, Object) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Create a
Document
with the provided key and value. - createObject() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Create a new empty
BasicDBObject
. - createObject(String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Create a new
BasicDBObject
out of the provided json. - createObject(String, Object) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Create a new
BasicDBObject
with the provided key and value. - createPacket(PacketType) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Create a new packet with the given type.
- CustomEvent - Class in dev.magicmq.pyspigot.event.custom
-
A custom event that scripts may instantiate and call for other plugins/scripts to listen to.
- CustomEvent(String, PyObject) - Constructor for class dev.magicmq.pyspigot.event.custom.CustomEvent
-
Note: This class should be instantiated from scripts only!
- CustomEvent(String, PyObject, boolean) - Constructor for class dev.magicmq.pyspigot.event.custom.CustomEvent
-
Note: This class should be instantiated from scripts only!
D
- database - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
DatabaseManager
- Database - Class in dev.magicmq.pyspigot.manager.database
-
Represents a database to which a script is connected and can read/write.
- Database(Script) - Constructor for class dev.magicmq.pyspigot.manager.database.Database
- DatabaseManager - Class in dev.magicmq.pyspigot.manager.database
-
Manager that allows connection to and interact with a variety of database types.
- DatabaseType - Enum Class in dev.magicmq.pyspigot.manager.database
-
Utility enum to represent different database types available for scripts to use.
- debug(String) - Method in class dev.magicmq.pyspigot.util.logging.ScriptLogger
-
A convenience method added for a script to print debug information to console and its log file.
- delay - Variable in class dev.magicmq.pyspigot.manager.task.Task
- deleteCollection(String, String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Delete a collection in the given database
- deleteConfig(String) - Method in class dev.magicmq.pyspigot.manager.config.ConfigManager
-
Delete a configuration file with the given path/name.
- deleteDocument(String, String, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Delete a document from a collection matching the provided filter.
- deleteDocuments(String, String, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Delete multiple documents from a collection matching the provided filter.
- description() - Element in annotation interface dev.magicmq.pyspigot.command.SubCommandMeta
- dev.magicmq.pyspigot - package dev.magicmq.pyspigot
-
Contains the main plugin class.
- dev.magicmq.pyspigot.command - package dev.magicmq.pyspigot.command
-
Contains all classes related to PySpigot's plugin commands.
- dev.magicmq.pyspigot.command.subcommands - package dev.magicmq.pyspigot.command.subcommands
-
Contains all subcommands for the plugin.
- dev.magicmq.pyspigot.config - package dev.magicmq.pyspigot.config
-
Contains the
PluginConfig
class, which is used to access values from the config.yml - dev.magicmq.pyspigot.event - package dev.magicmq.pyspigot.event
-
This package contains events related to scripts.
- dev.magicmq.pyspigot.event.custom - package dev.magicmq.pyspigot.event.custom
- dev.magicmq.pyspigot.manager.command - package dev.magicmq.pyspigot.manager.command
-
Contains all classes related to Script commands.
- dev.magicmq.pyspigot.manager.config - package dev.magicmq.pyspigot.manager.config
-
Contains all classes related to script config files.
- dev.magicmq.pyspigot.manager.database - package dev.magicmq.pyspigot.manager.database
-
Contains all classes related to database connections.
- dev.magicmq.pyspigot.manager.database.mongo - package dev.magicmq.pyspigot.manager.database.mongo
-
Contains classes related to MongoDB.
- dev.magicmq.pyspigot.manager.database.sql - package dev.magicmq.pyspigot.manager.database.sql
-
Contains classes related to SQL databases.
- dev.magicmq.pyspigot.manager.libraries - package dev.magicmq.pyspigot.manager.libraries
-
Contains all classes related to Jar libraries.
- dev.magicmq.pyspigot.manager.listener - package dev.magicmq.pyspigot.manager.listener
-
Contains all classes related to script event listeners.
- dev.magicmq.pyspigot.manager.placeholder - package dev.magicmq.pyspigot.manager.placeholder
-
Contains all classes related to PlaceholderAPI.
- dev.magicmq.pyspigot.manager.protocol - package dev.magicmq.pyspigot.manager.protocol
-
Contains all classes related to ProtocolLib.
- dev.magicmq.pyspigot.manager.redis - package dev.magicmq.pyspigot.manager.redis
-
Contains all classes related to redis.
- dev.magicmq.pyspigot.manager.redis.client - package dev.magicmq.pyspigot.manager.redis.client
-
Contains all the redis clients that can be used by scripts.
- dev.magicmq.pyspigot.manager.script - package dev.magicmq.pyspigot.manager.script
-
Contains all classes related to scripts themselves.
- dev.magicmq.pyspigot.manager.task - package dev.magicmq.pyspigot.manager.task
-
Contains all classes related to script tasks.
- dev.magicmq.pyspigot.util - package dev.magicmq.pyspigot.util
-
Contains utility classes for the plugin and for scripts.
- dev.magicmq.pyspigot.util.logging - package dev.magicmq.pyspigot.util.logging
-
Contains utility classes related to script logging.
- disconnect(Database) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Disconnect from the provided database connection.
- disconnectAll(Script) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Disconnect from all database connections belonging to a certain script.
- doesCollectionExist(String, String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Check if a collection exists within a database.
- doesConfigExist(String) - Method in class dev.magicmq.pyspigot.manager.config.ConfigManager
-
Check if a configuration file exists with the given path/name, relative to the
configs
folder. - doesDatabaseExist(String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Check if a database exists with the given name.
- doReportException() - Method in class dev.magicmq.pyspigot.event.ScriptExceptionEvent
-
Get if the exception should be reported to console and/or a script's log file.
- doScriptActionLogging() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- doScriptUnloadOnPluginDisable() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- doVerboseRedisLogging() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
E
- equals(Object) - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Check if this script is the same as another script.
- execute(Listener, Event) - Method in class dev.magicmq.pyspigot.manager.listener.ScriptEventExecutor
-
Called internally when the event occurs.
F
- FAIL_DISABLED - Enum constant in enum class dev.magicmq.pyspigot.manager.script.RunResult
-
Returned if the script was not loaded because it was disabled as per its script options in script_options.yml
- FAIL_DUPLICATE - Enum constant in enum class dev.magicmq.pyspigot.manager.script.RunResult
-
Returned if a script is already loaded with the same name.
- FAIL_ERROR - Enum constant in enum class dev.magicmq.pyspigot.manager.script.RunResult
-
Returned if the script was loaded but failed during runtime due to an error.
- FAIL_PLUGIN_DEPENDENCY - Enum constant in enum class dev.magicmq.pyspigot.manager.script.RunResult
-
Returned if the script was not loaded because it has one or more missing plugin dependencies.
- FAIL_SCRIPT_NOT_FOUND - Enum constant in enum class dev.magicmq.pyspigot.manager.script.RunResult
-
Returned if a script was not found with the given name.
- FAILED_ERROR - Enum constant in enum class dev.magicmq.pyspigot.manager.libraries.LibraryManager.LoadResult
-
The library failed to load because of some unrecoverable error.
- FAILED_FILE - Enum constant in enum class dev.magicmq.pyspigot.manager.libraries.LibraryManager.LoadResult
-
The library failed to load because the libs folder does not exist.
- FAILED_LOADED - Enum constant in enum class dev.magicmq.pyspigot.manager.libraries.LibraryManager.LoadResult
-
The library failed to load because it is already loaded.
- fetchNewFindOneAndUpdateOptions() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Fetch a new
FindOneAndUpdateOptions
object for updates - fetchNewUpdateOptions() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Fetch a new
UpdateOptions
object for updates - findAndUpdateDocument(String, String, Bson, List<Bson>) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update and return a document within a collection that match the given filter, with the default update options
- findAndUpdateDocument(String, String, Bson, List<Bson>, FindOneAndUpdateOptions) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update and return a document within a collection that match the given filter, with the default update options
- findAndUpdateDocument(String, String, Bson, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update and return a document within a collection that match the given filter, with the default update options
- findAndUpdateDocument(String, String, Bson, Bson, FindOneAndUpdateOptions) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update and return a document within a collection that match the given filter, with the default update options
- formatDuration(Duration) - Static method in class dev.magicmq.pyspigot.util.StringUtils
- function - Variable in class dev.magicmq.pyspigot.manager.task.Task
- functionArgs - Variable in class dev.magicmq.pyspigot.manager.task.Task
G
- get() - Static method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Get the singleton instance of this CommandManager
- get() - Static method in class dev.magicmq.pyspigot.manager.config.ConfigManager
-
Get the singleton instance of this ConfigManager
- get() - Static method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Get the singleton instance of this DatabaseManager.
- get() - Static method in class dev.magicmq.pyspigot.manager.libraries.LibraryManager
-
Get the singleton instance of this LibraryManager.
- get() - Static method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Get the singleton instance of this ListenerManager.
- get() - Static method in class dev.magicmq.pyspigot.manager.placeholder.PlaceholderManager
-
Get the singleton instance of this PlaceholderManager.
- get() - Static method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Get the singleton instance of this ProtocolManager.
- get() - Static method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Get the singleton instance of this RedisManager.
- get() - Static method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
- get() - Static method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Get the singleton instance of this ScriptManager.
- get() - Static method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Get the singleton instance of this TaskManager.
- get() - Static method in class dev.magicmq.pyspigot.PySpigot
-
Get the instance of this plugin.
- get(String) - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Get a global variable
- getAllScriptNames() - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Get a set of file names corresponding to all script files in the scripts folder (including in subfolders).
- getAllScriptPaths() - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Get a set of absolute paths corresponding to all script files in the scripts folder (including in subfolders).
- getAsyncCommands() - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisCommandClient
-
Get the
RedisAsyncCommands
object for executing commands asynchronously. - getAsynchronousManager() - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Get the current ProtocolLib AsynchronousManager.
- getAsyncPacketListener(Script, PacketType) - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Get the asynchronous packet listener for a particular packet type associated with a script
- getAsyncPacketListeners(Script) - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Get all asynchronous packet listeners associated with a script
- getAuthor() - Method in class dev.magicmq.pyspigot.manager.placeholder.ScriptPlaceholder
-
Get the author of this ScriptPlaceholder.
- getBukkitCommand() - Method in class dev.magicmq.pyspigot.manager.command.ScriptCommand
-
Get the
PluginCommand
that underlies this ScriptCommand - getChannel() - Method in class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
-
Implemented from
RedisPubSubListener
, but unused. - getClassLoader() - Method in class dev.magicmq.pyspigot.manager.libraries.LibraryManager
-
Get the
JarClassLoader
for loading Jar files into the classpath. - getClientClass() - Method in enum class dev.magicmq.pyspigot.manager.redis.ClientType
-
Get the class that pertains to the client type.
- getClientId() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Get the ID of this redis client.
- getClientOptions() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Get the
ClientOptions
of this redis client. - getCollection(String, String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get a collection from a database.
- getCollectionNames(String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get all collection names within a database.
- getCollections(String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get all collections within a database.
- getCommand(Script, String) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Get a command associated with a particular script by the command name
- getCommands() - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisCommandClient
-
Get the
RedisCommands
object for executing commands synchronously. - getCommands(Script) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Get an immutable list containing all commands belonging to a particular script.
- getConfigFile() - Method in class dev.magicmq.pyspigot.manager.config.ScriptConfig
-
Get the file associated with this configuration.
- getConfigFolder() - Method in class dev.magicmq.pyspigot.manager.config.ConfigManager
-
Get the path of the folder where script configuration files are stored.
- getConfigPath() - Method in class dev.magicmq.pyspigot.manager.config.ScriptConfig
-
Get the absolute path of the file associated with this configuration.
- getConnection() - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisCommandClient
-
Get the underlying connection for this RedisCommandClient.
- getConnection() - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Get the underlying connection for this RedisPubSubClient.
- getConnections(Script) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Get all database connnections belonging to a script.
- getConnections(Script, DatabaseType) - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Get all database connnections belonging to a script of the given type.
- getCraftBukkitClass(String) - Static method in class dev.magicmq.pyspigot.util.ReflectionUtils
- getCraftBukkitClass(String, String) - Static method in class dev.magicmq.pyspigot.util.ReflectionUtils
- getData() - Method in class dev.magicmq.pyspigot.event.custom.CustomEvent
-
Get the data attached to this event.
- getDataAsType(Class<T>) - Method in class dev.magicmq.pyspigot.event.custom.CustomEvent
-
Attempt to convert the data attached to this event to a provided type.
- getDataAsType(String) - Method in class dev.magicmq.pyspigot.event.custom.CustomEvent
-
Attempt to convert the data attached to this event to a provided type.
- getDatabase(String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get a
MongoDatabase
with the given name. - getDatabaseId() - Method in class dev.magicmq.pyspigot.manager.database.Database
-
Get the ID of this database connection.
- getDatabaseNames() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get all database names.
- getDatabases() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get all databases.
- getDataFolderPath() - Method in class dev.magicmq.pyspigot.PySpigot
-
Get the path of the data folder for PySpigot.
- getDbClass() - Method in enum class dev.magicmq.pyspigot.manager.database.DatabaseType
-
Get the class that pertains to the database type.
- getDocument(String, String, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get a document within a collection that match the given filter.
- getDocument(String, String, Bson, Bson, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get a document within a collection that match the given filter, projections, and sort criteria.
- getDocuments(String, String) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get all documents within a collection.
- getDocuments(String, String, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get all documents within a collection that match the given filter.
- getEnabled(String, boolean) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- getEvent() - Method in class dev.magicmq.pyspigot.manager.listener.ScriptEventListener
-
Get the Bukkit event associated with this listener.
- getEventExecutor() - Method in class dev.magicmq.pyspigot.manager.listener.ScriptEventListener
-
Get the
ScriptEventExecutor
associated with this script event listener. - getEventListener(Script, Class<? extends Event>) - Method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Get the event listener for a particular event associated with a script
- getException() - Method in class dev.magicmq.pyspigot.event.ScriptExceptionEvent
-
Get the
PyException
that was thrown. - getField(Class<?>, String) - Static method in class dev.magicmq.pyspigot.util.ReflectionUtils
- getFile() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get the File associated with this script.
- getFileLoggingEnabled(String, boolean) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- getFullText(CommandSender) - Method in class dev.magicmq.pyspigot.util.CommandAliasHelpTopic
- getFunction() - Method in class dev.magicmq.pyspigot.manager.protocol.ScriptPacketListener
-
Get the function that should be called when the packet event occurs.
- getHandlerList() - Static method in class dev.magicmq.pyspigot.event.custom.CustomEvent
- getHandlerList() - Static method in class dev.magicmq.pyspigot.event.ScriptEvent
- getHandlerList() - Static method in class dev.magicmq.pyspigot.event.ScriptExceptionEvent
- getHandlerList() - Static method in class dev.magicmq.pyspigot.event.ScriptLoadEvent
- getHandlerList() - Static method in class dev.magicmq.pyspigot.event.ScriptUnloadEvent
- getHandlers() - Method in class dev.magicmq.pyspigot.event.custom.CustomEvent
- getHandlers() - Method in class dev.magicmq.pyspigot.event.ScriptEvent
- getHandlers() - Method in class dev.magicmq.pyspigot.event.ScriptExceptionEvent
- getHandlers() - Method in class dev.magicmq.pyspigot.event.ScriptLoadEvent
- getHandlers() - Method in class dev.magicmq.pyspigot.event.ScriptUnloadEvent
- getHashMap() - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Get the underlying
HashMap
wherein global variables are cached. - getHikariDataSource() - Method in class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
-
Get the underlying
HikariDataSource
associated with this SQLDatabase. - getIdentifier() - Method in class dev.magicmq.pyspigot.manager.placeholder.ScriptPlaceholder
-
Get the identifier of this ScriptPlaceholder.
- getInterpreter() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get the
PythonInterpreter
associated wtih this script. - getKeys() - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Get a set of all global variable names.
- getLibraryRelocations() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- getListenerFunction() - Method in class dev.magicmq.pyspigot.manager.listener.ScriptEventListener
-
Get the script function that should be called when the event occurs.
- getListeners(Script) - Method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Get all event listeners associated with a script
- getListenerType() - Method in class dev.magicmq.pyspigot.manager.protocol.ScriptPacketListener
-
The listener type of this listener.
- getLoadedScriptNames() - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Get the names of all loaded scripts.
- getLoadedScripts() - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Get all loaded scripts.
- getLoadPriority() - Method in class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Get the load priority for this script.
- getLoadPriority(String, int) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- getLogFileName() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get the log file name for this script.
- getLogger() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get this scripts logger.
- getLogTimestamp() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- getMessage(String, boolean) - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- getMethod(Class<?>, String) - Static method in class dev.magicmq.pyspigot.util.ReflectionUtils
- getMetricsEnabled() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- getMinLoggingLevel() - Method in class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Get the minimum logging level for this script, represented as a
Level
- getMinLoggingLevel(String, String) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- getMongoClient() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Get the
MongoClient
associated with this Mongo Database connection. - getName() - Method in class dev.magicmq.pyspigot.event.custom.CustomEvent
-
Get the name of this event.
- getName() - Method in class dev.magicmq.pyspigot.manager.command.ScriptCommand
-
Get the name of this command.
- getName() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get the name associated with this script.
- getNMSClass(String, String) - Static method in class dev.magicmq.pyspigot.util.ReflectionUtils
- getOptions() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get the
ScriptOptions
for this script, which contains various runtime options associated with this script. - getPacketListener(Script, PacketType) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Get the normal packet listener for a particular packet type associated with a script.
- getPacketListeners(Script) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Get all normal packet listeners associated with a script, excluding asynchronous packet listeners.
- getPacketType() - Method in class dev.magicmq.pyspigot.manager.protocol.ScriptPacketListener
-
Get the packet type being listener for.
- getPath() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get the path corresponding to the script file.
- getPermissionDefault() - Method in class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Get the default permissions for permissions defined for this script.
- getPermissionDefault(String, String) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- getPermissions() - Method in class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Get a list of permissions defined for this script.
- getPermissions(String, Map<?, ?>) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- getPlaceholder(Script) - Method in class dev.magicmq.pyspigot.manager.placeholder.PlaceholderManager
-
Get a script's placeholder expansion.
- getPluginClassLoader() - Method in class dev.magicmq.pyspigot.PySpigot
-
Get the
ClassLoader
for PySpigot. - getPluginDepend(String, List<String>) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- getPluginDependencies() - Method in class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Get a list of plugin dependencies for this script.
- getPrefix() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- getProtocolManager() - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Get the current ProtocolLib ProtocolManager.
- getRedisClient() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Get the underlying lettuce
RedisClient
for this ScriptRedisClient. - getRedisClients(Script) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Get all open ScriptRedisClients belonging to a script.
- getRedisClients(Script, ClientType) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
- getRedisURI() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Get the
RedisURI
of this redis client. - getScript() - Method in class dev.magicmq.pyspigot.event.ScriptEvent
-
Get the script associated with this event.
- getScript() - Method in class dev.magicmq.pyspigot.manager.command.ScriptCommand
-
Get the script associated with this command.
- getScript() - Method in class dev.magicmq.pyspigot.manager.database.Database
-
Get the script associated with this database connection.
- getScript() - Method in class dev.magicmq.pyspigot.manager.listener.ScriptEventListener
-
Get the script associated with this listener.
- getScript() - Method in class dev.magicmq.pyspigot.manager.placeholder.ScriptPlaceholder
-
Get the script associated with this ScriptPlaceholder.
- getScript() - Method in class dev.magicmq.pyspigot.manager.protocol.ScriptPacketListener
-
Get the script associated with this listener.
- getScript() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Get the script associated with this redis client.
- getScript() - Method in class dev.magicmq.pyspigot.manager.task.Task
-
Get the script associated with this task.
- getScript(String) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Get a
Script
object for a loaded and running script - getScriptFromCallStack() - Static method in class dev.magicmq.pyspigot.util.ScriptUtils
-
Attempts to get the script involved in a Java method call by analyzing the call stack.
- getScriptLoadDelay() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- getScriptOptions(String) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Get the
ScriptOptions
for a particular script from the script file name. - getScriptOptions(Path) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Get the
ScriptOptions
for a particular script from the path pointing to the script file. - getScriptPath(String) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Attempts to resolve the absolute path for a script in the scripts folder based on the file name by searching through the scripts folder.
- getScriptSection(String) - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- getSimpleName() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get the simple name (without the file extension, .py) associated with this script.
- getSpigotVersion() - Method in class dev.magicmq.pyspigot.PySpigot
- getTask(int) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Get a scheduled task from its ID.
- getTasks(Script) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Get all scheduled tasks associated with a script.
- getUptime() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Get the millisecond duration that this script has been loaded
- getUri() - Method in enum class dev.magicmq.pyspigot.manager.database.DatabaseType
-
Get the URI scheme associated with the database type.
- getValues() - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Get a set of all global variable values.
- getVersion() - Method in class dev.magicmq.pyspigot.manager.placeholder.ScriptPlaceholder
-
Get the version of this ScriptPlaceholder.
- getVersion() - Method in class dev.magicmq.pyspigot.util.StringUtils.Version
- global_vars - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
GlobalVariables
- GlobalVariables - Class in dev.magicmq.pyspigot.manager.script
-
A wrapper class for a HashMap that contains global variables that can be shared across scripts.
H
- handleScriptException(Script, PyException, String) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Handles script errors/exceptions, particularly for script logging purposes.
- HelpCommand - Class in dev.magicmq.pyspigot.command.subcommands
- HelpCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.HelpCommand
I
- InfoCommand - Class in dev.magicmq.pyspigot.command.subcommands
- InfoCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.InfoCommand
- initFileHandler() - Method in class dev.magicmq.pyspigot.util.logging.ScriptLogger
-
Initializes the FileHandler to log script log messages to its respective log file.
- initHelp() - Method in class dev.magicmq.pyspigot.manager.command.ScriptCommand
- initPermissions() - Method in class dev.magicmq.pyspigot.manager.script.Script
- initPySystemState() - Static method in class dev.magicmq.pyspigot.util.ScriptUtils
-
Initializes a new PySystemState for a new
PythonInterpreter
when a script is loaded. - insertDocument(String, String, Document) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Insert a document into a collection.
- insertDocuments(String, String, List<Document>) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Insert multiple documents into a collection.
- isCancelled() - Method in class dev.magicmq.pyspigot.event.custom.CustomEvent
- isEnabled() - Method in class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Get if this script is enabled.
- isError() - Method in class dev.magicmq.pyspigot.event.ScriptUnloadEvent
-
Get if this unload event was due to a script error.
- isFileLoggingEnabled() - Method in class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Get if file logging is enabled for this script.
- isJarInClassPath(Path) - Method in class dev.magicmq.pyspigot.manager.libraries.JarClassLoader
-
Check if a Jar file is in the classpath.
- isPaper() - Method in class dev.magicmq.pyspigot.PySpigot
-
Get if the server is running paper.
- isPlaceholderApiAvailable() - Method in class dev.magicmq.pyspigot.PySpigot
-
Check if PlacehodlerAPI is available on the server.
- isProtocolLibAvailable() - Method in class dev.magicmq.pyspigot.PySpigot
-
Check if ProtocolLib is available on the server.
- isScriptRunning(String) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Check if a script with the given name is currently loaded.
J
- JarClassLoader - Class in dev.magicmq.pyspigot.manager.libraries
-
Utility class for assisting with loading Jar files into the classpath.
- JarClassLoader(ClassLoader) - Constructor for class dev.magicmq.pyspigot.manager.libraries.JarClassLoader
-
Initialize a new JarClassLoader using a parent class loader.
L
- LibraryManager - Class in dev.magicmq.pyspigot.manager.libraries
-
A manager class to help with dynamically loading Jar files into the classpath at runtime.
- LibraryManager.LoadResult - Enum Class in dev.magicmq.pyspigot.manager.libraries
-
An enum representing the outcome of an attempt to load a library.
- listener - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
ListenerManager
. - ListenerManager - Class in dev.magicmq.pyspigot.manager.listener
-
Manager to interface with Bukkit's event framework.
- ListenerType - Enum Class in dev.magicmq.pyspigot.manager.protocol
-
An enum representing the type of protocol listener that a script has registered.
- ListScriptsCommand - Class in dev.magicmq.pyspigot.command.subcommands
- ListScriptsCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.ListScriptsCommand
- load() - Method in class dev.magicmq.pyspigot.manager.config.ScriptConfig
-
Loads the config from the configuration file.
- LoadCommand - Class in dev.magicmq.pyspigot.command.subcommands
- LoadCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.LoadCommand
- loadConfig(String) - Method in class dev.magicmq.pyspigot.manager.config.ConfigManager
-
Load a configuration file with the given path/name, relative to the
configs
folder. - loadConfig(String, String) - Method in class dev.magicmq.pyspigot.manager.config.ConfigManager
-
Load a configuration file with the given path/name, relative to the
configs
folder. - loadLibrary(String) - Method in class dev.magicmq.pyspigot.manager.libraries.LibraryManager
-
Load a library into the classpath.
- LoadLibraryCommand - Class in dev.magicmq.pyspigot.command.subcommands
- LoadLibraryCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.LoadLibraryCommand
- loadScript(Script) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Load the given script.
- loadScript(String) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Load a script with the given name.
- loadScript(Path) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Load a script with the given path.
- loadScripts() - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Loads and runs all scripts contained within the scripts folder.
- log(LogRecord) - Method in class dev.magicmq.pyspigot.util.logging.ScriptLogger
M
- message(String, String) - Method in class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
-
Called internally when a message is received on the given channel.
- message(String, String, String) - Method in class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
-
Implemented from
RedisPubSubListener
, but unused. - MONGO_DB - Enum constant in enum class dev.magicmq.pyspigot.manager.database.DatabaseType
-
A MongoDB database type.
- MONGO_DB_NO_AUTH - Enum constant in enum class dev.magicmq.pyspigot.manager.database.DatabaseType
-
A MongoDB database type without authentication.
- MongoDatabase - Class in dev.magicmq.pyspigot.manager.database.mongo
-
Represents an open connection to a Mongo Database.
- MongoDatabase(Script, MongoClientSettings) - Constructor for class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
N
- newClientOptions() - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Get a new client options builder for use when opening a new script redis client.
- newHikariConfig() - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Get a new
HikariConfig
for specifying configuration options. - newMongoClientSettings() - Method in class dev.magicmq.pyspigot.manager.database.DatabaseManager
-
Get a new
MongoClientSettings.Builder
for specifying client settings. - newRedisURI() - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Get a new RedisURI builder for use when opening a new script redis client.
- NORMAL - Enum constant in enum class dev.magicmq.pyspigot.manager.protocol.ListenerType
-
A normal listner.
O
- onCommand(CommandSender, String[]) - Method in interface dev.magicmq.pyspigot.command.SubCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.HelpCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.InfoCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.ListScriptsCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.LoadCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.LoadLibraryCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.ReloadAllCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.ReloadCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.ReloadConfigCommand
- onCommand(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.UnloadCommand
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.magicmq.pyspigot.command.PySpigotCommand
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.magicmq.pyspigot.manager.command.ScriptCommand
- onDisable() - Method in class dev.magicmq.pyspigot.PySpigot
- onDisable(PluginDisableEvent) - Method in class dev.magicmq.pyspigot.PluginListener
- onEnable() - Method in class dev.magicmq.pyspigot.PySpigot
- onJoin(PlayerJoinEvent) - Method in class dev.magicmq.pyspigot.PluginListener
- onPacketReceiving(PacketEvent) - Method in class dev.magicmq.pyspigot.manager.protocol.PacketReceivingListener
- onPacketSending(PacketEvent) - Method in class dev.magicmq.pyspigot.manager.protocol.PacketSendingListener
- onRequest(OfflinePlayer, String) - Method in class dev.magicmq.pyspigot.manager.placeholder.ScriptPlaceholder
-
Called internally when the ScriptPlaceholder is used.
- onTabComplete(CommandSender, String[]) - Method in interface dev.magicmq.pyspigot.command.SubCommand
- onTabComplete(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.InfoCommand
- onTabComplete(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.LoadCommand
- onTabComplete(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.ReloadCommand
- onTabComplete(CommandSender, String[]) - Method in class dev.magicmq.pyspigot.command.subcommands.UnloadCommand
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.magicmq.pyspigot.command.PySpigotCommand
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.magicmq.pyspigot.manager.command.ScriptCommand
- open() - Method in class dev.magicmq.pyspigot.manager.database.Database
-
Opens a connection to the database.
- open() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Opens a connection to the database.
- open() - Method in class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
-
Opens a connection to the database.
- open() - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisCommandClient
-
Initialize a new
RedisClient
and open a connection to the remote redis server. - open() - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Initialize a new
RedisClient
and open a connection to the remote redis server. - open() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Initialize a new
RedisClient
and open a connection to the remote redis server. - openRedisClient(ClientType, RedisURI) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Initialize a new
RedisPubSubClient
with a connection to a remote redis server with the specifiedRedisURI
. - openRedisClient(ClientType, RedisURI, ClientOptions) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Initialize a new
RedisPubSubClient
with a connection to a remote redis server with the specifiedRedisURI
andClientOptions
. - openRedisClient(ClientType, String, String, String) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Initialize a new
RedisPubSubClient
with a connection to a remote redis server with the specified ip, port, and password, using the default client options. - openRedisClient(ClientType, String, String, String, ClientOptions) - Method in class dev.magicmq.pyspigot.manager.redis.RedisManager
-
Initialize a new
RedisPubSubClient
with a connection to a remote redis server with the specified ip, port, and password, using the specifiedClientOptions
.
P
- PacketReceivingListener - Class in dev.magicmq.pyspigot.manager.protocol
-
A listener that listens for packets received by the server from the client.
- PacketReceivingListener(Script, PyFunction, PacketType, ListenerPriority, ListenerType) - Constructor for class dev.magicmq.pyspigot.manager.protocol.PacketReceivingListener
- PacketSendingListener - Class in dev.magicmq.pyspigot.manager.protocol
-
A listener that listens for packets sent by the server to the client.
- PacketSendingListener(Script, PyFunction, PacketType, ListenerPriority, ListenerType) - Constructor for class dev.magicmq.pyspigot.manager.protocol.PacketSendingListener
- permission() - Element in annotation interface dev.magicmq.pyspigot.command.SubCommandMeta
- persist() - Method in class dev.magicmq.pyspigot.manager.placeholder.ScriptPlaceholder
-
Indicates that the ScriptPlaceholder should persist when PlaceholderAPI is reloaded.
- placeholder - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
PlaceholderManager
. - PlaceholderManager - Class in dev.magicmq.pyspigot.manager.placeholder
-
Manager to interface with PlaceholderAPI.
- playerOnly() - Element in annotation interface dev.magicmq.pyspigot.command.SubCommandMeta
- PluginConfig - Class in dev.magicmq.pyspigot.config
-
Helper class to retrieve configuration values from the plugin config.
- PluginConfig() - Constructor for class dev.magicmq.pyspigot.config.PluginConfig
- PluginListener - Class in dev.magicmq.pyspigot
-
Main listener of the plugin.
- PluginListener() - Constructor for class dev.magicmq.pyspigot.PluginListener
- prepare() - Method in class dev.magicmq.pyspigot.manager.script.Script
-
Prepares this script for execution by initializing its interpreter and logger.
- print(String) - Method in class dev.magicmq.pyspigot.util.logging.ScriptLogger
-
A convenience method added for a script to print debug information to console and its log file.
- PrintStreamWrapper - Class in dev.magicmq.pyspigot.util.logging
-
A wrapper class that captures print statements and errors/exceptions from scripts and redirects them to the script's logger.
- PrintStreamWrapper(OutputStream, Script, Level, String) - Constructor for class dev.magicmq.pyspigot.util.logging.PrintStreamWrapper
- protocol - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
ProtocolManager
. - ProtocolManager - Class in dev.magicmq.pyspigot.manager.protocol
-
Manager to interface with ProtocolLib's ProtocolManager.
- psubscribed(String, long) - Method in class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
-
Implemented from
RedisPubSubListener
, but unused. - PUB_SUB - Enum constant in enum class dev.magicmq.pyspigot.manager.redis.ClientType
-
A pub/sub client type, used for publishing and subscribing to redis messaging.
- publish(String, String) - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Synchronously publish a message to the given channel
- publishAsync(String, String) - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Asynchronously publish a message to the given channel
- publishSync(String, String) - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Synchronously publish a message to the given channel
- punsubscribed(String, long) - Method in class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
-
Implemented from
RedisPubSubListener
, but unused. - purge() - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Clear all global variables.
- PySpigot - Class in dev.magicmq.pyspigot
-
Main class of the plugin.
- PySpigot() - Constructor for class dev.magicmq.pyspigot.PySpigot
- PySpigotCommand - Class in dev.magicmq.pyspigot.command
- PySpigotCommand() - Constructor for class dev.magicmq.pyspigot.command.PySpigotCommand
R
- redis - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
RedisManager
- RedisCommandClient - Class in dev.magicmq.pyspigot.manager.redis.client
-
Extension of the
ScriptRedisClient
that provides ability to issue commands. - RedisCommandClient(Script, RedisURI, ClientOptions) - Constructor for class dev.magicmq.pyspigot.manager.redis.client.RedisCommandClient
- RedisManager - Class in dev.magicmq.pyspigot.manager.redis
-
Manager to interface with remote redis servers.
- RedisPubSubClient - Class in dev.magicmq.pyspigot.manager.redis.client
-
Extension of the
ScriptRedisClient
that provides pub/sub messaging capabilities. - RedisPubSubClient(Script, RedisURI, ClientOptions) - Constructor for class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
- ReflectionUtils - Class in dev.magicmq.pyspigot.util
-
A utility class to simplify reflection for working with CraftBukkit and NMS classes.
- registerAsyncListener(PyFunction, String) - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Register a new asynchronous listener.
- registerAsyncPacketListener(PyFunction, PacketType) - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Register a new asynchronous packet listener with default priority.
- registerAsyncPacketListener(PyFunction, PacketType, ListenerPriority) - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Register a new asynchronous packet listener.
- registerCommand(PyFunction, String) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Register a new command.
- registerCommand(PyFunction, String, String, String) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Register a new command.
- registerCommand(PyFunction, String, String, String, List<String>) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Register a new command.
- registerCommand(PyFunction, PyFunction, String) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Register a new command.
- registerCommand(PyFunction, PyFunction, String, String, String) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Register a new command.
- registerCommand(PyFunction, PyFunction, String, String, String, List<String>) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Register a new command.
- registerCommand(PyFunction, PyFunction, String, String, String, List<String>, String, String) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Register a new command.
- registerListener(PyFunction, Class<? extends Event>) - Method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Register a new event listener with default priority.
- registerListener(PyFunction, Class<? extends Event>, boolean) - Method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Register a new event listener with default priority.
- registerListener(PyFunction, Class<? extends Event>, EventPriority) - Method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Register a new event listener.
- registerListener(PyFunction, Class<? extends Event>, EventPriority, boolean) - Method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Register a new event listener.
- registerListener(PyFunction, String) - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Register a new synchronous listener.
- registerPacketListener(PyFunction, PacketType) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Register a new packet listener with default priority.
- registerPacketListener(PyFunction, PacketType, ListenerPriority) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Register a new packet listener.
- registerPlaceholder(PyFunction) - Method in class dev.magicmq.pyspigot.manager.placeholder.PlaceholderManager
-
Register a new script placeholder expansion.
- registerPlaceholder(PyFunction, String, String) - Method in class dev.magicmq.pyspigot.manager.placeholder.PlaceholderManager
-
Register a new script placeholder expansion.
- registerSyncListener(PyFunction, String) - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Register a new synchronous listener.
- registerTimeoutPacketListener(PyFunction, PacketType) - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Register a new asynchronous timeout packet listener with default priority.
- registerTimeoutPacketListener(PyFunction, PacketType, ListenerPriority) - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Register a new asynchronous timeout packet listener.
- reload() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- reload() - Static method in class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- reload() - Method in class dev.magicmq.pyspigot.manager.config.ScriptConfig
-
Reload the configuration.
- reload() - Method in class dev.magicmq.pyspigot.manager.libraries.LibraryManager
-
Attempts to load all libraries that are not currently loaded.
- reload() - Method in class dev.magicmq.pyspigot.PySpigot
-
Reload the plugin configuration.
- ReloadAllCommand - Class in dev.magicmq.pyspigot.command.subcommands
- ReloadAllCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.ReloadAllCommand
- ReloadCommand - Class in dev.magicmq.pyspigot.command.subcommands
- ReloadCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.ReloadCommand
- reloadConfig(ScriptConfig) - Method in class dev.magicmq.pyspigot.manager.config.ConfigManager
-
Deprecated.
- ReloadConfigCommand - Class in dev.magicmq.pyspigot.command.subcommands
- ReloadConfigCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.ReloadConfigCommand
- remove(String) - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Remove/delete a global variable.
- removeHelp() - Method in class dev.magicmq.pyspigot.manager.command.ScriptCommand
- removePermissions() - Method in class dev.magicmq.pyspigot.manager.script.Script
- RepeatingTask - Class in dev.magicmq.pyspigot.manager.task
-
Represents a repeating task defined by a script.
- RepeatingTask(Script, PyFunction, Object[], boolean, long, long) - Constructor for class dev.magicmq.pyspigot.manager.task.RepeatingTask
- replaceLastOccurrence(String, String, String) - Static method in class dev.magicmq.pyspigot.util.StringUtils
- run() - Method in class dev.magicmq.pyspigot.manager.task.RepeatingTask
-
Called internally when the task executes.
- run() - Method in class dev.magicmq.pyspigot.manager.task.SyncCallbackTask
-
Called internally when the task executes.
- run() - Method in class dev.magicmq.pyspigot.manager.task.Task
-
Called internally when the task executes.
- RunResult - Enum Class in dev.magicmq.pyspigot.manager.script
-
An enum class representing various outcomes of running a script, including run failures.
- runSyncCallbackTask(PyFunction, PyFunction, Object...) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Schedule a new asynchronous task with a synchronous callback.
- runSyncCallbackTaskLater(PyFunction, PyFunction, long, Object...) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Schedule a new asynchronous task with a synchronous callback to run at a later point in time.
- runTask(PyFunction, Object...) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Schedule a new synchronous task.
- runTaskAsync(PyFunction, Object...) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Schedule a new asynchronous task.
- runTaskLater(PyFunction, long, Object...) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Schedule a new synchronous task to run at a later point in time.
- runTaskLaterAsync(PyFunction, long, Object...) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Schedule a new asynchronous task to run at a later point in time.
S
- save() - Method in class dev.magicmq.pyspigot.manager.config.ScriptConfig
-
Save the configuration to its associated file.
- scheduleAsyncRepeatingTask(PyFunction, long, long, Object...) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Schedule a new asynchronous repeating task.
- scheduler - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
TaskManager
. - scheduleRepeatingTask(PyFunction, long, long, Object...) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Schedule a new synchronous repeating task.
- script - Variable in class dev.magicmq.pyspigot.manager.task.Task
- script - Static variable in class dev.magicmq.pyspigot.PySpigot
-
Can be used by scripts to access the
ScriptManager
. - Script - Class in dev.magicmq.pyspigot.manager.script
-
An object that represents a loaded script.
- Script(Path, String, ScriptOptions) - Constructor for class dev.magicmq.pyspigot.manager.script.Script
- ScriptCommand - Class in dev.magicmq.pyspigot.manager.command
-
Represents a command belonging to a script.
- ScriptCommand(Script, PyFunction, PyFunction, String, String, String, List<String>, String, String) - Constructor for class dev.magicmq.pyspigot.manager.command.ScriptCommand
- ScriptConfig - Class in dev.magicmq.pyspigot.manager.config
-
A class representing a script configuration file.
- ScriptConfig(File, String) - Constructor for class dev.magicmq.pyspigot.manager.config.ScriptConfig
- ScriptEvent - Class in dev.magicmq.pyspigot.event
-
Script event superclass.
- ScriptEvent(Script, boolean) - Constructor for class dev.magicmq.pyspigot.event.ScriptEvent
- ScriptEventExecutor - Class in dev.magicmq.pyspigot.manager.listener
-
Represents an event executor for script event listeners.
- ScriptEventExecutor(ScriptEventListener, Class<? extends Event>) - Constructor for class dev.magicmq.pyspigot.manager.listener.ScriptEventExecutor
- ScriptEventListener - Class in dev.magicmq.pyspigot.manager.listener
-
A dummy listener object that represents all events a script is currently listening to.
- ScriptEventListener(Script, PyFunction, Class<? extends Event>) - Constructor for class dev.magicmq.pyspigot.manager.listener.ScriptEventListener
- ScriptExceptionEvent - Class in dev.magicmq.pyspigot.event
-
Called when a script throws an unhandled error/exception.
- ScriptExceptionEvent(Script, PyException, boolean) - Constructor for class dev.magicmq.pyspigot.event.ScriptExceptionEvent
- ScriptLoadEvent - Class in dev.magicmq.pyspigot.event
-
Called when a script is loaded.
- ScriptLoadEvent(Script) - Constructor for class dev.magicmq.pyspigot.event.ScriptLoadEvent
- ScriptLogger - Class in dev.magicmq.pyspigot.util.logging
-
A subclass of Logger that represents a script's logger.
- ScriptLogger(Script) - Constructor for class dev.magicmq.pyspigot.util.logging.ScriptLogger
- ScriptManager - Class in dev.magicmq.pyspigot.manager.script
-
Master manager class for PySpigot.
- scriptOptionEnabled() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- scriptOptionFileLoggingEnabled() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- scriptOptionLoadPriority() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- scriptOptionMinLoggingLevel() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- scriptOptionPermissionDefault() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- scriptOptionPermissions() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- scriptOptionPluginDepend() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- ScriptOptions - Class in dev.magicmq.pyspigot.manager.script
-
A class representing various runtime options belonging to a certain script.
- ScriptOptions() - Constructor for class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Initialize a new ScriptOptions with the default values.
- ScriptOptions(String) - Constructor for class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Initialize a new ScriptOptions using the appropriate values in the script_options.yml file, using the script name to search for the values.
- ScriptOptionsConfig - Class in dev.magicmq.pyspigot.config
-
Helper class to retrieve configuration values from the script options config.
- ScriptOptionsConfig() - Constructor for class dev.magicmq.pyspigot.config.ScriptOptionsConfig
- ScriptPacketListener - Class in dev.magicmq.pyspigot.manager.protocol
-
An abstract class designed to represent a basic script packet listener.
- ScriptPacketListener(Script, PyFunction, PacketType, ListenerPriority, ListenerType) - Constructor for class dev.magicmq.pyspigot.manager.protocol.ScriptPacketListener
- ScriptPlaceholder - Class in dev.magicmq.pyspigot.manager.placeholder
-
A class that represents a script placeholder expansion.
- ScriptPlaceholder(Script, PyFunction, String, String) - Constructor for class dev.magicmq.pyspigot.manager.placeholder.ScriptPlaceholder
- ScriptPubSubListener - Class in dev.magicmq.pyspigot.manager.redis
-
A wrapper class that wraps the RedisPubSubListener from lettuce for use by scripts.
- ScriptPubSubListener(PyFunction, String) - Constructor for class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
- ScriptRedisClient - Class in dev.magicmq.pyspigot.manager.redis.client
-
A wrapper class that wraps the RedisClient from lettuce for use by scripts.
- ScriptRedisClient(Script, RedisURI, ClientOptions) - Constructor for class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
- ScriptUnloadEvent - Class in dev.magicmq.pyspigot.event
-
Called when a script is unloaded.
- ScriptUnloadEvent(Script, boolean) - Constructor for class dev.magicmq.pyspigot.event.ScriptUnloadEvent
- ScriptUtils - Class in dev.magicmq.pyspigot.util
-
A collection of utility methods related to scripts.
- select(String) - Method in class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
-
Select from the SQL database.
- select(String, Object[]) - Method in class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
-
Select from the SQL database with the provided values that should be inserted into the select statement.
- sendServerPacket(Player, PacketContainer) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Send a packet to a player.
- set(String, Object) - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Set a global variable.
- set(String, Object, boolean) - Method in class dev.magicmq.pyspigot.manager.script.GlobalVariables
-
Set a global variable, with the option to override an existing global variable with the same name.
- setCancelled(boolean) - Method in class dev.magicmq.pyspigot.event.custom.CustomEvent
- setIfNotExists(String, Object) - Method in class dev.magicmq.pyspigot.manager.config.ScriptConfig
-
Sets the specified path to the given value only if the path is not already set in the config file.
- setReportException(boolean) - Method in class dev.magicmq.pyspigot.event.ScriptExceptionEvent
-
Set if the exception should be reported to console and/or the script's log file.
- shouldPrintStackTraces() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- shouldShowUpdateMessages() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- shouldUpdatePySpigotLib() - Static method in class dev.magicmq.pyspigot.config.PluginConfig
- shutdown() - Method in class dev.magicmq.pyspigot.manager.libraries.LibraryManager
-
Closes the class loader for scripts.
- shutdown() - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Called on plugin unload or server shutdown.
- SQL - Enum constant in enum class dev.magicmq.pyspigot.manager.database.DatabaseType
-
An SQL database type.
- SqlDatabase - Class in dev.magicmq.pyspigot.manager.database.sql
-
Represents an open connection to an SQL database.
- SqlDatabase(Script, HikariConfig) - Constructor for class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
- stopTask(int) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Terminate a task with the given task ID.
- stopTask(Task) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Terminate a scheduled task.
- stopTasks(Script) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
-
Terminate all scheduled tasks belonging to a script.
- StringUtils - Class in dev.magicmq.pyspigot.util
-
A utility class for various methods/classes related to Strings.
- StringUtils.Version - Class in dev.magicmq.pyspigot.util
- SubCommand - Interface in dev.magicmq.pyspigot.command
- SubCommandMeta - Annotation Interface in dev.magicmq.pyspigot.command
- subscribed(String, long) - Method in class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
-
Implemented from
RedisPubSubListener
, but unused. - SUCCESS - Enum constant in enum class dev.magicmq.pyspigot.manager.libraries.LibraryManager.LoadResult
-
The library loaded successfully.
- SUCCESS - Enum constant in enum class dev.magicmq.pyspigot.manager.script.RunResult
-
Returned if the script loaded successfully.
- SyncCallbackTask - Class in dev.magicmq.pyspigot.manager.task
-
Represents an async task with a synchronous callback defined by a script.
- SyncCallbackTask(Script, PyFunction, PyFunction, Object[], long) - Constructor for class dev.magicmq.pyspigot.manager.task.SyncCallbackTask
T
- Task - Class in dev.magicmq.pyspigot.manager.task
-
Represents a task defined by a script.
- Task(Script, PyFunction, Object[], boolean, long) - Constructor for class dev.magicmq.pyspigot.manager.task.Task
- taskFinished(Task) - Method in class dev.magicmq.pyspigot.manager.task.TaskManager
- TaskManager - Class in dev.magicmq.pyspigot.manager.task
-
Manager to interface with Bukkit's scheduler.
- toString() - Method in class dev.magicmq.pyspigot.manager.command.ScriptCommand
-
Prints a representation of this ScriptCommand in string format, including all variables that pertain to the command (such as name, label, description, etc.)
- toString() - Method in class dev.magicmq.pyspigot.manager.database.Database
-
Prints a representation of this Database in string format.
- toString() - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Prints a representation of this MongoDatabase in string format, including the URI and
MongoClient
- toString() - Method in class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
-
Prints a representation of this SqlDatabase in string format, including the ID, URI, and
HikariDataSource
- toString() - Method in class dev.magicmq.pyspigot.manager.listener.ScriptEventListener
-
Prints a representation of this ScriptEventListener in string format, including the event being listened to by the listener
- toString() - Method in class dev.magicmq.pyspigot.manager.protocol.ScriptPacketListener
-
Prints a representation of this ScriptPacketListener in string format, including the packet type listened to by the listener
- toString() - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisCommandClient
-
Prints a representation of this RedisCommandClient in string format, including listeners
- toString() - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Prints a representation of this RedisPubSubClient in string format, including listeners
- toString() - Method in class dev.magicmq.pyspigot.manager.redis.client.ScriptRedisClient
-
Prints a representation of this ScriptRedisClient in string format
- toString() - Method in class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
-
Prints a representation of this ScriptPubSubListener in string format, including the channel being listened to.
- toString() - Method in class dev.magicmq.pyspigot.manager.script.ScriptOptions
-
Prints a representation of this ScriptOptions in string format, including all options as defined in script_options.yml
- toString() - Method in class dev.magicmq.pyspigot.manager.task.RepeatingTask
-
Prints a representation of this RepeatingTask in string format, including the task ID, if it is async, delay (if applicable), and interval (if applicable)
- toString() - Method in class dev.magicmq.pyspigot.manager.task.SyncCallbackTask
-
Prints a representation of this SyncCallbackTask in string format, including the task ID, if it is async, and delay (if applicable)
- toString() - Method in class dev.magicmq.pyspigot.manager.task.Task
-
Prints a representation of this Task in string format, including the task ID, if it is async, and delay (if applicable)
U
- UnloadCommand - Class in dev.magicmq.pyspigot.command.subcommands
- UnloadCommand() - Constructor for class dev.magicmq.pyspigot.command.subcommands.UnloadCommand
- unloadScript(Script, boolean) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Unload a given script.
- unloadScript(String) - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Unload a script with the given name.
- unloadScripts() - Method in class dev.magicmq.pyspigot.manager.script.ScriptManager
-
Unload all currently loaded scripts.
- unregisterAsyncPacketListener(ScriptPacketListener) - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Unregister an asynchronous packet listener.
- unregisterAsyncPacketListeners(Script) - Method in class dev.magicmq.pyspigot.manager.protocol.AsyncProtocolManager
-
Unregister all asynchronous packet listeners belonging to a script.
- unregisterCommand(ScriptCommand) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Unregister a script's command.
- unregisterCommands(Script) - Method in class dev.magicmq.pyspigot.manager.command.CommandManager
-
Unregister all commands belonging to a particular script.
- unregisterListener(ScriptEventListener) - Method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Unregister an event listener.
- unregisterListener(ScriptPubSubListener) - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Unregister the specified listener.
- unregisterListeners(Script) - Method in class dev.magicmq.pyspigot.manager.listener.ListenerManager
-
Unregister all event listeners belonging to a script.
- unregisterListeners(String) - Method in class dev.magicmq.pyspigot.manager.redis.client.RedisPubSubClient
-
Unregister all listeners (both synchronous and asynchronous) on the given channel
- unregisterPacketListener(ScriptPacketListener) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Unregister a packet listener.
- unregisterPacketListeners(Script) - Method in class dev.magicmq.pyspigot.manager.protocol.ProtocolManager
-
Unregister all normal packet listeners belonging to a script, excluding asynchronous packet listeners.
- unregisterPlaceholder(ScriptPlaceholder) - Method in class dev.magicmq.pyspigot.manager.placeholder.PlaceholderManager
-
Unregister a script placeholder expansion.
- unregisterPlaceholder(Script) - Method in class dev.magicmq.pyspigot.manager.placeholder.PlaceholderManager
-
Unregister a script's placeholder expansion.
- unsubscribed(String, long) - Method in class dev.magicmq.pyspigot.manager.redis.ScriptPubSubListener
-
Implemented from
RedisPubSubListener
, but unused. - update(String) - Method in class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
-
Update the SQL database.
- update(String, Object[]) - Method in class dev.magicmq.pyspigot.manager.database.sql.SqlDatabase
-
Update the SQL database with the provided values that should be inserted into the update statement.
- updateDocument(String, String, Bson, List<Bson>) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update one or more documents within a collection that match the given filter, with the default update options
- updateDocument(String, String, Bson, List<Bson>, UpdateOptions) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update one or more documents within a collection that match the given filter, with the provided update options
- updateDocument(String, String, Bson, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update one or more documents within a collection that match the given filter, with the default update options
- updateDocument(String, String, Bson, Bson, UpdateOptions) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update one or more documents within a collection that match the given filter, with the provided update options
- updateDocuments(String, String, Bson, List<Bson>) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update multiple documents within a collection.
- updateDocuments(String, String, Bson, List<Bson>, UpdateOptions) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update multiple documents within a collection.
- updateDocuments(String, String, Bson, Bson) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update multiple documents within a collection.
- updateDocuments(String, String, Bson, Bson, UpdateOptions) - Method in class dev.magicmq.pyspigot.manager.database.mongo.MongoDatabase
-
Update multiple documents within a collection.
- usage() - Element in annotation interface dev.magicmq.pyspigot.command.SubCommandMeta
V
- valueOf(String) - Static method in enum class dev.magicmq.pyspigot.manager.database.DatabaseType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.magicmq.pyspigot.manager.libraries.LibraryManager.LoadResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.magicmq.pyspigot.manager.protocol.ListenerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.magicmq.pyspigot.manager.redis.ClientType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.magicmq.pyspigot.manager.script.RunResult
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.magicmq.pyspigot.manager.database.DatabaseType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.magicmq.pyspigot.manager.libraries.LibraryManager.LoadResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.magicmq.pyspigot.manager.protocol.ListenerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.magicmq.pyspigot.manager.redis.ClientType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.magicmq.pyspigot.manager.script.RunResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- Version(String) - Constructor for class dev.magicmq.pyspigot.util.StringUtils.Version
W
- write(byte[]) - Method in class dev.magicmq.pyspigot.util.logging.PrintStreamWrapper
- write(byte[], int, int) - Method in class dev.magicmq.pyspigot.util.logging.PrintStreamWrapper
-
Captures writes to the PrintStream, converts the bytes into readable text (truncating according to the specified length and offset), and logs the text to the script's logger.
All Classes and Interfaces|All Packages
ScriptConfig.reload()
instead. This method will be removed in a future release.