API

Citizens has an extensive API that can be used for making your plugins work with NPCs or even for adding a brand new character that can be attached to an NPC. Make sure you always are using an up-to-date build of the CitizensAPI to ensure that your plugin works with the latest release of Citizens.

Javadocs can be found at https://jd.citizensnpcs.co

IF YOU HAVE TROUBLE USING THE API please speak to us on GitHub at https://github.com/CitizensDev/Citizens2/issues OR on Discord at https://discord.gg/Q6pZGSR

Current Release Download: Jenkins Developmental Builds: Jenkins Documentation: JavaDocs Source: Github

Linking Properly In Java

Citizens, like most Java projects, is built using Maven. Your plugin that links to Citizens should be using Maven as well.

In your pom.xml (Maven project) file, you can use this repository:

    <repository>
        <id>everything</id>
        <url>https://repo.citizensnpcs.co/</url>
    </repository>

and this dependency:

    <dependency>
        <groupId>net.citizensnpcs</groupId>
        <artifactId>citizens-main</artifactId>
        <version>VERSION</version>
        <type>jar</type>
        <scope>provided</scope>
    </dependency>

And replace VERSION with the current version of Citizens (check the filenames at http://ci.citizensnpcs.co/job/Citizens2/ for current version ID), formatted like 2.0.29-SNAPSHOT (but with the version numbers changed to the relevant version).

Note that for most purposes, it's best to link citizens-main rather than the API project, as many useful classes and utilities are not in the API. The main Citizens project includes the API and adds more options.

Hooking Into Citizens

Hooking into Citizens is as simple as creating a basic plugin and adding the line depend: [Citizens] into your plugin.yml. From here, a common basic entry point is the CitizensAPI class. This gives you access to the NPCRegistry for NPC lookup, as well as the TraitFactory which allows trait registration. If Citizens is not loaded, all CitizensAPI.* methods will return null.

Creating an NPC

The simplest way to create an NPC is to use an NPCRegistry, which manages the storage and creation of NPCs. The default registry is given by CitizensAPI.getNPCRegistry(), and you can create new ones with different storage methods by calling other CitizensAPI methods. A Player NPC with name "fullwall" could then be created like this:

NPC npc = CitizensAPI.getNPCRegistry().createNPC(EntityType.PLAYER, "fullwall");

Checking if an entity is a Citizens NPC

Citizens NPCs will have the "NPC" metadata set to true. boolean isCitizensNPC = entity.hasMetadata("NPC"); This method doesn't even require a dependency on Citizens, as it works entirely through Bukkit!

Making an NPC Move

Want to make an NPC move to a location? npc.getNavigator().setTarget(yourLocation);

Creating a Trait

Traits are persistent, attachable objects that are linked to an NPC and provide specific functionality. This can be anything from a full-blown dynamic villager AI to a simple talking trait.

To register a trait, we use the TraitFactory class. This controls registration for your custom traits.

Code:

//This is your trait that will be applied to a npc using the /trait mytraitname command. Each NPC gets its own instance of this class. //the Trait class has a reference to the attached NPC class through the protected field 'npc' or getNPC(). //The Trait class also implements Listener so you can add EventHandlers directly to your trait. public class MyTrait extends Trait { public MyTrait() { super("mytraitname"); plugin = JavaPlugin.getPlugin(MyPlugin.class); } MyPlugin plugin = null; boolean SomeSetting = false; // see the 'Persistence API' section @Persist("mysettingname") boolean automaticallyPersistedSetting = false; // Here you should load up any values you have previously saved (optional). // This does NOT get called when applying the trait for the first time, only loading onto an existing npc at server start. // This is called AFTER onAttach so you can load defaults in onAttach and they will be overridden here. // This is called BEFORE onSpawn, npc.getEntity() will return null. public void load(DataKey key) { SomeSetting = key.getBoolean("SomeSetting", false); } // Save settings for this NPC (optional). These values will be persisted to the Citizens saves file public void save(DataKey key) { key.setBoolean("SomeSetting",SomeSetting); } // An example event handler. All traits will be registered automatically as Bukkit Listeners. @EventHandler public void click(net.citizensnpcs.api.event.NPCRightClickEvent event){ //Handle a click on a NPC. The event has a getNPC() method. //Be sure to check event.getNPC() == this.getNPC() so you only handle clicks on this NPC! } // Called every tick @Override public void run() { } //Run code when your trait is attached to a NPC. //This is called BEFORE onSpawn, so npc.getEntity() will return null //This would be a good place to load configurable defaults for new NPCs. @Override public void onAttach() { plugin.getServer().getLogger().info(npc.getName() + "has been assigned MyTrait!"); } // Run code when the NPC is despawned. This is called before the entity actually despawns so npc.getEntity() is still valid. @Override public void onDespawn() { } //Run code when the NPC is spawned. Note that npc.getEntity() will be null until this method is called. //This is called AFTER onAttach and AFTER Load when the server is started. @Override public void onSpawn() { } //run code when the NPC is removed. Use this to tear down any repeating tasks. @Override public void onRemove() { } } //This is your bukkit plugin class. Use it to hook your trait into Citizens and handle any commands. public class MyPlugin extends org.bukkit.plugin.java.JavaPlugin { public void onEnable() { //check if Citizens is present and enabled. if(getServer().getPluginManager().getPlugin("Citizens") == null || !getServer().getPluginManager().getPlugin("Citizens").isEnabled()) { getLogger().log(Level.SEVERE, "Citizens 2.0 not found or not enabled"); getServer().getPluginManager().disablePlugin(this); return; } //Register your trait with Citizens. net.citizensnpcs.api.CitizensAPI.getTraitFactory().registerTrait(net.citizensnpcs.api.trait.TraitInfo.create(MyTrait.class).withName("mytraitname")); } @Override public boolean onCommand(CommandSender sender, Command cmd, String cmdLabel, String[] inargs) { //handle commands for /myplugin } }

Dos and Don'ts

DO

• Check npc.isSpawned() before using npc.getEntity()
• Check npc.isSpawned() before using npc.getNavigator()
• Create a separate singleton Listener class if you expect there to be many instances of this trait running. This may help performance with frequently called events.
• Honor npc.data().get(NPC.DEFAULT_PROTECTED_METADATA) If this is true the NPC should be 'invulnerable' to normal damaging effects.
• use CitizensAPI.getNPCRegistry().isNPC() to check if an entity is a NPC. Real players and player-type NPCs will both return true for instanceof Player.

DON'T

• Attempt to access npc.getEntity() from within traits until onSpawn() has been called or npc.isSpawned() returns true.
• Change anything in npc.getNavigator.getDefaultParams() unless you're sure you want a global change. Use the localParams() instead after setting a navigation target.
• Assume a NPC is a player-type. Mob types have some important differences.

Default Traits

Citizens comes by default with a number of Traits that can be interacted with. You can see these Traits in the JavaDocs http://jd.citizensnpcs.co/net/citizensnpcs/api/trait/trait/package-frame.html and also in the Citizens2 GitHub https://github.com/CitizensDev/Citizens2/tree/master/main/src/main/java/net/citizensnpcs/trait.

For example, you might add a piece of armor to an NPC using

npc.getOrAddTrait(Equipment.class).set(EquipmentSlot.BOOTS, new ItemStack(Material.LEATHER_BOOTS, 1));

NPC Events

Citizens implements its own Listeners and will call new NPC-specific versions of many common events. This saves Trait developers the trouble of finding their npcs from the normal event entities. The event object these events provide are just like their Bukkit counterparts with the addition of the getNPC() method. Citizens currently provides the following:

• EntityTargetNPCEvent
• NPCChatEvent
• NPCClickEvent
• NPCCollisionEvent
• NPCCombustByBlockEvent
• NPCCombustByEntityEvent
• NPCCombustEvent
• NPCDamageByBlockEvent
• NPCDamageByEntityEvent
• NPCDamageEvent
• NPCDeathEvent
• NPCDespawnEvent
• NPCEvent
• NPCLeftClickEvent
• NPCPushEvent
• NPCRemoveEvent
• NPCRightClickEvent
• NPCSelectEvent
• NPCSpawnEvent
• PlayerCreateNPCEvent

See the [Javadocs] for details.

Using the AI API

The AI API of Citizens can be broken down into two parts - GoalController and Navigator.

A Goal is a repeatable, abstract unit of work that can be performed by an NPC. For example, moving to a different location or attacking an enemy until it dies. It can be registered with a GoalController with a priority (higher is more important). The highest priority goal which can be executed will be prioritised. NPC contains getDefaultGoalController() for this purpose.

The GoalSelector allows a great deal of flexibility within goal implementations. It allows firstly the dynamic selection of sub-goals and the concurrent execution of many sub-goals, and can stop execution at any time.

Modern plugins should use the Behavior interface which allows a behavior tree-based AI approach that is backwards compatible with Goals and GoalControllers. More info about Behavior is available here: https://jd.citizensnpcs.co/net/citizensnpcs/api/ai/tree/Behavior.html

Code:

public class MyBehavior extends BehaviorGoalAdapter { // enable direct GoalController compatibility private Object state; public void reset() { state = null; // this method can be called at any time if another goal is selected } public BehaviorStatus run() { if(!npcIsCool()) { return BehaviorStatus.FAILURE; } else if (npcIsAwesome()) { return BehaviorStatus.SUCCESS; } else if (npcNeedsCool()) { new AccumulateCoolBehavior().run(); // easily run other behavior inline return BehaviorStatus.RUNNING; } } public boolean shouldExecute() { if (npcIsCool()) { return true; } return false; } }

You can easily create trees of behaviors such as in the following example:

Code:

public void setupTree(NPC npc) { npc.getGoalController().addGoal(Sequence.createSequence(new MyBehavior(), new MyAccumulateBehavior(), new MyParallelBehavior())); // A more complicated example npc.getGoalController().addGoal(Sequence.createSequence( new IfElse(() -> npc.isCool(), TimerDecorator.tickLimiter(new MyLongRunningBehavior(), 100), new MyElseBehavior()), new MyParallelBehavior() )); // You can implement nested loops and other behavior sequences using the API provided in net.citizensnpcs.api.ai.tree }

Code:

public class MyGoal implements Goal { private Object state; public void reset() { state = null; // this method can be called at any time if another goal is selected } public void run(GoalSelector selector) { if(!npcIsCool()) { selector.finish(); // stops execution } else if (npcIsAwesome()){ selector.select(new AwesomeGoal()); // this switches execution to AwesomeGoal and stops execution of this goal. } else if (npcNeedsCool()) { selector.selectAdditional(new AccumulateCoolGoal()); // AccumulateCoolGoal executes concurrently to this goal. } } public boolean shouldExecute(GoalSelector selector) { if (npcIsCool()) { return true; } return false; } }

The second concept is the Navigator. This controls the pathfinding aspects of the NPC. The Navigator can have one target at a time, and will call events to notify of completion/cancellation:

• NavigationBeginEvent
• NavigationCancelEvent
• NavigationCompleteEvent
• NavigationEvent
• NavigationReplaceEvent

You can use the NavigatorParameters class to control various aspects of pathfinding. The default parameters are copied to create the "local" parameters whenever a new path is started - modify local parameters after setting your path target! The pathfinding range of the Navigator is the maximum range it will search when attempting to find a path to the target. This is usually set by the server admin. The speed modifier of the Navigator is the % modified movement speed of the NPC while moving to the target.

Using the Persistence API

Sometimes, traits can store a lot of simple variables such as primitives, Strings, Locations, and others. Saving/loading them via the trait API can be a little bit of overkill.

Citizens 2.0.4+ provides a simple Persistence API to automatically save and load these variables using DataKeys. The key to this API is the @Persist annotation. Sample code is provided below.

Code: Example

public class MyTrait extends Trait { // logic omitted. @Persist boolean myVariable = false; // the default value of @Persist saves the value under the field name (in this case, 'myVariable'). @Persist("newkey") int intVariable = 11; // this saves the value under 'newkey'. The default value of the variable has been set to 11 - this will be used when loading if the key doesn't exist. @Persist(value="newkey", required=true) String required; // if the value under 'newkey' doesn't exist, then the trait will fail to load. }

More advanced use of the API can be found in the @DelegatePersistence annotation. This allows complex types such as Locations to be saved and loaded with finer grained control. These types can be given default delegates by calling PersistenceLoader#registerPersistDelegate(Persister) - Location has a built in Persister for convenience.

Code:

public class MyTrait extends Trait { // logic omitted. @Persist @DelegatePersistence(ExplicitComplexTypePersister.class) // explicit delegation ComplexType myComplexType; @Persist ComplexType implicitComplexType; // implicit delegation static { PersistenceLoader.registerPersistDelegate(ImplicitComplexTypePersister.class); } } public class ExplicitComplexTypePersister implements Persister { public Object create(DataKey root) { return new ComplexType(root.getInteger("complexstructures")); } public void save(Object instance, DataKey root) { ComplexType real = (ComplexType) instance; // guaranteed cast - will always succeed. root.setInteger("complexstructures", real.getComplexStructure()); } }

See Also

Characters