levelz.level
============

.. py:module:: levelz.level


Classes
-------

.. autoapisummary::

   levelz.level.Scroll
   levelz.level.Level
   levelz.level.Level2D
   levelz.level.Level3D


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

.. py:class:: Scroll

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


   Represents the scroll direction of a 2D Level.


   .. py:attribute:: NONE
      :value: 'none'


      No Scrolling



   .. py:attribute:: HORIZONTAL_LEFT
      :value: 'horizontal-left'


      Horizontal Scrolling moving left



   .. py:attribute:: HORIZONTAL_RIGHT
      :value: 'horizontal-right'


      Horizontal Scrolling moving right



   .. py:attribute:: VERTICAL_UP
      :value: 'vertical-up'


      Vertical Scrolling moving up



   .. py:attribute:: VERTICAL_DOWN
      :value: 'vertical-down'


      Vertical Scrolling moving down



.. py:class:: Level(dimension: levelz.coord.Dimension)

   Represents a LevelZ level.


   .. py:attribute:: _dimension
      :type:  levelz.coord.Dimension


   .. py:attribute:: _blocks
      :type:  list[levelz.block.LevelObject]
      :value: []



   .. py:attribute:: _headers
      :type:  dict[str, object]


   .. py:property:: dimension
      Returns the Dimension of the Level.



   .. py:property:: blocks
      Returns an immutable copy of the blocks in the Level.



   .. py:property:: headers
      Returns an immutable copy of the headers in the Level.



.. py:class:: Level2D(headers: dict[str, object] = {}, blocks: list[levelz.block.LevelObject] = [])

   Bases: :py:obj:`Level`


   Represents a 2D Level.


   .. py:attribute:: _headers


   .. py:attribute:: _blocks


   .. py:property:: scroll
      Returns the Scroll of the Level.



   .. py:property:: spawn
      Returns the spawn point of the Level.



.. py:class:: Level3D(headers: dict[str, object] = {}, blocks: list[levelz.block.LevelObject] = [])

   Bases: :py:obj:`Level`


   Represents a 3D Level.


   .. py:attribute:: _headers


   .. py:attribute:: _blocks


   .. py:property:: spawn
      Returns the spawn point of the Level.