Update documentation
This commit is contained in:
Joel Klimont
parent
0ef5670247
commit
41ffbe6d07
5 changed files with 59 additions and 7 deletions
|
|
@ -53,6 +53,7 @@
|
|||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Seeding</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#dokumentation-des-seeding-moduls">Dokumentation des Seeding Moduls</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#compLib.Seeding.Gamestate"><code class="docutils literal notranslate"><span class="pre">Gamestate</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#beispiele">Beispiele</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -98,7 +99,7 @@
|
|||
<dd><p>Erstellt den Seeding ‚‘Gamestate‘‘ für den angegebenen Seed.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameter</dt>
|
||||
<dd class="field-odd"><p><strong>seed</strong> – Seed welcher zum erstellen des Gamestates benutzt werden soll.</p>
|
||||
<dd class="field-odd"><p><strong>seed</strong> – Seed welcher zum Erstellen des Gamestates benutzt werden soll.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
|
|
@ -107,7 +108,7 @@
|
|||
<dd><p>Erstellt den Seeding ‚‘Gamestate‘‘ für den angegebenen Seed.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameter</dt>
|
||||
<dd class="field-odd"><p><strong>seed</strong> – Seed welcher zum erstellen des Gamestates benutzt werden soll.</p>
|
||||
<dd class="field-odd"><p><strong>seed</strong> – Seed welcher zum Erstellen des Gamestates benutzt werden soll.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -147,6 +148,30 @@
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<section id="beispiele">
|
||||
<h3>Beispiele<a class="headerlink" href="#beispiele" title="Permalink to this heading"></a></h3>
|
||||
<div class="line-block">
|
||||
<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">1</span></code> wird das Seeding Modul importiert.</div>
|
||||
<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">2</span></code> definieren wir dann eine Variable, in der wir den „Seed“ des Gamestates den wir erstellen wollten speichern.</div>
|
||||
<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">3</span></code> erstellen wir dann einen neuen Gamestate mit dem Seed und speichern ihn in die Variable <code class="docutils literal notranslate"><span class="pre">gamestate</span></code>.</div>
|
||||
<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">4</span></code> geben wir dann den Gamestate aus, damit wir ihn auf der Konsole ansehen können.</div>
|
||||
</div>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">compLib.Seeding</span> <span class="k">as</span> <span class="nn">Seeding</span>
|
||||
<span class="n">seed</span> <span class="o">=</span> <span class="mi">42</span>
|
||||
<span class="n">gamestate</span> <span class="o">=</span> <span class="n">Seeding</span><span class="o">.</span><span class="n">Gamestate</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="n">gamestate</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>In der Ausgabe des Print Statements sehen wir den generierten Gamestate.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Seed</span><span class="p">:</span> <span class="mi">42</span>
|
||||
<span class="n">Heu</span> <span class="n">Color</span><span class="p">:</span> <span class="mi">1</span>
|
||||
<span class="n">Material</span> <span class="n">Pairs</span><span class="p">:</span> <span class="p">[[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]]</span>
|
||||
<span class="n">Material</span> <span class="n">Zones</span><span class="p">:</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span>
|
||||
<span class="n">Logistic</span> <span class="n">Plan</span><span class="p">:</span> <span class="p">[</span><span class="mi">12</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">12</span><span class="p">]</span>
|
||||
<span class="n">Logistic</span> <span class="n">Centers</span><span class="p">:</span> <span class="p">[[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">]]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
|
|
|||
Reference in a new issue