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

@@ -0,0 +1,796 @@
+<!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: DoDSWeapon
+    &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">DoDSWeapon</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: DoDSWeapon
+</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">DoDSWeapon</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="GameWeapon.html" title="GameWeapon (module)">GameWeapon</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/community/dods/dods_weapon.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Represents the stats for a Day of Defeat: Source weapon 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="#headshots-instance_method" title="#headshots (instance method)">- (Fixnum) <strong>headshots</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of headshots achieved with this weapon.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#hits-instance_method" title="#hits (instance method)">- (Fixnum) <strong>hits</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of hits achieved with this weapon.</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 weapon.</p>
+</div></span>
+</li>
+  </ul>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="GameWeapon.html" title="GameWeapon (module)">GameWeapon</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameWeapon.html#id-instance_method" title="GameWeapon#id (method)">#id</a></span>, <span class='object_link'><a href="GameWeapon.html#kills-instance_method" title="GameWeapon#kills (method)">#kills</a></span>, <span class='object_link'><a href="GameWeapon.html#shots-instance_method" title="GameWeapon#shots (method)">#shots</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="#avg_hits_per_kill-instance_method" title="#avg_hits_per_kill (instance method)">- (Float) <strong>avg_hits_per_kill</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the average number of hits needed for a kill with this weapon.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#headshot_percentage-instance_method" title="#headshot_percentage (instance method)">- (Float) <strong>headshot_percentage</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the percentage of headshots relative to the shots hit with this weapon.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#hit_percentage-instance_method" title="#hit_percentage (instance method)">- (Float) <strong>hit_percentage</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the percentage of hits relative to the shots fired with this weapon.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (DoDSWeapon) <strong>initialize</strong>(weapon_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a Day of Defeat: Source weapon based on the given XML data.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="GameWeapon.html" title="GameWeapon (module)">GameWeapon</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameWeapon.html#avg_shots_per_kill-instance_method" title="GameWeapon#avg_shots_per_kill (method)">#avg_shots_per_kill</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="DoDSWeapon (class)">DoDSWeapon</a></span></tt>) <strong>initialize</strong>(weapon_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a Day of Defeat: Source weapon 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'>weapon_data</span>
+        <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The XML data of the class</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+34
+35
+36
+37
+38
+39
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/dods/dods_weapon.rb', line 34</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_weapon_data'>weapon_data</span><span class='rparen'>)</span>
+  <span class='kw'>super</span> <span class='id identifier rubyid_weapon_data'>weapon_data</span>
+  <span class='ivar'>@headshots</span> <span class='op'>=</span> <span class='id identifier rubyid_weapon_data'>weapon_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>headshots</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
+  <span class='ivar'>@id</span>        <span class='op'>=</span> <span class='id identifier rubyid_weapon_data'>weapon_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>key</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='ivar'>@name</span>      <span class='op'>=</span> <span class='id identifier rubyid_weapon_data'>weapon_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='ivar'>@shots</span>     <span class='op'>=</span> <span class='id identifier rubyid_weapon_data'>weapon_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>shotsfired</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
+  <span class='ivar'>@hits</span>      <span class='op'>=</span> <span class='id identifier rubyid_weapon_data'>weapon_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>shotshit</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
+<span class='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="headshots-instance_method">
+    - (<tt>Fixnum</tt>) <strong>headshots</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of headshots achieved with this weapon</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 headshots achieved</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+18
+19
+20</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/dods/dods_weapon.rb', line 18</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_headshots'>headshots</span>
+  <span class='ivar'>@headshots</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="hits-instance_method">
+    - (<tt>Fixnum</tt>) <strong>hits</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of hits achieved with this weapon</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 hits achieved</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/community/dods/dods_weapon.rb', line 28</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_hits'>hits</span>
+  <span class='ivar'>@hits</span>
+<span class='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 weapon</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 weapon</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/dods/dods_weapon.rb', line 23</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
+  <span class='ivar'>@name</span>
+<span class='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="avg_hits_per_kill-instance_method">
+    - (<tt>Float</tt>) <strong>avg_hits_per_kill</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the average number of hits needed for a kill with this weapon</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 average number of hits needed for a kill</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/dods/dods_weapon.rb', line 47</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_avg_hits_per_kill'>avg_hits_per_kill</span>
+  <span class='ivar'>@hits</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span> <span class='op'>/</span> <span class='ivar'>@kill</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="headshot_percentage-instance_method">
+    - (<tt>Float</tt>) <strong>headshot_percentage</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the percentage of headshots relative to the shots hit with this
+weapon</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 headshots</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+55
+56
+57</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/dods/dods_weapon.rb', line 55</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_headshot_percentage'>headshot_percentage</span>
+  <span class='ivar'>@headshots</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span> <span class='op'>/</span> <span class='ivar'>@hits</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="hit_percentage-instance_method">
+    - (<tt>Float</tt>) <strong>hit_percentage</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the percentage of hits relative to the shots fired with this
+weapon</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 hits</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+63
+64
+65</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/dods/dods_weapon.rb', line 63</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_hit_percentage'>hit_percentage</span>
+  <span class='ivar'>@hits</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span> <span class='op'>/</span> <span class='ivar'>@shots</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Sun Oct 27 11:01:22 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.1 (ruby-2.0.0).
+</div>
+  </body>
+</html>