summaryrefslogtreecommitdiffhomepage
path: root/docs/FelFlame/Systems.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/FelFlame/Systems.html')
-rw-r--r--docs/FelFlame/Systems.html150
1 files changed, 84 insertions, 66 deletions
diff --git a/docs/FelFlame/Systems.html b/docs/FelFlame/Systems.html
index 1bc342a..3586974 100644
--- a/docs/FelFlame/Systems.html
+++ b/docs/FelFlame/Systems.html
@@ -109,9 +109,9 @@
<h2>Overview</h2><div class="docstring">
<div class="discussion">
-<p>Creates an manages Systems.</p>
+<p>Creates an manages Systems. Systems are the logic of the game and do not contain any data within them.</p>
-<p>TODO: Improve System overview</p>
+<p>TODO: Improve Systems overview</p>
</div>
@@ -196,6 +196,8 @@
+ <span class="note title readonly">readonly</span>
+
@@ -438,7 +440,7 @@
<li class="public ">
<span class="summary_signature">
- <a href="#trigger_when_is_changed-instance_method" title="#trigger_when_is_changed (instance method)">#<strong>trigger_when_is_changed</strong>(component_or_manager, attr) &#x21d2; Object </a>
+ <a href="#trigger_when_is_changed-instance_method" title="#trigger_when_is_changed (instance method)">#<strong>trigger_when_is_changed</strong>(component_or_manager, attr) &#x21d2; Boolean </a>
@@ -584,15 +586,15 @@
<pre class="lines">
-67
-68
-69
-70
71
-72</pre>
+72
+73
+74
+75
+76</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 67</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 71</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='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</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::Systems (class)">Systems</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>
@@ -651,12 +653,12 @@
<pre class="lines">
-20
-21
-22</pre>
+24
+25
+26</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 20</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 24</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>
@@ -707,12 +709,12 @@
<pre class="lines">
-38
-39
-40</pre>
+42
+43
+44</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 38</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 42</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>
@@ -723,11 +725,11 @@
</div>
- <span id="const_name=-instance_method"></span>
+ <span id=""></span>
<div class="method_details ">
<h3 class="signature " id="const_name-instance_method">
- #<strong>const_name</strong> &#x21d2; <tt>Object</tt>
+ #<strong>const_name</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
@@ -849,12 +851,12 @@
<pre class="lines">
-29
-30
-31</pre>
+33
+34
+35</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 29</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 33</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>
@@ -910,12 +912,12 @@
<pre class="lines">
-47
-48
-49</pre>
+51
+52
+53</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 47</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_constants'>constants</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='op'>|</span> <span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span> <span class='rbrace'>}</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'>reverse</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
@@ -957,12 +959,12 @@
<pre class="lines">
-75
-76
-77</pre>
+79
+80
+81</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 75</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 79</span>
<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
<span class='ivar'>@block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
@@ -1035,7 +1037,7 @@
<span class='name'>component_or_manager</span>
- <span class='type'>(<tt>Component or ComponentManager</tt>)</span>
+ <span class='type'>(<tt>Component or <span class='object_link'><a href="ComponentManager.html" title="FelFlame::ComponentManager (class)">ComponentManager</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1062,7 +1064,7 @@
&mdash;
<div class='inline'>
-<p>true</p>
+<p><code>true</code></p>
</div>
</li>
@@ -1075,10 +1077,6 @@
<pre class="lines">
-107
-108
-109
-110
111
112
113
@@ -1143,10 +1141,12 @@
172
173
174
-175</pre>
+175
+176
+177</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 107</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 111</span>
<span class='kw'>def</span> <span class='id identifier rubyid_clear_triggers'>clear_triggers</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_trigger_types'>trigger_types</span><span class='comma'>,</span> <span class='label'>component_or_manager:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_trigger_types'>trigger_types</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:addition_triggers</span><span class='comma'>,</span> <span class='symbol'>:removal_triggers</span><span class='comma'>,</span> <span class='symbol'>:attr_triggers</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_trigger_types'>trigger_types</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
@@ -1193,10 +1193,7 @@
</span> <span class='lparen'>(</span><span class='id identifier rubyid_trigger_types'>trigger_types</span> <span class='op'>-</span> <span class='lbracket'>[</span><span class='symbol'>:addition_triggers</span><span class='comma'>,</span> <span class='symbol'>:removal_triggers</span><span class='comma'>,</span> <span class='symbol'>:attr_triggers</span><span class='rbracket'>]</span><span class='rparen'>)</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_attr'>attr</span><span class='op'>|</span>
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_component_or_manager'>component_or_manager</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='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_component_or_manager'>component_or_manager</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='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='kw'>self</span>
- <span class='comment'>#self.attr_triggers[component_or_manager].each do |attr|
-</span> <span class='comment'># component_or_manager.attr_triggers[attr].delete self
-</span> <span class='comment'>#end
-</span> <span class='kw'>end</span>
+ <span class='kw'>end</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_attr_triggers'>attr_triggers</span><span class='lbracket'>[</span><span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='rbracket'>]</span> <span class='op'>-=</span> <span class='id identifier rubyid_trigger_types'>trigger_types</span> <span class='kw'>unless</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_attr_triggers'>attr_triggers</span><span class='lbracket'>[</span><span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span>
@@ -1216,6 +1213,7 @@
<span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_trigger_type'>trigger_type</span><span class='rparen'>)</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='kw'>end</span>
+ <span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -1268,12 +1266,12 @@
<pre class="lines">
-80
-81
-82</pre>
+84
+85
+86</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 80</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 84</span>
<span class='kw'>def</span> <span class='id identifier rubyid_redefine'>redefine</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
@@ -1309,7 +1307,7 @@
<span class='name'>component_or_manager</span>
- <span class='type'>(<tt>Component or ComponentManager</tt>)</span>
+ <span class='type'>(<tt>Component or <span class='object_link'><a href="ComponentManager.html" title="FelFlame::ComponentManager (class)">ComponentManager</a></span></tt>)</span>
@@ -1334,7 +1332,7 @@
&mdash;
<div class='inline'>
-<p>true</p>
+<p><code>true</code></p>
</div>
</li>
@@ -1347,14 +1345,14 @@
<pre class="lines">
-180
-181
182
183
-184</pre>
+184
+185
+186</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 180</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 182</span>
<span class='kw'>def</span> <span class='id identifier rubyid_trigger_when_added'>trigger_when_added</span><span class='lparen'>(</span><span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_addition_triggers'>addition_triggers</span> <span class='op'>|=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='rbracket'>]</span>
@@ -1369,7 +1367,7 @@
<div class="method_details ">
<h3 class="signature " id="trigger_when_is_changed-instance_method">
- #<strong>trigger_when_is_changed</strong>(component_or_manager, attr) &#x21d2; <tt>Object</tt>
+ #<strong>trigger_when_is_changed</strong>(component_or_manager, attr) &#x21d2; <tt>Boolean</tt>
@@ -1385,6 +1383,24 @@
</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>
@@ -1392,9 +1408,6 @@
<pre class="lines">
-196
-197
-198
199
200
201
@@ -1403,10 +1416,14 @@
204
205
206
-207</pre>
+207
+208
+209
+210
+211</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 196</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 199</span>
<span class='kw'>def</span> <span class='id identifier rubyid_trigger_when_is_changed'>trigger_when_is_changed</span><span class='lparen'>(</span><span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_component_or_manager'>component_or_manager</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='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
@@ -1419,6 +1436,7 @@
<span class='kw'>else</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_attr_triggers'>attr_triggers</span><span class='lbracket'>[</span><span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='rbracket'>]</span> <span class='op'>|=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_attr'>attr</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
+ <span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -1451,7 +1469,7 @@
<span class='name'>component_or_manager</span>
- <span class='type'>(<tt>Component or ComponentManager</tt>)</span>
+ <span class='type'>(<tt>Component or <span class='object_link'><a href="ComponentManager.html" title="FelFlame::ComponentManager (class)">ComponentManager</a></span></tt>)</span>
@@ -1476,7 +1494,7 @@
&mdash;
<div class='inline'>
-<p>true</p>
+<p><code>true</code></p>
</div>
</li>
@@ -1489,14 +1507,14 @@
<pre class="lines">
-189
-190
191
192
-193</pre>
+193
+194
+195</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'system_manager.rb', line 189</span>
+ <pre class="code"><span class="info file"># File 'system_manager.rb', line 191</span>
<span class='kw'>def</span> <span class='id identifier rubyid_trigger_when_removed'>trigger_when_removed</span><span class='lparen'>(</span><span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_removal_triggers'>removal_triggers</span> <span class='op'>|=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_component_or_manager'>component_or_manager</span><span class='rbracket'>]</span>
@@ -1513,7 +1531,7 @@
</div>
<div id="footer">
- Generated on Wed Jul 7 01:04:28 2021 by
+ Generated on Wed Jul 7 17:45:24 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>
generated by cgit v1.2.3 (git 2.39.1) at 2026-04-14 16:20:59 +0000