Deploying to gh-pages from @ 24b6422 🚀

Author: BurnySc2

.doctrees/bot_ai/index.doctree

@@ -399,6 +399,8 @@ <h1>Source code for sc2.bot_ai</h1><div class="highlight"><pre>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Possible start locations for enemies.&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">game_info</span><span class="o">.</span><span class="n">start_locations</span>
 
+<div class="viewcode-block" id="BotAI.main_base_ramp">
+<a class="viewcode-back" href="../../bot_ai/index.html#sc2.bot_ai.BotAI.main_base_ramp">[docs]</a>
     <span class="nd">@cached_property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">main_base_ramp</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Ramp</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the Ramp instance of the closest main-ramp to start location.</span>
@@ -420,7 +422,8 @@ <h1>Source code for sc2.bot_ai</h1><div class="highlight"><pre>
                 <span class="p">(</span><span class="n">ramp</span> <span class="k">for</span> <span class="n">ramp</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">game_info</span><span class="o">.</span><span class="n">map_ramps</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">ramp</span><span class="o">.</span><span class="n">upper</span><span class="p">)</span> <span class="ow">in</span> <span class="p">{</span><span class="mi">4</span><span class="p">,</span> <span class="mi">9</span><span class="p">}),</span>
                 <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">r</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_location</span><span class="o">.</span><span class="n">distance_to</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">top_center</span><span class="p">),</span>
             <span class="p">)</span>
-        <span class="k">return</span> <span class="n">found_main_base_ramp</span>
+        <span class="k">return</span> <span class="n">found_main_base_ramp</span></div>
+
 
     <span class="nd">@property_cache_once_per_frame</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">expansion_locations_list</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">Point2</span><span class="p">]:</span>

.doctrees/environment.pickle

@@ -514,32 +514,43 @@ <h1>Source code for sc2.game_state</h1><div class="highlight"><pre>
 <span class="sd">                # dodge the ravager biles</span>
 <span class="sd">        &quot;&quot;&quot;</span>
 
+<div class="viewcode-block" id="GameState.dead_units">
+<a class="viewcode-back" href="../../game_state/index.html#sc2.game_state.GameState.dead_units">[docs]</a>
     <span class="nd">@cached_property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">dead_units</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">set</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;A set of unit tags that died this frame&quot;&quot;&quot;</span>
         <span class="n">_dead_units</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">observation_raw</span><span class="o">.</span><span class="n">event</span><span class="o">.</span><span class="n">dead_units</span><span class="p">)</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">previous_observation</span><span class="p">:</span>
             <span class="k">return</span> <span class="n">_dead_units</span> <span class="o">|</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">previous_observation</span><span class="o">.</span><span class="n">observation</span><span class="o">.</span><span class="n">raw_data</span><span class="o">.</span><span class="n">event</span><span class="o">.</span><span class="n">dead_units</span><span class="p">)</span>
-        <span class="k">return</span> <span class="n">_dead_units</span>
+        <span class="k">return</span> <span class="n">_dead_units</span></div>
 
+
+<div class="viewcode-block" id="GameState.chat">
+<a class="viewcode-back" href="../../game_state/index.html#sc2.game_state.GameState.chat">[docs]</a>
     <span class="nd">@cached_property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">chat</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">ChatMessage</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;List of chat messages sent this frame (by either player).&quot;&quot;&quot;</span>
         <span class="n">previous_frame_chat</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">previous_observation</span><span class="o">.</span><span class="n">chat</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">previous_observation</span> <span class="k">else</span> <span class="p">[]</span>
         <span class="k">return</span> <span class="p">[</span>
             <span class="n">ChatMessage</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">player_id</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
             <span class="k">for</span> <span class="n">message</span> <span class="ow">in</span> <span class="n">chain</span><span class="p">(</span><span class="n">previous_frame_chat</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">response_observation</span><span class="o">.</span><span class="n">chat</span><span class="p">)</span>
-        <span class="p">]</span>
+        <span class="p">]</span></div>
 
+
+<div class="viewcode-block" id="GameState.alerts">
+<a class="viewcode-back" href="../../game_state/index.html#sc2.game_state.GameState.alerts">[docs]</a>
     <span class="nd">@cached_property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">alerts</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Game alerts, see https://github.com/Blizzard/s2client-proto/blob/01ab351e21c786648e4c6693d4aad023a176d45c/s2clientprotocol/sc2api.proto#L683-L706</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">previous_observation</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">chain</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">previous_observation</span><span class="o">.</span><span class="n">observation</span><span class="o">.</span><span class="n">alerts</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">observation</span><span class="o">.</span><span class="n">alerts</span><span class="p">))</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">observation</span><span class="o">.</span><span class="n">alerts</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">observation</span><span class="o">.</span><span class="n">alerts</span></div>
+
 
+<div class="viewcode-block" id="GameState.actions">
+<a class="viewcode-back" href="../../game_state/index.html#sc2.game_state.GameState.actions">[docs]</a>
     <span class="nd">@cached_property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">actions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">ActionRawUnitCommand</span> <span class="o">|</span> <span class="n">ActionRawToggleAutocast</span> <span class="o">|</span> <span class="n">ActionRawCameraMove</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
@@ -592,26 +603,35 @@ <h1>Source code for sc2.game_state</h1><div class="highlight"><pre>
             <span class="k">else</span><span class="p">:</span>
                 <span class="c1"># Camera move actions</span>
                 <span class="n">actions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ActionRawCameraMove</span><span class="p">(</span><span class="n">Point2</span><span class="o">.</span><span class="n">from_proto</span><span class="p">(</span><span class="n">action</span><span class="o">.</span><span class="n">action_raw</span><span class="o">.</span><span class="n">camera_move</span><span class="o">.</span><span class="n">center_world_space</span><span class="p">)))</span>
-        <span class="k">return</span> <span class="n">actions</span>
+        <span class="k">return</span> <span class="n">actions</span></div>
 
+
+<div class="viewcode-block" id="GameState.actions_unit_commands">
+<a class="viewcode-back" href="../../game_state/index.html#sc2.game_state.GameState.actions_unit_commands">[docs]</a>
     <span class="nd">@cached_property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">actions_unit_commands</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">ActionRawUnitCommand</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        List of successful unit actions since last frame.</span>
 <span class="sd">        See https://github.com/Blizzard/s2client-proto/blob/01ab351e21c786648e4c6693d4aad023a176d45c/s2clientprotocol/raw.proto#L185-L193</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># pyre-ignore[7]</span>
-        <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">action</span><span class="p">:</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">action</span><span class="p">,</span> <span class="n">ActionRawUnitCommand</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">actions</span><span class="p">))</span>
+        <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">action</span><span class="p">:</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">action</span><span class="p">,</span> <span class="n">ActionRawUnitCommand</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">actions</span><span class="p">))</span></div>
+
 
+<div class="viewcode-block" id="GameState.actions_toggle_autocast">
+<a class="viewcode-back" href="../../game_state/index.html#sc2.game_state.GameState.actions_toggle_autocast">[docs]</a>
     <span class="nd">@cached_property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">actions_toggle_autocast</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">ActionRawToggleAutocast</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        List of successful autocast toggle actions since last frame.</span>
 <span class="sd">        See https://github.com/Blizzard/s2client-proto/blob/01ab351e21c786648e4c6693d4aad023a176d45c/s2clientprotocol/raw.proto#L199-L202</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># pyre-ignore[7]</span>
-        <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">action</span><span class="p">:</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">action</span><span class="p">,</span> <span class="n">ActionRawToggleAutocast</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">actions</span><span class="p">))</span>
+        <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">action</span><span class="p">:</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">action</span><span class="p">,</span> <span class="n">ActionRawToggleAutocast</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">actions</span><span class="p">))</span></div>
 
+
+<div class="viewcode-block" id="GameState.action_errors">
+<a class="viewcode-back" href="../../game_state/index.html#sc2.game_state.GameState.action_errors">[docs]</a>
     <span class="nd">@cached_property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">action_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">ActionError</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
@@ -623,6 +643,7 @@ <h1>Source code for sc2.game_state</h1><div class="highlight"><pre>
             <span class="n">ActionError</span><span class="p">(</span><span class="n">error</span><span class="o">.</span><span class="n">ability_id</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">unit_tag</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">result</span><span class="p">)</span>
             <span class="k">for</span> <span class="n">error</span> <span class="ow">in</span> <span class="n">chain</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">response_observation</span><span class="o">.</span><span class="n">action_errors</span><span class="p">,</span> <span class="n">previous_frame_errors</span><span class="p">)</span>
         <span class="p">]</span></div>
+</div>
 
 </pre></div>