summaryrefslogtreecommitdiffhomepage
path: root/docs/FelFlame/ComponentManager.html
diff options
context:
space:
mode:
authorrealtradam <[email protected]>2022-01-03 07:34:38 -0500
committerrealtradam <[email protected]>2022-01-03 07:34:38 -0500
commit55f1db30e7a609cebd2fab27c55ece1da45be232 (patch)
tree286045c958877ea872c69990d289dbf4c44c3c32 /docs/FelFlame/ComponentManager.html
parent809028c3d89993b2bb0651076ba723c11734cf3c (diff)
downloadFelECS-55f1db30e7a609cebd2fab27c55ece1da45be232.tar.gz
FelECS-55f1db30e7a609cebd2fab27c55ece1da45be232.zip
.
Diffstat (limited to 'docs/FelFlame/ComponentManager.html')
-rw-r--r--docs/FelFlame/ComponentManager.html211
1 files changed, 58 insertions, 153 deletions
diff --git a/docs/FelFlame/ComponentManager.html b/docs/FelFlame/ComponentManager.html
index 119a7ed..143fd3a 100644
--- a/docs/FelFlame/ComponentManager.html
+++ b/docs/FelFlame/ComponentManager.html
@@ -102,7 +102,7 @@
<h2>Overview</h2><div class="docstring">
<div class="discussion">
-<p>Component Managers are what is used to create individual components which can be attached to entities. When a Component is created from a Component Manager that has accessors given to it, you can set or get the values of those accessors using standard ruby message sending (e.g <tt>@component.var = 5</tt>), or by using the #attrs and <span class='object_link'><a href="#update_attrs-instance_method" title="FelFlame::ComponentManager#update_attrs (method)">#update_attrs</a></span> methods instead.</p>
+<p>Component Managers are what is used to create individual components which can be attached to entities. When a Component is created from a Component Manager that has accessors given to it, you can set or get the values of those accessors using standard ruby message sending (e.g <tt>@component.var = 5</tt>), or by using the <span class='object_link'><a href="#to_h-instance_method" title="FelFlame::ComponentManager#to_h (method)">#to_h</a></span> and <span class='object_link'><a href="#update_attrs-instance_method" title="FelFlame::ComponentManager#update_attrs (method)">#update_attrs</a></span> methods instead.</p>
</div>
@@ -312,30 +312,6 @@
<li class="public ">
<span class="summary_signature">
- <a href="#attr_changed_trigger_systems-instance_method" title="#attr_changed_trigger_systems (instance method)">#<strong>attr_changed_trigger_systems</strong>(attr) &#x21d2; Boolean </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Execute systems that have been added to execute on variable change.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> &#x21d2; Boolean </a>
@@ -449,7 +425,7 @@
<span class="summary_desc"><div class='inline'>
-<p>A hash, where all the keys are attributes linked to their respective values.</p>
+<p>A hash, where all the keys are attributes storing their respective values.</p>
</div></span>
</li>
@@ -531,6 +507,8 @@
<pre class="lines">
+154
+155
156
157
158
@@ -542,12 +520,10 @@
164
165
166
-167
-168
-169</pre>
+167</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 156</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 154</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_attrs'>attrs</span><span class='rparen'>)</span>
<span class='comment'># Prepare the object
@@ -614,12 +590,12 @@
<pre class="lines">
-206
-207
-208</pre>
+202
+203
+204</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 206</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 202</span>
<span class='kw'>def</span> <span class='id identifier rubyid_addition_triggers'>addition_triggers</span>
<span class='ivar'>@addition_triggers</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -670,12 +646,12 @@
<pre class="lines">
-222
-223
-224</pre>
+218
+219
+220</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 222</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 218</span>
<span class='kw'>def</span> <span class='id identifier rubyid_attr_triggers'>attr_triggers</span>
<span class='ivar'>@attr_triggers</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
@@ -726,12 +702,12 @@
<pre class="lines">
-214
-215
-216</pre>
+210
+211
+212</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 214</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 210</span>
<span class='kw'>def</span> <span class='id identifier rubyid_removal_triggers'>removal_triggers</span>
<span class='ivar'>@removal_triggers</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -787,12 +763,12 @@
<pre class="lines">
-133
-134
-135</pre>
+131
+132
+133</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 133</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 131</span>
<span class='kw'>def</span> <span class='id identifier rubyid_addition_triggers'>addition_triggers</span>
<span class='ivar'>@addition_triggers</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -843,12 +819,12 @@
<pre class="lines">
-149
-150
-151</pre>
+147
+148
+149</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 149</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 147</span>
<span class='kw'>def</span> <span class='id identifier rubyid_attr_triggers'>attr_triggers</span>
<span class='ivar'>@attr_triggers</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
@@ -899,12 +875,12 @@
<pre class="lines">
-141
-142
-143</pre>
+139
+140
+141</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 141</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 139</span>
<span class='kw'>def</span> <span class='id identifier rubyid_removal_triggers'>removal_triggers</span>
<span class='ivar'>@removal_triggers</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -922,78 +898,7 @@
<div class="method_details first">
- <h3 class="signature first" id="attr_changed_trigger_systems-instance_method">
-
- #<strong>attr_changed_trigger_systems</strong>(attr) &#x21d2; <tt>Boolean</tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
-
-<p>Execute systems that have been added to execute on variable change</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'>
-<p><code>true</code></p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-260
-261
-262
-263
-264
-265
-266
-267
-268</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 260</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_attr_changed_trigger_systems'>attr_changed_trigger_systems</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_systems_to_execute'>systems_to_execute</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_attr_triggers'>attr_triggers</span><span class='lbracket'>[</span><span class='id identifier rubyid_attr'>attr</span><span class='rbracket'>]</span>
- <span class='id identifier rubyid_systems_to_execute'>systems_to_execute</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_systems_to_execute'>systems_to_execute</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
-
- <span class='id identifier rubyid_systems_to_execute'>systems_to_execute</span> <span class='op'>|=</span> <span class='id identifier rubyid_attr_triggers'>attr_triggers</span><span class='lbracket'>[</span><span class='id identifier rubyid_attr'>attr</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_attr_triggers'>attr_triggers</span><span class='lbracket'>[</span><span class='id identifier rubyid_attr'>attr</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
-
- <span class='id identifier rubyid_systems_to_execute'>systems_to_execute</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='period'>.</span><span class='id identifier rubyid_reverse_each'>reverse_each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:call</span><span class='rparen'>)</span>
- <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="delete-instance_method">
+ <h3 class="signature first" id="delete-instance_method">
#<strong>delete</strong> &#x21d2; <tt>Boolean</tt>
@@ -1036,6 +941,8 @@
<pre class="lines">
+269
+270
271
272
273
@@ -1046,12 +953,10 @@
278
279
280
-281
-282
-283</pre>
+281</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 271</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 269</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
<span class='id identifier rubyid_addition_triggers'>addition_triggers</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>
@@ -1110,12 +1015,12 @@
<pre class="lines">
-235
-236
-237</pre>
+231
+232
+233</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 235</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 231</span>
<span class='kw'>def</span> <span class='id identifier rubyid_entities'>entities</span>
<span class='ivar'>@entities</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -1164,17 +1069,17 @@
<pre class="lines">
+237
+238
+239
+240
241
242
243
-244
-245
-246
-247
-248</pre>
+244</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 241</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 237</span>
<span class='kw'>def</span> <span class='id identifier rubyid_entity'>entity</span>
<span class='kw'>if</span> <span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
@@ -1201,7 +1106,7 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns A hash, where all the keys are attributes linked to their respective values.</p>
+<p>Returns A hash, where all the keys are attributes storing their respective values.</p>
</div>
@@ -1220,7 +1125,7 @@
&mdash;
<div class='inline'>
-<p>A hash, where all the keys are attributes linked to their respective values.</p>
+<p>A hash, where all the keys are attributes storing their respective values.</p>
</div>
</li>
@@ -1233,16 +1138,16 @@
<pre class="lines">
+284
+285
286
287
288
289
-290
-291
-292</pre>
+290</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 286</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 284</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
<span class='id identifier rubyid_return_hash'>return_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_instance_variables'>instance_variables</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_final'>final</span><span class='op'>|</span>
@@ -1300,14 +1205,14 @@
<pre class="lines">
-252
-253
-254
-255
-256</pre>
+248
+249
+250
+251
+252</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 252</span>
+ <pre class="code"><span class="info file"># File 'lib/felflame/component_manager.rb', line 248</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_attrs'>update_attrs</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</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_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
@@ -1324,7 +1229,7 @@
</div>
<div id="footer">
- Generated on Mon Jan 3 06:20:47 2022 by
+ Generated on Mon Jan 3 07:34:30 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>