Tick Repeat/Delay updates (#156)

* Fixes for issue #142.

Changed TickRepeat/TickRepeatStatus to Repeat/RepeatStatus to match Delay class naming convention.

Added time_remaining/time_elapsed properties to Delay class.

Added execute_on_start argument to Repeat.start to know if the function needs to be executed before any delays occur.

Changed Repeat properties remaining, count, limit, and elapsed to remaining_loops, loop_count, loop_limit, and time_elapsed to better describe what the property is for.

Added Repeat properties delay_time_remaining/delay_time_elapsed to return the values for the current delay.

* Updated doc-strings in listeners.tick.

* 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.

* Fix for issue #145.

Changed args and kwargs passed to Delay to not use star-args format.

Moved cancel_on_map_end to the end of the arguments.

Updated all instances of Delay class to use the new format.

* Fix for issue #145.

Updated doc strings for Delay/Repeat changes.

Updated Repeat argument structure to match Delay's new structure.

Changed args to use tuple() as it is immutable and should work fine in place of None.

* Fix for issue #145.

Changed cancel_on_map_end to cancel_on_level_end to match naming convention of the listener used to cancel the Delay.

* Fixed possible unexpected behaviour when canceling delays at the end of the map

* Fix for issue #145.

Moved properties above methods in Repeat class.

Changed property names of Repeat to be more conform.

* Fix for issue #145.

Fixed Repeat methods for changes to property names.

Changed Repeat values for loops_remaining, total_time, and total_time_remaining to return math.inf if there is no limit on the number of loops.

* Fix for issue #145.

Fixed Repeat status remaining RUNNING when its delay was cancelled on level end.

* Fixed possible error when using <function> named _execute for a Delay callback.

* Updated Entity.delay for upcoming changes.

* Updated documentation

* Infinity update

* Fixed total_time_remaining raising an error when the repeat stopped

* Added getters for interval, adjusted_loops and original_loops

Author: satoon101

addons/source-python/packages/source-python/core/command/__init__.py

@@ -23,8 +23,6 @@
 from engines.server import queue_command_string
 #   Paths
 from paths import SP_DATA_PATH
-#   Players
-from players.entity import Player
 #   Plugins
 from plugins import _plugin_strings
 from plugins.command import SubCommandManager
@@ -144,19 +142,22 @@ def print_credits(self):
 @_core_command.server_sub_command(['delay'])
 def _sp_delay(command_info, delay:float, command, *args):
     """Execute a command after a given delay."""
-    Delay(delay, queue_command_string, command + ' ' + ' '.join(args))
+    Delay(delay, queue_command_string, (command + ' ' + ' '.join(args), ))
+
 
 @_core_command.server_sub_command(['version'])
 def _sp_version(command_info):
     """Display Source.Python version information."""
     core_command_logger.log_message(
         'Current Source.Python version: {0}'.format(VERSION))
 
+
 @_core_command.server_sub_command(['credits'])
 def _sp_credits(command_info):
     """List all credits for Source.Python."""
     _core_command.print_credits()
 
+
 @_core_command.server_sub_command(['help'])
 def _sp_help(command_info, command=None, *server_sub_commands):
     """Print all sp sub-commands or help for a specific command."""

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

@@ -518,15 +518,20 @@ def _set_property(self, name, prop_type, value):
             'Property "{0}" not found for entity type "{1}"'.format(
                 name, self.classname))
 
-    def delay(self, delay, callback, *args, **kwargs):
+    def delay(
+            self, delay, callback, args=(), kwargs=None,
+            cancel_on_level_end=False):
         """Execute a callback after the given delay.
 
-        :param int delay: The delay in seconds.
+        :param float delay: The delay in seconds.
         :param callback: A callable object that should be called after the
             delay expired.
-        :param args: Arguments that should be passed to the callback.
-        :param kwargs: Keyword arguments that should be passed to the
+        :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.
+        :raises ValueError: If the given callback is not callable.
 
         :return: The delay instance.
         :rtype: Delay
@@ -548,7 +553,7 @@ def _callback(*args, **kwargs):
             callback(*args, **kwargs)
 
         # Get the delay instance...
-        delay = Delay(delay, _callback, *args, **kwargs)
+        delay = Delay(delay, _callback, args, kwargs, cancel_on_level_end)
 
         # Add the delay to the dictionary...
         _entity_delays[self.index].add(delay)