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

steam-condenser 1.3.6 → 1.3.7

Files changed (500) hide show

data/doc/GameItem.html ADDED Viewed

@@ -0,0 +1,1900 @@
+<!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: GameItem
+    &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">GameItem</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: GameItem
+</h1>
+<dl class="box">
+    <dt class="r1">Included in:</dt>
+    <dd class="r1"><span class='object_link'><a href="Dota2Item.html" title="Dota2Item (class)">Dota2Item</a></span>, <span class='object_link'><a href="Portal2Item.html" title="Portal2Item (class)">Portal2Item</a></span>, <span class='object_link'><a href="TF2Item.html" title="TF2Item (class)">TF2Item</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/community/game_item.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 an item 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>
+  <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="#attributes-instance_method" title="#attributes (instance method)">- (Hash&lt;Symbol, Object&gt;<sup>?</sup>) <strong>attributes</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Return the attributes of this item.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#backpack_position-instance_method" title="#backpack_position (instance method)">- (Fixnum) <strong>backpack_position</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the position of this item in the player&#39;s inventory.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#count-instance_method" title="#count (instance method)">- (Fixnum) <strong>count</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of items the player owns of this item.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#defindex-instance_method" title="#defindex (instance method)">- (Fixnum) <strong>defindex</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the index where the item is defined in the schema.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#id-instance_method" title="#id (instance method)">- (Fixnum) <strong>id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the ID of this item.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#inventory-instance_method" title="#inventory (instance method)">- (GameInventory) <strong>inventory</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the inventory this items belongs to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#item_class-instance_method" title="#item_class (instance method)">- (String) <strong>item_class</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the class of this item.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#item_set-instance_method" title="#item_set (instance method)">- (Hash&lt;Symbol, Object&gt;<sup>?</sup>) <strong>item_set</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the item set this item belongs to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#level-instance_method" title="#level (instance method)">- (Fixnum) <strong>level</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the level of this item.</p>
+</div></span>
+</li>
+      <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 level of this item.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#origin-instance_method" title="#origin (instance method)">- (String) <strong>origin</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the origin of this item.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#original_id-instance_method" title="#original_id (instance method)">- (Fixnum) <strong>original_id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the original ID of this item.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#quality-instance_method" title="#quality (instance method)">- (String) <strong>quality</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the quality of this item.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#type-instance_method" title="#type (instance method)">- (String) <strong>type</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the type of this item.</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="#craftable%3F-instance_method" title="#craftable? (instance method)">- (Boolean) <strong>craftable?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this item is craftable.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (GameItem) <strong>initialize</strong>(inventory, item_data) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a GameItem with the given data.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#preliminary%3F-instance_method" title="#preliminary? (instance method)">- (Boolean) <strong>preliminary?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this item is preliminary.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#schema_data-instance_method" title="#schema_data (instance method)">- (Hash&lt;Symbol, Object&gt;) <strong>schema_data</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the data for this item that&#39;s defined in the item schema.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#tradeable%3F-instance_method" title="#tradeable? (instance method)">- (Boolean) <strong>tradeable?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this item is tradeable.</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="attributes-instance_method">
+    - (<tt>Hash&lt;Symbol, Object&gt;</tt><sup>?</sup>) <strong>attributes</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Return the attributes of this item</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>, <tt>nil</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The attributes of this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+17
+18
+19</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 17</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_attributes identifier id'>attributes</span>
+  <span class='rubyid_@attributes ivar id'>@attributes</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="backpack_position-instance_method">
+    - (<tt>Fixnum</tt>) <strong>backpack_position</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the position of this item in the player&#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 position of this item in the player&#39;s inventory</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 22</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_backpack_position identifier id'>backpack_position</span>
+  <span class='rubyid_@backpack_position ivar id'>@backpack_position</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="count-instance_method">
+    - (<tt>Fixnum</tt>) <strong>count</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of items the player owns of this item</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 quantity of this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 27</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_count identifier id'>count</span>
+  <span class='rubyid_@count ivar id'>@count</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="defindex-instance_method">
+    - (<tt>Fixnum</tt>) <strong>defindex</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the index where the item is defined in the schema</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 schema index of this item</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_item.rb', line 32</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_defindex identifier id'>defindex</span>
+  <span class='rubyid_@defindex ivar id'>@defindex</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="id-instance_method">
+    - (<tt>Fixnum</tt>) <strong>id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the ID of this item</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 ID of this item</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_item.rb', line 37</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_id identifier id'>id</span>
+  <span class='rubyid_@id ivar id'>@id</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="inventory-instance_method">
+    - (<tt><span class='object_link'><a href="GameInventory.html" title="GameInventory (class)">GameInventory</a></span></tt>) <strong>inventory</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the inventory this items belongs to</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="GameInventory.html" title="GameInventory (class)">GameInventory</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The inventory this item belongs to</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_item.rb', line 42</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_inventory identifier id'>inventory</span>
+  <span class='rubyid_@inventory ivar id'>@inventory</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="item_class-instance_method">
+    - (<tt>String</tt>) <strong>item_class</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the class of this item</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 class of this item</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_item.rb', line 47</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_item_class identifier id'>item_class</span>
+  <span class='rubyid_@item_class ivar id'>@item_class</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="item_set-instance_method">
+    - (<tt>Hash&lt;Symbol, Object&gt;</tt><sup>?</sup>) <strong>item_set</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the item set this item belongs to</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>, <tt>nil</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The set this item belongs to</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+52
+53
+54</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 52</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_item_set identifier id'>item_set</span>
+  <span class='rubyid_@item_set ivar id'>@item_set</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="level-instance_method">
+    - (<tt>Fixnum</tt>) <strong>level</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the level of this item</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 level of this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+57
+58
+59</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 57</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_level identifier id'>level</span>
+  <span class='rubyid_@level ivar id'>@level</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="name-instance_method">
+    - (<tt>String</tt>) <strong>name</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the level of this item</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 level of this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+62
+63
+64</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 62</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_name identifier id'>name</span>
+  <span class='rubyid_@name ivar id'>@name</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="origin-instance_method">
+    - (<tt>String</tt>) <strong>origin</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the origin of this item</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 origin of this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+67
+68
+69</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 67</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_origin identifier id'>origin</span>
+  <span class='rubyid_@origin ivar id'>@origin</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="original_id-instance_method">
+    - (<tt>Fixnum</tt>) <strong>original_id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the original ID of this item</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 original ID of this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+72
+73
+74</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 72</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_original_id identifier id'>original_id</span>
+  <span class='rubyid_@original_id ivar id'>@original_id</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="quality-instance_method">
+    - (<tt>String</tt>) <strong>quality</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the quality of this item</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 quality of this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+77
+78
+79</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 77</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_quality identifier id'>quality</span>
+  <span class='rubyid_@quality ivar id'>@quality</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="type-instance_method">
+    - (<tt>String</tt>) <strong>type</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the type of this item</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 type of this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+82
+83
+84</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 82</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_type identifier id'>type</span>
+  <span class='rubyid_@type ivar id'>@type</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="craftable?-instance_method">
+    - (<tt>Boolean</tt>) <strong>craftable?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this item is craftable</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if this item is craftable</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+127
+128
+129</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 127</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_craftable? fid id'>craftable?</span>
+  <span class='rubyid_@craftable ivar id'>@craftable</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="GameItem (module)">GameItem</a></span></tt>) <strong>initialize</strong>(inventory, item_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a GameItem with the given data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>inventory</span>
+        <span class='type'>(<tt><span class='object_link'><a href="GameInventory.html" title="GameInventory (class)">GameInventory</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The inventory this item is contained in</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>item_data</span>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The data representing this item</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="GameItem (module)">GameItem</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>a new instance of GameItem</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 88</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_inventory identifier id'>inventory</span><span class='comma token'>,</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_@inventory ivar id'>@inventory</span> <span class='assign token'>=</span> <span class='rubyid_inventory identifier id'>inventory</span>
+  <span class='rubyid_@defindex ivar id'>@defindex</span>          <span class='assign token'>=</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:defindex</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@backpack_position ivar id'>@backpack_position</span> <span class='assign token'>=</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:inventory</span><span class='rbrack token'>]</span> <span class='bitand op'>&amp;</span> <span class='integer val'>0xffff</span>
+  <span class='rubyid_@count ivar id'>@count</span>             <span class='assign token'>=</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:quantity</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@craftable ivar id'>@craftable</span>         <span class='assign token'>=</span> <span class='notop op'>!</span><span class='notop op'>!</span><span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:flag_cannot_craft</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@id ivar id'>@id</span>                <span class='assign token'>=</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:id</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@item_class ivar id'>@item_class</span>        <span class='assign token'>=</span> <span class='rubyid_schema_data identifier id'>schema_data</span><span class='lbrack token'>[</span><span class='symbol val'>:item_class</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@item_set ivar id'>@item_set</span>          <span class='assign token'>=</span> <span class='rubyid_inventory identifier id'>inventory</span><span class='dot token'>.</span><span class='rubyid_item_schema identifier id'>item_schema</span><span class='dot token'>.</span><span class='rubyid_item_sets identifier id'>item_sets</span><span class='lbrack token'>[</span><span class='rubyid_schema_data identifier id'>schema_data</span><span class='lbrack token'>[</span><span class='symbol val'>:item_set</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@level ivar id'>@level</span>             <span class='assign token'>=</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:level</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@name ivar id'>@name</span>              <span class='assign token'>=</span> <span class='rubyid_schema_data identifier id'>schema_data</span><span class='lbrack token'>[</span><span class='symbol val'>:item_name</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@original_id ivar id'>@original_id</span>       <span class='assign token'>=</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:original_id</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@preliminary ivar id'>@preliminary</span>       <span class='assign token'>=</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:inventory</span><span class='rbrack token'>]</span> <span class='bitand op'>&amp;</span> <span class='integer val'>0x40000000</span> <span class='neq op'>!=</span> <span class='integer val'>0</span>
+  <span class='rubyid_@quality ivar id'>@quality</span>           <span class='assign token'>=</span> <span class='rubyid_inventory identifier id'>inventory</span><span class='dot token'>.</span><span class='rubyid_item_schema identifier id'>item_schema</span><span class='dot token'>.</span><span class='rubyid_qualities identifier id'>qualities</span><span class='lbrack token'>[</span><span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:quality</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@tradeable ivar id'>@tradeable</span>         <span class='assign token'>=</span> <span class='notop op'>!</span><span class='notop op'>!</span><span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:flag_cannot_trade</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@type ivar id'>@type</span>              <span class='assign token'>=</span> <span class='rubyid_schema_data identifier id'>schema_data</span><span class='lbrack token'>[</span><span class='symbol val'>:item_type_name</span><span class='rbrack token'>]</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='dot token'>.</span><span class='rubyid_key? fid id'>key?</span> <span class='colon op'>:</span><span class='rubyid_origin identifier id'>origin</span>
+    <span class='rubyid_@origin ivar id'>@origin</span> <span class='assign token'>=</span> <span class='rubyid_inventory identifier id'>inventory</span><span class='dot token'>.</span><span class='rubyid_item_schema identifier id'>item_schema</span><span class='dot token'>.</span><span class='rubyid_origins identifier id'>origins</span><span class='lbrack token'>[</span><span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:origin</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_attributes_data identifier id'>attributes_data</span> <span class='assign token'>=</span> <span class='rubyid_schema_data identifier id'>schema_data</span><span class='lbrack token'>[</span><span class='symbol val'>:attributes</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+  <span class='rubyid_attributes_data identifier id'>attributes_data</span> <span class='opasgn op'>+=</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:attributes</span><span class='rbrack token'>]</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='dot token'>.</span><span class='rubyid_key? fid id'>key?</span> <span class='symbol val'>:attributes</span>
+  <span class='rubyid_@attributes ivar id'>@attributes</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+  <span class='rubyid_attributes_data identifier id'>attributes_data</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_attribute_data identifier id'>attribute_data</span><span class='bitor op'>|</span>
+    <span class='rubyid_attribute_key identifier id'>attribute_key</span> <span class='assign token'>=</span> <span class='rubyid_attribute_data identifier id'>attribute_data</span><span class='lbrack token'>[</span><span class='symbol val'>:defindex</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='rubyid_attribute_data identifier id'>attribute_data</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span>
+    <span class='rubyid_unless unless kw'>unless</span> <span class='rubyid_attribute_key identifier id'>attribute_key</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+      <span class='rubyid_schema_attribute_data identifier id'>schema_attribute_data</span> <span class='assign token'>=</span> <span class='rubyid_inventory identifier id'>inventory</span><span class='dot token'>.</span><span class='rubyid_item_schema identifier id'>item_schema</span><span class='dot token'>.</span><span class='rubyid_attributes identifier id'>attributes</span><span class='lbrack token'>[</span><span class='rubyid_attribute_key identifier id'>attribute_key</span><span class='rbrack token'>]</span>
+      <span class='rubyid_@attributes ivar id'>@attributes</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_attribute_data identifier id'>attribute_data</span><span class='dot token'>.</span><span class='rubyid_merge identifier id'>merge</span><span class='lparen token'>(</span><span class='rubyid_schema_attribute_data identifier id'>schema_attribute_data</span><span class='rparen token'>)</span>
+    <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_end end kw'>end</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="preliminary?-instance_method">
+    - (<tt>Boolean</tt>) <strong>preliminary?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this item is preliminary</p>
+<p>Preliminary means that this item was just found or traded and has not yet
+been added to the inventory</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if this item is preliminary</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+137
+138
+139</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 137</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_preliminary? fid id'>preliminary?</span>
+  <span class='rubyid_@preliminary ivar id'>@preliminary</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="schema_data-instance_method">
+    - (<tt>Hash&lt;Symbol, Object&gt;</tt>) <strong>schema_data</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the data for this item that&#39;s defined in the item schema</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The schema data for this item</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+144
+145
+146</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 144</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_schema_data identifier id'>schema_data</span>
+  <span class='rubyid_inventory identifier id'>inventory</span><span class='dot token'>.</span><span class='rubyid_item_schema identifier id'>item_schema</span><span class='dot token'>.</span><span class='rubyid_items identifier id'>items</span><span class='lbrack token'>[</span><span class='rubyid_@defindex ivar id'>@defindex</span><span class='rbrack token'>]</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="tradeable?-instance_method">
+    - (<tt>Boolean</tt>) <strong>tradeable?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this item is tradeable</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if this item is tradeable</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+151
+152
+153</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_item.rb', line 151</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_tradeable? fid id'>tradeable?</span>
+  <span class='rubyid_@tradeable ivar id'>@tradeable</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:12:49 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>