diff options
| author | realtradam <[email protected]> | 2022-02-03 04:12:35 -0500 |
|---|---|---|
| committer | realtradam <[email protected]> | 2022-02-03 04:12:35 -0500 |
| commit | a6004b2fccca58e528d24be5ba8afdf781666662 (patch) | |
| tree | f2edde63acfdd2fe13791f89335faf6c784683cb /docs/FelFlame/Scenes.html | |
| parent | 1e9ee993f6f996352c797d9f9a4268e5a7c2f513 (diff) | |
| download | FelECS-a6004b2fccca58e528d24be5ba8afdf781666662.tar.gz FelECS-a6004b2fccca58e528d24be5ba8afdf781666662.zip | |
added new group method for entity manager
Diffstat (limited to 'docs/FelFlame/Scenes.html')
| -rw-r--r-- | docs/FelFlame/Scenes.html | 765 |
1 files changed, 0 insertions, 765 deletions
diff --git a/docs/FelFlame/Scenes.html b/docs/FelFlame/Scenes.html deleted file mode 100644 index 68f4ece..0000000 --- a/docs/FelFlame/Scenes.html +++ /dev/null @@ -1,765 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Class: FelFlame::Scenes - - — Documentation by YARD 0.9.26 - -</title> - - <link rel="stylesheet" href="../css/style.css" type="text/css" /> - - <link rel="stylesheet" href="../css/common.css" type="text/css" /> - -<script type="text/javascript"> - pathId = "FelFlame::Scenes"; - relpath = '../'; -</script> - - - <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> - - <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> - - - </head> - <body> - <div class="nav_wrap"> - <iframe id="nav" src="../class_list.html?1"></iframe> - <div id="resizer"></div> - </div> - - <div id="main" tabindex="-1"> - <div id="header"> - <div id="menu"> - - <a href="../_index.html">Index (S)</a> » - <span class='title'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (module)">FelFlame</a></span></span> - » - <span class="title">Scenes</span> - -</div> - - <div id="search"> - - <a class="full_list_link" id="class_list_link" - href="../class_list.html"> - - <svg width="24" height="24"> - <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> - <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> - <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> - </svg> - </a> - -</div> - <div class="clear"></div> - </div> - - <div id="content"><h1>Class: FelFlame::Scenes - - - -</h1> -<div class="box_info"> - - <dl> - <dt>Inherits:</dt> - <dd> - <span class="inheritName">Object</span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next">FelFlame::Scenes</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - </dl> - - - - - - - - - - - - <dl> - <dt>Defined in:</dt> - <dd>lib/felflame.rb<span class="defines">,<br /> - lib/felflame/scene_manager.rb</span> -</dd> - </dl> - -</div> - -<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. 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> -</div> -<div class="tags"> - - -</div> - - - - <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#priority-instance_method" title="#priority (instance method)">#<strong>priority</strong> ⇒ Object </a> - - - - </span> - - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>How early this Scene should be executed in a list of Scenes.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#systems-instance_method" title="#systems (instance method)">#<strong>systems</strong> ⇒ Array<System> </a> - - - - </span> - - - - - <span class="note title readonly">readonly</span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The list of Systems this Scene contains.</p> -</div></span> - -</li> - - - </ul> - - - - - - <h2> - Instance Method Summary - <small><a href="#" class="summary_toggle">collapse</a></small> - </h2> - - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#add-instance_method" title="#add (instance method)">#<strong>add</strong>(*systems_to_add) ⇒ Boolean </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds any number of Systems to this Scene.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong> ⇒ Boolean </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Execute all systems in this Scene, in the order of their priority.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#clear-instance_method" title="#clear (instance method)">#<strong>clear</strong> ⇒ Boolean </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Removes all Systems from this Scene.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, priority: 0) ⇒ Scenes </a> - - - - </span> - - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Create a new Scene using the name given.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#remove-instance_method" title="#remove (instance method)">#<strong>remove</strong>(*systems_to_remove) ⇒ Boolean </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Removes any number of Systems from this Scene.</p> -</div></span> - -</li> - - - </ul> - - -<div id="constructor_details" class="method_details_list"> - <h2>Constructor Details</h2> - - <div class="method_details first"> - <h3 class="signature first" id="initialize-instance_method"> - - #<strong>initialize</strong>(name, priority: 0) ⇒ <tt><span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span></tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Create a new Scene using the name given</p> - - - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>name</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>String format must follow requirements of a constant</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -22 -23 -24 -25</pre> - </td> - <td> - <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='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> -</table> -</div> - -</div> - - <div id="instance_attr_details" class="attr_details"> - <h2>Instance Attribute Details</h2> - - - <span id="priority=-instance_method"></span> - <div class="method_details first"> - <h3 class="signature first" id="priority-instance_method"> - - #<strong>priority</strong> ⇒ <tt>Object</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>How early this Scene should be executed in a list of Scenes</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -12 -13 -14</pre> - </td> - <td> - <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_priority'>priority</span> - <span class='ivar'>@priority</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - - <span id="systems=-instance_method"></span> - <div class="method_details "> - <h3 class="signature " id="systems-instance_method"> - - #<strong>systems</strong> ⇒ <tt>Array<System></tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>The list of Systems this Scene contains</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array<System></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -29 -30 -31</pre> - </td> - <td> - <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> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - - - <div id="instance_method_details" class="method_details_list"> - <h2>Instance Method Details</h2> - - - <div class="method_details first"> - <h3 class="signature first" id="add-instance_method"> - - #<strong>add</strong>(*systems_to_add) ⇒ <tt>Boolean</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Adds any number of Systems to this Scene</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></p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -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 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='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'>&</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> - </tr> -</table> -</div> - - <div class="method_details "> - <h3 class="signature " id="call-instance_method"> - - #<strong>call</strong> ⇒ <tt>Boolean</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Execute all systems in this Scene, in the order of their priority</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></p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -35 -36 -37 -38</pre> - </td> - <td> - <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'>&</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="clear-instance_method"> - - #<strong>clear</strong> ⇒ <tt>Boolean</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Removes all Systems from this Scene</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></p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -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 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='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> -</table> -</div> - - <div class="method_details "> - <h3 class="signature " id="remove-instance_method"> - - #<strong>remove</strong>(*systems_to_remove) ⇒ <tt>Boolean</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Removes any number of Systems from this Scene</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></p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -53 -54 -55 -56</pre> - </td> - <td> - <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='kw'>true</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - 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> - - </div> - </body> -</html>
\ No newline at end of file |