Skip to content

CitizensπŸ”—

If you have this plugin you can use it's NPCs. I highly recommend you installing it, it's NPCs are way more immersive. Having Citizens also allows you to use NPCKill objective and to have moving NPC's in addition to the normal NPC functionality.

Info

In addition Citizens integration supports all BetonQuest NPC features.

ActionsπŸ”—

Move NPC: npcmoveπŸ”—

This action will make the NPC move to a specified location. It will not return on its own, so you have to set a single path point with /npc path command - it will then return to that point every time. If you make it move too far away, it will teleport or break, so beware. You can change maximum pathfinding range in Citizens configuration files.

Move action can fail if the NPC is already moving for another player.

Parameter Syntax Default Value Explanation
NpcID npcId The NPCId.
Locations Locations The locations where the NPC will move to.
block Keyword (block) Disabled Blocks the NPC so interaction won't start a conversation while it is moving.
wait wait:number 0 Number of ticks the NPC will wait at its destination before firing actions.
done done:actions Disabled List of actions fired after reaching the destination.
fail fail:actions Disabled List of actions fired if this action fails.
Example
actions:
  showPath: "npcmove innkeeper 100;200;300;world,105;200;280;world block wait:20 done:msg_were_here,give_reward fail:msg_cant_go,give_reward"

Stop moving NPC: npcstopπŸ”—

This will stop all current move tasks for the NPC.

Parameter Syntax Default Value Explanation
NpcID npcId The NpcId.
Example
actions:
  stopGuide: "npcstop guard"

ObjectivesπŸ”—

NPC Kill: npckillπŸ”—

The NPC Kill objective requires the player to kill a NPC.

Parameter Syntax Default Value Explanation
NpcID npcId The NpcId.
amount amount:number 1 The time the NPC needs to be killed.
notify notify Disabled Display a message to the player each time they kill a NPC. Optionally with the notification interval after colon.
Placeholder Properties
Name Example Output Explanation
amount 6 Shows the amount of times already killed the NPC.
left 4 Shows the amount of times still needed to kill the NPC for the objective to be completed.
total 10 Shows the initial amount of times that the NPC needed to be killed.
Example
objectives:
  killThief: "npckill thief amount:3 actions:reward notify"