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/SteamCondenser/Community/DoDSStats.html ADDED Viewed

@@ -0,0 +1,520 @@
+<!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::DoDSStats
+    &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 (D)</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">DoDSStats</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::DoDSStats
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="GameStats.html" title="SteamCondenser::Community::GameStats (class)">GameStats</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="GameStats.html" title="SteamCondenser::Community::GameStats (class)">GameStats</a></span></li>
+            <li class="next">SteamCondenser::Community::DoDSStats</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/dods/dods_stats.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>The is class represents the game statistics for a single user in Day of
+Defeat: Source</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</h2>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="GameStats.html" title="SteamCondenser::Community::GameStats (class)">GameStats</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameStats.html#game-instance_method" title="SteamCondenser::Community::GameStats#game (method)">#game</a></span>, <span class='object_link'><a href="GameStats.html#hours_played-instance_method" title="SteamCondenser::Community::GameStats#hours_played (method)">#hours_played</a></span>, <span class='object_link'><a href="GameStats.html#privacy_state-instance_method" title="SteamCondenser::Community::GameStats#privacy_state (method)">#privacy_state</a></span>, <span class='object_link'><a href="GameStats.html#user-instance_method" title="SteamCondenser::Community::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, DoDSClass&gt;) <strong>class_stats</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns a hash of <code>DoDSClass</code> for this user containing all DoD:S classes.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (DoDSStats) <strong>initialize</strong>(steam_id, 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>DoDSStats</code> instance by calling the super constructor with the game name <code>&#39;DoD:S&#39;</code>.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#weapon_stats-instance_method" title="#weapon_stats (instance method)">- (Hash&lt;String, DoDSWeapon&gt;) <strong>weapon_stats</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns a Hash of <code>DoDSWeapon</code> for this user containing all DoD:S weapons.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="GameStats.html" title="SteamCondenser::Community::GameStats (class)">GameStats</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameStats.html#achievements-instance_method" title="SteamCondenser::Community::GameStats#achievements (method)">#achievements</a></span>, <span class='object_link'><a href="GameStats.html#achievements_done-instance_method" title="SteamCondenser::Community::GameStats#achievements_done (method)">#achievements_done</a></span>, <span class='object_link'><a href="GameStats.html#achievements_percentage-instance_method" title="SteamCondenser::Community::GameStats#achievements_percentage (method)">#achievements_percentage</a></span>, <span class='object_link'><a href="GameStats.html#base_url-class_method" title="SteamCondenser::Community::GameStats.base_url (method)">base_url</a></span>, <span class='object_link'><a href="GameStats.html#base_url-instance_method" title="SteamCondenser::Community::GameStats#base_url (method)">#base_url</a></span>, <span class='object_link'><a href="GameStats.html#create_game_stats-class_method" title="SteamCondenser::Community::GameStats.create_game_stats (method)">create_game_stats</a></span>, <span class='object_link'><a href="GameStats.html#public%3F-instance_method" title="SteamCondenser::Community::GameStats#public? (method)">#public?</a></span></p>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="XMLData.html" title="SteamCondenser::Community::XMLData (module)">XMLData</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="XMLData.html#parse-instance_method" title="SteamCondenser::Community::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="SteamCondenser::Community::DoDSStats (class)">DoDSStats</a></span></tt>) <strong>initialize</strong>(steam_id, fetch = true, bypass_cache = false)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a <code>DoDSStats</code> instance by calling the super constructor with the
+game name <code>&#39;DoD:S&#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'>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">
+24
+25
+26</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/dods/dods_stats.rb', line 24</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_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
+  <span class='rubyid_super super kw'>super</span> <span class='rubyid_steam_id identifier id'>steam_id</span><span class='comma token'>,</span> <span class='string val'>'DoD:S'</span>
+<span class='rubyid_end end 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="DoDSClass.html" title="SteamCondenser::Community::DoDSClass (class)">DoDSClass</a></span>&gt;</tt>) <strong>class_stats</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a hash of <code>DoDSClass</code> for this user containing all DoD:S classes.</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="DoDSClass.html" title="SteamCondenser::Community::DoDSClass (class)">DoDSClass</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The class statistics for this user</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/dods/dods_stats.rb', line 33</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_class_stats identifier id'>class_stats</span>
+  <span class='rubyid_return return kw'>return</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_public? fid id'>public?</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_@class_stats ivar id'>@class_stats</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+    <span class='rubyid_@class_stats ivar id'>@class_stats</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+    <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'stats'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'classes'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'class'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_class_data identifier id'>class_data</span><span class='bitor op'>|</span>
+      <span class='rubyid_@class_stats ivar id'>@class_stats</span><span class='lbrack token'>[</span><span class='rubyid_class_data identifier id'>class_data</span><span class='lbrack token'>[</span><span class='string val'>'key'</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_DoDSClass constant id'>DoDSClass</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_class_data identifier id'>class_data</span>
+    <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_@class_stats ivar id'>@class_stats</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="weapon_stats-instance_method">
+    - (<tt>Hash&lt;String, <span class='object_link'><a href="DoDSWeapon.html" title="SteamCondenser::Community::DoDSWeapon (class)">DoDSWeapon</a></span>&gt;</tt>) <strong>weapon_stats</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a Hash of <code>DoDSWeapon</code> for this user containing all DoD:S
+weapons.</p>
+<p>If the weapons 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="DoDSWeapon.html" title="SteamCondenser::Community::DoDSWeapon (class)">DoDSWeapon</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The weapon statistics for this user</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/dods/dods_stats.rb', line 52</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_weapon_stats identifier id'>weapon_stats</span>
+  <span class='rubyid_return return kw'>return</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_public? fid id'>public?</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_@weapon_stats ivar id'>@weapon_stats</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+    <span class='rubyid_@weapon_stats ivar id'>@weapon_stats</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+    <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'stats'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'weapons'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'weapon'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_weapon_data identifier id'>weapon_data</span><span class='bitor op'>|</span>
+      <span class='rubyid_@weapon_stats ivar id'>@weapon_stats</span><span class='lbrack token'>[</span><span class='rubyid_weapon_data identifier id'>weapon_data</span><span class='lbrack token'>[</span><span class='string val'>'key'</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_DoDSWeapon constant id'>DoDSWeapon</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_weapon_data identifier id'>weapon_data</span>
+    <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_@weapon_stats ivar id'>@weapon_stats</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:57 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>