RubyGems - steam-condenser - Versions diffs - 1.3.8.1 → 1.3.9 - Mend

steam-condenser 1.3.8.1 → 1.3.9

Files changed (476) hide show

data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4D2Map.html ADDED Viewed

@@ -0,0 +1,737 @@
+<!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::L4D2Map
+    &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 (L)</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">L4D2Map</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::L4D2Map
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="L4DMap.html" title="SteamCondenser::Community::L4DMap (class)">L4DMap</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="L4DMap.html" title="SteamCondenser::Community::L4DMap (class)">L4DMap</a></span></li>
+            <li class="next">SteamCondenser::Community::L4D2Map</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/l4d/l4d2_map.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>L4D2Map holds statistical information about maps played by a player in
+Survival mode of Left4Dead 2. The basic information provided is more or
+less the same for Left4Dead and Left4Dead 2, but parsing has to be done
+differently.</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>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="INFECTED-constant" class="">INFECTED =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The names of the special infected in Left4Dead 2</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='dstring node'>%w{boomer charger common hunter jockey smoker spitter tank}</span>
+</pre></dd>
+        <dt id="ITEMS-constant" class="">ITEMS =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The items available in Left4Dead 2</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='dstring node'>%w{adrenaline defibs medkits pills}</span>
+</pre></dd>
+    </dl>
+  <h3 class="inherited">Constants inherited
+     from <span class='object_link'><a href="L4DMap.html" title="SteamCondenser::Community::L4DMap (class)">L4DMap</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="L4DMap.html#BRONZE-constant" title="SteamCondenser::Community::L4DMap::BRONZE (constant)">SteamCondenser::Community::L4DMap::BRONZE</a></span>, <span class='object_link'><a href="L4DMap.html#GOLD-constant" title="SteamCondenser::Community::L4DMap::GOLD (constant)">SteamCondenser::Community::L4DMap::GOLD</a></span>, <span class='object_link'><a href="L4DMap.html#NONE-constant" title="SteamCondenser::Community::L4DMap::NONE (constant)">SteamCondenser::Community::L4DMap::NONE</a></span>, <span class='object_link'><a href="L4DMap.html#SILVER-constant" title="SteamCondenser::Community::L4DMap::SILVER (constant)">SteamCondenser::Community::L4DMap::SILVER</a></span></p>
+  <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="#items-instance_method" title="#items (instance method)">- (Hash&lt;Symbol, Fixnum&gt;) <strong>items</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns statistics about the items used by the player on this map.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#kills-instance_method" title="#kills (instance method)">- (Hash&lt;Symbol, Fixnum&gt;) <strong>kills</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of special infected killed by the player grouped by the names of the special infected.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#teammates-instance_method" title="#teammates (instance method)">- (Array&lt;SteamId&gt;) <strong>teammates</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the SteamIDs of the teammates of the player in his best game on this map.</p>
+</div></span>
+</li>
+  </ul>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="L4DMap.html" title="SteamCondenser::Community::L4DMap (class)">L4DMap</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="L4DMap.html#best_time-instance_method" title="SteamCondenser::Community::L4DMap#best_time (method)">#best_time</a></span>, <span class='object_link'><a href="L4DMap.html#id-instance_method" title="SteamCondenser::Community::L4DMap#id (method)">#id</a></span>, <span class='object_link'><a href="L4DMap.html#medal-instance_method" title="SteamCondenser::Community::L4DMap#medal (method)">#medal</a></span>, <span class='object_link'><a href="L4DMap.html#name-instance_method" title="SteamCondenser::Community::L4DMap#name (method)">#name</a></span>, <span class='object_link'><a href="L4DMap.html#times_played-instance_method" title="SteamCondenser::Community::L4DMap#times_played (method)">#times_played</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="#initialize-instance_method" title="#initialize (instance method)">- (L4D2Map) <strong>initialize</strong>(map_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a map based on the given XML data.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#played%3F-instance_method" title="#played? (instance method)">- (Boolean) <strong>played?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether the player has already played 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::L4D2Map (class)">L4D2Map</a></span></tt>) <strong>initialize</strong>(map_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a map based on the given XML data</p>
+<p>The map statistics for the Survival mode of Left4Dead 2 hold much more
+information than those for Left4Dead, e.g. the teammates and items are
+listed.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>map_data</span>
+        <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The XML data for this map</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/l4d/l4d2_map.rb', line 49</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_data identifier id'>map_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_@id ivar id'>@id</span>        <span class='assign token'>=</span> <span class='rubyid_map_data identifier id'>map_data</span><span class='lbrack token'>[</span><span class='string val'>'img'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/http:\/\/cdn\.steamcommunity\.com\/public\/images\/gamestats\/550\/(.*).jpg/</span><span class='rparen token'>)</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@name ivar id'>@name</span>      <span class='assign token'>=</span> <span class='rubyid_map_data identifier id'>map_data</span><span class='lbrack token'>[</span><span class='string val'>'name'</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@played ivar id'>@played</span>    <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_map_data identifier id'>map_data</span><span class='lbrack token'>[</span><span class='string val'>'hasPlayed'</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_if if kw'>if</span> <span class='rubyid_@played ivar id'>@played</span>
+    <span class='rubyid_@best_time ivar id'>@best_time</span> <span class='assign token'>=</span> <span class='rubyid_map_data identifier id'>map_data</span><span class='lbrack token'>[</span><span class='string val'>'besttimemilliseconds'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='integer val'>1000</span>
+    <span class='rubyid_@teammates ivar id'>@teammates</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+    <span class='rubyid_map_data identifier id'>map_data</span><span class='lbrack token'>[</span><span class='string val'>'teammates'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'steamID64'</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_teammate identifier id'>teammate</span><span class='bitor op'>|</span>
+      <span class='rubyid_@teammates ivar id'>@teammates</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_SteamId constant id'>SteamId</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_teammate identifier id'>teammate</span><span class='comma token'>,</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
+    <span class='rubyid_end end kw'>end</span>
+    <span class='rubyid_@items ivar id'>@items</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+    <span class='rubyid_ITEMS constant id'>ITEMS</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_item identifier id'>item</span><span class='bitor op'>|</span>
+      <span class='rubyid_@items ivar id'>@items</span><span class='lbrack token'>[</span><span class='rubyid_item identifier id'>item</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_map_data identifier id'>map_data</span><span class='lbrack token'>[</span><span class='dstring node'>&quot;items_#{item}&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_end end kw'>end</span>
+    <span class='rubyid_@kills ivar id'>@kills</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+    <span class='rubyid_INFECTED constant id'>INFECTED</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_infected identifier id'>infected</span><span class='bitor op'>|</span>
+      <span class='rubyid_@kills ivar id'>@kills</span><span class='lbrack token'>[</span><span class='rubyid_infected identifier id'>infected</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_map_data identifier id'>map_data</span><span class='lbrack token'>[</span><span class='dstring node'>&quot;kills_#{infected}&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_end end kw'>end</span>
+    <span class='rubyid_case case kw'>case</span> <span class='rubyid_map_data identifier id'>map_data</span><span class='lbrack token'>[</span><span class='string val'>'medal'</span><span class='rbrack token'>]</span>
+      <span class='rubyid_when when kw'>when</span> <span class='string val'>'gold'</span>
+        <span class='rubyid_@medal ivar id'>@medal</span> <span class='assign token'>=</span> <span class='rubyid_L4D2Map constant id'>L4D2Map</span><span class='colon2 op'>::</span><span class='rubyid_GOLD constant id'>GOLD</span>
+      <span class='rubyid_when when kw'>when</span> <span class='string val'>'silver'</span>
+        <span class='rubyid_@medal ivar id'>@medal</span> <span class='assign token'>=</span> <span class='rubyid_L4D2Map constant id'>L4D2Map</span><span class='colon2 op'>::</span><span class='rubyid_SILVER constant id'>SILVER</span>
+      <span class='rubyid_when when kw'>when</span> <span class='string val'>'bronze'</span>
+        <span class='rubyid_@medal ivar id'>@medal</span> <span class='assign token'>=</span> <span class='rubyid_L4D2Map constant id'>L4D2Map</span><span class='colon2 op'>::</span><span class='rubyid_BRONZE constant id'>BRONZE</span>
+      <span class='rubyid_else else kw'>else</span>
+        <span class='rubyid_@medal ivar id'>@medal</span> <span class='assign token'>=</span> <span class='rubyid_L4D2Map constant id'>L4D2Map</span><span class='colon2 op'>::</span><span class='rubyid_NONE constant id'>NONE</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>
+  <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="items-instance_method">
+    - (<tt>Hash&lt;Symbol, Fixnum&gt;</tt>) <strong>items</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns statistics about the items used by the player on this map</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Fixnum&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The items used by the player</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-condenser/community/l4d/l4d2_map.rb', line 22</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_items identifier id'>items</span>
+  <span class='rubyid_@items ivar id'>@items</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="kills-instance_method">
+    - (<tt>Hash&lt;Symbol, Fixnum&gt;</tt>) <strong>kills</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of special infected killed by the player grouped by
+the names of the special infected</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Fixnum&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The special infected killed by the player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+28
+29
+30</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/l4d/l4d2_map.rb', line 28</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_kills identifier id'>kills</span>
+  <span class='rubyid_@kills ivar id'>@kills</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="teammates-instance_method">
+    - (<tt>Array&lt;<span class='object_link'><a href="SteamId.html" title="SteamCondenser::Community::SteamId (class)">SteamId</a></span>&gt;</tt>) <strong>teammates</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the SteamIDs of the teammates of the player in his best game on
+this map</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="SteamId.html" title="SteamCondenser::Community::SteamId (class)">SteamId</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The SteamIDs of the teammates in the best game</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+34
+35
+36</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/l4d/l4d2_map.rb', line 34</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_teammates identifier id'>teammates</span>
+  <span class='rubyid_@teammates ivar id'>@teammates</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="played?-instance_method">
+    - (<tt>Boolean</tt>) <strong>played?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether the player has already played this map</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 player has already played this map</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+88
+89
+90</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/l4d/l4d2_map.rb', line 88</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_played? fid id'>played?</span>
+  <span class='rubyid_@played ivar id'>@played</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:54 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>