net.citizensnpcs.npc

Class CitizensNPC

java.lang.Object

net.citizensnpcs.api.npc.AbstractNPC

net.citizensnpcs.npc.CitizensNPC

All Implemented Interfaces:

Cloneable, Agent, NPC

public class CitizensNPC
extends AbstractNPC

Field Summary

Fields inherited from class net.citizensnpcs.api.npc.AbstractNPC

traits

Fields inherited from interface net.citizensnpcs.api.npc.NPC

ALWAYS_USE_NAME_HOLOGRAM_METADATA, AMBIENT_SOUND_METADATA, COLLIDABLE_METADATA, DAMAGE_OTHERS_METADATA, DEATH_SOUND_METADATA, DEFAULT_PROTECTED_METADATA, DISABLE_DEFAULT_STUCK_ACTION_METADATA, DROPS_ITEMS_METADATA, FLYABLE_METADATA, GLOWING_COLOR_METADATA, GLOWING_METADATA, HURT_SOUND_METADATA, ITEM_DATA_METADATA, ITEM_ID_METADATA, KEEP_CHUNK_LOADED_METADATA, LEASH_PROTECTED_METADATA, MINECART_ITEM_DATA_METADATA, MINECART_ITEM_METADATA, MINECART_OFFSET_METADATA, NAMEPLATE_VISIBLE_METADATA, PATHFINDER_OPEN_DOORS_METADATA, PLAYER_SKIN_TEXTURE_PROPERTIES_METADATA, PLAYER_SKIN_TEXTURE_PROPERTIES_SIGN_METADATA, PLAYER_SKIN_USE_LATEST, PLAYER_SKIN_UUID_METADATA, RESPAWN_DELAY_METADATA, SCOREBOARD_FAKE_TEAM_NAME_METADATA, SHOULD_SAVE_METADATA, SILENT_METADATA, SWIMMING_METADATA, TARGETABLE_METADATA, USE_MINECRAFT_AI_METADATA

Constructor Summary

Constructors

Constructor and Description
CitizensNPC(UUID uuid, int id, String name, EntityController entityController, NPCRegistry registry)

Method Summary

Modifier and Type	Method and Description
boolean	despawn(DespawnReason reason) Despawns this NPC.
void	destroy() Permanently removes this NPC and all data about it from the registry it's attached to.
void	faceLocation(org.bukkit.Location location) Faces a given Location if the NPC is spawned.
BlockBreaker	getBlockBreaker(org.bukkit.block.Block targetBlock, BlockBreaker.BlockBreakerConfiguration config)
org.bukkit.entity.Entity	getEntity() Gets the Bukkit entity associated with this NPC.
Navigator	getNavigator()
org.bukkit.Location	getStoredLocation() If the NPC is not spawned, then this method will return the last known location, or null if it has never been spawned.
boolean	isFlyable() Returns whether this NPC is flyable or not.
boolean	isSpawned() Gets whether this NPC is currently spawned.
void	load(DataKey root) Loads the NPC from the given DataKey.
boolean	requiresNameHologram()
void	save(DataKey root) Saves the NPC to the given DataKey.
void	setBukkitEntityType(org.bukkit.entity.EntityType type) Sets the EntityType of this NPC.
void	setEntityController(EntityController newController)
void	setFlyable(boolean flyable) Sets whether this NPC is flyable or not.
void	setName(String name) Sets the name of this NPC.
boolean	spawn(org.bukkit.Location at) Attempts to spawn this NPC.
boolean	spawn(org.bukkit.Location at, SpawnReason reason) Attempts to spawn this NPC.
void	teleport(org.bukkit.Location location, org.bukkit.event.player.PlayerTeleportEvent.TeleportCause reason) An alternative to npc.getEntity().getLocation() that teleports passengers as well.
void	update()

Methods inherited from class net.citizensnpcs.api.npc.AbstractNPC

addTrait, addTrait, clone, copy, data, despawn, destroy, equals, getDefaultGoalController, getDefaultSpeechController, getEntityType, getFullName, getId, getName, getOrAddTrait, getOwningRegistry, getTrait, getTraitFor, getTraitNullable, getTraits, getUniqueId, hashCode, hasTrait, isProtected, removeTrait, setAlwaysUseNameHologram, setProtected, setUseMinecraftAI, unloadEvents, useMinecraftAI

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CitizensNPC

public CitizensNPC(UUID uuid,
                   int id,
                   String name,
                   EntityController entityController,
                   NPCRegistry registry)

Method Detail

despawn

public boolean despawn(DespawnReason reason)

Description copied from interface: NPC

Despawns this NPC.

Parameters:

reason - The reason for despawning, for use in NPCDespawnEvent

Returns:

Whether this NPC was able to despawn

destroy

public void destroy()

Description copied from interface: NPC

Permanently removes this NPC and all data about it from the registry it's attached to.

Specified by:

destroy in interface NPC

Overrides:

destroy in class AbstractNPC

faceLocation

public void faceLocation(org.bukkit.Location location)

Description copied from interface: NPC

Faces a given Location if the NPC is spawned.

getBlockBreaker

public BlockBreaker getBlockBreaker(org.bukkit.block.Block targetBlock,
                                    BlockBreaker.BlockBreakerConfiguration config)

getEntity

public org.bukkit.entity.Entity getEntity()

Description copied from interface: NPC

Gets the Bukkit entity associated with this NPC. This may be null if NPC.isSpawned() is false.

Returns:

Entity associated with this NPC

getNavigator

public Navigator getNavigator()

Returns:

The Navigator of this NPC.

getStoredLocation

public org.bukkit.Location getStoredLocation()

Description copied from interface: NPC

If the NPC is not spawned, then this method will return the last known location, or null if it has never been spawned. Otherwise, it is equivalent to calling npc.getBukkitEntity().getLocation().

Returns:

The stored location, or null if none was found.

isFlyable

public boolean isFlyable()

Description copied from interface: NPC

Returns whether this NPC is flyable or not.

Specified by:

isFlyable in interface NPC

Overrides:

isFlyable in class AbstractNPC

Returns:

Whether this NPC is flyable

isSpawned

public boolean isSpawned()

Description copied from interface: NPC

Gets whether this NPC is currently spawned.

Returns:

Whether this NPC is spawned

load

public void load(DataKey root)

Description copied from interface: NPC

Loads the NPC from the given DataKey. This reloads all traits, respawns the NPC and sets it up for execution. Should not be called often.

Specified by:

load in interface NPC

Overrides:

load in class AbstractNPC

Parameters:

root - The root data key

requiresNameHologram

public boolean requiresNameHologram()

Specified by:

requiresNameHologram in interface NPC

Overrides:

requiresNameHologram in class AbstractNPC

save

public void save(DataKey root)

Description copied from interface: NPC

Saves the NPC to the given DataKey. This includes all metadata, traits, and spawn information that will allow it to respawn at a later time via NPC.load(DataKey).

Specified by:

save in interface NPC

Overrides:

save in class AbstractNPC

Parameters:

root - The root data key

setBukkitEntityType

public void setBukkitEntityType(org.bukkit.entity.EntityType type)

Description copied from interface: NPC

Sets the EntityType of this NPC. Currently only accepts living entity types, with scope for additional types in the future. The NPC will respawned if currently spawned, or will remain despawned otherwise.

Parameters:

type - The new mob type

setEntityController

public void setEntityController(EntityController newController)

setFlyable

public void setFlyable(boolean flyable)

Description copied from interface: NPC

Sets whether this NPC is flyable or not. Note that this is intended for normally ground-based entities only - it will generally have no effect on mob types that were originally flyable.

Specified by:

setFlyable in interface NPC

Overrides:

setFlyable in class AbstractNPC

setName

public void setName(String name)

Description copied from interface: NPC

Sets the name of this NPC.

Specified by:

setName in interface NPC

Overrides:

setName in class AbstractNPC

Parameters:

name - Name to give this NPC

spawn

public boolean spawn(org.bukkit.Location at)

Description copied from interface: NPC

Attempts to spawn this NPC.

Parameters:

at - Location to spawn this NPC

Returns:

Whether this NPC was able to spawn at the location

spawn

public boolean spawn(org.bukkit.Location at,
                     SpawnReason reason)

Description copied from interface: NPC

Attempts to spawn this NPC.

Parameters:

at - Location to spawn this NPC

reason - Reason for spawning

Returns:

Whether this NPC was able to spawn at the location

teleport

public void teleport(org.bukkit.Location location,
                     org.bukkit.event.player.PlayerTeleportEvent.TeleportCause reason)

Description copied from interface: NPC

An alternative to npc.getEntity().getLocation() that teleports passengers as well.

Specified by:

teleport in interface NPC

Overrides:

teleport in class AbstractNPC

Parameters:

location - The destination location

reason - The cause for teleporting

update

public void update()

Overrides:

update in class AbstractNPC