Package studio.magemonkey.codex

Class CodexEngine

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

studio.magemonkey.codex.CodexPlugin<CodexEngine>

studio.magemonkey.codex.CodexEngine

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.event.Listener, org.bukkit.plugin.Plugin, studio.magemonkey.codex.manager.api.Loggable

public class CodexEngine
extends CodexPlugin<CodexEngine>
implements org.bukkit.event.Listener

Field Summary

Fields inherited from class studio.magemonkey.codex.CodexPlugin

commandManager, configManager, editorHandler, moduleManager

Constructor Summary

Constructors

Constructor	Description
CodexEngine()
CodexEngine(org.bukkit.plugin.java.JavaPluginLoader loader, org.bukkit.plugin.PluginDescriptionFile description, File dataFolder, File file)

Method Summary

Modifier and Type	Method	Description
CoreConfig	cfg()
void	disable()
void	enable()
static CodexEngine	get()
ActionsManager	getActionsManager()
Set<CodexPlugin<?>>	getChildPlugins()
CitizensHK	getCitizens()
String	getCommandMessage()	Retrieves the message to be shown when a command is on cooldown
Config	getConfigFile(org.bukkit.plugin.java.JavaPlugin plugin, String file)	Retrieves the configuration file for a plugin
studio.magemonkey.codex.util.craft.CraftManager	getCraftManager()
HookManager	getHooksManager()
CodexItemManager	getItemManager()
studio.magemonkey.codex.manager.api.menu.MenuManager	getMenuManager()
studio.magemonkey.codex.util.messages.AbstractMessageUtil	getMessageUtil()
IMythicHook	getMythicMobs()
PacketManager	getPacketManager()
org.bukkit.plugin.PluginManager	getPluginManager()
VaultHK	getVault()
WorldGuardHK	getWorldGuard()
boolean	isChatEnabled()	Checks whether Codex's chat management is enabled
boolean	isScoreboardsEnabled()
CoreLang	lang()
void	onHookLate(org.bukkit.event.server.PluginEnableEvent e)
void	registerCommands(IGeneralCommand<CodexEngine> mainCommand)
void	registerConfig(Config config)	Registers the Config with Codex for auto saving.
void	registerEditor()
protected void	registerEvents()
void	registerHooks()
void	setConfig()

Methods inherited from class studio.magemonkey.codex.CodexPlugin

error, getAuthor, getClazzLoader, getCommandManager, getConfigManager, getEditorHandler, getEngine, getHook, getHook, getHooks, getLabel, getLabels, getMainCommand, getModuleManager, getNameRaw, hasEditor, info, isEngine, isHooked, isHooked, isSpigot, onDisable, onEnable, openEditor, registerHook, reload, warn

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, onCommand, onLoad, onTabComplete, reloadConfig, saveConfig, 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

Constructor Details

CodexEngine

public CodexEngine()

CodexEngine

public CodexEngine(org.bukkit.plugin.java.JavaPluginLoader loader,
 org.bukkit.plugin.PluginDescriptionFile description,
 File dataFolder,
 File file)

Method Details

get

@NotNull
public static CodexEngine get()

registerEvents

protected void registerEvents()

enable

public void enable()

Specified by:

enable in class CodexPlugin<CodexEngine>

disable

public void disable()

Specified by:

disable in class CodexPlugin<CodexEngine>

setConfig

public void setConfig()

Specified by:

setConfig in class CodexPlugin<CodexEngine>

registerHooks

public void registerHooks()

Specified by:

registerHooks in class CodexPlugin<CodexEngine>

registerCommands

public void registerCommands(@NotNull
 IGeneralCommand<CodexEngine> mainCommand)

Specified by:

registerCommands in class CodexPlugin<CodexEngine>

registerEditor

public void registerEditor()

Specified by:

registerEditor in class CodexPlugin<CodexEngine>

cfg

@NotNull
public CoreConfig cfg()

Specified by:

cfg in class CodexPlugin<CodexEngine>

lang

@NotNull
public CoreLang lang()

Specified by:

lang in class CodexPlugin<CodexEngine>

getChildPlugins

@NotNull
public Set<CodexPlugin<?>> getChildPlugins()

onHookLate

public void onHookLate(org.bukkit.event.server.PluginEnableEvent e)

getConfigFile

public Config getConfigFile(org.bukkit.plugin.java.JavaPlugin plugin,
 String file)

Retrieves the configuration file for a plugin

If the config file hasn't been loaded yet, this will load the file first.

Configs retrieved via this method are handled by Codex and automatically saved when Codex disables.

This should not be used for settings configs that admins may want to edit while the server is running as the auto save will overwrite any changes they make.

Parameters:

file - file name

Returns:

config manager for the file

registerConfig

public void registerConfig(Config config)

Registers the Config with Codex for auto saving.

If the Config was already registered, this method will not do anything.

Parameters:

config - config to register

getPluginManager

public org.bukkit.plugin.PluginManager getPluginManager()

Overrides:

getPluginManager in class CodexPlugin<CodexEngine>

getPacketManager

public PacketManager getPacketManager()

Overrides:

getPacketManager in class CodexPlugin<CodexEngine>

getActionsManager

public ActionsManager getActionsManager()

Overrides:

getActionsManager in class CodexPlugin<CodexEngine>

getCraftManager

public studio.magemonkey.codex.util.craft.CraftManager getCraftManager()

Overrides:

getCraftManager in class CodexPlugin<CodexEngine>

getMenuManager

public studio.magemonkey.codex.manager.api.menu.MenuManager getMenuManager()

getVault

public VaultHK getVault()

Overrides:

getVault in class CodexPlugin<CodexEngine>

getCitizens

public CitizensHK getCitizens()

Overrides:

getCitizens in class CodexPlugin<CodexEngine>

getWorldGuard

public WorldGuardHK getWorldGuard()

Overrides:

getWorldGuard in class CodexPlugin<CodexEngine>

getMythicMobs

public IMythicHook getMythicMobs()

Overrides:

getMythicMobs in class CodexPlugin<CodexEngine>

getHooksManager

public HookManager getHooksManager()

getItemManager

public CodexItemManager getItemManager()

getMessageUtil

public studio.magemonkey.codex.util.messages.AbstractMessageUtil getMessageUtil()

isChatEnabled

public boolean isChatEnabled()

Checks whether Codex's chat management is enabled

Returns:

true if enabled, false otherwise

getCommandMessage

public String getCommandMessage()

Retrieves the message to be shown when a command is on cooldown

Returns:

command cooldown message

isScoreboardsEnabled

public boolean isScoreboardsEnabled()