Wikis / MythicDungeons / Functions

Functions

Functions perform various actions and events in the dungeon. To those familiar with Mythic Mobs, these are similar to mechanics. This includes spawning mobs, sending messages, playing sounds, running commands, and even performing Mythic skills!

Common Function Options

All functions have a set of configurable options when you create or edit them. Common options that are seen across many different functions are listed here. Their default values are often different depending on the function in question.

BACK
Applies to all functions. Returns to the previous hotbar menu.
Trigger: [Trigger Name]
Applies to all functions. Opens the trigger's hotbar menu. Reads NONE if the function has no trigger, and clicking it in that state only prints a warning. Most functions are given the Dungeon Start trigger automatically if you leave the trigger picker without choosing one. Allow Block Place/Break and Door Controller are the exceptions and are allowed to run without a trigger.
Target Type
Only available on select functions. Cycles through target options. The full list, in cycle order, is: NONE, PLAYER, PARTY, ROOM.
NONE - The function targets nobody. (Skipped if the function requires a target.)
PLAYER - If the trigger was activated by a specific player, the function targets that player. (Skipped if the selected trigger doesn't have a player associated with it.)
PARTY - Targets every party member who is still inside the instance. If the triggering player isn't in a party, only that player is targeted. If the trigger has no player at all, the function targets everyone in the instance and the button relabels itself ALL PLAYERS.
ROOM - Targets every player standing inside the room this function was placed in. (Procedural dungeons only; skipped everywhere else.)

Functions that hide this button always use their built-in target type: Signal Sender, Player Reviver, Dungeon Status, Dungeon Difficulty, Mob Spawner, NPC Spawner, Place Redstone Block, Door Controller, Allow Block Place/Break, Hologram, Moving Block, Moving Block Cluster, Mythic Signal, Function Repeater, Dungeon Variable, and Room Door Controller. Note that Hologram only hides it while it is freshly placed; after the dungeon is saved and reloaded the button reappears, but the value it sets is ignored.

Functions List

Every function's own options are documented below the table, under Function Options.

Name	Category	Description
Start Dungeon	Dungeon	Starts the dungeon. Required if your dungeon has a lobby!
Finish Dungeon	Dungeon	RECOMMENDED Formally finishes the dungeon for the player or players.
Leave Dungeon	Dungeon	Sends the player or players out of the dungeon without completing it.
Respawn Checkpoint	Dungeon	Sets a respawn checkpoint for the player or players.
Signal Sender	Dungeon	Broadcasts a silent, configured signal to all "Signal Receiver" triggers.
Lives Editor	Dungeon	Modifies the player or players lives.
Player Reviver	Dungeon	Allows bringing another player back from death.
Chunk Loader	Dungeon	When triggered, force-loads the chunk this function is in, plus an optional radius of chunks around it. Trigger again to release them.
Dungeon Status	Dungeon	Sets the dungeons "status" to a configurable text. Similar to Mythic Mobs stances.
Dungeon Difficulty	Dungeon	Allows changing the difficulty of the dungeon on the fly.
Message Sender	Player	Sends a configured message to the player or players.
Teleporter	Player	Teleports the player or players to a configured location.
Title Sender	Player	Sends a configured title message to the player or players.
Boss Bar	Player	Shows a boss bar to the target player(s) with a configurable title, colour, style, and progress. Progress can follow a dungeon variable or a placeholder. Triggering it toggles the bar on or off.
Item Dispenser	Player	Gives or drops a configured item at the function's location.
Key Dispenser	Player	Gives one player a configured key item. Defaults to a dungeon key item. Note: Similar to Item Dispenser, however it reports a key being found to the players and gives the key to the party leader if the function is set to target the party.
Rewards	Player	Opens a rewards inventory the player can take items from.
Random Rewards	Player	Opens a rewards inventory that randomizes its contents.
Loot Table Rewards	Player	Opens a rewards inventory that randomizes its contents based on a loot table. With MythicMobs installed it accepts a MythicMobs drop table name as well.
Mob Spawner	Location	Spawns configured mobs at the function's location.
NPC Spawner	Location	Spawns configured NPC at the function's location. Only available with Citizens installed. Experimental feature! Stable, but not reliable as of yet!
Block Editor	Location	Places or removes a block at the function's location.
Sound Player	Location	Plays a configured sound.
Place Redstone Block	Location	Places a redstone block at the function's location.
Door Controller	Location	Makes a door lockable and unlockable with triggers.
Allow Block Place/Break	Location	Allows placing or breaking blocks, and optionally using buckets, at the function's location. Only takes effect once it has been triggered.
Hologram	Location	(1.3.0+) Displays a text hologram at a specified location.
Moving Block	Location	Turns the block at this location into a moving block, which can be configured to slowly move somewhere else when triggered.
Moving Block Cluster	Location	Turns a group of blocks into a group of moving blocks. Works similarly to moving block, but allows selecting many blocks.
Room Door Controller	Room	(Procedural dungeons only) Opens, closes, or toggles named doors in the room this function is placed in. Pairs with the Room Door trigger and the `roomdoor` mythic mechanic.
Mythic Skill	Meta	Executes a Mythic Skill from the function's location.
Mythic Signal	Meta	Sends a Mythic Mobs signal to nearby mobs. (For use with the ~onSignal MM trigger.)
Command Sender	Meta	Sends a command either from the player/players or console.
Multi-Function	Meta	Allows running multiple functions at the same location and from the same trigger.
Function Repeater	Meta	Runs a function a configured number of times on an interval.
Delayed Function	Meta	Runs a function after a specified number of ticks have passed.
Function Randomizer	Meta	Randomly chooses from a list of functions provided to run.
Function Sequencer	Meta	Runs a list of functions one at a time in order each time it's triggered.
Conditional Function	Meta	Checks its own conditions when triggered, then runs its THEN functions if they pass or its ELSE functions if they don't.
Dungeon Variable	Meta	Sets, adds to, or subtracts from an instance-scoped variable. Best used with the Variable Comparison condition. Variables can be used in message senders with the following format: `[my_variable_here]`. Also readable from Mythic skills via `<dungeon.var.X>`. See Variables.
Player Variable	Meta	Sets, adds to, or subtracts from a variable scoped to each target player. Optionally persists between dungeon runs. Read it back with the Player Variable Comparison condition.

Function Options

Each function's own options, in the order they appear on the hotbar. Defaults are what a freshly placed function starts with.

Dungeon

Start Dungeon

No options. If the trigger fires with more than one target at once the dungeon starts immediately; otherwise every player in the instance has to trigger it before it starts.

Finish Dungeon

Leave Dungeon - ENABLED by default. When on, the player is sent to the dungeon's exit location after finishing. Turn it off to keep them inside.

Leave Dungeon

No options.

Respawn Checkpoint

Player Direction - Sets the direction players face when they respawn here to the direction you are currently looking. Default 0 yaw / 0 pitch.
Use as Save Point - DISABLED by default. When on, a player who leaves without finishing will start here next time. Ignored in procedural dungeons.

Signal Sender

Signal Name - Default trigger. The name Signal Receiver triggers listen for.
Signal Range - Default 0, meaning infinite. Distance in blocks the signal reaches.

Lives Editor

Set Lives - Default 1. The amount used by the change mode below.
Set Lives Change Mode - Cycles ADD (default), SET, MULTIPLY.

Requires PlayerLives to be 1 or more in the dungeon config; otherwise the function logs a warning and does nothing. Changes that would take a player to 0 lives or below are ignored.

Player Reviver

Max Revives - Default 1. 0 means unlimited.
Lives After Revival - Default 1. Minimum 1.

Chunk Loader

Radius - Default 0, meaning just the chunk the function is in. Otherwise force-loads a square of chunks with this radius around it.

Triggering it again releases the chunks. All chunks it holds are released when the instance shuts down.

Dungeon Status

Set Status - No default. Free text; read back with the Dungeon Status condition.

Dungeon Difficulty

Set Difficulty - No default. Must match one of the difficulty level names in the dungeon config. Unknown names are ignored.

Player

Message Sender

Message Type - Cycles CHAT (default) and ACTION_BAR.
Edit Message - Default DEFAULT. Supports colour codes, PlaceholderAPI placeholders, and [dungeon_variable] substitution.

Teleporter

Set Location - No default; the function logs an error when the dungeon loads and does nothing until set. Click once to see the current target (marked with particles), click again to store the spot you are standing on. The prompt times out after 10 seconds.

This function always requires a target, so NONE is not selectable.

Title Sender

Edit Title - Default " " (a single space).
Edit Subtitle - Default " ".
Duration - Default 80 ticks.
Fade-In Ticks - Default 10.
Fade-Out Ticks - Default 10.

Title and subtitle both support PlaceholderAPI and [dungeon_variable] substitution.

Boss Bar

Title - Default &fBoss Bar. Supports colour codes, PlaceholderAPI, and [dungeon_variable] substitution.
Color - Cycles Bukkit's bar colours. Default RED.
Style - Cycles Bukkit's bar styles. Default SOLID.
Progress Source - Empty by default. A variable or placeholder that drives the bar fill, for example [boss_hp] or %md_dungeon_time_left_seconds%. Type clear to go back to the fixed value.
Fixed Progress - Default 1.0. Used when no progress source is set, or when the source doesn't resolve to a number. Clamped to 0.0-1.0.
Source Is Percent - DISABLED by default, meaning the source is read as 0.0-1.0. Turn it on if your source produces 0-100.
Visible by Default - ENABLED by default. Triggering the function toggles visibility.

The bar refreshes once a second while visible.

Item Dispenser

Choose Item - Opens the item picker. No default item; the function does nothing until one is chosen.
Toggle Drop - DISABLED by default (item is given to the target). When on, the item is dropped at the function's location instead. The item is also dropped if there are no targets.
Toggle Notification - ENABLED by default. Sends the "You got X" message.

MythicMobs items are regenerated from their MythicMobs definition when the function fires.

Key Dispenser

Has all three Item Dispenser options, plus:

Toggle Taking Key Out of Dungeon - ENABLED by default. When turned off, the key is tagged as a dungeon item and is stripped when the player leaves.

Defaults to a Dungeon Key (a renamed tripwire hook carrying the key tag). With the default PLAYER target type there is only ever one target and that player gets the key. If you set the target type to PARTY and the function ends up with more than one target, the key goes to the party leader, or to the first eligible member still in the instance if the leader is gone. Unless the trigger allows retriggering, the function disables itself after handing out the key.

Rewards

Edit Rewards - Opens a 45-slot inventory. Whatever is in it when you close it becomes the reward list.
Exp Reward - Default 0.
Exp Levels Reward - Default 0.
Cooldown Settings - Opens a sub-hotbar:
- Toggle Cooldown Enabled - Cooldowns are on by default.
- Toggle Custom Cooldown - DISABLED by default; the dungeon's own cooldown settings are used. Turning it on reveals the three options below.
- Type - Cycles TIMER (default), HOURLY, DAILY, WEEKLY, MONTHLY.
- Cooldown in Minutes / Hour of Day - Default 0. Shows as minutes for TIMER, otherwise as the hour of day the reward resets.
- Day of Week / Day of Month - Default 1. Only shown for WEEKLY and MONTHLY.

Random Rewards

Has all the Rewards options, plus:

Min Rewards - Default 1.
Max Rewards - Default 3.

Rolls a random count between the two, plus the difficulty level's bonus loot, and hands out that many distinct items from the reward list.

Loot Table Rewards

Set Loot Table - Empty by default. The unique name of a loot table created with /md loot create. With MythicMobs installed, a MythicMobs drop table name is accepted too and is used directly.
Exp Reward - Default 0.
Exp Levels Reward - Default 0.
Cooldown Settings - Same sub-hotbar as Rewards.

There is no "Edit Rewards" button here; the contents come entirely from the loot table.

There are two implementations behind this one name. With MythicMobs installed the browser gives you the MythicMobs-aware version, which is the one that also accepts a MythicMobs drop table name. Without MythicMobs you get the plain version, which only understands Mythic Dungeons loot tables. They look identical in the function browser and in the editor. A dungeon saved before MythicMobs was installed keeps loading after you install it, because the plain version stays loadable alongside the Mythic one. Going the other way is not safe: if you remove MythicMobs from a server whose dungeons already use the MythicMobs-aware version, the MythicMobs-aware class is no longer registered and those dungeons fail to load with an error naming it.

Location

Mob Spawner

Mob Name - Default zombie. A vanilla entity type or a MythicMobs mob ID. MythicMobs IDs are resolved first and are matched case-insensitively.
Mythic Mob Level - Default 0. Only shown when MythicMobs is installed. Accepts a range written as 3-6 or 3to6.
Amount - Default 1. How many mobs this spawner produces per activation.
Spawn Delay - Default 0 ticks before the first spawn.
Spawn Interval - Default 0 ticks between spawns (treated as 1).
Mob Direction - Sets the spawn yaw to the direction you are currently looking. Default 0.

If the dungeon uses difficulty levels, the amount, health, damage, and Mythic level are all scaled by the active difficulty (and by any per-mob override on it). Mobs spawned by this function have their despawn mode forced to NEVER so kill counters can't be broken by chunk unloads.

NPC Spawner

Only available with Citizens installed.

NPC ID - Default -1. The Citizens NPC ID to clone and spawn.
NPC Direction - Sets the spawn yaw to the direction you are currently looking. Default 0.

Block Editor

Block Type - Default AIR. A Bukkit material name, mythic:<id> for a MythicCrucible custom block, or (in remover mode only) ANY.
Toggle Remover - DISABLED by default, meaning the function places the block. Turn it on to remove it instead.
Block Direction - Default NORTH. Accepts a BlockFace for directional and rotatable blocks, an Axis (X/Y/Z) for orientable blocks such as logs, and a Rail.Shape for rails. Not usable in remover mode or on blocks that have no direction.

The function renames itself to <BLOCK> Placer or <BLOCK> Remover in the editor.

Sound Player

Set Sound - Empty by default; the function does nothing until set. Any sound key, for example minecraft:block.note_block.bell.
Set Category - Default MASTER. Any Bukkit SoundCategory. An unrecognised value silently falls back to MASTER.
Set Pitch - Default 1.0.
Set Volume - Default 1.0.
Toggle Sound Location - DISABLED by default, meaning the sound plays at each target player's own position. Turn it on to play it at the function's location.

Place Redstone Block

Delay - Default 0 ticks before the first pulse.
Repeat Count - Default 1. How many redstone pulses to send.
Repeat Interval - Default 5 ticks between pulses.

Each pulse places a redstone block and removes it one tick before the next pulse. The final pulse leaves the redstone block in place.

Door Controller

Start Locked - ENABLED by default.
Auto Open/Close - ENABLED by default. When on, unlocking also opens the door and locking also closes it.
Hide Key Name - DISABLED by default. When on, the locked-door message won't name the key that opens it. (The key is only ever named when the function's trigger is a Key Item Detector.)

Triggering the function flips the lock state. While locked, interacting with the door (or the block directly above or below it) is cancelled and the player is told the door is locked. This function does not need a trigger.

Allow Block Place/Break

Toggle Place - ENABLED by default.
Toggle Break - ENABLED by default.
Toggle Bucket - DISABLED by default. When on, emptying a bucket here follows the Place setting and filling one follows the Break setting.

This function does not need a trigger, but it only takes effect once it has been triggered. If you leave it without a trigger it is given a Dungeon Start trigger when the dungeon loads, so it is active from the beginning.

Hologram

Set Location - Defaults to the function's own block. Click once to see the current spot (marked with particles), click again to place the hologram 1.75 blocks above where you are standing. The prompt times out after 10 seconds.
Hologram Message - No default. Use \n for extra lines.
View Distance - Default 25 blocks.
Visible by Default - ENABLED by default. Triggering the function toggles visibility.

Moving Block

Set Destination - No default; the function logs an error at dungeon load if it is unset. Click once to see the current destination, click again to set it to the block you are looking at (within 10 blocks).
Movement Speed - Default 0.0 blocks per second, which means the block will not move until you set it.
Become Physical - DISABLED by default. When on, the block turns back into a real block on arrival and is picked up again on the next trigger. Container contents are not preserved.

Triggering it while it is moving pauses it; triggering a paused block resumes it; triggering a block that has arrived sends it back the other way. Vertically moving blocks will not carry players unless allow-flight is true in server.properties.

Moving Block Cluster

Has all the Moving Block options, plus:

Select Area - Right-click sets corner 1, left-click sets corner 2. Every non-air, non-liquid block in the box is added to the cluster.
Remove Area - Same corner controls; removes every stored block inside the box.

Room

Room Door Controller

Procedural dungeons only.

Door Name - Default all, meaning every door in the room that has a room on the other side. Otherwise the name of a single connector door.
Action - Cycles TOGGLE (default), OPEN, CLOSE.
Keep Entrance Open - ENABLED by default. Only shown when the door name is all; keeps the door the player entered through open.

Core Plugins