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

batFramework/actionContainer.py

@@ -1,38 +1,105 @@
-import batFramework as bf
-
-
-class ActionContainer:
-    def __init__(self, *actions: list[bf.Action]) -> None:
-        self._actions: dict[str, bf.Action] = {}
-        if actions:
-            self.add_action(*actions)
-
-    def clear(self):
-        self._actions = {}
-
-    def add_action(self, *actions: bf.Action):
-        for action in actions:
-            self._actions[action.get_name()] = action
-
-    def get(self,name:str)->bf.Action:
-        return self._actions.get(name)
-
-    def has_action(self, name:str):
-        return name in self._actions
-
-    def is_active(self, *names:str)->bool:
-        return all(self._actions.get(name).is_active() if name in self._actions else False for name in names)
-
-    def process_event(self, event):
-        for action in self._actions.values():
-            a = action.process_event(event)
-            if a and action._unique:
-                break
-
-    def reset(self):
-        for action in self._actions.values():
-            action.reset()
-
-    def hard_reset(self):
-        for action in self._actions.values():
-            action.hard_reset()
+import batFramework as bf
+import pygame
+
+
+class ActionContainer:
+    def __init__(self, *actions: list[bf.Action]) -> None:
+        self._actions: dict[str, bf.Action] = {}
+        if actions:
+            self.add_actions(*actions)
+
+    def __iter__(self):
+        return iter(self._actions.values())
+
+    def __getitem__(self, key):
+        return self._actions[key]
+
+    def __setitem__(self, key, value):
+        self._actions[key] = value
+
+    def __delitem__(self, key):
+        del self._actions[key]
+
+    def __contains__(self, key):
+        return key in self._actions
+
+    def __repr__(self):
+        return repr(self._actions)
+
+
+
+    def clear(self):
+        self._actions = {}
+
+    def add_actions(self, *actions: bf.Action):
+        for action in actions:
+            self._actions[action.name] = action
+
+    def get(self, name: str) -> bf.Action:
+        return self._actions.get(name)
+
+    def has_action(self, name: str):
+        return name in self._actions
+
+    def get_all(self) -> list[bf.Action]:
+        return self._actions
+
+    def is_active(self, *names: str) -> bool:
+        return all(
+            self._actions.get(name).active if name in self._actions else False
+            for name in names
+        )
+
+    def is_any_active(self,*names:str) -> bool:
+        return any(
+            self._actions.get(name).active if name in self._actions else False
+            for name in names
+        )
+
+    def process_event(self, event):
+        if event.consumed:
+            return
+        for action in self._actions.values():
+            action.process_event(event)
+            if event.consumed == True:
+                break
+
+    def reset(self):
+        for action in self._actions.values():
+            action.reset()
+
+    def hard_reset(self):
+        for action in self._actions.values():
+            action.hard_reset()
+
+
+class DirectionalKeyControls(ActionContainer):
+    def __init__(self):
+        super().__init__(
+            bf.Action("up").add_key_control(pygame.K_UP).set_holding(),
+            bf.Action("down").add_key_control(pygame.K_DOWN).set_holding(),
+            bf.Action("left").add_key_control(pygame.K_LEFT).set_holding(),
+            bf.Action("right").add_key_control(pygame.K_RIGHT).set_holding(),
+        )
+
+
+class WASDControls(ActionContainer):
+    def __init__(self):
+        super().__init__(
+            bf.Action("up").add_key_control(pygame.K_w).set_holding(),
+            bf.Action("down").add_key_control(pygame.K_s).set_holding(),
+            bf.Action("left").add_key_control(pygame.K_a).set_holding(),
+            bf.Action("right").add_key_control(pygame.K_d).set_holding(),
+        )
+
+
+class HybridControls(ActionContainer):
+    def __init__(self):
+        super().__init__(
+            bf.Action("up").add_key_control(pygame.K_UP, pygame.K_w).set_holding(),
+            bf.Action("down").add_key_control(pygame.K_DOWN, pygame.K_s).set_holding(),
+            bf.Action("left").add_key_control(pygame.K_LEFT, pygame.K_a).set_holding(),
+            bf.Action("right")
+            .add_key_control(pygame.K_RIGHT, pygame.K_r)
+            .set_holding(),
+        )

batFramework/animatedSprite.py

@@ -1,117 +1,81 @@
-import batFramework as bf
-import pygame
-
-
-
-def search_index(target, lst):
-    cumulative_sum = 0
-    for index, value in enumerate(lst):
-        cumulative_sum += value
-        if cumulative_sum >= target:
-            return index
-    return -1
-
-
-class AnimState:
-    def __init__(self, file, width, height, frame_length_list:list|int) -> None:
-        self.frames: list[pygame.Surface] = bf.utils.img_slice(file, width, height)
-        self.frames_flipX: list[pygame.Surface] = bf.utils.img_slice(
-            file, width, height, True
-        )
-
-        self.frame_length_list = []
-        self.ffl_length = 0
-        self.set_frame_length_list(frame_length_list)
-
-    def get_frame_index(self, counter:float|int):
-        return search_index(int(counter % self.ffl_length), self.frame_length_list)
-
-    def get_frame(self, counter, flip):
-        i = self.get_frame_index(counter)
-        return self.frames_flipX[i] if flip else self.frames[i]
-
-    def set_frame_length_list(self,frame_length_list:list[int]|int):
-        if isinstance(frame_length_list,int):
-            frame_length_list = [frame_length_list] * len(self.frames)
-        if len(frame_length_list) != len(self.frames) : 
-            raise ValueError("frame_length_list should have values for all frames")
-        self.frame_length_list = frame_length_list
-        self.ffl_length = sum(self.frame_length_list)
-        
-
-class AnimatedSprite(bf.DynamicEntity):
-    def __init__(self, size=None) -> None:
-        super().__init__(size, no_surface=True)
-        self.float_counter = 0
-        self.animStates: dict[str, AnimState] = {}
-        self.current_animState :str = ""
-        self.flipX = False
-        self._locked = False
-
-    def set_counter(self,value:float):
-        self.float_counter = value
-        
-
-    def lock_animState(self):
-        self._locked = True
-
-    def unlock_animState(self):
-        self._locked = False
-
-    def set_flipX(self, value):
-        self.flipX = value
-
-    def remove_animState(self, name:str):
-        if not name in self.animStates :return
-        self.animStates.pop(name) 
-        if self.current_animState == name : self.current_animState = list(self.animStates.keys())[0] if self.animStates else "" 
-
-    def add_animState(
-        self, name: str, file: str, size: tuple[int, int], frame_length_list: list[int]
-    ):
-        if name in self.animStates:
-            return
-        self.animStates[name] = AnimState(file, *size, frame_length_list)
-        if len(self.animStates) == 1 : self.set_animState(name)
-
-    def set_animState(self, state:str, reset_counter=True, lock=False):
-        if state not in self.animStates or self._locked:
-            return False
-        self.current_animState = state
-        self.rect = (
-            self.animStates[self.current_animState]
-            .frames[0]
-            .get_frect(center=self.rect.center)
-        )
-        if reset_counter or self.float_counter > sum(
-            self.get_state().frame_length_list
-        ):
-            self.float_counter = 0
-        if lock:
-            self.lock_animState()
-        return True
-
-    def get_state(self):
-        return self.animStates.get(self.current_animState,None)
-
-    def get_frame_index(self):
-        return self.animStates[self.current_animState].get_frame_index(
-            self.float_counter
-        )
-
-    def update(self, dt: float):
-        if not self.animStates : return
-        self.float_counter += 60 * dt
-        if self.float_counter > self.get_state().ffl_length:
-            self.float_counter = 0
-        self.do_update(dt)
-
-    def draw(self, camera: bf.Camera) -> bool:
-        if not self.visible or not camera.intersects(self.rect) or not self.animStates:
-            return False
-        # pygame.draw.rect(camera.surface,"purple",camera.transpose(self.rect).move(2,2))
-        camera.surface.blit(
-            self.get_state().get_frame(self.float_counter, self.flipX),
-            camera.transpose(self.rect),
-        )
-        return True
+import batFramework as bf
+import pygame
+from typing import List, Dict, Tuple, Union, Optional, Self, Callable, Any
+from .animation import Animation
+
+class AnimatedSprite(bf.Drawable):
+    def __init__(self,*args,**kwargs) -> None:
+        super().__init__((0,0),*args,**kwargs)
+        self.animations : dict[str,Animation] = {}
+        self.counter = 0 # int counter
+        self._fcounter = 0.0 # counter
+        self.current_animation : str = None
+        self.end_callback : Callable[[],Any] = None
+        self._flipX : bool = False
+        self.animation_loop : int = -1
+        self.queued_animation : str = None
+
+    @property
+    def flipX(self)->bool:
+        return self._flipX
+    
+    @flipX.setter
+    def flipX(self,value:bool):
+        self._flipX = value
+
+    def set_animation_end_callback(self,callback : Callable[[],Any]):
+        self.end_callback = callback 
+
+    def add_animation(self,animation:Animation)->Self:
+        self.animations[animation.name] = animation
+        if self.rect.size == (0,0):
+            self.rect.size = animation.frames[0].get_size()
+            self.surface = animation.frames[0].copy()
+        return self
+    
+    def set_animation(self,name:str,reset_counter:bool=True,loop:int=-1,queued_animation:str=None):
+        """
+        Sets the current animation,
+        if animation with given name hasn't been added, nothing happens
+        """
+        if name not in self.animations :
+            return
+        self.current_animation = name
+        if reset_counter:
+            self._fcounter = 0
+            self.counter = 0
+        self.animation_loop = loop
+        if loop != -1:
+            self.queued_animation = queued_animation
+        else:
+            self.queued_animation = None
+
+    def get_current_frame(self)->int|None:
+        if not self.current_animation:
+            return None
+        return  self.animations[self.current_animation].counter_to_frame(self._fcounter)        
+
+    def update(self, dt):
+        super().update(dt)        
+        if not self.current_animation:
+            return
+        self._fcounter += dt * 60 
+        self.counter = int(self._fcounter)
+        # self.counter = self.get_current_frame()
+        # print(f"{self.current_animation}:{self.counter}/{self.animations[self.current_animation].duration_list_length}")
+        if self.counter >= self.animations[self.current_animation].duration_list_length:
+            #one animation cycle ended
+            if self.animation_loop > 0:
+                self.animation_loop -= 1
+            elif self.queued_animation is not None:
+                # print("set to queued :",self.queued_animation)
+                self.set_animation(self.queued_animation,True)
+
+            if self.end_callback:
+                self.end_callback()            
+ 
+    def draw(self, camera):
+        # print(self.current_animation, f"{self.counter}/{self.animations[self.current_animation].duration_list_length}")
+        self.surface = self.animations[self.current_animation].get_frame(self.counter,self.flipX)#,(0,0)
+        super().draw(camera)
+        

batFramework/animation.py

@@ -0,0 +1,91 @@
+import pygame
+import batFramework as bf
+from typing import List, Dict, Tuple, Union, Optional, Self, Iterable
+
+
+def search_index(target: int, lst: List[int]) -> int:
+    cumulative_sum = 0
+    for index, value in enumerate(lst):
+        cumulative_sum += value
+        if cumulative_sum >= target:
+            return index
+    return -1
+
+
+class Animation:
+    def __init__(
+        self,
+        name: str
+    ) -> None:
+        """
+        Class to hold 2D animation data.
+        All frames are expected to have the same size.
+        This class does not do anything on its own, but can be used to easily manage
+        multiple animations using a simple counter.
+        The duration list provides a entry point for tweaking the timings,
+        so image data can be saved (no need for contiguous duplicate frames)
+        """
+        self.name = name
+        self.frames: list[pygame.Surface] = []
+        self.frames_flipX : list[pygame.Surface] = []
+        self.duration_list = []
+        self.duration_list_length = 0
+        self.numFrames : int = 0
+
+    def from_surface(self,surface:pygame.Surface,frame_size : Tuple[int,int])->Self:
+        """
+        Loads frames from a spritesheet containing all animation frames aligned horizontally, left to right
+        Frames are cut and stored in 2 versions, original and flipped on the horizontal axis.
+        Flipping sprites being pretty common, this serves as a builtin cache.
+        """
+        self.frames : List[pygame.Surface] = list(
+            bf.utils.split_surface(surface, frame_size).values()
+        )
+        self.frames_flipX : List[pygame.Surface] = list(
+            bf.utils.split_surface(
+                surface, frame_size,
+                func=lambda s : pygame.transform.flip(s,True,False)
+            ).values()
+        )
+        self.duration_list_length = len(self.frames)
+        self.numFrames = self.duration_list_length
+        if not self.duration_list:
+            self.duration_list = [1]*self.duration_list_length
+        return self
+
+    def from_path(
+        self,
+        path: str,
+        frame_size: Tuple[int, int],
+        convert_alpha: bool = True
+    ) -> Self:
+        """
+        Loads frames from a spritesheet at the given path.
+        Uses ResourceManager to load the image.
+        """
+        surface = bf.ResourceManager().get_image(path, convert_alpha)
+        return self.from_surface(surface, frame_size)
+
+
+    def __repr__(self):
+        return f"Animation({self.name})"
+
+    def counter_to_frame(self, counter: Union[float, int]) -> int:
+        if not self.frames : 
+            raise ValueError("Animation has no frames")
+        return search_index(
+            int(counter % self.duration_list_length), self.duration_list
+        )
+
+    def get_frame(self, counter: Union[float, int], flip: bool) -> pygame.Surface:
+        i = self.counter_to_frame(counter)
+        return self.frames_flipX[i] if flip else self.frames[i]
+
+    def set_duration_list(self, duration_list: Union[List[int], int]) -> Self:
+        if not isinstance(duration_list, Iterable):
+            duration_list = [duration_list] * len(self.frames)
+        if len(duration_list) != self.numFrames:
+            raise ValueError("duration_list should have values for all frames")
+        self.duration_list = duration_list
+        self.duration_list_length = sum(self.duration_list)
+        return self