summaryrefslogtreecommitdiff
path: root/javadoc/cpw/mods/fml/client/config/package-summary.html
blob: d27d8ebeb95890b5b404d105498b7ad11d60908b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_65) on Thu Feb 05 20:10:22 EST 2015 -->
<title>cpw.mods.fml.client.config (Forge API)</title>
<meta name="date" content="2015-02-05">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="cpw.mods.fml.client.config (Forge API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../cpw/mods/fml/client/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../cpw/mods/fml/client/event/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?cpw/mods/fml/client/config/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;cpw.mods.fml.client.config</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Provides an interface for defining GuiPropertyList.listEntry objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html" title="interface in cpw.mods.fml.client.config">GuiSelectStringEntries.IGuiSelectStringListEntry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiSlider.ISlider.html" title="interface in cpw.mods.fml.client.config">GuiSlider.ISlider</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">This interface provides the information needed by GuiConfig and GuiConfigEntries to display config elements for editing.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/DummyConfigElement.html" title="class in cpw.mods.fml.client.config">DummyConfigElement</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">This class's main purpose is to provide the necessary objects for a sample Config GUI for FML, although
 there may be practical uses for the objects defined here such as using the DummyCategoryElement object as a 
 wrapper for a custom IGuiConfigListEntry object that opens a special screen.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html" title="class in cpw.mods.fml.client.config">DummyConfigElement.DummyCategoryElement</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">This class provides a Dummy Category IConfigElement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html" title="class in cpw.mods.fml.client.config">DummyConfigElement.DummyListElement</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">This class provides a dummy array-type IConfigElement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiButtonExt.html" title="class in cpw.mods.fml.client.config">GuiButtonExt</a></td>
<td class="colLast">
<div class="block">This class provides a button that fixes several bugs present in the vanilla GuiButton drawing code.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiCheckBox.html" title="class in cpw.mods.fml.client.config">GuiCheckBox</a></td>
<td class="colLast">
<div class="block">This class provides a checkbox style control.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfig.html" title="class in cpw.mods.fml.client.config">GuiConfig</a></td>
<td class="colLast">
<div class="block">This class is the base GuiScreen for all config GUI screens.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries</a></td>
<td class="colLast">
<div class="block">This class implements the scrolling list functionality of the config GUI screens.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.ArrayEntry</a></td>
<td class="colLast">
<div class="block">ArrayEntry

 Provides a GuiButton with the list contents as the displayString.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.BooleanEntry</a></td>
<td class="colLast">
<div class="block">BooleanPropEntry

 Provides a GuiButton that toggles between true and false.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.ButtonEntry</a></td>
<td class="colLast">
<div class="block">ButtonEntry

 Provides a basic GuiButton entry to be used as a base for other entries that require a button for the value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.CategoryEntry</a></td>
<td class="colLast">
<div class="block">CategoryEntry

 Provides an entry that consists of a GuiButton for navigating to the child category GuiConfig screen.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.ChatColorEntry</a></td>
<td class="colLast">
<div class="block">ChatColorEntry

 Provides a GuiButton that cycles through the list of chat color codes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.CycleValueEntry</a></td>
<td class="colLast">
<div class="block">CycleValueEntry

 Provides a GuiButton that cycles through the prop's validValues array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.DoubleEntry</a></td>
<td class="colLast">
<div class="block">DoubleEntry

 Provides a GuiTextField for user input.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.IntegerEntry</a></td>
<td class="colLast">
<div class="block">IntegerEntry

 Provides a GuiTextField for user input.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.ListEntryBase</a></td>
<td class="colLast">
<div class="block">ListEntryBase

 Provides a base entry for others to extend.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.NumberSliderEntry</a></td>
<td class="colLast">
<div class="block">NumberSliderEntry

 Provides a slider for numeric properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.SelectValueEntry</a></td>
<td class="colLast">
<div class="block">SelectValueEntry

 Provides a GuiButton with the current value as the displayString.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html" title="class in cpw.mods.fml.client.config">GuiConfigEntries.StringEntry</a></td>
<td class="colLast">
<div class="block">StringEntry

 Provides a GuiTextField for user input.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiEditArray.html" title="class in cpw.mods.fml.client.config">GuiEditArray</a></td>
<td class="colLast">
<div class="block">This class is the base screen used for editing an array-type property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.html" title="class in cpw.mods.fml.client.config">GuiEditArrayEntries</a></td>
<td class="colLast">
<div class="block">This class implements the scrolling list functionality of the GuiEditList screen.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html" title="class in cpw.mods.fml.client.config">GuiEditArrayEntries.BaseEntry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html" title="class in cpw.mods.fml.client.config">GuiEditArrayEntries.BooleanEntry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html" title="class in cpw.mods.fml.client.config">GuiEditArrayEntries.DoubleEntry</a></td>
<td class="colLast">
<div class="block">IGuiListEntry Inner Classes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html" title="class in cpw.mods.fml.client.config">GuiEditArrayEntries.IntegerEntry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html" title="class in cpw.mods.fml.client.config">GuiEditArrayEntries.StringEntry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiMessageDialog.html" title="class in cpw.mods.fml.client.config">GuiMessageDialog</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiSelectString.html" title="class in cpw.mods.fml.client.config">GuiSelectString</a></td>
<td class="colLast">
<div class="block">This class provides a screen that allows the user to select a value from a list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiSelectStringEntries.html" title="class in cpw.mods.fml.client.config">GuiSelectStringEntries</a></td>
<td class="colLast">
<div class="block">This class implements the scrolling list functionality of the GuiSelectString screen.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html" title="class in cpw.mods.fml.client.config">GuiSelectStringEntries.EntryComparator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html" title="class in cpw.mods.fml.client.config">GuiSelectStringEntries.ListEntry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiSlider.html" title="class in cpw.mods.fml.client.config">GuiSlider</a></td>
<td class="colLast">
<div class="block">This class is blatantly stolen from iChunUtils with permission.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html" title="class in cpw.mods.fml.client.config">GuiUnicodeGlyphButton</a></td>
<td class="colLast">
<div class="block">This class provides a button that shows a string glyph at the beginning.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/GuiUtils.html" title="class in cpw.mods.fml.client.config">GuiUtils</a></td>
<td class="colLast">
<div class="block">This class provides several methods and constants used by the Config GUI classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/HoverChecker.html" title="class in cpw.mods.fml.client.config">HoverChecker</a></td>
<td class="colLast">
<div class="block">This class implements an easy way to check if the mouse has hovered within a certain region of the screen for a given 
 period of time.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../cpw/mods/fml/client/config/ConfigGuiType.html" title="enum in cpw.mods.fml.client.config">ConfigGuiType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../cpw/mods/fml/client/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../cpw/mods/fml/client/event/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?cpw/mods/fml/client/config/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>