core: utility method for visualizing worlds as PlantUML

[el-u]

What is this fixing or adding?

This adds a utility method that allows world developers to debug their world visually by generating a PlantUML diagram representing the Regions and their connections via Entrances. This can be used, e.g., to quickly identify unconncted Entrances or orphaned Regions.

Locations and the filled Items can be show in the diagram as well, so one can also use this to illustrate the fill state.

How was this tested?

See screenshots.

If this makes graphical changes, please attach screenshots.

• ALttP, with locations hidden:
  

• I don't know what world this is Adventure, after create_regions:
  

• ALttP again, but after pre_fill:
  

• KH2, fill completed (right before generate_output):
  

• No comment:
  

• No comment either:
  

[Silvris]

2nd image is of Adventure.

[kindasneaki]

It might be a good idea to have something in the docs to explain what each thing does

[el-u]

It might be a good idea to have something in the docs to explain what each thing does

I added a bit to the world docs that explains that this feature exists. Since the default arguments are sane enough so that the average developer wouldn't need to change them, I don't explain that there. Advanced users will look at the function docstring, which explains what each of the arguments does.

[BootsinSoots]

I would like this very much. I am actually stuck at a point when generating where something like this would be very useful - I'm having problems locating exactly where my generation is getting extra locations from.

[kindasneaki]

I've ran this a couple times to test my world. It took me a bit to figure out how to open the .puml file but after doing so it was very helpful to see how all my regions connect together.

[Zunawe]

An additional thing that I would find helpful is being able to pass in a subset of regions or region names to highlight in a certain color or put in a bounding box or something. That way you could pass in reachable_regions from a CollectionState to visually see which regions are in sphere 1, or double check which regions open up when certain items are collected, or show the current state of your world when stepping through fill_restrictive, etc...

state = CollectionState(self.multiworld)
state.collect(important_items[0])
state.collect(important_items[1])
...
visualize_regions(self.multiworld.get_region("Menu", self.player), "reachable_regions.puml",
                  highlight_regions=state.reachable_regions[self.player])

[el-u]

Not planning to add any more features at this time.

[Zunawe]

Fair enough. It's still very useful as-is.