Fixed issue #205

Author: Ayuto

addons/source-python/packages/source-python/commands/typed.py

@@ -37,7 +37,8 @@
 # =============================================================================
 # >> ALL DECLARATION
 # =============================================================================
-__all__ = ('SUPPORTED_KINDS',
+__all__ = ('PRIVATE_COMMAND_PREFIX',
+           'SUPPORTED_KINDS',
            'ArgumentError',
            'ArgumentNumberMismatch',
            'CommandInfo',
@@ -69,6 +70,8 @@
     Parameter.VAR_POSITIONAL,
 )
 
+PRIVATE_COMMAND_PREFIX = '/'
+
 
 # =============================================================================
 # >> GLOBAL VARIABLES
@@ -493,6 +496,28 @@ def reply(self, msg):
         """
         self.typed_command_cls.send_message(self, msg)
 
+    def is_private_command(self):
+        """Return ``True`` if it's a private command.
+
+        :rtype: bool
+        """
+        return self.command[0].startswith(PRIVATE_COMMAND_PREFIX)
+
+    @property
+    def auto_command_return(self):
+        """Determine the probably most desired ``CommandReturn`` value.
+
+        For server commands it will always return ``CommandReturn.CONTINUE``.
+        Client commands will always use ``CommandReturn.BLOCK``. For say
+        commands it's determined by checking the prefix. If the command starts
+        with a slash (``/``) it's handled as a private command. Thus,
+        ``CommandReturn.BLOCK`` is returned. Otherwise
+        ``CommandReturn.CONTINUE`` is used.
+
+        :rtype: CommandReturn
+        """
+        return self.typed_command_cls.get_auto_command_return(self)
+
 
 # We can't integrate this into SayCommand, ServerCommand and ClientCommand,
 # because multiple callbacks are not supported by this system (because of the
@@ -558,14 +583,16 @@ def on_command(cls, command, *args):
         Parse the command, clean its arguments and execute the callback.
         """
         # TODO: Translations!
-        command_info = CommandInfo(command, cls, *args)
+        info = CommandInfo(command, cls, *args)
         try:
-            command_node, args = cls.parser.parse_command(
-                command_info.command)
-            result = cls.on_clean_command(command_info, command_node, args)
+            command_node, args = cls.parser.parse_command(info.command)
+            result = cls.on_clean_command(info, command_node, args)
         except ValidationError as e:
-            command_info.reply(e.message)
+            info.reply(e.message)
         else:
+            if result is None:
+                return info.auto_command_return
+
             return result
 
         return CommandReturn.CONTINUE
@@ -600,6 +627,14 @@ def send_message(command_info, message):
         """Send a message."""
         raise NotImplementedError('Needs to be implemented by a sub class.')
 
+    @classmethod
+    def get_auto_command_return(cls, info):
+        """Return the most desired ``CommandReturn`` value.
+
+        :rtype: CommandReturn
+        """
+        raise NotImplementedError('Needs to be implemented by a sub class.')
+
 
 class TypedServerCommand(_TypedCommand):
     """Decorator class to create typed server commands."""
@@ -611,6 +646,10 @@ class TypedServerCommand(_TypedCommand):
     def send_message(command_info, message):
         logger.log_message(message)
 
+    @classmethod
+    def get_auto_command_return(cls, info):
+        return CommandReturn.CONTINUE
+
 
 class _TypedPlayerCommand(_TypedCommand):
     """Decorator class to create typed player based commands."""
@@ -648,6 +687,10 @@ class TypedClientCommand(_TypedPlayerCommand):
     def send_message(command_info, message):
         TextMsg(message, HudDestination.CONSOLE).send(command_info.index)
 
+    @classmethod
+    def get_auto_command_return(cls, info):
+        return CommandReturn.BLOCK
+
 
 class TypedSayCommand(_TypedPlayerCommand):
     """Decorator class to create typed say commands."""
@@ -659,6 +702,13 @@ class TypedSayCommand(_TypedPlayerCommand):
     def send_message(command_info, message):
         SayText2(message).send(command_info.index)
 
+    @classmethod
+    def get_auto_command_return(cls, info):
+        if info.is_private_command():
+            return CommandReturn.BLOCK
+
+        return CommandReturn.CONTINUE
+
 
 # =============================================================================
 # >> COMMAND ANNOTATIONS