tinyecs-compsys-base 0.0.1__py3-none-any.whl

tinyecs/compsys/base/__init__.py

@@ -0,0 +1,132 @@
+from collections.abc import Callable
+from dataclasses import dataclass, InitVar
+
+import tinyecs as ecs
+
+from aenum import extend_enum
+from pgcooldown import CronD, Cooldown
+from tinyecs import EntityID
+from tinyecs.compsys import Comp
+
+
+extend_enum(Comp, 'CROND')
+extend_enum(Comp, 'FOLLOWUP')
+extend_enum(Comp, 'IS_KILLED')
+extend_enum(Comp, 'KILL_WITH_PARENT')
+extend_enum(Comp, 'TIMER')
+
+
+@dataclass
+class Timer:
+    """An optionally repeating timer component.
+
+    :param cooldown: The actual timer object
+    :param callback: The function to run when the timer fires
+    :param repeat: Decides if the timer is reoccurring
+
+    The prototype of the callback function is::
+
+        def callback()
+
+    .. note:: If ``repeat`` is false, when using :func:`sys_timer`, the
+        component will be removed after it fired.
+    """
+
+    cooldown: InitVar[float | Cooldown]
+    callback: Callable[None, []]
+    repeat: bool = False
+
+    def __post_init__(self, cooldown: Cooldown | float) -> None:
+        self.cooldown = cooldown if isinstance(cooldown, Cooldown) else Cooldown(cooldown)
+
+
+def sys_crond(eid: EntityID, crond: CronD) -> None:
+    """Update a pgcooldown.CronD queue.
+
+    :param eid: The entity ID
+    :param crond: The schedule queue for the entity.  See :class:`pgcooldown.CronD`
+
+    pgcooldown's ``CronD`` class needs to have its ``update`` method called
+    frequently.  Running this system will ensure exactly that.
+
+    """
+
+    crond.update()
+
+
+def sys_followup(eid: EntityID, is_killed: bool, followup: Callable[[], None]) -> None:
+    """Run a followup function after an entity is marked as dead.
+
+    :param eid: The entity ID
+    :param is_killed: The boolean flag component to mark this as killed
+    :param followup: A callback to run
+
+    The prototype for the callback is::
+
+        def callback() -> None
+
+    Once the followup has fired, its component is removed.
+    """
+
+    ecs.remove_component(eid, Comp.FOLLOWUP)
+    followup(eid)
+
+
+def sys_kill_with_parent(eid: EntityID, parent: EntityID):
+    """Mark this entity as "killed" if its parent is killed as well.
+
+    :param eid: The entity ID
+    :param parent: The parent entity to watch
+
+    Relies on :func:`sys_reap` or your own system to actually remove the entity.
+    """
+
+    if ecs.eid_has(parent, Comp.IS_KILLED):
+        ecs.add_component(eid, Comp.IS_KILLED, True)
+
+
+def sys_lifetime(eid: EntityID, lifetime: Cooldown) -> None:
+    """Update position based on a LerpPosition object.
+
+    :param eid: The entity ID
+    :param lifetime: A `pgcooldown.Cooldown` instance
+
+    Relies on :func:`sys_reap` or your own system to actually remove the entity.
+    """
+
+    if lifetime.cold():
+        ecs.add_component(eid, Comp.IS_KILLED, True)
+
+
+def sys_reap(eid: EntityID, is_killed: bool) -> None:
+    """Remove entities that have a Comp.IS_KILLED component.
+
+    :param eid: The entity ID
+    :param is_killed: Exactly that
+
+    """
+
+    ecs.remove_entity(eid)
+
+
+def sys_timer(eid: EntityID, timer: Cooldown) -> None:
+    """Run a callback function after a timer runs out.
+
+    :param eid: The entity ID
+    :param timer: A :class:`Timer` object
+
+    .. note:: If timer.repeat is not set, the component is removed after the
+        timer has run out.  Otherwise the timer is reset.
+
+    The prototype for the callback is::
+
+        def callback() -> None
+    """
+
+    if timer.cooldown.cold():
+        if timer.repeat:
+            timer.cooldown.reset()
+        else:
+            ecs.remove_component(eid, Comp.TIMER)
+
+        timer.callback()

tinyecs_compsys_base-0.0.1.dist-info/METADATA

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: tinyecs-compsys-base
+Version: 0.0.1
+Summary: Foundational component and system library for tinyecs
+Author-email: Michael Lamertz <michael.lamertz@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/dickerdackel/tinyecs-compsys-base
+Project-URL: bugtracker, https://github.com/dickerdackel/tinyecs-compsys-base/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries :: pygame
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: aenum
+Requires-Dist: pgcooldown
+Requires-Dist: tinyecs>=0.5.0
+Dynamic: license-file
+
+tinyecs-compsys-base
+====================
+
+Thise are some very basic and framework independent components.
+
+Synopsis
+--------
+
+.. code:: python
+
+   from tinyecs.compsys.base import ...
+
+Usage
+-----
+
+This package has no direct functionality, but all sub modules will register
+their component IDs in the ``tinyecs.compsys.Comp`` enum.
+
+Installation
+------------
+
+Installation instructions + requirements (should come automagically with
+pyproject.toml)
+
+.. code:: console
+
+   pip install tinyecs[base]
+   # or
+   pip install tinyecs
+   pip install tinyecs-compsys
+   pip install tinyecs-compsys-base
+
+Support / Contributing
+----------------------
+
+Issues can be opened on `github issues`_
+
+.. _github issues: https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
+
+
+License
+-------
+
+This software is provided under the MIT license.
+
+See LICENSE file for details.

tinyecs_compsys_base-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+tinyecs/compsys/base/__init__.py,sha256=MOJ5JEPO_ydlHpjlChDqUMD3SbFJJxrSNsPP0egTAtE,3537
+tinyecs_compsys_base-0.0.1.dist-info/licenses/LICENSE,sha256=Ov4pwsg4S7PmyeyUVABYYBtwaBxK1LdI8Y9--FajuMk,1072
+tinyecs_compsys_base-0.0.1.dist-info/METADATA,sha256=EWOxUEzQQQXJixCZwPJX8nlzBkm8BJ4Vb2PLEtxr0eQ,1605
+tinyecs_compsys_base-0.0.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+tinyecs_compsys_base-0.0.1.dist-info/top_level.txt,sha256=lMaXjtnpZvawjp5Re5jZOY_Yki_mB1QkM_PTRUig0O4,8
+tinyecs_compsys_base-0.0.1.dist-info/RECORD,,

tinyecs_compsys_base-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

tinyecs_compsys_base-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Michael Lamertz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tinyecs_compsys_base-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+tinyecs