FancyNpcs

https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0
Admin
FancyNpcs is a software project for creating and managing custom NPCs in game environments.
Tokens:39,264
Snippets:364
Trust Score:4.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### getSkinManager

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Gets the skin manager instance from the FancyNpcsPlugin.

```APIDOC
## getSkinManager()

### Description
Gets the skin manager instance from the FancyNpcsPlugin.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **SkinManager** (SkinManager) - The skin manager instance.
```

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

### NpcStartLookingEvent

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/events/NpcStartLookingEvent.html

This event is fired when an NPC starts looking at a player. It extends the Bukkit Event class and provides access to the NPC and the player.

```APIDOC
## Class: NpcStartLookingEvent

### Description
Is fired when NPC starts looking at a player.

### Constructor
`NpcStartLookingEvent(@NotNull Npc npc, @NotNull org.bukkit.entity.Player player)`

### Methods
* `static org.bukkit.event.HandlerList getHandlerList()`
  Returns the handler list for this event.
* `@NotNull org.bukkit.event.HandlerList getHandlers()`
  Specified by: `getHandlers` in class `org.bukkit.event.Event`
* `@NotNull Npc getNpc()`
  Returns: the npc that started looking at a player
* `@NotNull org.bukkit.entity.Player getPlayer()`
  Returns: the player who npc started looking at
```

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

### Get All NPC Actions

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/ActionManager.html

Retrieves a list of all registered NPC actions.

```APIDOC
## getAllActions

### Description
Retrieves a list of all registered NPC actions.

### Method Signature
`List<NpcAction> getAllActions()`

### Returns
* **List<NpcAction>** - A list containing all registered NPC actions.
```

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

### getTypes

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcAttribute.html

Gets the list of Bukkit entity types this NPC attribute can be applied to.

```APIDOC
## getTypes

### Description
Gets the list of Bukkit entity types this NPC attribute can be applied to.

### Returns
- (List<org.bukkit.entity.EntityType>) - A list of applicable entity types.
```

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

### Get NPC by ID

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcManager.html

Retrieves an NPC using its unique string ID. This is a reliable way to get a specific NPC if its ID is known.

```APIDOC
## getNpcById

### Description
Retrieves an NPC by its unique string ID.

### Method Signature
`Npc getNpcById(String id)`

### Parameters
* **id** (String) - The unique ID of the NPC.
```

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

### Constructors

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/executor/ActionExecutionContext.html

Provides two constructors to initialize the ActionExecutionContext, one with a player and one without.

```APIDOC
## Constructors

### ActionExecutionContext(ActionTrigger trigger, Npc npc, UUID player)
Constructs an ActionExecutionContext with the specified ActionTrigger, Npc, and an optional Player.

**Parameters:**
* `trigger` (ActionTrigger) - the trigger that initiated the action
* `npc` (Npc) - the NPC that the action is being executed on
* `player` (UUID) - the player involved in the action, may be null if no player is involved

### ActionExecutionContext(ActionTrigger trigger, Npc npc)
Constructs an ActionExecutionContext with the specified ActionTrigger and Npc, without a Player.

**Parameters:**
* `trigger` (ActionTrigger) - the trigger that initiated the action
* `npc` (Npc) - the NPC that the action is being executed on
```

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

### ActionExecutionContext Constructors

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Constructs for initializing the ActionExecutionContext.

```APIDOC
## ActionExecutionContext(ActionTrigger, Npc)

### Description
Constructs an ActionExecutionContext with the specified ActionTrigger and Npc, without a Player.

### Method
Constructor

### Endpoint
N/A

### Parameters
- **trigger** (ActionTrigger) - Required - The trigger for the action sequence.
- **npc** (Npc) - Required - The NPC associated with the context.

### Request Example
None

### Response
#### Success Response (N/A)
- **ActionExecutionContext** (Object) - The newly created ActionExecutionContext instance.
```

```APIDOC
## ActionExecutionContext(ActionTrigger, Npc, UUID)

### Description
Constructs an ActionExecutionContext with the specified ActionTrigger, Npc, and an optional Player.

### Method
Constructor

### Endpoint
N/A

### Parameters
- **trigger** (ActionTrigger) - Required - The trigger for the action sequence.
- **npc** (Npc) - Required - The NPC associated with the context.
- **playerUuid** (UUID) - Optional - The UUID of the player initiating the context.

### Request Example
None

### Response
#### Success Response (N/A)
- **ActionExecutionContext** (Object) - The newly created ActionExecutionContext instance.
```

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

### getTranslator

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Gets the translator instance from the FancyNpcsPlugin.

```APIDOC
## getTranslator()

### Description
Gets the translator instance from the FancyNpcsPlugin.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Translator** (Translator) - The translator instance.
```

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

### getName

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcAttribute.html

Gets the name of the NPC attribute.

```APIDOC
## getName

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

### Returns
- (String) - The name of the attribute.
```

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

### Fetch Skin by File Path

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/skins/SkinManager.html

Fetches a skin using a file path relative to the plugins/FancyNPCs/skins directory.

```APIDOC
## getByFile

### Description
Fetch a skin by a file path pointing to a skin image (relative to plugins/FancyNPCs/skins)

### Method Signature
SkinData getByFile(String filePath, SkinData.SkinVariant variant)

### Parameters
* `filePath` (String) - The path to the skin image file.
* `variant` (SkinData.SkinVariant) - The desired skin variant (e.g., `SKIN`, `CAPE`).

### Returns
* `SkinData` - The skin data if cached, otherwise null. The skin will be fetched asynchronously.

### Event
Listen to `SkinGeneratedEvent` for asynchronous skin data.
```

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

### Npc.create()

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Creates a new NPC instance.

```APIDOC
## create()

### Description
Creates a new, uninitialized NPC instance. Further configuration is required before use.

### Method
Instance Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (N/A)
- **Npc** (Object) - The newly created NPC instance.
```

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

### getVisibilityDistance (NpcData)

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Gets the visibility distance for this NPC.

```APIDOC
## getVisibilityDistance()

### Description
Gets the visibility distance for this NPC.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Double** (Double) - The visibility distance.
```

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

### Npc Constructor

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/Npc.html

Initializes a new Npc instance with the provided NpcData.

```APIDOC
## Npc(NpcData data)

### Description
Constructs a new Npc object.

### Parameters
* **data** (NpcData) - The data object containing information for the NPC.
```

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

### getVisibilityDistance (FancyNpcsConfig)

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Gets the visibility distance from FancyNpcsConfig.

```APIDOC
## getVisibilityDistance()

### Description
Gets the visibility distance from FancyNpcsConfig.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Double** (Double) - The visibility distance.
```

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

### getTurnToPlayerDistance (NpcData)

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Gets the turn-to-player distance for this NPC.

```APIDOC
## getTurnToPlayerDistance()

### Description
Gets the turn-to-player distance for this NPC.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Double** (Double) - The turn-to-player distance.
```

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

### Npc.moveForAll() Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Methods to move all NPCs.

```APIDOC
## Npc.moveForAll()

### Description
Methods to move all NPCs.

### Methods
- `moveForAll()`: Moves all NPCs.
- `moveForAll(boolean force)`: Moves all NPCs with an option to force the movement.
```

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

### NpcData Constructors

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcData.html

Provides details on how to create new NpcData instances.

```APIDOC
## Constructor Details

### NpcData
public NpcData(String id, String name, UUID creator, String displayName, SkinData skin, org.bukkit.Location location, boolean showInTab, boolean spawnEntity, boolean collidable, boolean glowing, net.kyori.adventure.text.format.NamedTextColor glowingColor, org.bukkit.entity.EntityType type, Map<NpcEquipmentSlot,org.bukkit.inventory.ItemStack> equipment, boolean turnToPlayer, int turnToPlayerDistance, Consumer<org.bukkit.entity.Player> onClick, Map<ActionTrigger,List<NpcAction.NpcActionData>> actions, float interactionCooldown, float scale, int visibilityDistance, Map<NpcAttribute,String> attributes, boolean mirrorSkin)

### NpcData
public NpcData(String name, UUID creator, org.bukkit.Location location)
Creates a default npc with random id
```

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

### getTurnToPlayerDistance (FancyNpcsConfig)

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Gets the turn-to-player distance from FancyNpcsConfig.

```APIDOC
## getTurnToPlayerDistance()

### Description
Gets the turn-to-player distance from FancyNpcsConfig.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Double** (Double) - The turn-to-player distance.
```

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

### BlockUntilDoneAction Constructor

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/types/BlockUntilDoneAction.html

Initializes a new instance of the BlockUntilDoneAction class.

```APIDOC
## BlockUntilDoneAction()

### Description
Constructs a new BlockUntilDoneAction.

### Constructor
`public BlockUntilDoneAction()`
```

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

### NpcEquipmentSlot Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/utils/NpcEquipmentSlot.html

Provides methods to interact with the NpcEquipmentSlot enum.

```APIDOC
## Methods

### `static NpcEquipmentSlot[] values()`
Returns an array containing the constants of this enum class, in the order they are declared.

### `static NpcEquipmentSlot valueOf(String name)`
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:
- `name` (String) - The name of the enum constant to be returned.

Returns:
- The enum constant with the specified name.

Throws:
- `IllegalArgumentException`: If this enum class has no constant with the specified name.
- `NullPointerException`: If the argument is null.

### `static NpcEquipmentSlot parse(String s)`
Parses a string representation into an NpcEquipmentSlot.

### `String toNmsName()`
Converts the NpcEquipmentSlot to its NMS (Net Minecraft Server) name representation.
```

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

### getPossibleValues

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcAttribute.html

Gets the list of possible values for this NPC attribute.

```APIDOC
## getPossibleValues

### Description
Gets the list of possible values for this NPC attribute.

### Returns
- (List<String>) - A list of possible string values.
```

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

### NpcData Constructors

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcData.html

Provides details on how to create NpcData objects, either with a full set of properties or with basic initialization.

```APIDOC
## NpcData Constructors

### Full Constructor
```java
public NpcData(String id, String name, UUID creator, String displayName, SkinData skin, org.bukkit.Location location, boolean showInTab, boolean spawnEntity, boolean collidable, boolean glowing, net.kyori.adventure.text.format.NamedTextColor glowingColor, org.bukkit.entity.EntityType type, Map<NpcEquipmentSlot, org.bukkit.inventory.ItemStack> equipment, boolean turnToPlayer, int turnToPlayerDistance, Consumer<org.bukkit.entity.Player> onClick, Map<ActionTrigger, List<NpcAction.NpcActionData>> actions, float interactionCooldown, float scale, int visibilityDistance, Map<NpcAttribute, String> attributes, boolean mirrorSkin)
```

### Basic Constructor
```java
public NpcData(String name, UUID creator, org.bukkit.Location location)
```
Creates a default NPC with a random ID.
```

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

### Visibility Distance

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcData.html

Methods to get and set the visibility distance for an NPC.

```APIDOC
## getVisibilityDistance

### Description
Retrieves the current visibility distance of the NPC.

### Method
GET

### Endpoint
NpcData.getVisibilityDistance()

### Response
#### Success Response (200)
- **visibilityDistance** (int) - The visibility distance of the NPC.
```

```APIDOC
## setVisibilityDistance

### Description
Sets the visibility distance for the NPC.

### Method
SET

### Endpoint
NpcData.setVisibilityDistance(int visibilityDistance)

### Parameters
#### Path Parameters
- **visibilityDistance** (int) - Required - The new visibility distance for the NPC.
```

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

### Get All NPCs

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcManager.html

Retrieves a collection of all NPCs currently managed by the NpcManager.

```APIDOC
## getAllNpcs

### Description
Retrieves a collection of all NPCs managed by the NpcManager.

### Method Signature
`Collection<Npc> getAllNpcs()`
```

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

### getReason() Method

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/skins/SkinLoadException.html

Retrieves the specific reason why the skin loading failed. This method is useful for determining the cause of the exception and implementing appropriate error handling.

```APIDOC
## getReason() Method

### Description
Returns the reason why the skin could not be loaded.

### Returns
- **SkinLoadException.Reason** - The reason for the skin loading failure.
```

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

### runNext

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Executes the next action in the sequence.

```APIDOC
## runNext()

### Description
Executes the next action in the list of actions.

### Method
`runNext()`
```

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

### SkinManager Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Methods for fetching skins from various sources.

```APIDOC
## SkinManager

### Fetch Skin by File

**Method:** `getByFile(String filePath, SkinData.SkinVariant variant)`

**Description:** Fetch a skin by a file path pointing to a skin image (relative to plugins/FancyNPCs/skins).

### Fetch Skin by Identifier

**Method:** `getByIdentifier(String identifier, SkinData.SkinVariant variant)`

**Description:** Fetch a skin by its identifier and variant.

### Fetch Skin by URL

**Method:** `getByURL(String url, SkinData.SkinVariant variant)`

**Description:** Fetch a skin by a URL pointing to a skin image.

### Fetch Skin by Username

**Method:** `getByUsername(String username, SkinData.SkinVariant variant)`

**Description:** Fetch a skin by a username of a player.

### Fetch Skin by UUID

**Method:** `getByUUID(UUID uuid, SkinData.SkinVariant variant)`

**Description:** Fetch a skin by a UUID of a player.
```

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

### Get NPC Action by Name

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/ActionManager.html

Retrieves a specific NPC action by its unique name.

```APIDOC
## getActionByName

### Description
Retrieves an NPC action by its name.

### Method Signature
`NpcAction getActionByName(String name)`

### Parameters
* **name** (String) - The name of the NPC action to retrieve.

### Returns
* **NpcAction** - The NPC action associated with the given name, or null if not found.
```

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

### Fetch Skin by URL

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/skins/SkinManager.html

Fetches a skin using a URL pointing to the skin image.

```APIDOC
## getByURL

### Description
Fetch a skin by a URL pointing to a skin image.

### Method Signature
SkinData getByURL(String url, SkinData.SkinVariant variant)

### Parameters
* `url` (String) - The URL of the skin image.
* `variant` (SkinData.SkinVariant) - The desired skin variant (e.g., `SKIN`, `CAPE`).

### Returns
* `SkinData` - The skin data if cached, otherwise null. The skin will be fetched asynchronously.

### Event
Listen to `SkinGeneratedEvent` for asynchronous skin data.
```

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

### run(int)

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Executes the action at a specific index.

```APIDOC
## run(int)

### Description
Executes the action at the specified index within the list of actions.

### Method
`run(int index)`
```

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

### Get NPC by Name and Creator

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcManager.html

Retrieves an NPC by its name and the UUID of its creator. This is useful for disambiguating NPCs with the same name.

```APIDOC
## getNpc (by name and creator)

### Description
Retrieves an NPC by its name and the UUID of its creator.

### Method Signature
`Npc getNpc(String name, UUID creator)`

### Parameters
* **name** (String) - The name of the NPC.
* **creator** (UUID) - The UUID of the NPC's creator.
```

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

### NPC Creation and Spawning

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/Npc.html

Methods for creating and spawning NPCs.

```APIDOC
## create

### Description
Abstract method to create the NPC. This should be implemented by subclasses.

### Method
`public abstract void create()`

## spawn

### Description
Spawns the NPC for a specific player.

### Method
`public abstract void spawn(org.bukkit.entity.Player player)`

### Parameters
* **player** (org.bukkit.entity.Player) - The player for whom to spawn the NPC.

## spawnForAll

### Description
Spawns the NPC for all players.

### Method
`public void spawnForAll()`
```

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

### NpcModifyEvent.NpcModification Static Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/events/NpcModifyEvent.NpcModification.html

Provides static methods for interacting with the NpcModification enum, such as retrieving constants by name or getting all constants.

```APIDOC
## Method Summary

Modifier and Type | Method | Description
---|---|---
`static NpcModifyEvent.NpcModification` | `valueOf(String name)` | Returns the enum constant of this class with the specified name.
`static NpcModifyEvent.NpcModification[]` | `values()` | Returns an array containing the constants of this enum class, in the order they are declared.
```

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

### Create Interval for current time

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/utils/Interval.html

Creates an Interval object representing the current time. This is a convenient way to get an interval for immediate use.

```java
Interval.now()
```

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

### Status and Information Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/executor/ActionExecutionContext.html

Methods to check the status and retrieve information about the action execution context.

```APIDOC
## Status and Information Methods

### hasNext()
Checks if there are more actions to be executed.

**Returns:**
* `boolean` - true if there are more actions to be executed, false otherwise

### isTerminated()
Checks if the action sequence has been terminated.

**Returns:**
* `boolean` - true if the action index is -1, indicating the sequence is terminated; false otherwise

### shouldBlockUntilDone()

**Returns:**
* `boolean`

### getTrigger()

**Returns:**
* `ActionTrigger`

### getNpc()

**Returns:**
* `Npc`

### getActions()

**Returns:**
* `List<NpcAction.NpcActionData>`

### getPlayerUUID()

**Returns:**
* `UUID`

### getPlayer()

**Returns:**
* `org.bukkit.entity.Player` (nullable)

### getActionIndex()

**Returns:**
* `int`
```

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

### Get NPC by Name

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcManager.html

Retrieves an NPC using its name. If multiple NPCs share the same name, this method might return one of them or behave unpredictably depending on the implementation.

```APIDOC
## getNpc (by name)

### Description
Retrieves an NPC by its name.

### Method Signature
`Npc getNpc(String name)`

### Parameters
* **name** (String) - The name of the NPC.
```

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

### execute Method

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/NpcAction.html

Abstract method to be implemented by subclasses to define the action's behavior.

```APIDOC
## execute Method

### Description
Executes the action associated with this NpcAction. This is an abstract method that must be implemented by subclasses.

### Signature
`public abstract void execute(@NotNull ActionExecutionContext context, @Nullable String value)`

### Parameters
* **context** (@NotNull ActionExecutionContext) - The context in which the action is being executed.
* **value** (@Nullable String) - The value associated with the action. Can be null if no value is required.
```

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

### SkinLoadException Constructor

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/skins/SkinLoadException.html

Constructs a new SkinLoadException with the specified reason and message. This exception is thrown when a skin cannot be fetched or loaded.

```APIDOC
## SkinLoadException Constructor

### Description
Constructs a new SkinLoadException with the specified reason and message.

### Parameters
- **reason** (SkinLoadException.Reason) - Required - The reason why the skin could not be loaded.
- **message** (String) - Required - A detailed message explaining the error.
```

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

### Get NPC by Entity ID

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcManager.html

Retrieves an NPC using its unique entity ID. Note: This method is marked as internal and may not be intended for direct external use.

```APIDOC
## getNpc (by entityId)

### Description
Retrieves an NPC by its entity ID. This method is marked as internal.

### Method Signature
`@Internal Npc getNpc(int entityId)`

### Parameters
* **entityId** (int) - The unique entity ID of the NPC.
```

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

### BlockUntilDoneAction execute Method

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/types/BlockUntilDoneAction.html

Executes the action associated with this NpcAction. This method is intended to be overridden by subclasses to provide specific action logic. For BlockUntilDoneAction, it signifies the start of a blocking operation.

```APIDOC
## execute(ActionExecutionContext context, String value)

### Description
Executes the action associated with this NpcAction. This method is inherited from `NpcAction` and is implemented here to represent a blocking action.

### Method
`public void execute(ActionExecutionContext context, String value)`

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* None

### Parameters
- **context** (`ActionExecutionContext`) - The context in which the action is being executed.
- **value** (`String`) - The value associated with the action. Can be null if no value is required.
```

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

### Fetch Skin by UUID

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/skins/SkinManager.html

Fetches a skin using the UUID of a player.

```APIDOC
## getByUUID

### Description
Fetch a skin by a UUID of a player.

### Method Signature
SkinData getByUUID(UUID uuid, SkinData.SkinVariant variant)

### Parameters
* `uuid` (UUID) - The UUID of the player.
* `variant` (SkinData.SkinVariant) - The desired skin variant (e.g., `SKIN`, `CAPE`).

### Returns
* `SkinData` - The skin data if cached, otherwise null. The skin will be fetched asynchronously.

### Event
Listen to `SkinGeneratedEvent` for asynchronous skin data.
```

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

### NpcData.addEquipment()

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Adds equipment to the NPC's data.

```APIDOC
## addEquipment(NpcEquipmentSlot, ItemStack)

### Description
Adds an ItemStack to a specific equipment slot for the NPC.

### Method
Instance Method

### Endpoint
N/A

### Parameters
- **slot** (NpcEquipmentSlot) - Required - The equipment slot to add the item to.
- **itemStack** (ItemStack) - Required - The ItemStack to add.

### Request Example
None

### Response
#### Success Response (N/A)
Void (operation modifies NpcData in place).
```

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

### PacketReceivedEvent Handler Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/events/PacketReceivedEvent.html

Static and instance methods for handling events.

```APIDOC
## PacketReceivedEvent Handler Methods

### getHandlerList

#### Description
Returns the list of handlers for this event.

#### Returns
* org.bukkit.event.HandlerList - The handler list.
```

```APIDOC
### getHandlers

#### Description
Returns the handler list for this event.

#### Returns
* @NotNull org.bukkit.event.HandlerList - The handler list.
```

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

### Fetch Skin by Identifier

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/skins/SkinManager.html

Fetches a skin using a general identifier, which can be a UUID, username, URL, or file path.

```APIDOC
## getByIdentifier

### Description
Fetch a skin by its identifier and variant.

### Method Signature
SkinData getByIdentifier(String identifier, SkinData.SkinVariant variant)

### Parameters
* `identifier` (String) - Either a valid UUID, username, URL, or file path.
* `variant` (SkinData.SkinVariant) - The desired skin variant (e.g., `SKIN`, `CAPE`).

### Returns
* `SkinData` - The skin data if cached, otherwise null. The skin will be fetched asynchronously.

### Event
Listen to `SkinGeneratedEvent` for asynchronous skin data.
```

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

### Interval.Unit Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/utils/Interval.Unit.html

This section details the methods available for the Interval.Unit enum.

```APIDOC
## Method Summary

### `static Interval.Unit` values()
Returns an array containing the constants of this enum class, in the order they are declared.

### `static Interval.Unit` valueOf(String name)
Returns the enum constant of this class with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:
    `name` - the name of the enum constant to be returned.

Returns:
    the enum constant with the specified name

Throws:
    `IllegalArgumentException` - if this enum class has no constant with the specified name
    `NullPointerException` - if the argument is null

### `static @Nullable Interval.Unit` fromShortCode(@NotNull String shortCode)
Returns `Interval.Unit` or `null` from provided short code.

### `long` getFactor()
Returns the factor associated with the time unit.

### `@NotNull String` getShortCode()
Returns the short code representation of the time unit.
```

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

### SkinLoadException

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Exception thrown when a skin fails to load. Provides the reason for the failure.

```APIDOC
## getReason()

### Description
Returns the reason why the skin could not be loaded.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
None

### Response
- reason (String): The detailed reason for the skin load failure.
```

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

### Configuration Getters

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/FancyNpcsConfig.html

Methods to retrieve current configuration values for various FancyNpcs features.

```APIDOC
## Method Summary

`int`
`getAutoSaveInterval()`
`List<String>`
`getBlockedCommands()`
`Map<String,Integer>`
`getMaxNpcsPerPermission()`
`String`
`getMineSkinApiKey()`
`int`
`getNpcUpdateInterval()`
`int`
`getNpcUpdateVisibilityInterval()`
`int`
`getRemoveNpcsFromPlayerlistDelay()`
`int`
`getTurnToPlayerDistance()`
`int`
`getVisibilityDistance()`

## Method Details

### getAutoSaveInterval

`int getAutoSaveInterval()`

### getNpcUpdateInterval

`int getNpcUpdateInterval()`

### getNpcUpdateVisibilityInterval

`int getNpcUpdateVisibilityInterval()`

### getTurnToPlayerDistance

`int getTurnToPlayerDistance()`

### getVisibilityDistance

`int getVisibilityDistance()`

### getRemoveNpcsFromPlayerlistDelay

`int getRemoveNpcsFromPlayerlistDelay()`

### getMineSkinApiKey

`String getMineSkinApiKey()`

### getBlockedCommands

`List<String> getBlockedCommands()`

### getMaxNpcsPerPermission

`Map<String,Integer> getMaxNpcsPerPermission()`
```

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

### ActionExecutionContext

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Provides context for executing NPC actions, including the NPC, player, and player UUID.

```APIDOC
## getNpc()

### Description
Retrieves the NPC associated with the action execution context.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
None

### Response
- npc (Npc): The NPC object.
```

```APIDOC
## getPlayer()

### Description
Retrieves the player associated with the action execution context.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
None

### Response
- player (Player): The player object.
```

```APIDOC
## getPlayerUUID()

### Description
Retrieves the UUID of the player associated with the action execution context.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
None

### Response
- playerUUID (UUID): The UUID of the player.
```

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

### SkinData Constructors

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/skins/SkinData.html

Constructors for creating SkinData objects.

```APIDOC
## SkinData Constructors

### SkinData(String identifier, SkinData.SkinVariant variant)

Creates a SkinData object with an identifier and variant.

### SkinData(String identifier, SkinData.SkinVariant variant, String textureValue, String textureSignature)

Creates a SkinData object with an identifier, variant, texture value, and texture signature.
```

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

### Configuration Booleans

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/FancyNpcsConfig.html

Methods to check the status of boolean configuration options for FancyNpcs.

```APIDOC
## Method Summary

`boolean`
`isEnableAutoSave()`
`boolean`
`isInteractionCooldownMessageDisabled()`
`boolean`
`isMuteVersionNotification()`
`boolean`
`isSkipInvisibleNpcs()`
`boolean`
`isTurnToPlayerResetToInitialDirection()`

## Method Details

### isSkipInvisibleNpcs

`boolean isSkipInvisibleNpcs()`

### isInteractionCooldownMessageDisabled

`boolean isInteractionCooldownMessageDisabled()`

### isMuteVersionNotification

`boolean isMuteVersionNotification()`

### isEnableAutoSave

`boolean isEnableAutoSave()`

### isTurnToPlayerResetToInitialDirection

`boolean isTurnToPlayerResetToInitialDirection()`
```

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

### Is Loaded

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcManager.html

Checks if the NpcManager has finished loading all necessary NPC data.

```APIDOC
## isLoaded

### Description
Checks if the NpcManager has finished loading NPC data.

### Method Signature
`boolean isLoaded()`

### Returns
`true` if NPCs are loaded, `false` otherwise.
```

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

### NpcManager

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Interface for managing all NPCs within the server.

```APIDOC
## isLoaded()

### Description
Checks if the NPC manager has finished loading all NPCs.

### Method
`isLoaded()`

### Interface
de.oliver.fancynpcs.api.NpcManager
```

```APIDOC
## loadNpcs()

### Description
Initiates the loading process for all NPCs.

### Method
`loadNpcs()`

### Interface
de.oliver.fancynpcs.api.NpcManager
```

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

### Interval Utility Class

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Utility class for managing time intervals, with static methods to create Interval objects.

```APIDOC
## Class Interval

### Static Methods

#### now()

Returns `Interval` object of current time.

#### of(double interval, Interval.Unit unit)

Returns `Interval` object constructed from provided `double` `(interval)`.

#### of(long interval, Interval.Unit unit)

Returns `Interval` object constructed from provided `long` `(interval)`.
```

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

### Fetch Skin by Username

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/skins/SkinManager.html

Fetches a skin using the username of a player.

```APIDOC
## getByUsername

### Description
Fetch a skin by a username of a player.

### Method Signature
SkinData getByUsername(String username, SkinData.SkinVariant variant)

### Parameters
* `username` (String) - The username of the player.
* `variant` (SkinData.SkinVariant) - The desired skin variant (e.g., `SKIN`, `CAPE`).

### Returns
* `SkinData` - The skin data if cached, otherwise null. The skin will be fetched asynchronously.

### Event
Listen to `SkinGeneratedEvent` for asynchronous skin data.
```

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

### ExecuteRandomActionAction constructor

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Constructs a new instance of the ExecuteRandomActionAction class.

```APIDOC
## ExecuteRandomActionAction()

### Description
Initializes a new instance of the ExecuteRandomActionAction, used for creating actions that trigger other actions randomly.

### Constructor
Constructor

### Class
de.oliver.fancynpcs.api.actions.types.ExecuteRandomActionAction
```

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

### ConsoleCommandAction.execute

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/types/ConsoleCommandAction.html

Executes the console command action for an NPC. The command string can include placeholders like {player} which will be dynamically replaced.

```APIDOC
## execute

### Description
Executes the console command action for an NPC.

### Method Signature
`void execute(ActionExecutionContext context, String value)`

### Parameters
* `context` (ActionExecutionContext) - Required - The context in which the action is being executed.
* `value` (String) - Required - The command string to be executed. Can contain the placeholder "{player}" which will be replaced with the player's name.
```

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

### Interval Conversion and Manipulation

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/utils/Interval.html

Methods for converting intervals to different units, adding or removing time, and formatting.

```APIDOC
## Instance Methods for Interval Operations

### `as(Interval.Unit unit)`
Converts the current `Interval` to the specified `Interval.Unit` and returns the value as a `double`.

Example:
```java
 Interval.of(1500, Interval.Unit.MILLISECONDS).as(Interval.Unit.SECONDS) // Returns 1.5
 Interval.of(300, Interval.Unit.SECONDS).as(Interval.Unit.MINUTES) // Returns 5.0
```

### `add(Interval other)`
Returns a new `Interval` object that is the result of adding another `Interval` (`other`) to the current `Interval`.

### `add(long n, Interval.Unit unit)`
Returns a new `Interval` object with `n` units added to the current `Interval`.

### `remove(Interval other)`
Returns a new `Interval` object that is the result of subtracting another `Interval` (`other`) from the current `Interval`.

### `remove(long n, Interval.Unit unit)`
Returns a new `Interval` object with `n` units removed from the current `Interval`.

### `toDate()`
Converts the `Interval` to a `java.util.Date` object.

### `toInstant()`
Converts the `Interval` to a `java.time.Instant` object.

### `toString()`
Returns a formatted `String` representation of the `Interval`, typically expressing elapsed time.

Example:
```java
 final Interval i = Interval.between(lastJoinedMillis, currentTimeMillis, Interval.Unit.MILLISECONDS);
 System.out.println(i.toString() + " ago"); // e.g., '1d 7h 32min 10s ago'
```
```

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

### NpcAction Constructor

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/NpcAction.html

Initializes a new NpcAction with a given name and a flag indicating if it requires a value.

```APIDOC
## NpcAction Constructor

### Description
Initializes a new NpcAction with a given name and a flag indicating if it requires a value.

### Signature
`public NpcAction(String name, boolean requiresValue)`

### Parameters
* **name** (String) - The name of the action.
* **requiresValue** (boolean) - True if the action requires a value, false otherwise.
```

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

### PlaySoundAction execute method

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Executes the play sound action for an NPC.

```APIDOC
## execute(ActionExecutionContext, String)

### Description
Plays a specified sound effect associated with the NPC's action.

### Method
Method

### Class
de.oliver.fancynpcs.api.actions.types.PlaySoundAction
```

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

### Interval Creation

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/utils/Interval.html

Static methods to create Interval objects from current time, specific values, or time differences.

```APIDOC
## Static Methods for Interval Creation

### `now()`
Returns an `Interval` object representing the current time.

### `of(long interval, Interval.Unit unit)`
Constructs an `Interval` object from a provided `long` value representing a time difference in the specified `unit`.

### `of(double interval, Interval.Unit unit)`
Constructs an `Interval` object from a provided `double` value representing a time difference in the specified `unit`.

### `between(long n, long m, Interval.Unit unit)`
Calculates and returns an `Interval` representing the time difference between two `long` timestamps `n` and `m` in the specified `unit`.

### `between(double n, double m, Interval.Unit unit)`
Calculates and returns an `Interval` representing the time difference between two `double` timestamps `n` and `m` in the specified `unit`.
```

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

### PacketReceivedEvent Constructor

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/events/PacketReceivedEvent.html

Constructs a new PacketReceivedEvent with the given packet and player.

```APIDOC
## PacketReceivedEvent Constructor

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

### Parameters
* **packet** (Object) - The received network packet.
* **player** (org.bukkit.entity.Player) - The player who received the packet.
```

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

### Skin Mirroring

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcData.html

Methods to check and set whether the NPC's skin should be mirrored.

```APIDOC
## isMirrorSkin

### Description
Checks if the NPC's skin mirroring is enabled.

### Method
GET

### Endpoint
NpcData.isMirrorSkin()

### Response
#### Success Response (200)
- **mirrorSkin** (boolean) - True if skin mirroring is enabled, false otherwise.
```

```APIDOC
## setMirrorSkin

### Description
Sets whether the NPC's skin should be mirrored.

### Method
SET

### Endpoint
NpcData.setMirrorSkin(boolean mirrorSkin)

### Parameters
#### Path Parameters
- **mirrorSkin** (boolean) - Required - True to enable skin mirroring, false to disable.
```

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

### Execute Action

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/executor/ActionExecutor.html

Executes a given action for an NPC based on a trigger and the interacting player.

```APIDOC
## execute

### Description
Executes a given action for an NPC based on a trigger and the interacting player.

### Method
```java
public static void execute(ActionTrigger trigger, Npc npc, org.bukkit.entity.Player player)
```

### Parameters
* **trigger** (ActionTrigger) - The trigger that initiates the action.
* **npc** (Npc) - The NPC for which the action is to be executed.
* **player** (org.bukkit.entity.Player) - The player interacting with the NPC.
```

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

### Npc.move() Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Methods to move an NPC.

```APIDOC
## Npc.move()

### Description
Methods to move an NPC.

### Methods
- `move(Player player)`: Moves the NPC.
- `move(Player player, boolean force)`: Moves the NPC with an option to force the movement.
```

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

### ConsoleCommandAction execute method

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Executes the console command action for an NPC.

```APIDOC
## execute(ActionExecutionContext, String)

### Description
Executes a console command as defined by the NPC's action configuration.

### Method
Method

### Class
de.oliver.fancynpcs.api.actions.types.ConsoleCommandAction
```

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

### apply

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/NpcAttribute.html

Applies the attribute to the given NPC with the specified value.

```APIDOC
## apply

### Description
Applies this attribute to the given NPC with the specified value.

### Parameters
- **npc** (Npc) - The NPC to apply the attribute to.
- **value** (String) - The value to apply.
```

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

### PlayerCommandAction - execute method

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/types/PlayerCommandAction.html

This method is responsible for executing a player command action. It is called when an NPC interaction triggers this action, and it processes the command using the provided context and value.

```APIDOC
## execute

### Description
Executes a player command action when triggered by an NPC interaction.

### Method Signature
`public void execute(@NotNull ActionExecutionContext context, String value)`

### Parameters
* `context` (@NotNull ActionExecutionContext) - The context in which the action is being executed.
* `value` (String) - The value associated with the action. Can be null if no value is required.

### Overrides
`execute` in class `NpcAction`
```

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

### Action Execution Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/executor/ActionExecutionContext.html

Methods for controlling the execution flow of NPC actions.

```APIDOC
## Action Execution Methods

### run(int index)
Executes the action at the specified index within the list of actions.

**Parameters:**
* `index` (int) - the index of the action to be executed. If the index is out of bounds, the method returns immediately.

### runNext()
Executes the next action in the list of actions. If the current action index is out of bounds, the method returns immediately. The action index is incremented after the action is executed.

### reset()
Resets the current action index to its initial state. This is useful for re-running the sequence of actions from the beginning.

### terminate()
Terminates the current action sequence by setting the action index to -1. This effectively marks the context as finished and prevents any further actions from being executed.
```

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

### Npc Class Methods

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/Npc.html

This section details the various methods available to interact with and manage NPCs.

```APIDOC
## checkAndUpdateVisibility

### Description
Checks and updates the visibility status of the NPC for a specific player.

### Method
`void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player for whom to check visibility.

## create

### Description
Creates the NPC. This method should be called after initialization.

### Method
`abstract void`

## getData

### Description
Retrieves the NpcData associated with this NPC.

### Method
`NpcData`

## getEntityId

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

### Method
`abstract int`

## getEyeHeight

### Description
Gets the eye height of the NPC.

### Method
`abstract float`

## getIsLookingAtPlayer

### Description
Retrieves a map indicating which players the NPC is currently looking at.

### Method
`Map<UUID,Boolean>`

## getIsTeamCreated

### Description
Retrieves a map indicating which players have had the NPC's team created for them.

### Method
`Map<UUID,Boolean>`

## getIsVisibleForPlayer

### Description
Retrieves a map indicating which players the NPC is currently visible to.

### Method
`Map<UUID,Boolean>`

## getLastPlayerInteraction

### Description
Retrieves a map containing the last interaction time for each player with the NPC.

### Method
`Map<UUID,Long>`

## interact

### Description
Handles player interaction with the NPC.

### Method
`void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player interacting with the NPC.

## interact

### Description
Handles player interaction with the NPC, triggered by a specific action.

### Method
`void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player interacting with the NPC.
- `actionTrigger` (ActionTrigger) - The trigger for the interaction.

## isDirty

### Description
Checks if the NPC's data has been modified and needs saving.

### Method
`boolean`

## isSaveToFile

### Description
Checks if the NPC is configured to be saved to a file.

### Method
`boolean`

## lookAt

### Description
Makes the NPC look at a specific player at a given location.

### Method
`abstract void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player to look at.
- `location` (org.bukkit.Location) - The location the NPC should look towards.

## move

### Description
Triggers the NPC to move for a specific player.

### Method
`void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player for whom the NPC should move.

## move

### Description
Triggers the NPC to move for a specific player, with an option to swing their arm.

### Method
`abstract void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player for whom the NPC should move.
- `swingArm` (boolean) - Whether the NPC should swing its arm during movement.

## moveForAll

### Description
Triggers the NPC to move for all players.

### Method
`void`

## moveForAll

### Description
Triggers the NPC to move for all players, with an option to swing their arm.

### Method
`void`

### Parameters
- `swingArm` (boolean) - Whether the NPC should swing its arm during movement.

## refreshEntityData

### Description
Refreshes the entity data for the NPC, typically for a specific server player.

### Method
`protected abstract void`

### Parameters
- `serverPlayer` (org.bukkit.entity.Player) - The server player for whom to refresh entity data.

## remove

### Description
Removes the NPC for a specific player.

### Method
`abstract void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player for whom to remove the NPC.

## removeForAll

### Description
Removes the NPC for all players.

### Method
`void`

## setDirty

### Description
Sets the dirty flag for the NPC, indicating if its data has been modified.

### Method
`void`

### Parameters
- `dirty` (boolean) - The new dirty status.

## setSaveToFile

### Description
Sets whether the NPC should be saved to a file.

### Method
`void`

### Parameters
- `saveToFile` (boolean) - The new save to file status.

## shouldBeVisible

### Description
Checks if the NPC should be visible for the player.

### Method
`protected boolean`

### Parameters
- `player` (org.bukkit.entity.Player) - The player to check visibility for.

## spawn

### Description
Spawns the NPC for a specific player.

### Method
`abstract void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player for whom to spawn the NPC.

## spawnForAll

### Description
Spawns the NPC for all players.

### Method
`void`

## update

### Description
Updates the NPC for a specific player.

### Method
`void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player for whom to update the NPC.

## update

### Description
Updates the NPC for a specific player, with an option to swing their arm.

### Method
`abstract void`

### Parameters
- `player` (org.bukkit.entity.Player) - The player for whom to update the NPC.
- `swingArm` (boolean) - Whether the NPC should swing its arm during the update.

## updateForAll

### Description
Updates the NPC for all players.

### Method
`void`

## updateForAll

### Description
Updates the NPC for all players, with an option to swing their arm.

### Method
`void`

### Parameters
- `swingArm` (boolean) - Whether the NPC should swing its arm during the update.
```

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

### PlaySoundAction execute method

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/de/oliver/fancynpcs/api/actions/types/PlaySoundAction.html

This method executes the sound-playing action for an NPC. It takes an ActionExecutionContext and a String value, which represents the sound to be played.

```APIDOC
## execute

### Description
Executes the action associated with this NpcAction. This method is intended to play a sound for an NPC.

### Method Signature
`public void execute(@NotNull ActionExecutionContext context, String value)`

### Parameters
* `context` (ActionExecutionContext) - Required - The context in which the action is being executed.
* `value` (String) - Optional - The value associated with the action, typically representing the sound to be played. Can be null if no value is required.
```

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

### NpcCreateEvent Class

Source: https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/2.8.0/raw/index-all.html

Event fired when a new NPC is being created.

```APIDOC
## Class NpcCreateEvent

### Constructors

#### NpcCreateEvent(Npc npc, CommandSender sender)

Constructs an NpcCreateEvent.
```
Tokens:
Raw