Raphtalia
/
DungeonGenerationPlus_LethalCompany_Mod
1
1
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update Components

Raphtalia 2024-11-04 17:29:25 +00:00
parent 61f39215dd
commit 6d3d0bdac5
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Components.md

@ -3,7 +3,15 @@
## Main Room Doorway Groups
Works in conjunction with `DunGenExtender's` Main Path feature. This allows for more control in which doorways are selected for the alternate main paths. If you wish to use this component, it must be attached the `MainRoomTilePrefab`.
`DoorwayLists` contains a list of grouped doorways. `Name` is for organizing purposes and has no effect on the dungeon generation. When a doorway is selected for a main path and IF the `MainRoomDoorwayGroups` exists anywhere in the `MainRoomTilePrefab`, the dungeon generation will find that doorway's corresponding group in the component's `DoorwayLists`. It will then mark every doorway in that group invalid for the other main paths. This is reverted once all main paths finish generating and it begins the branch path generation.
`DoorwayLists` contains a list of grouped doorways. `Name` is for organizing purposes and has no effect on the dungeon generation.
`DoorwayGroupBehaviour` describes how the dungeon generation algorithm should treat the `DoorwayLists` during the main path(s) generation step. Only two behaviours exist, `RemoveGroup` and `SetInOrder`.
#### Remove Group
When a doorway is selected for a main path, the dungeon generation will find that doorway's corresponding group in the component's `DoorwayLists`. It will then mark every doorway in that group invalid as a starting doorway for the other main paths.
#### Set In Order
When a main path begins generation, for either the default main path or alternate main paths, it will grab the group corresponding to the main path generation order. If the first main path begins generation (`DungeonFlow's` default main path), the first group in the list is selected. If the second main path begins generation (the first alternate main path), the second group is selected and so on. Whichever group is selected, it only allow the doorways in that group to start it's main path.
> **NOTE:** You may want to use this component to split the main paths between floors for example. Or perhaps one main path in the left side of the main room and the other main path in the right side. However you like it.