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/Dota2Item.html ADDED Viewed

@@ -0,0 +1,388 @@
+<!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: Dota2Item
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index (D)</a> &raquo;
+    <span class="title">Dota2Item</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: Dota2Item
+</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">Dota2Item</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/community/dota2/dota2_item.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Represents a DotA 2 item</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+  <h2>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameItem.html#attributes-instance_method" title="GameItem#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="GameItem.html#backpack_position-instance_method" title="GameItem#backpack_position (method)">#backpack_position</a></span>, <span class='object_link'><a href="GameItem.html#count-instance_method" title="GameItem#count (method)">#count</a></span>, <span class='object_link'><a href="GameItem.html#defindex-instance_method" title="GameItem#defindex (method)">#defindex</a></span>, <span class='object_link'><a href="GameItem.html#id-instance_method" title="GameItem#id (method)">#id</a></span>, <span class='object_link'><a href="GameItem.html#inventory-instance_method" title="GameItem#inventory (method)">#inventory</a></span>, <span class='object_link'><a href="GameItem.html#item_class-instance_method" title="GameItem#item_class (method)">#item_class</a></span>, <span class='object_link'><a href="GameItem.html#item_set-instance_method" title="GameItem#item_set (method)">#item_set</a></span>, <span class='object_link'><a href="GameItem.html#level-instance_method" title="GameItem#level (method)">#level</a></span>, <span class='object_link'><a href="GameItem.html#name-instance_method" title="GameItem#name (method)">#name</a></span>, <span class='object_link'><a href="GameItem.html#origin-instance_method" title="GameItem#origin (method)">#origin</a></span>, <span class='object_link'><a href="GameItem.html#original_id-instance_method" title="GameItem#original_id (method)">#original_id</a></span>, <span class='object_link'><a href="GameItem.html#quality-instance_method" title="GameItem#quality (method)">#quality</a></span>, <span class='object_link'><a href="GameItem.html#type-instance_method" title="GameItem#type (method)">#type</a></span></p>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#equipped%3F-instance_method" title="#equipped? (instance method)">- (Boolean) <strong>equipped?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this item is equipped by this player at all.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Dota2Item) <strong>initialize</strong>(inventory, item_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a DotA 2 item with the given data.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameItem.html#craftable%3F-instance_method" title="GameItem#craftable? (method)">#craftable?</a></span>, <span class='object_link'><a href="GameItem.html#preliminary%3F-instance_method" title="GameItem#preliminary? (method)">#preliminary?</a></span>, <span class='object_link'><a href="GameItem.html#schema_data-instance_method" title="GameItem#schema_data (method)">#schema_data</a></span>, <span class='object_link'><a href="GameItem.html#tradeable%3F-instance_method" title="GameItem#tradeable? (method)">#tradeable?</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="Dota2Item (class)">Dota2Item</a></span></tt>) <strong>initialize</strong>(inventory, item_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a DotA 2 item 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="Dota2Inventory.html" title="Dota2Inventory (class)">Dota2Inventory</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 specifying this item</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="WebApiError.html" title="WebApiError (class)">WebApiError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>on Web API errors</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+20
+21
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/dota2/dota2_item.rb', line 20</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_super super kw'>super</span>
+  <span class='rubyid_@equipped ivar id'>@equipped</span> <span class='assign token'>=</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'>:equipped</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</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="equipped?-instance_method">
+    - (<tt>Boolean</tt>) <strong>equipped?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this item is equipped by this player at all</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>Whether this item is equipped by this player at all</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+29
+30
+31</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/dota2/dota2_item.rb', line 29</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_equipped? fid id'>equipped?</span>
+  <span class='rubyid_@equipped ivar id'>@equipped</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:13:11 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>

data/doc/GameAchievement.html ADDED Viewed

@@ -0,0 +1,1255 @@
+<!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: GameAchievement
+    &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">GameAchievement</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: GameAchievement
+</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">GameAchievement</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/community/game_achievement.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>The GameAchievement class represents a specific achievement for a single game
+and for a single user</p>
+<p>It also provides the ability to load the global unlock percentages of all
+achievements of a specific 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="#api_name-instance_method" title="#api_name (instance method)">- (String) <strong>api_name</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the symbolic API name of this achievement.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#description-instance_method" title="#description (instance method)">- (String) <strong>description</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the description of this achievement.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#game-instance_method" title="#game (instance method)">- (Steam) <strong>game</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Return the game this achievement belongs to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#icon_closed_url-instance_method" title="#icon_closed_url (instance method)">- (String) <strong>icon_closed_url</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the url for the closed icon of this achievement.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#icon_open_url-instance_method" title="#icon_open_url (instance method)">- (String) <strong>icon_open_url</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the url for the open icon of this achievement.</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 name of this achievement.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#timestamp-instance_method" title="#timestamp (instance method)">- (Time) <strong>timestamp</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the time this achievement has been unlocked by its owner.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#user-instance_method" title="#user (instance method)">- (Fixnum) <strong>user</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the SteamID of the user who owns this achievement.</p>
+</div></span>
+</li>
+  </ul>
+    <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="#global_percentages-class_method" title="global_percentages (class method)">+ (Hash&lt;Symbol, Float&gt;) <strong>global_percentages</strong>(app_id) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Loads the global unlock percentages of all achievements for the game with the given Steam Application ID.</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="#initialize-instance_method" title="#initialize (instance method)">- (GameAchievement) <strong>initialize</strong>(user, game, achievement_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates the achievement with the given name for the given user and game and achievement data.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#unlocked%3F-instance_method" title="#unlocked? (instance method)">- (Boolean) <strong>unlocked?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this achievement has been unlocked by its owner.</p>
+</div></span>
+</li>
+    </ul>
+<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="GameAchievement (class)">GameAchievement</a></span></tt>) <strong>initialize</strong>(user, game, achievement_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates the achievement with the given name for the given user and game
+and achievement data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>user</span>
+        <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 SteamID of the player this achievement belongs to</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>game</span>
+        <span class='type'>(<tt><span class='object_link'><a href="SteamGame.html" title="SteamGame (class)">SteamGame</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The game this achievement belongs to</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>achievement_data</span>
+        <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The achievement data
+extracted from XML</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_achievement.rb', line 87</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_user identifier id'>user</span><span class='comma token'>,</span> <span class='rubyid_game identifier id'>game</span><span class='comma token'>,</span> <span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_@api_name ivar id'>@api_name</span>        <span class='assign token'>=</span> <span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='lbrack token'>[</span><span class='string val'>'apiname'</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@description ivar id'>@description</span>     <span class='assign token'>=</span> <span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='lbrack token'>[</span><span class='string val'>'description'</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@game ivar id'>@game</span>            <span class='assign token'>=</span> <span class='rubyid_game identifier id'>game</span>
+  <span class='rubyid_@icon_closed_url ivar id'>@icon_closed_url</span> <span class='assign token'>=</span> <span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='lbrack token'>[</span><span class='string val'>'iconClosed'</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@icon_open_url ivar id'>@icon_open_url</span>   <span class='assign token'>=</span> <span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='lbrack token'>[</span><span class='string val'>'iconOpen'</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@name ivar id'>@name</span>            <span class='assign token'>=</span> <span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='lbrack token'>[</span><span class='string val'>'name'</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@unlocked ivar id'>@unlocked</span>        <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='lbrack token'>[</span><span class='string val'>'closed'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span> <span class='eq op'>==</span> <span class='integer val'>1</span><span class='rparen token'>)</span>
+  <span class='rubyid_@user ivar id'>@user</span>            <span class='assign token'>=</span> <span class='rubyid_user identifier id'>user</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_@unlocked ivar id'>@unlocked</span> <span class='andop op'>&amp;&amp;</span> <span class='notop op'>!</span><span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='lbrack token'>[</span><span class='string val'>'unlockTimestamp'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+    <span class='rubyid_@timestamp ivar id'>@timestamp</span>  <span class='assign token'>=</span> <span class='rubyid_Time constant id'>Time</span><span class='dot token'>.</span><span class='rubyid_at identifier id'>at</span><span class='lparen token'>(</span><span class='rubyid_achievement_data identifier id'>achievement_data</span><span class='lbrack token'>[</span><span class='string val'>'unlockTimestamp'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span><span class='rparen token'>)</span>
+  <span class='rubyid_end end kw'>end</span>
+<span class='rubyid_end end 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="api_name-instance_method">
+    - (<tt>String</tt>) <strong>api_name</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the symbolic API name of this achievement</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 API name of this achievement</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_achievement.rb', line 22</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_api_name identifier id'>api_name</span>
+  <span class='rubyid_@api_name ivar id'>@api_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="description-instance_method">
+    - (<tt>String</tt>) <strong>description</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the description of this achievement</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 description of this achievement</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_achievement.rb', line 27</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_description identifier id'>description</span>
+  <span class='rubyid_@description ivar id'>@description</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="game-instance_method">
+    - (<tt>Steam</tt>) <strong>game</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Return the game this achievement belongs to</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Steam</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The game this achievement belongs to</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_achievement.rb', line 32</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_game identifier id'>game</span>
+  <span class='rubyid_@game ivar id'>@game</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="icon_closed_url-instance_method">
+    - (<tt>String</tt>) <strong>icon_closed_url</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the url for the closed icon of this achievement</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 url of the closed achievement icon</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_achievement.rb', line 37</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_icon_closed_url identifier id'>icon_closed_url</span>
+  <span class='rubyid_@icon_closed_url ivar id'>@icon_closed_url</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="icon_open_url-instance_method">
+    - (<tt>String</tt>) <strong>icon_open_url</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the url for the open icon of this achievement</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 url of the open achievement icon</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_achievement.rb', line 42</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_icon_open_url identifier id'>icon_open_url</span>
+  <span class='rubyid_@icon_open_url ivar id'>@icon_open_url</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 name of this achievement</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 achievement</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_achievement.rb', line 47</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="timestamp-instance_method">
+    - (<tt>Time</tt>) <strong>timestamp</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the time this achievement has been unlocked by its owner</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Time</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The time this achievement has been unlocked</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_achievement.rb', line 52</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_timestamp identifier id'>timestamp</span>
+  <span class='rubyid_@timestamp ivar id'>@timestamp</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="user-instance_method">
+    - (<tt>Fixnum</tt>) <strong>user</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the SteamID of the user who owns this achievement</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 SteamID of this achievement&#39;s owner</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_achievement.rb', line 57</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_user identifier id'>user</span>
+  <span class='rubyid_@user ivar id'>@user</span>
+<span class='rubyid_end end 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="global_percentages-class_method">
+    + (<tt>Hash&lt;Symbol, Float&gt;</tt>) <strong>global_percentages</strong>(app_id)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Loads the global unlock percentages of all achievements for the game with
+the given Steam Application ID</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 unique Steam Application ID of the game (e.g.
+<code>440</code> for Team Fortress 2). See
+ <a href="http://developer.valvesoftware.com/wiki/Steam_Application_IDs">http://developer.valvesoftware.com/wiki/Steam_Application_IDs</a> for
+ all application IDs</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Float&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The symbolic achievement names with their
+corresponding unlock percentages</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="WebApiError.html" title="WebApiError (class)">WebApiError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the request to Steam&#39;s Web API fails</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_achievement.rb', line 69</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_global_percentages identifier id'>global_percentages</span><span class='lparen token'>(</span><span class='rubyid_app_id identifier id'>app_id</span><span class='rparen token'>)</span>
+  <span class='rubyid_percentages identifier id'>percentages</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+  <span class='rubyid_data identifier id'>data</span> <span class='assign token'>=</span> <span class='rubyid_WebApi constant id'>WebApi</span><span class='dot token'>.</span><span class='rubyid_json identifier id'>json</span><span class='lparen token'>(</span><span class='string val'>'ISteamUserStats'</span><span class='comma token'>,</span> <span class='string val'>'GetGlobalAchievementPercentagesForApp'</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='lbrace token'>{</span> <span class='symbol val'>:gameid</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_app_id identifier id'>app_id</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
+  <span class='rubyid_MultiJson constant id'>MultiJson</span><span class='dot token'>.</span><span class='rubyid_load identifier id'>load</span><span class='lparen token'>(</span><span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='lbrace token'>{</span> <span class='symbol val'>:symbolize_keys</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span><span class='lbrack token'>[</span><span class='symbol val'>:achievementpercentages</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='symbol val'>:achievements</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_percentage identifier id'>percentage</span><span class='bitor op'>|</span>
+    <span class='rubyid_percentages identifier id'>percentages</span><span class='lbrack token'>[</span><span class='rubyid_percentage identifier id'>percentage</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_percentage identifier id'>percentage</span><span class='lbrack token'>[</span><span class='symbol val'>:percent</span><span class='rbrack token'>]</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_percentages identifier id'>percentages</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="unlocked?-instance_method">
+    - (<tt>Boolean</tt>) <strong>unlocked?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this achievement has been unlocked by its owner</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 the achievement has been unlocked by the user</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+105
+106
+107</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_achievement.rb', line 105</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_unlocked? fid id'>unlocked?</span>
+  <span class='rubyid_@unlocked ivar id'>@unlocked</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:13:12 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>