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

steam-condenser 1.3.9 → 1.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (958) hide show

data/pkg/steam-condenser-1.3.9/doc/GameClass.html ADDED

@@ -0,0 +1,328 @@
+<!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: GameClass
+    &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 (G)</a> &raquo;
+    <span class="title">GameClass</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: GameClass
+</h1>
+<dl class="box">
+    <dt class="r1">Included in:</dt>
+    <dd class="r1"><span class='object_link'><a href="DoDSClass.html" title="DoDSClass (class)">DoDSClass</a></span>, <span class='object_link'><a href="TF2Class.html" title="TF2Class (class)">TF2Class</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/community/game_class.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>A module implementing basic functionality for classes representing
+player
+classes</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="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the name of this class.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#play_time-instance_method" title="#play_time (instance method)">- (Fixnum) <strong>play_time</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the time in minutes the player has played with this class.</p>
+</div></span>
+</li>
+  </ul>
+  <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="name-instance_method">
+    - (<tt>String</tt>) <strong>name</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the name of this class</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The name of this class</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+15
+16
+17</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_class.rb', line 15</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
+  <span class='ivar'>@name</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="play_time-instance_method">
+    - (<tt>Fixnum</tt>) <strong>play_time</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the time in minutes the player has played with this 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>The time this class has been played</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/game_class.rb', line 20</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_play_time'>play_time</span>
+  <span class='ivar'>@play_time</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Tue Jul 22 07:10:16 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-2.0.0).
+</div>
+  </body>
+</html>

data/pkg/steam-condenser-1.3.9/doc/GameInventory.html ADDED

@@ -0,0 +1,1512 @@
+<!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: GameInventory
+    &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 (G)</a> &raquo;
+    <span class="title">GameInventory</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: GameInventory
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">GameInventory</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="Cacheable.html" title="Cacheable (module)">Cacheable</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/community/game_inventory.rb<span class="defines">,<br />
+  lib/steam/community/game_inventory.rb</span>
+</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Provides basic functionality to represent an inventory of player in a game</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><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="Dota2BetaInventory.html" title="Dota2BetaInventory (class)">Dota2BetaInventory</a></span>, <span class='object_link'><a href="Dota2Inventory.html" title="Dota2Inventory (class)">Dota2Inventory</a></span>, <span class='object_link'><a href="Portal2Inventory.html" title="Portal2Inventory (class)">Portal2Inventory</a></span>, <span class='object_link'><a href="TF2BetaInventory.html" title="TF2BetaInventory (class)">TF2BetaInventory</a></span>, <span class='object_link'><a href="TF2Inventory.html" title="TF2Inventory (class)">TF2Inventory</a></span></p>
+</div>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="item_class-classvariable" class="">@@item_class =
+        </dt>
+        <dd><pre class="code"><span class='const'>GameItem</span></pre></dd>
+        <dt id="schema_language-classvariable" class="">@@schema_language =
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>en</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+    </dl>
+  <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="#app_id-instance_method" title="#app_id (instance method)">- (Fixnum) <strong>app_id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the application ID of the game this inventory class belongs to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#items-instance_method" title="#items (instance method)">- (Array&lt;GameItem&gt;) <strong>items</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns an array of all items in this players inventory.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#preliminary_items-instance_method" title="#preliminary_items (instance method)">- (Array&lt;GameItem&gt;) <strong>preliminary_items</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns an array of all items that this player just found or traded.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#user-instance_method" title="#user (instance method)">- (SteamId) <strong>user</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the Steam ID of the player owning this inventory.</p>
+</div></span>
+</li>
+  </ul>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="Cacheable.html" title="Cacheable (module)">Cacheable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Cacheable.html#fetch_time-instance_method" title="Cacheable#fetch_time (method)">#fetch_time</a></span></p>
+    <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="#new-class_method" title="new (class method)">+ (GameInventory) <strong>new</strong>(app_id, steam_id, args, fetch = true, bypass_cache = false) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>This is a wrapper around all subclasses of <code>GameInventory</code> so
+that an instance of correct subclass is returned for a given application
+ID.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#schema_language%3D-class_method" title="schema_language= (class method)">+ (Object) <strong>schema_language=</strong>(language) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sets the language the schema should be fetched in (default is:
+<code>&#39;en&#39;</code>).</p>
+</div></span>
+</li>
+    </ul>
+    <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="#%5B%5D-instance_method" title="#[] (instance method)">- (GameItem) <strong>[]</strong>(index) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the item at the given position in the inventory.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Updates the contents of the inventory using the Steam Web API.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (GameInventory) <strong>initialize</strong>(app_id, steam_id64, fetch = true, bypass_cache = false) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new inventory object for the given AppID and SteamID64.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#inspect-instance_method" title="#inspect (instance method)">- (String) <strong>inspect</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a short, human-readable string representation of this inventory.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#item_schema-instance_method" title="#item_schema (instance method)">- (GameItemSchema) <strong>item_schema</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the item schema for this inventory.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#size-instance_method" title="#size (instance method)">- (Fixnum) <strong>size</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the number of items in the user&#39;s inventory.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Cacheable.html" title="Cacheable (module)">Cacheable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Cacheable.html#cache-instance_method" title="Cacheable#cache (method)">#cache</a></span>, <span class='object_link'><a href="Cacheable.html#cache_id_value-instance_method" title="Cacheable#cache_id_value (method)">#cache_id_value</a></span>, <span class='object_link'><a href="Cacheable.html#cache_ids-instance_method" title="Cacheable#cache_ids (method)">#cache_ids</a></span>, <span class='object_link'><a href="Cacheable.html#cached_instance-instance_method" title="Cacheable#cached_instance (method)">#cached_instance</a></span>, <span class='object_link'><a href="Cacheable.html#fetched%3F-instance_method" title="Cacheable#fetched? (method)">#fetched?</a></span>, <span class='object_link'><a href="Cacheable.html#included-class_method" title="Cacheable.included (method)">included</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="GameInventory (class)">GameInventory</a></span></tt>) <strong>initialize</strong>(app_id, steam_id64, fetch = true, bypass_cache = false)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Creates a new inventory object for the given AppID and SteamID64.
+This
+calls update to fetch the data and create the item instances contained
+in
+this players backpack</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>app_id</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The application ID of the game</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>steam_id64</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The 64bit SteamID of the player to get the
+inventory for</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">
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 108</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_steam_id64'>steam_id64</span><span class='rparen'>)</span>
+  <span class='kw'>unless</span> <span class='id identifier rubyid_steam_id64'>steam_id64</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Fixnum</span>
+    <span class='id identifier rubyid_steam_id64'>steam_id64</span> <span class='op'>=</span> <span class='const'>SteamId</span><span class='period'>.</span><span class='id identifier rubyid_resolve_vanity_url'>resolve_vanity_url</span> <span class='id identifier rubyid_steam_id64'>steam_id64</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User not found</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_steam_id64'>steam_id64</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='kw'>end</span>
+  <span class='ivar'>@app_id</span>     <span class='op'>=</span> <span class='id identifier rubyid_app_id'>app_id</span>
+  <span class='ivar'>@items</span>      <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@steam_id64</span> <span class='op'>=</span> <span class='id identifier rubyid_steam_id64'>steam_id64</span>
+  <span class='ivar'>@user</span>       <span class='op'>=</span> <span class='const'>SteamId</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_steam_id64'>steam_id64</span><span class='comma'>,</span> <span class='kw'>false</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="app_id-instance_method">
+    - (<tt>Fixnum</tt>) <strong>app_id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the application ID of the game this inventory class belongs to</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>The application ID of the game</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/community/game_inventory.rb', line 32</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_app_id'>app_id</span>
+  <span class='ivar'>@app_id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="items-instance_method">
+    - (<tt>Array&lt;<span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span>&gt;</tt>) <strong>items</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns an array of all items in this players inventory.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>All items in the backpack</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+37
+38
+39</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 37</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_items'>items</span>
+  <span class='ivar'>@items</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="preliminary_items-instance_method">
+    - (<tt>Array&lt;<span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span>&gt;</tt>) <strong>preliminary_items</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns an array of all items that this player just found or traded</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>All preliminary items of the inventory</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+42
+43
+44</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 42</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_preliminary_items'>preliminary_items</span>
+  <span class='ivar'>@preliminary_items</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="user-instance_method">
+    - (<tt><span class='object_link'><a href="SteamId.html" title="SteamId (class)">SteamId</a></span></tt>) <strong>user</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the Steam ID of the player owning this inventory</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="SteamId.html" title="SteamId (class)">SteamId</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The Steam ID of the owner of this inventory</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+47
+48
+49</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 47</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span>
+  <span class='ivar'>@user</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="new-class_method">
+    + (<tt><span class='object_link'><a href="" title="GameInventory (class)">GameInventory</a></span></tt>) <strong>new</strong>(app_id, steam_id, args, fetch = true, bypass_cache = false)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>This is a wrapper around all subclasses of <code>GameInventory</code> so
+that an
+instance of correct subclass is returned for a given application
+ID. If
+there&#39;s no specific subclass for an application ID exists, a
+generic
+instance of <code>GameInventory</code> is created.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>app_id</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The application ID of the game</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>steam_id</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>The 64bit Steam ID or vanity URL 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>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="GameInventory (class)">GameInventory</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The inventory for the given user and game</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt>SteamCondenserException</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>if creating the inventory fails</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 63</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_steam_id'>steam_id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_unshift'>unshift</span> <span class='id identifier rubyid_steam_id'>steam_id</span> <span class='kw'>unless</span> <span class='id identifier rubyid_steam_id'>steam_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='kw'>if</span> <span class='kw'>self</span> <span class='op'>==</span> <span class='const'>GameInventory</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wrong number of arguments (1 for 2)</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_unshift'>unshift</span> <span class='id identifier rubyid_app_id'>app_id</span>
+    <span class='id identifier rubyid_app_id'>app_id</span> <span class='op'>=</span> <span class='kw'>self</span><span class='op'>::</span><span class='const'>APP_ID</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_cacheable_new'>cacheable_new</span> <span class='op'>=</span> <span class='const'>Cacheable</span><span class='op'>::</span><span class='const'>ClassMethods</span><span class='period'>.</span><span class='id identifier rubyid_instance_method'>instance_method</span> <span class='symbol'>:new</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_app_id'>app_id</span>
+    <span class='kw'>when</span> <span class='const'>Dota2BetaInventory</span><span class='op'>::</span><span class='const'>APP_ID</span>
+      <span class='id identifier rubyid_cacheable_new'>cacheable_new</span> <span class='op'>=</span> <span class='id identifier rubyid_cacheable_new'>cacheable_new</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span> <span class='const'>Dota2BetaInventory</span>
+    <span class='kw'>when</span> <span class='const'>Dota2Inventory</span><span class='op'>::</span><span class='const'>APP_ID</span>
+      <span class='id identifier rubyid_cacheable_new'>cacheable_new</span> <span class='op'>=</span> <span class='id identifier rubyid_cacheable_new'>cacheable_new</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span> <span class='const'>Dota2Inventory</span>
+    <span class='kw'>when</span> <span class='const'>Portal2Inventory</span><span class='op'>::</span><span class='const'>APP_ID</span>
+      <span class='id identifier rubyid_cacheable_new'>cacheable_new</span> <span class='op'>=</span> <span class='id identifier rubyid_cacheable_new'>cacheable_new</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span> <span class='const'>Portal2Inventory</span>
+    <span class='kw'>when</span> <span class='const'>TF2BetaInventory</span><span class='op'>::</span><span class='const'>APP_ID</span>
+      <span class='id identifier rubyid_cacheable_new'>cacheable_new</span> <span class='op'>=</span> <span class='id identifier rubyid_cacheable_new'>cacheable_new</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span> <span class='const'>TF2BetaInventory</span>
+    <span class='kw'>when</span> <span class='const'>TF2Inventory</span><span class='op'>::</span><span class='const'>APP_ID</span>
+      <span class='id identifier rubyid_cacheable_new'>cacheable_new</span> <span class='op'>=</span> <span class='id identifier rubyid_cacheable_new'>cacheable_new</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span> <span class='const'>TF2Inventory</span>
+    <span class='kw'>else</span>
+      <span class='id identifier rubyid_cacheable_new'>cacheable_new</span> <span class='op'>=</span> <span class='id identifier rubyid_cacheable_new'>cacheable_new</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span> <span class='const'>GameInventory</span>
+      <span class='kw'>return</span> <span class='id identifier rubyid_cacheable_new'>cacheable_new</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_cacheable_new'>cacheable_new</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="schema_language=-class_method">
+    + (<tt>Object</tt>) <strong>schema_language=</strong>(language)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sets the language the schema should be fetched in (default is:
+<code>&#39;en&#39;</code>)</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>language</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The ISO 639-1 code of the schema language</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+96
+97
+98</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 96</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_schema_language='>schema_language=</span><span class='lparen'>(</span><span class='id identifier rubyid_language'>language</span><span class='rparen'>)</span>
+  <span class='cvar'>@@schema_language</span> <span class='op'>=</span> <span class='id identifier rubyid_language'>language</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="[]-instance_method">
+    - (<tt><span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span></tt>) <strong>[]</strong>(index)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the item at the given position in the inventory. The
+positions
+range from 1 to 100 instead of the usual array indices (0 to 99).</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="GameItem.html" title="GameItem (module)">GameItem</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The item at the given position in the inventory</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+124
+125
+126</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 124</span>
+<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
+  <span class='ivar'>@items</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span> <span class='op'>-</span> <span class='int'>1</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="fetch-instance_method">
+    - (<tt>Object</tt>) <strong>fetch</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Updates the contents of the inventory using the Steam Web API</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 129</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span>
+  <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:SteamID</span> <span class='op'>=&gt;</span> <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_steam_id64'>steam_id64</span> <span class='rbrace'>}</span>
+  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>WebApi</span><span class='period'>.</span><span class='id identifier rubyid_json!'>json!</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>IEconItems_</span><span class='embvar'>#</span><span class='ivar'>@app_id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GetPlayerItems</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
+  <span class='id identifier rubyid_item_class'>item_class</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:class_variable_get</span><span class='comma'>,</span> <span class='symbol'>:@@item_class</span>
+  <span class='ivar'>@items</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@preliminary_items</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='symbol'>:items</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_item_data'>item_data</span><span class='op'>|</span>
+    <span class='kw'>unless</span> <span class='id identifier rubyid_item_data'>item_data</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+      <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='id identifier rubyid_item_class'>item_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_item_data'>item_data</span><span class='rparen'>)</span>
+      <span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_preliminary?'>preliminary?</span>
+        <span class='ivar'>@preliminary_items</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_item'>item</span>
+      <span class='kw'>else</span>
+        <span class='ivar'>@items</span><span class='lbracket'>[</span><span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_backpack_position'>backpack_position</span> <span class='op'>-</span> <span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span>
+      <span class='kw'>end</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="inspect-instance_method">
+    - (<tt>String</tt>) <strong>inspect</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a short, human-readable string representation of this inventory</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>A string representation of this inventory</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+151
+152
+153
+154</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 151</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#&lt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embvar'>#</span><span class='ivar'>@app_id</span><span class='tstring_content'> </span><span class='embvar'>#</span><span class='ivar'>@steam_id64</span><span class='tstring_content'> (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_size'>size</span><span class='embexpr_end'>}</span><span class='tstring_content'> items) - </span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fetch_time'>fetch_time</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>not fetched</span><span class='tstring_end'>&#39;</span></span><span class='embexpr_end'>}</span><span class='tstring_content'>&gt;</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="item_schema-instance_method">
+    - (<tt><span class='object_link'><a href="GameItemSchema.html" title="GameItemSchema (class)">GameItemSchema</a></span></tt>) <strong>item_schema</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the item schema for this inventory</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="GameItemSchema.html" title="GameItemSchema (class)">GameItemSchema</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The item schema for the game this inventory
+belongs to</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+160
+161
+162</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 160</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_item_schema'>item_schema</span>
+  <span class='ivar'>@item_schema</span> <span class='op'>||=</span> <span class='const'>GameItemSchema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='cvar'>@@schema_language</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="size-instance_method">
+    - (<tt>Fixnum</tt>) <strong>size</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the number of items in the user&#39;s inventory</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>The number of items in the inventory</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+167
+168
+169</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_inventory.rb', line 167</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
+  <span class='ivar'>@items</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Tue Jul 22 07:10:27 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-2.0.0).
+</div>
+  </body>
+</html>