### start

Source: https://jd.citizensnpcs.co/net/citizensnpcs/commands/NPCCommandSelector.html

Starts the NPC command selection conversation.

```APIDOC
## start

### Description
Initiates the NPC command selection process, starting a conversation with the player.

### Method
public static

### Parameters
- **callback** (NPCCommandSelector.Callback) - The callback to handle the NPC selection.
- **player** (Conversable) - The player initiating the command.
- **possible** (List<NPC>) - A list of NPCs available for selection.
```

--------------------------------

### startBundling

Source: https://jd.citizensnpcs.co/net/citizensnpcs/util/EntityPacketTracker.PacketBundler.html

Starts the packet bundling process.

```APIDOC
## startBundling

### Description
Starts the packet bundling process. Packets sent after this call will be batched until `stopBundlingAndSend` is invoked.

### Method Signature
`void startBundling()`
```

--------------------------------

### begin()

Source: https://jd.citizensnpcs.co/net/citizensnpcs/editor/CopierEditor.html

Starts the NPC copying editor session.

```APIDOC
## begin()

### Description
Begins the editor session. This method is specified by the Editor class.

### Method
public void begin()
```

--------------------------------

### Get All Commands from a Root Level

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/command/class-use/CommandManager.CommandInfo.html

Retrieves a list of all modified and root commands starting from a specified top-level command.

```APIDOC
## getCommands(String topLevelCommand)

### Description
Gets all modified and root commands from the given root level command.

### Method Signature
`List<CommandManager.CommandInfo> getCommands(String topLevelCommand)`

### Parameters
#### Path Parameters
- **topLevelCommand** (String) - Required - The root level command to start from.

### Returns
- `List<CommandManager.CommandInfo>` - A list of command information objects.
```

--------------------------------

### begin()

Source: https://jd.citizensnpcs.co/net/citizensnpcs/editor/EquipmentEditor.html

Starts the equipment editing session for the associated NPC.

```APIDOC
## begin()

### Description
Initiates the equipment editing process. This method is specified by the Editor class.

### Method
`void`

### Endpoint
N/A (Method call)
```

--------------------------------

### initialise Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/ShopTrait.NPCShopViewer.html

Initializes the shop viewer with the provided menu context.

```APIDOC
## initialise Method

### Description
Initializes the `NPCShopViewer` with the necessary context for menu operations.

### Method
`void initialise(MenuContext ctx)`

### Parameters
* **ctx** (MenuContext) - The context object containing information for menu initialization.
```

--------------------------------

### Get Default NPCRegistry

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Gets the default NPCRegistry.

```java
public NPCRegistry getNPCRegistry()
```

--------------------------------

### Get Collision Box at Coordinates

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/astar/pathfinder/BlockSource.html

Abstract method to get the BoundingBox for collision at specific integer coordinates (x, y, z). Subclasses must implement this.

```java
public abstract BoundingBox getCollisionBox(int x, int y, int z)
```

--------------------------------

### initialise Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/ShopTrait.NPCShopContentsEditor.html

Initializes the shop contents editor with the provided menu context.

```APIDOC
## initialise Method

### Description
Initializes the shop contents editor with the provided menu context.

### Method
void

### Endpoint
Specified by: `initialise` in class `InventoryMenuPage`

### Parameters
#### Path Parameters
- **ctx** (MenuContext) - Required - The menu context to initialize the editor with.
```

--------------------------------

### initialise Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/ShopTrait.NPCShopPageSettings.html

Initializes the menu context for the shop page.

```APIDOC
## initialise Method

### Description
Initializes the menu context for the shop page.

### Parameters
* **ctx** (MenuContext) - The context for the menu initialization.
```

--------------------------------

### getAuthor

Source: https://jd.citizensnpcs.co/index-all.html

Gets the author of the CitizensPlaceholders.

```APIDOC
## getAuthor

### Description
Gets the author of the CitizensPlaceholders.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
N/A

### Response
N/A
```

--------------------------------

### listSize(String)

Source: https://jd.citizensnpcs.co/index-all.html

Gets the size of a list.

```APIDOC
## listSize(String key)

### Description
Gets the number of items currently in the list identified by the key.

### Method
N/A (Java Method)

### Parameters
#### Path Parameters
- **key** (String) - Required - The key identifying the list.

### Response
#### Success Response (200)
- **size** (int) - The number of items in the list.

### Response Example
```json
{
  "size": 5
}
```
```

--------------------------------

### Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/SimpleNPCDataStore.html

Initializes a new instance of the SimpleNPCDataStore class.

```APIDOC
## SimpleNPCDataStore(Storage saves)

### Description
Initializes a new instance of the SimpleNPCDataStore class.

### Parameters
#### Path Parameters
- **saves** (Storage) - Description of the storage mechanism.
```

--------------------------------

### getName() - Pose

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the Pose.

```APIDOC
## getName() - Pose

### Description
Gets the name of the Pose.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the Pose.
```

--------------------------------

### initialise Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/editor/GenericEquipperGUI.html

Initializes the GUI with the provided menu context. This method is specified by the InventoryMenuPage class.

```APIDOC
## initialise(MenuContext ctx)

### Description
Initializes the GenericEquipperGUI with the given menu context.

### Method
`public void initialise(MenuContext ctx)`

### Parameters
#### Path Parameters
- **ctx** (MenuContext) - Required - The context for the menu.
```

--------------------------------

### getName() - Anchor

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the Anchor.

```APIDOC
## getName() - Anchor

### Description
Gets the name of the Anchor.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the Anchor.
```

--------------------------------

### getName() - NPCShop

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the NPCShop.

```APIDOC
## getName() - NPCShop

### Description
Gets the name of the NPCShop.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the NPCShop.
```

--------------------------------

### Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/SimpleMetadataStore.html

Initializes a new instance of the SimpleMetadataStore class.

```APIDOC
## SimpleMetadataStore()

### Description
Constructs a new SimpleMetadataStore.

### Method
`SimpleMetadataStore()`
```

--------------------------------

### getName() - FoliaTeamImpl

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the FoliaTeamImpl.

```APIDOC
## getName() - FoliaTeamImpl

### Description
Gets the name of the FoliaTeamImpl.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the FoliaTeamImpl.
```

--------------------------------

### Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/SimpleMetadataStore.html

Initializes a new instance of the SimpleMetadataStore class.

```APIDOC
## Constructor

### SimpleMetadataStore 
public SimpleMetadataStore()

Initializes a new instance of the SimpleMetadataStore class.
```

--------------------------------

### getName() - BukkitTeamImpl

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the BukkitTeamImpl.

```APIDOC
## getName() - BukkitTeamImpl

### Description
Gets the name of the BukkitTeamImpl.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the BukkitTeamImpl.
```

--------------------------------

### getName() - AbstractTeam

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the team.

```APIDOC
## getName() - AbstractTeam

### Description
Gets the name of the team.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the team.
```

--------------------------------

### initialise

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/gui/InventoryMenuPage.html

Initializes the menu page with the provided menu context. Injected variables become available after this method is called.

```APIDOC
## initialise(MenuContext ctx)

### Description
Initializes the menu page with the provided menu context. Injected variables become available after this method is called.

### Method
public abstract void initialise(MenuContext ctx)

### Parameters
#### Path Parameters
- **ctx** (MenuContext) - The context for the menu.
```

--------------------------------

### getName() - CitizensNPCRegistry

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the CitizensNPCRegistry.

```APIDOC
## getName() - CitizensNPCRegistry

### Description
Gets the name of the CitizensNPCRegistry.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the CitizensNPCRegistry.
```

--------------------------------

### EndermanEquipperGUI Methods

Source: https://jd.citizensnpcs.co/net/citizensnpcs/editor/EndermanEquipperGUI.html

Provides methods for initializing the GUI and handling item equipping.

```APIDOC
## initialise

### Description
Initializes the inventory menu with the given context.

### Method Signature
`public void initialise(MenuContext ctx)`

### Parameters
* **ctx** (MenuContext) - The context for the menu initialization.
```

```APIDOC
## setHand

### Description
Sets the item in the specified hand slot based on the click event.

### Method Signature
`public void setHand(InventoryMenuSlot slot, CitizensInventoryClickEvent event)`

### Parameters
* **slot** (InventoryMenuSlot) - The inventory slot being interacted with.
* **event** (CitizensInventoryClickEvent) - The event triggered by the player's click.
```

--------------------------------

### getName() - MolangEngine

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the MolangEngine.

```APIDOC
## getName() - MolangEngine

### Description
Gets the name of the MolangEngine.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the MolangEngine.
```

--------------------------------

### OpenShopActionGUI Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/shop/OpenShopAction.OpenShopActionGUI.html

Initializes a new instance of the OpenShopActionGUI class.

```APIDOC
## OpenShopActionGUI()

### Description
Constructs a new OpenShopActionGUI.

### Constructor
`OpenShopActionGUI()`
```

--------------------------------

### getName() - DenizenEngine

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the DenizenEngine.

```APIDOC
## getName() - DenizenEngine

### Description
Gets the name of the DenizenEngine.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the DenizenEngine.
```

--------------------------------

### initialise Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/DropsTrait.DropsGUI.html

Initializes the menu context for the DropsGUI. This method is called when the GUI is first created or opened.

```APIDOC
## initialise Method

### Description
Initializes the menu context for the DropsGUI.

### Parameters
* **ctx** (MenuContext) - The context for the menu initialization.
```

--------------------------------

### startWithCallback

Source: https://jd.citizensnpcs.co/net/citizensnpcs/commands/NPCCommandSelector.html

Starts the NPC command selection with a specific callback and context.

```APIDOC
## startWithCallback

### Description
Starts the NPC command selection process, allowing for a custom callback and providing detailed context.

### Method
public static

### Parameters
- **callback** (NPCCommandSelector.Callback) - The callback to handle the NPC selection.
- **npcRegistry** (NPCRegistry) - The registry of NPCs.
- **sender** (CommandSender) - The sender of the command.
- **args** (CommandContext) - The command arguments.
- **raw** (String) - The raw command input.

### Throws
- `CommandException` - If there is an error processing the command.
```

--------------------------------

### getName() - Trait

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of this trait.

```APIDOC
## getName() - Trait

### Description
Gets the name of this trait.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the trait.
```

--------------------------------

### getName() - NPCRegistry

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the NPCRegistry.

```APIDOC
## getName() - NPCRegistry

### Description
Gets the name of the registry.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the NPCRegistry.
```

--------------------------------

### MoneyActionGUI Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/shop/MoneyAction.MoneyActionGUI.html

Initializes a new instance of the MoneyActionGUI class.

```APIDOC
## MoneyActionGUI()

### Description
Initializes a new instance of the MoneyActionGUI class.

### Constructor
`MoneyActionGUI()`
```

--------------------------------

### getName() - AbstractNPC

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the AbstractNPC.

```APIDOC
## getName() - AbstractNPC

### Description
Gets the name of the AbstractNPC.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the AbstractNPC.
```

--------------------------------

### IntMapTraitLookup Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/trait/TraitLookup.IntMapTraitLookup.html

Initializes a new instance of the IntMapTraitLookup class.

```APIDOC
## Constructor

### IntMapTraitLookup

`public IntMapTraitLookup()`

Initializes a new instance of the `IntMapTraitLookup` class.
```

--------------------------------

### Running the Algorithm

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/astar/AStarMachine.html

Methods to execute the A* pathfinding algorithm.

```APIDOC
## run

### Description
Runs the `AStarMachine.AStarState` until a plan is found.

### Method
`P run(AStarMachine.AStarState<N> state)`

### Parameters
- **state** (AStarMachine.AStarState<N>) - The state to use

### Returns
The generated `Plan`, or `null`

### See Also
- `run(AStarState)`

## run

### Description
Runs the machine using the given `AStarMachine.AStarState`'s `AStarStorage`. Can be used to provide a continuation style usage of the A* algorithm.

### Method
`P run(AStarMachine.AStarState<N> state, int maxIterations)`

### Parameters
- **state** (AStarMachine.AStarState<N>) - The state to use
- **maxIterations** (int) - The maximum number of iterations

### Returns
The generated `Plan`, or `null` if not found

## runFully

### Description
Runs the machine until a plan is either found or cannot be generated.

### Method
`P runFully(AStarGoal<N> goal, N start)`

### See Also
- `runFully(AStarGoal, AStarNode, int)`

## runFully

### Description
Runs the machine fully until the iteration limit has been exceeded. This will use the supplied goal and start to generate neighbours until the goal state has been reached using the A* algorithm.

### Method
`P runFully(AStarGoal<N> goal, N start, int iterations)`

### Parameters
- **goal** (AStarGoal<N>) - The `AStarGoal` state
- **start** (N) - The starting `AStarNode`
- **iterations** (int) - The number of iterations to run the machine for

### Returns
The generated `Plan`, or `null` if it was not found
```

--------------------------------

### getName() - JSR223Engine

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the JSR223Engine.

```APIDOC
## getName() - JSR223Engine

### Description
Gets the name of the JSR223Engine.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the JSR223Engine.
```

--------------------------------

### Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/HologramTrait.html

Initializes a new HologramTrait.

```APIDOC
## HologramTrait
public HologramTrait()

### Description
Initializes a new instance of the HologramTrait class.
```

--------------------------------

### getName() - ExpressionEngine

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the ExpressionEngine.

```APIDOC
## getName() - ExpressionEngine

### Description
Gets the name of the ExpressionEngine.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the ExpressionEngine.
```

--------------------------------

### getName() - TalkableEntity

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the TalkableEntity.

```APIDOC
## getName() - TalkableEntity

### Description
Gets the name of the TalkableEntity.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the TalkableEntity.
```

--------------------------------

### EquipmentEditor Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/editor/EquipmentEditor.html

Initializes a new instance of the EquipmentEditor class.

```APIDOC
## EquipmentEditor(Player player, NPC npc)

### Description
Constructs a new EquipmentEditor associated with a specific player and NPC.

### Parameters
#### Path Parameters
- **player** (Player) - The player interacting with the editor.
- **npc** (NPC) - The NPC whose equipment is being edited.
```

--------------------------------

### getBodyColor

Source: https://jd.citizensnpcs.co/index-all.html

Gets the body color of a TropicalFishTrait.

```APIDOC
## getBodyColor

### Description
Gets the body color of a TropicalFishTrait.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
N/A

### Response
N/A
```

--------------------------------

### run

Source: https://jd.citizensnpcs.co/net/citizensnpcs/npc/ai/CitizensNavigator.html

Executes the navigation logic.

```APIDOC
## run()

### Description
Executes the main navigation logic for the NPC. This method is typically called by a scheduler or thread.
```

--------------------------------

### getBillboard

Source: https://jd.citizensnpcs.co/index-all.html

Gets the billboard setting for the DisplayTrait.

```APIDOC
## getBillboard

### Description
Gets the billboard setting for the DisplayTrait.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
N/A

### Response
N/A
```

--------------------------------

### NPCShopViewer initialise Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/ShopTrait.NPCShopViewer.html

Initializes the shop viewer with the provided MenuContext. This method is specified by the InventoryMenuPage class.

```java
public void initialise(MenuContext ctx)
```

--------------------------------

### getBackgroundColor

Source: https://jd.citizensnpcs.co/index-all.html

Gets the background color for the TextDisplayTrait.

```APIDOC
## getBackgroundColor

### Description
Gets the background color for the TextDisplayTrait.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
N/A

### Response
N/A
```

--------------------------------

### createInventory Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/ShopTrait.NPCShopViewer.html

Creates the inventory GUI for the shop viewer.

```APIDOC
## createInventory Method

### Description
Creates and returns the inventory object used for the shop viewer's interface.

### Method
`Inventory createInventory(String title)`

### Parameters
* **title** (String) - The title to be displayed on the inventory GUI.

### Returns
* **Inventory** - The created inventory object.
```

--------------------------------

### getEyeLocation

Source: https://jd.citizensnpcs.co/net/citizensnpcs/util/Util.html

Gets the eye location of an entity.

```APIDOC
## getEyeLocation

### Description
Gets the eye location of an entity.

### Method
`public static Location getEyeLocation(Entity entity)`
```

--------------------------------

### Settings Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Settings.html

Initializes the Settings object with a specified folder for configuration files.

```APIDOC
## Settings(File folder)

### Description
Initializes a new instance of the Settings class.

### Constructor
`Settings(File folder)`

### Parameters
* **folder** (File) - The directory where settings will be stored or loaded from.
```

--------------------------------

### getCenterLocation

Source: https://jd.citizensnpcs.co/net/citizensnpcs/util/Util.html

Gets the center location of a block.

```APIDOC
## getCenterLocation

### Description
Gets the center location of a block.

### Method
`public static Location getCenterLocation(Block block)`
```

--------------------------------

### toBukkit() Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/trait/trait/Equipment.EquipmentSlot.html

Converts this EquipmentSlot enum to its Bukkit equivalent.

```APIDOC
## Method: toBukkit()

### Description
Converts this EquipmentSlot enum to its Bukkit equivalent.

### Signature
`public EquipmentSlot toBukkit()`

### Returns
The corresponding Bukkit EquipmentSlot.
```

--------------------------------

### getFullName

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/AbstractNPC.html

Gets the full name of this NPC.

```APIDOC
## getFullName
public String getFullName()

### Description
Gets the full name of this NPC.

### Returns
Full name of this NPC
```

--------------------------------

### MolangEngine Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/npc/ai/tree/MolangEngine.html

Initializes a new instance of the MolangEngine class.

```APIDOC
## MolangEngine()

### Description
Initializes a new instance of the MolangEngine class.

### Constructor
`MolangEngine()`
```

--------------------------------

### run

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/astar/pathfinder/Path.html

Executes the pathfinding logic for the given NPC.

```APIDOC
## run

### Description
Executes the pathfinding logic for the given NPC.

### Signature
`void run(NPC npc)`

### Parameters
* **npc** (NPC) - The NPC for which to run the path.
```

--------------------------------

### getUniqueId

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/AbstractNPC.html

Gets the unique ID of this NPC.

```APIDOC
## getUniqueId

### Description
Gets the unique id of this NPC.

### Method
```java
public UUID getUniqueId()
```

### Returns
* UUID - The unique ID of the NPC.
```

--------------------------------

### getTrait

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/AbstractNPC.html

Gets a trait from the given class.

```APIDOC
## getTrait

### Description
Gets a trait from the given class.

### Method
```java
<T extends Trait> T getTrait(Class<T> trait)
```

### Parameters
* **trait** (Class<T>) - The class of the trait to retrieve.

### Returns
* T - The trait instance.
```

--------------------------------

### AStarPlanner Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/npc/ai/AStarNavigationStrategy.AStarPlanner.html

Initializes a new instance of the AStarPlanner class with specified navigation parameters, a starting location, and a destination location.

```APIDOC
## AStarPlanner Constructor

### Description
Initializes a new instance of the AStarPlanner class.

### Parameters
* **params** (NavigatorParameters) - The navigation parameters to use for pathfinding.
* **from** (Location) - The starting location for the path.
* **to** (Location) - The destination location for the path.
```

--------------------------------

### Instance Methods

Source: https://jd.citizensnpcs.co/net/citizensnpcs/npc/ai/AStarNavigationStrategy.html

Methods available for interacting with the AStarNavigationStrategy.

```APIDOC
## Method Details

### getCurrentDestination

```java
public Location getCurrentDestination()
```

Returns:
Gets the current movement destination

### getPath

```java
public Iterable<Vector> getPath()
```

Returns:
A copy of the current path, if any

### getTargetAsLocation

```java
public Location getTargetAsLocation()
```

Returns:
Gets the target destination location

### stop

```java
public void stop()
```

Description copied from interface: `PathStrategy`
Forcibly stops pathfinding. Note that this method does not necessarily set the cancel reason.

### update

```java
public boolean update()
```

Description copied from interface: `PathStrategy`
Updates and runs the pathfinding strategy on its current NPC and destination. 

Returns:
Whether pathfinding has completed
```

--------------------------------

### getId

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/AbstractNPC.html

Gets the unique ID of this NPC.

```APIDOC
## getId

### Description
Gets the unique ID of this NPC.

### Method
```java
public int getId()
```

### Returns
* int - The unique ID of the NPC.
```

--------------------------------

### accept Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/templates/CommandEventAction.html

Executes the defined commands for a given NPC.

```APIDOC
## accept Method

### Description
Executes the commands associated with this action for the provided NPC.

### Signature
`public void accept(NPC npc)`

### Parameters
* **npc** (`NPC`) - The NPC for which the commands should be executed.

### Implements
`accept` in interface `Consumer<NPC>`
```

--------------------------------

### getEntityType

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/AbstractNPC.html

Gets the entity type of this NPC.

```APIDOC
## getEntityType

### Description
Gets the entity type of this NPC.

### Method
```java
protected EntityType getEntityType()
```

### Returns
* EntityType - The entity type.
```

--------------------------------

### GuidedWaypointProvider Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/waypoint/GuidedWaypointProvider.html

Initializes a new instance of the GuidedWaypointProvider class.

```APIDOC
## GuidedWaypointProvider()

### Description
Initializes a new instance of the `GuidedWaypointProvider` class.

### Constructor
`GuidedWaypointProvider()`
```

--------------------------------

### getName

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/NPCRegistry.html

Gets the name of the NPC registry.

```APIDOC
## getName

### Description
Gets the name of the NPC registry.

### Method
GET

### Endpoint
/npcs/registry/name

### Parameters
None

### Response
#### Success Response (200)
- **name** (String) - The name of the registry.

#### Response Example
```json
{
  "name": "DefaultNPCRegistry"
}
```
```

--------------------------------

### buildPlan

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/astar/pathfinder/VectorNode.html

Builds a plan for the path. Inherited from AStarNode.

```APIDOC
### buildPlan
public Plan buildPlan()

Specified by:
`buildPlan` in class `AStarNode`
```

--------------------------------

### CitizensEnableEvent getHandlerList

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/event/CitizensEnableEvent.html

Gets the HandlerList for all events.

```APIDOC
## getHandlerList()

### Description
Gets the HandlerList for all events.

### Method
`public static HandlerList getHandlerList()`

### Returns
`HandlerList` - The handler list for all events.
```

--------------------------------

### Instance Methods

Source: https://jd.citizensnpcs.co/net/citizensnpcs/npc/ai/FlyingAStarNavigationStrategy.html

Details the methods available for interacting with and controlling the navigation strategy.

```APIDOC
## getCurrentDestination()

### Description
Gets the current movement destination of the NPC.

### Returns
* **Location** - The current destination.
```

```APIDOC
## getPath()

### Description
Retrieves a copy of the current path being followed by the NPC.

### Returns
* **Iterable<Vector>** - A copy of the current path.
```

```APIDOC
## getTargetAsLocation()

### Description
Gets the target destination location for the NPC.

### Returns
* **Location** - The target destination.
```

```APIDOC
## setPlan(Path path)

### Description
Sets a new path plan for the navigation strategy.

### Parameters
* **path** (Path) - The new path to set.
```

```APIDOC
## stop()

### Description
Forcibly stops the pathfinding process. This method does not necessarily set the cancel reason.

### Returns
* **void**
```

```APIDOC
## update()

### Description
Updates the pathfinding strategy, processing the current NPC and destination. Returns whether pathfinding has completed.

### Returns
* **boolean** - True if pathfinding has completed, false otherwise.
```

--------------------------------

### getHandlerList()

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/ai/event/NavigationCancelEvent.html

Gets the handler list for this event.

```APIDOC
## getHandlerList()

### Description
Returns the handler list for this event. This is a static method used for event registration.

### Returns
- **HandlerList** - The list of handlers for this event.
```

--------------------------------

### Get TemplateRegistry

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the TemplateRegistry instance.

```java
public TemplateRegistry getTemplateRegistry()
```

--------------------------------

### ExperienceActionGUI Methods

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/shop/ExperienceAction.ExperienceActionGUI.html

Provides details on the methods available for interacting with the ExperienceActionGUI, including checking usability, creating editors and menu items, and managing actions.

```APIDOC
## Class: ExperienceActionGUI

Implements: `NPCShopAction.GUI`

### Description
Represents the graphical user interface for experience-related actions within the NPC shop system. It allows for the creation and management of shop action GUIs.

### Methods

#### `canUse(HumanEntity entity)`

*   **Description**: Checks if the given entity can use this GUI.
*   **Signature**: `public boolean canUse(HumanEntity entity)`
*   **Implements**: `NPCShopAction.GUI.canUse`

#### `createEditor(NPCShopAction previous, Consumer<NPCShopAction> callback)`

*   **Description**: Creates an inventory menu page for editing the shop action.
*   **Signature**: `public InventoryMenuPage createEditor(NPCShopAction previous, Consumer<NPCShopAction> callback)`
*   **Implements**: `NPCShopAction.GUI.createEditor`

#### `createMenuItem(NPCShopAction previous)`

*   **Description**: Creates an ItemStack representing the menu item for this shop action.
*   **Signature**: `public ItemStack createMenuItem(NPCShopAction previous)`
*   **Implements**: `NPCShopAction.GUI.createMenuItem`

#### `manages(NPCShopAction action)`

*   **Description**: Determines if this GUI manages the given shop action.
*   **Signature**: `public boolean manages(NPCShopAction action)`
*   **Implements**: `NPCShopAction.GUI.manages`
```

--------------------------------

### Get StoredShops

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the StoredShops instance.

```java
public StoredShops getShops()
```

--------------------------------

### CommandActionGUI Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/shop/CommandAction.CommandActionGUI.html

Initializes a new instance of the CommandActionGUI class.

```APIDOC
## CommandActionGUI()

### Description
Initializes a new instance of the CommandActionGUI class.

### Method
public CommandActionGUI()
```

--------------------------------

### Get CitizensScoreboardManager

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the CitizensScoreboardManager instance.

```java
public CitizensScoreboardManager getScoreboardManager()
```

--------------------------------

### MemoryNPCDataStore Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/MemoryNPCDataStore.html

Initializes a new instance of the MemoryNPCDataStore class.

```APIDOC
## MemoryNPCDataStore()

### Description
Initializes a new instance of the MemoryNPCDataStore class.

### Method
Constructor

### Endpoint
N/A
```

--------------------------------

### Get PacketEventsListener

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the PacketEventsHook listener.

```java
public PacketEventsHook getPacketEventsListener()
```

--------------------------------

### createInventory Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/ShopTrait.NPCShopContentsEditor.html

Creates and returns an inventory menu for the shop contents.

```APIDOC
## createInventory Method

### Description
Creates and returns an inventory menu for the shop contents.

### Method
Inventory

### Endpoint
Overrides: `createInventory` in class `InventoryMenuPage`

### Parameters
#### Path Parameters
- **title** (String) - Required - The title to be displayed for the inventory menu.
```

--------------------------------

### Get NPCSelector

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the NPCSelector instance.

```java
public NPCSelector getNPCSelector()
```

--------------------------------

### accept Method

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/templates/CommandListExecutor.html

Accepts an NPC and executes the predefined list of commands on it.

```APIDOC
## accept(NPC npc)

### Description
Executes the list of commands associated with this executor on the given NPC.

### Method
`void accept(NPC npc)`

### Parameters
#### Path Parameters
- **npc** (NPC) - Required - The NPC to execute commands on.

### Methods inherited from interface Consumer
`andThen`
```

--------------------------------

### Constructors

Source: https://jd.citizensnpcs.co/net/citizensnpcs/npc/ai/AStarNavigationStrategy.html

Constructors for initializing the AStarNavigationStrategy.

```APIDOC
## Constructor Details

### AStarNavigationStrategy

```java
public AStarNavigationStrategy(NPC npc, Iterable<Vector> path, NavigatorParameters params)
```

### AStarNavigationStrategy

```java
public AStarNavigationStrategy(NPC npc, Location dest, NavigatorParameters params)
```
```

--------------------------------

### Get NMSHelper

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the NMSHelper instance.

```java
public NMSHelper getNMSHelper()
```

--------------------------------

### Get LocationLookup

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the LocationLookup instance.

```java
public LocationLookup getLocationLookup()
```

--------------------------------

### Constructors

Source: https://jd.citizensnpcs.co/net/citizensnpcs/npc/ai/StraightLineNavigationStrategy.html

Initializes a new instance of the StraightLineNavigationStrategy.

```APIDOC
## StraightLineNavigationStrategy(NPC npc, Entity target, NavigatorParameters params)

### Description
Constructs a new StraightLineNavigationStrategy targeting a specific entity.

### Parameters
- **npc** (NPC) - The NPC to navigate.
- **target** (Entity) - The entity to navigate towards.
- **params** (NavigatorParameters) - Parameters for the navigator.

## StraightLineNavigationStrategy(NPC npc, Location dest, NavigatorParameters params)

### Description
Constructs a new StraightLineNavigationStrategy targeting a specific location.

### Parameters
- **npc** (NPC) - The NPC to navigate.
- **dest** (Location) - The destination location to navigate towards.
- **params** (NavigatorParameters) - Parameters for the navigator.
```

--------------------------------

### SaddleEquipperGUI Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/editor/SaddleEquipperGUI.html

Initializes a new instance of the SaddleEquipperGUI class.

```APIDOC
## SaddleEquipperGUI()

### Description
Initializes a new instance of the SaddleEquipperGUI class.

### Constructor
`SaddleEquipperGUI()`
```

--------------------------------

### Get ExpressionRegistry

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the ExpressionRegistry instance.

```java
public ExpressionRegistry getExpressionRegistry()
```

--------------------------------

### MetadataStore and SimpleMetadataStore Operations with NPC.Metadata

Source: https://jd.citizensnpcs.co/net/citizensnpcs/api/npc/class-use/NPC.Metadata.html

Demonstrates how to use NPC.Metadata keys with MetadataStore and SimpleMetadataStore to manage NPC metadata.

```APIDOC
## Metadata Management with NPC.Metadata

### Description
These methods allow for the retrieval, checking, removal, and setting of NPC metadata using `NPC.Metadata` keys.

### Methods
#### `MetadataStore.get(NPC.Metadata key)`
Fetches metadata from the given key.

#### `MetadataStore.get(NPC.Metadata key, T def)`
Fetches metadata from the given key, returning a default value if not found.

#### `SimpleMetadataStore.get(NPC.Metadata key)`
Fetches metadata from the given key.

#### `SimpleMetadataStore.get(NPC.Metadata key, T def)`
Fetches metadata from the given key, returning a default value if not found.

#### `MetadataStore.has(NPC.Metadata key)`
Returns whether the metadata exists for the given key.

#### `SimpleMetadataStore.has(NPC.Metadata key)`
Returns whether the metadata exists for the given key.

#### `MetadataStore.remove(NPC.Metadata key)`
Removes any metadata at the given metadata key.

#### `SimpleMetadataStore.remove(NPC.Metadata key)`
Removes any metadata at the given metadata key.

#### `MetadataStore.set(NPC.Metadata key, Object data)`
Stores data at the given key.

#### `SimpleMetadataStore.set(NPC.Metadata key, Object data)`
Stores data at the given key.

#### `MetadataStore.setPersistent(NPC.Metadata key, Object data)`
Stores data persistently at the given key.

#### `SimpleMetadataStore.setPersistent(NPC.Metadata key, Object data)`
Stores data persistently at the given key.
```

--------------------------------

### Get CommandManager

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the CommandManager instance.

```java
public CommandManager getCommandManager()
```

--------------------------------

### Get BehaviorRegistry

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the BehaviorRegistry instance.

```java
public BehaviorRegistry getBehaviorRegistry()
```

--------------------------------

### CreateNPCHistoryItem Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/commands/history/CreateNPCHistoryItem.html

Initializes a new instance of the CreateNPCHistoryItem class.

```APIDOC
## CreateNPCHistoryItem(NPC npc)

### Description
Initializes a new instance of the CreateNPCHistoryItem class with the specified NPC.

### Parameters
* **npc** (NPC) - The NPC associated with this history item.
```

--------------------------------

### Get AsyncChunkCache

Source: https://jd.citizensnpcs.co/net/citizensnpcs/Citizens.html

Retrieves the AsyncChunkCache instance.

```java
public AsyncChunkCache getAsyncChunkCache()
```

--------------------------------

### GenericEquipperGUI Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/editor/GenericEquipperGUI.html

Initializes a new instance of the GenericEquipperGUI class.

```APIDOC
## GenericEquipperGUI()

### Description
Constructs a new GenericEquipperGUI.

### Method
`public GenericEquipperGUI()`
```

--------------------------------

### EndermanEquipperGUI Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/editor/EndermanEquipperGUI.html

Initializes a new instance of the EndermanEquipperGUI class.

```APIDOC
## EndermanEquipperGUI()

### Description
Constructs a new EndermanEquipperGUI.

### Constructor
`public EndermanEquipperGUI()`
```

--------------------------------

### getName() - Talkable

Source: https://jd.citizensnpcs.co/index-all.html

Gets the name of the Talkable LivingEntity.

```APIDOC
## getName() - Talkable

### Description
Gets the name of the Talkable LivingEntity.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The name of the Talkable entity.
```

--------------------------------

### OpenShopAction Constructors

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/shop/OpenShopAction.html

Provides details on how to instantiate the OpenShopAction class.

```APIDOC
## OpenShopAction()

### Description
Default constructor for OpenShopAction.

### Constructor
`public OpenShopAction()`
```

```APIDOC
## OpenShopAction(String shopName)

### Description
Constructor for OpenShopAction that initializes the shop name.

### Constructor
`public OpenShopAction(String shopName)`

### Parameters
* **shopName** (String) - The name of the shop to be opened.
```

--------------------------------

### PermissionActionGUI Constructor

Source: https://jd.citizensnpcs.co/net/citizensnpcs/trait/shop/PermissionAction.PermissionActionGUI.html

Initializes a new instance of the PermissionActionGUI class.

```APIDOC
## PermissionActionGUI Constructor

### Description
Initializes a new instance of the PermissionActionGUI class.

### Method
`public PermissionActionGUI()`
```

--------------------------------

### getMessage() - SpeechContext

Source: https://jd.citizensnpcs.co/index-all.html

Gets the text message that was sent.

```APIDOC
## getMessage() - SpeechContext

### Description
Gets the text message that was sent.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **String** (string) - The sent speech message.
```

--------------------------------

### getBukkitValue

Source: https://jd.citizensnpcs.co/index-all.html

Gets the Bukkit value of a team option.

```APIDOC
## getBukkitValue

### Description
Gets the Bukkit value of a team option, such as CollisionRule or NameTags.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
N/A

### Response
N/A
```