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

@@ -0,0 +1,889 @@
+<!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::CSSWeapon
+    &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">CSSWeapon</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::CSSWeapon
+</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::CSSWeapon</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_weapon.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 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="#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="#kills-instance_method" title="#kills (instance method)">- (Fixnum) <strong>kills</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of kills 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>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#shots-instance_method" title="#shots (instance method)">- (Fixnum) <strong>shots</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the number of shots fired with this weapon.</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="#accuracy-instance_method" title="#accuracy (instance method)">- (Float) <strong>accuracy</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the accuracy of this player with this weapon.</p>
+</div></span>
+</li>
+        <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 weapon is the favorite weapon of this player.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (CSSWeapon) <strong>initialize</strong>(weapon_name, weapons_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 weapon based on the given XML data.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#ksratio-instance_method" title="#ksratio (instance method)">- (Float) <strong>ksratio</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the kill-shot-ratio of this player with this weapon.</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::CSSWeapon (class)">CSSWeapon</a></span></tt>) <strong>initialize</strong>(weapon_name, weapons_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a Counter-Strike: 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_name</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The name of the weapon</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>weapons_data</span>
+        <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The XML data of all weapons</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/css/css_weapon.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_weapon_name identifier id'>weapon_name</span><span class='comma token'>,</span> <span class='rubyid_weapons_data identifier id'>weapons_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_@name ivar id'>@name</span> <span class='assign token'>=</span> <span class='rubyid_weapon_name identifier id'>weapon_name</span>
+  <span class='rubyid_@favorite ivar id'>@favorite</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_weapons_data identifier id'>weapons_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_@kills ivar id'>@kills</span>    <span class='assign token'>=</span> <span class='rubyid_weapons_data identifier id'>weapons_data</span><span class='lbrack token'>[</span><span class='dstring node'>&quot;#{@name}_kills&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_if if kw'>if</span> <span class='rubyid_@name ivar id'>@name</span> <span class='neq op'>!=</span> <span class='string val'>'grenade'</span> <span class='andop op'>&amp;&amp;</span> <span class='rubyid_@name ivar id'>@name</span> <span class='neq op'>!=</span> <span class='string val'>'knife'</span>
+    <span class='rubyid_@hits ivar id'>@hits</span>  <span class='assign token'>=</span> <span class='rubyid_weapons_data identifier id'>weapons_data</span><span class='lbrack token'>[</span><span class='dstring node'>&quot;#{@name}_hits&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_@shots ivar id'>@shots</span> <span class='assign token'>=</span> <span class='rubyid_weapons_data identifier id'>weapons_data</span><span class='lbrack token'>[</span><span class='dstring node'>&quot;#{@name}_shots&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_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="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">
+17
+18
+19</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/css/css_weapon.rb', line 17</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_hits identifier id'>hits</span>
+  <span class='rubyid_@hits ivar id'>@hits</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>Fixnum</tt>) <strong>kills</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of kills 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 kills achieved</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-condenser/community/css/css_weapon.rb', line 27</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="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">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/css/css_weapon.rb', line 22</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="shots-instance_method">
+    - (<tt>Fixnum</tt>) <strong>shots</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the number of 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>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The number of shots fired</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-condenser/community/css/css_weapon.rb', line 32</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_shots identifier id'>shots</span>
+  <span class='rubyid_@shots ivar id'>@shots</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="accuracy-instance_method">
+    - (<tt>Float</tt>) <strong>accuracy</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the accuracy of this player 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 accuracy with this weapon</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+54
+55
+56</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/css/css_weapon.rb', line 54</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_accuracy identifier id'>accuracy</span>
+  <span class='lparen token'>(</span><span class='rubyid_@shots ivar id'>@shots</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_@hits ivar id'>@hits</span><span class='dot token'>.</span><span class='rubyid_to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='rubyid_@shots ivar id'>@shots</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 class="method_details ">
+  <h3 class="signature " id="favorite?-instance_method">
+    - (<tt>Boolean</tt>) <strong>favorite?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this weapon is the favorite weapon 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 weapon</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+61
+62
+63</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/css/css_weapon.rb', line 61</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="ksratio-instance_method">
+    - (<tt>Float</tt>) <strong>ksratio</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the kill-shot-ratio of this player 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 kill-shot-ratio</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+68
+69
+70</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/css/css_weapon.rb', line 68</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_ksratio identifier id'>ksratio</span>
+  <span class='lparen token'>(</span><span class='rubyid_@shots ivar id'>@shots</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_@kills ivar id'>@kills</span><span class='dot token'>.</span><span class='rubyid_to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='rubyid_@shots ivar id'>@shots</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:56 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>