mirror/Archipelago
1
0
Fork 1
mirror of https://github.com/ArchipelagoMW/Archipelago.git synced 2026-07-17 13:10:42 -07:00
Code Issues Packages Projects Releases Wiki Activity

Core: Add parameter to visualize_regions to display Rule Builder explanations on exits (#6184)

Browse Source 
Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com>
This commit is contained in:
Katelyn Gigante
2026-07-18 04:08:20 +10:00
committed by GitHub
parent 13f1929286
commit feab54daec
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Utils.py
+12 -1
View File
@@ -1088,6 +1088,7 @@ def visualize_regions(
file_name: str,
*,
show_entrance_names: bool = False,
show_entrance_rules: bool = False,
show_locations: bool = True,
show_other_regions: bool = True,
linetype_ortho: bool = True,
@@ -1100,6 +1101,7 @@ def visualize_regions(
:param root_region: The region from which to start the diagram from. (Usually the "Menu" region of your world.)
:param file_name: The name of the destination .puml file.
:param show_entrance_names: (default False) If enabled, the name of the entrance will be shown near each connection.
:param show_entrance_rules: (default False) If enabled, the Rule Builder explanation of the entrance's access rule will be shown near each connection.
:param show_locations: (default True) If enabled, the locations will be listed inside each region.
Priority locations will be shown in bold.
Excluded locations will be stricken out.
@@ -1189,13 +1191,22 @@ def visualize_regions(
return re.sub("[\".:]", "", name)
def visualize_exits(region: Region) -> None:
import rule_builder.rules
for exit_ in region.exits:
color_code: str = ""
if exit_.randomization_group in entrance_highlighting:
color_code = f" #{entrance_highlighting[exit_.randomization_group]:0>6X}"
if exit_.connected_region:
label = ""
if show_entrance_names:
uml.append(f"\"{fmt(region)}\" --> \"{fmt(exit_.connected_region)}\" : \"{fmt(exit_)}\"{color_code}")
label += fmt(exit_)
if show_entrance_rules:
if isinstance(exit_.access_rule, rule_builder.rules.Rule.Resolved):
if label:
label += "\\n"
label += exit_.access_rule.explain_str()
if label:
uml.append(f"\"{fmt(region)}\" --> \"{fmt(exit_.connected_region)}\" : \"{label}\"{color_code}")
else:
try:
uml.remove(f"\"{fmt(exit_.connected_region)}\" --> \"{fmt(region)}\"{color_code}")