Archipelago/worlds/sc2wol/Options.py

from typing import Dict
from BaseClasses import MultiWorld
from Options import Choice, Option, DefaultOnToggle


class GameDifficulty(Choice):
    """The difficulty of the campaign, affects enemy AI, starting units, and game speed."""
    display_name = "Game Difficulty"
    option_casual = 0
    option_normal = 1
    option_hard = 2
    option_brutal = 3


class UpgradeBonus(Choice):
    """Determines what lab upgrade to use, whether it is Ultra-Capacitors which boost attack speed with every weapon upgrade
    or Vanadium Plating which boosts life with every armor upgrade."""
    display_name = "Upgrade Bonus"
    option_ultra_capacitors = 0
    option_vanadium_plating = 1


class BunkerUpgrade(Choice):
    """Determines what bunker lab upgrade to use, whether it is Shrike Turret which outfits bunkers with an automated turret or
    Fortified Bunker which boosts the life of bunkers."""
    display_name = "Bunker Upgrade"
    option_shrike_turret = 0
    option_fortified_bunker = 1


class AllInMap(Choice):
    """Determines what version of All-In (final map) that will be generated for the campaign."""
    display_name = "All In Map"
    option_ground = 0
    option_air = 1


class MissionOrder(Choice):
    """Determines the order the missions are played in.
    Vanilla: Keeps the standard mission order and branching from the WoL Campaign.
    Vanilla Shuffled: Keeps same branching paths from the WoL Campaign but randomizes the order of missions within."""
    display_name = "Mission Order"
    option_vanilla = 0
    option_vanilla_shuffled = 1


class ShuffleProtoss(DefaultOnToggle):
    """Determines if the 3 protoss missions are included in the shuffle if Vanilla Shuffled is enabled.  If this is
    not the 3 protoss missions will stay in their vanilla order in the mission order making them optional to complete
    the game."""
    display_name = "Shuffle Protoss Missions"


class RelegateNoBuildMissions(DefaultOnToggle):
    """If enabled, all no build missions besides the needed first one will be placed at the end of optional routes so
    that none of them become required to complete the game.  Only takes effect if mission order is not set to vanilla."""
    display_name = "Relegate No-Build Missions"


# noinspection PyTypeChecker
sc2wol_options: Dict[str, Option] = {
    "game_difficulty": GameDifficulty,
    "upgrade_bonus": UpgradeBonus,
    "bunker_upgrade": BunkerUpgrade,
    "all_in_map": AllInMap,
    "mission_order": MissionOrder,
    "shuffle_protoss": ShuffleProtoss,
    "relegate_no_build": RelegateNoBuildMissions
}


def get_option_value(world: MultiWorld, player: int, name: str) -> int:
    option = getattr(world, name, None)

    if option == None:
        return 0

    return int(option[player].value)