Entity.repeat (#295)

* Initial commit

* Renamed Entity.register_repeat to Entity.repeat, fixed raises

* Removed weakreafs

* PEP8

* Back cancel_on_level end, updated description

* updated desciption

Author: invisiblesoldiers

addons/source-python/packages/source-python/entities/_base.py

@@ -52,6 +52,8 @@
 from listeners import OnEntityDeleted
 from listeners import on_entity_deleted_listener_manager
 from listeners.tick import Delay
+from listeners.tick import Repeat
+from listeners.tick import RepeatStatus
 #   Mathlib
 from mathlib import NULL_VECTOR
 #   Memory
@@ -72,6 +74,9 @@
 # Get a dictionary to store the delays
 _entity_delays = defaultdict(set)
 
+# Get a dictionary to store the repeats
+_entity_repeats = defaultdict(set)
+
 # Get a set to store the registered entity classes
 _entity_classes = WeakSet()
 
@@ -800,7 +805,7 @@ def _set_property(self, name, prop_type, value):
     def delay(
             self, delay, callback, args=(), kwargs=None,
             cancel_on_level_end=False):
-        """Execute a callback after the given delay.
+        """Create the delay which will be stopped after removing the entity.
 
         :param float delay:
             The delay in seconds.
@@ -843,6 +848,33 @@ def _callback(*args, **kwargs):
         # Return the delay instance...
         return delay
 
+    def repeat(self, callback, args=(), kwargs=None, cancel_on_level_end=False):
+        """Create the repeat which will be stopped after removing the entity.
+
+        :param callback:
+            A callable object that should be called at the end of each loop.
+        :param tuple args:
+            Arguments that should be passed to the callback.
+        :param dict kwargs:
+            Keyword arguments that should be passed to the callback.
+        :param bool cancel_on_level_end:
+            Whether or not to cancel the delay at the end of the map.
+        :raise ValueError:
+            Raised if the given callback is not callable.
+        :return:
+            The repeat instance.
+        :rtype: Repeat
+        """
+
+        # Get the repeat instance...
+        repeat = Repeat(callback, args, kwargs, cancel_on_level_end)
+
+        # Add the repeat to the dictionary...
+        _entity_repeats[self.index].add(repeat)
+
+        # Return the repeat instance...
+        return repeat
+
     def get_input(self, name):
         """Return the input function matching the given name.
 
@@ -1129,19 +1161,30 @@ def _on_entity_deleted(base_entity):
     for cls in _entity_classes:
         cls.cache.pop(index, None)
 
-    # Was no delay registered for this entity?
-    if index not in _entity_delays:
-        return
+    # Was delay registered for this entity?
+    if index in _entity_delays:
+        # Loop through all delays...
+        for delay in _entity_delays[index]:
+
+            # Make sure the delay is still running...
+            if not delay.running:
+                continue
+
+            # Cancel the delay...
+            delay.cancel()
 
-    # Loop through all delays...
-    for delay in _entity_delays[index]:
+        # Remove the entity from the dictionary...
+        del _entity_delays[index]
 
-        # Make sure the delay is still running...
-        if not delay.running:
-            continue
+    # Was repeat registered for this entity?
+    if index in _entity_repeats:
+        # Loop through all repeats...
+        for repeat in _entity_repeats[index]:
 
-        # Cancel the delay...
-        delay.cancel()
+            # Stop the repeat if running
+            if repeat.status is RepeatStatus.RUNNING:
+                repeat.stop()
 
-    # Remove the entity from the dictionary...
-    del _entity_delays[index]
+        # Remove the entity from the dictionary...
+        del _entity_repeats[index]
+