CitizensAPI (citizens-main 2.0.28-SNAPSHOT API)

java.lang.Object
- net.citizensnpcs.api.CitizensAPI

```
public final class CitizensAPI
extends Object
```
Contains methods used in order to utilize the Citizens API.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static NPCRegistry`	`createAnonymousNPCRegistry(NPCDataStore store)` Creates a new anonymous `NPCRegistry` with its own set of `NPC`s.
`static NPCRegistry`	`createCitizensBackedNPCRegistry(NPCDataStore store)` Creates a new anonymous `NPCRegistry` that is "Citizens-backed" i.e.
`static NPCRegistry`	`createNamedNPCRegistry(String name, NPCDataStore store)` Creates a new `NPCRegistry` with its own set of `NPC`s.
`static File`	`getDataFolder()`
`static NPCSelector`	`getDefaultNPCSelector()`
`static NPCRegistry`	`getNamedNPCRegistry(String name)` Retrieves the `NPCRegistry` previously created via `createNamedNPCRegistry(String, NPCDataStore)` with the given name, or null if not found.
`static Iterable<NPCRegistry>`	`getNPCRegistries()`
`static NPCRegistry`	`getNPCRegistry()` Gets the current implementation's default `NPCRegistry`.
`static org.bukkit.plugin.Plugin`	`getPlugin()`
`static ScriptCompiler`	`getScriptCompiler()`
`static File`	`getScriptFolder()`
`static SkullMetaProvider`	`getSkullMetaProvider()`
`static SpeechFactory`	`getSpeechFactory()` Gets the current implementation's `SpeechFactory`.
`static TraitFactory`	`getTraitFactory()` Gets the current implementation's `TraitFactory`.
`static boolean`	`hasImplementation()`
`static void`	`registerEvents(org.bukkit.event.Listener listener)` A helper method for registering events using the current implementation's `Plugin`.
`static void`	`removeNamedNPCRegistry(String name)` Removes any previously created `NPCRegistry` stored under the given name.
`static void`	`setImplementation(CitizensPlugin implementation)` Sets the current Citizens implementation.
`static void`	`shutdown()` Shuts down any resources currently being held.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createAnonymousNPCRegistry
```
public static NPCRegistry createAnonymousNPCRegistry(NPCDataStore store)
```
    Creates a new anonymous NPCRegistry with its own set of NPCs. This is not stored by the Citizens plugin.
    
    Parameters:
    
    store - The NPCDataStore to use with the registry
    
    Returns:
    
    A new anonymous NPCRegistry that is not accessible via getNamedNPCRegistry(String)
    
    Since:
    
    2.0.8
  - createCitizensBackedNPCRegistry
```
public static NPCRegistry createCitizensBackedNPCRegistry(NPCDataStore store)
```
    Creates a new anonymous NPCRegistry that is "Citizens-backed" i.e. will reload and unload at the same time that Citizens reloads and unloads.
    
    Parameters:
    
    store - The NPCDataStore to use with the registry
  - createNamedNPCRegistry
```
public static NPCRegistry createNamedNPCRegistry(String name,
                                                 NPCDataStore store)
```
    Creates a new NPCRegistry with its own set of NPCs. This is stored in memory with the Citizens plugin, and can be accessed via getNamedNPCRegistry(String).
    
    Parameters:
    
    name - The plugin name
    
    store - The NPCDataStore to use with the registry
    
    Returns:
    
    A new NPCRegistry, that can also be retrieved via getNamedNPCRegistry(String)
    
    Since:
    
    2.0.8
  - getDataFolder
```
public static File getDataFolder()
```
    Returns:
    
    The data folder of the current implementation
  - getDefaultNPCSelector
```
public static NPCSelector getDefaultNPCSelector()
```
    Returns:
    
    The default NPC selector
  - getNamedNPCRegistry
```
public static NPCRegistry getNamedNPCRegistry(String name)
```
    Retrieves the NPCRegistry previously created via createNamedNPCRegistry(String, NPCDataStore) with the given name, or null if not found.
    
    Parameters:
    
    name - The registry name
    
    Returns:
    
    A NPCRegistry previously created via createNamedNPCRegistry(String, NPCDataStore), or null if not found
    
    Since:
    
    2.0.8
  - getNPCRegistries
```
public static Iterable<NPCRegistry> getNPCRegistries()
```
  - getNPCRegistry
```
public static NPCRegistry getNPCRegistry()
```
    Gets the current implementation's default NPCRegistry.
    
    Returns:
    
    The NPC registry
  - getPlugin
```
public static org.bukkit.plugin.Plugin getPlugin()
```
    Returns:
    
    The current Plugin providing an implementation
  - getScriptCompiler
```
public static ScriptCompiler getScriptCompiler()
```
    Returns:
    
    The current ScriptCompiler
  - getScriptFolder
```
public static File getScriptFolder()
```
    Returns:
    
    The folder used for storing scripts
  - getSkullMetaProvider
```
public static SkullMetaProvider getSkullMetaProvider()
```
  - getSpeechFactory
```
public static SpeechFactory getSpeechFactory()
```
    Gets the current implementation's SpeechFactory.
    
    Returns:
    
    Citizens speech factory
    
    See Also:
    
    CitizensPlugin
  - getTraitFactory
```
public static TraitFactory getTraitFactory()
```
    Gets the current implementation's TraitFactory.
    
    Returns:
    
    Citizens trait factory
    
    See Also:
    
    CitizensPlugin
  - hasImplementation
```
public static boolean hasImplementation()
```
    Returns:
    
    Whether a Citizens implementation is currently present
  - registerEvents
```
public static void registerEvents(org.bukkit.event.Listener listener)
```
    A helper method for registering events using the current implementation's Plugin.
    
    Parameters:
    
    listener - The listener to register events for
    
    See Also:
    
    getPlugin()
  - removeNamedNPCRegistry
```
public static void removeNamedNPCRegistry(String name)
```
    Removes any previously created NPCRegistry stored under the given name.
    
    Parameters:
    
    name - The name previously given to createNamedNPCRegistry(String, NPCDataStore)
    
    Since:
    
    2.0.8
  - setImplementation
```
public static void setImplementation(CitizensPlugin implementation)
```
    Sets the current Citizens implementation.
    
    Parameters:
    
    implementation - The new implementation
  - shutdown
```
public static void shutdown()
```
    Shuts down any resources currently being held.

Class CitizensAPI

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createAnonymousNPCRegistry

createCitizensBackedNPCRegistry

createNamedNPCRegistry

getDataFolder

getDefaultNPCSelector

getNamedNPCRegistry

getNPCRegistries

getNPCRegistry

getPlugin

getScriptCompiler

getScriptFolder

getSkullMetaProvider

getSpeechFactory

getTraitFactory

hasImplementation

registerEvents

removeNamedNPCRegistry

setImplementation

shutdown