bastd.actor.onscreencountdown

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Defines Actor Type(s)."""
  4
  5from __future__ import annotations
  6
  7from typing import TYPE_CHECKING
  8
  9import ba
 10
 11if TYPE_CHECKING:
 12    from typing import Any, Callable
 13
 14
 15class OnScreenCountdown(ba.Actor):
 16    """A Handy On-Screen Timer.
 17
 18    category: Gameplay Classes
 19
 20    Useful for time-based games that count down to zero.
 21    """
 22
 23    def __init__(self,
 24                 duration: int,
 25                 endcall: Callable[[], Any] | None = None):
 26        """Duration is provided in seconds."""
 27        super().__init__()
 28        self._timeremaining = duration
 29        self._ended = False
 30        self._endcall = endcall
 31        self.node = ba.newnode('text',
 32                               attrs={
 33                                   'v_attach': 'top',
 34                                   'h_attach': 'center',
 35                                   'h_align': 'center',
 36                                   'color': (1, 1, 0.5, 1),
 37                                   'flatness': 0.5,
 38                                   'shadow': 0.5,
 39                                   'position': (0, -70),
 40                                   'scale': 1.4,
 41                                   'text': ''
 42                               })
 43        self.inputnode = ba.newnode('timedisplay',
 44                                    attrs={
 45                                        'time2': duration * 1000,
 46                                        'timemax': duration * 1000,
 47                                        'timemin': 0
 48                                    })
 49        self.inputnode.connectattr('output', self.node, 'text')
 50        self._countdownsounds = {
 51            10: ba.getsound('announceTen'),
 52            9: ba.getsound('announceNine'),
 53            8: ba.getsound('announceEight'),
 54            7: ba.getsound('announceSeven'),
 55            6: ba.getsound('announceSix'),
 56            5: ba.getsound('announceFive'),
 57            4: ba.getsound('announceFour'),
 58            3: ba.getsound('announceThree'),
 59            2: ba.getsound('announceTwo'),
 60            1: ba.getsound('announceOne')
 61        }
 62        self._timer: ba.Timer | None = None
 63
 64    def start(self) -> None:
 65        """Start the timer."""
 66        globalsnode = ba.getactivity().globalsnode
 67        globalsnode.connectattr('time', self.inputnode, 'time1')
 68        self.inputnode.time2 = (globalsnode.time +
 69                                (self._timeremaining + 1) * 1000)
 70        self._timer = ba.Timer(1.0, self._update, repeat=True)
 71
 72    def on_expire(self) -> None:
 73        super().on_expire()
 74
 75        # Release callbacks/refs.
 76        self._endcall = None
 77
 78    def _update(self, forcevalue: int | None = None) -> None:
 79        if forcevalue is not None:
 80            tval = forcevalue
 81        else:
 82            self._timeremaining = max(0, self._timeremaining - 1)
 83            tval = self._timeremaining
 84
 85        # if there's a countdown sound for this time that we
 86        # haven't played yet, play it
 87        if tval == 10:
 88            assert self.node
 89            assert isinstance(self.node.scale, float)
 90            self.node.scale *= 1.2
 91            cmb = ba.newnode('combine', owner=self.node, attrs={'size': 4})
 92            cmb.connectattr('output', self.node, 'color')
 93            ba.animate(cmb, 'input0', {0: 1.0, 0.15: 1.0}, loop=True)
 94            ba.animate(cmb, 'input1', {0: 1.0, 0.15: 0.5}, loop=True)
 95            ba.animate(cmb, 'input2', {0: 0.1, 0.15: 0.0}, loop=True)
 96            cmb.input3 = 1.0
 97        if tval <= 10 and not self._ended:
 98            ba.playsound(ba.getsound('tick'))
 99        if tval in self._countdownsounds:
100            ba.playsound(self._countdownsounds[tval])
101        if tval <= 0 and not self._ended:
102            self._ended = True
103            if self._endcall is not None:
104                self._endcall()