Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
MythicDungeons MythicDungeons
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 86
    • Issues 86
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Operations
    • Operations
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • MythicCraft
  • MythicDungeonsMythicDungeons
  • Wiki
  • Functions

Last edited by MarcatoSound May 06, 2024
Page history

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.

  • Trigger: [Trigger Name]
    Applies to all functions. Opens the trigger's hotbar menu.

  • Target Type
    Only available on select functions. Cycles through target options. Options are: PLAYER, PARTY, NONE.
    PLAYER - If the function is targeted and the trigger is activated by a specific player, the function will target that player. (Not available if the selected trigger doesn't have a player associated with it.)
    PARTY - If the function is targeted, the function will target all players in the party.
    NONE - The function targets nobody. (Not available if the function requires a target.)

Functions List

Icon 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.
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.
Reviver Dungeon Allows bringing another player back from death.
Chunk Loader Dungeon When triggered, forces the chunk this function is in to remain loaded. Trigger again to allow the chunk to unload.
Dungeon Status Dungeon Sets the dungeons "status" to a configurable text. Similar to Mythic Mobs stances.
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.
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.
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.
Redstone Block Location Places a redstone block at the function's location.
Door Controller Location Makes a door lockable and unlockable with triggers.
Block Controller Location Allows placing or breaking blocks at the function's location.
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.
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.
Dungeon Variable Meta Allows setting and modifying a custom variable. Best used with the Variable Comparison condition. Variables can be used in message senders with the following format: <my_variable_here>
Clone repository

NOTE: Items marked with * are incomplete or unwritten.

General Info
  • Changelogs
  • Free vs Premium
  • Commands and Permissions
  • Plugin Config
  • How it all Works
Guides
  • Getting Started
  • Your First Dungeon
  • Importing from DXL
Dungeon Elements
  • Dungeon Config
  • Dungeon Types
  • Functions
  • Triggers
  • Conditions
Generated Dungeons [2.0+]
  • Procedural Dungeons Overview
  • Dungeon Rooms
  • Default generation.yml
  • Generator Tips & Tricks
  • Troubleshooting
Compatibility
  • Mythic Mobs
  • Placeholder API
  • BetonQuest
Developer Documentation
  • Avoiding Memory Leaks
  • Introduction to API
  • Getting Started with Elements
  • GUI Menus
  • *Custom Functions
  • *Custom Triggers
  • *Custom Conditions
  • Adding Party Support
    [Coming Soon!]
  • *Custom Dungeon Types
  • *Custom Procedural Layouts