Conversation Entities Properties

Name

This is the name of the NPC that will show in chat. You can add the {centered} variable before the name to make the text centered.

Example 1

name: '&a&lGuard'

Example 2

name: '{centered}&a&lGuard'

Starting Points

Conversations should start with an NPC or entity. You need to use the following format.

1) NPC named <name>

2) <entity> named <name>

3) NPC with id <id>

The <name> value is the custom name of the entity. If you have an NPC called "Bob", then this is the name. Don't use color codes.

If you want to start a conversation without using a Citizens NPC, and instead, a Minecraft entity, replace the <entity> value with an EntityType from this link: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html

If you are starting a conversation using the /interactions start command, you don't need to add a starting point.

Example 1

starts_with:
- NPC named Guard
- NPC with id 17

This will start the conversation when a player right clicks a Citizens NPC called "Guard" or a Citizens NPC with id "17".

Example 2

starts_with:
- SKELETON named Teleporter

This will start the conversation when a player right clicks a Skeleton called "Teleporter".

Conversation Radius

Start conversation radius

The radius of blocks a player must be near the NPC to automatically start the conversation. Set it to 0 to ignore this option and prevent the conversation to start automatically.

End conversation radius

The radius of blocks a player must be away from the NPC to automatically leave/end the conversation. You can set it to 0 to ignore this option but it is recommended always setting it to a higher value to prevent bugs.

start_conversation_radius: 5
end_conversation_radius: 5

Slow Effect

When enabled, this will create a "zoom effect" when talking to the NPC.

slow_effect: true

Block Movement

Whether the player movement should be cancelled when talking to this NPC.

block_movement: true

Can Be Started on Air

Whether the player can start the conversation while not on the ground.

can_be_started_on_air: false

Save Conversation Progress

When enabled, if the player leaves the server or the server is closed while talking to an NPC, the progress of the conversation will be saved for the next time they join.

save_conversation_progress: true

Requires Permission

When enabled, players will need the interactions.start.<conversation> permission to speak with the NPC. You can also add an option where you can specify a unique permission error message for each NPC conversation. If you don't set the custom permission message, the default one from messages.yml will be used.

requires_permission: true
custom_permission_message: "&cYou need to be level 20 to start this conversation."

Cooldown

Defines the amount of seconds the player must wait before talking to the NPC again. If you don't want a cooldown set it to 0 or delete the option.

cooldown: 3600

Hologram Dialogues

Allows the display of holograms above the NPC on each conversation dialogue.

Requires a compatible hologram plugin mentioned in Requirements

hologram_dialogues:
  # Whether holograms should be enabled or not.
  enabled: false
  
  # The height of the hologram.
  offset_y: 2.7
  
  # Modification on the horizontal position of the hologram
  # Negative values = left, and positive values = right (from the
  # original location).
  offset_horizontal: -1.5

Conversations

It refers to the multiple conversations this entity can have. Click HERE for Conversations properties.

conversation:
    conversation1:
    ...
    conversation2:
    ...