IL2HorusTeam/il2fb-mission-parser

View on GitHub
docs/sections/respawn-time.rst

Summary

Maintainability
Test Coverage
.. _respawn-time-section:

RespawnTime section
===================

.. note::

    `Russian version <https://github.com/IL2HorusTeam/il2fb-mission-parser/wiki/%D0%A1%D0%B5%D0%BA%D1%86%D0%B8%D1%8F-RespawnTime>`_

:class:`~il2fb.parsers.mission.sections.respawn_time.RespawnTimeSectionParser`
is responsible for parsing ``RespawnTime`` section. This section defines
respawn time for different types of stationary objects.

Section example::

    [RespawnTime]
      Bigship 1000000
      Ship 1000000
      Aeroanchored 1000000
      Artillery 1000000
      Searchlight 1000000

Output example:

.. code-block:: python

    {
        'respawn_time': {
            'ships': {
                'big': 1000000,
                'small': 1000000,
            },
            'balloons': 1000000,
            'artillery': 1000000,
            'searchlights': 1000000,
        },
    }


Output contains a :class:`dict` with ``respawn_time`` element.


**Description**:

Respawn time is measured by seconds.

``Bigship``
  Respawn time for big ships [1]_.

  :Output path: ``respawn_time.ships.big``
  :Output type: :class:`int`
  :Output value: original value converted to integer number

``Ship``
  Respawn time for small ships [1]_.

  :Output path: ``respawn_time.ships.small``
  :Output type: :class:`int`
  :Output value: original value converted to integer number

``Aeroanchored``
  Respawn time for balloons.

  :Output path: ``respawn_time.balloons``
  :Output type: :class:`int`
  :Output value: original value converted to integer number

``Artillery``
  Respawn time for artillery.

  :Output path: ``respawn_time.artillery``
  :Output type: :class:`int`
  :Output value: original value converted to integer number

``Searchlight``
  Respawn time for searchlights.

  :Output path: ``respawn_time.searchlights``
  :Output type: :class:`int`
  :Output value: original value converted to integer number


----------

Footnotes:

.. [#] See what big and small ships are: :ref:`ships categories <ships-categories>`.