mini_arcade_core.scenes.autoreg
===============================

.. py:module:: mini_arcade_core.scenes.autoreg

.. autoapi-nested-parse::

   Autoregistration utilities for mini arcade core.
   Allows automatic registration of Scene classes via decorators.



Functions
---------

.. autoapisummary::

   mini_arcade_core.scenes.autoreg.register_scene
   mini_arcade_core.scenes.autoreg.snapshot
   mini_arcade_core.scenes.autoreg.clear


Module Contents
---------------

.. py:function:: register_scene(scene_id: str)

   Decorator to mark and register a Scene class under an id.

   :param scene_id: The unique identifier for the Scene class.
   :type scene_id: str

   :raises ValueError: If the scene_id is already registered.


.. py:function:: snapshot() -> Dict[str, Type[mini_arcade_core.scenes.scene.Scene]]

   Copy of current catalog (useful for tests).

   :return: A copy of the current scene catalog.
   :rtype: Dict[str, Type["Scene"]]


.. py:function:: clear()

   Clear the current catalog (useful for tests).