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

@@ -0,0 +1,417 @@
+<!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: S2A_PLAYER_Packet
+    &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">S2A_PLAYER_Packet</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: S2A_PLAYER_Packet
+</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">S2A_PLAYER_Packet</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/packets/s2a_player_packet.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class represents a S2A_PLAYER response sent by a game server</p>
+<p>It is used to transfer a list of players currently playing on the server.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li>GameServer#update_player_info</li>
+  </ul>
+<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>
+  <h2>Constant Summary</h2>
+  <h3 class="inherited">Constants included
+     from <span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="SteamPacket.html#A2M_GET_SERVERS_BATCH2_HEADER-constant" title="SteamPacket::A2M_GET_SERVERS_BATCH2_HEADER (constant)">SteamPacket::A2M_GET_SERVERS_BATCH2_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#A2S_INFO_HEADER-constant" title="SteamPacket::A2S_INFO_HEADER (constant)">SteamPacket::A2S_INFO_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#A2S_PLAYER_HEADER-constant" title="SteamPacket::A2S_PLAYER_HEADER (constant)">SteamPacket::A2S_PLAYER_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#A2S_RULES_HEADER-constant" title="SteamPacket::A2S_RULES_HEADER (constant)">SteamPacket::A2S_RULES_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#A2S_SERVERQUERY_GETCHALLENGE_HEADER-constant" title="SteamPacket::A2S_SERVERQUERY_GETCHALLENGE_HEADER (constant)">SteamPacket::A2S_SERVERQUERY_GETCHALLENGE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#C2M_CHECKMD5_HEADER-constant" title="SteamPacket::C2M_CHECKMD5_HEADER (constant)">SteamPacket::C2M_CHECKMD5_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#M2A_SERVER_BATCH_HEADER-constant" title="SteamPacket::M2A_SERVER_BATCH_HEADER (constant)">SteamPacket::M2A_SERVER_BATCH_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#M2C_ISVALIDMD5_HEADER-constant" title="SteamPacket::M2C_ISVALIDMD5_HEADER (constant)">SteamPacket::M2C_ISVALIDMD5_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#M2S_REQUESTRESTART_HEADER-constant" title="SteamPacket::M2S_REQUESTRESTART_HEADER (constant)">SteamPacket::M2S_REQUESTRESTART_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#RCON_GOLDSRC_CHALLENGE_HEADER-constant" title="SteamPacket::RCON_GOLDSRC_CHALLENGE_HEADER (constant)">SteamPacket::RCON_GOLDSRC_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#RCON_GOLDSRC_NO_CHALLENGE_HEADER-constant" title="SteamPacket::RCON_GOLDSRC_NO_CHALLENGE_HEADER (constant)">SteamPacket::RCON_GOLDSRC_NO_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#RCON_GOLDSRC_RESPONSE_HEADER-constant" title="SteamPacket::RCON_GOLDSRC_RESPONSE_HEADER (constant)">SteamPacket::RCON_GOLDSRC_RESPONSE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_INFO2_HEADER-constant" title="SteamPacket::S2A_INFO2_HEADER (constant)">SteamPacket::S2A_INFO2_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_INFO_DETAILED_HEADER-constant" title="SteamPacket::S2A_INFO_DETAILED_HEADER (constant)">SteamPacket::S2A_INFO_DETAILED_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_LOGSTRING_HEADER-constant" title="SteamPacket::S2A_LOGSTRING_HEADER (constant)">SteamPacket::S2A_LOGSTRING_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_PLAYER_HEADER-constant" title="SteamPacket::S2A_PLAYER_HEADER (constant)">SteamPacket::S2A_PLAYER_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_RULES_HEADER-constant" title="SteamPacket::S2A_RULES_HEADER (constant)">SteamPacket::S2A_RULES_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2C_CHALLENGE_HEADER-constant" title="SteamPacket::S2C_CHALLENGE_HEADER (constant)">SteamPacket::S2C_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2C_CONNREJECT_HEADER-constant" title="SteamPacket::S2C_CONNREJECT_HEADER (constant)">SteamPacket::S2C_CONNREJECT_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2M_HEARTBEAT2_HEADER-constant" title="SteamPacket::S2M_HEARTBEAT2_HEADER (constant)">SteamPacket::S2M_HEARTBEAT2_HEADER</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="#player_hash-instance_method" title="#player_hash (instance method)">- (Hash&lt;String, SteamPlayer&gt;) <strong>player_hash</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of active players provided by the server.</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="#initialize-instance_method" title="#initialize (instance method)">- (S2A_PLAYER_Packet) <strong>initialize</strong>(content_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new S2A_PLAYER response object based on the given data.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="SteamPacket.html#to_s-instance_method" title="SteamPacket#to_s (method)">#to_s</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="S2A_PLAYER_Packet (class)">S2A_PLAYER_Packet</a></span></tt>) <strong>initialize</strong>(content_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new S2A_PLAYER response object based on the given data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>content_data</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The raw packet data sent by the server</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="PacketFormatError.html" title="PacketFormatError (class)">PacketFormatError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the packet data is not well formatted</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/packets/s2a_player_packet.rb', line 28</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_content_data identifier id'>content_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_content_data identifier id'>content_data</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+    <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_PacketFormatError constant id'>PacketFormatError</span><span class='comma token'>,</span> <span class='string val'>'Wrong formatted S2A_PLAYER packet.'</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_super super kw'>super</span> <span class='rubyid_S2A_PLAYER_HEADER constant id'>S2A_PLAYER_HEADER</span><span class='comma token'>,</span> <span class='rubyid_content_data identifier id'>content_data</span>
+  <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_byte identifier id'>byte</span>
+  <span class='rubyid_@player_hash ivar id'>@player_hash</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+  <span class='rubyid_while while kw'>while</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_remaining identifier id'>remaining</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+    <span class='rubyid_player_data identifier id'>player_data</span> <span class='assign token'>=</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_byte identifier id'>byte</span><span class='comma token'>,</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_cstring identifier id'>cstring</span><span class='comma token'>,</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_signed_long identifier id'>signed_long</span><span class='comma token'>,</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_float identifier id'>float</span>
+    <span class='rubyid_@player_hash ivar id'>@player_hash</span><span class='lbrack token'>[</span><span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_SteamPlayer constant id'>SteamPlayer</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='rubyid_player_data identifier id'>player_data</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='dot2 op'>..</span><span class='integer val'>3</span><span class='rbrack token'>]</span><span class='rparen token'>)</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="player_hash-instance_method">
+    - (<tt>Hash&lt;String, <span class='object_link'><a href="SteamPlayer.html" title="SteamPlayer (class)">SteamPlayer</a></span>&gt;</tt>) <strong>player_hash</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the list of active players provided by the server</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;String, <span class='object_link'><a href="SteamPlayer.html" title="SteamPlayer (class)">SteamPlayer</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>All active players on the server</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/packets/s2a_player_packet.rb', line 22</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_player_hash identifier id'>player_hash</span>
+  <span class='rubyid_@player_hash ivar id'>@player_hash</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:13:09 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>

data/doc/S2A_RULES_Packet.html ADDED Viewed

@@ -0,0 +1,411 @@
+<!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: S2A_RULES_Packet
+    &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">S2A_RULES_Packet</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: S2A_RULES_Packet
+</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">S2A_RULES_Packet</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/packets/s2a_rules_packet.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class represents a S2A_RULES response sent by a game server</p>
+<p>It is used to transfer a list of server rules (a.k.a. CVARs) with their
+active values.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li>GameServer#update_rules_info</li>
+  </ul>
+<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>
+  <h2>Constant Summary</h2>
+  <h3 class="inherited">Constants included
+     from <span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="SteamPacket.html#A2M_GET_SERVERS_BATCH2_HEADER-constant" title="SteamPacket::A2M_GET_SERVERS_BATCH2_HEADER (constant)">SteamPacket::A2M_GET_SERVERS_BATCH2_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#A2S_INFO_HEADER-constant" title="SteamPacket::A2S_INFO_HEADER (constant)">SteamPacket::A2S_INFO_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#A2S_PLAYER_HEADER-constant" title="SteamPacket::A2S_PLAYER_HEADER (constant)">SteamPacket::A2S_PLAYER_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#A2S_RULES_HEADER-constant" title="SteamPacket::A2S_RULES_HEADER (constant)">SteamPacket::A2S_RULES_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#A2S_SERVERQUERY_GETCHALLENGE_HEADER-constant" title="SteamPacket::A2S_SERVERQUERY_GETCHALLENGE_HEADER (constant)">SteamPacket::A2S_SERVERQUERY_GETCHALLENGE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#C2M_CHECKMD5_HEADER-constant" title="SteamPacket::C2M_CHECKMD5_HEADER (constant)">SteamPacket::C2M_CHECKMD5_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#M2A_SERVER_BATCH_HEADER-constant" title="SteamPacket::M2A_SERVER_BATCH_HEADER (constant)">SteamPacket::M2A_SERVER_BATCH_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#M2C_ISVALIDMD5_HEADER-constant" title="SteamPacket::M2C_ISVALIDMD5_HEADER (constant)">SteamPacket::M2C_ISVALIDMD5_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#M2S_REQUESTRESTART_HEADER-constant" title="SteamPacket::M2S_REQUESTRESTART_HEADER (constant)">SteamPacket::M2S_REQUESTRESTART_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#RCON_GOLDSRC_CHALLENGE_HEADER-constant" title="SteamPacket::RCON_GOLDSRC_CHALLENGE_HEADER (constant)">SteamPacket::RCON_GOLDSRC_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#RCON_GOLDSRC_NO_CHALLENGE_HEADER-constant" title="SteamPacket::RCON_GOLDSRC_NO_CHALLENGE_HEADER (constant)">SteamPacket::RCON_GOLDSRC_NO_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#RCON_GOLDSRC_RESPONSE_HEADER-constant" title="SteamPacket::RCON_GOLDSRC_RESPONSE_HEADER (constant)">SteamPacket::RCON_GOLDSRC_RESPONSE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_INFO2_HEADER-constant" title="SteamPacket::S2A_INFO2_HEADER (constant)">SteamPacket::S2A_INFO2_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_INFO_DETAILED_HEADER-constant" title="SteamPacket::S2A_INFO_DETAILED_HEADER (constant)">SteamPacket::S2A_INFO_DETAILED_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_LOGSTRING_HEADER-constant" title="SteamPacket::S2A_LOGSTRING_HEADER (constant)">SteamPacket::S2A_LOGSTRING_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_PLAYER_HEADER-constant" title="SteamPacket::S2A_PLAYER_HEADER (constant)">SteamPacket::S2A_PLAYER_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2A_RULES_HEADER-constant" title="SteamPacket::S2A_RULES_HEADER (constant)">SteamPacket::S2A_RULES_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2C_CHALLENGE_HEADER-constant" title="SteamPacket::S2C_CHALLENGE_HEADER (constant)">SteamPacket::S2C_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2C_CONNREJECT_HEADER-constant" title="SteamPacket::S2C_CONNREJECT_HEADER (constant)">SteamPacket::S2C_CONNREJECT_HEADER</a></span>, <span class='object_link'><a href="SteamPacket.html#S2M_HEARTBEAT2_HEADER-constant" title="SteamPacket::S2M_HEARTBEAT2_HEADER (constant)">SteamPacket::S2M_HEARTBEAT2_HEADER</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="#rules_hash-instance_method" title="#rules_hash (instance method)">- (Hash&lt;String, String&gt;) <strong>rules_hash</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of server rules (a.k.a. CVars) with the current values.</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="#initialize-instance_method" title="#initialize (instance method)">- (S2A_RULES_Packet) <strong>initialize</strong>(content_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new S2A_RULES response object based on the given data.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="SteamPacket.html#to_s-instance_method" title="SteamPacket#to_s (method)">#to_s</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="S2A_RULES_Packet (class)">S2A_RULES_Packet</a></span></tt>) <strong>initialize</strong>(content_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new S2A_RULES response object based on the given data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>content_data</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The raw packet data sent by the server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/packets/s2a_rules_packet.rb', line 27</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_content_data identifier id'>content_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_content_data identifier id'>content_data</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+    <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_PacketFormatError constant id'>PacketFormatError</span><span class='comma token'>,</span> <span class='string val'>'Wrong formatted S2A_RULES response packet.'</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_super super kw'>super</span> <span class='rubyid_SteamPacket constant id'>SteamPacket</span><span class='colon2 op'>::</span><span class='rubyid_S2A_RULES_HEADER constant id'>S2A_RULES_HEADER</span><span class='comma token'>,</span> <span class='rubyid_content_data identifier id'>content_data</span>
+  <span class='rubyid_rules_count identifier id'>rules_count</span> <span class='assign token'>=</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_short identifier id'>short</span>
+  <span class='rubyid_@rules_hash ivar id'>@rules_hash</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+  <span class='rubyid_rules_count identifier id'>rules_count</span><span class='dot token'>.</span><span class='rubyid_times identifier id'>times</span> <span class='rubyid_do do kw'>do</span>
+    <span class='rubyid_rule identifier id'>rule</span>  <span class='assign token'>=</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_cstring identifier id'>cstring</span>
+    <span class='rubyid_value identifier id'>value</span> <span class='assign token'>=</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_cstring identifier id'>cstring</span>
+    <span class='rubyid_break break kw'>break</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_rule identifier id'>rule</span><span class='dot token'>.</span><span class='rubyid_empty? fid id'>empty?</span>
+    <span class='rubyid_@rules_hash ivar id'>@rules_hash</span><span class='lbrack token'>[</span><span class='rubyid_rule identifier id'>rule</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_value identifier id'>value</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="rules_hash-instance_method">
+    - (<tt>Hash&lt;String, String&gt;</tt>) <strong>rules_hash</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the list of server rules (a.k.a. CVars) with the current values</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;String, String&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of server rules</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/packets/s2a_rules_packet.rb', line 22</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rules_hash identifier id'>rules_hash</span>
+  <span class='rubyid_@rules_hash ivar id'>@rules_hash</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:13:07 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>