net.citizensnpcs

Class Citizens

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

net.citizensnpcs.Citizens

All Implemented Interfaces:

CitizensPlugin, org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class Citizens
extends org.bukkit.plugin.java.JavaPlugin
implements CitizensPlugin

Constructor Summary

Constructors

Constructor and Description
Citizens()

Method Summary

Modifier and Type	Method and Description
NPCRegistry	createAnonymousNPCRegistry(NPCDataStore store)
NPCRegistry	createCitizensBackedNPCRegistry(NPCDataStore store) Creates a new anonymous NPCRegistry that is "Citizens-backed" i.e.
NPCRegistry	createNamedNPCRegistry(String name, NPCDataStore store)
CommandManager.CommandInfo	getCommandInfo(String rootCommand, String modifier)
Iterable<CommandManager.CommandInfo>	getCommands(String base)
NPCSelector	getDefaultNPCSelector()
NPCRegistry	getNamedNPCRegistry(String name)
Iterable<NPCRegistry>	getNPCRegistries() Get all registered NPCRegistrys.
NPCRegistry	getNPCRegistry() Gets the default NPCRegistry.
NPCSelector	getNPCSelector()
ClassLoader	getOwningClassLoader()
File	getScriptFolder()
SkullMetaProvider	getSkullMetaProvider()
SpeechFactory	getSpeechFactory() Gets the SpeechFactory.
TraitFactory	getTraitFactory() Gets the TraitFactory.
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command command, String cmdName, String[] args)
void	onDisable()
void	onEnable()
void	onImplementationChanged() Called when the current Citizens implementation is changed
void	registerCommandClass(Class<?> clazz)
void	reload()
void	removeNamedNPCRegistry(String name) Removes the named NPCRegistry with the given name.
void	setDefaultNPCDataStore(NPCDataStore store) Sets the default NPC data store.
void	storeNPCs()
void	storeNPCs(CommandContext args)

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

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, 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

Methods inherited from interface org.bukkit.plugin.Plugin

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

Methods inherited from interface org.bukkit.command.TabCompleter

onTabComplete

Constructor Detail

Citizens

public Citizens()

Method Detail

createAnonymousNPCRegistry

public NPCRegistry createAnonymousNPCRegistry(NPCDataStore store)

Specified by:

createAnonymousNPCRegistry in interface CitizensPlugin

Parameters:

store - The data store of the registry

Returns:

A new anonymous NPCRegistry that is not accessible via CitizensPlugin.getNamedNPCRegistry(String)

createCitizensBackedNPCRegistry

public NPCRegistry createCitizensBackedNPCRegistry(NPCDataStore store)

Description copied from interface: CitizensPlugin

Creates a new anonymous NPCRegistry that is "Citizens-backed" i.e. will reload and unload at the same time that Citizens reloads and unloads.

Specified by:

createCitizensBackedNPCRegistry in interface CitizensPlugin

Parameters:

store - The NPCDataStore to use with the registry

createNamedNPCRegistry

public NPCRegistry createNamedNPCRegistry(String name,
                                          NPCDataStore store)

Specified by:

createNamedNPCRegistry in interface CitizensPlugin

Parameters:

name - The plugin name

store - The data store for the registry

Returns:

A new NPCRegistry, that can also be retrieved via CitizensPlugin.getNamedNPCRegistry(String)

getCommandInfo

public CommandManager.CommandInfo getCommandInfo(String rootCommand,
                                                 String modifier)

getCommands

public Iterable<CommandManager.CommandInfo> getCommands(String base)

getDefaultNPCSelector

public NPCSelector getDefaultNPCSelector()

Specified by:

getDefaultNPCSelector in interface CitizensPlugin

Returns:

The default NPCSelector for managing player/server NPC selection

getNamedNPCRegistry

public NPCRegistry getNamedNPCRegistry(String name)

Specified by:

getNamedNPCRegistry in interface CitizensPlugin

Parameters:

name - The plugin name

Returns:

A NPCRegistry previously created via CitizensPlugin.createNamedNPCRegistry(String, NPCDataStore), or null if not found

getNPCRegistries

public Iterable<NPCRegistry> getNPCRegistries()

Description copied from interface: CitizensPlugin

Get all registered NPCRegistrys.

Specified by:

getNPCRegistries in interface CitizensPlugin

getNPCRegistry

public NPCRegistry getNPCRegistry()

Description copied from interface: CitizensPlugin

Gets the default NPCRegistry.

Specified by:

getNPCRegistry in interface CitizensPlugin

Returns:

The NPC registry

getNPCSelector

public NPCSelector getNPCSelector()

getOwningClassLoader

public ClassLoader getOwningClassLoader()

Specified by:

getOwningClassLoader in interface CitizensPlugin

getScriptFolder

public File getScriptFolder()

Specified by:

getScriptFolder in interface CitizensPlugin

Returns:

The folder for storing scripts

getSkullMetaProvider

public SkullMetaProvider getSkullMetaProvider()

Specified by:

getSkullMetaProvider in interface CitizensPlugin

Returns:

The Skull ItemMeta provider

getSpeechFactory

public SpeechFactory getSpeechFactory()

Description copied from interface: CitizensPlugin

Gets the SpeechFactory.

Specified by:

getSpeechFactory in interface CitizensPlugin

Returns:

Citizens speech factory

getTraitFactory

public TraitFactory getTraitFactory()

Description copied from interface: CitizensPlugin

Gets the TraitFactory.

Specified by:

getTraitFactory in interface CitizensPlugin

Returns:

Citizens trait factory

onCommand

public boolean onCommand(org.bukkit.command.CommandSender sender,
                         org.bukkit.command.Command command,
                         String cmdName,
                         String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

Overrides:

onCommand in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onImplementationChanged

public void onImplementationChanged()

Description copied from interface: CitizensPlugin

Called when the current Citizens implementation is changed

Specified by:

onImplementationChanged in interface CitizensPlugin

registerCommandClass

public void registerCommandClass(Class<?> clazz)

reload

public void reload()
            throws NPCLoadException

Throws:

NPCLoadException

removeNamedNPCRegistry

public void removeNamedNPCRegistry(String name)

Description copied from interface: CitizensPlugin

Removes the named NPCRegistry with the given name.

Specified by:

removeNamedNPCRegistry in interface CitizensPlugin

setDefaultNPCDataStore

public void setDefaultNPCDataStore(NPCDataStore store)

Description copied from interface: CitizensPlugin

Sets the default NPC data store. Should be set during onEnable.

Specified by:

setDefaultNPCDataStore in interface CitizensPlugin

Parameters:

store - The new default store

storeNPCs

public void storeNPCs()

storeNPCs

public void storeNPCs(CommandContext args)