Package com.earth2me.essentials

Class Essentials

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.earth2me.essentials.Essentials

All Implemented Interfaces:

IEssentials, IEssentials, CommandExecutor, TabCompleter, TabExecutor, Plugin

public class Essentials
extends JavaPlugin
implements IEssentials

Constructor Summary

Constructors

Modifier	Constructor	Description
	Essentials()
protected	Essentials(JavaPluginLoader loader, PluginDescriptionFile description, File dataFolder, File file)
	Essentials(Server server)

Method Summary

Modifier and Type	Method	Description
void	addReloadListener(IConf listener)
int	broadcastMessage(IUser sender, String message)
int	broadcastMessage(IUser sender, String message, Predicate<IUser> shouldExclude)
int	broadcastMessage(String message)
int	broadcastMessage(String permission, String message)
void	broadcastTl(IUser sender, String tlKey, Object... args)
void	broadcastTl(IUser sender, String permission, String tlKey, Object... args)
void	broadcastTl(IUser sender, Predicate<IUser> shouldExclude, boolean parseKeywords, String tlKey, Object... args)
void	broadcastTl(IUser sender, Predicate<IUser> shouldExclude, String tlKey, Object... args)
void	broadcastTl(String tlKey, Object... args)
boolean	canInteractWith(CommandSource interactor, User interactee)
boolean	canInteractWith(User interactor, User interactee)
void	cleanupOpenInventories()
AlternativeCommandsHandler	getAlternativeCommandsHandler()
Backup	getBackup()
BalanceTop	getBalanceTop()
net.ess3.provider.BiomeKeyProvider	getBiomeKeyProvider()
net.kyori.adventure.platform.bukkit.BukkitAudiences	getBukkitAudience()
Map<String,IEssentialsCommand>	getCommandMap()
net.ess3.provider.ContainerProvider	getContainerProvider()
CustomItemResolver	getCustomItemResolver()	Get the CustomItemResolver that is currently in use.
net.ess3.provider.DamageEventProvider	getDamageEventProvider()
net.ess3.provider.FormattedCommandAliasProvider	getFormattedCommandAliasProvider()
I18n	getI18n()
IItemDb	getItemDb()
net.ess3.provider.ItemUnbreakableProvider	getItemUnbreakableProvider()
IJails	getJails()
Kits	getKits()
net.ess3.provider.KnownCommandsProvider	getKnownCommandsProvider()
MailService	getMail()
net.ess3.provider.MaterialTagProvider	getMaterialTagProvider()
User	getOfflineUser(String name)
net.ess3.nms.refl.providers.ReflOnlineModeProvider	getOnlineModeProvider()
Collection<Player>	getOnlinePlayers()
Iterable<User>	getOnlineUsers()
PermissionsHandler	getPermissionsHandler()
net.ess3.provider.PersistentDataProvider	getPersistentDataProvider()
net.ess3.provider.PlayerLocaleProvider	getPlayerLocaleProvider()
PluginCommand	getPluginCommand(String cmd)
net.ess3.provider.PotionMetaProvider	getPotionMetaProvider()	Get the potion meta provider for the current platform.
RandomTeleport	getRandomTeleport()
BukkitScheduler	getScheduler()
net.ess3.provider.SerializationProvider	getSerializationProvider()
net.ess3.provider.ServerStateProvider	getServerStateProvider()
ISettings	getSettings()
net.ess3.provider.SignDataProvider	getSignDataProvider()
net.ess3.provider.SpawnEggProvider	getSpawnEggProvider()	Get the spawn egg provider for the current platform.
net.ess3.provider.SpawnerBlockProvider	getSpawnerBlockProvider()
net.ess3.provider.SpawnerItemProvider	getSpawnerItemProvider()
net.ess3.provider.SyncCommandsProvider	getSyncCommandsProvider()
EssentialsTimer	getTimer()
UpdateChecker	getUpdateChecker()
User	getUser(Object base)	Deprecated.
User	getUser(String base)
User	getUser(UUID base)
User	getUser(Player base)
UserMap	getUserMap()	Deprecated.
ModernUserMap	getUsers()
List<String>	getVanishedPlayers()	Get a list of players who are vanished.
Collection<String>	getVanishedPlayersNew()	Get a list of players who are vanished.
Warps	getWarps()
World	getWorld(String name)
net.ess3.provider.WorldInfoProvider	getWorldInfoProvider()
Worth	getWorth()
static Logger	getWrappedLogger()
User	matchUser(Server server, User sourceUser, String searchTerm, Boolean getHidden, boolean getOffline)
boolean	onCommand(CommandSender sender, Command command, String commandLabel, String[] args)
boolean	onCommandEssentials(CommandSender cSender, Command command, String commandLabel, String[] args, ClassLoader classLoader, String commandPath, String permissionPrefix, IEssentialsModule module)
void	onDisable()
void	onEnable()
void	onLoad()
List<String>	onTabComplete(CommandSender sender, Command command, String commandLabel, String[] args)
List<String>	onTabCompleteEssentials(CommandSender cSender, Command command, String commandLabel, String[] args, ClassLoader classLoader, String commandPath, String permissionPrefix, IEssentialsModule module)
void	reload()
BukkitTask	runTaskAsynchronously(Runnable run)
BukkitTask	runTaskLaterAsynchronously(Runnable run, long delay)
BukkitTask	runTaskTimerAsynchronously(Runnable run, long delay, long period)
void	saveConfig()
int	scheduleSyncDelayedTask(Runnable run)
int	scheduleSyncDelayedTask(Runnable run, long delay)
int	scheduleSyncRepeatingTask(Runnable run, long delay, long period)
void	setupForTesting(Server server)
void	showError(CommandSource sender, Throwable exception, String commandLabel)

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, reloadConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bukkit.plugin.Plugin

getConfig, getDataFolder, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getLogger, getName, getPluginLoader, getResource, getServer, isEnabled, isNaggable, reloadConfig, saveDefaultConfig, saveResource, setNaggable

Constructor Details

Essentials

public Essentials()

Essentials

protected Essentials(JavaPluginLoader loader,
 PluginDescriptionFile description,
 File dataFolder,
 File file)

Essentials

public Essentials(Server server)

Method Details

getSettings

public ISettings getSettings()

Specified by:

getSettings in interface IEssentials

setupForTesting

public void setupForTesting(Server server)
                     throws IOException,
InvalidDescriptionException

Throws:

IOException

InvalidDescriptionException

onLoad

public void onLoad()

Specified by:

onLoad in interface Plugin

Overrides:

onLoad in class JavaPlugin

onEnable

public void onEnable()

Specified by:

onEnable in interface Plugin

Overrides:

onEnable in class JavaPlugin

getWrappedLogger

public static Logger getWrappedLogger()

saveConfig

public void saveConfig()

Specified by:

saveConfig in interface Plugin

Overrides:

saveConfig in class JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface Plugin

Overrides:

onDisable in class JavaPlugin

reload

public void reload()

Specified by:

reload in interface IEssentials

getCommandMap

public Map<String,IEssentialsCommand> getCommandMap()

Specified by:

getCommandMap in interface IEssentials

onTabComplete

public List<String> onTabComplete(CommandSender sender,
 Command command,
 String commandLabel,
 String[] args)

Specified by:

onTabComplete in interface TabCompleter

Overrides:

onTabComplete in class JavaPlugin

onTabCompleteEssentials

public List<String> onTabCompleteEssentials(CommandSender cSender,
 Command command,
 String commandLabel,
 String[] args,
 ClassLoader classLoader,
 String commandPath,
 String permissionPrefix,
 IEssentialsModule module)

Specified by:

onTabCompleteEssentials in interface IEssentials

onCommand

public boolean onCommand(CommandSender sender,
 Command command,
 String commandLabel,
 String[] args)

Specified by:

onCommand in interface CommandExecutor

Overrides:

onCommand in class JavaPlugin

onCommandEssentials

public boolean onCommandEssentials(CommandSender cSender,
 Command command,
 String commandLabel,
 String[] args,
 ClassLoader classLoader,
 String commandPath,
 String permissionPrefix,
 IEssentialsModule module)

Specified by:

onCommandEssentials in interface IEssentials

cleanupOpenInventories

public void cleanupOpenInventories()

showError

public void showError(CommandSource sender,
 Throwable exception,
 String commandLabel)

Specified by:

showError in interface IEssentials

getScheduler

public BukkitScheduler getScheduler()

Specified by:

getScheduler in interface IEssentials

getJails

public IJails getJails()

Specified by:

getJails in interface IEssentials

getWarps

public Warps getWarps()

Specified by:

getWarps in interface IEssentials

getWorth

public Worth getWorth()

Specified by:

getWorth in interface IEssentials

getBackup

public Backup getBackup()

Specified by:

getBackup in interface IEssentials

getKits

public Kits getKits()

Specified by:

getKits in interface IEssentials

getRandomTeleport

public RandomTeleport getRandomTeleport()

Specified by:

getRandomTeleport in interface IEssentials

getUpdateChecker

public UpdateChecker getUpdateChecker()

Specified by:

getUpdateChecker in interface IEssentials

getUser

@Deprecated
public User getUser(Object base)

Deprecated.

Specified by:

getUser in interface IEssentials

getUser

public User getUser(String base)

Specified by:

getUser in interface IEssentials

getUser

public User getUser(UUID base)

Specified by:

getUser in interface IEssentials

getOfflineUser

public User getOfflineUser(String name)

Specified by:

getOfflineUser in interface IEssentials

matchUser

public User matchUser(Server server,
 User sourceUser,
 String searchTerm,
 Boolean getHidden,
 boolean getOffline)
               throws PlayerNotFoundException

Specified by:

matchUser in interface IEssentials

Throws:

PlayerNotFoundException

canInteractWith

public boolean canInteractWith(CommandSource interactor,
 User interactee)

Specified by:

canInteractWith in interface IEssentials

canInteractWith

public boolean canInteractWith(User interactor,
 User interactee)

Specified by:

canInteractWith in interface IEssentials

getUser

public User getUser(Player base)

Specified by:

getUser in interface IEssentials

getWorld

public World getWorld(String name)

Specified by:

getWorld in interface IEssentials

addReloadListener

public void addReloadListener(IConf listener)

Specified by:

addReloadListener in interface IEssentials

broadcastMessage

public int broadcastMessage(String message)

Specified by:

broadcastMessage in interface IEssentials

broadcastMessage

public int broadcastMessage(IUser sender,
 String message)

Specified by:

broadcastMessage in interface IEssentials

broadcastMessage

public int broadcastMessage(IUser sender,
 String message,
 Predicate<IUser> shouldExclude)

Specified by:

broadcastMessage in interface IEssentials

broadcastMessage

public int broadcastMessage(String permission,
 String message)

Specified by:

broadcastMessage in interface IEssentials

broadcastTl

public void broadcastTl(String tlKey,
 Object... args)

Specified by:

broadcastTl in interface IEssentials

broadcastTl

public void broadcastTl(IUser sender,
 String tlKey,
 Object... args)

Specified by:

broadcastTl in interface IEssentials

broadcastTl

public void broadcastTl(IUser sender,
 String permission,
 String tlKey,
 Object... args)

Specified by:

broadcastTl in interface IEssentials

broadcastTl

public void broadcastTl(IUser sender,
 Predicate<IUser> shouldExclude,
 String tlKey,
 Object... args)

Specified by:

broadcastTl in interface IEssentials

broadcastTl

public void broadcastTl(IUser sender,
 Predicate<IUser> shouldExclude,
 boolean parseKeywords,
 String tlKey,
 Object... args)

Specified by:

broadcastTl in interface IEssentials

runTaskAsynchronously

public BukkitTask runTaskAsynchronously(Runnable run)

Specified by:

runTaskAsynchronously in interface IEssentials

runTaskLaterAsynchronously

public BukkitTask runTaskLaterAsynchronously(Runnable run,
 long delay)

Specified by:

runTaskLaterAsynchronously in interface IEssentials

runTaskTimerAsynchronously

public BukkitTask runTaskTimerAsynchronously(Runnable run,
 long delay,
 long period)

Specified by:

runTaskTimerAsynchronously in interface IEssentials

scheduleSyncDelayedTask

public int scheduleSyncDelayedTask(Runnable run)

Specified by:

scheduleSyncDelayedTask in interface IEssentials

scheduleSyncDelayedTask

public int scheduleSyncDelayedTask(Runnable run,
 long delay)

Specified by:

scheduleSyncDelayedTask in interface IEssentials

scheduleSyncRepeatingTask

public int scheduleSyncRepeatingTask(Runnable run,
 long delay,
 long period)

Specified by:

scheduleSyncRepeatingTask in interface IEssentials

getPermissionsHandler

public PermissionsHandler getPermissionsHandler()

Specified by:

getPermissionsHandler in interface IEssentials

getAlternativeCommandsHandler

public AlternativeCommandsHandler getAlternativeCommandsHandler()

Specified by:

getAlternativeCommandsHandler in interface IEssentials

getItemDb

public IItemDb getItemDb()

Specified by:

getItemDb in interface IEssentials

getUserMap

@Deprecated
public UserMap getUserMap()

Deprecated.

Specified by:

getUserMap in interface IEssentials

getUsers

public ModernUserMap getUsers()

Specified by:

getUsers in interface IEssentials

getBalanceTop

public BalanceTop getBalanceTop()

Specified by:

getBalanceTop in interface IEssentials

getI18n

public I18n getI18n()

Specified by:

getI18n in interface IEssentials

getTimer

public EssentialsTimer getTimer()

Specified by:

getTimer in interface IEssentials

getMail

public MailService getMail()

Specified by:

getMail in interface IEssentials

getVanishedPlayers

public List<String> getVanishedPlayers()

Description copied from interface: IEssentials

Get a list of players who are vanished.

Specified by:

getVanishedPlayers in interface IEssentials

Returns:

A list of players who are vanished

getVanishedPlayersNew

public Collection<String> getVanishedPlayersNew()

Description copied from interface: IEssentials

Get a list of players who are vanished.

Specified by:

getVanishedPlayersNew in interface IEssentials

Returns:

A list of players who are vanished

getOnlinePlayers

public Collection<Player> getOnlinePlayers()

Specified by:

getOnlinePlayers in interface IEssentials

getOnlineUsers

public Iterable<User> getOnlineUsers()

Specified by:

getOnlineUsers in interface IEssentials

getSpawnerItemProvider

public net.ess3.provider.SpawnerItemProvider getSpawnerItemProvider()

Specified by:

getSpawnerItemProvider in interface IEssentials

getSpawnerBlockProvider

public net.ess3.provider.SpawnerBlockProvider getSpawnerBlockProvider()

Specified by:

getSpawnerBlockProvider in interface IEssentials

getSpawnEggProvider

public net.ess3.provider.SpawnEggProvider getSpawnEggProvider()

Description copied from interface: IEssentials

Get the spawn egg provider for the current platform.

Specified by:

getSpawnEggProvider in interface IEssentials

Returns:

The current active spawn egg provider

getPotionMetaProvider

public net.ess3.provider.PotionMetaProvider getPotionMetaProvider()

Description copied from interface: IEssentials

Get the potion meta provider for the current platform.

Specified by:

getPotionMetaProvider in interface IEssentials

Returns:

The current active potion meta provider

getCustomItemResolver

public CustomItemResolver getCustomItemResolver()

Description copied from interface: IEssentials

Get the CustomItemResolver that is currently in use. Note: external plugins should generally avoid using this. If you want to add custom items from your plugin, you probably want to implement your own IItemDb.ItemResolver.

Specified by:

getCustomItemResolver in interface IEssentials

Returns:

The custom item resolver

getServerStateProvider

public net.ess3.provider.ServerStateProvider getServerStateProvider()

Specified by:

getServerStateProvider in interface IEssentials

getMaterialTagProvider

public net.ess3.provider.MaterialTagProvider getMaterialTagProvider()

Specified by:

getMaterialTagProvider in interface IEssentials

getContainerProvider

public net.ess3.provider.ContainerProvider getContainerProvider()

Specified by:

getContainerProvider in interface IEssentials

getKnownCommandsProvider

public net.ess3.provider.KnownCommandsProvider getKnownCommandsProvider()

Specified by:

getKnownCommandsProvider in interface IEssentials

getSerializationProvider

public net.ess3.provider.SerializationProvider getSerializationProvider()

Specified by:

getSerializationProvider in interface IEssentials

getFormattedCommandAliasProvider

public net.ess3.provider.FormattedCommandAliasProvider getFormattedCommandAliasProvider()

Specified by:

getFormattedCommandAliasProvider in interface IEssentials

getSyncCommandsProvider

public net.ess3.provider.SyncCommandsProvider getSyncCommandsProvider()

Specified by:

getSyncCommandsProvider in interface IEssentials

getPersistentDataProvider

public net.ess3.provider.PersistentDataProvider getPersistentDataProvider()

Specified by:

getPersistentDataProvider in interface IEssentials

getOnlineModeProvider

public net.ess3.nms.refl.providers.ReflOnlineModeProvider getOnlineModeProvider()

Specified by:

getOnlineModeProvider in interface IEssentials

getItemUnbreakableProvider

public net.ess3.provider.ItemUnbreakableProvider getItemUnbreakableProvider()

Specified by:

getItemUnbreakableProvider in interface IEssentials

getWorldInfoProvider

public net.ess3.provider.WorldInfoProvider getWorldInfoProvider()

Specified by:

getWorldInfoProvider in interface IEssentials

getPlayerLocaleProvider

public net.ess3.provider.PlayerLocaleProvider getPlayerLocaleProvider()

Specified by:

getPlayerLocaleProvider in interface IEssentials

getDamageEventProvider

public net.ess3.provider.DamageEventProvider getDamageEventProvider()

Specified by:

getDamageEventProvider in interface IEssentials

getBiomeKeyProvider

public net.ess3.provider.BiomeKeyProvider getBiomeKeyProvider()

Specified by:

getBiomeKeyProvider in interface IEssentials

getSignDataProvider

public net.ess3.provider.SignDataProvider getSignDataProvider()

Specified by:

getSignDataProvider in interface IEssentials

getPluginCommand

public PluginCommand getPluginCommand(String cmd)

Specified by:

getPluginCommand in interface IEssentials

getBukkitAudience

public net.kyori.adventure.platform.bukkit.BukkitAudiences getBukkitAudience()