eu.wauz.wauzcore.mobs.citizens

Class WauzCitizenSpawner

java.lang.Object

eu.wauz.wauzcore.mobs.citizens.WauzCitizenSpawner

public class WauzCitizenSpawner
extends java.lang.Object

A class to handle spawning / despawning, aswell as rendering of citizen npcs.

Author:

Wauzmons

See Also:

WauzCitizen

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<WauzCitizen,net.jitse.npclib.api.NPC>	citizenNpcMap A map of npcs, indexed by citizen.
private static net.jitse.npclib.NPCLib	NPC_LIB Access to the NPCLib API.
private static java.util.Map<net.jitse.npclib.api.NPC,WauzCitizen>	npcCitizenMap A map of citizens, indexed by npc.
private static int	RENDER_RADIUS The radius in chunks, in which citizens should be rendered.

Constructor Summary

Constructors

Constructor and Description
WauzCitizenSpawner()

Method Summary

Modifier and Type	Method and Description
static void	createNpc(WauzCitizen citizen) Creates a citizen npc using the npc lib.
static void	destroyNpc(net.jitse.npclib.api.NPC npc) Destroys the given npc, i.e. remove it from the registry.
static WauzCitizen	getCitizen(net.jitse.npclib.api.NPC npc) Retrieves a registered citizen from the npc map.
static net.jitse.npclib.NPCLib	getNpclib()
static void	hideNpc(net.jitse.npclib.api.NPC npc, org.bukkit.entity.Player player) Hides the npc from the given player.
static void	registerNpc(WauzCitizen citizen, net.jitse.npclib.api.NPC npc) Registers the given citizen npc, to retrieve it when needed.
static void	showNpc(net.jitse.npclib.api.NPC npc, org.bukkit.entity.Player player) Show the npc to the given player.
static void	showNpcsNearPlayer(org.bukkit.entity.Player player) Shows all npcs near the given player to them.
static void	unregisterNpc(WauzCitizen citizen) Unregisters the given citizen and destroy its npc object.

Methods inherited from class java.lang.Object

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

Field Detail

NPC_LIB

private static final net.jitse.npclib.NPCLib NPC_LIB

Access to the NPCLib API.

RENDER_RADIUS

private static final int RENDER_RADIUS

The radius in chunks, in which citizens should be rendered.

See Also:

Constant Field Values

citizenNpcMap

private static java.util.Map<WauzCitizen,net.jitse.npclib.api.NPC> citizenNpcMap

A map of npcs, indexed by citizen.

npcCitizenMap

private static java.util.Map<net.jitse.npclib.api.NPC,WauzCitizen> npcCitizenMap

A map of citizens, indexed by npc.

Constructor Detail

WauzCitizenSpawner

public WauzCitizenSpawner()

Method Detail

createNpc

public static void createNpc(WauzCitizen citizen)

Creates a citizen npc using the npc lib. The npc won't be visible, till it is shown to a player.

Parameters:

citizen - The citizen, that should be created.

See Also:

registerNpc(WauzCitizen, NPC)

registerNpc

public static void registerNpc(WauzCitizen citizen,
                               net.jitse.npclib.api.NPC npc)

Registers the given citizen npc, to retrieve it when needed.

Parameters:

citizen - The citizen to register.

npc - The npc object bound to the citzen.

See Also:

getCitizen(NPC)

unregisterNpc

public static void unregisterNpc(WauzCitizen citizen)

Unregisters the given citizen and destroy its npc object.

Parameters:

citizen - The citizen to unregister.

getCitizen

public static WauzCitizen getCitizen(net.jitse.npclib.api.NPC npc)

Retrieves a registered citizen from the npc map.

Parameters:

npc - The npc object bound to the citzen.

Returns:

The requested citizen.

See Also:

registerNpc(WauzCitizen, NPC)

showNpcsNearPlayer

public static void showNpcsNearPlayer(org.bukkit.entity.Player player)

Shows all npcs near the given player to them.

Parameters:

player - The player to show the npcs to.

destroyNpc

public static void destroyNpc(net.jitse.npclib.api.NPC npc)

Destroys the given npc, i.e. remove it from the registry.

Parameters:

npc - The npc to destroy.

showNpc

public static void showNpc(net.jitse.npclib.api.NPC npc,
                           org.bukkit.entity.Player player)

Show the npc to the given player.

Parameters:

npc - The npc to show.

player - The player to show the npc to.

hideNpc

public static void hideNpc(net.jitse.npclib.api.NPC npc,
                           org.bukkit.entity.Player player)

Hides the npc from the given player.

Parameters:

npc - The npc to hide.

player - The player to hide the npc from.

getNpclib

public static net.jitse.npclib.NPCLib getNpclib()

Returns:

Access to the NPCLib API.