mini_arcade_core.engine.scenes.models
=====================================

.. py:module:: mini_arcade_core.engine.scenes.models

.. autoapi-nested-parse::

   Models for scene management in the engine.



Classes
-------

.. autoapisummary::

   mini_arcade_core.engine.scenes.models.ScenePolicy
   mini_arcade_core.engine.scenes.models.SceneEntry
   mini_arcade_core.engine.scenes.models.StackItem


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

.. py:class:: ScenePolicy

   Controls how a scene behaves in the scene stack.

   blocks_update: if True, scenes below do not tick/update (pause modal)
   blocks_input:  if True, scenes below do not receive input
   is_opaque:     if True, scenes below are not rendered
   receives_input: if True, scene can receive input


   .. py:attribute:: blocks_update
      :type:  bool
      :value: False



   .. py:attribute:: blocks_input
      :type:  bool
      :value: False



   .. py:attribute:: is_opaque
      :type:  bool
      :value: False



   .. py:attribute:: receives_input
      :type:  bool
      :value: True



.. py:class:: SceneEntry

   An entry in the scene stack.

   :ivar scene_id (str): Identifier of the scene.
   :ivar scene (SimScene): The scene instance.
   :ivar is_overlay (bool): Whether the scene is an overlay.
   :ivar policy (ScenePolicy): The scene's policy.


   .. py:attribute:: scene_id
      :type:  str


   .. py:attribute:: scene
      :type:  mini_arcade_core.scenes.sim_scene.SimScene


   .. py:attribute:: is_overlay
      :type:  bool


   .. py:attribute:: policy
      :type:  ScenePolicy


.. py:class:: StackItem

   An item in the scene stack.

   :ivar entry (SceneEntry): The scene entry.


   .. py:attribute:: entry
      :type:  SceneEntry