diff options
Diffstat (limited to 'docs/FelECS.html')
| -rw-r--r-- | docs/FelECS.html | 335 |
1 files changed, 335 insertions, 0 deletions
diff --git a/docs/FelECS.html b/docs/FelECS.html new file mode 100644 index 0000000..d2d03b4 --- /dev/null +++ b/docs/FelECS.html @@ -0,0 +1,335 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<title> + Module: FelECS + + — 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 = "FelECS"; + 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 (F)</a> » + + + <span class="title">FelECS</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>Module: FelECS + + + +</h1> +<div class="box_info"> + + + + + + + + + + + + <dl> + <dt>Defined in:</dt> + <dd>lib/felecs.rb<span class="defines">,<br /> + lib/felecs/order.rb,<br /> lib/felecs/version.rb,<br /> lib/felecs/scene_manager.rb,<br /> lib/felecs/stage_manager.rb,<br /> lib/felecs/entity_manager.rb,<br /> lib/felecs/system_manager.rb,<br /> lib/felecs/component_manager.rb</span> +</dd> + </dl> + +</div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>:nocov: Keeps the version of the Gem</p> + + + </div> +</div> +<div class="tags"> + + +</div><h2>Defined Under Namespace</h2> +<p class="children"> + + + <strong class="modules">Modules:</strong> <span class='object_link'><a href="FelECS/Components.html" title="FelECS::Components (module)">Components</a></span>, <span class='object_link'><a href="FelECS/Order.html" title="FelECS::Order (module)">Order</a></span>, <span class='object_link'><a href="FelECS/Stage.html" title="FelECS::Stage (module)">Stage</a></span> + + + + <strong class="classes">Classes:</strong> <span class='object_link'><a href="FelECS/ComponentManager.html" title="FelECS::ComponentManager (class)">ComponentManager</a></span>, <span class='object_link'><a href="FelECS/Entities.html" title="FelECS::Entities (class)">Entities</a></span>, <span class='object_link'><a href="FelECS/Scenes.html" title="FelECS::Scenes (class)">Scenes</a></span>, <span class='object_link'><a href="FelECS/Systems.html" title="FelECS::Systems (class)">Systems</a></span> + + +</p> + + + <h2> + Constant Summary + <small><a href="#" class="constants_summary_toggle">collapse</a></small> + </h2> + + <dl class="constants"> + + <dt id="Ent-constant" class="">Ent = + <div class="docstring"> + <div class="discussion"> + +<p>An alias for <span class='object_link'><a href="FelECS/Entities.html" title="FelECS::Entities (class)">Entities</a></span></p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='const'>FelECS</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FelECS/Entities.html" title="FelECS::Entities (class)">Entities</a></span></span></pre></dd> + + <dt id="Cmp-constant" class="">Cmp = + <div class="docstring"> + <div class="discussion"> + +<p>An alias for <span class='object_link'><a href="FelECS/Components.html" title="FelECS::Components (module)">Components</a></span></p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='const'>FelECS</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FelECS/Components.html" title="FelECS::Components (module)">Components</a></span></span></pre></dd> + + <dt id="Sys-constant" class="">Sys = + <div class="docstring"> + <div class="discussion"> + +<p>An alias for <span class='object_link'><a href="FelECS/Systems.html" title="FelECS::Systems (class)">Systems</a></span></p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='const'>FelECS</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FelECS/Systems.html" title="FelECS::Systems (class)">Systems</a></span></span></pre></dd> + + <dt id="Scn-constant" class="">Scn = + <div class="docstring"> + <div class="discussion"> + +<p>An alias for <span class='object_link'><a href="FelECS/Scenes.html" title="FelECS::Scenes (class)">Scenes</a></span></p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='const'>FelECS</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FelECS/Scenes.html" title="FelECS::Scenes (class)">Scenes</a></span></span></pre></dd> + + <dt id="Stg-constant" class="">Stg = + <div class="docstring"> + <div class="discussion"> + +<p>An alias for <span class='object_link'><a href="FelECS/Stage.html" title="FelECS::Stage (module)">Stage</a></span></p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='const'>FelECS</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FelECS/Stage.html" title="FelECS::Stage (module)">Stage</a></span></span></pre></dd> + + <dt id="Odr-constant" class="">Odr = + <div class="docstring"> + <div class="discussion"> + <dl class="rdoc-list note-list"><dt>An alias for {FelECS +<dd></dd></dl> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='const'>FelECS</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FelECS/Order.html" title="FelECS::Order (module)">Order</a></span></span></pre></dd> + + <dt id="VERSION-constant" class="">VERSION = + <div class="docstring"> + <div class="discussion"> + +<p>The version of the Gem</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>5.0.0</span><span class='tstring_end'>'</span></span></pre></dd> + + </dl> + + + + + + + + + + <h2> + Class Method Summary + <small><a href="#" class="summary_toggle">collapse</a></small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#call-class_method" title="call (class method)">.<strong>call</strong> ⇒ Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>An alias for <span class='object_link'><a href="FelECS/Stage.html#call-class_method" title="FelECS::Stage.call (method)">Stage.call</a></span>.</p> +</div></span> + +</li> + + + </ul> + + + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="call-class_method"> + + .<strong>call</strong> ⇒ <tt>Object</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>An alias for <span class='object_link'><a href="FelECS/Stage.html#call-class_method" title="FelECS::Stage.call (method)">FelECS::Stage.call</a></span>. It executes a single frame in the game.</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +18 +19 +20</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/felecs.rb', line 18</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span> + <span class='const'><span class='object_link'><a href="" title="FelECS (module)">FelECS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FelECS/Stage.html" title="FelECS::Stage (module)">Stage</a></span></span><span class='period'>.</span><span class='id identifier rubyid_call'><span class='object_link'><a href="FelECS/Stage.html#call-class_method" title="FelECS::Stage.call (method)">call</a></span></span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Fri Jan 28 16:21:20 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 |