Major 4.0 Update (#16)v4.0.04.0.0

See Changelog

1 files changed, 68 insertions, 66 deletions

diff --git a/docs/FelFlame/Scenes.html b/docs/FelFlame/Scenes.html
index 41e369e..68f4ece 100644
--- a/docs/FelFlame/Scenes.html
+++ b/docs/FelFlame/Scenes.html
@@ -37,7 +37,7 @@
         <div id="menu">
   
     <a href="../_index.html">Index (S)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span>
+    <span class='title'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (module)">FelFlame</a></span></span>
      &raquo; 
     <span class="title">Scenes</span>
   
@@ -104,9 +104,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Creates and manages Scenes. Scenes are collections of Systems, and execute all the Systems when called upon.</p>
-
-<p>TODO: Improve Scenes overview</p>
+<p>Creates and manages Scenes. Scenes are collections of Systems, and execute all the Systems when called upon. Any scenes you create are accessable under the <span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span> namespace as Constants.</p>
 
 
   </div>
@@ -124,7 +122,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#const_name-instance_method" title="#const_name (instance method)">#<strong>const_name</strong>  &#x21d2; Object </a>
+      <a href="#priority-instance_method" title="#priority (instance method)">#<strong>priority</strong>  &#x21d2; Object </a>
     
 
     
@@ -133,8 +131,6 @@
   
   
     
-      <span class="note title readonly">readonly</span>
-    
     
   
   
@@ -144,7 +140,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>The Constant name assigned to this Scene.</p>
+<p>How early this Scene should be executed in a list of Scenes.</p>
 </div></span>
   
 </li>
@@ -267,7 +263,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name)  &#x21d2; Scenes </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, priority: 0)  &#x21d2; Scenes </a>
     
 
     
@@ -308,7 +304,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Removes any number of SystemS from this Scene.</p>
+<p>Removes any number of Systems from this Scene.</p>
 </div></span>
   
 </li>
@@ -323,7 +319,7 @@
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    #<strong>initialize</strong>(name)  &#x21d2; <tt><span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span></tt> 
+    #<strong>initialize</strong>(name, priority: 0)  &#x21d2; <tt><span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span></tt> 
   
 
   
@@ -366,17 +362,17 @@
       <pre class="lines">
 
 
-14
-15
-16
-17</pre>
+22
+23
+24
+25</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 14</span>
+      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 22</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
-  <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_set'>const_set</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span>
-  <span class='ivar'>@const_name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>priority:</span> <span class='int'>0</span><span class='rparen'>)</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'>=</span> <span class='id identifier rubyid_priority'>priority</span>
+  <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (module)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_set'>const_set</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -389,11 +385,11 @@
     <h2>Instance Attribute Details</h2>
     
       
-      <span id=""></span>
+      <span id="priority=-instance_method"></span>
       <div class="method_details first">
-  <h3 class="signature first" id="const_name-instance_method">
+  <h3 class="signature first" id="priority-instance_method">
   
-    #<strong>const_name</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+    #<strong>priority</strong>  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -402,7 +398,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>The Constant name assigned to this Scene</p>
+<p>How early this Scene should be executed in a list of Scenes</p>
 
 
   </div>
@@ -416,15 +412,15 @@
       <pre class="lines">
 
 
-4
-5
-6</pre>
+12
+13
+14</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 4</span>
+      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 12</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_const_name'>const_name</span>
-  <span class='ivar'>@const_name</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_priority'>priority</span>
+  <span class='ivar'>@priority</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -472,12 +468,12 @@
       <pre class="lines">
 
 
-21
-22
-23</pre>
+29
+30
+31</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 29</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_systems'>systems</span>
   <span class='ivar'>@systems</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -538,20 +534,24 @@
       <pre class="lines">
 
 
-34
-35
-36
-37
-38
-39</pre>
+42
+43
+44
+45
+46
+47
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 34</span>
+      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 42</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_systems_to_add'>systems_to_add</span><span class='rparen'>)</span>
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_systems'>systems</span> <span class='op'>|=</span> <span class='id identifier rubyid_systems_to_add'>systems_to_add</span>
-  <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_sort_by!'>sort_by!</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:priority</span><span class='rparen'>)</span>
-  <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Stage.html" title="FelFlame::Stage (class)">Stage</a></span></span><span class='period'>.</span><span class='id identifier rubyid_update_systems_list'>update_systems_list</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Stage.html" title="FelFlame::Stage (class)">Stage</a></span></span><span class='period'>.</span><span class='id identifier rubyid_scenes'><span class='object_link'><a href="Stage.html#scenes-class_method" title="FelFlame::Stage.scenes (method)">scenes</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='kw'>self</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_systems'>systems</span> <span class='op'>=</span> <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:priority</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_systems_to_add'>systems_to_add</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_system'>system</span><span class='op'>|</span>
+    <span class='id identifier rubyid_system'>system</span><span class='period'>.</span><span class='id identifier rubyid_scenes'>scenes</span> <span class='op'>|=</span> <span class='lbracket'>[</span><span class='kw'>self</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span>
   <span class='kw'>true</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -603,13 +603,13 @@
       <pre class="lines">
 
 
-27
-28
-29
-30</pre>
+35
+36
+37
+38</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 27</span>
+      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 35</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
   <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:call</span><span class='rparen'>)</span>
@@ -664,19 +664,25 @@
       <pre class="lines">
 
 
-52
-53
-54
-55
-56</pre>
+60
+61
+62
+63
+64
+65
+66
+67</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 52</span>
+      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 60</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_clear'>clear</span>
+  <span class='id identifier rubyid_systems'>systems</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_system'>system</span><span class='op'>|</span>
+    <span class='id identifier rubyid_system'>system</span><span class='period'>.</span><span class='id identifier rubyid_scenes'>scenes</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='kw'>self</span>
+  <span class='kw'>end</span>
   <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
-  <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Stage.html" title="FelFlame::Stage (class)">Stage</a></span></span><span class='period'>.</span><span class='id identifier rubyid_update_systems_list'>update_systems_list</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Stage.html" title="FelFlame::Stage (class)">Stage</a></span></span><span class='period'>.</span><span class='id identifier rubyid_scenes'><span class='object_link'><a href="Stage.html#scenes-class_method" title="FelFlame::Stage.scenes (method)">scenes</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='kw'>self</span>
-  <span class='kw'>true</span>
+  <span class='comment'># FelFlame::Stage.update_systems_list if FelFlame::Stage.scenes.include? self
+</span>  <span class='kw'>true</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -695,7 +701,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Removes any number of SystemS from this Scene</p>
+<p>Removes any number of Systems from this Scene</p>
 
 
   </div>
@@ -727,20 +733,16 @@
       <pre class="lines">
 
 
-43
-44
-45
-46
-47
-48</pre>
+53
+54
+55
+56</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 43</span>
+      <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 53</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_systems_to_remove'>systems_to_remove</span><span class='rparen'>)</span>
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_systems'>systems</span> <span class='op'>-=</span> <span class='id identifier rubyid_systems_to_remove'>systems_to_remove</span>
-  <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_sort_by!'>sort_by!</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:priority</span><span class='rparen'>)</span>
-  <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Stage.html" title="FelFlame::Stage (class)">Stage</a></span></span><span class='period'>.</span><span class='id identifier rubyid_update_systems_list'>update_systems_list</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Stage.html" title="FelFlame::Stage (class)">Stage</a></span></span><span class='period'>.</span><span class='id identifier rubyid_scenes'><span class='object_link'><a href="Stage.html#scenes-class_method" title="FelFlame::Stage.scenes (method)">scenes</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='kw'>self</span>
   <span class='kw'>true</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -753,7 +755,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Jul 12 18:28:27 2021 by
+  Generated on Mon Jan  3 08:23:04 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>