Initial commit
[trapthecap.git] / doc / classes / GameState.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <title>Class: GameState</title>
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10 <meta http-equiv="Content-Script-Type" content="text/javascript" />
11 <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12 <script type="text/javascript">
13 // <![CDATA[
14
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17 }
18
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
24 else
25 return false;
26
27 elemStyle = elem.style;
28
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
31 } else {
32 elemStyle.display = "none"
33 }
34
35 return true;
36 }
37
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
41 // ]]>
42 </script>
43
44 </head>
45 <body>
46
47
48
49 <div id="classHeader">
50 <table class="header-table">
51 <tr class="top-aligned-row">
52 <td><strong>Class</strong></td>
53 <td class="class-name-in-header">GameState</td>
54 </tr>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
57 <td>
58 <a href="../files/lib/libttc_rb.html">
59 lib/libttc.rb
60 </a>
61 <br />
62 </td>
63 </tr>
64
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
67 <td>
68 Object
69 </td>
70 </tr>
71 </table>
72 </div>
73 <!-- banner header -->
74
75 <div id="bodyContent">
76
77
78
79 <div id="contextContent">
80
81 <div id="description">
82 <p>
83 A class to record each of the states previously found in a game. Note that
84 this is a deep copy of the pieces and what they&#8216;ve captured, so
85 you&#8216;ll need to convert back
86 </p>
87
88 </div>
89
90
91 </div>
92
93 <div id="method-list">
94 <h3 class="section-bar">Methods</h3>
95
96 <div class="name-list">
97 <a href="#M000009">==</a>&nbsp;&nbsp;
98 <a href="#M000008">new</a>&nbsp;&nbsp;
99 </div>
100 </div>
101
102 </div>
103
104
105 <!-- if includes -->
106
107 <div id="section">
108
109
110
111
112
113 <div id="attribute-list">
114 <h3 class="section-bar">Attributes</h3>
115
116 <div class="name-list">
117 <table>
118 <tr class="top-aligned-row context-row">
119 <td class="context-item-name">move</td>
120 <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
121 <td class="context-item-desc"></td>
122 </tr>
123 <tr class="top-aligned-row context-row">
124 <td class="context-item-name">pieces_after_move</td>
125 <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
126 <td class="context-item-desc"></td>
127 </tr>
128 <tr class="top-aligned-row context-row">
129 <td class="context-item-name">player</td>
130 <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
131 <td class="context-item-desc"></td>
132 </tr>
133 </table>
134 </div>
135 </div>
136
137
138
139 <!-- if method_list -->
140 <div id="methods">
141 <h3 class="section-bar">Public Class methods</h3>
142
143 <div id="method-M000008" class="method-detail">
144 <a name="M000008"></a>
145
146 <div class="method-heading">
147 <a href="GameState.src/M000008.html" target="Code" class="method-signature"
148 onclick="popupCode('GameState.src/M000008.html');return false;">
149 <span class="method-name">new</span><span class="method-args">(move, player, pieces)</span>
150 </a>
151 </div>
152
153 <div class="method-description">
154 </div>
155 </div>
156
157 <h3 class="section-bar">Public Instance methods</h3>
158
159 <div id="method-M000009" class="method-detail">
160 <a name="M000009"></a>
161
162 <div class="method-heading">
163 <a href="GameState.src/M000009.html" target="Code" class="method-signature"
164 onclick="popupCode('GameState.src/M000009.html');return false;">
165 <span class="method-name">==</span><span class="method-args">(other)</span>
166 </a>
167 </div>
168
169 <div class="method-description">
170 </div>
171 </div>
172
173
174 </div>
175
176
177 </div>
178
179
180 <div id="validator-badges">
181 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
182 </div>
183
184 </body>
185 </html>