customEvents.md

Custom Events

The below Denizen Custom Events are available to listen to in your own scripts without modification to dDungeon.

• dd_dungeon_world_created
• dd_dungeon_generation_complete
• dd_dungeon_section_placed
• dd_player_enters_dungeon
• dd_player_exits_dungeon
• dd_dungeon_spawner_destroyed
• dd_dungeon_spawned_entity_killed

---

dd_dungeon_world_created

• Fired before Dungeon sections have started to be placed.
• Useful for changing any settings/flags of the world before generation starts.

The below context data is passed when the event fires.

Key	Description	Values
world	World that was created for the Dungeon	WorldTag
dungeon_key	Dungeon Key for the Dungeon this World was created for	ElementTag
dungeon_category	Dungeon Category for the Dungeon this World was created for	ElementTag

---

dd_dungeon_generation_complete

• Fired after all Dungeon sections have been placed, and all cleanup tasks have finished.
• This is the last custom event to fire during Dungeon Generation.

The below context data is passed when the event fires.

Key	Description	Values
world	World the Dungeon is in	WorldTag
dungeon_key	Dungeon Key for the Dungeon created	ElementTag
dungeon_category	Dungeon Category for the Dungeon created	ElementTag

---

dd_dungeon_section_placed

• Fired for every Dungeon Section as it is placed.
• Useful for making modifications to dungeons after it is created.
• You may want to include an event switch to limit when your event is actually listening.
  • Such as dungeon_key:{my_cool_key_here} or dungeon_category:stonebrick

The below context data is passed when the event fires.

Key	Description	Values
area	Area containing the Section that was just placed	AreaTag
dungeon_key	Dungeon Key for the Dungeon this Section is in	ElementTag
dungeon_category	Dungeon Category used to create the Dungeon this Section is in	ElementTag
dungeon_section_type	Dungeon Section Type of this Section	ElementTag
dungeon_section_name	Name of this Dungeon Section	ElementTag

---

dd_player_enters_dungeon

• Fired when a player enters a Dungeon
• Note that this event fires for multiple reasons (e.g., player teleports into dungeon, player respawns, etc.)

The below context data is passed when the event fires.

Key	Description	Values
location	Location of Player when entering Dungeon	LocationTag
reason	Underlying event causing this event to fire	PLAYER_RESURRECTED PLAYER_RESPAWNS PLAYER_TELEPORTS

---

dd_player_exits_dungeon

• Fired when a player leaves a Dungeon
• Note that this event fires for multiple reasons (e.g., player teleports into dungeon, player dies, etc.)

The below context data is passed when the event fires.

Key	Description	Values
location	Location of Player after leaving Dungeon	LocationTag
reason	Underlying event causing this event to fire	PLAYER_RESURRECTED PLAYER_RESPAWNS PLAYER_TELEPORTS

---

dd_dungeon_spawner_destroyed

• Fired when a Dungeon Spawner is destroyed (ie, players have killed enough Entities spawned from it).

The below context data is passed when the event fires.

Key	Description	Values
location	Location of the Spawner being destroyed	LocationTag
players	List of Players who have damaged at least one Entity spawned from this Spawner	ListTag<PlayerTag>
spawn_table	Name of Spawn Table the destroyed Spawner used Spawn tables are defined in the script dd_SpawnTables	element library_guardians ambient_stonebrick etc.....

---

dd_dungeon_spawned_entity_killed

• Fired when an entity that was spawned by either a Dungeon Spawner or by Dungeon Ambient spawning is killed by a player.
• Has player linked to the player that the server considered killed the entity.

The below context data is passed when the event fires.

Key	Description	Values
spawner_location	Location of the Spawner this Entity was spawned from, if it was spawned by a Spawner. If spawned through ambient spawning this will be null.	LocationTag null
entity	Entity that was killed.	EntityTag
assisting_players	List of players who have damaged this Entity	ListTag<PlayerTag>
spawn_table	Name of Spawn Table used to spawn this Entity	element library_guardians ambient_stonebrick etc.....