bastd.game.targetpractice

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Implements Target Practice game."""
  4
  5# ba_meta require api 7
  6# (see https://ballistica.net/wiki/meta-tag-system)
  7
  8from __future__ import annotations
  9
 10import random
 11from typing import TYPE_CHECKING
 12
 13import ba
 14from bastd.actor.scoreboard import Scoreboard
 15from bastd.actor.onscreencountdown import OnScreenCountdown
 16from bastd.actor.bomb import Bomb
 17from bastd.actor.popuptext import PopupText
 18
 19if TYPE_CHECKING:
 20    from typing import Any, Sequence
 21    from bastd.actor.bomb import Blast
 22
 23
 24class Player(ba.Player['Team']):
 25    """Our player type for this game."""
 26
 27    def __init__(self) -> None:
 28        self.streak = 0
 29
 30
 31class Team(ba.Team[Player]):
 32    """Our team type for this game."""
 33
 34    def __init__(self) -> None:
 35        self.score = 0
 36
 37
 38# ba_meta export game
 39class TargetPracticeGame(ba.TeamGameActivity[Player, Team]):
 40    """Game where players try to hit targets with bombs."""
 41
 42    name = 'Target Practice'
 43    description = 'Bomb as many targets as you can.'
 44    available_settings = [
 45        ba.IntSetting('Target Count', min_value=1, default=3),
 46        ba.BoolSetting('Enable Impact Bombs', default=True),
 47        ba.BoolSetting('Enable Triple Bombs', default=True),
 48    ]
 49    default_music = ba.MusicType.FORWARD_MARCH
 50
 51    @classmethod
 52    def get_supported_maps(cls, sessiontype: type[ba.Session]) -> list[str]:
 53        return ['Doom Shroom']
 54
 55    @classmethod
 56    def supports_session_type(cls, sessiontype: type[ba.Session]) -> bool:
 57        # We support any teams or versus sessions.
 58        return issubclass(sessiontype, ba.CoopSession) or issubclass(
 59            sessiontype, ba.MultiTeamSession
 60        )
 61
 62    def __init__(self, settings: dict):
 63        super().__init__(settings)
 64        self._scoreboard = Scoreboard()
 65        self._targets: list[Target] = []
 66        self._update_timer: ba.Timer | None = None
 67        self._countdown: OnScreenCountdown | None = None
 68        self._target_count = int(settings['Target Count'])
 69        self._enable_impact_bombs = bool(settings['Enable Impact Bombs'])
 70        self._enable_triple_bombs = bool(settings['Enable Triple Bombs'])
 71
 72    def on_team_join(self, team: Team) -> None:
 73        if self.has_begun():
 74            self.update_scoreboard()
 75
 76    def on_begin(self) -> None:
 77        super().on_begin()
 78        self.update_scoreboard()
 79
 80        # Number of targets is based on player count.
 81        for i in range(self._target_count):
 82            ba.timer(5.0 + i * 1.0, self._spawn_target)
 83
 84        self._update_timer = ba.Timer(1.0, self._update, repeat=True)
 85        self._countdown = OnScreenCountdown(60, endcall=self.end_game)
 86        ba.timer(4.0, self._countdown.start)
 87
 88    def spawn_player(self, player: Player) -> ba.Actor:
 89        spawn_center = (0, 3, -5)
 90        pos = (
 91            spawn_center[0] + random.uniform(-1.5, 1.5),
 92            spawn_center[1],
 93            spawn_center[2] + random.uniform(-1.5, 1.5),
 94        )
 95
 96        # Reset their streak.
 97        player.streak = 0
 98        spaz = self.spawn_player_spaz(player, position=pos)
 99
100        # Give players permanent triple impact bombs and wire them up
101        # to tell us when they drop a bomb.
102        if self._enable_impact_bombs:
103            spaz.bomb_type = 'impact'
104        if self._enable_triple_bombs:
105            spaz.set_bomb_count(3)
106        spaz.add_dropped_bomb_callback(self._on_spaz_dropped_bomb)
107        return spaz
108
109    def _spawn_target(self) -> None:
110
111        # Generate a few random points; we'll use whichever one is farthest
112        # from our existing targets (don't want overlapping targets).
113        points = []
114
115        for _i in range(4):
116            # Calc a random point within a circle.
117            while True:
118                xpos = random.uniform(-1.0, 1.0)
119                ypos = random.uniform(-1.0, 1.0)
120                if xpos * xpos + ypos * ypos < 1.0:
121                    break
122            points.append(ba.Vec3(8.0 * xpos, 2.2, -3.5 + 5.0 * ypos))
123
124        def get_min_dist_from_target(pnt: ba.Vec3) -> float:
125            return min((t.get_dist_from_point(pnt) for t in self._targets))
126
127        # If we have existing targets, use the point with the highest
128        # min-distance-from-targets.
129        if self._targets:
130            point = max(points, key=get_min_dist_from_target)
131        else:
132            point = points[0]
133
134        self._targets.append(Target(position=point))
135
136    def _on_spaz_dropped_bomb(self, spaz: ba.Actor, bomb: ba.Actor) -> None:
137        del spaz  # Unused.
138
139        # Wire up this bomb to inform us when it blows up.
140        assert isinstance(bomb, Bomb)
141        bomb.add_explode_callback(self._on_bomb_exploded)
142
143    def _on_bomb_exploded(self, bomb: Bomb, blast: Blast) -> None:
144        assert blast.node
145        pos = blast.node.position
146
147        # Debugging: throw a locator down where we landed.
148        # ba.newnode('locator', attrs={'position':blast.node.position})
149
150        # Feed the explosion point to all our targets and get points in return.
151        # Note: we operate on a copy of self._targets since the list may change
152        # under us if we hit stuff (don't wanna get points for new targets).
153        player = bomb.get_source_player(Player)
154        if not player:
155            # It's possible the player left after throwing the bomb.
156            return
157
158        bullseye = any(
159            target.do_hit_at_position(pos, player)
160            for target in list(self._targets)
161        )
162        if bullseye:
163            player.streak += 1
164        else:
165            player.streak = 0
166
167    def _update(self) -> None:
168        """Misc. periodic updating."""
169        # Clear out targets that have died.
170        self._targets = [t for t in self._targets if t]
171
172    def handlemessage(self, msg: Any) -> Any:
173        # When players die, respawn them.
174        if isinstance(msg, ba.PlayerDiedMessage):
175            super().handlemessage(msg)  # Do standard stuff.
176            player = msg.getplayer(Player)
177            assert player is not None
178            self.respawn_player(player)  # Kick off a respawn.
179        elif isinstance(msg, Target.TargetHitMessage):
180            # A target is telling us it was hit and will die soon..
181            # ..so make another one.
182            self._spawn_target()
183        else:
184            super().handlemessage(msg)
185
186    def update_scoreboard(self) -> None:
187        """Update the game scoreboard with current team values."""
188        for team in self.teams:
189            self._scoreboard.set_team_value(team, team.score)
190
191    def end_game(self) -> None:
192        results = ba.GameResults()
193        for team in self.teams:
194            results.set_team_score(team, team.score)
195        self.end(results)
196
197
198class Target(ba.Actor):
199    """A target practice target."""
200
201    class TargetHitMessage:
202        """Inform an object a target was hit."""
203
204    def __init__(self, position: Sequence[float]):
205        self._r1 = 0.45
206        self._r2 = 1.1
207        self._r3 = 2.0
208        self._rfudge = 0.15
209        super().__init__()
210        self._position = ba.Vec3(position)
211        self._hit = False
212
213        # It can be handy to test with this on to make sure the projection
214        # isn't too far off from the actual object.
215        show_in_space = False
216        loc1 = ba.newnode(
217            'locator',
218            attrs={
219                'shape': 'circle',
220                'position': position,
221                'color': (0, 1, 0),
222                'opacity': 0.5,
223                'draw_beauty': show_in_space,
224                'additive': True,
225            },
226        )
227        loc2 = ba.newnode(
228            'locator',
229            attrs={
230                'shape': 'circleOutline',
231                'position': position,
232                'color': (0, 1, 0),
233                'opacity': 0.3,
234                'draw_beauty': False,
235                'additive': True,
236            },
237        )
238        loc3 = ba.newnode(
239            'locator',
240            attrs={
241                'shape': 'circleOutline',
242                'position': position,
243                'color': (0, 1, 0),
244                'opacity': 0.1,
245                'draw_beauty': False,
246                'additive': True,
247            },
248        )
249        self._nodes = [loc1, loc2, loc3]
250        ba.animate_array(loc1, 'size', 1, {0: [0.0], 0.2: [self._r1 * 2.0]})
251        ba.animate_array(loc2, 'size', 1, {0.05: [0.0], 0.25: [self._r2 * 2.0]})
252        ba.animate_array(loc3, 'size', 1, {0.1: [0.0], 0.3: [self._r3 * 2.0]})
253        ba.playsound(ba.getsound('laserReverse'))
254
255    def exists(self) -> bool:
256        return bool(self._nodes)
257
258    def handlemessage(self, msg: Any) -> Any:
259        if isinstance(msg, ba.DieMessage):
260            for node in self._nodes:
261                node.delete()
262            self._nodes = []
263        else:
264            super().handlemessage(msg)
265
266    def get_dist_from_point(self, pos: ba.Vec3) -> float:
267        """Given a point, returns distance squared from it."""
268        return (pos - self._position).length()
269
270    def do_hit_at_position(self, pos: Sequence[float], player: Player) -> bool:
271        """Handle a bomb hit at the given position."""
272        # pylint: disable=too-many-statements
273        activity = self.activity
274
275        # Ignore hits if the game is over or if we've already been hit
276        if activity.has_ended() or self._hit or not self._nodes:
277            return False
278
279        diff = ba.Vec3(pos) - self._position
280
281        # Disregard Y difference. Our target point probably isn't exactly
282        # on the ground anyway.
283        diff[1] = 0.0
284        dist = diff.length()
285
286        bullseye = False
287        if dist <= self._r3 + self._rfudge:
288            # Inform our activity that we were hit
289            self._hit = True
290            activity.handlemessage(self.TargetHitMessage())
291            keys: dict[float, Sequence[float]] = {
292                0.0: (1.0, 0.0, 0.0),
293                0.049: (1.0, 0.0, 0.0),
294                0.05: (1.0, 1.0, 1.0),
295                0.1: (0.0, 1.0, 0.0),
296            }
297            cdull = (0.3, 0.3, 0.3)
298            popupcolor: Sequence[float]
299            if dist <= self._r1 + self._rfudge:
300                bullseye = True
301                self._nodes[1].color = cdull
302                self._nodes[2].color = cdull
303                ba.animate_array(self._nodes[0], 'color', 3, keys, loop=True)
304                popupscale = 1.8
305                popupcolor = (1, 1, 0, 1)
306                streak = player.streak
307                points = 10 + min(20, streak * 2)
308                ba.playsound(ba.getsound('bellHigh'))
309                if streak > 0:
310                    ba.playsound(
311                        ba.getsound(
312                            'orchestraHit4'
313                            if streak > 3
314                            else 'orchestraHit3'
315                            if streak > 2
316                            else 'orchestraHit2'
317                            if streak > 1
318                            else 'orchestraHit'
319                        )
320                    )
321            elif dist <= self._r2 + self._rfudge:
322                self._nodes[0].color = cdull
323                self._nodes[2].color = cdull
324                ba.animate_array(self._nodes[1], 'color', 3, keys, loop=True)
325                popupscale = 1.25
326                popupcolor = (1, 0.5, 0.2, 1)
327                points = 4
328                ba.playsound(ba.getsound('bellMed'))
329            else:
330                self._nodes[0].color = cdull
331                self._nodes[1].color = cdull
332                ba.animate_array(self._nodes[2], 'color', 3, keys, loop=True)
333                popupscale = 1.0
334                popupcolor = (0.8, 0.3, 0.3, 1)
335                points = 2
336                ba.playsound(ba.getsound('bellLow'))
337
338            # Award points/etc.. (technically should probably leave this up
339            # to the activity).
340            popupstr = '+' + str(points)
341
342            # If there's more than 1 player in the game, include their
343            # names and colors so they know who got the hit.
344            if len(activity.players) > 1:
345                popupcolor = ba.safecolor(player.color, target_intensity=0.75)
346                popupstr += ' ' + player.getname()
347            PopupText(
348                popupstr,
349                position=self._position,
350                color=popupcolor,
351                scale=popupscale,
352            ).autoretain()
353
354            # Give this player's team points and update the score-board.
355            player.team.score += points
356            assert isinstance(activity, TargetPracticeGame)
357            activity.update_scoreboard()
358
359            # Also give this individual player points
360            # (only applies in teams mode).
361            assert activity.stats is not None
362            activity.stats.player_scored(
363                player, points, showpoints=False, screenmessage=False
364            )
365
366            ba.animate_array(
367                self._nodes[0],
368                'size',
369                1,
370                {0.8: self._nodes[0].size, 1.0: [0.0]},
371            )
372            ba.animate_array(
373                self._nodes[1],
374                'size',
375                1,
376                {0.85: self._nodes[1].size, 1.05: [0.0]},
377            )
378            ba.animate_array(
379                self._nodes[2],
380                'size',
381                1,
382                {0.9: self._nodes[2].size, 1.1: [0.0]},
383            )
384            ba.timer(1.1, ba.Call(self.handlemessage, ba.DieMessage()))
385
386        return bullseye