core: utility method for visualizing worlds as PlantUML (#1935)

* core: typing for MultiWorld.get_regions

* core: utility method for visualizing worlds as PlantUML

* core: utility method for visualizing worlds as PlantUML: update docs
This commit is contained in:
el-u
2023-10-02 01:56:55 +02:00
committed by GitHub
parent e08deff6f9
commit 485aa23afd
4 changed files with 120 additions and 1 deletions

View File

@@ -559,6 +559,12 @@ def generate_basic(self) -> None:
# in most cases it's better to do this at the same time the itempool is
# filled to avoid accidental duplicates:
# manually placed and still in the itempool
# for debugging purposes, you may want to visualize the layout of your world. Uncomment the following code to
# write a PlantUML diagram to the file "my_world.puml" that can help you see whether your regions and locations
# are connected and placed as desired
# from Utils import visualize_regions
# visualize_regions(self.multiworld.get_region("Menu", self.player), "my_world.puml")
```
### Setting Rules