diff options
Diffstat (limited to 'docs/FelFlame/Order.html')
| -rw-r--r-- | docs/FelFlame/Order.html | 109 |
1 files changed, 94 insertions, 15 deletions
diff --git a/docs/FelFlame/Order.html b/docs/FelFlame/Order.html index b17a786..e55ce58 100644 --- a/docs/FelFlame/Order.html +++ b/docs/FelFlame/Order.html @@ -78,12 +78,25 @@ <dl> <dt>Defined in:</dt> - <dd>lib/felflame/order.rb</dd> + <dd>lib/felflame.rb<span class="defines">,<br /> + lib/felflame/order.rb</span> +</dd> </dl> </div> +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>Sets the priority of a list of Systems or Scenes for you in the order you pass them to this class.</p> + + + </div> +</div> +<div class="tags"> + +</div> @@ -92,7 +105,7 @@ <h2> - Instance Method Summary + Class Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> @@ -101,7 +114,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#sort-instance_method" title="#sort (instance method)">#<strong>sort</strong>(*sortables) ⇒ Object </a> + <a href="#sort-class_method" title="sort (class method)">.<strong>sort</strong>(*sortables) ⇒ Boolean </a> @@ -115,7 +128,9 @@ - <span class="summary_desc"><div class='inline'></div></span> + <span class="summary_desc"><div class='inline'> +<p>Sets the priority of all items passed into this method according to the order they were passed.</p> +</div></span> </li> @@ -125,32 +140,96 @@ - <div id="instance_method_details" class="method_details_list"> - <h2>Instance Method Details</h2> + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> <div class="method_details first"> - <h3 class="signature first" id="sort-instance_method"> + <h3 class="signature first" id="sort-class_method"> + + .<strong>sort</strong>(*sortables) ⇒ <tt>Boolean</tt> - #<strong>sort</strong>(*sortables) ⇒ <tt>Object</tt> + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Sets the priority of all items passed into this method according to the order they were passed. If an array is one of the elements then it will give all of those elements in the array the same priority.</p> + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>sortables</span> + + + <span class='type'>(<tt>(<span class='object_link'><a href="Systems.html" title="FelFlame::Systems (class)">Systems</a></span> and Array<<span class='object_link'><a href="Systems.html" title="FelFlame::Systems (class)">Systems</a></span>>) or (<span class='object_link'><a href="Scenes.html" title="FelFlame::Scenes (class)">Scenes</a></span> and Array<<span class='object_link'><a href="Scenes.html" title="FelFlame::Scenes (class)">Scenes</a></span>>)</tt>)</span> + + + + </li> +</ul> +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'> +<p><code>true</code>.</p> +</div> + + </li> -</h3><table class="source_code"> +</ul> + +</div><table class="source_code"> <tr> <td> <pre class="lines"> -3 -4</pre> +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/felflame/order.rb', line 3</span> - -<span class='kw'>def</span> <span class='id identifier rubyid_sort'>sort</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_sortables'>sortables</span><span class='rparen'>)</span> + <pre class="code"><span class="info file"># File 'lib/felflame/order.rb', line 10</span> + +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_sort'>sort</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_sortables'>sortables</span><span class='rparen'>)</span> + <span class='id identifier rubyid_sortables'>sortables</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sorted'>sorted</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span> + <span class='kw'>if</span> <span class='id identifier rubyid_sorted'>sorted</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span> <span class='symbol'>:priority</span> + <span class='id identifier rubyid_sorted'>sorted</span><span class='period'>.</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'>=</span> <span class='id identifier rubyid_index'>index</span> + <span class='kw'>else</span> + <span class='id identifier rubyid_sorted'>sorted</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_item'>item</span><span class='op'>|</span> + <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'>=</span> <span class='id identifier rubyid_index'>index</span> + <span class='kw'>end</span> + <span class='kw'>end</span> + <span class='kw'>end</span> + <span class='kw'>true</span> <span class='kw'>end</span></pre> </td> </tr> @@ -162,7 +241,7 @@ </div> <div id="footer"> - Generated on Mon Jan 3 07:34:30 2022 by + Generated on Mon Jan 3 08:08:08 2022 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-2.7.3). </div> |