eu.wauz.wauzcore.mobs.citizens

Class WauzCitizen

java.lang.Object

eu.wauz.wauzcore.mobs.citizens.WauzCitizen

public class WauzCitizen
extends java.lang.Object

A citizen, generated from a citizen config file.

Author:

Wauzmons

See Also:

WauzCitizenSpawner

Field Summary

Fields

Modifier and Type	Field and Description
private org.bukkit.inventory.ItemStack	bootsItemStack The equipped boots item.
private boolean	burning If the citizen is burning.
private org.bukkit.inventory.ItemStack	chestplateItemStack The equipped chestplate item.
private static ChunkKeyMap<java.util.List<WauzCitizen>>	chunkCitizensMap A map with lists of citizens, indexed by chunk keys.
private static int	citizenCount The number of all registred citizens.
private java.lang.String	citizenName The canonical name of the citizen.
private java.lang.String	displayName The name of the citizen, as shown in chat.
private org.bukkit.inventory.ItemStack	helmetItemStack The equipped helmet item.
private WauzCitizenInteractions	interactions The interaction options of the citizen.
private boolean	invisible If the citizen is invisible.
private long	lastMessageTime The time of the last random message sent by the citizen.
private org.bukkit.inventory.ItemStack	leggingsItemStack The equipped leggings item.
private org.bukkit.Location	location The location where the npc should be spawned.
private org.bukkit.inventory.ItemStack	mainhandItemStack The equipped mainhand item.
private java.util.List<java.lang.String>	messages The random messages of the citizen.
private java.util.List<java.lang.String>	nameLines The lines of text above the citizen's head.
private org.bukkit.inventory.ItemStack	offhandItemStack The equipped offhand item.
private int	skinId The identifier of a skin from mineskin.org
private static java.util.Map<java.lang.String,WauzCitizen>	unassignedCitizenMap A map of citizens that aren't assigned to a world, indexed by name.

Constructor Summary

Constructors

Constructor and Description
WauzCitizen(java.lang.String citizenName) Constructs a citizen, based on the citizen file name in the /WauzCore/CitizenData folder.
WauzCitizen(WauzCitizen citizen) Constructs a citizen, that is an exact copy of another citizen.

Method Summary

Modifier and Type	Method and Description
static void	addToChunkMap(WauzCitizen citizen, org.bukkit.Chunk chunk) Adds a citizen to the chunk map, so they can spawn in that chunk.
org.bukkit.inventory.ItemStack	getBootsItemStack()
org.bukkit.inventory.ItemStack	getChestplateItemStack()
java.lang.String	getCitizenName()
static java.util.List<WauzCitizen>	getCitizensNearPlayer(org.bukkit.entity.Player player, int radius) Finds all the citzens, near the given player.
java.lang.String	getDisplayName()
org.bukkit.inventory.ItemStack	getHelmetItemStack()
WauzCitizenInteractions	getInteractions()
org.bukkit.inventory.ItemStack	getLeggingsItemStack()
org.bukkit.Location	getLocation()
org.bukkit.inventory.ItemStack	getMainhandItemStack()
(package private) java.util.List<java.lang.String>	getMessages()
java.util.List<java.lang.String>	getNameLines()
org.bukkit.inventory.ItemStack	getOffhandItemStack()
java.lang.String	getRandomMessage()
int	getSkinId()
static WauzCitizen	getUnassignedCitizen(java.lang.String citizenName) Gets a citizen that isn't assigned to a world, with the given name.
static void	init() Initializes all citizen configs and fills the internal citizen maps.
boolean	isBurning()
boolean	isInvisible()
static void	removeFromChunkMap(WauzCitizen citizen, org.bukkit.Chunk chunk) Removes a citizen from the chunk map, so they can no longer spawn in that chunk.
void	setLocation(org.bukkit.Location location)

Methods inherited from class java.lang.Object

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

Field Detail

chunkCitizensMap

private static ChunkKeyMap<java.util.List<WauzCitizen>> chunkCitizensMap

A map with lists of citizens, indexed by chunk keys.

unassignedCitizenMap

private static java.util.Map<java.lang.String,WauzCitizen> unassignedCitizenMap

A map of citizens that aren't assigned to a world, indexed by name.

citizenCount

private static int citizenCount

The number of all registred citizens.

citizenName

private java.lang.String citizenName

The canonical name of the citizen.

displayName

private java.lang.String displayName

The name of the citizen, as shown in chat.

nameLines

private java.util.List<java.lang.String> nameLines

The lines of text above the citizen's head.

location

private org.bukkit.Location location

The location where the npc should be spawned.

skinId

private int skinId

The identifier of a skin from mineskin.org

invisible

private boolean invisible

If the citizen is invisible.

burning

private boolean burning

If the citizen is burning.

lastMessageTime

private long lastMessageTime

The time of the last random message sent by the citizen.

messages

private java.util.List<java.lang.String> messages

The random messages of the citizen.

mainhandItemStack

private org.bukkit.inventory.ItemStack mainhandItemStack

The equipped mainhand item.

offhandItemStack

private org.bukkit.inventory.ItemStack offhandItemStack

The equipped offhand item.

helmetItemStack

private org.bukkit.inventory.ItemStack helmetItemStack

The equipped helmet item.

chestplateItemStack

private org.bukkit.inventory.ItemStack chestplateItemStack

The equipped chestplate item.

leggingsItemStack

private org.bukkit.inventory.ItemStack leggingsItemStack

The equipped leggings item.

bootsItemStack

private org.bukkit.inventory.ItemStack bootsItemStack

The equipped boots item.

interactions

private WauzCitizenInteractions interactions

The interaction options of the citizen.

Constructor Detail

WauzCitizen

public WauzCitizen(java.lang.String citizenName)

Constructs a citizen, based on the citizen file name in the /WauzCore/CitizenData folder.

Parameters:

citizenName - The canonical name of the citizen.

WauzCitizen

public WauzCitizen(WauzCitizen citizen)

Constructs a citizen, that is an exact copy of another citizen.

Parameters:

citizen - The citizen to clone.

Method Detail

init

public static void init()

Initializes all citizen configs and fills the internal citizen maps.

See Also:

CitizenConfigurator.getCitizenNameList(), addToChunkMap(WauzCitizen, Chunk)

addToChunkMap

public static void addToChunkMap(WauzCitizen citizen,
                                 org.bukkit.Chunk chunk)

Adds a citizen to the chunk map, so they can spawn in that chunk.

Parameters:

citizen - The citizen to add.

chunk - The chunk of the citizen.

See Also:

WauzCitizenSpawner.createNpc(WauzCitizen)

removeFromChunkMap

public static void removeFromChunkMap(WauzCitizen citizen,
                                      org.bukkit.Chunk chunk)

Removes a citizen from the chunk map, so they can no longer spawn in that chunk.

Parameters:

citizen - The citizen to remove.

chunk - The chunk of the citizen.

See Also:

WauzCitizenSpawner.unregisterNpc(WauzCitizen)

getUnassignedCitizen

public static WauzCitizen getUnassignedCitizen(java.lang.String citizenName)

Gets a citizen that isn't assigned to a world, with the given name.

Parameters:

citizenName - The name of the citizen.

Returns:

The found citizen or null.

getCitizensNearPlayer

public static java.util.List<WauzCitizen> getCitizensNearPlayer(org.bukkit.entity.Player player,
                                                                int radius)

Finds all the citzens, near the given player.

Parameters:

player - The player to get the citizens for.

radius - The radius in chunks, in which citizens should be found.

Returns:

A list of all citizens, the player should see.

getCitizenName

public java.lang.String getCitizenName()

Returns:

The canonical name of the citizen.

getDisplayName

public java.lang.String getDisplayName()

Returns:

The name of the citizen, as shown in chat.

getNameLines

public java.util.List<java.lang.String> getNameLines()

Returns:

The lines of text above the citizen's head.

getLocation

public org.bukkit.Location getLocation()

Returns:

The location where the npc should be spawned.

setLocation

public void setLocation(org.bukkit.Location location)

Parameters:

location - The new location where the npc should be spawned.

getSkinId

public int getSkinId()

Returns:

The identifier of a skin from mineskin.org

isInvisible

public boolean isInvisible()

Returns:

If the citizen is invisible.

isBurning

public boolean isBurning()

Returns:

If the citizen is burning.

getMessages

final java.util.List<java.lang.String> getMessages()

Returns:

The random messages of the citizen.

getRandomMessage

public java.lang.String getRandomMessage()

Returns:

A random messages of the citizen or null, if none defined or cooldown is active.

getMainhandItemStack

public org.bukkit.inventory.ItemStack getMainhandItemStack()

Returns:

The equipped mainhand item.

getOffhandItemStack

public org.bukkit.inventory.ItemStack getOffhandItemStack()

Returns:

The equipped offhand item.

getHelmetItemStack

public org.bukkit.inventory.ItemStack getHelmetItemStack()

Returns:

The equipped helmet item.

getChestplateItemStack

public org.bukkit.inventory.ItemStack getChestplateItemStack()

Returns:

The equipped chestplate item.

getLeggingsItemStack

public org.bukkit.inventory.ItemStack getLeggingsItemStack()

Returns:

The equipped leggings item.

getBootsItemStack

public org.bukkit.inventory.ItemStack getBootsItemStack()

Returns:

The equipped boots item.

getInteractions

public WauzCitizenInteractions getInteractions()

Returns:

The interaction options of the citizen.