batframework 1.0.8a12__py3-none-any.whl → 1.0.8a14__py3-none-any.whl

batFramework/manager.py

@@ -1,23 +1,24 @@
 import batFramework as bf
 import pygame
 import asyncio
-import random
 
 class Manager(bf.SceneManager):
     def __init__(self, *initial_scene_list) -> None:
-        # random.seed("random")
         super().__init__()
-        self._screen: pygame.Surface | None = bf.const.SCREEN
-        self._timeManager = bf.TimeManager()
-        self._cutsceneManager = bf.CutsceneManager()
-        self._cutsceneManager.set_manager(self)
-        self._clock: pygame.Clock = pygame.Clock()
-        self._is_async_running : bool = False
-        self._running = False
+        self.debug_mode: bf.enums.debugMode = bf.debugMode.HIDDEN
+        self.screen: pygame.Surface | None = bf.const.SCREEN
+        self.timeManager = bf.TimeManager()
+        self.cutsceneManager = bf.CutsceneManager()
+        self.cutsceneManager.set_manager(self)
+        self.clock: pygame.Clock = pygame.Clock()
+        self.is_async_running : bool = False
+        self.running = False
         pygame.mouse.set_cursor(bf.const.DEFAULT_CURSOR)
         self.do_pre_init()
         self.init_scenes(*initial_scene_list)
-        self.set_sharedVar("clock", self._clock)
+        bf.ResourceManager().set_sharedVar("clock", self.clock)
+        bf.ResourceManager().set_sharedVar("debug_mode", self.debug_mode)
+
         self.do_init()
 
     @staticmethod
@@ -39,14 +40,14 @@ class Manager(bf.SceneManager):
         print("=" * 50)
         
         # Print the timers information
-        print(self._timeManager)
+        print(self.timeManager)
         
         # End with a visual separator
         print("=" * 50 + "\n")
 
 
     def get_fps(self) -> float:
-        return self._clock.get_fps()
+        return self.clock.get_fps()
 
     def do_init(self) -> None:
         pass
@@ -55,67 +56,67 @@ class Manager(bf.SceneManager):
         pass
 
     def stop(self) -> None:
-        self._running = False
+        self.running = False
 
     async def run_async(self):
-        if self._running:
+        if self.running:
             print("Error : Already running")
             return
-        self._is_async_running = True
-        self._running = True
+        self.is_async_running = True
+        self.running = True
         dt: float = 0
-        while self._running:
+        while self.running:
             for event in pygame.event.get():
                 event.consumed = False
                 self.process_event(event)
                 if not event.consumed:
                     if event.type == pygame.QUIT:
-                        self._running = False
+                        self.running = False
                         break
                     if event.type == pygame.VIDEORESIZE and not (
                         bf.const.FLAGS & pygame.SCALED
                     ):
                         bf.const.set_resolution((event.w, event.h))
             # update
-            dt = self._clock.tick(bf.const.FPS) / 1000
-            # dt = min(dt, 0.02) dirty fix for dt being too high when window not focused for a long time
-            self._timeManager.update(dt)
-            self._cutsceneManager.update(dt)
+            self.timeManager.update(dt)
+            self.cutsceneManager.update(dt)
             self.update(dt)
             # render
-            self._screen.fill((0, 0, 0))
-            self.draw(self._screen)
+            self.screen.fill((0, 0, 0))
+            self.draw(self.screen)
             pygame.display.flip()
+            dt = self.clock.tick(bf.const.FPS) / 1000
+            # dt = min(dt, 0.02) dirty fix for dt being too high when window not focused for a long time
             await asyncio.sleep(0)
         pygame.quit()
 
 
     def run(self) -> None:
-        if self._running:
+        if self.running:
             print("Error : Already running")
             return
-        self._running = True
+        self.running = True
         dt: float = 0
-        while self._running:
+        while self.running:
             for event in pygame.event.get():
                 event.consumed = False
                 self.process_event(event)
                 if not event.consumed:
                     if event.type == pygame.QUIT:
-                        self._running = False
+                        self.running = False
                         break
                     if event.type == pygame.VIDEORESIZE and not (
                         bf.const.FLAGS & pygame.SCALED
                     ):
                         bf.const.set_resolution((event.w, event.h))
             # update
-            dt = self._clock.tick(bf.const.FPS) / 1000
-            # dt = min(dt, 0.02) dirty fix for dt being too high when window not focused for a long time
-            self._timeManager.update(dt)
-            self._cutsceneManager.update(dt)
+            self.timeManager.update(dt)
+            self.cutsceneManager.update(dt)
             self.update(dt)
             # render
-            self._screen.fill((0, 0, 0))
-            self.draw(self._screen)
+            self.screen.fill((0, 0, 0))
+            self.draw(self.screen)
             pygame.display.flip()
+            dt = self.clock.tick(bf.const.FPS) / 1000
+            # dt = min(dt, 0.02) dirty fix for dt being too high when window not focused for a long time
         pygame.quit()

batFramework/particle.py

@@ -78,7 +78,7 @@ class DirectionalParticle(BasicParticle):
         super().update_surface()
 
 
-class ParticleGenerator(bf.Entity):
+class ParticleGenerator(bf.Drawable):
     def __init__(self) -> None:
         super().__init__((0, 0))
         self.particles: list[Particle] = []

batFramework/scene.py

@@ -70,35 +70,6 @@ class Scene:
         """Get the scene index."""
         return self.scene_index
 
-    def set_sharedVar(self, name: str, value: Any) -> bool:
-        """
-        Set a shared variable in the manager.
-
-        Args:
-            name: Name of the shared variable.
-            value: Value to set.
-
-        Returns:
-            bool: True if setting was successful, False otherwise.
-        """
-        if not self.manager:
-            return False
-        return self.manager.set_sharedVar(name, value)
-
-    def get_sharedVar(self, name: str, error_value=None) -> Any:
-        """
-        Get a shared variable from the manager.
-
-        Args:
-            name: Name of the shared variable.
-
-        Returns:
-            Any: Value of the shared variable.
-        """
-        if not self.manager:
-            return error_value
-        return self.manager.get_sharedVar(name, error_value)
-
     def do_when_added(self):
         pass
 
@@ -277,7 +248,6 @@ class Scene:
         self.actions.reset()
         self.early_actions.reset()
 
-
         if self.entities_to_add:
             for e in self.entities_to_add:
                 self.world_entities[e] = None
@@ -337,7 +307,7 @@ class Scene:
 
     def _draw_camera(self, camera: bf.Camera, entity_list):
         _ = [entity.draw(camera) for entity in entity_list]
-        debugMode = self.manager.debug_mode
+        debugMode = bf.ResourceManager().get_sharedVar("debug_mode")
         # Draw outlines for world entities if required
         if debugMode == bf.debugMode.OUTLINES:
             [self.debug_entity(e, camera) for e in entity_list]
@@ -355,15 +325,12 @@ class Scene:
         self.set_active(True)
         self.set_visible(True)
         self.root.clear_hovered()
-        # self.root.clear_focused()
         self.root.build()
         bf.TimeManager().activate_register(self.name)
         self.do_on_enter()
-        # self.root.visit(lambda e : e.resolve_constraints())
 
     def on_exit(self):
         self.root.clear_hovered()
-        # self.root.clear_focused()
         self.set_active(False)
         self.set_visible(False)
         self.actions.hard_reset()

batFramework/sceneManager.py

@@ -2,7 +2,6 @@ import batFramework as bf
 import pygame
 from typing import Self
 
-
 def swap(lst, index1, index2):
     lst[index1], lst[index2] = lst[index2], lst[index1]
 
@@ -11,11 +10,6 @@ class SceneManager:
     def __init__(self) -> None:
         self.scenes: list[bf.Scene] = []
         self.shared_events = {pygame.WINDOWRESIZED}
-
-        self.set_sharedVar("in_cutscene", False)
-        self.set_sharedVar("player_has_control", True)
-        self.old_player_control = True
-        self.debug_mode: bf.enums.debugMode = bf.debugMode.HIDDEN
         self.current_transitions: dict[str, bf.transition.Transition] = {}
 
     def init_scenes(self, *initial_scenes:bf.Scene):
@@ -23,7 +17,6 @@ class SceneManager:
             s.set_scene_index(index)
         for s in reversed(initial_scenes):
             self.add_scene(s)
-        # self.scenes = list(initial_scenes)
         self.set_scene(initial_scenes[0].get_name())
         self.update_scene_states()
 
@@ -38,7 +31,7 @@ class SceneManager:
         Print detailed information about the current state of the scenes and shared variables.
         """
 
-        def format_scene_info(scene):
+        def format_scene_info(scene:bf.Scene):
             status = 'Active' if scene.active else 'Inactive'
             visibility = 'Visible' if scene.visible else 'Invisible'
             return f"{scene.name:<30} | {status:<8} | {visibility:<10} | Index={scene.scene_index}"
@@ -78,13 +71,6 @@ class SceneManager:
 
         print("=" * 50 + "\n")
 
-
-    def set_sharedVar(self, name, value) -> None:
-        bf.ResourceManager().set_sharedVar(name,value)
-
-    def get_sharedVar(self, name, error_value=None):
-        return bf.ResourceManager().get_sharedVar(name, error_value)
-
     def get_current_scene_name(self) -> str:
         """get the name of the current scene"""
         return self.scenes[0].get_name()
@@ -106,10 +92,10 @@ class SceneManager:
     def remove_scene(self, name: str):
         self.scenes = [s for s in self.scenes if s.name != name]
 
-    def has_scene(self, name):
+    def has_scene(self, name:str):
         return any(name == scene.name for scene in self.scenes)
 
-    def get_scene(self, name):
+    def get_scene(self, name:str):
         if not self.has_scene(name):
             return None
         for scene in self.scenes:
@@ -150,8 +136,6 @@ class SceneManager:
     def _start_transition(self, target_scene: bf.Scene):
         target_scene.set_active(True)
         target_scene.set_visible(True)
-        self.old_player_control = bool(self.get_sharedVar("player_has_control"))
-        self.set_sharedVar("player_has_control", False)
 
     def _end_transition(self, scene_name, index):
         self.set_scene(scene_name, index, True)
@@ -177,11 +161,10 @@ class SceneManager:
             self.scenes[index].do_on_enter_early()
         target_scene.on_enter()
 
-        self.set_sharedVar("player_has_control", self.old_player_control)
 
 
     def cycle_debug_mode(self):
-        current_index = self.debug_mode.value
+        current_index = bf.ResourceManager().get_sharedVar("debug_mode").value
         next_index = (current_index + 1) % len(bf.debugMode)
         return bf.debugMode(next_index)
 
@@ -193,8 +176,7 @@ class SceneManager:
             and event.type == pygame.KEYDOWN
         ):
             if event.key == pygame.K_d:
-                self.debug_mode = self.cycle_debug_mode()
-                self.set_sharedVar("debug_mode", self.debug_mode)
+                bf.ResourceManager().set_sharedVar("debug_mode", self.cycle_debug_mode())
                 return
             if event.key == pygame.K_p:
                 self.print_status()

batFramework/sprite.py

@@ -3,11 +3,11 @@ import pygame
 from typing import Self
 
 
-class Sprite(bf.Entity):
+class Sprite(bf.Drawable):
     def __init__(
         self,
-        path=None,
         size: None | tuple[int, int] = None,
+        path=None,
         convert_alpha: bool = True,
     ):
         self.original_surface: pygame.Surface = None

batFramework/templates/character.py

@@ -3,8 +3,8 @@ import pygame
 from .states import *
 
 class Platform2DCharacter(bf.Character):
-    def __init__(self):
-        super().__init__()
+    def __init__(self,*args,**kwargs):
+        super().__init__(*args,**kwargs)
         self.actions = bf.ActionContainer(
             *bf.DirectionalKeyControls(),
             bf.Action("jump").add_key_control(pygame.K_SPACE).set_holding()
@@ -18,8 +18,6 @@ class Platform2DCharacter(bf.Character):
         self.friction = 0.7
         self.gravity = 300
         self.terminal_velocity = 1000
-        self.state_machine.set_state("idle")
-        
 
     def do_setup_animations(self):
         self.add_animation(bf.Animation("idle"))
@@ -33,7 +31,8 @@ class Platform2DCharacter(bf.Character):
         self.state_machine.add_state(Platform2DRun())
         self.state_machine.add_state(Platform2DJump())
         self.state_machine.add_state(Platform2DFall())
-
+        self.state_machine.set_state("idle")
+        
 
 
     def do_reset_actions(self) -> None:
@@ -41,4 +40,4 @@ class Platform2DCharacter(bf.Character):
 
     def do_process_actions(self, event: pygame.Event) -> None:
         self.actions.process_event(event)
-    
+    

batFramework/{time.py → timeManager.py}

@@ -1,7 +1,5 @@
 import batFramework as bf
 from typing import Self
-
-
 from typing import Callable, Union, Self
 
 

batFramework/utils.py

@@ -1,17 +1,16 @@
 import pygame
-from enum import Enum
-import os
 import batFramework as bf
-import json
+import random
 from .enums import *
 import re
-from typing import Callable, TYPE_CHECKING, Any
+from typing import Callable, TYPE_CHECKING
 from functools import cache
 if TYPE_CHECKING:
-    from .object import Object
+    from .drawable import Drawable
     from .entity import Entity
 
 
+
 class Singleton(type):
     _instances = {}
 
@@ -28,9 +27,15 @@ class Utils:
         surface: pygame.Surface, split_size: tuple[int, int], func=None
     ) -> dict[tuple[int, int], pygame.Surface]:
         """
-        Splits a surface into subsurfaces and returns a dictionnary of them
-        with their tuple coordinates as keys.
-        Exemple : '(0,0) : Surface'
+        Splits a surface into subsurfaces based on a given size and returns a dictionary of them with their coordinates as keys.
+
+        Args:
+            surface (pygame.Surface): The surface to be split.
+            split_size (tuple[int, int]): The size of each subsurface (width, height).
+            func (callable, optional): A function to apply to each subsurface. Defaults to None.
+
+        Returns:
+            dict[tuple[int, int], pygame.Surface]: A dictionary with (x, y) coordinates as keys and the corresponding subsurfaces as values.
         """
         width, height = surface.get_size()
         res = {}
@@ -47,6 +52,19 @@ class Utils:
 
     @staticmethod
     def filter_text(text_mode: textMode):
+        """
+        Filters a string based on the specified text mode.
+
+        Args:
+            text_mode (textMode): Mode specifying the type of filtering (ALPHABETICAL, NUMERICAL, ALPHANUMERICAL).
+
+        Returns:
+            callable: A function that takes a string and removes all characters not allowed by the text mode.
+
+        Raises:
+            ValueError: If an unsupported text mode is provided.
+        """
+
         if text_mode == textMode.ALPHABETICAL:
             pattern = re.compile(r"[^a-zA-Z]")
         elif text_mode == textMode.NUMERICAL:
@@ -66,15 +84,20 @@ class Utils:
     @cache
     def create_spotlight(inside_color, outside_color, radius, radius_stop=None, dest_surf=None,size=None):
         """
-        Draws a circle spotlight centered on a surface
-        inner color on the center
-        gradient towards outside color from radius to radius stop
-        surface background is made transparent
-        if des_surf is None:
-            if size is None :  size is radius_stop*radius_stop
-            returns the newly created surface of size 'size' with the spotlight drawn
-
+        Creates a spotlight effect on a surface with a gradient from inside_color to outside_color.
+
+        Args:
+            inside_color (tuple[int, int, int]): RGB color at the center of the spotlight.
+            outside_color (tuple[int, int, int]): RGB color at the outer edge of the spotlight.
+            radius (int): Radius of the inner circle.
+            radius_stop (int, optional): Radius where the spotlight ends. Defaults to the value of radius.
+            dest_surf (pygame.Surface, optional): Surface to draw the spotlight on. Defaults to None.
+            size (tuple[int, int], optional): Size of the surface if dest_surf is None. Defaults to a square based on radius_stop.
+
+        Returns:
+            pygame.Surface: The surface with the spotlight effect drawn on it.
         """
+
         if radius_stop is None:
             radius_stop = radius
         diameter = radius_stop * 2
@@ -103,6 +126,18 @@ class Utils:
 
     @staticmethod
     def draw_spotlight(dest_surf:pygame.Surface,inside_color,outside_color,radius,radius_stop=None,center=None):
+        """
+        Draws a spotlight effect directly onto an existing surface.
+
+        Args:
+            dest_surf (pygame.Surface): The surface to draw the spotlight on.
+            inside_color (tuple[int, int, int]): RGB color at the center of the spotlight.
+            outside_color (tuple[int, int, int]): RGB color at the outer edge of the spotlight.
+            radius (int): Radius of the inner circle.
+            radius_stop (int, optional): Radius where the spotlight ends. Defaults to the value of radius.
+            center (tuple[int, int], optional): Center point of the spotlight. Defaults to the center of dest_surf.
+        """
+
         if radius_stop is None:
             radius_stop = radius
         center = dest_surf.get_rect().center if center is None else center
@@ -117,12 +152,34 @@ class Utils:
             pygame.draw.circle(dest_surf, inside_color, center, radius)
 
     @staticmethod
-    def animate_move(entity:"Object", start_pos : tuple[float,float], end_pos:tuple[float,float])->Callable[[float],None]:
+    def animate_move(entity:"Entity", start_pos : tuple[float,float], end_pos:tuple[float,float])->Callable[[float],None]:
+        """
+        Creates a function to animate the movement of an entity from start_pos to end_pos.
+
+        Args:
+            entity (Entity): The entity to move.
+            start_pos (tuple[float, float]): The starting position of the entity.
+            end_pos (tuple[float, float]): The ending position of the entity.
+
+        Returns:
+            Callable[[float], None]: A function that updates the entity's position based on a progression value (0 to 1).
+        """
         def func(x):
             entity.set_center(start_pos[0]+(end_pos[0]-start_pos[0])*x,start_pos[1]+(end_pos[1]-start_pos[1])*x)
         return func
     
-    def animate_move_to(entity: "Object", end_pos: tuple[float, float]) -> Callable[[float], None]:
+    def animate_move_to(entity: "Entity", end_pos: tuple[float, float]) -> Callable[[float], None]:
+        """
+        Creates a function to animate the movement of an entity to a specified end position, capturing the start position at the start of the animation.
+
+        Args:
+            entity (Entity): The entity to move.
+            end_pos (tuple[float, float]): The target position of the entity.
+
+        Returns:
+            Callable[[float], None]: A function that updates the entity's position based on a progression value (0 to 1).
+        """
+
         # Start position will be captured once when the animation starts
         start_pos = [None]
 
@@ -140,10 +197,52 @@ class Utils:
         return update_position
 
     @staticmethod
-    def animate_alpha(entity:"Entity", start : int, end:int)->Callable[[float],None]:
+    def animate_alpha(entity:"Drawable", start : int, end:int)->Callable[[float],None]:
+        """
+        Creates a function to animate the alpha (transparency) of a drawable entity between a start and end value.
+
+        Args:
+            entity (Drawable): The entity to animate.
+            start (int): The starting alpha value (0 to 255).
+            end (int): The ending alpha value (0 to 255).
+
+        Returns:
+            Callable[[float], None]: A function that updates the entity's alpha based on a progression value (0 to 1).
+        """
         def func(x):
             entity.set_alpha(int(pygame.math.clamp(start+(end-start)*x,0,255)))
         return func
     
 
 
+    @staticmethod
+    def random_color(min_value: int = 0, max_value: int = 255) -> tuple[int, int, int]:
+        """
+        Generates a random color as an RGB tuple.
+
+        Args:
+            min_value (int): Minimum value for each RGB component (inclusive). Defaults to 0.
+            max_value (int): Maximum value for each RGB component (inclusive). Defaults to 255.
+
+        Returns:
+            tuple[int, int, int]: A tuple representing a random color in RGB format, with each component 
+            between min_value and max_value.
+        """
+        return random.randint(min_value, max_value), random.randint(min_value, max_value), random.randint(min_value, max_value)
+
+    @staticmethod
+    def random_point_on_screen(margin: int = 0) -> tuple[int, int]:
+        """
+        Generates a random point on the screen, considering a margin from the edges.
+
+        Args:
+            margin (int): Margin from the screen edges, where the point won't be generated. 
+                        If margin is less than 0 or greater than the screen resolution, returns (0, 0).
+
+        Returns:
+            tuple[int, int]: A tuple representing a random point (x, y) on the screen within the screen 
+            resolution minus the margin.
+        """
+        if margin < 0 or margin > bf.const.RESOLUTION[0] or margin > bf.const.RESOLUTION[1]:
+            return 0, 0
+        return random.randint(margin, bf.const.RESOLUTION[0] - margin), random.randint(margin, bf.const.RESOLUTION[1] - margin)

{batframework-1.0.8a12.dist-info → batframework-1.0.8a14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batframework
-Version: 1.0.8a12
+Version: 1.0.8a14
 Summary: Pygame framework for making games easier.
 Author-email: Turan Baturay <baturayturan@gmail.com>
 Project-URL: Homepage, https://github.com/TuranBaturay/batFramework