Merge pull request #193 from arnauddupuis/arnauddupuis/issue189

Issue #189: Improve RandomActuator

pygamelib/actuators.py

@@ -20,7 +20,7 @@
 from queue import PriorityQueue
 
 
-class Actuator:
+class Actuator(base.PglBaseObject):
     """
     Actuator is the base class for all Actuators. It is mainly a contract class with
     some utility methods.
@@ -40,6 +40,7 @@ def __init__(self, parent):
             actuator to be in a different state (PAUSED for example), you have to do it
             yourself.
         """
+        super().__init__()
         self.type = None
         self.state = constants.RUNNING
         self.parent = parent
@@ -150,8 +151,48 @@ def __init__(self, moveset=None, parent=None):
         if moveset is None:
             moveset = []
         super().__init__(parent)
+        self.__moveset = []
+        self._vector_moveset = []
+        self.__current_direction = None
+        self.__current_dir_move_left = None
+        # We'll use that to check if the moving board item is stuck.
+        self.__projected_position_cache = None
         self.moveset = moveset
 
+    @property
+    def moveset(self):
+        """
+        Return the moveset.
+
+        :return: The moveset.
+        :rtype: list
+        """
+        return self.__moveset
+
+    @moveset.setter
+    def moveset(self, moveset):
+        """
+        Set the moveset.
+
+        :param moveset: The moveset.
+        :type moveset: list
+        """
+        self.__moveset = moveset
+        self._vector_moveset = []
+        if len(self.moveset) > 0:
+            # let's build a cache of directions to avoid creating vectors at each
+            # next_move() call.
+            for m in self.moveset:
+                if isinstance(m, base.Vector2D):
+                    self._vector_moveset.append(m)
+                else:
+                    # Here we consider that in moveset, there's either Vector2D or
+                    # directions from the constants module. If it is not the case,
+                    # result will be funky...
+                    self._vector_moveset.append(base.Vector2D.from_direction(m, 1))
+            self.__current_direction = random.randrange(0, len(self.moveset))
+            self.__current_dir_move_left = random.randint(1, 10)
+
     def next_move(self):
         """Return a randomly selected movement
 
@@ -163,10 +204,27 @@ def next_move(self):
 
         Example::
 
-            randomactuator.next_move()
+            random_actuator.next_move()
         """
         if self.state == constants.RUNNING and self.moveset:
-            return random.choice(self.moveset)
+            ppav = None
+            if isinstance(self.parent, board_items.Movable):
+                ppav = self.parent.position_as_vector()
+            if (
+                self.__current_dir_move_left <= 0
+                or ppav != self.__projected_position_cache
+            ):
+
+                self.__current_direction = random.randrange(0, len(self.moveset))
+                self.__current_dir_move_left = random.randint(1, 10)
+            self.__current_dir_move_left -= 1
+            if ppav is not None:
+                self.__projected_position_cache = (
+                    ppav + self._vector_moveset[self.__current_direction]
+                )
+            return self.moveset[self.__current_direction]
+
+            # return random.choice(self.moveset)
         else:
             return constants.NO_DIR
 
@@ -235,7 +293,7 @@ def next_move(self):
 
         Example::
 
-            pathactuator.next_move()
+            path_actuator.next_move()
         """
         if self.state == constants.RUNNING:
             move = self.path[self.index]
@@ -256,7 +314,7 @@ def set_path(self, path):
 
         Example::
 
-            pathactuator.set_path([constants.UP,constants.DOWN,constants.LEFT,constants.RIGHT])
+            path_actuator.set_path([constants.UP,constants.DOWN,constants.LEFT,constants.RIGHT])
         """
         self.path = path
         self.index = 0
@@ -320,7 +378,7 @@ def next_move(self):
 
         Example::
 
-            patrolactuator.next_move()
+            patrol_actuator.next_move()
         """
         if self.state == constants.RUNNING:
             move = self.path[self.index]

pygamelib/engine.py

@@ -2615,7 +2615,8 @@ def add_npc(
                                     constants.DOWN,
                                     constants.LEFT,
                                     constants.RIGHT,
-                                ]
+                                ],
+                                parent=npc,
                             )
                         if npc.step is None:
                             npc.step = 1

tests/test_actuators.py

@@ -1,7 +1,4 @@
-from pygamelib import actuators
-from pygamelib import constants
-from pygamelib import board_items
-from pygamelib import engine
+from pygamelib import actuators, constants, board_items, engine, base
 import unittest
 
 # Test cases for all classes in pygamelib.gfx.particles.
@@ -40,6 +37,9 @@ def test_random(self):
         al = actuators.RandomActuator.load(data)
         self.assertEqual(al.moveset, [constants.UP])
         self.assertEqual(al.moveset, a.moveset)
+        # Test with a vector based move set
+        a = actuators.RandomActuator([base.Vector2D(1, 1)])
+        self.assertEqual(a.moveset, [base.Vector2D(1, 1)])
 
     def test_random_empty(self):
         a = actuators.RandomActuator()