Package com.earth2me.essentials

Interface IEssentials

All Superinterfaces:

CommandExecutor, Plugin, TabCompleter, TabExecutor

All Known Subinterfaces:

IEssentials

All Known Implementing Classes:

Essentials

public interface IEssentials
extends Plugin

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)
AlternativeCommandsHandler	getAlternativeCommandsHandler()
Backup	getBackup()
BalanceTop	getBalanceTop()
Map<String,IEssentialsCommand>	getCommandMap()
I18n	getI18n()
IItemDb	getItemDb()
IJails	getJails()
Kits	getKits()
MailService	getMail()
User	getOfflineUser(String name)
Collection<Player>	getOnlinePlayers()
Iterable<User>	getOnlineUsers()
PermissionsHandler	getPermissionsHandler()
PluginCommand	getPluginCommand(String cmd)
ProviderFactory	getProviders()
RandomTeleport	getRandomTeleport()
BukkitScheduler	getScheduler()
ISettings	getSettings()
EssentialsTimer	getTimer()
UpdateChecker	getUpdateChecker()
User	getUser(Object base)	Deprecated.
User	getUser(String base)
User	getUser(UUID base)
User	getUser(Player base)
UserMap	getUserMap()	Deprecated.
IUserMap	getUsers()
List<String>	getVanishedPlayers()	Deprecated. Use IEssentials.getVanishedPlayersNew() where possible.
IWarps	getWarps()
World	getWorld(String name)
Worth	getWorth()
User	matchUser(Server server, User sourceUser, String searchTerm, Boolean getHidden, boolean getOffline)
boolean	onCommandEssentials(CommandSender sender, Command command, String commandLabel, String[] args, ClassLoader classLoader, String commandPath, String permissionPrefix, IEssentialsModule module)
List<String>	onTabCompleteEssentials(CommandSender sender, Command command, String commandLabel, String[] args, ClassLoader classLoader, String commandPath, String permissionPrefix, IEssentialsModule module)
default <P extends net.ess3.provider.Provider> P	provider(Class<P> providerClass)
void	reload()
BukkitTask	runTaskAsynchronously(Runnable run)
BukkitTask	runTaskLaterAsynchronously(Runnable run, long delay)
BukkitTask	runTaskTimerAsynchronously(Runnable run, long delay, long period)
int	scheduleSyncDelayedTask(Runnable run)
int	scheduleSyncDelayedTask(Runnable run, long delay)
int	scheduleSyncRepeatingTask(Runnable run, long delay, long period)
void	showError(CommandSource sender, Throwable exception, String commandLabel)

Methods inherited from interface org.bukkit.command.CommandExecutor

onCommand

Methods inherited from interface org.bukkit.plugin.Plugin

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

Methods inherited from interface org.bukkit.command.TabCompleter

onTabComplete

Method Details

addReloadListener

void addReloadListener(IConf listener)

reload

void reload()

getCommandMap

Map<String,IEssentialsCommand> getCommandMap()

onTabCompleteEssentials

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

onCommandEssentials

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

getUser

@Deprecated
User getUser(Object base)

Deprecated.

getUser

User getUser(UUID base)

getUser

User getUser(String base)

getUser

User getUser(Player base)

matchUser

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

Throws:

PlayerNotFoundException

canInteractWith

boolean canInteractWith(CommandSource interactor,
 User interactee)

canInteractWith

boolean canInteractWith(User interactor,
 User interactee)

getI18n

I18n getI18n()

getOfflineUser

User getOfflineUser(String name)

getWorld

World getWorld(String name)

broadcastMessage

int broadcastMessage(String message)

broadcastMessage

int broadcastMessage(IUser sender,
 String message)

broadcastMessage

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

broadcastMessage

int broadcastMessage(String permission,
 String message)

broadcastTl

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

broadcastTl

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

broadcastTl

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

broadcastTl

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

broadcastTl

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

getSettings

ISettings getSettings()

getScheduler

BukkitScheduler getScheduler()

getJails

IJails getJails()

getWarps

IWarps getWarps()

getWorth

Worth getWorth()

getBackup

Backup getBackup()

getKits

Kits getKits()

getRandomTeleport

RandomTeleport getRandomTeleport()

getUpdateChecker

UpdateChecker getUpdateChecker()

runTaskAsynchronously

BukkitTask runTaskAsynchronously(Runnable run)

runTaskLaterAsynchronously

BukkitTask runTaskLaterAsynchronously(Runnable run,
 long delay)

runTaskTimerAsynchronously

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

scheduleSyncDelayedTask

int scheduleSyncDelayedTask(Runnable run)

scheduleSyncDelayedTask

int scheduleSyncDelayedTask(Runnable run,
 long delay)

scheduleSyncRepeatingTask

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

getPermissionsHandler

PermissionsHandler getPermissionsHandler()

getAlternativeCommandsHandler

AlternativeCommandsHandler getAlternativeCommandsHandler()

showError

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

getItemDb

IItemDb getItemDb()

getUsers

IUserMap getUsers()

getUserMap

@Deprecated
UserMap getUserMap()

Deprecated.

getBalanceTop

BalanceTop getBalanceTop()

getTimer

EssentialsTimer getTimer()

getMail

MailService getMail()

getVanishedPlayers

@Deprecated
List<String> getVanishedPlayers()

Deprecated.

Use IEssentials.getVanishedPlayersNew() where possible.

Get a list of players who are vanished.

Returns:

A list of players who are vanished

getOnlinePlayers

Collection<Player> getOnlinePlayers()

getOnlineUsers

Iterable<User> getOnlineUsers()

getPluginCommand

PluginCommand getPluginCommand(String cmd)

getProviders

ProviderFactory getProviders()

provider

default <P extends net.ess3.provider.Provider> P provider(Class<P> providerClass)