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

@@ -0,0 +1,1764 @@
+<!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::Servers::SteamPlayer
+    &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 (S)</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="../Servers.html" title="SteamCondenser::Servers (module)">Servers</a></span></span>
+     &raquo;
+    <span class="title">SteamPlayer</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::Servers::SteamPlayer
+</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::Servers::SteamPlayer</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam-condenser/servers/steam_player.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>The SteamPlayer class represents a player connected to a server</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="#client_port-instance_method" title="#client_port (instance method)">- (Fixnum) <strong>client_port</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the client port of this player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#connect_time-instance_method" title="#connect_time (instance method)">- (Float) <strong>connect_time</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the time this player is connected to the server.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#id-instance_method" title="#id (instance method)">- (Fixnum) <strong>id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the ID of this player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#ip_address-instance_method" title="#ip_address (instance method)">- (String) <strong>ip_address</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the IP address of this player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#loss-instance_method" title="#loss (instance method)">- (String) <strong>loss</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the packet loss of this player&#39;s connection.</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 nickname of this player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#ping-instance_method" title="#ping (instance method)">- (Fixnum) <strong>ping</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the ping of this player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#rate-instance_method" title="#rate (instance method)">- (Fixnum) <strong>rate</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the rate of this player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#real_id-instance_method" title="#real_id (instance method)">- (Fixnum) <strong>real_id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the real ID (as used on the server) of this player.</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 player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#state-instance_method" title="#state (instance method)">- (String) <strong>state</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the connection state of this player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#steam_id-instance_method" title="#steam_id (instance method)">- (String) <strong>steam_id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the SteamID of this 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="#add_info-instance_method" title="#add_info (instance method)">- (Object) <strong>add_info</strong>(player_data) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Extends a player object with information retrieved from a RCON call to the status command.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#bot%3F-instance_method" title="#bot? (instance method)">- (Boolean) <strong>bot?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this player is a bot.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#extended%3F-instance_method" title="#extended? (instance method)">- (Boolean) <strong>extended?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this player object has extended information gathered using RCON.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (SteamPlayer) <strong>initialize</strong>(id, name, score, connect_time) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new player instance with the given information.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#to_s-instance_method" title="#to_s (instance method)">- (String) <strong>to_s</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns a string representation of this player.</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::Servers::SteamPlayer (class)">SteamPlayer</a></span></tt>) <strong>initialize</strong>(id, name, score, connect_time)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new player instance with the given information</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>id</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The ID of the player on the server</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>name</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The name of the player</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>score</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The score of the player</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>connect_time</span>
+        <span class='type'>(<tt>Float</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The time the player is connected to the
+server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+82
+83
+84
+85
+86
+87
+88</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 82</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_id identifier id'>id</span><span class='comma token'>,</span> <span class='rubyid_name identifier id'>name</span><span class='comma token'>,</span> <span class='rubyid_score identifier id'>score</span><span class='comma token'>,</span> <span class='rubyid_connect_time identifier id'>connect_time</span><span class='rparen token'>)</span>
+  <span class='rubyid_@connect_time ivar id'>@connect_time</span> <span class='assign token'>=</span> <span class='rubyid_connect_time identifier id'>connect_time</span>
+  <span class='rubyid_@id ivar id'>@id</span> <span class='assign token'>=</span> <span class='rubyid_id identifier id'>id</span>
+  <span class='rubyid_@name ivar id'>@name</span> <span class='assign token'>=</span> <span class='rubyid_name identifier id'>name</span>
+  <span class='rubyid_@score ivar id'>@score</span> <span class='assign token'>=</span> <span class='rubyid_score identifier id'>score</span>
+  <span class='rubyid_@extended ivar id'>@extended</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</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="client_port-instance_method">
+    - (<tt>Fixnum</tt>) <strong>client_port</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the client port of this player</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 client port of the player</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-condenser/servers/steam_player.rb', line 18</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_client_port identifier id'>client_port</span>
+  <span class='rubyid_@client_port ivar id'>@client_port</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="connect_time-instance_method">
+    - (<tt>Float</tt>) <strong>connect_time</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the time this player is connected to the server</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 connection time of the player</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-condenser/servers/steam_player.rb', line 23</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_connect_time identifier id'>connect_time</span>
+  <span class='rubyid_@connect_time ivar id'>@connect_time</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="id-instance_method">
+    - (<tt>Fixnum</tt>) <strong>id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the ID of this player</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 ID of this 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/servers/steam_player.rb', line 28</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_id identifier id'>id</span>
+  <span class='rubyid_@id ivar id'>@id</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="ip_address-instance_method">
+    - (<tt>String</tt>) <strong>ip_address</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the IP address of this player</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 IP address of this player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+33
+34
+35</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 33</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_ip_address identifier id'>ip_address</span>
+  <span class='rubyid_@ip_address ivar id'>@ip_address</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="loss-instance_method">
+    - (<tt>String</tt>) <strong>loss</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the packet loss of this player&#39;s connection</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 packet loss of this player&#39;s connection</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+43
+44
+45</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 43</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_loss identifier id'>loss</span>
+  <span class='rubyid_@loss ivar id'>@loss</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 nickname of this player</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 player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+38
+39
+40</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 38</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="ping-instance_method">
+    - (<tt>Fixnum</tt>) <strong>ping</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the ping of this player</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 ping of this player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+48
+49
+50</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 48</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_ping identifier id'>ping</span>
+  <span class='rubyid_@ping ivar id'>@ping</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="rate-instance_method">
+    - (<tt>Fixnum</tt>) <strong>rate</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the rate of this player</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 rate of this player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+53
+54
+55</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 53</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rate identifier id'>rate</span>
+  <span class='rubyid_@rate ivar id'>@rate</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="real_id-instance_method">
+    - (<tt>Fixnum</tt>) <strong>real_id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the real ID (as used on the server) of this player</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 real ID of this player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+58
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 58</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_real_id identifier id'>real_id</span>
+  <span class='rubyid_@real_id ivar id'>@real_id</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 player</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">
+63
+64
+65</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 63</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="state-instance_method">
+    - (<tt>String</tt>) <strong>state</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the connection state of this player</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 connection state of this player</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/servers/steam_player.rb', line 68</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_state identifier id'>state</span>
+  <span class='rubyid_@state ivar id'>@state</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>String</tt>) <strong>steam_id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the SteamID of this player</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 SteamID of this player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+73
+74
+75</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 73</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 id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="add_info-instance_method">
+    - (<tt>Object</tt>) <strong>add_info</strong>(player_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Extends a player object with information retrieved from a RCON call to
+the status command</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>player_data</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The player data retrieved from <code>rcon status</code></p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">Error</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the information belongs to another player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 95</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_add_info identifier id'>add_info</span><span class='lparen token'>(</span><span class='rubyid_player_data identifier id'>player_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_unless unless kw'>unless</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span> <span class='eq op'>==</span> <span class='rubyid_@name ivar id'>@name</span>
+    <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span> <span class='string val'>'Information to add belongs to a different player.'</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_@extended ivar id'>@extended</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span>
+  <span class='rubyid_@real_id ivar id'>@real_id</span>  <span class='assign token'>=</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='symbol val'>:userid</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+  <span class='rubyid_@steam_id ivar id'>@steam_id</span> <span class='assign token'>=</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='symbol val'>:uniqueid</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@state ivar id'>@state</span>    <span class='assign token'>=</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='symbol val'>:state</span><span class='rbrack token'>]</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='dot token'>.</span><span class='rubyid_key? fid id'>key?</span> <span class='symbol val'>:state</span>
+  <span class='rubyid_if if kw'>if</span> <span class='notop op'>!</span><span class='rubyid_bot? fid id'>bot?</span>
+    <span class='rubyid_@loss ivar id'>@loss</span> <span class='assign token'>=</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='symbol val'>:loss</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+    <span class='rubyid_@ping ivar id'>@ping</span> <span class='assign token'>=</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='symbol val'>:ping</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_player_data identifier id'>player_data</span><span class='dot token'>.</span><span class='rubyid_key? fid id'>key?</span> <span class='colon op'>:</span><span class='rubyid_adr identifier id'>adr</span>
+      <span class='rubyid_@ip_address ivar id'>@ip_address</span><span class='comma token'>,</span> <span class='rubyid_@client_port ivar id'>@client_port</span>  <span class='assign token'>=</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='symbol val'>:adr</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>':'</span><span class='rparen token'>)</span>
+      <span class='rubyid_@client_port ivar id'>@client_port</span> <span class='assign token'>=</span> <span class='rubyid_@client_port ivar id'>@client_port</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_@rate ivar id'>@rate</span>  <span class='assign token'>=</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='symbol val'>:rate</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_mod kw'>if</span> <span class='rubyid_player_data identifier id'>player_data</span><span class='dot token'>.</span><span class='rubyid_key? fid id'>key?</span> <span class='symbol val'>:rate</span>
+  <span class='rubyid_end end kw'>end</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="bot?-instance_method">
+    - (<tt>Boolean</tt>) <strong>bot?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this player is a bot</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>bool <code>true</code> if this player is a bot</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+122
+123
+124</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 122</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_bot? fid id'>bot?</span>
+  <span class='rubyid_@steam_id ivar id'>@steam_id</span> <span class='eq op'>==</span> <span class='string val'>'BOT'</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="extended?-instance_method">
+    - (<tt>Boolean</tt>) <strong>extended?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this player object has extended information gathered
+using RCON</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>bool <code>true</code> if extended information for this player is available</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+130
+131
+132</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 130</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_extended? fid id'>extended?</span>
+  <span class='rubyid_@extended ivar id'>@extended</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="to_s-instance_method">
+    - (<tt>String</tt>) <strong>to_s</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a string representation of this player</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>A string representing this player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+137
+138
+139
+140
+141
+142
+143</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/steam_player.rb', line 137</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_to_s identifier id'>to_s</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_@extended ivar id'>@extended</span>
+    <span class='string val'>&quot;\##@real_id \&quot;#@name\&quot;, SteamID: #@steam_id, Score: #@score, Time: #@connect_time&quot;</span>
+  <span class='rubyid_else else kw'>else</span>
+    <span class='string val'>&quot;\##@id \&quot;#@name\&quot;, Score: #@score, Time: #@connect_time&quot;</span>
+  <span class='rubyid_end end kw'>end</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:50 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>