gameboy_worlds.emulation.deja_vu.test_metrics

  1import numpy as np
  2
  3from gameboy_worlds.emulation.deja_vu.parsers import DejaVu1StateParser, DejaVu2StateParser
  4from gameboy_worlds.emulation.parser import StateParser
  5from gameboy_worlds.emulation.tracker import (
  6    RegionMatchTerminationMetric,
  7    RegionMatchTerminationOnlyMetric,
  8    SingleRegionMatchSubGoal,
  9    SubGoal,
 10    SubGoalMetric,
 11    TerminationMetric,
 12    AnyRegionMatchSubGoal
 13)
 14
 15# class DejaVuCoatSubGoalMetric(SubGoalMetric):
 16#     """SubGoalMetric for the take_coat_test task, tracking 'Take' action selection as an intermediate step."""
 17
 18#     REQUIRED_PARSER = DejaVu1StateParser
 19#     SUBGOALS = [SelectedTakeActionSubGoal]
 20
 21# class DejaVuCoatTerminationMetric(RegionMatchTerminationMetric, TerminationMetric):
 22
 23# deja_vu_1 termination metrics
 24class TakenCoatTerminationMetric(RegionMatchTerminationOnlyMetric):
 25    REQUIRED_PARSER = DejaVu1StateParser
 26
 27    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 28    _TERMINATION_TARGET_NAME = "took_coat"
 29
 30class TakenGunTerminationMetric(RegionMatchTerminationOnlyMetric):
 31    REQUIRED_PARSER = DejaVu1StateParser
 32
 33    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 34    _TERMINATION_TARGET_NAME = "took_gun"
 35
 36class OpenedDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
 37    REQUIRED_PARSER = DejaVu1StateParser
 38
 39    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 40    _TERMINATION_TARGET_NAME = "opened_door"
 41
 42class ClosedDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
 43    REQUIRED_PARSER = DejaVu1StateParser
 44
 45    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 46    _TERMINATION_TARGET_NAME = "closed_door"
 47
 48class OpenedPocketTerminationMetric(RegionMatchTerminationOnlyMetric):
 49    REQUIRED_PARSER = DejaVu1StateParser
 50
 51    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 52    _TERMINATION_TARGET_NAME = "opened_pocket"
 53
 54class OpenedWalletTerminationMetric(RegionMatchTerminationOnlyMetric):
 55    REQUIRED_PARSER = DejaVu1StateParser
 56
 57    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 58    _TERMINATION_TARGET_NAME = "opened_wallet"
 59
 60class ClosedPocketTerminationMetric(RegionMatchTerminationOnlyMetric):
 61    REQUIRED_PARSER = DejaVu1StateParser
 62
 63    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 64    _TERMINATION_TARGET_NAME = "closed_pocket"
 65
 66class ClosedWalletTerminationMetric(RegionMatchTerminationOnlyMetric):
 67    REQUIRED_PARSER = DejaVu1StateParser
 68
 69    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 70    _TERMINATION_TARGET_NAME = "closed_wallet"
 71
 72class CheckedCoatTerminationMetric(RegionMatchTerminationOnlyMetric):
 73    REQUIRED_PARSER = DejaVu1StateParser
 74
 75    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 76    _TERMINATION_TARGET_NAME = "checked_coat"
 77
 78class CheckedGunTerminationMetric(RegionMatchTerminationOnlyMetric):
 79    REQUIRED_PARSER = DejaVu1StateParser
 80
 81    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 82    _TERMINATION_TARGET_NAME = "checked_gun"
 83
 84class OpenedSpigotTerminationMetric(RegionMatchTerminationOnlyMetric):
 85    REQUIRED_PARSER = DejaVu1StateParser
 86
 87    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 88    _TERMINATION_TARGET_NAME = "opened_spigot"
 89
 90class HitBottleTerminationMetric(RegionMatchTerminationOnlyMetric):
 91    REQUIRED_PARSER = DejaVu1StateParser
 92
 93    _TERMINATION_NAMED_REGION = "dialogue_box_area"
 94    _TERMINATION_TARGET_NAME = "hit_bottle"
 95
 96class EnteredCellarTerminationMetric(RegionMatchTerminationOnlyMetric):
 97    REQUIRED_PARSER = DejaVu1StateParser
 98
 99    _TERMINATION_NAMED_REGION = "dialogue_box_area"
100    _TERMINATION_TARGET_NAME = "entered_cellar"
101
102class EnteredConnectingRoomTerminationMetric(RegionMatchTerminationOnlyMetric):
103    REQUIRED_PARSER = DejaVu1StateParser
104
105    _TERMINATION_NAMED_REGION = "dialogue_box_area"
106    _TERMINATION_TARGET_NAME = "entered_connecting_room"
107
108class MadeBetTerminationMetric(RegionMatchTerminationOnlyMetric):
109    REQUIRED_PARSER = DejaVu1StateParser
110
111    _TERMINATION_NAMED_REGION = "dialogue_box_area"
112    _TERMINATION_TARGET_NAME = "made_bet"
113
114class EnteredEmptyRoomFromMapTerminationMetric(RegionMatchTerminationOnlyMetric):
115    REQUIRED_PARSER = DejaVu1StateParser
116
117    _TERMINATION_NAMED_REGION = "dialogue_box_area"
118    _TERMINATION_TARGET_NAME = "entered_empty_room"
119
120class UnlockedFrontDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
121    REQUIRED_PARSER = DejaVu1StateParser
122
123    _TERMINATION_NAMED_REGION = "dialogue_box_area"
124    _TERMINATION_TARGET_NAME = "unlocked_front_door"
125
126class MeetMuggerTerminationMetric(RegionMatchTerminationOnlyMetric):
127    REQUIRED_PARSER = DejaVu1StateParser
128
129    _TERMINATION_NAMED_REGION = "dialogue_box_area"
130    _TERMINATION_TARGET_NAME = "met_mugger"
131
132class HitMuggerTerminationMetric(RegionMatchTerminationOnlyMetric):
133    REQUIRED_PARSER = DejaVu1StateParser
134
135    _TERMINATION_NAMED_REGION = "dialogue_box_area"
136    _TERMINATION_TARGET_NAME = "hit_mugger"
137
138class UnlockedCarDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
139    REQUIRED_PARSER = DejaVu1StateParser
140
141    _TERMINATION_NAMED_REGION = "dialogue_box_area"
142    _TERMINATION_TARGET_NAME = "unlocked_car_door"
143
144class OpenedDashbrdTerminationMetric(RegionMatchTerminationOnlyMetric):
145    REQUIRED_PARSER = DejaVu1StateParser
146
147    _TERMINATION_NAMED_REGION = "dialogue_box_area"
148    _TERMINATION_TARGET_NAME = "opened_dashbrd"
149
150class ClosedDashbrdTerminationMetric(RegionMatchTerminationOnlyMetric):
151    REQUIRED_PARSER = DejaVu1StateParser
152
153    _TERMINATION_NAMED_REGION = "dialogue_box_area"
154    _TERMINATION_TARGET_NAME = "closed_dashbrd"
155
156class CheckedNote2TerminationMetric(RegionMatchTerminationOnlyMetric):
157    REQUIRED_PARSER = DejaVu1StateParser
158
159    _TERMINATION_NAMED_REGION = "dialogue_box_area"
160    _TERMINATION_TARGET_NAME = "checked_note2"
161
162class CheckedMapTerminationMetric(RegionMatchTerminationOnlyMetric):
163    REQUIRED_PARSER = DejaVu1StateParser
164
165    _TERMINATION_NAMED_REGION = "dialogue_box_area"
166    _TERMINATION_TARGET_NAME = "checked_map"
167
168class CheckedSnapshotTerminationMetric(RegionMatchTerminationOnlyMetric):
169    REQUIRED_PARSER = DejaVu1StateParser
170
171    _TERMINATION_NAMED_REGION = "dialogue_box_area"
172    _TERMINATION_TARGET_NAME = "checked_snapshot"
173
174class GoNewsstandTerminationMetric(RegionMatchTerminationOnlyMetric):
175    REQUIRED_PARSER = DejaVu1StateParser
176
177    _TERMINATION_NAMED_REGION = "dialogue_box_area"
178    _TERMINATION_TARGET_NAME = "in_front_of_newsstand"
179
180class EnteredTaxiTerminationMetric(RegionMatchTerminationOnlyMetric):
181    REQUIRED_PARSER = DejaVu1StateParser
182
183    _TERMINATION_NAMED_REGION = "dialogue_box_area"
184    _TERMINATION_TARGET_NAME = "entered_taxi"
185
186class TalkedToTaxiDriverTerminationMetric(RegionMatchTerminationOnlyMetric):
187    REQUIRED_PARSER = DejaVu1StateParser
188
189    _TERMINATION_NAMED_REGION = "dialogue_box_area"
190    _TERMINATION_TARGET_NAME = "talked_to_taxi_driver"
191
192class WenttoWestendTerminationMetric(RegionMatchTerminationOnlyMetric):
193    REQUIRED_PARSER = DejaVu1StateParser
194
195    _TERMINATION_NAMED_REGION = "dialogue_box_area"
196    _TERMINATION_TARGET_NAME = "went_to_westend"
197
198class PaidTaxiTerminationMetric(RegionMatchTerminationOnlyMetric):
199    REQUIRED_PARSER = DejaVu1StateParser
200
201    _TERMINATION_NAMED_REGION = "dialogue_box_area"
202    _TERMINATION_TARGET_NAME = "paid_taxi"
203
204class OutsideApartmentTerminationMetric(RegionMatchTerminationOnlyMetric):
205    REQUIRED_PARSER = DejaVu1StateParser
206
207    _TERMINATION_NAMED_REGION = "dialogue_box_area"
208    _TERMINATION_TARGET_NAME = "outside_apartment"
209
210class EnteredShermanTerminationMetric(RegionMatchTerminationOnlyMetric):
211    REQUIRED_PARSER = DejaVu1StateParser
212
213    _TERMINATION_NAMED_REGION = "dialogue_box_area"
214    _TERMINATION_TARGET_NAME = "entered_sherman"
215
216class WenttoOfficeTerminationMetric(RegionMatchTerminationOnlyMetric):
217    REQUIRED_PARSER = DejaVu1StateParser
218
219    _TERMINATION_NAMED_REGION = "dialogue_box_area"
220    _TERMINATION_TARGET_NAME = "stood_in_front_office"
221
222class EnteredWestendTerminationMetric(RegionMatchTerminationOnlyMetric):
223    REQUIRED_PARSER = DejaVu1StateParser
224
225    _TERMINATION_NAMED_REGION = "dialogue_box_area"
226    _TERMINATION_TARGET_NAME = "entered_westend"
227
228class OpenedElevatorDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
229    REQUIRED_PARSER = DejaVu1StateParser
230
231    _TERMINATION_NAMED_REGION = "dialogue_box_area"
232    _TERMINATION_TARGET_NAME = "opened_elevator_door"
233
234class EnteredElevatorTerminationMetric(RegionMatchTerminationOnlyMetric):
235    REQUIRED_PARSER = DejaVu1StateParser
236
237    _TERMINATION_NAMED_REGION = "dialogue_box_area"
238    _TERMINATION_TARGET_NAME = "entered_elevator"
239
240class ClosedElevatorDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
241    REQUIRED_PARSER = DejaVu1StateParser
242
243    _TERMINATION_NAMED_REGION = "dialogue_box_area"
244    _TERMINATION_TARGET_NAME = "closed_elevator_door"
245
246class CheckedPhotoTerminationMetric(RegionMatchTerminationOnlyMetric):
247    REQUIRED_PARSER = DejaVu1StateParser
248
249    _TERMINATION_NAMED_REGION = "dialogue_box_area"
250    _TERMINATION_TARGET_NAME = "checked_photo"
251
252class ShotDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
253    REQUIRED_PARSER = DejaVu1StateParser
254
255    _TERMINATION_NAMED_REGION = "game_screen_area"
256    _TERMINATION_TARGET_NAME = "shot_door"
257
258class OpenedDeskTerminationMetric(RegionMatchTerminationOnlyMetric):
259    REQUIRED_PARSER = DejaVu1StateParser
260
261    _TERMINATION_NAMED_REGION = "dialogue_box_area"
262    _TERMINATION_TARGET_NAME = "opened_desk"
263
264class UnlockedOfficeDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
265    REQUIRED_PARSER = DejaVu1StateParser
266
267    _TERMINATION_NAMED_REGION = "dialogue_box_area"
268    _TERMINATION_TARGET_NAME = "unlocked_office_door"
269
270class MadeMedicineTerminationMetric(RegionMatchTerminationOnlyMetric):
271    REQUIRED_PARSER = DejaVu1StateParser
272
273    _TERMINATION_NAMED_REGION = "dialogue_box_area"
274    _TERMINATION_TARGET_NAME = "made_medicine"
275
276class TakenMedicineTerminationMetric(RegionMatchTerminationOnlyMetric):
277    REQUIRED_PARSER = DejaVu1StateParser
278
279    _TERMINATION_NAMED_REGION = "dialogue_box_area"
280    _TERMINATION_TARGET_NAME = "taken_medicine"
281
282class ShotLockTerminationMetric(RegionMatchTerminationOnlyMetric):
283    REQUIRED_PARSER = DejaVu1StateParser
284
285    _TERMINATION_NAMED_REGION = "game_screen_area"
286    _TERMINATION_TARGET_NAME = "shot_lock"
287
288class OpenedDiaryTerminationMetric(RegionMatchTerminationOnlyMetric):
289    REQUIRED_PARSER = DejaVu1StateParser
290
291    _TERMINATION_NAMED_REGION = "dialogue_box_area"
292    _TERMINATION_TARGET_NAME = "opened_diary"
293
294class ShotGrimyOfficeDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
295    REQUIRED_PARSER = DejaVu1StateParser
296
297    _TERMINATION_NAMED_REGION = "game_screen_area"
298    _TERMINATION_TARGET_NAME = "shot_door"
299
300class CheckedDeadManTerminationMetric(RegionMatchTerminationOnlyMetric):
301    REQUIRED_PARSER = DejaVu1StateParser
302
303    _TERMINATION_NAMED_REGION = "dialogue_box_area"
304    _TERMINATION_TARGET_NAME = "checked_dead_man"
305
306class OpenedCabinetTerminationMetric(RegionMatchTerminationOnlyMetric):
307    REQUIRED_PARSER = DejaVu1StateParser
308
309    _TERMINATION_NAMED_REGION = "dialogue_box_area"
310    _TERMINATION_TARGET_NAME = "opened_cabinet"
311
312class ExitedGrimyOfficeTerminationMetric(RegionMatchTerminationOnlyMetric):
313    REQUIRED_PARSER = DejaVu1StateParser
314
315    _TERMINATION_NAMED_REGION = "dialogue_box_area"
316    _TERMINATION_TARGET_NAME = "exited_grimy_office"
317
318class OpenedWallSafeTerminationMetric(RegionMatchTerminationOnlyMetric):
319    REQUIRED_PARSER = DejaVu1StateParser
320
321    _TERMINATION_NAMED_REGION = "dialogue_box_area"
322    _TERMINATION_TARGET_NAME = "opened_wall_safe"
323
324class OpenedCarTrunkTerminationMetric(RegionMatchTerminationOnlyMetric):
325    REQUIRED_PARSER = DejaVu1StateParser
326
327    _TERMINATION_NAMED_REGION = "dialogue_box_area"
328    _TERMINATION_TARGET_NAME = "opened_car_trunk"
329
330# deja_vu_2 termination metrics
331class OpenedTrenchCoatPocketTerminationMetric(RegionMatchTerminationOnlyMetric):
332    REQUIRED_PARSER = DejaVu2StateParser
333
334    _TERMINATION_NAMED_REGION = "dialogue_box_area"
335    _TERMINATION_TARGET_NAME = "opened_trench_coat_pocket"
336
337class OpenedBathroomDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
338    REQUIRED_PARSER = DejaVu2StateParser
339
340    _TERMINATION_NAMED_REGION = "dialogue_box_area"
341    _TERMINATION_TARGET_NAME = "opened_door"
342
343class TakenGumTerminationMetric(RegionMatchTerminationOnlyMetric):
344    REQUIRED_PARSER = DejaVu2StateParser
345
346    _TERMINATION_NAMED_REGION = "dialogue_box_area"
347    _TERMINATION_TARGET_NAME = "taken_gum"
348
349class OpenedPantsPocketTerminationMetric(RegionMatchTerminationOnlyMetric):
350    REQUIRED_PARSER = DejaVu2StateParser
351
352    _TERMINATION_NAMED_REGION = "dialogue_box_area"
353    _TERMINATION_TARGET_NAME = "opened_pants_pocket"
354
355class TakenPantsTerminationMetric(RegionMatchTerminationOnlyMetric):
356    REQUIRED_PARSER = DejaVu2StateParser
357
358    _TERMINATION_NAMED_REGION = "dialogue_box_area"
359    _TERMINATION_TARGET_NAME = "taken_pants"
360
361class ClosedPantsPocketTerminationMetric(RegionMatchTerminationOnlyMetric):
362    REQUIRED_PARSER = DejaVu2StateParser
363
364    _TERMINATION_NAMED_REGION = "dialogue_box_area"
365    _TERMINATION_TARGET_NAME = "closed_pants_pocket"
366
367class PutOnTrenchCoatTerminationMetric(RegionMatchTerminationOnlyMetric):
368    REQUIRED_PARSER = DejaVu2StateParser
369
370    _TERMINATION_NAMED_REGION = "dialogue_box_area"
371    _TERMINATION_TARGET_NAME = "put_on_trench_coat"
372
373class PutOnPantsTerminationMetric(RegionMatchTerminationOnlyMetric):
374    REQUIRED_PARSER = DejaVu2StateParser
375
376    _TERMINATION_NAMED_REGION = "dialogue_box_area"
377    _TERMINATION_TARGET_NAME = "put_on_pants"
378
379class OpenedWallet1TerminationMetric(RegionMatchTerminationOnlyMetric):
380    REQUIRED_PARSER = DejaVu2StateParser
381
382    _TERMINATION_NAMED_REGION = "dialogue_box_area"
383    _TERMINATION_TARGET_NAME = "opened_wallet1"
384
385class TakenNewsclip1TerminationMetric(RegionMatchTerminationOnlyMetric):
386    REQUIRED_PARSER = DejaVu2StateParser
387
388    _TERMINATION_NAMED_REGION = "dialogue_box_area"
389    _TERMINATION_TARGET_NAME = "taken_newsclip1"
390
391class TakenLicense1TerminationMetric(RegionMatchTerminationOnlyMetric):
392    REQUIRED_PARSER = DejaVu2StateParser
393
394    _TERMINATION_NAMED_REGION = "dialogue_box_area"
395    _TERMINATION_TARGET_NAME = "taken_license1"
396
397class ClosedWallet1TerminationMetric(RegionMatchTerminationOnlyMetric):
398    REQUIRED_PARSER = DejaVu2StateParser
399
400    _TERMINATION_NAMED_REGION = "dialogue_box_area"
401    _TERMINATION_TARGET_NAME = "closed_wallet1"
402
403class OpenedColdTapTerminationMetric(RegionMatchTerminationOnlyMetric):
404    REQUIRED_PARSER = DejaVu2StateParser
405
406    _TERMINATION_NAMED_REGION = "dialogue_box_area"
407    _TERMINATION_TARGET_NAME = "opened_cold_tap"
408
409class ClosedColdTapTerminationMetric(RegionMatchTerminationOnlyMetric):
410    REQUIRED_PARSER = DejaVu2StateParser
411
412    _TERMINATION_NAMED_REGION = "dialogue_box_area"
413    _TERMINATION_TARGET_NAME = "closed_cold_tap"
414
415class CheckedNewsclip1TerminationMetric(RegionMatchTerminationOnlyMetric):
416    REQUIRED_PARSER = DejaVu2StateParser
417
418    _TERMINATION_NAMED_REGION = "dialogue_box_area"
419    _TERMINATION_TARGET_NAME = "checked_newsclip1"
420
421class TakenRing1TerminationMetric(RegionMatchTerminationOnlyMetric):
422    REQUIRED_PARSER = DejaVu2StateParser
423
424    _TERMINATION_NAMED_REGION = "dialogue_box_area"
425    _TERMINATION_TARGET_NAME = "taken_ring1"
426
427class OpenedDoorFromMapTerminationMetric(RegionMatchTerminationOnlyMetric):
428    REQUIRED_PARSER = DejaVu2StateParser
429
430    _TERMINATION_NAMED_REGION = "dialogue_box_area"
431    _TERMINATION_TARGET_NAME = "opened_room_door"
432
433class ClosedDoorFromMapTerminationMetric(RegionMatchTerminationOnlyMetric):
434    REQUIRED_PARSER = DejaVu2StateParser
435
436    _TERMINATION_NAMED_REGION = "dialogue_box_area"
437    _TERMINATION_TARGET_NAME = "closed_room_door"
438
439class EnteredHallwayTerminationMetric(RegionMatchTerminationOnlyMetric):
440    REQUIRED_PARSER = DejaVu2StateParser
441
442    _TERMINATION_NAMED_REGION = "dialogue_box_area"
443    _TERMINATION_TARGET_NAME = "entered_hallway"
444
445class Bought2ChipsTerminationMetric(RegionMatchTerminationOnlyMetric):
446    REQUIRED_PARSER = DejaVu2StateParser
447
448    _TERMINATION_NAMED_REGION = "dialogue_box_area"
449    _TERMINATION_TARGET_NAME = "bought_2_chips"
450
451class ReturnedToCashierTerminationMetric(RegionMatchTerminationOnlyMetric):
452    REQUIRED_PARSER = DejaVu2StateParser
453
454    _TERMINATION_NAMED_REGION = "dialogue_box_area"
455    _TERMINATION_TARGET_NAME = "returned_cashier"
456
457class CashedOutTerminationMetric(RegionMatchTerminationOnlyMetric):
458    REQUIRED_PARSER = DejaVu2StateParser
459
460    _TERMINATION_NAMED_REGION = "dialogue_box_area"
461    _TERMINATION_TARGET_NAME = "cashed_out"
462
463class OpenedLobbyDoorTerminationMetric(RegionMatchTerminationOnlyMetric):
464    REQUIRED_PARSER = DejaVu2StateParser
465
466    _TERMINATION_NAMED_REGION = "dialogue_box_area"
467    _TERMINATION_TARGET_NAME = "opened_lobby_door"
468
469class ExitedCasinoTerminationMetric(RegionMatchTerminationOnlyMetric):
470    REQUIRED_PARSER = DejaVu2StateParser
471
472    _TERMINATION_NAMED_REGION = "dialogue_box_area"
473    _TERMINATION_TARGET_NAME = "exited_casino"
474
475class TalkedInTrainStationTerminationMetric(RegionMatchTerminationOnlyMetric):
476    REQUIRED_PARSER = DejaVu2StateParser
477
478    _TERMINATION_NAMED_REGION = "dialogue_box_area"
479    _TERMINATION_TARGET_NAME = "talked_in_train_station"
480
481class VisitedCounterTerminationMetric(RegionMatchTerminationOnlyMetric):
482    REQUIRED_PARSER = DejaVu2StateParser
483
484    _TERMINATION_NAMED_REGION = "dialogue_box_area"
485    _TERMINATION_TARGET_NAME = "visited_counter"
486
487class TakenPamphletTerminationMetric(RegionMatchTerminationOnlyMetric):
488    REQUIRED_PARSER = DejaVu2StateParser
489
490    _TERMINATION_NAMED_REGION = "dialogue_box_area"
491    _TERMINATION_TARGET_NAME = "taken_pamphlet"
492
493class CheckedTimetableTerminationMetric(RegionMatchTerminationOnlyMetric):
494    REQUIRED_PARSER = DejaVu2StateParser
495
496    _TERMINATION_NAMED_REGION = "dialogue_box_area"
497    _TERMINATION_TARGET_NAME = "timetable"
498
499class EnteredPlatformTerminationMetric(RegionMatchTerminationOnlyMetric):
500    REQUIRED_PARSER = DejaVu2StateParser
501
502    _TERMINATION_NAMED_REGION = "game_screen_area"
503    _TERMINATION_TARGET_NAME = "on_track6"
504
505class EnteredTrainTerminationMetric(RegionMatchTerminationOnlyMetric):
506    REQUIRED_PARSER = DejaVu2StateParser
507
508    _TERMINATION_NAMED_REGION = "dialogue_box_area"
509    _TERMINATION_TARGET_NAME = "entered_train"
510
511class BoughtTicketTerminationMetric(RegionMatchTerminationOnlyMetric):
512    REQUIRED_PARSER = DejaVu2StateParser
513
514    _TERMINATION_NAMED_REGION = "dialogue_box_area"
515    _TERMINATION_TARGET_NAME = "bought_ticket"
516
517class CheckedGirlTerminationMetric(RegionMatchTerminationOnlyMetric):
518    REQUIRED_PARSER = DejaVu2StateParser
519
520    _TERMINATION_NAMED_REGION = "dialogue_box_area"
521    _TERMINATION_TARGET_NAME = "checked_girl"
522
523class CheckedSignTerminationMetric(RegionMatchTerminationOnlyMetric):
524    REQUIRED_PARSER = DejaVu2StateParser
525
526    _TERMINATION_NAMED_REGION = "dialogue_box_area"
527    _TERMINATION_TARGET_NAME = "checked_sign"
528
529class ChattedSellerTerminationMetric(RegionMatchTerminationOnlyMetric):
530    REQUIRED_PARSER = DejaVu2StateParser
531
532    _TERMINATION_NAMED_REGION = "dialogue_box_area"
533    _TERMINATION_TARGET_NAME = "chatted_seller"
534
535class BoughtNewspaperTerminationMetric(RegionMatchTerminationOnlyMetric):
536    REQUIRED_PARSER = DejaVu2StateParser
537
538    _TERMINATION_NAMED_REGION = "dialogue_box_area"
539    _TERMINATION_TARGET_NAME = "bought_newspaper"
540
541class TakenNewsclip4TerminationMetric(RegionMatchTerminationOnlyMetric):
542    REQUIRED_PARSER = DejaVu2StateParser
543
544    _TERMINATION_NAMED_REGION = "dialogue_box_area"
545    _TERMINATION_TARGET_NAME = "taken_newsclip4"
546
547class EnteredChicagoTaxiTerminationMetric(RegionMatchTerminationOnlyMetric):
548    REQUIRED_PARSER = DejaVu2StateParser
549
550    _TERMINATION_NAMED_REGION = "dialogue_box_area"
551    _TERMINATION_TARGET_NAME = "entered_chicago_taxi"
552
553class ChattedTaxiDriverTerminationMetric(RegionMatchTerminationOnlyMetric):
554    REQUIRED_PARSER = DejaVu2StateParser
555
556    _TERMINATION_NAMED_REGION = "dialogue_box_area"
557    _TERMINATION_TARGET_NAME = "chatted_taxi_driver"
558
559class EnteredMiddleRoomTerminationMetric(RegionMatchTerminationOnlyMetric):
560    REQUIRED_PARSER = DejaVu2StateParser
561
562    _TERMINATION_NAMED_REGION = "dialogue_box_area"
563    _TERMINATION_TARGET_NAME = "entered_middle_room"
564
565class LoadedGunTerminationMetric(RegionMatchTerminationOnlyMetric):
566    REQUIRED_PARSER = DejaVu2StateParser
567
568    _TERMINATION_NAMED_REGION = "dialogue_box_area"
569    _TERMINATION_TARGET_NAME = "loaded_gun"
570
571class OpenedLockTerminationMetric(RegionMatchTerminationOnlyMetric):
572    REQUIRED_PARSER = DejaVu2StateParser
573
574    _TERMINATION_NAMED_REGION = "dialogue_box_area"
575    _TERMINATION_TARGET_NAME = "opened_lock"
576
577class HitBoardTerminationMetric(RegionMatchTerminationOnlyMetric):
578    REQUIRED_PARSER = DejaVu2StateParser
579
580    _TERMINATION_NAMED_REGION = "dialogue_box_area"
581    _TERMINATION_TARGET_NAME = "hit_board"
582
583class OpenedTelephoneTerminationMetric(RegionMatchTerminationOnlyMetric):
584    REQUIRED_PARSER = DejaVu2StateParser
585
586    _TERMINATION_NAMED_REGION = "dialogue_box_area"
587    _TERMINATION_TARGET_NAME = "opened_telephone"
588
589class OpenedBoxTerminationMetric(RegionMatchTerminationOnlyMetric):
590    REQUIRED_PARSER = DejaVu2StateParser
591
592    _TERMINATION_NAMED_REGION = "dialogue_box_area"
593    _TERMINATION_TARGET_NAME = "opened_box"
594
595class OpenedPocketKnifeTerminationMetric(RegionMatchTerminationOnlyMetric):
596    REQUIRED_PARSER = DejaVu2StateParser
597
598    _TERMINATION_NAMED_REGION = "dialogue_box_area"
599    _TERMINATION_TARGET_NAME = "opened_pocket_knife"
600
601class OpenedDoorByKnifeTerminationMetric(RegionMatchTerminationOnlyMetric):
602    REQUIRED_PARSER = DejaVu2StateParser
603
604    _TERMINATION_NAMED_REGION = "dialogue_box_area"
605    _TERMINATION_TARGET_NAME = "opened_door_by_knife"
606
607class PutOnFlashlightTerminationMetric(RegionMatchTerminationOnlyMetric):
608    REQUIRED_PARSER = DejaVu2StateParser
609
610    _TERMINATION_NAMED_REGION = "dialogue_box_area"
611    _TERMINATION_TARGET_NAME = "put_on_flashlight"
612
613class EnteredJoePlaceTerminationMetric(RegionMatchTerminationOnlyMetric):
614    REQUIRED_PARSER = DejaVu2StateParser
615
616    _TERMINATION_NAMED_REGION = "dialogue_box_area"
617    _TERMINATION_TARGET_NAME = "entered_joe_place"
618
619class OpenedSlotLockTerminationMetric(RegionMatchTerminationOnlyMetric):
620    REQUIRED_PARSER = DejaVu2StateParser
621
622    _TERMINATION_NAMED_REGION = "dialogue_box_area"
623    _TERMINATION_TARGET_NAME = "opened_slot_lock"
624
625class TurnOffFlashlightTerminationMetric(RegionMatchTerminationOnlyMetric):
626    REQUIRED_PARSER = DejaVu2StateParser
627
628    _TERMINATION_NAMED_REGION = "dialogue_box_area"
629    _TERMINATION_TARGET_NAME = "turned_off_flashlight"
630
631class GotLocationFromCardTerminationMetric(RegionMatchTerminationOnlyMetric):
632    REQUIRED_PARSER = DejaVu2StateParser
633
634    _TERMINATION_NAMED_REGION = "dialogue_box_area"
635    _TERMINATION_TARGET_NAME = "got_location_from_card"
636
637class OpenedBagWithKnifeTerminationMetric(RegionMatchTerminationOnlyMetric):
638    REQUIRED_PARSER = DejaVu2StateParser
639
640    _TERMINATION_NAMED_REGION = "dialogue_box_area"
641    _TERMINATION_TARGET_NAME = "opened_bag_with_knife"
642
643class AskedAboutNametag2TerminationMetric(RegionMatchTerminationOnlyMetric):
644    REQUIRED_PARSER = DejaVu2StateParser
645
646    _TERMINATION_NAMED_REGION = "dialogue_box_area"
647    _TERMINATION_TARGET_NAME = "asked_about_nametage2"
648
649
650
651# subgoal classes
652# subgoal classes with multiple region match requirements
653class InVacuumMenuSubGoal(AnyRegionMatchSubGoal):
654    NAME = "in_vacuum_menu"
655    _NAMED_REGIONS = ["menu_title_area"]
656    _TARGET_NAMES = ["vacuum_menu"]
657
658class OpenedJoePlaceDoorSubGoal(AnyRegionMatchSubGoal):
659    NAME = "opened_joe_place_door"
660    _NAMED_REGIONS = ["dialogue_box_area"]
661    _TARGET_NAMES = ["opened_joe_place_door"]
662
663class UnlockedMiddleRoomDoorSubGoal(AnyRegionMatchSubGoal):
664    NAME = "unlocked_middle_room_door"
665    _NAMED_REGIONS = ["dialogue_box_area"]
666    _TARGET_NAMES = ["unlocked_middle_door"]
667
668class InCoatPocketMenuSubGoal(AnyRegionMatchSubGoal):
669    NAME = "in_coat_pocket_menu"
670    _NAMED_REGIONS = ["menu_title_area"]
671    _TARGET_NAMES = ["coat_pocket_menu"]
672
673class InWalletMenuSubGoal(AnyRegionMatchSubGoal):
674    NAME = "in_wallet_menu"
675    _NAMED_REGIONS = ["menu_title_area"]
676    _TARGET_NAMES = ["wallet_menu"]
677
678class InGoodsMenuSubGoal(AnyRegionMatchSubGoal):
679    NAME = "in_goods_menu"
680    _NAMED_REGIONS = ["menu_title_area"]
681    _TARGET_NAMES = ["goods_menu"]
682
683class SockoOnScreenSubGoal(AnyRegionMatchSubGoal):
684    NAME = "socko_on_screen"
685    _NAMED_REGIONS = ["game_screen_area"]
686    _TARGET_NAMES = ["socko_on_screen"]
687
688class OpenedCellarDoorOnScreenSubGoal(AnyRegionMatchSubGoal):
689    NAME = "opened_cellar_door_on_screen"
690    _NAMED_REGIONS = ["game_screen_area"]
691    _TARGET_NAMES = ["opened_cellar_door"]
692
693class InTrenchCoatPocketMenuSubGoal(AnyRegionMatchSubGoal):
694    NAME = "in_trench_coat_pocket_menu"
695    _NAMED_REGIONS = ["menu_title_area"]
696    _TARGET_NAMES = ["trench_coat_pocket_menu"]
697
698class InWallet1MenuSubGoal(AnyRegionMatchSubGoal):
699    NAME = "in_wallet1_menu"
700    _NAMED_REGIONS = ["menu_title_area"]
701    _TARGET_NAMES = ["wallet1_menu"]
702
703class Selected2ChipsSubGoal(AnyRegionMatchSubGoal):
704    NAME = "selected_2_chips"
705    _NAMED_REGIONS = ["dialogue_box_area"]
706    _TARGET_NAMES = ["selected_2_chips"]
707
708class OpenedWestendDoorSubGoal(AnyRegionMatchSubGoal):
709    NAME = "opened_westend_door"
710    _NAMED_REGIONS = ["dialogue_box_area"]
711    _TARGET_NAMES = ["opened_westend_door"]
712
713class OpenedShermanDoorSubGoal(AnyRegionMatchSubGoal):
714    NAME = "opened_sherman_door"
715    _NAMED_REGIONS = ["dialogue_box_area"]
716    _TARGET_NAMES = ["opened_sherman_door"]
717
718# subgoal classes for no action selected
719class NoActionInCellarSubGoal(AnyRegionMatchSubGoal):
720    NAME = "no_action_in_cellar"
721    _NAMED_REGIONS = ["no_action"]
722    _TARGET_NAMES = ["in_cellar"]
723
724class NoActionInEmptyRestaurantSubGoal(AnyRegionMatchSubGoal):
725    NAME = "no_action_in_empty_restaurant"
726    _NAMED_REGIONS = ["no_action"]
727    _TARGET_NAMES = ["in_empty_restaurant"]
728
729class NoActionOnPeoriaStSubGoal(AnyRegionMatchSubGoal):
730    NAME = "no_action_on_peoria_st"
731    _NAMED_REGIONS = ["no_action"]
732    _TARGET_NAMES = ["on_peoria_st"]
733
734class NoActionInLobbySubGoal(AnyRegionMatchSubGoal):
735    NAME = "no_action_in_lobby"
736    _NAMED_REGIONS = ["no_action"]
737    _TARGET_NAMES = ["in_lobby"]
738
739class NoActionInShermanLobbySubGoal(AnyRegionMatchSubGoal):
740    NAME = "no_action_in_sherman_lobby"
741    _NAMED_REGIONS = ["no_action"]
742    _TARGET_NAMES = ["in_sherman_lobby"]
743
744class NoActionInWestendLobbySubGoal(AnyRegionMatchSubGoal):
745    NAME = "no_action_in_westend_lobby"
746    _NAMED_REGIONS = ["no_action"]
747    _TARGET_NAMES = ["in_westend_lobby"]
748
749class NoActionInGrimyOfficeSubGoal(AnyRegionMatchSubGoal):
750    NAME = "no_action_in_grimy_office"
751    _NAMED_REGIONS = ["no_action"]
752    _TARGET_NAMES = ["in_grimy_office"]
753
754# subgoal classes with single region match requirement
755class UsingNametag2SubGoal(SingleRegionMatchSubGoal):
756    NAME = "using_nametag2"
757    _NAMED_REGION = "using_nametag2_item"
758
759class UsingFlashlightSubGoal(SingleRegionMatchSubGoal):
760    NAME = "using_flashlight"
761    _NAMED_REGION = "using_flashlight_item"
762
763class UsingKey4SubGoal(SingleRegionMatchSubGoal):
764    NAME = "using_key4"
765    _NAMED_REGION = "using_key4_item"
766
767class UsingKnifeSubGoal(SingleRegionMatchSubGoal):
768    NAME = "using_knife"
769    _NAMED_REGION = "using_knife_item"
770
771class UsingKey4SubGoal(SingleRegionMatchSubGoal):
772    NAME = "using_key4"
773    _NAMED_REGION = "using_key4_item"
774
775class UsingNote3SubGoal(SingleRegionMatchSubGoal):
776    NAME = "using_note3"
777    _NAMED_REGION = "using_note3_item"
778
779class UsingKey2SubGoal(SingleRegionMatchSubGoal):
780    NAME = "using_key2"
781    _NAMED_REGION = "using_key2_item"
782
783class UsingKey1SubGoal(SingleRegionMatchSubGoal):
784    NAME = "using_key1"
785    _NAMED_REGION = "using_key1_item"
786
787class UsingCashSubGoal(SingleRegionMatchSubGoal):
788    NAME = "using_cash"
789    _NAMED_REGION = "using_cash_item"
790
791class UsingBulletSubGoal(SingleRegionMatchSubGoal):
792    NAME = "using_bullet"
793    _NAMED_REGION = "using_bullet_item"
794
795class PointedAtCoatSubGoal(SingleRegionMatchSubGoal):
796    NAME = "pointed_at_coat"
797    _NAMED_REGION = "selected_coat_item"
798
799class PointedAtWalletSubGoal(SingleRegionMatchSubGoal):
800    NAME = "pointed_at_wallet"
801    _NAMED_REGION = "selected_wallet_item"
802
803class PointedAtGumSubGoal(SingleRegionMatchSubGoal):
804    NAME = "pointed_at_gum"
805    _NAMED_REGION = "selected_gum_item"
806
807class PointedAtPantsSubGoal(SingleRegionMatchSubGoal):
808    NAME = "pointed_at_pants"
809    _NAMED_REGION = "selected_pants_item"
810
811class PointedAtTrenchCoatSubGoal(SingleRegionMatchSubGoal):
812    NAME = "pointed_at_trench_coat"
813    _NAMED_REGION = "selected_trench_coat_item"
814
815class SelectedOutfitButtonSubGoal(SingleRegionMatchSubGoal):
816    NAME = "selected_outfit_button"
817    _NAMED_REGION = "selected_outfit_button"
818
819class PointedAtWallet1SubGoal(SingleRegionMatchSubGoal):
820    NAME = "pointed_at_wallet1"
821    _NAMED_REGION = "selected_wallet1_item"
822
823class PointedAtNewsclip1SubGoal(SingleRegionMatchSubGoal):
824    NAME = "pointed_at_newsclip1"
825    _NAMED_REGION = "selected_newsclip1_item"
826
827class PointedAtLicense1SubGoal(SingleRegionMatchSubGoal):
828    NAME = "pointed_at_license1"
829    _NAMED_REGION = "selected_license1_item"
830
831class PointedAt21OnMapSubGoal(SingleRegionMatchSubGoal):
832    NAME = "pointed_at_21_on_map"
833    _NAMED_REGION = "pointed_at_21_on_map"
834
835class PointedAt13OnMapSubGoal(SingleRegionMatchSubGoal):
836    NAME = "pointed_at_13_on_map"
837    _NAMED_REGION = "pointed_at_13_on_map"
838
839class PointedAt11OnMapSubGoal(SingleRegionMatchSubGoal):
840    NAME = "pointed_at_11_on_map"
841    _NAMED_REGION = "pointed_at_11_on_map"
842
843class PointedAtCoinSubGoal(SingleRegionMatchSubGoal):
844    NAME = "pointed_at_coin"
845    _NAMED_REGION = "selected_coin_item"
846
847class UsingCoinSubGoal(SingleRegionMatchSubGoal):
848    NAME = "using_coin"
849    _NAMED_REGION = "using_coin_item"
850
851class UsingKey3SubGoal(SingleRegionMatchSubGoal):
852    NAME = "using_key3"
853    _NAMED_REGION = "using_key3_item"
854
855class UsingKey2SubGoal(SingleRegionMatchSubGoal):
856    NAME = "using_key2"
857    _NAMED_REGION = "using_key2_item"
858
859class PointedAtWestendAddressSubGoal(SingleRegionMatchSubGoal):
860    NAME = "pointed_at_westend_address"
861    _NAMED_REGION = "selected_westend_address"
862
863class PointedAt25OnMapSubGoal(SingleRegionMatchSubGoal):
864    NAME = "pointed_at_25_on_map"
865    _NAMED_REGION = "pointed_at_25_on_map"
866
867class PointedAt35OnMapSubGoal(SingleRegionMatchSubGoal):
868    NAME = "pointed_at_35_on_map"
869    _NAMED_REGION = "pointed_at_35_on_map"
870
871class PointedAt41OnMapSubGoal(SingleRegionMatchSubGoal):
872    NAME = "pointed_at_41_on_map"
873    _NAMED_REGION = "pointed_at_41_on_map"
874
875class PointedAt45OnMapSubGoal(SingleRegionMatchSubGoal):
876    NAME = "pointed_at_45_on_map"
877    _NAMED_REGION = "pointed_at_45_on_map"
878
879class PointedAt52OnMapSubGoal(SingleRegionMatchSubGoal):
880    NAME = "pointed_at_52_on_map"
881    _NAMED_REGION = "pointed_at_52_on_map"
882
883class PointedAt24OnMapSubGoal(SingleRegionMatchSubGoal):
884    NAME = "pointed_at_24_on_map"
885    _NAMED_REGION = "pointed_at_24_on_map"
886
887class PointedAt54OnMapSubGoal(SingleRegionMatchSubGoal):
888    NAME = "pointed_at_54_on_map"
889    _NAMED_REGION = "pointed_at_54_on_map"
890
891
892# Action selection subgoals in menu and normal have the same target names
893# Menu action selection subgoals
894# class NoActionSelectedInMenuSubGoal(AnyRegionMatchSubGoal):
895#     NAME = "no_action_selected_in_menu"
896#     _NAMED_REGIONS = ["action_bar_in_menu"]
897#     _TARGET_NAMES = ["no_action_selected"]
898
899class SelectedWatchActionInMenuSubGoal(SingleRegionMatchSubGoal):
900    NAME = "selected_watch_action_in_menu"
901    _NAMED_REGION = "selected_watch_action_in_menu"
902
903class SelectedUseActionInMenuSubGoal(SingleRegionMatchSubGoal):
904    NAME = "selected_use_action_in_menu"
905    _NAMED_REGION = "selected_use_action_in_menu"
906
907class SelectedTakeActionInMenuSubGoal(SingleRegionMatchSubGoal):
908    NAME = "selected_take_action_in_menu"
909    _NAMED_REGION = "selected_take_action_in_menu"
910
911class SelectedOpenActionInMenuSubGoal(SingleRegionMatchSubGoal):
912    NAME = "selected_open_action_in_menu"
913    _NAMED_REGION = "selected_open_action_in_menu"
914
915class SelectedCloseActionInMenuSubGoal(SingleRegionMatchSubGoal):
916    NAME = "selected_close_action_in_menu"
917    _NAMED_REGION = "selected_close_action_in_menu"
918
919# Normal action selection subgoals
920class SelectedWatchActionInNormalSubGoal(SingleRegionMatchSubGoal):
921    NAME = "selected_watch_action_in_normal"
922    _NAMED_REGION = "selected_watch_action_in_normal"
923
924class SelectedTakeActionInNormalSubGoal(SingleRegionMatchSubGoal):
925    NAME = "selected_take_action_in_normal"
926    _NAMED_REGION = "selected_take_action_in_normal"
927
928class SelectedOpenActionInNormalSubGoal(SingleRegionMatchSubGoal):
929    NAME = "selected_open_action_in_normal"
930    _NAMED_REGION = "selected_open_action_in_normal"
931
932class SelectedCloseActionInNormalSubGoal(SingleRegionMatchSubGoal):
933    NAME = "selected_close_action_in_normal"
934    _NAMED_REGION = "selected_close_action_in_normal"
935
936class SelectedTalkActionInNormalSubGoal(SingleRegionMatchSubGoal):
937    NAME = "selected_talk_action_in_normal"
938    _NAMED_REGION = "selected_talk_action_in_normal"
939
940class SelectedHitActionInNormalSubGoal(SingleRegionMatchSubGoal):
941    NAME = "selected_hit_action_in_normal"
942    _NAMED_REGION = "selected_hit_action_in_normal"