Fix for issue #145.

Both Delay and Repeat now allow for the argument cancel_on_map_end to denote whether the object should be cancelled when the current map ends.

Author: satoon101

addons/source-python/packages/source-python/listeners/tick.py

@@ -25,6 +25,7 @@
 #   Listeners
 from listeners import listeners_logger
 from listeners import on_tick_listener_manager
+from listeners import OnLevelEnd
 
 
 # =============================================================================
@@ -108,12 +109,16 @@ def add(self, delay):
 class Delay(WeakAutoUnload):
     """Execute a callback after a given delay."""
 
-    def __init__(self, delay, callback, *args, **kwargs):
+    def __init__(
+        self, delay, callback, cancel_on_map_end=False, *args, **kwargs
+    ):
         """Initialize the delay.
 
         :param float delay: The delay in seconds.
         :param callback: A callable object that should be called after the
             delay expired.
+        :param bool cancel_on_map_end: Whether or not to cancel the delay at
+            the end of the map.
         :param args: Arguments that should be passed to the callback.
         :param kwargs: Keyword arguments that should be passed to the
             callback.
@@ -126,6 +131,7 @@ def __init__(self, delay, callback, *args, **kwargs):
         self._start_time = time.time()
         self.exec_time = self._start_time + delay
         self.callback = callback
+        self.cancel_on_map_end = cancel_on_map_end
         self.args = args
         self.kwargs = kwargs
         _delay_manager.add(self)
@@ -199,17 +205,20 @@ class RepeatStatus(IntEnum):
 class Repeat(AutoUnload):
     """Class used to create and call repeats."""
 
-    def __init__(self, callback, *args, **kwargs):
+    def __init__(self, callback, cancel_on_map_end=False, *args, **kwargs):
         """Store all instance attributes.
 
         :param callback: A callable object that should be called at the
             end of each loop.
+        :param bool cancel_on_map_end: Whether or not to cancel the repeat at
+            the end of the map.
         :param args: Arguments that should be passed to the callback.
         :param kwargs: Keyword arguments that should be passed to the
             callback.
         """
         # Store the base attributes
         self.callback = callback
+        self.cancel_on_map_end = cancel_on_map_end
         self.args = args
         self.kwargs = kwargs
 
@@ -268,7 +277,9 @@ def start(self, interval, limit, execute_on_start=False):
         self._adjusted = 0
 
         # Start the delay
-        self._delay = Delay(self._interval, self._execute)
+        self._delay = Delay(
+            self._interval, self._execute, self.cancel_on_map_end
+        )
 
         # Call the callback if set to execute on start
         if execute_on_start:
@@ -368,7 +379,9 @@ def resume(self):
         self._status = RepeatStatus.RUNNING
 
         # Start the delay
-        self._delay = Delay(self._loop_time, self._execute)
+        self._delay = Delay(
+            self._loop_time, self._execute, self.cancel_on_map_end
+        )
 
     def extend(self, adjustment):
         """Add to the number of loops to be made.
@@ -465,7 +478,9 @@ def _execute(self):
                         self.remaining_loops))
 
             # Call the delay again
-            self._delay = Delay(self._interval, self._execute)
+            self._delay = Delay(
+                self._interval, self._execute, self.cancel_on_map_end
+            )
 
         # Are no more loops to be made?
         else:
@@ -572,3 +587,13 @@ def delay_time_elapsed(self):
     def _unload_instance(self):
         """Stop the repeat with being unloaded."""
         self.stop()
+
+
+# =============================================================================
+# >> HELPER FUNCTIONS
+# =============================================================================
+@OnLevelEnd
+def _cancel_delays_on_level_end():
+    for delay in _delay_manager:
+        if delay.cancel_on_map_end:
+            delay.cancel()