diff options
Diffstat (limited to 'docs/FelFlame/Systems.html')
| -rw-r--r-- | docs/FelFlame/Systems.html | 366 |
1 files changed, 150 insertions, 216 deletions
diff --git a/docs/FelFlame/Systems.html b/docs/FelFlame/Systems.html index 8961bf1..1bc342a 100644 --- a/docs/FelFlame/Systems.html +++ b/docs/FelFlame/Systems.html @@ -129,7 +129,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#addition_triggers-instance_method" title="#addition_triggers (instance method)">#<strong>addition_triggers</strong> ⇒ Object </a> + <a href="#addition_triggers-instance_method" title="#addition_triggers (instance method)">#<strong>addition_triggers</strong> ⇒ Array<Component> </a> @@ -138,30 +138,7 @@ - - - - - - - - - <span class="summary_desc"><div class='inline'></div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#attr_triggers-instance_method" title="#attr_triggers (instance method)">#<strong>attr_triggers</strong> ⇒ Object </a> - - - - </span> - - - + <span class="note title readonly">readonly</span> @@ -171,7 +148,9 @@ - <span class="summary_desc"><div class='inline'></div></span> + <span class="summary_desc"><div class='inline'> +<p>Stores references to components or their managers that trigger this component when a component or component from that manager is added to an entity.</p> +</div></span> </li> @@ -179,7 +158,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#const_name-instance_method" title="#const_name (instance method)">#<strong>const_name</strong> ⇒ Object </a> + <a href="#attr_triggers-instance_method" title="#attr_triggers (instance method)">#<strong>attr_triggers</strong> ⇒ Hash<Symbol, Array<Symbol>> </a> @@ -188,6 +167,8 @@ + <span class="note title readonly">readonly</span> + @@ -197,7 +178,7 @@ <span class="summary_desc"><div class='inline'> -<p>The Constant name assigned to this System.</p> +<p>Stores references to systems that should be triggered when an attribute from this manager is changed Do not edit this hash as it is managed by FelFlame automatically.</p> </div></span> </li> @@ -206,7 +187,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#frame-instance_method" title="#frame (instance method)">#<strong>frame</strong> ⇒ Object </a> + <a href="#const_name-instance_method" title="#const_name (instance method)">#<strong>const_name</strong> ⇒ Object </a> @@ -224,7 +205,7 @@ <span class="summary_desc"><div class='inline'> -<p>How many frames need to pass before this System is executed when controlled by Stage.</p> +<p>The Constant name assigned to this System.</p> </div></span> </li> @@ -260,7 +241,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#removal_triggers-instance_method" title="#removal_triggers (instance method)">#<strong>removal_triggers</strong> ⇒ Object </a> + <a href="#removal_triggers-instance_method" title="#removal_triggers (instance method)">#<strong>removal_triggers</strong> ⇒ Array<Component> </a> @@ -269,6 +250,8 @@ + <span class="note title readonly">readonly</span> + @@ -277,7 +260,9 @@ - <span class="summary_desc"><div class='inline'></div></span> + <span class="summary_desc"><div class='inline'> +<p>Stores references to components or their managers that trigger this component when a component or component from that manager is removed from an entity.</p> +</div></span> </li> @@ -429,30 +414,6 @@ <li class="public "> <span class="summary_signature"> - <a href="#step-instance_method" title="#step (instance method)">#<strong>step</strong> ⇒ Boolean </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Attempt to execute the system following the frame parameter set on this system.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - <a href="#trigger_when_added-instance_method" title="#trigger_when_added (instance method)">#<strong>trigger_when_added</strong>(component_or_manager) ⇒ Boolean </a> @@ -557,8 +518,7 @@ <span class='id identifier rubyid_component'>component</span><span class='period'>.</span><span class='id identifier rubyid_hp'>hp</span> <span class='op'>+=</span> <span class='int'>5</span> <span class='kw'>end</span> <span class='kw'>end</span> -<span class='comment'># Only heal all characters with health every other frame. -</span><span class='comment'># Give it a low priority so other systems such as a +<span class='comment'># Give it a low priority so other systems such as a </span><span class='comment'># Poison system would kill the player first</span></code></pre> </div> @@ -624,15 +584,15 @@ <pre class="lines"> -56 -57 -58 -59 -60 -61</pre> +67 +68 +69 +70 +71 +72</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 56</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 67</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'>&</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> @@ -655,59 +615,51 @@ <div class="method_details first"> <h3 class="signature first" id="addition_triggers-instance_method"> - #<strong>addition_triggers</strong> ⇒ <tt>Object</tt> + #<strong>addition_triggers</strong> ⇒ <tt>Array<Component></tt> -</h3><table class="source_code"> - <tr> - <td> - <pre class="lines"> - +</h3><div class="docstring"> + <div class="discussion"> + +<p>Stores references to components or their managers that trigger this component when a component or component from that manager is added to an entity. Do not edit this hash as it is managed by FelFlame automatically.</p> -14 -15 -16</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 14</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> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> + </div> </div> - - - <span id="attr_triggers=-instance_method"></span> - <div class="method_details "> - <h3 class="signature " id="attr_triggers-instance_method"> +<div class="tags"> - #<strong>attr_triggers</strong> ⇒ <tt>Object</tt> +<p class="tag_title">Returns:</p> +<ul class="return"> - + <li> + + + <span class='type'>(<tt>Array<Component></tt>)</span> + + + + </li> +</ul> - -</h3><table class="source_code"> +</div><table class="source_code"> <tr> <td> <pre class="lines"> -26 -27 -28</pre> +20 +21 +22</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 26</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 20</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> +<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> <span class='kw'>end</span></pre> </td> </tr> @@ -715,11 +667,11 @@ </div> - <span id="const_name=-instance_method"></span> + <span id="attr_triggers=-instance_method"></span> <div class="method_details "> - <h3 class="signature " id="const_name-instance_method"> + <h3 class="signature " id="attr_triggers-instance_method"> - #<strong>const_name</strong> ⇒ <tt>Object</tt> + #<strong>attr_triggers</strong> ⇒ <tt>Hash<Symbol, Array<Symbol>></tt> @@ -728,13 +680,26 @@ </h3><div class="docstring"> <div class="discussion"> -<p>The Constant name assigned to this System</p> +<p>Stores references to systems that should be triggered when an attribute from this manager is changed Do not edit this hash as it is managed by FelFlame automatically.</p> </div> </div> <div class="tags"> +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Hash<Symbol, Array<Symbol>></tt>)</span> + + + + </li> + +</ul> </div><table class="source_code"> <tr> @@ -742,15 +707,15 @@ <pre class="lines"> -7 -8 -9</pre> +38 +39 +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 7</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 38</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_attr_triggers'>attr_triggers</span> + <span class='ivar'>@attr_triggers</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> </tr> @@ -758,11 +723,11 @@ </div> - <span id="frame=-instance_method"></span> + <span id="const_name=-instance_method"></span> <div class="method_details "> - <h3 class="signature " id="frame-instance_method"> + <h3 class="signature " id="const_name-instance_method"> - #<strong>frame</strong> ⇒ <tt>Object</tt> + #<strong>const_name</strong> ⇒ <tt>Object</tt> @@ -771,7 +736,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>How many frames need to pass before this System is executed when controlled by FelFlame::Stage</p> +<p>The Constant name assigned to this System</p> </div> @@ -785,15 +750,15 @@ <pre class="lines"> -10 -11 -12</pre> +7 +8 +9</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 10</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 7</span> -<span class='kw'>def</span> <span class='id identifier rubyid_frame'>frame</span> - <span class='ivar'>@frame</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'>end</span></pre> </td> </tr> @@ -848,24 +813,48 @@ <div class="method_details "> <h3 class="signature " id="removal_triggers-instance_method"> - #<strong>removal_triggers</strong> ⇒ <tt>Object</tt> + #<strong>removal_triggers</strong> ⇒ <tt>Array<Component></tt> -</h3><table class="source_code"> +</h3><div class="docstring"> + <div class="discussion"> + +<p>Stores references to components or their managers that trigger this component when a component or component from that manager is removed from an entity. Do not edit this hash as it is managed by FelFlame automatically.</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array<Component></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> <tr> <td> <pre class="lines"> -20 -21 -22</pre> +29 +30 +31</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 29</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> @@ -921,12 +910,12 @@ <pre class="lines"> -35 -36 -37</pre> +47 +48 +49</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 35</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 47</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_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'>&</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'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> @@ -968,12 +957,12 @@ <pre class="lines"> -64 -65 -66</pre> +75 +76 +77</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 64</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 75</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> @@ -1086,10 +1075,6 @@ <pre class="lines"> -103 -104 -105 -106 107 108 109 @@ -1154,10 +1139,14 @@ 168 169 170 -171</pre> +171 +172 +173 +174 +175</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 103</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 107</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> @@ -1279,12 +1268,12 @@ <pre class="lines"> -76 -77 -78</pre> +80 +81 +82</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 76</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 80</span> <span class='kw'>def</span> <span class='id identifier rubyid_redefine'>redefine</span><span class='lparen'>(</span><span class='op'>&</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> @@ -1295,61 +1284,6 @@ </div> <div class="method_details "> - <h3 class="signature " id="step-instance_method"> - - #<strong>step</strong> ⇒ <tt>Boolean</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Attempt to execute the system following the frame parameter set on this system. For example if a System has its frame set to 3, it will only execute once every third frame that is called in FelFlame::Stage</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'> -<p><code>true</code> if the frame of the FelFlame::Stage is a multiple of this System's frame setting and this system has executed, <code>false</code> otherwise where the system has not executed.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -72</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 72</span> - -<span class='kw'>def</span> <span class='id identifier rubyid_step'>step</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> <h3 class="signature " id="trigger_when_added-instance_method"> #<strong>trigger_when_added</strong>(component_or_manager) ⇒ <tt>Boolean</tt> @@ -1413,14 +1347,14 @@ <pre class="lines"> -176 -177 -178 -179 -180</pre> +180 +181 +182 +183 +184</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 176</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 180</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> @@ -1458,10 +1392,6 @@ <pre class="lines"> -192 -193 -194 -195 196 197 198 @@ -1469,10 +1399,14 @@ 200 201 202 -203</pre> +203 +204 +205 +206 +207</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 192</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 196</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> @@ -1555,14 +1489,14 @@ <pre class="lines"> -185 -186 -187 -188 -189</pre> +189 +190 +191 +192 +193</pre> </td> <td> - <pre class="code"><span class="info file"># File 'system_manager.rb', line 185</span> + <pre class="code"><span class="info file"># File 'system_manager.rb', line 189</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> @@ -1579,7 +1513,7 @@ </div> <div id="footer"> - Generated on Sat Jul 3 00:34:25 2021 by + Generated on Wed Jul 7 01:04:28 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> |