diff options
| author | realtradam <[email protected]> | 2021-06-12 00:57:04 -0400 |
|---|---|---|
| committer | realtradam <[email protected]> | 2021-06-12 00:57:04 -0400 |
| commit | 8dcacf9e69214f66be09c120ba474b848047cb53 (patch) | |
| tree | 43692e58a42632fd5fe069bcc3ab4bab96340ece /docs/FelFlame/Entities.html | |
| parent | 3ad8d2531329c1696a2bf86db8db9237309281ab (diff) | |
| download | FelECS-8dcacf9e69214f66be09c120ba474b848047cb53.tar.gz FelECS-8dcacf9e69214f66be09c120ba474b848047cb53.zip | |
unit testing and cleanup
Diffstat (limited to 'docs/FelFlame/Entities.html')
| -rw-r--r-- | docs/FelFlame/Entities.html | 144 |
1 files changed, 74 insertions, 70 deletions
diff --git a/docs/FelFlame/Entities.html b/docs/FelFlame/Entities.html index 4ba4d6f..38898a8 100644 --- a/docs/FelFlame/Entities.html +++ b/docs/FelFlame/Entities.html @@ -250,7 +250,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#add-instance_method" title="#add (instance method)">#<strong>add</strong>(component) ⇒ Boolean </a> + <a href="#add-instance_method" title="#add (instance method)">#<strong>add</strong>(*components_to_add) ⇒ Boolean </a> @@ -265,7 +265,7 @@ <span class="summary_desc"><div class='inline'> -<p>Returns true when added, or false if it already belongs to the Entity Add a component to the Entity.</p> +<p>Add any number components to the Entity.</p> </div></span> </li> @@ -348,7 +348,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#remove-instance_method" title="#remove (instance method)">#<strong>remove</strong>(component) ⇒ Boolean </a> + <a href="#remove-instance_method" title="#remove (instance method)">#<strong>remove</strong>(*components_to_remove) ⇒ Boolean </a> @@ -481,21 +481,25 @@ 18 19 20 -21</pre> +21 +22 +23</pre> </td> <td> <pre class="code"><span class="info file"># File 'entity_manager.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_components'>components</span><span class='rparen'>)</span> <span class='comment'># Assign new unique ID -</span> <span class='id identifier rubyid_new_id'>new_id</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_find_index'>find_index</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span> +</span> <span class='id identifier rubyid_new_id'>new_id</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_find_index'>find_index</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:nil?</span><span class='rparen'>)</span> <span class='id identifier rubyid_new_id'>new_id</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='kw'>if</span> <span class='id identifier rubyid_new_id'>new_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='id identifier rubyid_new_id'>new_id</span> <span class='comment'># Add each component -</span> <span class='id identifier rubyid_components'>components</span><span class='period'>.</span><span class='id identifier rubyid_uniq'>uniq</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_component'>component</span><span class='op'>|</span> - <span class='id identifier rubyid_add'>add</span> <span class='id identifier rubyid_component'>component</span> - <span class='kw'>end</span> +</span> <span class='comment'>#components.uniq.each do |component| +</span> <span class='comment'># add component +</span> <span class='comment'>#end +</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_components'>components</span><span class='rparen'>)</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>self</span> <span class='kw'>end</span></pre> </td> @@ -639,12 +643,12 @@ <pre class="lines"> -103 104 -105</pre> +105 +106</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 103</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 104</span> <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_entity_id'>entity_id</span><span class='rparen'>)</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_entity_id'>entity_id</span><span class='rbracket'>]</span> @@ -693,12 +697,12 @@ <pre class="lines"> -110 111 -112</pre> +112 +113</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 110</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 111</span> <span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> @@ -770,10 +774,10 @@ <pre class="lines"> -118</pre> +119</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 118</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 119</span> <span class='kw'>def</span> <span class='id identifier rubyid_from_json'>from_json</span><span class='lparen'>(</span><span class='id identifier rubyid_json_string'>json_string</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> @@ -790,7 +794,7 @@ <div class="method_details first"> <h3 class="signature first" id="add-instance_method"> - #<strong>add</strong>(component) ⇒ <tt>Boolean</tt> + #<strong>add</strong>(*components_to_add) ⇒ <tt>Boolean</tt> @@ -799,7 +803,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Returns true when added, or false if it already belongs to the Entity Add a component to the Entity</p> +<p>Add any number components to the Entity.</p> </div> @@ -819,7 +823,7 @@ — <div class='inline'> -<p>A component created from any component manager</p> +<p>Any number of components created from any component manager</p> </div> </li> @@ -838,7 +842,7 @@ — <div class='inline'> -<p>true if component is added, false if it already is attached</p> +<p>true if component is added, false if it already is attached or no components given</p> </div> </li> @@ -851,6 +855,9 @@ <pre class="lines"> +54 +55 +56 57 58 59 @@ -862,24 +869,25 @@ 65 66 67 -68 -69</pre> +68</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 57</span> - -<span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_component'>component</span><span class='rparen'>)</span> - <span class='kw'>if</span> <span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> - <span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> - <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_id'>id</span> - <span class='kw'>true</span> - <span class='kw'>elsif</span> <span class='op'>!</span><span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> - <span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> - <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_id'>id</span> - <span class='kw'>true</span> - <span class='kw'>else</span> - <span class='kw'>false</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 54</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_components_to_add'>components_to_add</span><span class='rparen'>)</span> + <span class='id identifier rubyid_added'>added</span> <span class='op'>=</span> <span class='kw'>false</span> + <span class='id identifier rubyid_components_to_add'>components_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_component'>component</span><span class='op'>|</span> + <span class='kw'>if</span> <span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> + <span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> + <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_id'>id</span> + <span class='id identifier rubyid_added'>added</span> <span class='op'>=</span><span class='kw'>true</span> + <span class='kw'>elsif</span> <span class='op'>!</span><span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> + <span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> + <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_id'>id</span> + <span class='id identifier rubyid_added'>added</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>end</span> <span class='kw'>end</span> + <span class='id identifier rubyid_added'>added</span> <span class='kw'>end</span></pre> </td> </tr> @@ -925,12 +933,12 @@ <pre class="lines"> -25 -26 -27</pre> +27 +28 +29</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 25</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 27</span> <span class='kw'>def</span> <span class='id identifier rubyid_components'>components</span> <span class='ivar'>@components</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> @@ -984,8 +992,6 @@ <pre class="lines"> -37 -38 39 40 41 @@ -996,22 +1002,16 @@ 46 47 48 -49 -50 -51</pre> +49</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 37</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 39</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_components'>components</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_component_manager'>component_manager</span><span class='comma'>,</span> <span class='id identifier rubyid_component_array'>component_array</span><span class='op'>|</span> <span class='id identifier rubyid_component_array'>component_array</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_component_id'>component_id</span><span class='op'>|</span> - <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span> - <span class='id identifier rubyid_component_manager'>component_manager</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_delete_prefix'>delete_prefix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>FelFlame::</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rparen'>)</span><span class='lbracket'>[</span><span class='id identifier rubyid_component_id'>component_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> - <span class='comment'># The following is neater, but doesnt work for some reason :/ -</span> <span class='comment'>#Object.const_get(component_manager)[component_id].entities.delete(id) -</span> <span class='kw'>end</span> + <span class='id identifier rubyid_component_manager'>component_manager</span><span class='lbracket'>[</span><span class='id identifier rubyid_component_id'>component_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> + <span class='kw'>end</span> <span class='kw'>end</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::Entities (class)">Entities</a></span></span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='ivar'>@id</span> <span class='op'>=</span> <span class='kw'>nil</span> @@ -1026,7 +1026,7 @@ <div class="method_details "> <h3 class="signature " id="remove-instance_method"> - #<strong>remove</strong>(component) ⇒ <tt>Boolean</tt> + #<strong>remove</strong>(*components_to_remove) ⇒ <tt>Boolean</tt> @@ -1046,7 +1046,7 @@ <li> - <span class='name'>component</span> + <span class='name'>component_to_remove</span> <span class='type'>(<tt>Component</tt>)</span> @@ -1074,7 +1074,7 @@ — <div class='inline'> -<p>true if component is removed, false if it wasnt attached to component</p> +<p>true if at least one component is removed, false if none of them were attached to the component</p> </div> </li> @@ -1087,6 +1087,7 @@ <pre class="lines"> +73 74 75 76 @@ -1094,18 +1095,21 @@ 78 79 80 -81</pre> +81 +82</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 74</span> - -<span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span><span class='id identifier rubyid_component'>component</span><span class='rparen'>)</span> - <span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> - <span class='kw'>if</span> <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_id'>id</span> - <span class='kw'>true</span> - <span class='kw'>else</span> - <span class='kw'>false</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 73</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_components_to_remove'>components_to_remove</span><span class='rparen'>)</span> + <span class='id identifier rubyid_removed'>removed</span> <span class='op'>=</span> <span class='kw'>false</span> + <span class='id identifier rubyid_components_to_remove'>components_to_remove</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_component'>component</span><span class='op'>|</span> + <span class='id identifier rubyid_components'>components</span><span class='lbracket'>[</span><span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> + <span class='kw'>if</span> <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_id'>id</span> + <span class='id identifier rubyid_removed'>removed</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>end</span> <span class='kw'>end</span> + <span class='id identifier rubyid_removed'>removed</span> <span class='kw'>end</span></pre> </td> </tr> @@ -1151,12 +1155,12 @@ <pre class="lines"> -31 -32 -33</pre> +33 +34 +35</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 31</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 33</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_i'>to_i</span> <span class='id identifier rubyid_id'>id</span> @@ -1210,10 +1214,10 @@ <pre class="lines"> -86</pre> +87</pre> </td> <td> - <pre class="code"><span class="info file"># File 'entity_manager.rb', line 86</span> + <pre class="code"><span class="info file"># File 'entity_manager.rb', line 87</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> @@ -1226,7 +1230,7 @@ </div> <div id="footer"> - Generated on Fri Jun 11 01:49:32 2021 by + Generated on Sat Jun 12 00:56:07 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-2.7.3). </div> |
