RubyGems - steam-condenser - Versions diffs - 1.3.8.1 → 1.3.9 - Mend

steam-condenser 1.3.8.1 → 1.3.9

Files changed (476) hide show

data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2ClassFactory.html ADDED Viewed

@@ -0,0 +1,273 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: SteamCondenser::Community::TF2ClassFactory
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../';
+  framesUrl = "../../frames.html#!" + escape(window.location.href);
+</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 id="header">
+      <div id="menu">
+    <a href="../../_index.html">Index (T)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Community.html" title="SteamCondenser::Community (module)">Community</a></span></span>
+     &raquo;
+    <span class="title">TF2ClassFactory</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Module: SteamCondenser::Community::TF2ClassFactory
+</h1>
+<dl class="box">
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/community/tf2/tf2_class_factory.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>The <code>TF2ClassFactory</code> is used to created instances of <code>TF2Class</code> based on the
+XML input data</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+    <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="#tf2_class-class_method" title="tf2_class (class method)">+ (TF2Class) <strong>tf2_class</strong>(class_data) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a TF2 class instance based on the given XML data.</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="tf2_class-class_method">
+    + (<tt><span class='object_link'><a href="TF2Class.html" title="SteamCondenser::Community::TF2Class (class)">TF2Class</a></span></tt>) <strong>tf2_class</strong>(class_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a TF2 class instance based on the given XML data</p>
+<p>This returns an instance of <code>TF2Class</code> or its subclasses <code>TF2Engineer</code>,
+<code>TF2Medic</code>, <code>TF2Sniper</code> or <code>TF2Spy</code> depending on the given XML data.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>class_data</span>
+        <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The XML data for the class</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="TF2Class.html" title="SteamCondenser::Community::TF2Class (class)">TF2Class</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The statistics for the given class data</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/tf2/tf2_class_factory.rb', line 27</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_tf2_class identifier id'>tf2_class</span><span class='lparen token'>(</span><span class='rubyid_class_data identifier id'>class_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_case case kw'>case</span> <span class='rubyid_class_data identifier id'>class_data</span><span class='lbrack token'>[</span><span class='string val'>'className'</span><span class='rbrack token'>]</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'Engineer'</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_return return kw'>return</span> <span class='rubyid_TF2Engineer constant id'>TF2Engineer</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_class_data identifier id'>class_data</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'Medic'</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_return return kw'>return</span> <span class='rubyid_TF2Medic constant id'>TF2Medic</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_class_data identifier id'>class_data</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'Sniper'</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_return return kw'>return</span> <span class='rubyid_TF2Sniper constant id'>TF2Sniper</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_class_data identifier id'>class_data</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'Spy'</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_return return kw'>return</span> <span class='rubyid_TF2Spy constant id'>TF2Spy</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_class_data identifier id'>class_data</span><span class='rparen token'>)</span>
+    <span class='rubyid_else else kw'>else</span>
+      <span class='rubyid_return return kw'>return</span> <span class='rubyid_TF2Class constant id'>TF2Class</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_class_data identifier id'>class_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_end end kw'>end</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Aug 14 21:47:43 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7 (ruby-1.8.7).
+</div>
+  </body>
+</html>

data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Engineer.html ADDED Viewed

@@ -0,0 +1,555 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: SteamCondenser::Community::TF2Engineer
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../';
+  framesUrl = "../../frames.html#!" + escape(window.location.href);
+</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 id="header">
+      <div id="menu">
+    <a href="../../_index.html">Index (T)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Community.html" title="SteamCondenser::Community (module)">Community</a></span></span>
+     &raquo;
+    <span class="title">TF2Engineer</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: SteamCondenser::Community::TF2Engineer
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="TF2Class.html" title="SteamCondenser::Community::TF2Class (class)">TF2Class</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="TF2Class.html" title="SteamCondenser::Community::TF2Class (class)">TF2Class</a></span></li>
+            <li class="next">SteamCondenser::Community::TF2Engineer</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam-condenser/community/tf2/tf2_engineer.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Represents the stats for the Team Fortress 2 Engineer class for a specific
+user</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</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="#max_buildings_built-instance_method" title="#max_buildings_built (instance method)">- (Fixnum) <strong>max_buildings_built</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the maximum number of buildings built by the player in a single life as an Engineer.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#max_sentry_kills-instance_method" title="#max_sentry_kills (instance method)">- (Fixnum) <strong>max_sentry_kills</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the maximum number of enemies killed by sentry guns built by the player in a single life as an Engineer.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#max_teleports-instance_method" title="#max_teleports (instance method)">- (Fixnum) <strong>max_teleports</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the maximum number of teammates teleported by teleporters built by the player in a single life as an Engineer.</p>
+</div></span>
+</li>
+  </ul>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="TF2Class.html" title="SteamCondenser::Community::TF2Class (class)">TF2Class</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="TF2Class.html#max_buildings_destroyed-instance_method" title="SteamCondenser::Community::TF2Class#max_buildings_destroyed (method)">#max_buildings_destroyed</a></span>, <span class='object_link'><a href="TF2Class.html#max_captures-instance_method" title="SteamCondenser::Community::TF2Class#max_captures (method)">#max_captures</a></span>, <span class='object_link'><a href="TF2Class.html#max_damage-instance_method" title="SteamCondenser::Community::TF2Class#max_damage (method)">#max_damage</a></span>, <span class='object_link'><a href="TF2Class.html#max_defenses-instance_method" title="SteamCondenser::Community::TF2Class#max_defenses (method)">#max_defenses</a></span>, <span class='object_link'><a href="TF2Class.html#max_dominations-instance_method" title="SteamCondenser::Community::TF2Class#max_dominations (method)">#max_dominations</a></span>, <span class='object_link'><a href="TF2Class.html#max_kill_assists-instance_method" title="SteamCondenser::Community::TF2Class#max_kill_assists (method)">#max_kill_assists</a></span>, <span class='object_link'><a href="TF2Class.html#max_kills-instance_method" title="SteamCondenser::Community::TF2Class#max_kills (method)">#max_kills</a></span>, <span class='object_link'><a href="TF2Class.html#max_revenges-instance_method" title="SteamCondenser::Community::TF2Class#max_revenges (method)">#max_revenges</a></span>, <span class='object_link'><a href="TF2Class.html#max_score-instance_method" title="SteamCondenser::Community::TF2Class#max_score (method)">#max_score</a></span>, <span class='object_link'><a href="TF2Class.html#max_time_alive-instance_method" title="SteamCondenser::Community::TF2Class#max_time_alive (method)">#max_time_alive</a></span></p>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="GameClass.html" title="SteamCondenser::Community::GameClass (module)">GameClass</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameClass.html#name-instance_method" title="SteamCondenser::Community::GameClass#name (method)">#name</a></span>, <span class='object_link'><a href="GameClass.html#play_time-instance_method" title="SteamCondenser::Community::GameClass#play_time (method)">#play_time</a></span></p>
+    <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="#initialize-instance_method" title="#initialize (instance method)">- (TF2Engineer) <strong>initialize</strong>(class_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of the Engineer class based on the given XML data.</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">
+    - (<tt><span class='object_link'><a href="" title="SteamCondenser::Community::TF2Engineer (class)">TF2Engineer</a></span></tt>) <strong>initialize</strong>(class_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of the Engineer class based on the given XML data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>class_data</span>
+        <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The XML data for this Engineer</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+37
+38
+39
+40
+41
+42
+43</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/tf2/tf2_engineer.rb', line 37</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_class_data identifier id'>class_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_super super kw'>super</span> <span class='rubyid_class_data identifier id'>class_data</span>
+  <span class='rubyid_@max_buildings_built ivar id'>@max_buildings_built</span> <span class='assign token'>=</span> <span class='rubyid_class_data identifier id'>class_data</span><span class='lbrack token'>[</span><span class='string val'>'ibuildingsbuilt'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+  <span class='rubyid_@max_teleports ivar id'>@max_teleports</span>       <span class='assign token'>=</span> <span class='rubyid_class_data identifier id'>class_data</span><span class='lbrack token'>[</span><span class='string val'>'inumteleports'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+  <span class='rubyid_@max_sentry_kills ivar id'>@max_sentry_kills</span>    <span class='assign token'>=</span> <span class='rubyid_class_data identifier id'>class_data</span><span class='lbrack token'>[</span><span class='string val'>'isentrykills'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="max_buildings_built-instance_method">
+    - (<tt>Fixnum</tt>) <strong>max_buildings_built</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the maximum number of buildings built by the player in a single
+life as an Engineer</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Maximum number of buildings built</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/tf2/tf2_engineer.rb', line 20</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_max_buildings_built identifier id'>max_buildings_built</span>
+  <span class='rubyid_@max_buildings_built ivar id'>@max_buildings_built</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="max_sentry_kills-instance_method">
+    - (<tt>Fixnum</tt>) <strong>max_sentry_kills</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the maximum number of enemies killed by sentry guns built by the
+player in a single life as an Engineer</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Maximum number of sentry kills</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/tf2/tf2_engineer.rb', line 26</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_max_sentry_kills identifier id'>max_sentry_kills</span>
+  <span class='rubyid_@max_sentry_kills ivar id'>@max_sentry_kills</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="max_teleports-instance_method">
+    - (<tt>Fixnum</tt>) <strong>max_teleports</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the maximum number of teammates teleported by teleporters built
+by the player in a single life as an Engineer</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Maximum number of teleports</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/tf2/tf2_engineer.rb', line 32</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_max_teleports identifier id'>max_teleports</span>
+  <span class='rubyid_@max_teleports ivar id'>@max_teleports</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Aug 14 21:47:59 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7 (ruby-1.8.7).
+</div>
+  </body>
+</html>