Package net.citizensnpcs.npc

Class CitizensNPCRegistry

java.lang.Object

net.citizensnpcs.npc.CitizensNPCRegistry

All Implemented Interfaces:

Iterable<NPC>, NPCRegistry

public class CitizensNPCRegistry
extends Object
implements NPCRegistry

Constructor Summary

Constructors

Constructor	Description
CitizensNPCRegistry(NPCDataStore store)
CitizensNPCRegistry(NPCDataStore store, String registryName)

Method Summary

Modifier and Type	Method	Description
NPC	createNPC(EntityType type, String name)	Creates an despawned NPC.
NPC	createNPC(EntityType type, UUID uuid, int id, String name)	Creates an NPC with the given id.
void	deregister(NPC npc)	Deregisters the NPC and removes all data about it from the data store.
void	deregisterAll()	Deregisters all NPCs from this registry.
void	despawnNPCs(DespawnReason reason)	Despawn all NPCs within the registry.
NPC	getById(int id)	Gets the NPC with the given ID if it exists.
NPC	getByUniqueId(UUID uuid)	Gets the NPC with the given unique ID if it exists.
NPC	getByUniqueIdGlobal(UUID uuid)	Gets the NPC with the given unique ID if it exists, otherwise null.
String	getName()	Gets the name of the registry.
NPC	getNPC(Entity entity)	Tries to convert the given Entity to a spawned NPC.
boolean	isNPC(Entity entity)	Checks whether the given Entity is convertable to an NPC.
Iterator<NPC>	iterator()
void	saveToStore()	Saves the NPCs to the internal NPCDataStore
Iterable<NPC>	sorted()	Returns a sorted view of this registry, sorted by NPC id.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CitizensNPCRegistry

public CitizensNPCRegistry(NPCDataStore store)

CitizensNPCRegistry

public CitizensNPCRegistry(NPCDataStore store,
 String registryName)

Method Details

createNPC

public NPC createNPC(EntityType type,
 String name)

Description copied from interface: NPCRegistry

Creates an despawned NPC.

Specified by:

createNPC in interface NPCRegistry

Parameters:

type - EntityType to assign to the NPC

name - Name to give the NPC

Returns:

Created NPC

createNPC

public NPC createNPC(EntityType type,
 UUID uuid,
 int id,
 String name)

Description copied from interface: NPCRegistry

Creates an NPC with the given id. WARNING: may overwrite any existing NPC in the registry with the same ID.

Specified by:

createNPC in interface NPCRegistry

Parameters:

type - The EntityType of the NPC.

id - The NPC ID

name - The NPC name

Returns:

The created NPC

deregister

public void deregister(NPC npc)

Description copied from interface: NPCRegistry

Deregisters the NPC and removes all data about it from the data store.

Specified by:

deregister in interface NPCRegistry

Parameters:

npc - The NPC to deregister

deregisterAll

public void deregisterAll()

Description copied from interface: NPCRegistry

Deregisters all NPCs from this registry. NPCRegistry.deregister(NPC)

Specified by:

deregisterAll in interface NPCRegistry

despawnNPCs

public void despawnNPCs(DespawnReason reason)

Description copied from interface: NPCRegistry

Despawn all NPCs within the registry.

Specified by:

despawnNPCs in interface NPCRegistry

getById

public NPC getById(int id)

Description copied from interface: NPCRegistry

Gets the NPC with the given ID if it exists.

Specified by:

getById in interface NPCRegistry

Parameters:

id - ID of the NPC

Returns:

NPC with the given ID (may or may not be spawned)

getByUniqueId

public NPC getByUniqueId(UUID uuid)

Description copied from interface: NPCRegistry

Gets the NPC with the given unique ID if it exists.

Specified by:

getByUniqueId in interface NPCRegistry

Parameters:

uuid - UUID of the NPC

Returns:

NPC with the given ID (may or may not be spawned)

getByUniqueIdGlobal

public NPC getByUniqueIdGlobal(UUID uuid)

Description copied from interface: NPCRegistry

Gets the NPC with the given unique ID if it exists, otherwise null.

Specified by:

getByUniqueIdGlobal in interface NPCRegistry

Parameters:

uuid - ID of the NPC

Returns:

NPC with the given UUID

getName

public String getName()

Description copied from interface: NPCRegistry

Gets the name of the registry. Not null.

Specified by:

getName in interface NPCRegistry

getNPC

public NPC getNPC(Entity entity)

Description copied from interface: NPCRegistry

Tries to convert the given Entity to a spawned NPC.

Specified by:

getNPC in interface NPCRegistry

Parameters:

entity - Entity to get the NPC from

Returns:

NPC from the given entity or null if not found.

isNPC

public boolean isNPC(Entity entity)

Description copied from interface: NPCRegistry

Checks whether the given Entity is convertable to an NPC.

Specified by:

isNPC in interface NPCRegistry

Parameters:

entity - Entity to check

Returns:

Whether the given entity is an NPC

iterator

public Iterator<NPC> iterator()

Specified by:

iterator in interface Iterable<NPC>

saveToStore

public void saveToStore()

Description copied from interface: NPCRegistry

Saves the NPCs to the internal NPCDataStore

Specified by:

saveToStore in interface NPCRegistry

sorted

public Iterable<NPC> sorted()

Description copied from interface: NPCRegistry

Returns a sorted view of this registry, sorted by NPC id.

Specified by:

sorted in interface NPCRegistry

Returns:

A sorted view of the registry