Source code for bascenev1._campaign

# Released under the MIT License. See LICENSE for details.
#
"""Functionality related to co-op campaigns."""
from __future__ import annotations

from typing import TYPE_CHECKING

import babase

if TYPE_CHECKING:
    from typing import Any
    import bascenev1


def register_campaign(campaign: bascenev1.Campaign) -> None:
    """Register a new campaign."""
    assert babase.app.classic is not None
    babase.app.classic.campaigns[campaign.name] = campaign


class Campaign:
    """Represents a unique set or series of baclassic.Level-s.

    Category: **App Classes**
    """

    def __init__(
        self,
        name: str,
        sequential: bool = True,
        levels: list[bascenev1.Level] | None = None,
    ):
        self._name = name
        self._sequential = sequential
        self._levels: list[bascenev1.Level] = []
        if levels is not None:
            for level in levels:
                self.addlevel(level)

    @property
    def name(self) -> str:
        """The name of the Campaign."""
        return self._name

    @property
    def sequential(self) -> bool:
        """Whether this Campaign's levels must be played in sequence."""
        return self._sequential

[docs] def addlevel( self, level: bascenev1.Level, index: int | None = None ) -> None: """Adds a baclassic.Level to the Campaign.""" if level.campaign is not None: raise RuntimeError('Level already belongs to a campaign.') level.set_campaign(self, len(self._levels)) if index is None: self._levels.append(level) else: self._levels.insert(index, level)
@property def levels(self) -> list[bascenev1.Level]: """The list of baclassic.Level-s in the Campaign.""" return self._levels
[docs] def getlevel(self, name: str) -> bascenev1.Level: """Return a contained baclassic.Level by name.""" for level in self._levels: if level.name == name: return level raise babase.NotFoundError( "Level '" + name + "' not found in campaign '" + self.name + "'" )
[docs] def reset(self) -> None: """Reset state for the Campaign.""" babase.app.config.setdefault('Campaigns', {})[self._name] = {}
# FIXME should these give/take baclassic.Level instances instead # of level names?..
[docs] def set_selected_level(self, levelname: str) -> None: """Set the Level currently selected in the UI (by name).""" self.configdict['Selection'] = levelname babase.app.config.commit()
[docs] def get_selected_level(self) -> str: """Return the name of the Level currently selected in the UI.""" val = self.configdict.get('Selection', self._levels[0].name) assert isinstance(val, str) return val
@property def configdict(self) -> dict[str, Any]: """Return the live config dict for this campaign.""" val: dict[str, Any] = babase.app.config.setdefault( 'Campaigns', {} ).setdefault(self._name, {}) assert isinstance(val, dict) return val def init_campaigns() -> None: """Fill out initial default Campaigns.""" # pylint: disable=cyclic-import from bascenev1._level import Level from bascenev1lib.game.onslaught import OnslaughtGame from bascenev1lib.game.football import FootballCoopGame from bascenev1lib.game.runaround import RunaroundGame from bascenev1lib.game.thelaststand import TheLastStandGame from bascenev1lib.game.race import RaceGame from bascenev1lib.game.targetpractice import TargetPracticeGame from bascenev1lib.game.meteorshower import MeteorShowerGame from bascenev1lib.game.easteregghunt import EasterEggHuntGame from bascenev1lib.game.ninjafight import NinjaFightGame # TODO: Campaigns should be load-on-demand; not all imported at launch # like this. # FIXME: Once translations catch up, we can convert these to use the # generic display-name '${GAME} Training' type stuff. register_campaign( Campaign( 'Easy', levels=[ Level( 'Onslaught Training', gametype=OnslaughtGame, settings={'preset': 'training_easy'}, preview_texture_name='doomShroomPreview', ), Level( 'Rookie Onslaught', gametype=OnslaughtGame, settings={'preset': 'rookie_easy'}, preview_texture_name='courtyardPreview', ), Level( 'Rookie Football', gametype=FootballCoopGame, settings={'preset': 'rookie_easy'}, preview_texture_name='footballStadiumPreview', ), Level( 'Pro Onslaught', gametype=OnslaughtGame, settings={'preset': 'pro_easy'}, preview_texture_name='doomShroomPreview', ), Level( 'Pro Football', gametype=FootballCoopGame, settings={'preset': 'pro_easy'}, preview_texture_name='footballStadiumPreview', ), Level( 'Pro Runaround', gametype=RunaroundGame, settings={'preset': 'pro_easy'}, preview_texture_name='towerDPreview', ), Level( 'Uber Onslaught', gametype=OnslaughtGame, settings={'preset': 'uber_easy'}, preview_texture_name='courtyardPreview', ), Level( 'Uber Football', gametype=FootballCoopGame, settings={'preset': 'uber_easy'}, preview_texture_name='footballStadiumPreview', ), Level( 'Uber Runaround', gametype=RunaroundGame, settings={'preset': 'uber_easy'}, preview_texture_name='towerDPreview', ), ], ) ) # "hard" mode register_campaign( Campaign( 'Default', levels=[ Level( 'Onslaught Training', gametype=OnslaughtGame, settings={'preset': 'training'}, preview_texture_name='doomShroomPreview', ), Level( 'Rookie Onslaught', gametype=OnslaughtGame, settings={'preset': 'rookie'}, preview_texture_name='courtyardPreview', ), Level( 'Rookie Football', gametype=FootballCoopGame, settings={'preset': 'rookie'}, preview_texture_name='footballStadiumPreview', ), Level( 'Pro Onslaught', gametype=OnslaughtGame, settings={'preset': 'pro'}, preview_texture_name='doomShroomPreview', ), Level( 'Pro Football', gametype=FootballCoopGame, settings={'preset': 'pro'}, preview_texture_name='footballStadiumPreview', ), Level( 'Pro Runaround', gametype=RunaroundGame, settings={'preset': 'pro'}, preview_texture_name='towerDPreview', ), Level( 'Uber Onslaught', gametype=OnslaughtGame, settings={'preset': 'uber'}, preview_texture_name='courtyardPreview', ), Level( 'Uber Football', gametype=FootballCoopGame, settings={'preset': 'uber'}, preview_texture_name='footballStadiumPreview', ), Level( 'Uber Runaround', gametype=RunaroundGame, settings={'preset': 'uber'}, preview_texture_name='towerDPreview', ), Level( 'The Last Stand', gametype=TheLastStandGame, settings={}, preview_texture_name='rampagePreview', ), ], ) ) # challenges: our 'official' random extra co-op levels register_campaign( Campaign( 'Challenges', sequential=False, levels=[ Level( 'Infinite Onslaught', gametype=OnslaughtGame, settings={'preset': 'endless'}, preview_texture_name='doomShroomPreview', ), Level( 'Infinite Runaround', gametype=RunaroundGame, settings={'preset': 'endless'}, preview_texture_name='towerDPreview', ), Level( 'Race', displayname='${GAME}', gametype=RaceGame, settings={'map': 'Big G', 'Laps': 3, 'Bomb Spawning': 0}, preview_texture_name='bigGPreview', ), Level( 'Pro Race', displayname='Pro ${GAME}', gametype=RaceGame, settings={'map': 'Big G', 'Laps': 3, 'Bomb Spawning': 1000}, preview_texture_name='bigGPreview', ), Level( 'Lake Frigid Race', displayname='${GAME}', gametype=RaceGame, settings={ 'map': 'Lake Frigid', 'Laps': 6, 'Mine Spawning': 2000, 'Bomb Spawning': 0, }, preview_texture_name='lakeFrigidPreview', ), Level( 'Football', displayname='${GAME}', gametype=FootballCoopGame, settings={'preset': 'tournament'}, preview_texture_name='footballStadiumPreview', ), Level( 'Pro Football', displayname='Pro ${GAME}', gametype=FootballCoopGame, settings={'preset': 'tournament_pro'}, preview_texture_name='footballStadiumPreview', ), Level( 'Runaround', displayname='${GAME}', gametype=RunaroundGame, settings={'preset': 'tournament'}, preview_texture_name='towerDPreview', ), Level( 'Uber Runaround', displayname='Uber ${GAME}', gametype=RunaroundGame, settings={'preset': 'tournament_uber'}, preview_texture_name='towerDPreview', ), Level( 'The Last Stand', displayname='${GAME}', gametype=TheLastStandGame, settings={'preset': 'tournament'}, preview_texture_name='rampagePreview', ), Level( 'Tournament Infinite Onslaught', displayname='Infinite Onslaught', gametype=OnslaughtGame, settings={'preset': 'endless_tournament'}, preview_texture_name='doomShroomPreview', ), Level( 'Tournament Infinite Runaround', displayname='Infinite Runaround', gametype=RunaroundGame, settings={'preset': 'endless_tournament'}, preview_texture_name='towerDPreview', ), Level( 'Target Practice', displayname='Pro ${GAME}', gametype=TargetPracticeGame, settings={}, preview_texture_name='doomShroomPreview', ), Level( 'Target Practice B', displayname='${GAME}', gametype=TargetPracticeGame, settings={ 'Target Count': 2, 'Enable Impact Bombs': False, 'Enable Triple Bombs': False, }, preview_texture_name='doomShroomPreview', ), Level( 'Meteor Shower', displayname='${GAME}', gametype=MeteorShowerGame, settings={}, preview_texture_name='rampagePreview', ), Level( 'Epic Meteor Shower', displayname='${GAME}', gametype=MeteorShowerGame, settings={'Epic Mode': True}, preview_texture_name='rampagePreview', ), Level( 'Easter Egg Hunt', displayname='${GAME}', gametype=EasterEggHuntGame, settings={}, preview_texture_name='towerDPreview', ), Level( 'Pro Easter Egg Hunt', displayname='Pro ${GAME}', gametype=EasterEggHuntGame, settings={'Pro Mode': True}, preview_texture_name='towerDPreview', ), Level( name='Ninja Fight', # (unique id not seen by player) displayname='${GAME}', # (readable name seen by player) gametype=NinjaFightGame, settings={'preset': 'regular'}, preview_texture_name='courtyardPreview', ), Level( name='Pro Ninja Fight', displayname='Pro ${GAME}', gametype=NinjaFightGame, settings={'preset': 'pro'}, preview_texture_name='courtyardPreview', ), ], ) )