io.github.bananapuncher714.cartographer.core.module

Class Module

java.lang.Object

io.github.bananapuncher714.cartographer.core.module.Module

public abstract class Module
extends java.lang.Object

An addon for Cartographer2. Allows for extreme customization.

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
Module() There should always be an empty constructor for initialization by Cartographer2's ModuleLoader

Method Summary

Modifier and Type	Method and Description
protected Locale	convertToDefaultLocale(Locale locale)
Cartographer	getCartographer() Get the Cartographer instance.
java.io.File	getDataFolder() Get the local data folder, much like a plugin's data folder.
ModuleDescription	getDescription() Get the description of the module.
java.io.File	getFile() Quick get file method.
java.util.Collection<Locale>	getLocales() Get a list of supported locales for this module
java.util.logging.Logger	getLogger()
java.lang.String	getName() Quick get name method.
java.io.InputStream	getResource(java.lang.String mrl) Get a resource from the jar or zip of the module file.
SettingState<?>[]	getSettingStates()
protected ModuleTracker	getTracker()
java.lang.String	getVersion() Quick get version method.
boolean	isEnabled() Enabled or not.
void	load(Cartographer plugin, ModuleDescription description, java.io.File file) Developers should not call this.
protected java.util.Collection<Locale>	loadLocale(java.io.File file)
protected Locale	loadLocale(java.io.InputStream stream)
void	onDisable() Optional disable method.
abstract void	onEnable() Starting point of any module.
protected void	registerCommand(org.bukkit.command.PluginCommand command) Gets a command with the given name.
void	registerListener(org.bukkit.event.Listener listener) Register any listener under Cartographer2.
protected void	registerLocales() Call to register locales with the locale manager Should be done in the onEnable method
protected org.bukkit.scheduler.BukkitTask	runTask(java.lang.Runnable runnable, long delay)
protected org.bukkit.scheduler.BukkitTask	runTaskTimer(java.lang.Runnable runnable, long delay, long interval)
boolean	setEnabled(boolean enabled) Set to enable or disable.
java.lang.String	translate(org.bukkit.command.CommandSender sender, java.lang.String key, java.lang.Object... params)
java.lang.String	translate(java.lang.String code, org.bukkit.command.CommandSender sender, java.lang.String key, java.lang.Object... params)
java.lang.String	translateAndSend(org.bukkit.command.CommandSender sender, java.lang.String key, java.lang.Object... params)
java.lang.String	translateAndSend(java.lang.String code, org.bukkit.command.CommandSender sender, java.lang.String key, java.lang.Object... params)
void	unload()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Module

public Module()

There should always be an empty constructor for initialization by Cartographer2's ModuleLoader

Method Detail

load

public final void load(Cartographer plugin,
                       ModuleDescription description,
                       java.io.File file)

Developers should not call this. Purely for loading by Cartographer2.

Parameters:

plugin - The Cartographer instance.

description - A ModuleDescription of this module.

file - The data folder.

unload

public final void unload()

onEnable

public abstract void onEnable()

Starting point of any module.

onDisable

public void onDisable()

Optional disable method.

getSettingStates

public SettingState<?>[] getSettingStates()

getTracker

protected final ModuleTracker getTracker()

registerCommand

protected final void registerCommand(org.bukkit.command.PluginCommand command)

Gets a command with the given name.

Parameters:

id - The name of the command. Cannot be null.

runTaskTimer

protected org.bukkit.scheduler.BukkitTask runTaskTimer(java.lang.Runnable runnable,
                                                       long delay,
                                                       long interval)

runTask

protected org.bukkit.scheduler.BukkitTask runTask(java.lang.Runnable runnable,
                                                  long delay)

getLocales

public java.util.Collection<Locale> getLocales()

Get a list of supported locales for this module

Returns:

registerLocales

protected final void registerLocales()

Call to register locales with the locale manager Should be done in the onEnable method

convertToDefaultLocale

protected final Locale convertToDefaultLocale(Locale locale)

loadLocale

protected final Locale loadLocale(java.io.InputStream stream)

loadLocale

protected final java.util.Collection<Locale> loadLocale(java.io.File file)

translate

public java.lang.String translate(java.lang.String code,
                                  org.bukkit.command.CommandSender sender,
                                  java.lang.String key,
                                  java.lang.Object... params)

translate

public java.lang.String translate(org.bukkit.command.CommandSender sender,
                                  java.lang.String key,
                                  java.lang.Object... params)

translateAndSend

public java.lang.String translateAndSend(java.lang.String code,
                                         org.bukkit.command.CommandSender sender,
                                         java.lang.String key,
                                         java.lang.Object... params)

translateAndSend

public java.lang.String translateAndSend(org.bukkit.command.CommandSender sender,
                                         java.lang.String key,
                                         java.lang.Object... params)

setEnabled

public boolean setEnabled(boolean enabled)

Set to enable or disable. You should use ModuleManager.enableModule( Module ) or ModuleManager.disableModule( Module ) instead.

Parameters:

enabled - Enabled or not.

Returns:

Whether or not it was successful. false indicates nothing changed.

getResource

public java.io.InputStream getResource(java.lang.String mrl)

Get a resource from the jar or zip of the module file.

Parameters:

mrl - The path, starting at the base of the jar or zip. Cannot be null.

Returns:

An InputStream of the resource, or null.

registerListener

public void registerListener(org.bukkit.event.Listener listener)

Register any listener under Cartographer2.

Parameters:

listener - The listener to be registered. Cannot be null.

getCartographer

public final Cartographer getCartographer()

Get the Cartographer instance.

Returns:

The current instance.

getLogger

public final java.util.logging.Logger getLogger()

isEnabled

public final boolean isEnabled()

Enabled or not.

Returns:

Boolean indicating enabled state, not loaded state.

getDataFolder

public final java.io.File getDataFolder()

Get the local data folder, much like a plugin's data folder.

Returns:

A directory.

getDescription

public final ModuleDescription getDescription()

Get the description of the module.

Returns:

Should be unique per person.

getFile

public final java.io.File getFile()

Quick get file method.

Returns:

The jar file of this module.

getName

public final java.lang.String getName()

Quick get name method.

Returns:

String of the name.

getVersion

public final java.lang.String getVersion()

Quick get version method.

Returns:

String of the version.