RubyGems - steam-condenser - Versions diffs - 1.3.7 → 1.3.8 - Mend

steam-condenser 1.3.7 → 1.3.8

Files changed (883) hide show

data/pkg/steam-condenser-1.3.7/doc/TF2Stats.html ADDED Viewed

@@ -0,0 +1,723 @@
+<!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: TF2Stats
+    &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">TF2Stats</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: TF2Stats
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="GameStats.html" title="GameStats (class)">GameStats</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="GameStats.html" title="GameStats (class)">GameStats</a></span></li>
+            <li class="next">TF2Stats</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/community/tf2/tf2_stats.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class represents the game statistics for a single user in Team Fortress
+2</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="#accumulated_points-instance_method" title="#accumulated_points (instance method)">- (Fixnum) <strong>accumulated_points</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the total points this player has achieved in his career.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#total_playtime-instance_method" title="#total_playtime (instance method)">- (Fixnum) <strong>total_playtime</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the accumulated number of seconds this player has spent playing as a TF2 class.</p>
+</div></span>
+</li>
+  </ul>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="GameStats.html" title="GameStats (class)">GameStats</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameStats.html#game-instance_method" title="GameStats#game (method)">#game</a></span>, <span class='object_link'><a href="GameStats.html#hours_played-instance_method" title="GameStats#hours_played (method)">#hours_played</a></span>, <span class='object_link'><a href="GameStats.html#privacy_state-instance_method" title="GameStats#privacy_state (method)">#privacy_state</a></span>, <span class='object_link'><a href="GameStats.html#user-instance_method" title="GameStats#user (method)">#user</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="#class_stats-instance_method" title="#class_stats (instance method)">- (Hash&lt;String, TF2Class&gt;) <strong>class_stats</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the statistics for all Team Fortress 2 classes for this user.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (TF2Stats) <strong>initialize</strong>(steam_id, beta, fetch = true, bypass_cache = false) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a <code>TF2Stats</code> instance by calling the super constructor with the game name <code>&#39;tf2&#39;</code>.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#inventory-instance_method" title="#inventory (instance method)">- (TF2Inventory) <strong>inventory</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the current Team Fortress 2 inventory (a.k.a. backpack) of this player.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="GameStats.html" title="GameStats (class)">GameStats</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameStats.html#achievements-instance_method" title="GameStats#achievements (method)">#achievements</a></span>, <span class='object_link'><a href="GameStats.html#achievements_done-instance_method" title="GameStats#achievements_done (method)">#achievements_done</a></span>, <span class='object_link'><a href="GameStats.html#achievements_percentage-instance_method" title="GameStats#achievements_percentage (method)">#achievements_percentage</a></span>, <span class='object_link'><a href="GameStats.html#base_url-class_method" title="GameStats.base_url (method)">base_url</a></span>, <span class='object_link'><a href="GameStats.html#base_url-instance_method" title="GameStats#base_url (method)">#base_url</a></span>, <span class='object_link'><a href="GameStats.html#create_game_stats-class_method" title="GameStats.create_game_stats (method)">create_game_stats</a></span>, <span class='object_link'><a href="GameStats.html#public%3F-instance_method" title="GameStats#public? (method)">#public?</a></span></p>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="XMLData.html" title="XMLData (module)">XMLData</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="XMLData.html#parse-instance_method" title="XMLData#parse (method)">#parse</a></span></p>
+<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="TF2Stats (class)">TF2Stats</a></span></tt>) <strong>initialize</strong>(steam_id, beta, fetch = true, bypass_cache = false)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a <code>TF2Stats</code> instance by calling the super constructor with the
+game name <code>&#39;tf2&#39;</code></p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>steam_id</span>
+        <span class='type'>(<tt>String</tt>, <tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The custom URL or 64bit Steam ID of the
+user</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>beta</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        <em class="default">(defaults to: <tt>false</tt>)</em>
+        &mdash;
+        <div class='inline'><p>If `true, creates stats for the public TF2 beta</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>fetch</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p>if <code>true</code> the object&#39;s data is fetched after
+creation</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>bypass_cache</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p>if <code>true</code> the object&#39;s data is fetched again
+even if it has been cached already</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_stats.rb', line 34</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='comma'>,</span> <span class='id identifier rubyid_beta'>beta</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
+  <span class='kw'>super</span> <span class='id identifier rubyid_steam_id'>steam_id</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='id identifier rubyid_beta'>beta</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>520</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tf2</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_public?'>public?</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stats</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>accumulatedPoints</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='ivar'>@accumulated_points</span> <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stats</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>accumulatedPoints</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
+  <span class='kw'>end</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_public?'>public?</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stats</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>secondsPlayedAllClassesLifetime</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='ivar'>@total_playtime</span> <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stats</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>secondsPlayedAllClassesLifetime</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='kw'>end</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=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="accumulated_points-instance_method">
+    - (<tt>Fixnum</tt>) <strong>accumulated_points</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the total points this player has achieved in his career</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>This player&#39;s accumulated points</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/community/tf2/tf2_stats.rb', line 20</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_accumulated_points'>accumulated_points</span>
+  <span class='ivar'>@accumulated_points</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="total_playtime-instance_method">
+    - (<tt>Fixnum</tt>) <strong>total_playtime</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the accumulated number of seconds this player has spent playing as a TF2 class</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>total seconds played as a TF2 class</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+25
+26
+27</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_stats.rb', line 25</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_total_playtime'>total_playtime</span>
+  <span class='ivar'>@total_playtime</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="class_stats-instance_method">
+    - (<tt>Hash&lt;String, <span class='object_link'><a href="TF2Class.html" title="TF2Class (class)">TF2Class</a></span>&gt;</tt>) <strong>class_stats</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the statistics for all Team Fortress 2 classes for this user</p>
+<p>If the classes haven&#39;t been parsed already, parsing is done now.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;String, <span class='object_link'><a href="TF2Class.html" title="TF2Class (class)">TF2Class</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A hash storing individual stats for each
+Team Fortress 2 class</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_stats.rb', line 51</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_class_stats'>class_stats</span>
+  <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_public?'>public?</span>
+  <span class='kw'>if</span> <span class='ivar'>@class_stats</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='ivar'>@class_stats</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+    <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stats</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>classData</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</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_class_data'>class_data</span><span class='op'>|</span>
+      <span class='ivar'>@class_stats</span><span class='lbracket'>[</span><span class='id identifier rubyid_class_data'>class_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>className</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>TF2ClassFactory</span><span class='period'>.</span><span class='id identifier rubyid_tf2_class'>tf2_class</span><span class='lparen'>(</span><span class='id identifier rubyid_class_data'>class_data</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='ivar'>@class_stats</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="inventory-instance_method">
+    - (<tt><span class='object_link'><a href="TF2Inventory.html" title="TF2Inventory (class)">TF2Inventory</a></span></tt>) <strong>inventory</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the current Team Fortress 2 inventory (a.k.a. backpack) of this
+player</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="TF2Inventory.html" title="TF2Inventory (class)">TF2Inventory</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>This player&#39;s TF2 backpack</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+68
+69
+70
+71
+72
+73
+74
+75</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_stats.rb', line 68</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_inventory'>inventory</span>
+  <span class='kw'>if</span> <span class='ivar'>@inventory</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='id identifier rubyid_inventory_class'>inventory_class</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_game'>game</span><span class='period'>.</span><span class='id identifier rubyid_short_name'>short_name</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tf2</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>TF2Inventory</span> <span class='op'>:</span> <span class='const'>TF2BetaInventory</span>
+    <span class='ivar'>@inventory</span> <span class='op'>=</span> <span class='id identifier rubyid_inventory_class'>inventory_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_steam_id64'>steam_id64</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@inventory</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='kw'>end</span>
+  <span class='ivar'>@inventory</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Sun Oct 27 11:01:21 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.1 (ruby-2.0.0).
+</div>
+  </body>
+</html>