From 4c0ecde7a5a65f74ac38a20ed609600703698a07 Mon Sep 17 00:00:00 2001 From: Raphtalia Date: Tue, 20 Aug 2024 19:34:13 +0000 Subject: [PATCH] Update Components --- Components.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/Components.md b/Components.md index ed685c5..f0d9ba1 100644 --- a/Components.md +++ b/Components.md @@ -1,3 +1,5 @@ +# Important Components + ## 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`. @@ -5,8 +7,17 @@ Works in conjunction with `DunGenExtender's` Main Path feature. This allows for > **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. +# Nice To Have Components + +## Random Guaranteed Scrap Spawn +Forces a random piece of scrap to spawn on the `Transform's` position. `spawnChance` specifics the chance that the scrap will spawn or not. `minimumScrapValue` specifies that the random piece of scrap to be spawned **MUST** have a `minValue` value greater or equal to `minimumScrapValue`. + +> **NOTE:** These scrap does not count towards the moon's scrap count. + +# Niche Components + ## Doorway Sisters -Works in conjunction with `DunGenExtender's` Doorway Sisters feature. The `UseDoorwaySisters` toggle in the Extender MUST be on for this component to do anything. This prevents an intersecting doorway from generating into an actual doorway IF it's sister doorway has already generated AND both of these doorways lead to the intersecting, neighbor tile. Read here for more information. +Works in conjunction with `DunGenExtender's` Doorway Sisters feature. The `UseDoorwaySisters` toggle in the Extender MUST be on for this component to do anything. This prevents an intersecting doorway from generating into an actual doorway IF it's sister doorway has already generated AND both of these doorways lead to the intersecting, neighbor tile. Read [here](https://git.touhou.dev/Raphtalia/DungeonGenerationPlus_LethalCompany_Mod/wiki/DunGenExtender#doorway-sisters) for more information. `Sisters` contains a list of the sister doorways. This should be self-explanatory.