docs/Battlesnake/Board.html in battlesnake-0.1.2 vs docs/Battlesnake/Board.html in battlesnake-0.1.3
- old
+ new
@@ -307,11 +307,11 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#available%3F-instance_method" title="#available? (instance method)">#<strong>available?</strong>(*coordinates) ⇒ Boolean </a>
+ <a href="#available%3F-instance_method" title="#available? (instance method)">#<strong>available?</strong>(location) ⇒ Boolean </a>
</span>
@@ -381,11 +381,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#occupied%3F-instance_method" title="#occupied? (instance method)">#<strong>occupied?</strong>(*coordinates) ⇒ Boolean </a>
+ <a href="#occupied%3F-instance_method" title="#occupied? (instance method)">#<strong>occupied?</strong>(location) ⇒ Boolean </a>
</span>
@@ -426,10 +426,58 @@
</div></span>
</li>
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#on_board%3F-instance_method" title="#on_board? (instance method)">#<strong>on_board?</strong>(location) ⇒ Boolean </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'>
+<p>Where the supplied location falls within the boundaries of the board.</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#paths-instance_method" title="#paths (instance method)">#<strong>paths</strong>(from, to) ⇒ Array<Path> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'>
+<p>List of valid, consecutive paths from one location to the next.</p>
+</div></span>
+
+</li>
+
+
</ul>
@@ -899,11 +947,11 @@
<div class="method_details first">
<h3 class="signature first" id="available?-instance_method">
- #<strong>available?</strong>(*coordinates) ⇒ <tt>Boolean</tt>
+ #<strong>available?</strong>(location) ⇒ <tt>Boolean</tt>
@@ -919,20 +967,20 @@
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
- <span class='name'>*coordinates</span>
+ <span class='name'>location</span>
- <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>, <tt>Hash</tt>, <tt>String</tt>, <tt>Array</tt>)</span>
+ <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
—
<div class='inline'>
-<p>can be specified as a <em>Location</em> object, hash containing x/y keys, JSON string of such a hash, or a pair of x,y coordinates expressed as a 2-element array or two separate parameters.</p>
+<p>being tested for availability.</p>
</div>
</li>
</ul>
@@ -960,19 +1008,19 @@
<tr>
<td>
<pre class="lines">
-73
-74
-75</pre>
+78
+79
+80</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 73</span>
+ <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 78</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_available?'>available?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_coordinates'>coordinates</span><span class='rparen'>)</span>
- <span class='op'>!</span><span class='id identifier rubyid_occupied?'>occupied?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_coordinates'>coordinates</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_available?'>available?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_on_board?'>on_board?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_occupied?'>occupied?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -1039,18 +1087,18 @@
<tr>
<td>
<pre class="lines">
-83
-84
-85
-86
-87</pre>
+88
+89
+90
+91
+92</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 83</span>
+ <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 88</span>
<span class='kw'>def</span> <span class='id identifier rubyid_available_directions'>available_directions</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Location.html#DIRECTIONS-constant" title="Battlesnake::Location::DIRECTIONS (constant)">DIRECTIONS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_direction'>direction</span><span class='op'>|</span>
<span class='id identifier rubyid_available?'>available?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_move'>move</span><span class='lparen'>(</span><span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
@@ -1061,11 +1109,11 @@
</div>
<div class="method_details ">
<h3 class="signature " id="occupied?-instance_method">
- #<strong>occupied?</strong>(*coordinates) ⇒ <tt>Boolean</tt>
+ #<strong>occupied?</strong>(location) ⇒ <tt>Boolean</tt>
@@ -1081,20 +1129,20 @@
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
- <span class='name'>*coordinates</span>
+ <span class='name'>location</span>
- <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>, <tt>Hash</tt>, <tt>String</tt>, <tt>Array</tt>)</span>
+ <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
—
<div class='inline'>
-<p>can be specified as a <em>Location</em> object, hash containing x/y keys, JSON string of such a hash, or a pair of x,y coordinates expressed as a 2-element array or two separate parameters.</p>
+<p>being checked for occupancy.</p>
</div>
</li>
</ul>
@@ -1122,20 +1170,18 @@
<tr>
<td>
<pre class="lines">
-60
-61
-62
-63</pre>
+58
+59
+60</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 60</span>
+ <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 58</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_occupied?'>occupied?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_coordinates'>coordinates</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_location'>location</span> <span class='op'>=</span> <span class='id identifier rubyid_coordinates'>coordinates</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_coordinates'>coordinates</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Location.html#initialize-instance_method" title="Battlesnake::Location#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_coordinates'>coordinates</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_occupied?'>occupied?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
<span class='id identifier rubyid_occupied_locations'>occupied_locations</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -1200,15 +1246,196 @@
</td>
</tr>
</table>
</div>
+ <div class="method_details ">
+ <h3 class="signature " id="on_board?-instance_method">
+
+ #<strong>on_board?</strong>(location) ⇒ <tt>Boolean</tt>
+
+
+
+
+
+</h3><div class="docstring">
+ <div class="discussion">
+
+<p>Where the supplied location falls within the boundaries of the board.</p>
+
+
</div>
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>location</span>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>being tested.</p>
+</div>
+
+ </li>
+
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>true if location is within the boundaries of the board.</p>
</div>
+
+ </li>
+
+</ul>
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+68
+69
+70</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 68</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_on_board?'>on_board?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>>=</span> <span class='int'>0</span> <span class='op'>&&</span> <span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_y'>y</span> <span class='op'>>=</span> <span class='int'>0</span> <span class='op'>&&</span> <span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'><</span> <span class='id identifier rubyid_width'>width</span> <span class='op'>&&</span> <span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_y'>y</span> <span class='op'><</span> <span class='id identifier rubyid_height'>height</span>
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <h3 class="signature " id="paths-instance_method">
+
+ #<strong>paths</strong>(from, to) ⇒ <tt>Array<Path></tt>
+
+
+
+
+
+</h3><div class="docstring">
+ <div class="discussion">
+
+<p>List of valid, consecutive paths from one location to the next. Paths may not:</p>
+
+<pre class="code ruby"><code class="ruby">- wander outside board boundaries.
+- use the same location more than once.
+- contain occupied locations, EXCEPT the start/end locations.
+</code></pre>
+
+<p>The exception for start/end locations allows us to generate paths, for example, from a snake to a food location, without having to calulate the starting/ending permutations ourselves.</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>from</span>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>starting location, may be occupied</p>
+</div>
+
+ </li>
+
+ <li>
+
+ <span class='name'>to</span>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>starting location, may be occupied</p>
+</div>
+
+ </li>
+
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Array<Path></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>a list of paths, which themselves are lists of consecutive, valid locations.</p>
+</div>
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+108
+109
+110</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 108</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_paths'>paths</span><span class='lparen'>(</span><span class='id identifier rubyid_from'>from</span><span class='comma'>,</span> <span class='id identifier rubyid_to'>to</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
<div id="footer">
- Generated on Sat Nov 5 20:09:02 2022 by
+ Generated on Mon Nov 7 15:30:13 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-2.7.2).
</div>
</div>
\ No newline at end of file