multigp_toolkit.enums
=====================

.. py:module:: multigp_toolkit.enums

.. autoapi-nested-parse::

   Custom Enums



Classes
-------

.. autoapisummary::

   multigp_toolkit.enums.RequestAction
   multigp_toolkit.enums.MGPMode
   multigp_toolkit.enums.MGPFormat
   multigp_toolkit.enums.DefaultMGPFormats


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

.. py:class:: RequestAction

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Common request methods


   .. py:attribute:: GET
      :value: 'GET'


      Represents a GET action



   .. py:attribute:: POST
      :value: 'POST'


      Represents a POST action



   .. py:attribute:: PUT
      :value: 'PUT'


      Represents a PUT action



   .. py:attribute:: PATCH
      :value: 'PATCH'


      Represents a PATCH action



   .. py:attribute:: DELETE
      :value: 'DELETE'


      Represents a DELETE action



.. py:class:: MGPMode

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   MultiGP Schedule types


   .. py:attribute:: PREDEFINED_HEATS
      :value: '0'


      Standard type. Formerly known as CONTROLLED mode



   .. py:attribute:: ZIPPYQ
      :value: '1'


      MultiGP's custom queueing mode



   .. py:attribute:: BRACKET
      :value: '2'


      Setting for custom bracket results. Expects 1 round per heat



.. py:class:: MGPFormat

   Define the standard variables for an imported race format


   .. py:attribute:: format_name
      :type:  str

      Name of the format



   .. py:attribute:: win_condition
      :type:  RHRace.WinCondition

      Win condition of the format



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


      Flag marking the format to be used for Global Qualifiers



   .. py:attribute:: race_time_sec
      :type:  int
      :value: 120


      The default time in seconds for the format



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


      Allow unlimited time for the format



   .. py:attribute:: start_behavior
      :type:  RHRace.StartBehavior

      Start behavior for the format



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


      Team racing enabled for the format



.. py:class:: DefaultMGPFormats(*args, **kwds)

   Bases: :py:obj:`MGPFormat`, :py:obj:`enum.Enum`


   Default formats for MultiGP


   .. py:attribute:: AGGREGATE

      Most laps in race



   .. py:attribute:: FASTEST

      Fastest lap in race



   .. py:attribute:: CONSECUTIVE

      Fastest Consecutive laps in race



   .. py:attribute:: GLOBAL

      `CONSECUTIVE` with Global Qualifer features enabled.

      This format needs to be hardcoded until there is a way to lock format changes
      in the user interface.