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

@@ -0,0 +1,603 @@
+<!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::Portal2Item
+    &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 (P)</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">Portal2Item</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::Portal2Item
+</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::Portal2Item</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="GameItem.html" title="SteamCondenser::Community::GameItem (module)">GameItem</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/community/portal2/portal2_item.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Represents a Portal 2 item</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="BOTS-constant" class="">BOTS =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The names of the bots available in Portal 2</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='lbrack token'>[</span> <span class='symbol val'>:pbody</span><span class='comma token'>,</span> <span class='symbol val'>:atlas</span> <span class='rbrack token'>]</span>
+</pre></dd>
+    </dl>
+  <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="#slot-instance_method" title="#slot (instance method)">- (String<sup>?</sup>) <strong>slot</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the slot where this item can be equipped in or <code>nil</code> if this item cannot be equipped.</p>
+</div></span>
+</li>
+  </ul>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="GameItem.html" title="SteamCondenser::Community::GameItem (module)">GameItem</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameItem.html#attributes-instance_method" title="SteamCondenser::Community::GameItem#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="GameItem.html#backpack_position-instance_method" title="SteamCondenser::Community::GameItem#backpack_position (method)">#backpack_position</a></span>, <span class='object_link'><a href="GameItem.html#count-instance_method" title="SteamCondenser::Community::GameItem#count (method)">#count</a></span>, <span class='object_link'><a href="GameItem.html#defindex-instance_method" title="SteamCondenser::Community::GameItem#defindex (method)">#defindex</a></span>, <span class='object_link'><a href="GameItem.html#id-instance_method" title="SteamCondenser::Community::GameItem#id (method)">#id</a></span>, <span class='object_link'><a href="GameItem.html#inventory-instance_method" title="SteamCondenser::Community::GameItem#inventory (method)">#inventory</a></span>, <span class='object_link'><a href="GameItem.html#item_class-instance_method" title="SteamCondenser::Community::GameItem#item_class (method)">#item_class</a></span>, <span class='object_link'><a href="GameItem.html#item_set-instance_method" title="SteamCondenser::Community::GameItem#item_set (method)">#item_set</a></span>, <span class='object_link'><a href="GameItem.html#level-instance_method" title="SteamCondenser::Community::GameItem#level (method)">#level</a></span>, <span class='object_link'><a href="GameItem.html#name-instance_method" title="SteamCondenser::Community::GameItem#name (method)">#name</a></span>, <span class='object_link'><a href="GameItem.html#origin-instance_method" title="SteamCondenser::Community::GameItem#origin (method)">#origin</a></span>, <span class='object_link'><a href="GameItem.html#original_id-instance_method" title="SteamCondenser::Community::GameItem#original_id (method)">#original_id</a></span>, <span class='object_link'><a href="GameItem.html#quality-instance_method" title="SteamCondenser::Community::GameItem#quality (method)">#quality</a></span>, <span class='object_link'><a href="GameItem.html#type-instance_method" title="SteamCondenser::Community::GameItem#type (method)">#type</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="#bots_equipped%3F-instance_method" title="#bots_equipped? (instance method)">- (Array&lt;String&gt;) <strong>bots_equipped?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the symbols for each bot this player has equipped this item.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#equipped%3F-instance_method" title="#equipped? (instance method)">- (Boolean) <strong>equipped?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether this item is equipped by this player at all.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Portal2Item) <strong>initialize</strong>(inventory, item_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a Portal 2 item with the given data.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="GameItem.html" title="SteamCondenser::Community::GameItem (module)">GameItem</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameItem.html#craftable%3F-instance_method" title="SteamCondenser::Community::GameItem#craftable? (method)">#craftable?</a></span>, <span class='object_link'><a href="GameItem.html#preliminary%3F-instance_method" title="SteamCondenser::Community::GameItem#preliminary? (method)">#preliminary?</a></span>, <span class='object_link'><a href="GameItem.html#schema_data-instance_method" title="SteamCondenser::Community::GameItem#schema_data (method)">#schema_data</a></span>, <span class='object_link'><a href="GameItem.html#tradeable%3F-instance_method" title="SteamCondenser::Community::GameItem#tradeable? (method)">#tradeable?</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="SteamCondenser::Community::Portal2Item (class)">Portal2Item</a></span></tt>) <strong>initialize</strong>(inventory, item_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a Portal 2 item with the given data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>inventory</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Portal2Inventory.html" title="SteamCondenser::Community::Portal2Inventory (class)">Portal2Inventory</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The inventory this item is contained
+in</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>item_data</span>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The data specifying this item</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/WebApi.html" title="SteamCondenser::Error::WebApi (class)">Error::WebApi</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>on Web API errors</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/portal2/portal2_item.rb', line 32</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_inventory identifier id'>inventory</span><span class='comma token'>,</span> <span class='rubyid_item_data identifier id'>item_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_super super kw'>super</span>
+  <span class='rubyid_@slot ivar id'>@slot</span> <span class='assign token'>=</span> <span class='rubyid_schema_data identifier id'>schema_data</span><span class='lbrack token'>[</span><span class='symbol val'>:item_slot</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@equipped ivar id'>@equipped</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+  <span class='rubyid_BOTS constant id'>BOTS</span><span class='dot token'>.</span><span class='rubyid_each_index identifier id'>each_index</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_class_id identifier id'>class_id</span><span class='bitor op'>|</span>
+    <span class='rubyid_@equipped ivar id'>@equipped</span><span class='lbrack token'>[</span><span class='rubyid_BOTS constant id'>BOTS</span><span class='lbrack token'>[</span><span class='rubyid_class_id identifier id'>class_id</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_item_data identifier id'>item_data</span><span class='lbrack token'>[</span><span class='symbol val'>:inventory</span><span class='rbrack token'>]</span> <span class='bitand op'>&amp;</span> <span class='lparen token'>(</span><span class='integer val'>1</span> <span class='lshft op'>&lt;&lt;</span> <span class='integer val'>16</span> <span class='plus op'>+</span> <span class='rubyid_class_id identifier id'>class_id</span><span class='rparen token'>)</span> <span class='neq op'>!=</span> <span class='integer val'>0</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="slot-instance_method">
+    - (<tt>String</tt><sup>?</sup>) <strong>slot</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the slot where this item can be equipped in or <code>nil</code> if this item
+cannot be equipped</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The slot where this item can be equipped in</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+24
+25
+26</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/portal2/portal2_item.rb', line 24</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_slot identifier id'>slot</span>
+  <span class='rubyid_@slot ivar id'>@slot</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="bots_equipped?-instance_method">
+    - (<tt>Array&lt;String&gt;</tt>) <strong>bots_equipped?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the symbols for each bot this player has equipped this item</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The names of the bots this player has equipped
+this item</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-condenser/community/portal2/portal2_item.rb', line 47</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_bots_equipped? fid id'>bots_equipped?</span>
+  <span class='rubyid_@equipped ivar id'>@equipped</span><span class='dot token'>.</span><span class='rubyid_reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_bot_id identifier id'>bot_id</span><span class='comma token'>,</span> <span class='rubyid_equipped identifier id'>equipped</span><span class='bitor op'>|</span> <span class='notop op'>!</span><span class='rubyid_equipped identifier id'>equipped</span> <span class='rbrace token'>}</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="equipped?-instance_method">
+    - (<tt>Boolean</tt>) <strong>equipped?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether this item is equipped by this player at all</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if the player has equipped this item at all</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/portal2/portal2_item.rb', line 54</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_equipped? fid id'>equipped?</span>
+  <span class='rubyid_@equipped ivar id'>@equipped</span><span class='dot token'>.</span><span class='rubyid_has_value? fid id'>has_value?</span> <span class='rubyid_true true kw'>true</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:48:03 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>