PLUGIN Skript Support

Skript Support

To use this plugin’s events in Skript, you need Skript-Reflect

---

Basic usage

import:
  de.eisi05.npc.api.events.<EventName>

on <EventName>:
    # your code here

Replace <EventName> with one of the events listed below.

---

Available Events

---

NpcHideEvent

Triggered after an NPC is hidden from a player.

Available values:

• event.getNpc() → NPC
• event.getPlayer() → Player

---

NpcInteractEvent

Triggered when a player interacts with an NPC.

Available values:

• event.getNpc() → NPC
• event.getPlayer() → Player
• event.getAction() → ClickActionType (LEFT / RIGHT)
• event.isCancelled() → boolean

---

NpcPostShowEvent

Called after an NPC is fully visible to a player.

Note: This event cannot be cancelled.

Available values:

• event.getNpc() → NPC
• event.getPlayer() → Player
• event.wasViewer() → boolean (true if the player already saw this NPC before)

---

NpcPreShowEvent

Called before an NPC is shown to a player.

Note: This event can be cancelled.

Available values:

• event.getNpc() → NPC
• event.getPlayer() → Player
• event.wasViewer() → boolean
• event.isCancelled() → boolean

---

NpcStartWalkingEvent

Called before an NPC starts walking along a path.

Available values:

• event.getNpc() → NPC
• event.getPath() → Path
• event.getWalkSpeed() → double
• event.isChangeRealLocation() → boolean (whether real NPC location will update)
• event.isCancelled() → boolean

---

NpcStopWalkingEvent

Called after an NPC stops walking.

Available values:

• event.getNpc() → NPC
• event.getWalkingResult() → WalkingResult (SUCCESS / CANCELLED)
• event.changeRealLocation() → boolean (whether final position should be applied)

---

Example

You can also directly access Java methods inside Skript like this:

import:
  de.eisi05.npc.api.events.NpcInteractEvent

on NpcInteractEvent:
    set {_player} to event.getPlayer()
    send "Triggered!" to {_player}

---

Additional Resources

For more information about Skript-Reflect syntax and features, visit:
https://tpgamesnl.gitbook.io/skript-reflect/basics