net.citizensnpcs.api.trait

Class Trait

java.lang.Object

net.citizensnpcs.api.trait.Trait

All Implemented Interfaces:

Runnable, Listener

Direct Known Subclasses:

Age, Anchors, ArmorStandTrait, Controllable, CurrentLocation, Equipment, FollowTrait, GameModeTrait, Gravity, HorseModifiers, Inventory, LookClose, MobType, MountTrait, OcelotModifiers, Owner, Poses, Powered, RabbitType, Saddle, ScoreboardTrait, ScriptTrait, SheepTrait, SkinLayers, SlimeSize, Spawned, Speech, Text, VillagerProfession, Waypoints, WitherTrait, WolfModifiers, WoolColor

public abstract class Trait
extends Object
implements Listener, Runnable

Represents a Trait linked to an NPC that can be loaded and saved. This will be kept persisted inside a NPC across server restarts. Traits must be registered in Citizens' TraitFactory. All traits should have a default constructor with no arguments for persistence purposes.

Field Summary

Fields

Modifier and Type	Field and Description
protected NPC	npc

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Trait(String name)

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the name of this trait.
NPC	getNPC()
boolean	isRunImplemented()
void	linkToNPC(NPC npc)
void	load(DataKey key) Loads a trait.
void	onAttach() Called when the trait has been attached to an NPC.
void	onCopy() Called when the trait has been newly copied to an NPC.
void	onDespawn() Called just before the attached NPC is despawned.
void	onRemove() Called when a trait is removed from the attached NPC.
void	onSpawn() Called when an NPC is spawned.
void	run() Called every tick if overridden.
void	save(DataKey key) Saves a trait.

Methods inherited from class java.lang.Object

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

Field Detail

npc

protected NPC npc

Constructor Detail

Trait

protected Trait(String name)

Method Detail

getName

public final String getName()

Gets the name of this trait.

Returns:

Name of this trait

getNPC

public final NPC getNPC()

Returns:

The NPC this trait is attached to. May be null.

isRunImplemented

public boolean isRunImplemented()

linkToNPC

public void linkToNPC(NPC npc)

load

public void load(DataKey key)
          throws NPCLoadException

Loads a trait.

Parameters:

key - DataKey to load from

Throws:

NPCLoadException - Thrown if this trait failed to load properly

onAttach

public void onAttach()

Called when the trait has been attached to an NPC. npc will be null until this is called.

onCopy

public void onCopy()

Called when the trait has been newly copied to an NPC.

onDespawn

public void onDespawn()

Called just before the attached NPC is despawned. NPC.getEntity() will be non-null.

onRemove

public void onRemove()

Called when a trait is removed from the attached NPC.

onSpawn

public void onSpawn()

Called when an NPC is spawned. NPC.getEntity() will return null until this is called. This is also called onAttach when the NPC is already spawned.

run

public void run()

Called every tick if overridden.

Specified by:

run in interface Runnable

save

public void save(DataKey key)

Saves a trait.

Parameters:

key - DataKey to save to