mini_arcade_core.scenes.systems.builtins.pause
==============================================

.. py:module:: mini_arcade_core.scenes.systems.builtins.pause

.. autoapi-nested-parse::

   Reusable pause trigger system driven by intent.



Attributes
----------

.. autoapisummary::

   mini_arcade_core.scenes.systems.builtins.pause.TContext


Classes
-------

.. autoapisummary::

   mini_arcade_core.scenes.systems.builtins.pause.IntentPauseSystem


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

.. py:data:: TContext

.. py:class:: IntentPauseSystem

   Bases: :py:obj:`mini_arcade_core.scenes.systems.base_system.BaseSystem`\ [\ :py:obj:`TContext`\ ], :py:obj:`Generic`\ [\ :py:obj:`TContext`\ ]


   Generic pause trigger:
   - checks `ctx.intent.<intent_attr>`
   - optionally runs a local pause callback
   - pushes the pause command into `ctx.commands`


   .. py:attribute:: pause_command_factory
      :type:  Callable[[TContext], object]


   .. py:attribute:: name
      :type:  str
      :value: 'pause_intent'



   .. py:attribute:: phase
      :type:  int


   .. py:attribute:: order
      :type:  int
      :value: 12



   .. py:attribute:: intent_attr
      :type:  str
      :value: 'pause'



   .. py:attribute:: is_already_paused
      :type:  Callable[[TContext], bool] | None
      :value: None



   .. py:attribute:: on_pause
      :type:  Callable[[TContext], None] | None
      :value: None



   .. py:method:: step(ctx: TContext) -> None

      Perform a single step of the system within the given context.

      :param ctx: The system context.
      :type ctx: TSystemContext