steam-condenser 1.3.8 → 1.3.8.1

data/doc/GameInventory.html

@@ -107,7 +107,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>Provides basic functionality to represent an inventory of player in a game</p>
+    
+<p>Provides basic functionality to represent an inventory of player in a game</p>
 
 
   </div>
@@ -123,7 +124,8 @@
       
       
         
-        <div class='inline'><p>Sebastian Staudt</p>
+        <div class='inline'>
+<p>Sebastian Staudt</p>
 </div>
       
     </li>
@@ -180,7 +182,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the application ID of the game this inventory class belongs to.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the application ID of the game this inventory class belongs to.</p>
 </div></span>
   
 </li>
@@ -208,7 +211,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns an array of all items in this players inventory.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns an array of all items in this players inventory.</p>
 </div></span>
   
 </li>
@@ -236,7 +240,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns an array of all items that this player just found or traded.</p>
+    <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>
@@ -264,7 +269,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the Steam ID of the player owning this inventory.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the Steam ID of the player owning this inventory.</p>
 </div></span>
   
 </li>
@@ -305,7 +311,10 @@
   
 
   
-    <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>
+    <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>
@@ -328,7 +337,9 @@
   
 
   
-    <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>
+    <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>
@@ -360,7 +371,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the item at the given position in the inventory.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the item at the given position in the inventory.</p>
 </div></span>
   
 </li>
@@ -383,7 +395,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Updates the contents of the inventory using the Steam Web API.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Updates the contents of the inventory using the Steam Web API.</p>
 </div></span>
   
 </li>
@@ -408,7 +421,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Creates a new inventory object for the given AppID and SteamID64.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new inventory object for the given AppID and SteamID64.</p>
 </div></span>
   
 </li>
@@ -431,7 +445,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns a short, human-readable string representation of this inventory.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a short, human-readable string representation of this inventory.</p>
 </div></span>
   
 </li>
@@ -454,7 +469,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the item schema for this inventory.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the item schema for this inventory.</p>
 </div></span>
   
 </li>
@@ -477,7 +493,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the number of items in the user&#39;s inventory.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the number of items in the user&#39;s inventory.</p>
 </div></span>
   
 </li>
@@ -511,8 +528,11 @@
   
 </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
+    
+<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>
 
 
@@ -534,7 +554,8 @@ this players backpack</p>
       
       
         &mdash;
-        <div class='inline'><p>The application ID of the game</p>
+        <div class='inline'>
+<p>The application ID of the game</p>
 </div>
       
     </li>
@@ -549,7 +570,8 @@ this players backpack</p>
       
       
         &mdash;
-        <div class='inline'><p>The 64bit SteamID of the player to get the
+        <div class='inline'>
+<p>The 64bit SteamID of the player to get the
 inventory for</p>
 </div>
       
@@ -565,7 +587,8 @@ inventory for</p>
       
       
         &mdash;
-        <div class='inline'><p>if <code>true</code> the object&#39;s data is fetched after
+        <div class='inline'>
+<p>if <code>true</code> the object&#39;s data is fetched after
 creation</p>
 </div>
       
@@ -581,8 +604,10 @@ creation</p>
       
       
         &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 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>
@@ -645,7 +670,8 @@ even if it has been cached already</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the application ID of the game this inventory class belongs to</p>
+    
+<p>Returns the application ID of the game this inventory class belongs to</p>
 
 
   </div>
@@ -663,7 +689,8 @@ even if it has been cached already</p>
       
       
         &mdash;
-        <div class='inline'><p>The application ID of the game</p>
+        <div class='inline'>
+<p>The application ID of the game</p>
 </div>
       
     </li>
@@ -704,7 +731,8 @@ even if it has been cached already</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns an array of all items in this players inventory.</p>
+    
+<p>Returns an array of all items in this players inventory.</p>
 
 
   </div>
@@ -722,7 +750,8 @@ even if it has been cached already</p>
       
       
         &mdash;
-        <div class='inline'><p>All items in the backpack</p>
+        <div class='inline'>
+<p>All items in the backpack</p>
 </div>
       
     </li>
@@ -763,7 +792,8 @@ even if it has been cached already</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns an array of all items that this player just found or traded</p>
+    
+<p>Returns an array of all items that this player just found or traded</p>
 
 
   </div>
@@ -781,7 +811,8 @@ even if it has been cached already</p>
       
       
         &mdash;
-        <div class='inline'><p>All preliminary items of the inventory</p>
+        <div class='inline'>
+<p>All preliminary items of the inventory</p>
 </div>
       
     </li>
@@ -822,7 +853,8 @@ even if it has been cached already</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the Steam ID of the player owning this inventory</p>
+    
+<p>Returns the Steam ID of the player owning this inventory</p>
 
 
   </div>
@@ -840,7 +872,8 @@ even if it has been cached already</p>
       
       
         &mdash;
-        <div class='inline'><p>The Steam ID of the owner of this inventory</p>
+        <div class='inline'>
+<p>The Steam ID of the owner of this inventory</p>
 </div>
       
     </li>
@@ -886,9 +919,13 @@ even if it has been cached already</p>
   
 </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
+    
+<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>
 
 
@@ -910,7 +947,8 @@ instance of <code>GameInventory</code> is created.</p>
       
       
         &mdash;
-        <div class='inline'><p>The application ID of the game</p>
+        <div class='inline'>
+<p>The application ID of the game</p>
 </div>
       
     </li>
@@ -927,7 +965,8 @@ instance of <code>GameInventory</code> is created.</p>
       
       
         &mdash;
-        <div class='inline'><p>The 64bit Steam ID or vanity URL of the user</p>
+        <div class='inline'>
+<p>The 64bit Steam ID or vanity URL of the user</p>
 </div>
       
     </li>
@@ -942,7 +981,8 @@ instance of <code>GameInventory</code> is created.</p>
       
       
         &mdash;
-        <div class='inline'><p>if <code>true</code> the object&#39;s data is fetched after
+        <div class='inline'>
+<p>if <code>true</code> the object&#39;s data is fetched after
 creation</p>
 </div>
       
@@ -958,8 +998,10 @@ creation</p>
       
       
         &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 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>
@@ -977,7 +1019,8 @@ even if it has been cached already</p>
       
       
         &mdash;
-        <div class='inline'><p>The inventory for the given user and game</p>
+        <div class='inline'>
+<p>The inventory for the given user and game</p>
 </div>
       
     </li>
@@ -994,7 +1037,8 @@ even if it has been cached already</p>
       
       
         &mdash;
-        <div class='inline'><p>if creating the inventory fails</p>
+        <div class='inline'>
+<p>if creating the inventory fails</p>
 </div>
       
     </li>
@@ -1085,7 +1129,9 @@ even if it has been cached already</p>
   
 </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>
+    
+<p>Sets the language the schema should be fetched in (default is:
+<code>&#39;en&#39;</code>)</p>
 
 
   </div>
@@ -1104,7 +1150,8 @@ even if it has been cached already</p>
       
       
         &mdash;
-        <div class='inline'><p>The ISO 639-1 code of the schema language</p>
+        <div class='inline'>
+<p>The ISO 639-1 code of the schema language</p>
 </div>
       
     </li>
@@ -1150,7 +1197,9 @@ even if it has been cached already</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the item at the given position in the inventory. The positions
+    
+<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>
 
 
@@ -1169,7 +1218,8 @@ range from 1 to 100 instead of the usual array indices (0 to 99).</p>
       
       
         &mdash;
-        <div class='inline'><p>The item at the given position in the inventory</p>
+        <div class='inline'>
+<p>The item at the given position in the inventory</p>
 </div>
       
     </li>
@@ -1208,7 +1258,8 @@ range from 1 to 100 instead of the usual array indices (0 to 99).</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Updates the contents of the inventory using the Steam Web API</p>
+    
+<p>Updates the contents of the inventory using the Steam Web API</p>
 
 
   </div>
@@ -1278,7 +1329,8 @@ range from 1 to 100 instead of the usual array indices (0 to 99).</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a short, human-readable string representation of this inventory</p>
+    
+<p>Returns a short, human-readable string representation of this inventory</p>
 
 
   </div>
@@ -1296,7 +1348,8 @@ range from 1 to 100 instead of the usual array indices (0 to 99).</p>
       
       
         &mdash;
-        <div class='inline'><p>A string representation of this inventory</p>
+        <div class='inline'>
+<p>A string representation of this inventory</p>
 </div>
       
     </li>
@@ -1337,7 +1390,8 @@ range from 1 to 100 instead of the usual array indices (0 to 99).</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the item schema for this inventory</p>
+    
+<p>Returns the item schema for this inventory</p>
 
 
   </div>
@@ -1355,7 +1409,8 @@ range from 1 to 100 instead of the usual array indices (0 to 99).</p>
       
       
         &mdash;
-        <div class='inline'><p>The item schema for the game this inventory
+        <div class='inline'>
+<p>The item schema for the game this inventory
 belongs to</p>
 </div>
       
@@ -1395,7 +1450,8 @@ belongs to</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the number of items in the user&#39;s inventory</p>
+    
+<p>Returns the number of items in the user&#39;s inventory</p>
 
 
   </div>
@@ -1413,7 +1469,8 @@ belongs to</p>
       
       
         &mdash;
-        <div class='inline'><p> The number of items in the inventory</p>
+        <div class='inline'>
+<p>The number of items in the inventory</p>
 </div>
       
     </li>
@@ -1446,9 +1503,9 @@ belongs to</p>
 </div>
 
     <div id="footer">
-  Generated on Sun Oct 27 11:01:21 2013 by
+  Generated on Tue Dec 31 18:50:13 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).
+  0.8.7.3 (ruby-2.0.0).
 </div>
 
   </body>