batframework 1.1.0__py3-none-any.whl → 2.0.0a1__py3-none-any.whl

batFramework/action.py

@@ -1,252 +1,280 @@
-from typing import Any
-from enum import Enum
-import pygame
-
-ActionType = Enum("type", "INSTANTANEOUS CONTINUOUS HOLDING")
-
-class Action:
-    def __init__(self, name: str) -> None:
-        """
-        Create a new action with the given name.
-
-        Args:
-            name (str): The name of the action.
-        """
-        self._name = name
-        self._active = False
-        self._type = ActionType.INSTANTANEOUS
-        self._key_control = set()
-        self._mouse_control = set()
-        self._gamepad_button_control = set()
-        self._gamepad_axis_control = set()
-        self._holding = set()
-        self._unique = True
-        self.data : Any = None
-
-    def set_unique(self, val: bool) -> None:
-        """
-        Set whether this action is unique (exclusive).
-
-        Args:
-            val (bool): True if the action is unique, False otherwise.
-        """
-        self._unique = val
-
-    def is_active(self) -> bool:
-        """
-        Check if the action is currently active.
-
-        Returns:
-            bool: True if the action is active, False otherwise.
-        """
-        return self._active
-
-    def set_active(self, value: bool) -> None:
-        """
-        Set the action's active state.
-
-        Args:
-            value (bool): True to activate the action, False to deactivate it.
-        """
-        self._active = value
-        self._holding = set()
-
-    def add_key_control(self, *keys) -> 'Action':
-        """
-        Add key controls to the action.
-
-        Args:
-            *keys (int): Key codes to control this action.
-
-        Returns:
-            Action: The updated Action object for method chaining.
-        """
-        self._key_control.update(keys)
-        return self
-
-    def add_mouse_control(self, *mouse_buttons) -> 'Action':
-        """
-        Add mouse control to the action.
-
-        Args:
-            *mouse_buttons (int): Mouse button codes to control this action.
-
-        Returns:
-            Action: The updated Action object for method chaining.
-        """
-        self._mouse_control.update(mouse_buttons)
-        return self
-
-    def get_name(self) -> str:
-        """
-        Get the name of the action.
-
-        Returns:
-            str: The name of the action.
-        """
-        return self._name
-
-    def set_continuous(self) -> 'Action':
-        """
-        Set the action type to continuous.
-
-        Returns:
-            Action: The updated Action object for method chaining.
-        """
-        self._holding = set()
-        self._type = ActionType.CONTINUOUS
-        return self
-
-    def is_continuous(self) -> bool:
-        """
-        Check if the action type is continuous.
-
-        Returns:
-            bool: True if the action type is continuous, False otherwise.
-        """
-        return self._type == ActionType.CONTINUOUS
-
-    def set_instantaneous(self) -> 'Action':
-        """
-        Set the action type to instantaneous.
-
-        Returns:
-            Action: The updated Action object for method chaining.
-        """
-        self._type = ActionType.INSTANTANEOUS
-        self._holding = set()
-        return self
-
-    def is_instantaneous(self) -> bool:
-        """
-        Check if the action type is instantaneous.
-
-        Returns:
-            bool: True if the action type is instantaneous, False otherwise.
-        """
-        return self._type == ActionType.INSTANTANEOUS
-
-    def set_holding(self) -> 'Action':
-        """
-        Set the action type to holding.
-
-        Returns:
-            Action: The updated Action object for method chaining.
-        """
-        self._type = ActionType.HOLDING
-        return self
-
-    def is_holding_type(self) -> bool:
-        """
-        Check if the action type is holding.
-
-        Returns:
-            bool: True if the action type is holding, False otherwise.
-        """
-        return self._type == ActionType.HOLDING
-
-    def process_update(self,event:pygame.Event)->None:
-        if self.is_active() and event.type == pygame.MOUSEMOTION and  self.is_holding_type() and pygame.MOUSEMOTION in self._mouse_control:
-            self.data = {"pos":event.pos,"rel":event.rel}
-
-    def process_activate(self, event: pygame.event.Event) -> bool:
-        """
-        Process activation of the action based on a pygame event.
-
-        Args:
-            event (pygame.event.Event): The pygame event to process.
-
-        Returns:
-            bool: True if the action was activated by the event, False otherwise.
-        """
-        if event.type == pygame.KEYDOWN and event.key in self._key_control:
-            self._active = True
-            if self.is_holding_type():
-                self._holding.add(event.key)
-            return True
-
-        if event.type == pygame.MOUSEBUTTONDOWN and event.button in self._mouse_control:
-            self._active = True
-            if self.is_holding_type():
-                self._holding.add(event.button)
-            return True
-
-        if event.type == pygame.MOUSEMOTION and event.type in self._mouse_control:
-            self._active = True
-            if self.is_holding_type():
-                self._holding.add(event.type)
-            return True
-
-        return False
-
-    def process_deactivate(self, event: pygame.event.Event) -> bool:
-        """
-        Process deactivation of the action based on a pygame event.
-
-        Args:
-            event (pygame.event.Event): The pygame event to process.
-
-        Returns:
-            bool: True if the action was deactivated by the event, False otherwise.
-        """
-        if self._type == ActionType.HOLDING:
-            if event.type == pygame.KEYUP and event.key in self._key_control:
-                if event.key in self._holding:
-                    self._holding.remove(event.key)
-                if not self._holding:
-                    self._active = False
-                    return True
-            elif (
-                event.type == pygame.MOUSEBUTTONUP
-                and event.button in self._mouse_control
-            ):
-                if event.button in self._holding:
-                    self._holding.remove(event.button)
-                if not self._holding:
-                    self._active = False
-                    return True
-            elif (
-                event.type == pygame.MOUSEMOTION
-                and event.type in self._mouse_control
-            ):
-                self.value = None
-                if event.type in self._holding:
-                    self._holding.remove(event.type)
-                if not self._holding:
-                    self._active = False
-                    return True
-
-        return False
-
-    def process_event(self, event: pygame.event.Event) -> bool:
-        """
-        Process a pygame event and update the action's state.
-
-        Args:
-            event (pygame.event.Event): The pygame event to process.
-
-        Returns:
-            bool: True if the action state changed, False otherwise.
-        """
-        if not self._active:
-            res = self.process_activate(event)
-        else:
-            res = self.process_deactivate(event)
-        self.process_update(event)
-        return res
-
-    def reset(self) -> None:
-        """
-        Reset the action's state to the default state.
-        """
-        if self._type in {ActionType.CONTINUOUS, ActionType.HOLDING}:
-            return
-        elif self._type == ActionType.INSTANTANEOUS:
-            self._active = False
-
-    def hard_reset(self) -> None:
-        """
-        Hard reset the action, deactivating it and clearing any holding controls.
-        """
-        self._active = False
-        self._holding = set()
+from typing import Any, Self
+from enum import Enum
+import pygame
+from .enums import actionType
+
+
+class Action:
+    def __init__(self, name: str) -> None:
+        """
+        Create a new action with the given name.
+
+        Args:
+            name (str): The name of the action.
+        """
+        self.name: str = name
+        self.active: bool = False
+        self.data: dict = {}
+        self.consume_event: bool = False
+        self._type: actionType = actionType.INSTANTANEOUS
+        self._key_control: set = set()
+        self._mouse_control: set = set()
+        self._event_control: set = set()
+        self._gamepad_button_control: set = set()
+        self._gamepad_axis_control: set = set()
+        self._holding = set()
+
+    def __bool__(self) -> bool :
+        return self.active
+
+    def set_consume_event(self, val: bool) -> Self:
+        """
+        Set whether this action is unique (exclusive).
+        When in an action Container, unique actions -when active - break the propagation of their event to other actions.
+
+        Args:
+            val (bool): True if the action is unique, False otherwise.
+        """
+        self.consume_event = val
+        return self
+
+    def set_active(self, value: bool) -> None:
+        """
+        Set the action's active state.
+
+        Args:
+            value (bool): True to activate the action, False to deactivate it.
+        """
+        self.active = value
+        
+
+    def add_event_control(self, *events) -> Self:
+        self._event_control.update(events)
+        return self
+
+    def remove_event_control(self, *events) -> Self:
+        self._event_control = self._event_control - events
+        return self
+
+    def add_key_control(self, *keys) -> Self:
+        """
+        Add key controls to the action.
+
+        Args:
+            *keys (int): Key codes to control this action.
+
+        Returns:
+            Action: The updated Action object for method chaining.
+        """
+        self._key_control.update(keys)
+        return self
+
+    def remove_key_control(self, *keys: int) -> Self:
+        """
+        Remove key controls to the action.
+
+        Args:
+            *keys (int): Key codes to control this action.
+
+        Returns:
+            Action: The updated Action object for method chaining.
+        """
+        self._key_control = self._key_control - set(keys)
+        return self
+
+    def replace_key_control(self, key, new_key) -> Self:
+        if not key in self._key_control:
+            return self
+        self.remove_key_control(key)
+        self.add_key_control(new_key)
+        return self
+
+    def add_mouse_control(self, *mouse: int) -> Self:
+        """
+        Add mouse control to the action.
+
+        Args:
+            *mouse_buttons (int): Mouse button codes to control this action.
+
+        Returns:
+            Action: The updated Action object for method chaining.
+        """
+        self._mouse_control.update(mouse)
+        return self
+
+    def remove_mouse_control(self, *mouse: int) -> Self:
+        self._mouse_control = self._mouse_control - set(mouse)
+        return self
+
+    def replace_mouse_control(self, mouse, new_mouse) -> Self:
+        if not mouse in self._mouse_control:
+            return self
+        self.remove_mouse_control(mouse)
+        self.add_mouse_control(new_mouse)
+        return self
+
+    def set_continuous(self) -> Self:
+        """
+        Set the action type to continuous.
+
+        Returns:
+            Action: The updated Action object for method chaining.
+        """
+        self._holding = set()
+        self._type = actionType.CONTINUOUS
+        return self
+
+    def is_continuous(self) -> bool:
+        """
+        Check if the action type is continuous.
+
+        Returns:
+            bool: True if the action type is continuous, False otherwise.
+        """
+        return self._type == actionType.CONTINUOUS
+
+    def set_instantaneous(self) -> Self:
+        """
+        Set the action type to instantaneous.
+
+        Returns:
+            Action: The updated Action object for method chaining.
+        """
+        self._type = actionType.INSTANTANEOUS
+        self._holding = set()
+        return self
+
+    def is_instantaneous(self) -> bool:
+        """
+        Check if the action type is instantaneous.
+
+        Returns:
+            bool: True if the action type is instantaneous, False otherwise.
+        """
+        return self._type == actionType.INSTANTANEOUS
+
+    def set_holding(self) -> Self:
+        """
+        Set the action type to holding.
+
+        Returns:
+            Action: The updated Action object for method chaining.
+        """
+        self._type = actionType.HOLDING
+        return self
+
+    def is_holding_type(self) -> bool:
+        """
+        Check if the action type is holding.
+
+        Returns:
+            bool: True if the action type is holding, False otherwise.
+        """
+        return self._type == actionType.HOLDING
+
+    def process_update(self, event: pygame.Event) -> None:
+        if event.type in self._event_control:
+            self.data = event.dict
+            self.data.update({"type":event.type})
+
+
+    def process_activate(self, event: pygame.event.Event):
+        """
+        Process activation of the action based on a pygame event.
+
+        Args:
+            event (pygame.event.Event): The pygame event to process.
+
+        Returns:
+            bool: True if the action was activated by the event, False otherwise.
+        """
+
+        if event.type == pygame.KEYDOWN and event.key in self._key_control:
+            self._activate_action(event.key)
+        elif (
+            event.type == pygame.MOUSEBUTTONDOWN and event.button in self._mouse_control
+        ):
+            self._activate_action(event.button)
+
+        elif event.type in self._event_control:
+            self._activate_action(event.type)
+        else:
+            return
+        
+        self.data = event.dict
+        self.data.update({"type":event.type})
+
+        if self.consume_event:
+            event.consumed = True
+
+    def _activate_action(self, control):
+        self.active = True
+        if self._type == actionType.HOLDING:
+            self._holding.add(control)
+
+    def process_deactivate(self, event: pygame.event.Event):
+        """
+        Process deactivation of the action based on a pygame event.
+
+        Args:
+            event (pygame.event.Event): The pygame event to process.
+
+        """
+        if self._type == actionType.HOLDING:
+            if event.type == pygame.KEYUP and event.key in self._key_control:
+                self._deactivate_action(event.key)
+            elif (
+                event.type == pygame.MOUSEBUTTONUP
+                and event.button in self._mouse_control
+            ):
+                self._deactivate_action(event.button)
+            elif event.type in self._event_control:
+                self._deactivate_action(event.type)
+
+            else:
+                event.consumed = False
+                return
+
+        if self.consume_event:
+            event.consumed = True
+
+    def _deactivate_action(self, control) -> bool:
+        if control in self._holding:
+            self._holding.remove(control)
+        if not self._holding:
+            self.active = False
+
+    def process_event(self, event: pygame.event.Event):
+        """
+        Process a pygame event and update the action's state.
+
+        Args:
+            event (pygame.event.Event): The pygame event to process.
+        """
+
+        if event.consumed:
+            return
+        if not self.active:
+            self.process_activate(event)
+        else:
+            self.process_deactivate(event)
+        if self.active:
+            self.process_update(event)
+        return
+
+    def reset(self) -> None:
+        """
+        Reset the action's state to the default state.
+        """
+        if self._type in {actionType.CONTINUOUS, actionType.HOLDING}:
+            return
+        elif self._type == actionType.INSTANTANEOUS:
+            self.active = False
+
+    def hard_reset(self) -> None:
+        """
+        Hard reset the action, deactivating it and clearing any holding controls.
+        """
+        self.active = False
+        self._holding = set()
+        self.data = {}