added german documentation to seeding and double elimination api/ gamestate

This commit is contained in:
Joel Klimont 2022-11-09 03:25:27 +01:00
parent de9b671f29
commit 369692b619
8 changed files with 107 additions and 24 deletions

View file

@ -21,6 +21,11 @@ Logistic Plan: {self.logistic_plan}
Logistic Centers: {self.logistic_center}"""
def __init__(self, seed: int):
"""
Erstellt den Seeding "Gamestate" für den angegebenen Seed.
:param seed: Seed welcher zum Erstellen des Gamestates benutzt werden soll.
"""
self.seed = seed
set_random_seed(seed)
@ -80,10 +85,25 @@ Logistic Centers: {self.logistic_center}"""
self.logistic_plan = [x + 10 for x in self.logistic_plan]
def get_heuballen(self) -> int:
"""
Die Funktion gibt entweder die Zahl "1" oder "2" zurück. Wenn die Funktion "1" zurückgibt, dann liegen die Heuballen auf den gelben Linien. Wenn die Funktion "2" zurückgibt, dann liegen sie auf den blauen Flächen.
:return: Gibt entweder die Zahl 1 oder 2 zurück.
"""
return self.heu_color
def get_logistic_plan(self) -> []:
"""
Die Funktion gibt den "Logistik Plan" zurück. Also die Reihenfolge, in welcher der Roboter die Logistik Zonen Abfahren muss, um die Pakete welche dort liegen zu sortieren.
:return: Eine Liste an Zahlen zwischen 10 und 13.
"""
return self.logistic_plan
def get_material_deliveries(self) -> [[]]:
"""
Die Funktion gibt die einzelnen "Material Lieferungen" zurück. Da der Roboter immer zwei Paare an Materialien anliefern muss, gibt die Funktion eine Liste an Material Paaren zurück. Die Materialien werden dabei durch ihre Zonen-ID representiert. Also Holz ist z.B. "0" und die Ziegelsteine sind "3".
:return: Eine Liste and Material Paaren.
"""
return self.material_pairs