Update documentation

This commit is contained in:
Joel Klimont 2022-11-09 03:13:02 +01:00
parent 0ef5670247
commit 41ffbe6d07
5 changed files with 59 additions and 7 deletions

View file

@ -10,3 +10,29 @@ Dokumentation des Seeding Moduls
:members:
.. automethod:: __init__
Beispiele
----------
| In ``Zeile 1`` wird das Seeding Modul importiert.
| In ``Zeile 2`` definieren wir dann eine Variable, in der wir den "Seed" des Gamestates den wir erstellen wollten speichern.
| In ``Zeile 3`` erstellen wir dann einen neuen Gamestate mit dem Seed und speichern ihn in die Variable ``gamestate``.
| In ``Zeile 4`` geben wir dann den Gamestate aus, damit wir ihn auf der Konsole ansehen können.
.. code-block:: python
import compLib.Seeding as Seeding
seed = 42
gamestate = Seeding.Gamestate(seed)
print(gamestate)
In der Ausgabe des Print Statements sehen wir den generierten Gamestate.
.. code-block::
Seed: 42
Heu Color: 1
Material Pairs: [[3, 0], [2, 3], [0, 2], [1, 2]]
Material Zones: [2, 1, 3, 2]
Logistic Plan: [12, 13, 12, 13, 10, 11, 13, 10, 13, 12, 11, 10, 11, 13, 10, 11, 12, 11, 12, 10, 12]
Logistic Centers: [[0, 3, 1, 1], [1, 0, 2, 2], [1, 2, 0, 2], [3, 0, 2, 0]]