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

@@ -0,0 +1,630 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: SteamCondenser::Community::GameLeaderboardEntry
+    &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'><span class='object_link'><a href="../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Community.html" title="SteamCondenser::Community (module)">Community</a></span></span>
+     &raquo;
+    <span class="title">GameLeaderboardEntry</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: SteamCondenser::Community::GameLeaderboardEntry
+</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">SteamCondenser::Community::GameLeaderboardEntry</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam-condenser/community/game_leaderboard_entry.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>The GameLeaderboard class represents a single entry in a leaderboard</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="#leaderboard-instance_method" title="#leaderboard (instance method)">- (GameLeaderboard) <strong>leaderboard</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the leaderboard this entry belongs to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#rank-instance_method" title="#rank (instance method)">- (Fixnum) <strong>rank</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the rank where this entry is listed in the leaderboard.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#score-instance_method" title="#score (instance method)">- (Fixnum) <strong>score</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the score of this entry.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#steam_id-instance_method" title="#steam_id (instance method)">- (SteamId) <strong>steam_id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the Steam ID of this entry&#39;s player.</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)">- (GameLeaderboardEntry) <strong>initialize</strong>(entry_data, leaderboard) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates new entry instance for the given XML data and leaderboard.</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="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span></tt>) <strong>initialize</strong>(entry_data, leaderboard)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates new entry instance for the given XML data and leaderboard</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>entry_data</span>
+        <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The XML data of the leaderboard
+of the leaderboard entry</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>leaderboard</span>
+        <span class='type'>(<tt><span class='object_link'><a href="GameLeaderboard.html" title="SteamCondenser::Community::GameLeaderboard (class)">GameLeaderboard</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The leaderboard this entry belongs
+to</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+39
+40
+41
+42
+43
+44</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard_entry.rb', line 39</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_entry_data identifier id'>entry_data</span><span class='comma token'>,</span> <span class='rubyid_leaderboard identifier id'>leaderboard</span><span class='rparen token'>)</span>
+  <span class='rubyid_@steam_id ivar id'>@steam_id</span>    <span class='assign token'>=</span> <span class='rubyid_SteamId constant id'>SteamId</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_entry_data identifier id'>entry_data</span><span class='lbrack token'>[</span><span class='string val'>'steamid'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span><span class='comma token'>,</span> <span class='rubyid_false false kw'>false</span>
+  <span class='rubyid_@score ivar id'>@score</span>       <span class='assign token'>=</span> <span class='rubyid_entry_data identifier id'>entry_data</span><span class='lbrack token'>[</span><span class='string val'>'score'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+  <span class='rubyid_@rank ivar id'>@rank</span>        <span class='assign token'>=</span> <span class='rubyid_entry_data identifier id'>entry_data</span><span class='lbrack token'>[</span><span class='string val'>'rank'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+  <span class='rubyid_@leaderboard ivar id'>@leaderboard</span> <span class='assign token'>=</span> <span class='rubyid_leaderboard identifier id'>leaderboard</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="leaderboard-instance_method">
+    - (<tt><span class='object_link'><a href="GameLeaderboard.html" title="SteamCondenser::Community::GameLeaderboard (class)">GameLeaderboard</a></span></tt>) <strong>leaderboard</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the leaderboard this entry 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="GameLeaderboard.html" title="SteamCondenser::Community::GameLeaderboard (class)">GameLeaderboard</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The leaderboard of this entry</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard_entry.rb', line 31</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_leaderboard identifier id'>leaderboard</span>
+  <span class='rubyid_@leaderboard ivar id'>@leaderboard</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="rank-instance_method">
+    - (<tt>Fixnum</tt>) <strong>rank</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the rank where this entry is listed in the leaderboard</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 rank of this entry</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard_entry.rb', line 26</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rank identifier id'>rank</span>
+  <span class='rubyid_@rank ivar id'>@rank</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="score-instance_method">
+    - (<tt>Fixnum</tt>) <strong>score</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the score of this entry</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 score of this player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+21
+22
+23</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard_entry.rb', line 21</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_score identifier id'>score</span>
+  <span class='rubyid_@score ivar id'>@score</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="steam_id-instance_method">
+    - (<tt><span class='object_link'><a href="SteamId.html" title="SteamCondenser::Community::SteamId (class)">SteamId</a></span></tt>) <strong>steam_id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the Steam ID of this entry&#39;s player</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="SteamId.html" title="SteamCondenser::Community::SteamId (class)">SteamId</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The Steam ID of the player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard_entry.rb', line 16</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_steam_id identifier id'>steam_id</span>
+  <span class='rubyid_@steam_id ivar id'>@steam_id</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Aug 14 21:48:04 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>