 294a67a4b4
			
		
	
	294a67a4b4
	
	
	
		
			
			Changelog:
Features:
- New Goal
  - Minigame Madness
    - Win a certain number of each type of Minigame Trap, then defeat the Finalhazard to win!
	- How many of each Minigame are required can be set by an Option
	- When the required amount of a Minigame has been received, that Minigame can be replayed in the Chao World Lobby
- New optional Location Checks
  - Bigsanity
    - Go fishing with Big in each stage for a Location Check
  - Itemboxsanity
    - Either Extra Life Boxes or All Item Boxes
- New Items
  - New Traps
    - Literature Trap
	- Controller Drift Trap
	- Poison Trap
	- Bee Trap
  - New Minigame Traps
    - Breakout Trap
	- Fishing Trap
	- Trivia Trap
	- Pokemon Trivia Trap
	- Pokemon Count Trap
	- Number Sequence Trap
	- Light Up Path Trap
	- Pinball Trap
	- Math Quiz Trap
	- Snake Trap
	- Input Sequence Trap
- Trap Link
  - When you receive a trap, you send a copy of it to every other player with Trap Link enabled
- Boss Gate Plando
- Expert Logic Difficulty
	- Use at your own risk. This difficulty requires complete mastery of SA2.
- Missions can now be enabled and disabled per-character, instead of just per-style
- Minigame Difficulty can now be set to "Chaos", which selects a new difficulty randomly per-trap received
Quality of Life:
- Gate Stages and Mission Orders are now displayed in the spoiler log
- Additional play stats are saved and displayed with the randomizer credits
- Stage Locations progress UI now displays in multiple pages when Itemboxsanity is enabled
- Current stage mission order and progress are now shown when paused in-level
- Chaos Emeralds are now shown when paused in-level
- Location Name Groups were created
- Moved SA2B to the new Options system
- Option Presets were created
- Error Messages are more obvious
Bug Fixes:
- Added missing `Dry Lagoon - 12 Animals` location
- Flying Dog boss should no longer crash when you have done at least 3 Intermediate Kart Races
- Invincibility can no longer be received in the King Boom Boo fight, preventing a crash
- Chaos Emeralds should no longer disproportionately end up in Cannon's Core or the final Level Gate
- Going into submenus from the pause menu should no longer reset traps
- `Sonic - Magic Gloves` are now plural
- Junk items will no longer cause a crash when in a falling state
- Chao Garden:
	- Prevent races from occasionally becoming uncompletable when using the "Prize Only" option
	- Properly allow Hero Chao to participate in Dark Races
	- Don't allow the Chao Garden to send locations when connected to an invalid server
	- Prevent the Chao Garden from resetting your life count
	- Fix Chao World Entrance Shuffle causing inaccessible Neutral Garden
	- Fix pressing the 'B' button to take you to the proper location in Chao World Entrance Shuffle
	- Prevent Chao Karate progress icon overflow
	- Prevent changing Chao Timescale while paused or while a Minigame is active
- Logic Fixes:
	- `Mission Street - Chao Key 1` (Hard Logic) now requires no upgrades
	- `Mission Street - Chao Key 2` (Hard Logic) now requires no upgrades
	- `Crazy Gadget - Hidden 1` (Standard Logic) now requires `Sonic - Bounce Bracelet` instead of `Sonic - Light Shoes`
	- `Lost Colony - Hidden 1` (Standard Logic) now requires `Eggman - Jet Engine`
	- `Mad Space - Gold Beetle` (Standard Logic) now only requires `Rouge - Iron Boots`
	- `Cosmic Wall - Gold Beetle` (Standard and Hard Logic) now only requires `Eggman - Jet Engine`
		
	
		
			
				
	
	
		
			291 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			291 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
| import typing
 | |
| 
 | |
| from BaseClasses import Item, ItemClassification
 | |
| from .Names import ItemName
 | |
| 
 | |
| 
 | |
| class ItemData(typing.NamedTuple):
 | |
|     code: typing.Optional[int]
 | |
|     progression: bool
 | |
|     trap: bool = False
 | |
|     quantity: int = 1
 | |
|     event: bool = False
 | |
| 
 | |
| 
 | |
| class SA2BItem(Item):
 | |
|     game: str = "Sonic Adventure 2 Battle"
 | |
| 
 | |
|     def __init__(self, name, classification: ItemClassification, code: int = None, player: int = None):
 | |
|         super(SA2BItem, self).__init__(name, classification, code, player)
 | |
| 
 | |
| 
 | |
| # Separate tables for each type of item.
 | |
| emblems_table = {
 | |
|     ItemName.emblem:       ItemData(0xFF0000, True),
 | |
|     ItemName.market_token: ItemData(0xFF001F, True),
 | |
| }
 | |
| 
 | |
| upgrades_table = {
 | |
|     ItemName.sonic_gloves:          ItemData(0xFF0001, False),
 | |
|     ItemName.sonic_light_shoes:     ItemData(0xFF0002, True),
 | |
|     ItemName.sonic_ancient_light:   ItemData(0xFF0003, False),
 | |
|     ItemName.sonic_bounce_bracelet: ItemData(0xFF0004, True),
 | |
|     ItemName.sonic_flame_ring:      ItemData(0xFF0005, True),
 | |
|     ItemName.sonic_mystic_melody:   ItemData(0xFF0006, True),
 | |
|     
 | |
|     ItemName.tails_laser_blaster: ItemData(0xFF0007, False),
 | |
|     ItemName.tails_booster:       ItemData(0xFF0008, True),
 | |
|     ItemName.tails_mystic_melody: ItemData(0xFF0009, True),
 | |
|     ItemName.tails_bazooka:       ItemData(0xFF000A, True),
 | |
| 
 | |
|     ItemName.knuckles_mystic_melody: ItemData(0xFF000B, True),
 | |
|     ItemName.knuckles_shovel_claws:  ItemData(0xFF000C, True),
 | |
|     ItemName.knuckles_air_necklace:  ItemData(0xFF000D, True),
 | |
|     ItemName.knuckles_hammer_gloves: ItemData(0xFF000E, True),
 | |
|     ItemName.knuckles_sunglasses:    ItemData(0xFF000F, True),
 | |
|     
 | |
|     ItemName.shadow_flame_ring:    ItemData(0xFF0010, True),
 | |
|     ItemName.shadow_air_shoes:     ItemData(0xFF0011, True),
 | |
|     ItemName.shadow_ancient_light: ItemData(0xFF0012, False),
 | |
|     ItemName.shadow_mystic_melody: ItemData(0xFF0013, True),
 | |
|     
 | |
|     ItemName.eggman_laser_blaster:    ItemData(0xFF0014, False),
 | |
|     ItemName.eggman_mystic_melody:    ItemData(0xFF0015, True),
 | |
|     ItemName.eggman_jet_engine:       ItemData(0xFF0016, True),
 | |
|     ItemName.eggman_large_cannon:     ItemData(0xFF0017, True),
 | |
|     ItemName.eggman_protective_armor: ItemData(0xFF0018, False),
 | |
| 
 | |
|     ItemName.rouge_mystic_melody:  ItemData(0xFF0019, True),
 | |
|     ItemName.rouge_pick_nails:     ItemData(0xFF001A, True),
 | |
|     ItemName.rouge_treasure_scope: ItemData(0xFF001B, True),
 | |
|     ItemName.rouge_iron_boots:     ItemData(0xFF001C, True),
 | |
| }
 | |
| 
 | |
| junk_table = {
 | |
|     ItemName.five_rings:      ItemData(0xFF0020, False),
 | |
|     ItemName.ten_rings:       ItemData(0xFF0021, False),
 | |
|     ItemName.twenty_rings:    ItemData(0xFF0022, False),
 | |
|     ItemName.extra_life:      ItemData(0xFF0023, False),
 | |
|     ItemName.shield:          ItemData(0xFF0024, False),
 | |
|     ItemName.magnetic_shield: ItemData(0xFF0025, False),
 | |
|     ItemName.invincibility:   ItemData(0xFF0026, False),
 | |
| }
 | |
| 
 | |
| trap_table = {
 | |
|     ItemName.omochao_trap:          ItemData(0xFF0030, False, True),
 | |
|     ItemName.timestop_trap:         ItemData(0xFF0031, False, True),
 | |
|     ItemName.confuse_trap:          ItemData(0xFF0032, False, True),
 | |
|     ItemName.tiny_trap:             ItemData(0xFF0033, False, True),
 | |
|     ItemName.gravity_trap:          ItemData(0xFF0034, False, True),
 | |
|     ItemName.exposition_trap:       ItemData(0xFF0035, False, True),
 | |
|     #ItemName.darkness_trap:         ItemData(0xFF0036, False, True),
 | |
|     ItemName.ice_trap:              ItemData(0xFF0037, False, True),
 | |
|     ItemName.slow_trap:             ItemData(0xFF0038, False, True),
 | |
|     ItemName.cutscene_trap:         ItemData(0xFF0039, False, True),
 | |
|     ItemName.reverse_trap:          ItemData(0xFF003A, False, True),
 | |
|     ItemName.literature_trap:       ItemData(0xFF003B, False, True),
 | |
|     ItemName.controller_drift_trap: ItemData(0xFF003C, False, True),
 | |
|     ItemName.poison_trap:           ItemData(0xFF003D, False, True),
 | |
|     ItemName.bee_trap:              ItemData(0xFF003E, False, True),
 | |
| }
 | |
| 
 | |
| minigame_trap_table = {
 | |
|     ItemName.pong_trap:            ItemData(0xFF0050, False, True),
 | |
|     ItemName.breakout_trap:        ItemData(0xFF0051, False, True),
 | |
|     ItemName.fishing_trap:         ItemData(0xFF0052, False, True),
 | |
|     ItemName.trivia_trap:          ItemData(0xFF0053, False, True),
 | |
|     ItemName.pokemon_trivia_trap:  ItemData(0xFF0054, False, True),
 | |
|     ItemName.pokemon_count_trap:   ItemData(0xFF0055, False, True),
 | |
|     ItemName.number_sequence_trap: ItemData(0xFF0056, False, True),
 | |
|     ItemName.light_up_path_trap:   ItemData(0xFF0057, False, True),
 | |
|     ItemName.pinball_trap:         ItemData(0xFF0058, False, True),
 | |
|     ItemName.math_quiz_trap:       ItemData(0xFF0059, False, True),
 | |
|     ItemName.snake_trap:           ItemData(0xFF005A, False, True),
 | |
|     ItemName.input_sequence_trap:  ItemData(0xFF005B, False, True),
 | |
| }
 | |
| 
 | |
| emeralds_table = {
 | |
|     ItemName.white_emerald:  ItemData(0xFF0040, True),
 | |
|     ItemName.red_emerald:    ItemData(0xFF0041, True),
 | |
|     ItemName.cyan_emerald:   ItemData(0xFF0042, True),
 | |
|     ItemName.purple_emerald: ItemData(0xFF0043, True),
 | |
|     ItemName.green_emerald:  ItemData(0xFF0044, True),
 | |
|     ItemName.yellow_emerald: ItemData(0xFF0045, True),
 | |
|     ItemName.blue_emerald:   ItemData(0xFF0046, True),
 | |
| }
 | |
| 
 | |
| eggs_table = {
 | |
|     ItemName.normal_egg:              ItemData(0xFF0100, False),
 | |
|     ItemName.yellow_monotone_egg:     ItemData(0xFF0101, False),
 | |
|     ItemName.white_monotone_egg:      ItemData(0xFF0102, False),
 | |
|     ItemName.brown_monotone_egg:      ItemData(0xFF0103, False),
 | |
|     ItemName.sky_blue_monotone_egg:   ItemData(0xFF0104, False),
 | |
|     ItemName.pink_monotone_egg:       ItemData(0xFF0105, False),
 | |
|     ItemName.blue_monotone_egg:       ItemData(0xFF0106, False),
 | |
|     ItemName.grey_monotone_egg:       ItemData(0xFF0107, False),
 | |
|     ItemName.green_monotone_egg:      ItemData(0xFF0108, False),
 | |
|     ItemName.red_monotone_egg:        ItemData(0xFF0109, False),
 | |
|     ItemName.lime_green_monotone_egg: ItemData(0xFF010A, False),
 | |
|     ItemName.purple_monotone_egg:     ItemData(0xFF010B, False),
 | |
|     ItemName.orange_monotone_egg:     ItemData(0xFF010C, False),
 | |
|     ItemName.black_monotone_egg:      ItemData(0xFF010D, False),
 | |
| 
 | |
|     ItemName.yellow_twotone_egg:     ItemData(0xFF010E, False),
 | |
|     ItemName.white_twotone_egg:      ItemData(0xFF010F, False),
 | |
|     ItemName.brown_twotone_egg:      ItemData(0xFF0110, False),
 | |
|     ItemName.sky_blue_twotone_egg:   ItemData(0xFF0111, False),
 | |
|     ItemName.pink_twotone_egg:       ItemData(0xFF0112, False),
 | |
|     ItemName.blue_twotone_egg:       ItemData(0xFF0113, False),
 | |
|     ItemName.grey_twotone_egg:       ItemData(0xFF0114, False),
 | |
|     ItemName.green_twotone_egg:      ItemData(0xFF0115, False),
 | |
|     ItemName.red_twotone_egg:        ItemData(0xFF0116, False),
 | |
|     ItemName.lime_green_twotone_egg: ItemData(0xFF0117, False),
 | |
|     ItemName.purple_twotone_egg:     ItemData(0xFF0118, False),
 | |
|     ItemName.orange_twotone_egg:     ItemData(0xFF0119, False),
 | |
|     ItemName.black_twotone_egg:      ItemData(0xFF011A, False),
 | |
| 
 | |
|     ItemName.normal_shiny_egg:     ItemData(0xFF011B, False),
 | |
|     ItemName.yellow_shiny_egg:     ItemData(0xFF011C, False),
 | |
|     ItemName.white_shiny_egg:      ItemData(0xFF011D, False),
 | |
|     ItemName.brown_shiny_egg:      ItemData(0xFF011E, False),
 | |
|     ItemName.sky_blue_shiny_egg:   ItemData(0xFF011F, False),
 | |
|     ItemName.pink_shiny_egg:       ItemData(0xFF0120, False),
 | |
|     ItemName.blue_shiny_egg:       ItemData(0xFF0121, False),
 | |
|     ItemName.grey_shiny_egg:       ItemData(0xFF0122, False),
 | |
|     ItemName.green_shiny_egg:      ItemData(0xFF0123, False),
 | |
|     ItemName.red_shiny_egg:        ItemData(0xFF0124, False),
 | |
|     ItemName.lime_green_shiny_egg: ItemData(0xFF0125, False),
 | |
|     ItemName.purple_shiny_egg:     ItemData(0xFF0126, False),
 | |
|     ItemName.orange_shiny_egg:     ItemData(0xFF0127, False),
 | |
|     ItemName.black_shiny_egg:      ItemData(0xFF0128, False),
 | |
| }
 | |
| 
 | |
| fruits_table = {
 | |
|     ItemName.chao_garden_fruit: ItemData(0xFF0200, False),
 | |
|     ItemName.hero_garden_fruit: ItemData(0xFF0201, False),
 | |
|     ItemName.dark_garden_fruit: ItemData(0xFF0202, False),
 | |
| 
 | |
|     ItemName.strong_fruit:   ItemData(0xFF0203, False),
 | |
|     ItemName.tasty_fruit:    ItemData(0xFF0204, False),
 | |
|     ItemName.hero_fruit:     ItemData(0xFF0205, False),
 | |
|     ItemName.dark_fruit:     ItemData(0xFF0206, False),
 | |
|     ItemName.round_fruit:    ItemData(0xFF0207, False),
 | |
|     ItemName.triangle_fruit: ItemData(0xFF0208, False),
 | |
|     ItemName.square_fruit:   ItemData(0xFF0209, False),
 | |
|     ItemName.heart_fruit:    ItemData(0xFF020A, False),
 | |
|     ItemName.chao_fruit:     ItemData(0xFF020B, False),
 | |
|     ItemName.smart_fruit:    ItemData(0xFF020C, False),
 | |
| 
 | |
|     ItemName.orange_fruit: ItemData(0xFF020D, False),
 | |
|     ItemName.blue_fruit:   ItemData(0xFF020E, False),
 | |
|     ItemName.pink_fruit:   ItemData(0xFF020F, False),
 | |
|     ItemName.green_fruit:  ItemData(0xFF0210, False),
 | |
|     ItemName.purple_fruit: ItemData(0xFF0211, False),
 | |
|     ItemName.yellow_fruit: ItemData(0xFF0212, False),
 | |
|     ItemName.red_fruit:    ItemData(0xFF0213, False),
 | |
| 
 | |
|     ItemName.mushroom_fruit:       ItemData(0xFF0214, False),
 | |
|     ItemName.super_mushroom_fruit: ItemData(0xFF0215, False),
 | |
|     ItemName.mint_candy_fruit:     ItemData(0xFF0216, False),
 | |
|     ItemName.grapes_fruit:         ItemData(0xFF0217, False),
 | |
| }
 | |
| 
 | |
| seeds_table = {
 | |
|     ItemName.strong_seed:   ItemData(0xFF0300, False),
 | |
|     ItemName.tasty_seed:    ItemData(0xFF0301, False),
 | |
|     ItemName.hero_seed:     ItemData(0xFF0302, False),
 | |
|     ItemName.dark_seed:     ItemData(0xFF0303, False),
 | |
|     ItemName.round_seed:    ItemData(0xFF0304, False),
 | |
|     ItemName.triangle_seed: ItemData(0xFF0305, False),
 | |
|     ItemName.square_seed:   ItemData(0xFF0306, False),
 | |
| }
 | |
| 
 | |
| hats_table = {
 | |
|     ItemName.pumpkin_hat:       ItemData(0xFF0401, False),
 | |
|     ItemName.skull_hat:         ItemData(0xFF0402, False),
 | |
|     ItemName.apple_hat:         ItemData(0xFF0403, False),
 | |
|     ItemName.bucket_hat:        ItemData(0xFF0404, False),
 | |
|     ItemName.empty_can_hat:     ItemData(0xFF0405, False),
 | |
|     ItemName.cardboard_box_hat: ItemData(0xFF0406, False),
 | |
|     ItemName.flower_pot_hat:    ItemData(0xFF0407, False),
 | |
|     ItemName.paper_bag_hat:     ItemData(0xFF0408, False),
 | |
|     ItemName.pan_hat:           ItemData(0xFF0409, False),
 | |
|     ItemName.stump_hat:         ItemData(0xFF040A, False),
 | |
|     ItemName.watermelon_hat:    ItemData(0xFF040B, False),
 | |
| 
 | |
|     ItemName.red_wool_beanie_hat:   ItemData(0xFF040C, False),
 | |
|     ItemName.blue_wool_beanie_hat:  ItemData(0xFF040D, False),
 | |
|     ItemName.black_wool_beanie_hat: ItemData(0xFF040E, False),
 | |
|     ItemName.pacifier_hat:          ItemData(0xFF040F, False),
 | |
| }
 | |
| 
 | |
| animals_table = {
 | |
|     ItemName.animal_penguin:      ItemData(0xFF0500, False),
 | |
|     ItemName.animal_seal:         ItemData(0xFF0501, False),
 | |
|     ItemName.animal_otter:        ItemData(0xFF0502, False),
 | |
|     ItemName.animal_rabbit:       ItemData(0xFF0503, False),
 | |
|     ItemName.animal_cheetah:      ItemData(0xFF0504, False),
 | |
|     ItemName.animal_warthog:      ItemData(0xFF0505, False),
 | |
|     ItemName.animal_bear:         ItemData(0xFF0506, False),
 | |
|     ItemName.animal_tiger:        ItemData(0xFF0507, False),
 | |
|     ItemName.animal_gorilla:      ItemData(0xFF0508, False),
 | |
|     ItemName.animal_peacock:      ItemData(0xFF0509, False),
 | |
|     ItemName.animal_parrot:       ItemData(0xFF050A, False),
 | |
|     ItemName.animal_condor:       ItemData(0xFF050B, False),
 | |
|     ItemName.animal_skunk:        ItemData(0xFF050C, False),
 | |
|     ItemName.animal_sheep:        ItemData(0xFF050D, False),
 | |
|     ItemName.animal_raccoon:      ItemData(0xFF050E, False),
 | |
|     ItemName.animal_halffish:     ItemData(0xFF050F, False),
 | |
|     ItemName.animal_skeleton_dog: ItemData(0xFF0510, False),
 | |
|     ItemName.animal_bat:          ItemData(0xFF0511, False),
 | |
|     ItemName.animal_dragon:       ItemData(0xFF0512, False),
 | |
|     ItemName.animal_unicorn:      ItemData(0xFF0513, False),
 | |
|     ItemName.animal_phoenix:      ItemData(0xFF0514, False),
 | |
| }
 | |
| 
 | |
| chaos_drives_table = {
 | |
|     ItemName.chaos_drive_yellow: ItemData(0xFF0515, False),
 | |
|     ItemName.chaos_drive_green:  ItemData(0xFF0516, False),
 | |
|     ItemName.chaos_drive_red:    ItemData(0xFF0517, False),
 | |
|     ItemName.chaos_drive_purple: ItemData(0xFF0518, False),
 | |
| }
 | |
| 
 | |
| event_table = {
 | |
|     ItemName.maria: ItemData(None, True),
 | |
| }
 | |
| 
 | |
| # Complete item table.
 | |
| item_table = {
 | |
|     **emblems_table,
 | |
|     **upgrades_table,
 | |
|     **junk_table,
 | |
|     **trap_table,
 | |
|     **minigame_trap_table,
 | |
|     **emeralds_table,
 | |
|     **eggs_table,
 | |
|     **fruits_table,
 | |
|     **seeds_table,
 | |
|     **hats_table,
 | |
|     **animals_table,
 | |
|     **chaos_drives_table,
 | |
| }
 | |
| 
 | |
| lookup_id_to_name: typing.Dict[int, str] = {data.code: item_name for item_name, data in item_table.items() if data.code}
 | |
| 
 | |
| item_groups: typing.Dict[str, str] = {
 | |
|     "Chaos Emeralds": list(emeralds_table.keys()),
 | |
|     "Eggs":           list(eggs_table.keys()),
 | |
|     "Fruits":         list(fruits_table.keys()),
 | |
|     "Seeds":          list(seeds_table.keys()),
 | |
|     "Hats":           list(hats_table.keys()),
 | |
|     "Traps":          list(trap_table.keys()),
 | |
|     "Minigames":      list(minigame_trap_table.keys()),
 | |
| }
 | |
| 
 | |
| try:
 | |
|     from worlds.alttp import ALTTPWorld
 | |
|     ALTTPWorld.pedestal_credit_texts[item_table[ItemName.sonic_light_shoes].code] = "and the Soap Shoes"
 | |
|     ALTTPWorld.pedestal_credit_texts[item_table[ItemName.shadow_air_shoes].code] = "and the Soap Shoes"
 | |
| except ModuleNotFoundError:
 | |
|     pass
 |