Glossary
This page explains the terms used in the plugin.
Modules and Assets
| Term | Meaning |
|---|
| Module | A piece of a dungeon that you create by hand. For most dungeons, a module would be a room, but it could for example also be a part of a room, a section of a cave, or an entire house. A module is a normal Unreal level that the Dungeon Spawner loads as a sublevel. It can be anything, as long as it can connect to other modules somehow. |
| Module Set | A collection of modules used by the generator to generate a dungeon. For example, you can make a Lava and Ice set, or an Earth and Moon set. The set also defines which Connector Actors and Closing Meshes are used. Dungeon generation only uses a single module set, but you can chain together multiple dungeons that use different module sets. |
| Module Type | A category for modules, for example, Spawn Room, Corridor, or Dead End. Module Types are used when defining the layout of a dungeon. Both a Lava and an Ice set could have large rooms, corridors, or dead ends. To give your dungeons more variations, you probably want to create several modules for each module type. |
| Module Definition | A data asset automatically created or updated by Save/Update module data. It stores the module's level, connectors, and bounds. |
| Placement Bounds | The hitbox that tells the generator how much space a module takes up. The generator ensures that the placement bounds of one module never overlap with the bounds of another module. |
| Dungeon Graph | Defines the high-level layout of a dungeon. |
Openings and Connections
| Term | Meaning |
|---|
| Connector | An opening that can lead to another module. A connector can be represented by a Connector Actor, which could for example be a door. |
| Connector Marker | An actor you place at an opening to tell the generator where another module can connect. Its arrow must begin where the module geometry ends and point out of the module. |
| Connector Type | A data asset that defines the type of connection a Connector Marker marks. The generator always matches two connectors of the same type. For example, use different types if the openings have different dimensions (so a small, vent-sized opening doesn't connect to a door). |
| Used Connection | A connector leading to another module. |
| Unused Connection | A connector that leads nowhere. |
| External Connection | A connector that leads out of a dungeon. This can be used to create seamless transitions between two dungeons, or between a dungeon and your world geometry. |
| Connector Actor | An actor placed at a used connection, for example a door or locked gate. You can choose these in the Module Set under Connector Pools → Used Connections. |
| Closing Mesh | A static mesh that closes an unused opening, for example a wall piece. You can choose these in the Module Set under Connector Pools → Unused Connectors. |
Module Actors During Play
| Term | Meaning |
|---|
| Module Actor | An actor that belongs to a module's level, for example a chest you placed while building the room. |
| Module Manager | An actor created for each loaded module, unless Module Managers are disabled. It lets you find the module's actors and connections, and track actors entering or leaving its bounds. |
| Occupant | An actor that is inside of a module and overlaps with the Module Manager's bounds. This is usually a player or enemy currently in the module. An Occupant can be a Module Actor too. |