diff options
| author | realtradam <[email protected]> | 2021-06-11 02:14:57 -0400 |
|---|---|---|
| committer | realtradam <[email protected]> | 2021-06-11 02:14:57 -0400 |
| commit | 3ad8d2531329c1696a2bf86db8db9237309281ab (patch) | |
| tree | 425ec6ded13c8c20cfb087a7a68cfe4c8e8deeea /docs/FelFlame/Components.html | |
| parent | 1145a2bf43d87256676f49ae9612ff0c49cd5901 (diff) | |
| download | FelECS-3ad8d2531329c1696a2bf86db8db9237309281ab.tar.gz FelECS-3ad8d2531329c1696a2bf86db8db9237309281ab.zip | |
general cleanup
Diffstat (limited to 'docs/FelFlame/Components.html')
| -rw-r--r-- | docs/FelFlame/Components.html | 77 |
1 files changed, 52 insertions, 25 deletions
diff --git a/docs/FelFlame/Components.html b/docs/FelFlame/Components.html index fdb54c0..633c5fb 100644 --- a/docs/FelFlame/Components.html +++ b/docs/FelFlame/Components.html @@ -111,7 +111,7 @@ <p>Creates component managers and allows accessing them them under the <span class='object_link'><a href="" title="FelFlame::Components (class)">Components</a></span> namespace as Constants</p> -<p>To see how component managers are used please look at the <span class='object_link'><a href="Helper/ComponentManagerTemplate.html" title="FelFlame::Helper::ComponentManagerTemplate (class)">Helper::ComponentManagerTemplate</a></span> documentation.</p> +<p>To see how component managers are used please look at the Helper::ComponentManagerTemplate documentation.</p> <p>TODO: Improve Component overview</p> @@ -163,7 +163,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(component_name, *attrs, **attrs_with_defaults) ⇒ Object </a> + <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(component_name, *attrs, **attrs_with_defaults) ⇒ ComponentManager </a> @@ -178,7 +178,7 @@ <span class="summary_desc"><div class='inline'> -<p>Creates a new component manager.</p> +<p>Creates a new <span class='object_link'><a href="Helper/ComponentManager.html" title="FelFlame::Helper::ComponentManager (class)">component manager</a></span>.</p> </div></span> </li> @@ -206,7 +206,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Iterate over all existing component managers. You also call other enumerable methods instead of each, such as `each_with_index` or `select`</p> +<p>Iterate over all existing component managers. You also call other enumerable methods instead of each, such as <code>each_with_index</code> or <code>select</code></p> </div> @@ -233,12 +233,12 @@ <pre class="lines"> -32 -33 -34</pre> +41 +42 +43</pre> </td> <td> - <pre class="code"><span class="info file"># File 'component_manager.rb', line 32</span> + <pre class="code"><span class="info file"># File 'component_manager.rb', line 41</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_each'>each</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> @@ -251,7 +251,7 @@ <div class="method_details "> <h3 class="signature " id="new-class_method"> - .<strong>new</strong>(component_name, *attrs, **attrs_with_defaults) ⇒ <tt>Object</tt> + .<strong>new</strong>(component_name, *attrs, **attrs_with_defaults) ⇒ <tt>ComponentManager</tt> @@ -260,13 +260,25 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Creates a new component manager.</p> +<p>Creates a new <span class='object_link'><a href="Helper/ComponentManager.html" title="FelFlame::Helper::ComponentManager (class)">component manager</a></span>.</p> </div> </div> <div class="tags"> - <p class="tag_title">Parameters:</p> + + <div class="examples"> + <p class="tag_title">Examples:</p> + + + <pre class="example code"><code><span class='comment'># Here color is set to default to red +</span><span class='comment'># while max and current are nil until set. +</span><span class='comment'># When you make a new component using this component manager +</span><span class='comment'># these are the values and accessors it will have. +</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'>Component</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Health</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:max</span><span class='comma'>,</span> <span class='symbol'>:current</span><span class='comma'>,</span> <span class='label'>color:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>red</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></code></pre> + + </div> +<p class="tag_title">Parameters:</p> <ul class="param"> <li> @@ -306,7 +318,7 @@ <span class='name'>attrs_with_defaults</span> - <span class='type'>(<tt>Keywords</tt>)</span> + <span class='type'>(<tt>Keyword: DefaultValue</tt>)</span> @@ -319,6 +331,19 @@ </ul> +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>ComponentManager</tt>)</span> + + + + </li> + +</ul> </div><table class="source_code"> <tr> @@ -326,26 +351,27 @@ <pre class="lines"> -15 -16 -17 -18 -19 -20 -21 -22 23 24 25 26 27 -28</pre> +28 +29 +30 +31 +32 +33 +34 +35 +36 +37</pre> </td> <td> - <pre class="code"><span class="info file"># File 'component_manager.rb', line 15</span> + <pre class="code"><span class="info file"># File 'component_manager.rb', line 23</span> <span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_component_name'>component_name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_attrs'>attrs</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_attrs_with_defaults'>attrs_with_defaults</span><span class='rparen'>)</span> - <span class='id identifier rubyid_const_set'>const_set</span><span class='lparen'>(</span><span class='id identifier rubyid_component_name'>component_name</span><span class='comma'>,</span> <span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</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="Helper.html" title="FelFlame::Helper (class)">Helper</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Helper/ComponentManagerTemplate.html" title="FelFlame::Helper::ComponentManagerTemplate (class)">ComponentManagerTemplate</a></span></span><span class='rparen'>)</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> + <span class='id identifier rubyid_const_set'>const_set</span><span class='lparen'>(</span><span class='id identifier rubyid_component_name'>component_name</span><span class='comma'>,</span> <span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</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="Helper.html" title="FelFlame::Helper (class)">Helper</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Helper/ComponentManager.html" title="FelFlame::Helper::ComponentManager (class)">ComponentManager</a></span></span><span class='rparen'>)</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_attrs'>attrs</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='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::Components (class)">Components</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_component_name'>component_name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='id identifier rubyid_attr'>attr</span> <span class='kw'>end</span> @@ -357,6 +383,7 @@ <span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attr'>attr</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</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::Components (class)">Components</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_component_name'>component_name</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> @@ -368,9 +395,9 @@ </div> <div id="footer"> - Generated on Thu Jun 10 12:12:44 2021 by + Generated on Fri Jun 11 01:49:32 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.26 (ruby-2.7.2). + 0.9.26 (ruby-2.7.3). </div> </div> |
