Skip to main content

Dungeon Enter

Action entry that creates a dungeon instance and teleports the player inside. Can be triggered from commands, NPCs, or other entries.

Configuration

dungeon_enterMap

Configuration for the dungeon enter action.

Properties

dungeonInstance

"> Target dungeon instance to enter. joinMessage

"> Message shown when successfully joining the dungeon. Supports PlaceholderAPI. maxReachedMessage

"> Message shown when the maximum simultaneous instances limit is reached. errorMessage

"> Message shown when the dungeon entry fails (e.g., instance not found).

Behavior

  1. Checks maxSimultaneousInstances — if the limit is reached, shows maxReachedMessage and aborts.
  2. Creates a new dungeon instance via DungeonInstanceService.
  3. Teleports the player to the configured spawnPoint from the Room Config.
  4. Sends joinMessage on success.

Example

action:
type: dungeon_enter
id: "enter_temple"
dungeonInstance: "ancient_temple"
joinMessage: "<green>Entering Ancient Temple...</green>"
maxReachedMessage: "<red>All instances are currently in use!</red>"
errorMessage: "<red>Could not enter the dungeon.</red>"