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

steam-condenser 1.3.7 → 1.3.8

Files changed (883) hide show

data/pkg/steam-condenser-1.3.7/doc/SteamCondenser/Community/CSSMap.html ADDED Viewed

@@ -0,0 +1,805 @@
+<!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::CSSMap
+    &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 (C)</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">CSSMap</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::CSSMap
+</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::CSSMap</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/css/css_map.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Represents the stats for a Counter-Strike: Source map for a specific user</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the name of this map.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#rounds_lost-instance_method" title="#rounds_lost (instance method)">- (Fixnum) <strong>rounds_lost</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of rounds the player has lost on this map.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#rounds_played-instance_method" title="#rounds_played (instance method)">- (Fixnum) <strong>rounds_played</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of rounds the player has played on this map.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#rounds_won-instance_method" title="#rounds_won (instance method)">- (Fixnum) <strong>rounds_won</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of rounds the player has won on this map.</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="#favorite%3F-instance_method" title="#favorite? (instance method)">- (Boolean) <strong>favorite?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this map is the favorite map of this player.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (CSSMap) <strong>initialize</strong>(map_name, maps_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a Counter-Strike: Source class based on the given XML data.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#rounds_won_percentage-instance_method" title="#rounds_won_percentage (instance method)">- (Float) <strong>rounds_won_percentage</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the percentage of rounds the player has won on this map.</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::CSSMap (class)">CSSMap</a></span></tt>) <strong>initialize</strong>(map_name, maps_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a Counter-Strike: Source class based on the
+given XML data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>map_name</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The name of the map</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>maps_data</span>
+        <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The XML data of all maps</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/css/css_map.rb', line 38</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_map_name identifier id'>map_name</span><span class='comma token'>,</span> <span class='rubyid_maps_data identifier id'>maps_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_@name ivar id'>@name</span> <span class='assign token'>=</span> <span class='rubyid_map_name identifier id'>map_name</span>
+  <span class='rubyid_@favorite ivar id'>@favorite</span>      <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_maps_data identifier id'>maps_data</span><span class='lbrack token'>[</span><span class='string val'>'favorite'</span><span class='rbrack token'>]</span> <span class='eq op'>==</span> <span class='rubyid_@name ivar id'>@name</span><span class='rparen token'>)</span>
+  <span class='rubyid_@rounds_played ivar id'>@rounds_played</span> <span class='assign token'>=</span> <span class='rubyid_maps_data identifier id'>maps_data</span><span class='lbrack token'>[</span><span class='dstring node'>&quot;#{@name}_rounds&quot;</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+  <span class='rubyid_@rounds_won ivar id'>@rounds_won</span>    <span class='assign token'>=</span> <span class='rubyid_maps_data identifier id'>maps_data</span><span class='lbrack token'>[</span><span class='dstring node'>&quot;#{@name}_wins&quot;</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+  <span class='rubyid_@rounds_lost ivar id'>@rounds_lost</span> <span class='assign token'>=</span> <span class='rubyid_@rounds_played ivar id'>@rounds_played</span> <span class='minus op'>-</span> <span class='rubyid_@rounds_won ivar id'>@rounds_won</span>
+  <span class='rubyid_@rounds_won_percentage ivar id'>@rounds_won_percentage</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_@rounds_played ivar id'>@rounds_played</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='rubyid_@rounds_won ivar id'>@rounds_won</span><span class='dot token'>.</span><span class='rubyid_to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='rubyid_@rounds_played ivar id'>@rounds_played</span> <span class='colon op'>:</span> <span class='integer val'>0</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="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 map</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 map</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/css/css_map.rb', line 16</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="rounds_lost-instance_method">
+    - (<tt>Fixnum</tt>) <strong>rounds_lost</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of rounds the player has lost on this map</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The number of rounds lost</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/css/css_map.rb', line 21</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rounds_lost identifier id'>rounds_lost</span>
+  <span class='rubyid_@rounds_lost ivar id'>@rounds_lost</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="rounds_played-instance_method">
+    - (<tt>Fixnum</tt>) <strong>rounds_played</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of rounds the player has played on this map</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The number of rounds played</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/css/css_map.rb', line 26</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rounds_played identifier id'>rounds_played</span>
+  <span class='rubyid_@rounds_played ivar id'>@rounds_played</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="rounds_won-instance_method">
+    - (<tt>Fixnum</tt>) <strong>rounds_won</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of rounds the player has won on this map</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The number of rounds won</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/css/css_map.rb', line 31</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rounds_won identifier id'>rounds_won</span>
+  <span class='rubyid_@rounds_won ivar id'>@rounds_won</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="favorite?-instance_method">
+    - (<tt>Boolean</tt>) <strong>favorite?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this map is the favorite map of this player</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 is the favorite map</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-condenser/community/css/css_map.rb', line 52</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_favorite? fid id'>favorite?</span>
+  <span class='rubyid_@favorite ivar id'>@favorite</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rounds_won_percentage-instance_method">
+    - (<tt>Float</tt>) <strong>rounds_won_percentage</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the percentage of rounds the player has won on this map</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Float</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The percentage of rounds won</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+59
+60
+61</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/css/css_map.rb', line 59</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rounds_won_percentage identifier id'>rounds_won_percentage</span>
+  <span class='lparen token'>(</span><span class='rubyid_@rounds_played ivar id'>@rounds_played</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='rubyid_@rounds_won ivar id'>@rounds_won</span><span class='dot token'>.</span><span class='rubyid_to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='rubyid_@rounds_played ivar id'>@rounds_played</span> <span class='colon op'>:</span> <span class='integer val'>0</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:47:53 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>