batframework 1.0.8a13__tar.gz → 1.0.8a14__tar.gz

{batframework-1.0.8a13/src/batframework.egg-info → batframework-1.0.8a14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batframework
-Version: 1.0.8a13
+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

{batframework-1.0.8a13 → batframework-1.0.8a14}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "batframework"
-version = "1.0.8a13"
+version = "1.0.8a14"
 description = "Pygame framework for making games easier."
 readme = "README.md"
 classifiers = [ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent",]

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/__init__.py

@@ -8,7 +8,7 @@ from .resourceManager import ResourceManager
 from .fontManager import FontManager
 from .utils import Utils as utils
 from .tileset import Tileset
-from .time import *
+from .timeManager import TimeManager,Timer,SceneTimer
 from .easingController import EasingController
 from .cutscene import Cutscene, CutsceneManager
 from .cutsceneBlocks import *
@@ -17,8 +17,8 @@ import batFramework.transition as transition
 from .action import Action
 from .actionContainer import *
 from .camera import Camera
-from .object import Object
 from .entity import Entity
+from .drawable import Drawable
 from .renderGroup import RenderGroup
 from .dynamicEntity import DynamicEntity
 from .sprite import Sprite

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/animatedSprite.py

@@ -3,7 +3,7 @@ import pygame
 from typing import List, Dict, Tuple, Union, Optional, Self
 from .animation import Animation
 
-class AnimatedSprite(bf.Entity):
+class AnimatedSprite(bf.Drawable):
     def __init__(self, size: Optional[Tuple[int, int]] = None,*args,**kwargs) -> None:
         super().__init__(size, no_surface=True,*args,**kwargs)
         self.float_counter: float = 0

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/character.py

@@ -3,7 +3,7 @@ from .stateMachine import State
 from .animatedSprite import AnimatedSprite
 from .dynamicEntity import DynamicEntity
 
-class Character(AnimatedSprite,DynamicEntity):
+class Character(DynamicEntity,AnimatedSprite):
     def __init__(self,*args,**kwargs) -> None:
         super().__init__(*args,**kwargs)
         self.state_machine = bf.StateMachine(self)

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/constants.py

@@ -4,6 +4,8 @@ import pygame
 class Constants:
     SCREEN: pygame.Surface = None
     RESOLUTION: tuple[int, int] = (1280, 720)
+    WIDTH = 1280
+    HEIGHT = 720
     VSYNC = 0
     FLAGS: int = pygame.SCALED | pygame.RESIZABLE
     FPS: int = 60
@@ -18,6 +20,8 @@ class Constants:
     @staticmethod
     def set_resolution(resolution: tuple[int, int]):
         Constants.RESOLUTION = resolution
+        Constants.WIDTH = resolution[0]
+        Constants.HEIGHT = resolution[1]
 
     @staticmethod
     def set_default_cursor(cursor: pygame.Cursor):

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/cutscene.py

@@ -1,5 +1,5 @@
 import batFramework as bf
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING,Self
 
 class CutsceneBlock: ...
 
@@ -75,13 +75,15 @@ class Cutscene:
     def init_blocks(self):
         pass
 
-    def add_blocks(self, *blocks: CutsceneBlock):
+    def add_blocks(self, *blocks: CutsceneBlock)->Self:
         self.cutscene_blocks.extend(blocks)
-
-    def add_end_blocks(self, *blocks: CutsceneBlock):
+        return self
+        
+    def add_end_blocks(self, *blocks: CutsceneBlock)->Self:
         _ = [block.set_parent_cutscene(self) for block in blocks]
         self.end_blocks.extend(blocks)
-
+        return self
+        
     def get_scene_at(self, index):
         return bf.CutsceneManager().manager.scenes[index]
 

batframework-1.0.8a13/src/batFramework/entity.py → batframework-1.0.8a14/src/batFramework/drawable.py

@@ -1,10 +1,10 @@
 from typing import Any, Self
 import pygame
 import batFramework as bf
-from .object import Object
+from .entity import Entity
 
 
-class Entity(Object):
+class Drawable(Entity):
     """
     Basic entity class
     """
@@ -19,6 +19,7 @@ class Entity(Object):
     ) -> None:
         super().__init__()
         self.visible: bool = True
+        self.render_order: int = 0
         self.rect.size = (10, 10) if size is None else size
         self.convert_alpha: bool = convert_alpha
         self.surface_flags: int = surface_flags

batframework-1.0.8a13/src/batFramework/object.py → batframework-1.0.8a14/src/batFramework/entity.py

@@ -7,7 +7,7 @@ if TYPE_CHECKING:
     from .camera import Camera
 
 
-class Object:
+class Entity:
     __count = 0
     __available_uid = set()
     __used_uid = set()
@@ -17,18 +17,17 @@ class Object:
         self.tags: list[str] = []
         self.parent_scene: bf.Scene | None = None
         self.debug_color: tuple | str = "red"
-        self.render_order: int = 0
-        self.uid: int = Object.__count
-        Object.__used_uid.add(self.uid)
+        self.uid: int = Entity.__count
+        Entity.__used_uid.add(self.uid)
 
-        if Object.__available_uid:
-            self.name = Object.__available_uid.pop()
+        if Entity.__available_uid:
+            self.name = Entity.__available_uid.pop()
         else:
-            self.name = Object.__count
-            Object.__count += 1
+            self.name = Entity.__count
+            Entity.__count += 1
 
     def __del__(self):
-        Object.__available_uid.add(self.uid)
+        Entity.__available_uid.add(self.uid)
 
     def set_position(self, x, y) -> Self:
         self.rect.topleft = x, y
@@ -62,11 +61,13 @@ class Object:
         pass
 
     def set_uid(self, uid: int) -> Self:
-        if uid in Object.__used_uid:
+        if uid in Entity.__used_uid:
             print(f"set_uid error : UID '{uid}' is already in use")
             return self
         self.uid = uid
-        Object.__used_uid.add(uid)
+        if uid in Entity.__used_uid:
+            Entity.__used_uid.remove(uid)
+        Entity.__used_uid.add(uid)
         return self
 
     def add_tags(self, *tags) -> Self:
@@ -87,7 +88,7 @@ class Object:
 
     def process_event(self, event: pygame.Event) -> bool:
         """
-        Returns bool : True if the method is blocking (no propagation to next object of the scene)
+        Returns bool : True if the method is blocking (no propagation to next Entity of the scene)
         """
         if event.consumed:
             return
@@ -112,7 +113,7 @@ class Object:
 
     def update(self, dt: float) -> None:
         """
-        Update method to be overriden by subclasses of object (must call do_update and do_reset_actions)
+        Update method to be overriden by subclasses of Entity (must call do_update and do_reset_actions)
         """
         self.do_update(dt)
         self.do_reset_actions()

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/gui/container.py

@@ -174,7 +174,7 @@ class Container(Shape, InteractiveWidget):
             self.paint()
             self.dirty_surface = False
 
-        bf.Entity.draw(self, camera)
+        bf.Drawable.draw(self, camera)
 
         if self.clip_children:
             new_clip = camera.world_to_screen(self.get_padded_rect())

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/gui/debugger.py

@@ -72,7 +72,7 @@ class Debugger(Label):
     def update(self, dt: float) -> None:
         if not self.parent_scene:
             return
-        if self.parent_scene.get_sharedVar("debug_mode") != bf.debugMode.DEBUGGER:
+        if bf.ResourceManager().get_sharedVar("debug_mode") != bf.debugMode.DEBUGGER:
             self.set_visible(False)
             return
         self.set_visible(True)

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/gui/label.py

@@ -37,7 +37,6 @@ class Label(Shape):
         self.text_rect = pygame.FRect(0, 0, 0, 0)
         # text surface (result of font.render)
         self.text_surface: pygame.Surface = pygame.Surface((0, 0))
-        self.do_caching: bool = False
 
         self.show_text_outline: bool = False
 
@@ -54,21 +53,9 @@ class Label(Shape):
         self.set_autoresize(True)
         self.set_font(force=True)
 
-    @staticmethod
-    def clear_cache():
-        Label._text_cache = {}
-
     def __str__(self) -> str:
         return f"Label({repr(self.text)})"
 
-    def enable_caching(self) -> Self:
-        self.do_caching = True
-        return self
-
-    def disable_caching(self) -> Self:
-        self.do_caching = False
-        return self
-
     def set_text_color(self, color) -> Self:
         self.text_color = color
         self.dirty_surface = True
@@ -205,35 +192,26 @@ class Label(Shape):
         return self.text
 
     def _render_font(self, params: dict) -> pygame.Surface:
-        key = tuple(params.values())
-
-        cached_value = Label._text_cache.get(key, None)
 
         if self.draw_mode == bf.drawMode.SOLID:
-            if cached_value is None:
-                params.pop("font_name")
-
-                # save old settings
-                old_italic = self.font_object.get_italic()
-                old_bold = self.font_object.get_bold()
-                old_underline = self.font_object.get_underline()
-
-                # setup font
-                self.font_object.set_italic(self.is_italic)
-                self.font_object.set_bold(self.is_bold)
-                self.font_object.set_underline(self.is_underlined)
-
-                surf = self.font_object.render(**params)
-
-                # reset font
-                self.font_object.set_italic(old_italic)
-                self.font_object.set_bold(old_bold)
-                self.font_object.set_underline(old_underline)
-
-                if self.do_caching:
-                    Label._text_cache[key] = surf
-            else:
-                surf = cached_value
+            params.pop("font_name")
+
+            # save old settings
+            old_italic = self.font_object.get_italic()
+            old_bold = self.font_object.get_bold()
+            old_underline = self.font_object.get_underline()
+
+            # setup font
+            self.font_object.set_italic(self.is_italic)
+            self.font_object.set_bold(self.is_bold)
+            self.font_object.set_underline(self.is_underlined)
+
+            surf = self.font_object.render(**params)
+
+            # reset font
+            self.font_object.set_italic(old_italic)
+            self.font_object.set_bold(old_bold)
+            self.font_object.set_underline(old_underline)
         else:
             params.pop("font_name")
             surf = self.font_object.render(**params)

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/gui/root.py

@@ -95,8 +95,6 @@ class Root(InteractiveWidget):
         return self
 
     def do_handle_event(self, event):
-        if not self.parent_scene.get_sharedVar("player_has_control"):
-            return
         if self.focused:
             if event.type == pygame.KEYDOWN:
                 if self.focused.on_key_down(event.key):
@@ -130,8 +128,6 @@ class Root(InteractiveWidget):
 
     def update(self, dt: float) -> None:
         super().update(dt)
-        if not self.parent_scene.get_sharedVar("player_has_control",True):
-            return
         old = self.hovered
         transposed = self.drawing_camera.screen_to_world(pygame.mouse.get_pos())
         self.hovered = self.top_at(*transposed) if self.top_at(*transposed) else None
@@ -145,8 +141,6 @@ class Root(InteractiveWidget):
 
     def draw(self, camera: bf.Camera) -> None:
         super().draw(camera)
-        if not self.parent_scene.get_sharedVar("player_has_control"):
-            return
         if (
             self.parent_scene
             and self.parent_scene.active

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batFramework/gui/widget.py

@@ -18,7 +18,7 @@ class WidgetMeta(type):
         return obj
 
 
-class Widget(bf.Entity, metaclass=WidgetMeta):
+class Widget(bf.Drawable, metaclass=WidgetMeta):
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.children: list["Widget"] = []

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/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
-            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 = 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
-            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 = 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-1.0.8a13 → batframework-1.0.8a14}/src/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-1.0.8a13 → batframework-1.0.8a14}/src/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-1.0.8a13 → batframework-1.0.8a14}/src/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-1.0.8a13 → batframework-1.0.8a14}/src/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-1.0.8a13/src/batFramework/time.py → batframework-1.0.8a14/src/batFramework/timeManager.py

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

batframework-1.0.8a14/src/batFramework/utils.py

@@ -0,0 +1,248 @@
+import pygame
+import batFramework as bf
+import random
+from .enums import *
+import re
+from typing import Callable, TYPE_CHECKING
+from functools import cache
+if TYPE_CHECKING:
+    from .drawable import Drawable
+    from .entity import Entity
+
+
+
+class Singleton(type):
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
+        return cls._instances[cls]
+
+
+class Utils:
+
+    @staticmethod
+    def split_surface(
+        surface: pygame.Surface, split_size: tuple[int, int], func=None
+    ) -> dict[tuple[int, int], pygame.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 = {}
+        for iy, y in enumerate(range(0, height, split_size[1])):
+            for ix, x in enumerate(range(0, width, split_size[0])):
+                sub = surface.subsurface((x, y, split_size[0], split_size[1]))
+
+                if func is not None:
+                    sub = func(sub)
+
+                res[(ix, iy)] = sub
+
+        return res
+
+    @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:
+            pattern = re.compile(r"[^0-9]")
+        elif text_mode == textMode.ALPHANUMERICAL:
+            pattern = re.compile(r"[^a-zA-Z0-9]")
+        else:
+            raise ValueError("Unsupported text mode")
+
+        def filter_function(s: str) -> str:
+            return pattern.sub("", s)
+
+        return filter_function
+
+
+    @staticmethod
+    @cache
+    def create_spotlight(inside_color, outside_color, radius, radius_stop=None, dest_surf=None,size=None):
+        """
+        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
+
+        if dest_surf is None:
+            if size is None:
+                size = (diameter,diameter)
+            dest_surf = pygame.Surface(size, pygame.SRCALPHA)
+        
+        dest_surf.fill((0,0,0,0))
+
+
+        center = dest_surf.get_rect().center
+
+        if radius_stop != radius:
+            for r in range(radius_stop, radius - 1, -1):
+                color = [
+                    inside_color[i] + (outside_color[i] - inside_color[i]) * (r - radius) / (radius_stop - radius)
+                    for i in range(3)
+                ] + [255]  # Preserve the alpha channel as fully opaque
+                pygame.draw.circle(dest_surf, color, center, r)
+        else:
+            pygame.draw.circle(dest_surf, inside_color, center, radius)
+
+        return dest_surf
+
+    @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
+        if radius_stop != radius:
+            for r in range(radius_stop, radius - 1, -1):
+                color = [
+                    inside_color[i] + (outside_color[i] - inside_color[i]) * (r - radius) / (radius_stop - radius)
+                    for i in range(3)
+                ] + [255]
+                pygame.draw.circle(dest_surf, color, center, r)
+        else:
+            pygame.draw.circle(dest_surf, inside_color, center, radius)
+
+    @staticmethod
+    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: "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]
+
+        def update_position(progression: float):
+            if start_pos[0] is None:
+                start_pos[0] = entity.rect.center  # Capture the start position at the start of the animation
+
+            # Calculate new position based on progression
+            new_x = start_pos[0][0] + (end_pos[0] - start_pos[0][0]) * progression
+            new_y = start_pos[0][1] + (end_pos[1] - start_pos[0][1]) * progression
+
+            # Set the entity's new position
+            entity.set_center(new_x, new_y)
+
+        return update_position
+
+    @staticmethod
+    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.8a13 → batframework-1.0.8a14/src/batframework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batframework
-Version: 1.0.8a13
+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

{batframework-1.0.8a13 → batframework-1.0.8a14}/src/batframework.egg-info/SOURCES.txt

@@ -12,13 +12,13 @@ src/batFramework/character.py
 src/batFramework/constants.py
 src/batFramework/cutscene.py
 src/batFramework/cutsceneBlocks.py
+src/batFramework/drawable.py
 src/batFramework/dynamicEntity.py
 src/batFramework/easingController.py
 src/batFramework/entity.py
 src/batFramework/enums.py
 src/batFramework/fontManager.py
 src/batFramework/manager.py
-src/batFramework/object.py
 src/batFramework/particle.py
 src/batFramework/renderGroup.py
 src/batFramework/resourceManager.py
@@ -28,7 +28,7 @@ src/batFramework/scrollingSprite.py
 src/batFramework/sprite.py
 src/batFramework/stateMachine.py
 src/batFramework/tileset.py
-src/batFramework/time.py
+src/batFramework/timeManager.py
 src/batFramework/transition.py
 src/batFramework/triggerZone.py
 src/batFramework/utils.py

batframework-1.0.8a13/src/batFramework/utils.py

@@ -1,149 +0,0 @@
-import pygame
-from enum import Enum
-import os
-import batFramework as bf
-import json
-from .enums import *
-import re
-from typing import Callable, TYPE_CHECKING, Any
-from functools import cache
-if TYPE_CHECKING:
-    from .object import Object
-    from .entity import Entity
-
-
-class Singleton(type):
-    _instances = {}
-
-    def __call__(cls, *args, **kwargs):
-        if cls not in cls._instances:
-            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
-        return cls._instances[cls]
-
-
-class Utils:
-
-    @staticmethod
-    def split_surface(
-        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'
-        """
-        width, height = surface.get_size()
-        res = {}
-        for iy, y in enumerate(range(0, height, split_size[1])):
-            for ix, x in enumerate(range(0, width, split_size[0])):
-                sub = surface.subsurface((x, y, split_size[0], split_size[1]))
-
-                if func is not None:
-                    sub = func(sub)
-
-                res[(ix, iy)] = sub
-
-        return res
-
-    @staticmethod
-    def filter_text(text_mode: textMode):
-        if text_mode == textMode.ALPHABETICAL:
-            pattern = re.compile(r"[^a-zA-Z]")
-        elif text_mode == textMode.NUMERICAL:
-            pattern = re.compile(r"[^0-9]")
-        elif text_mode == textMode.ALPHANUMERICAL:
-            pattern = re.compile(r"[^a-zA-Z0-9]")
-        else:
-            raise ValueError("Unsupported text mode")
-
-        def filter_function(s: str) -> str:
-            return pattern.sub("", s)
-
-        return filter_function
-
-
-    @staticmethod
-    @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
-
-        """
-        if radius_stop is None:
-            radius_stop = radius
-        diameter = radius_stop * 2
-
-        if dest_surf is None:
-            if size is None:
-                size = (diameter,diameter)
-            dest_surf = pygame.Surface(size, pygame.SRCALPHA)
-        
-        dest_surf.fill((0,0,0,0))
-
-
-        center = dest_surf.get_rect().center
-
-        if radius_stop != radius:
-            for r in range(radius_stop, radius - 1, -1):
-                color = [
-                    inside_color[i] + (outside_color[i] - inside_color[i]) * (r - radius) / (radius_stop - radius)
-                    for i in range(3)
-                ] + [255]  # Preserve the alpha channel as fully opaque
-                pygame.draw.circle(dest_surf, color, center, r)
-        else:
-            pygame.draw.circle(dest_surf, inside_color, center, radius)
-
-        return dest_surf
-
-    @staticmethod
-    def draw_spotlight(dest_surf:pygame.Surface,inside_color,outside_color,radius,radius_stop=None,center=None):
-        if radius_stop is None:
-            radius_stop = radius
-        center = dest_surf.get_rect().center if center is None else center
-        if radius_stop != radius:
-            for r in range(radius_stop, radius - 1, -1):
-                color = [
-                    inside_color[i] + (outside_color[i] - inside_color[i]) * (r - radius) / (radius_stop - radius)
-                    for i in range(3)
-                ] + [255]
-                pygame.draw.circle(dest_surf, color, center, r)
-        else:
-            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 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]:
-        # Start position will be captured once when the animation starts
-        start_pos = [None]
-
-        def update_position(progression: float):
-            if start_pos[0] is None:
-                start_pos[0] = entity.rect.center  # Capture the start position at the start of the animation
-
-            # Calculate new position based on progression
-            new_x = start_pos[0][0] + (end_pos[0] - start_pos[0][0]) * progression
-            new_y = start_pos[0][1] + (end_pos[1] - start_pos[0][1]) * progression
-
-            # Set the entity's new position
-            entity.set_center(new_x, new_y)
-
-        return update_position
-
-    @staticmethod
-    def animate_alpha(entity:"Entity", start : int, end:int)->Callable[[float],None]:
-        def func(x):
-            entity.set_alpha(int(pygame.math.clamp(start+(end-start)*x,0,255)))
-        return func
-    
-
-