about summary refs log tree commit diff stats
path: root/apworld/player_logic.py
diff options
context:
space:
mode:
Diffstat (limited to 'apworld/player_logic.py')
-rw-r--r--apworld/player_logic.py247
1 files changed, 215 insertions, 32 deletions
diff --git a/apworld/player_logic.py b/apworld/player_logic.py index 5cb9011..4aa481d 100644 --- a/apworld/player_logic.py +++ b/apworld/player_logic.py
@@ -1,9 +1,10 @@
1from enum import IntEnum, auto 1from enum import IntEnum, auto
2 2
3from .generated import data_pb2 as data_pb2 3from .generated import data_pb2 as data_pb2
4from .items import SYMBOL_ITEMS
4from typing import TYPE_CHECKING, NamedTuple 5from typing import TYPE_CHECKING, NamedTuple
5 6
6from .options import VictoryCondition, ShuffleLetters 7from .options import VictoryCondition, ShuffleLetters, CyanDoorBehavior
7 8
8if TYPE_CHECKING: 9if TYPE_CHECKING:
9 from . import Lingo2World 10 from . import Lingo2World
@@ -23,21 +24,38 @@ class AccessRequirements:
23 items: set[str] 24 items: set[str]
24 progressives: dict[str, int] 25 progressives: dict[str, int]
25 rooms: set[str] 26 rooms: set[str]
26 symbols: set[str]
27 letters: dict[str, int] 27 letters: dict[str, int]
28 cyans: bool 28 cyans: bool
29 29
30 # This is an AND of ORs. 30 # This is an AND of ORs.
31 or_logic: list[list["AccessRequirements"]] 31 or_logic: list[list["AccessRequirements"]]
32 32
33 # When complete_at is set, at least that many of the requirements in possibilities must be accessible. This should
34 # only be used for doors with complete_at > 1, as or_logic is more efficient for complete_at == 1.
35 complete_at: int | None
36 possibilities: list["AccessRequirements"]
37
33 def __init__(self): 38 def __init__(self):
34 self.items = set() 39 self.items = set()
35 self.progressives = dict() 40 self.progressives = dict()
36 self.rooms = set() 41 self.rooms = set()
37 self.symbols = set()
38 self.letters = dict() 42 self.letters = dict()
39 self.cyans = False 43 self.cyans = False
40 self.or_logic = list() 44 self.or_logic = list()
45 self.complete_at = None
46 self.possibilities = list()
47
48 def copy(self) -> "AccessRequirements":
49 reqs = AccessRequirements()
50 reqs.items = self.items.copy()
51 reqs.progressives = self.progressives.copy()
52 reqs.rooms = self.rooms.copy()
53 reqs.letters = self.letters.copy()
54 reqs.cyans = self.cyans
55 reqs.or_logic = [[other_req.copy() for other_req in disjunction] for disjunction in self.or_logic]
56 reqs.complete_at = self.complete_at
57 reqs.possibilities = self.possibilities.copy()
58 return reqs
41 59
42 def merge(self, other: "AccessRequirements"): 60 def merge(self, other: "AccessRequirements"):
43 for item in other.items: 61 for item in other.items:
@@ -49,9 +67,6 @@ class AccessRequirements:
49 for room in other.rooms: 67 for room in other.rooms:
50 self.rooms.add(room) 68 self.rooms.add(room)
51 69
52 for symbol in other.symbols:
53 self.symbols.add(symbol)
54
55 for letter, level in other.letters.items(): 70 for letter, level in other.letters.items():
56 self.letters[letter] = max(self.letters.get(letter, 0), level) 71 self.letters[letter] = max(self.letters.get(letter, 0), level)
57 72
@@ -60,6 +75,98 @@ class AccessRequirements:
60 for disjunction in other.or_logic: 75 for disjunction in other.or_logic:
61 self.or_logic.append(disjunction) 76 self.or_logic.append(disjunction)
62 77
78 if other.complete_at is not None:
79 # Merging multiple requirements that use complete_at sucks, and is part of why we want to minimize use of
80 # it. If both requirements use complete_at, we will cheat by using the or_logic field, which supports
81 # conjunctions of requirements.
82 if self.complete_at is not None:
83 print("Merging requirements with complete_at > 1. This is messy and should be avoided!")
84
85 left_req = AccessRequirements()
86 left_req.complete_at = self.complete_at
87 left_req.possibilities = self.possibilities
88 self.or_logic.append([left_req])
89
90 self.complete_at = None
91 self.possibilities = list()
92
93 right_req = AccessRequirements()
94 right_req.complete_at = other.complete_at
95 right_req.possibilities = other.possibilities
96 self.or_logic.append([right_req])
97 else:
98 self.complete_at = other.complete_at
99 self.possibilities = other.possibilities
100
101 def is_empty(self) -> bool:
102 return (len(self.items) == 0 and len(self.progressives) == 0 and len(self.rooms) == 0 and len(self.letters) == 0
103 and not self.cyans and len(self.or_logic) == 0 and self.complete_at is None)
104
105 def __eq__(self, other: "AccessRequirements"):
106 return (self.items == other.items and self.progressives == other.progressives and self.rooms == other.rooms and
107 self.letters == other.letters and self.cyans == other.cyans and self.or_logic == other.or_logic and
108 self.complete_at == other.complete_at and self.possibilities == other.possibilities)
109
110 def simplify(self):
111 resimplify = False
112
113 if len(self.or_logic) > 0:
114 old_or_logic = self.or_logic
115
116 def remove_redundant(sub_reqs: "AccessRequirements"):
117 new_reqs = sub_reqs.copy()
118 new_reqs.letters = {l: v for l, v in new_reqs.letters.items() if self.letters.get(l, 0) < v}
119 if new_reqs != sub_reqs:
120 return new_reqs
121 else:
122 return sub_reqs
123
124 self.or_logic = []
125 for disjunction in old_or_logic:
126 new_disjunction = []
127 for ssr in disjunction:
128 new_ssr = remove_redundant(ssr)
129 if not new_ssr.is_empty():
130 new_disjunction.append(new_ssr)
131 else:
132 new_disjunction.clear()
133 break
134 if len(new_disjunction) == 1:
135 self.merge(new_disjunction[0])
136 resimplify = True
137 elif len(new_disjunction) > 1:
138 if all(cjr == new_disjunction[0] for cjr in new_disjunction):
139 self.merge(new_disjunction[0])
140 resimplify = True
141 else:
142 self.or_logic.append(new_disjunction)
143
144 if resimplify:
145 self.simplify()
146
147 def get_referenced_rooms(self):
148 result = set(self.rooms)
149
150 for disjunction in self.or_logic:
151 for sub_req in disjunction:
152 result = result.union(sub_req.get_referenced_rooms())
153
154 for sub_req in self.possibilities:
155 result = result.union(sub_req.get_referenced_rooms())
156
157 return result
158
159 def remove_room(self, room: str):
160 if room in self.rooms:
161 self.rooms.remove(room)
162
163 for disjunction in self.or_logic:
164 for sub_req in disjunction:
165 sub_req.remove_room(room)
166
167 for sub_req in self.possibilities:
168 sub_req.remove_room(room)
169
63 def __repr__(self): 170 def __repr__(self):
64 parts = [] 171 parts = []
65 if len(self.items) > 0: 172 if len(self.items) > 0:
@@ -68,15 +175,17 @@ class AccessRequirements:
68 parts.append(f"progressives={self.progressives}") 175 parts.append(f"progressives={self.progressives}")
69 if len(self.rooms) > 0: 176 if len(self.rooms) > 0:
70 parts.append(f"rooms={self.rooms}") 177 parts.append(f"rooms={self.rooms}")
71 if len(self.symbols) > 0:
72 parts.append(f"symbols={self.symbols}")
73 if len(self.letters) > 0: 178 if len(self.letters) > 0:
74 parts.append(f"letters={self.letters}") 179 parts.append(f"letters={self.letters}")
75 if self.cyans: 180 if self.cyans:
76 parts.append(f"cyans=True") 181 parts.append(f"cyans=True")
77 if len(self.or_logic) > 0: 182 if len(self.or_logic) > 0:
78 parts.append(f"or_logic={self.or_logic}") 183 parts.append(f"or_logic={self.or_logic}")
79 return f"AccessRequirements({", ".join(parts)})" 184 if self.complete_at is not None:
185 parts.append(f"complete_at={self.complete_at}")
186 if len(self.possibilities) > 0:
187 parts.append(f"possibilities={self.possibilities}")
188 return "AccessRequirements(" + ", ".join(parts) + ")"
80 189
81 190
82class PlayerLocation(NamedTuple): 191class PlayerLocation(NamedTuple):
@@ -123,16 +232,60 @@ class Lingo2PlayerLogic:
123 self.item_by_door[progressive.doors[i]] = (progressive.name, i + 1) 232 self.item_by_door[progressive.doors[i]] = (progressive.name, i + 1)
124 self.real_items.append(progressive.name) 233 self.real_items.append(progressive.name)
125 234
235 for door_group in world.static_logic.objects.door_groups:
236 if door_group.type == data_pb2.DoorGroupType.CONNECTOR:
237 if not self.world.options.shuffle_doors:
238 continue
239 elif door_group.type == data_pb2.DoorGroupType.COLOR_CONNECTOR:
240 if not self.world.options.shuffle_control_center_colors:
241 continue
242 elif door_group.type == data_pb2.DoorGroupType.SHUFFLE_GROUP:
243 if not self.world.options.shuffle_doors:
244 continue
245 else:
246 continue
247
248 for door in door_group.doors:
249 self.item_by_door[door] = (door_group.name, 1)
250
251 self.real_items.append(door_group.name)
252
126 # We iterate through the doors in two parts because it is essential that we determine which doors are shuffled 253 # We iterate through the doors in two parts because it is essential that we determine which doors are shuffled
127 # before we calculate any access requirements. 254 # before we calculate any access requirements.
128 for door in world.static_logic.objects.doors: 255 for door in world.static_logic.objects.doors:
129 if door.type in [data_pb2.DoorType.STANDARD, data_pb2.DoorType.ITEM_ONLY] and self.world.options.shuffle_doors: 256 if door.type in [data_pb2.DoorType.EVENT, data_pb2.DoorType.LOCATION_ONLY, data_pb2.DoorType.GRAVESTONE]:
130 if door.id in self.item_by_door: 257 continue
258
259 if door.id in self.item_by_door:
260 continue
261
262 if (door.type in [data_pb2.DoorType.STANDARD, data_pb2.DoorType.ITEM_ONLY] and
263 not self.world.options.shuffle_doors):
264 continue
265
266 if (door.type == data_pb2.DoorType.CONTROL_CENTER_COLOR and
267 not self.world.options.shuffle_control_center_colors):
268 continue
269
270 if door.type == data_pb2.DoorType.GALLERY_PAINTING and not self.world.options.shuffle_gallery_paintings:
271 continue
272
273 door_item_name = self.world.static_logic.get_door_item_name(door)
274 self.item_by_door[door.id] = (door_item_name, 1)
275 self.real_items.append(door_item_name)
276
277 # We handle cyan_door_behavior = Item after door shuffle, because cyan doors that are impacted by door shuffle
278 # should be exempt from cyan_door_behavior.
279 if world.options.cyan_door_behavior == CyanDoorBehavior.option_item:
280 for door_group in world.static_logic.objects.door_groups:
281 if door_group.type != data_pb2.DoorGroupType.CYAN_DOORS:
131 continue 282 continue
132 283
133 door_item_name = self.world.static_logic.get_door_item_name(door) 284 for door in door_group.doors:
134 self.item_by_door[door.id] = (door_item_name, 1) 285 if not door in self.item_by_door:
135 self.real_items.append(door_item_name) 286 self.item_by_door[door] = (door_group.name, 1)
287
288 self.real_items.append(door_group.name)
136 289
137 for door in world.static_logic.objects.doors: 290 for door in world.static_logic.objects.doors:
138 if door.type in [data_pb2.DoorType.STANDARD, data_pb2.DoorType.LOCATION_ONLY, data_pb2.DoorType.GRAVESTONE]: 291 if door.type in [data_pb2.DoorType.STANDARD, data_pb2.DoorType.LOCATION_ONLY, data_pb2.DoorType.GRAVESTONE]:
@@ -190,6 +343,10 @@ class Lingo2PlayerLogic:
190 self.locations_by_room.setdefault(keyholder.room_id, []).append(PlayerLocation(keyholder.ap_id, 343 self.locations_by_room.setdefault(keyholder.room_id, []).append(PlayerLocation(keyholder.ap_id,
191 reqs)) 344 reqs))
192 345
346 if self.world.options.shuffle_symbols:
347 for symbol_name in SYMBOL_ITEMS.values():
348 self.real_items.append(symbol_name)
349
193 def get_panel_reqs(self, panel_id: int, answer: str | None) -> AccessRequirements: 350 def get_panel_reqs(self, panel_id: int, answer: str | None) -> AccessRequirements:
194 if answer is None: 351 if answer is None:
195 if panel_id not in self.panel_reqs: 352 if panel_id not in self.panel_reqs:
@@ -212,25 +369,35 @@ class Lingo2PlayerLogic:
212 self.add_solution_reqs(reqs, answer) 369 self.add_solution_reqs(reqs, answer)
213 elif len(panel.proxies) > 0: 370 elif len(panel.proxies) > 0:
214 possibilities = [] 371 possibilities = []
372 already_filled = False
215 373
216 for proxy in panel.proxies: 374 for proxy in panel.proxies:
217 proxy_reqs = AccessRequirements() 375 proxy_reqs = AccessRequirements()
218 self.add_solution_reqs(proxy_reqs, proxy.answer) 376 self.add_solution_reqs(proxy_reqs, proxy.answer)
219 377
220 possibilities.append(proxy_reqs) 378 if not proxy_reqs.is_empty():
379 possibilities.append(proxy_reqs)
380 else:
381 already_filled = True
382 break
221 383
222 if not any(proxy.answer == panel.answer for proxy in panel.proxies): 384 if not already_filled and not any(proxy.answer == panel.answer for proxy in panel.proxies):
223 proxy_reqs = AccessRequirements() 385 proxy_reqs = AccessRequirements()
224 self.add_solution_reqs(proxy_reqs, panel.answer) 386 self.add_solution_reqs(proxy_reqs, panel.answer)
225 387
226 possibilities.append(proxy_reqs) 388 if not proxy_reqs.is_empty():
389 possibilities.append(proxy_reqs)
390 else:
391 already_filled = True
227 392
228 reqs.or_logic.append(possibilities) 393 if not already_filled:
394 reqs.or_logic.append(possibilities)
229 else: 395 else:
230 self.add_solution_reqs(reqs, panel.answer) 396 self.add_solution_reqs(reqs, panel.answer)
231 397
232 for symbol in panel.symbols: 398 if self.world.options.shuffle_symbols:
233 reqs.symbols.add(symbol) 399 for symbol in panel.symbols:
400 reqs.items.add(SYMBOL_ITEMS.get(symbol))
234 401
235 if panel.HasField("required_door"): 402 if panel.HasField("required_door"):
236 door_reqs = self.get_door_open_reqs(panel.required_door) 403 door_reqs = self.get_door_open_reqs(panel.required_door)
@@ -253,18 +420,26 @@ class Lingo2PlayerLogic:
253 door = self.world.static_logic.objects.doors[door_id] 420 door = self.world.static_logic.objects.doors[door_id]
254 reqs = AccessRequirements() 421 reqs = AccessRequirements()
255 422
256 # TODO: lavender_cubes, endings
257 if not door.HasField("complete_at") or door.complete_at == 0: 423 if not door.HasField("complete_at") or door.complete_at == 0:
258 for proxy in door.panels: 424 for proxy in door.panels:
259 panel_reqs = self.get_panel_reqs(proxy.panel, proxy.answer if proxy.HasField("answer") else None) 425 panel_reqs = self.get_panel_reqs(proxy.panel, proxy.answer if proxy.HasField("answer") else None)
260 reqs.merge(panel_reqs) 426 reqs.merge(panel_reqs)
261 elif door.complete_at == 1: 427 elif door.complete_at == 1:
262 reqs.or_logic.append([self.get_panel_reqs(proxy.panel, 428 disjunction = []
263 proxy.answer if proxy.HasField("answer") else None) 429 for proxy in door.panels:
264 for proxy in door.panels]) 430 proxy_reqs = self.get_panel_reqs(proxy.panel, proxy.answer if proxy.HasField("answer") else None)
431 if proxy_reqs.is_empty():
432 disjunction.clear()
433 break
434 else:
435 disjunction.append(proxy_reqs)
436 if len(disjunction) > 0:
437 reqs.or_logic.append(disjunction)
265 else: 438 else:
266 # TODO: Handle complete_at > 1 439 reqs.complete_at = door.complete_at
267 pass 440 for proxy in door.panels:
441 panel_reqs = self.get_panel_reqs(proxy.panel, proxy.answer if proxy.HasField("answer") else None)
442 reqs.possibilities.append(panel_reqs)
268 443
269 if door.HasField("control_center_color"): 444 if door.HasField("control_center_color"):
270 # TODO: Logic for ensuring two CC states aren't needed at once. 445 # TODO: Logic for ensuring two CC states aren't needed at once.
@@ -272,12 +447,14 @@ class Lingo2PlayerLogic:
272 self.add_solution_reqs(reqs, door.control_center_color) 447 self.add_solution_reqs(reqs, door.control_center_color)
273 448
274 if door.double_letters: 449 if door.double_letters:
275 if self.world.options.shuffle_letters in [ShuffleLetters.option_vanilla, 450 if self.world.options.cyan_door_behavior == CyanDoorBehavior.option_collect_h2:
276 ShuffleLetters.option_vanilla_cyan]:
277 reqs.rooms.add("The Repetitive - Main Room") 451 reqs.rooms.add("The Repetitive - Main Room")
278 elif self.world.options.shuffle_letters in [ShuffleLetters.option_progressive, 452 elif self.world.options.cyan_door_behavior == CyanDoorBehavior.option_any_double_letter:
279 ShuffleLetters.option_item_cyan]: 453 if self.world.options.shuffle_letters != ShuffleLetters.option_unlocked:
280 reqs.cyans = True 454 reqs.cyans = True
455 elif self.world.options.cyan_door_behavior == CyanDoorBehavior.option_item:
456 # There shouldn't be any locations that are cyan doors.
457 pass
281 458
282 for keyholder_uses in door.keyholders: 459 for keyholder_uses in door.keyholders:
283 key_name = keyholder_uses.key.upper() 460 key_name = keyholder_uses.key.upper()
@@ -293,12 +470,18 @@ class Lingo2PlayerLogic:
293 470
294 for ending_id in door.endings: 471 for ending_id in door.endings:
295 ending = self.world.static_logic.objects.endings[ending_id] 472 ending = self.world.static_logic.objects.endings[ending_id]
296 reqs.items.add(f"{ending.name.capitalize()} Ending (Achieved)") 473
474 if self.world.options.victory_condition.current_key.removesuffix("_ending").upper() == ending.name:
475 reqs.items.add("Victory")
476 else:
477 reqs.items.add(f"{ending.name.capitalize()} Ending (Achieved)")
297 478
298 for sub_door_id in door.doors: 479 for sub_door_id in door.doors:
299 sub_reqs = self.get_door_open_reqs(sub_door_id) 480 sub_reqs = self.get_door_open_reqs(sub_door_id)
300 reqs.merge(sub_reqs) 481 reqs.merge(sub_reqs)
301 482
483 reqs.simplify()
484
302 return reqs 485 return reqs
303 486
304 # This gets the requirements to open a door within the world. When a door is shuffled, this means having the item 487 # This gets the requirements to open a door within the world. When a door is shuffled, this means having the item