forked from spigotjpwiki/spigotjpwiki.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoverview-summary.html
436 lines (435 loc) · 19.1 KB
/
overview-summary.html
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
<!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_72) on Sat Feb 07 12:00:03 CET 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Overview (Spigot-API 1.8-R0.1-SNAPSHOT API)</title>
<meta name="date" content="2015-02-07">
<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="Overview (Spigot-API 1.8-R0.1-SNAPSHOT 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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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 class="title">Spigot-API 1.8-R0.1-SNAPSHOT API</h1>
</div>
<div class="header">
<div class="subTitle">
<div class="block">Bukkit, the plugin development framework.</div>
</div>
<p>See: <a href="#overview_description">Description</a></p>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/package-summary.html">org.bukkit</a></td>
<td class="colLast">
<div class="block">More generalized classes in the API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/block/package-summary.html">org.bukkit.block</a></td>
<td class="colLast">
<div class="block">Classes used to manipulate the voxels in a <a href="org/bukkit/World.html" title="interface in org.bukkit"><code>world</code></a>,
including special states.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/block/banner/package-summary.html">org.bukkit.block.banner</a></td>
<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/command/package-summary.html">org.bukkit.command</a></td>
<td class="colLast">
<div class="block">Classes relating to handling specialized non-chat player input.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/command/defaults/package-summary.html">org.bukkit.command.defaults</a></td>
<td class="colLast">
<div class="block">Commands for emulating the Minecraft commands and other necessary ones for
use by a Bukkit implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/configuration/package-summary.html">org.bukkit.configuration</a></td>
<td class="colLast">
<div class="block">Classes dedicated to handling a plugin's runtime configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/configuration/file/package-summary.html">org.bukkit.configuration.file</a></td>
<td class="colLast">
<div class="block">Classes dedicated facilitating <a href="org/bukkit/configuration/Configuration.html" title="interface in org.bukkit.configuration"><code>configurations</code></a> to be read and
stored on the filesystem.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/configuration/serialization/package-summary.html">org.bukkit.configuration.serialization</a></td>
<td class="colLast">
<div class="block">Classes dedicated to being able to perform serialization specialized for
the Bukkit <a href="org/bukkit/configuration/Configuration.html" title="interface in org.bukkit.configuration"><code>configuration</code></a>
implementation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/conversations/package-summary.html">org.bukkit.conversations</a></td>
<td class="colLast">
<div class="block">Classes dedicated to facilitate direct player-to-plugin communication.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/enchantments/package-summary.html">org.bukkit.enchantments</a></td>
<td class="colLast">
<div class="block">Classes relating to the specialized enhancements to <a href="org/bukkit/inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>item stacks</code></a>, as part of the <a href="org/bukkit/inventory/meta/ItemMeta.html" title="interface in org.bukkit.inventory.meta"><code>meta data</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/entity/package-summary.html">org.bukkit.entity</a></td>
<td class="colLast">
<div class="block">Interfaces for non-voxel objects that can exist in a <a href="org/bukkit/World.html" title="interface in org.bukkit"><code>world</code></a>, including all players, monsters, projectiles, etc.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/entity/minecart/package-summary.html">org.bukkit.entity.minecart</a></td>
<td class="colLast">
<div class="block">Interfaces for various <a href="org/bukkit/entity/Minecart.html" title="interface in org.bukkit.entity"><code>Minecart</code></a> types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/event/package-summary.html">org.bukkit.event</a></td>
<td class="colLast">
<div class="block">Classes dedicated to handling triggered code executions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/event/block/package-summary.html">org.bukkit.event.block</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to when a <a href="org/bukkit/block/Block.html" title="interface in org.bukkit.block"><code>block</code></a> is changed or interacts with the <a href="org/bukkit/World.html" title="interface in org.bukkit"><code>world</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/event/enchantment/package-summary.html">org.bukkit.event.enchantment</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> triggered from an <a href="org/bukkit/inventory/EnchantingInventory.html" title="interface in org.bukkit.inventory"><code>enchantment table</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/event/entity/package-summary.html">org.bukkit.event.entity</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to <a href="org/bukkit/entity/Entity.html" title="interface in org.bukkit.entity"><code>entities</code></a>, excluding some directly referencing
some more specific entity types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/event/hanging/package-summary.html">org.bukkit.event.hanging</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to <a href="org/bukkit/entity/Hanging.html" title="interface in org.bukkit.entity"><code>entities that hang</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/event/inventory/package-summary.html">org.bukkit.event.inventory</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to <a href="org/bukkit/inventory/Inventory.html" title="interface in org.bukkit.inventory"><code>inventory</code></a> manipulation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/event/painting/package-summary.html">org.bukkit.event.painting</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to <a href="org/bukkit/entity/Painting.html" title="interface in org.bukkit.entity"><code>paintings</code></a>, but deprecated for more general
<a href="org/bukkit/event/hanging/package-summary.html"><code>hanging</code></a> events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/event/player/package-summary.html">org.bukkit.event.player</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to <a href="org/bukkit/entity/Player.html" title="interface in org.bukkit.entity"><code>players</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/event/server/package-summary.html">org.bukkit.event.server</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to programmatic state
changes on the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/event/vehicle/package-summary.html">org.bukkit.event.vehicle</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to <a href="org/bukkit/entity/Vehicle.html" title="interface in org.bukkit.entity"><code>vehicular entities</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/event/weather/package-summary.html">org.bukkit.event.weather</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> relating to weather.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/event/world/package-summary.html">org.bukkit.event.world</a></td>
<td class="colLast">
<div class="block"><a href="org/bukkit/event/Event.html" title="class in org.bukkit.event"><code>Events</code></a> triggered by various <a href="org/bukkit/World.html" title="interface in org.bukkit"><code>world</code></a> states or changes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/generator/package-summary.html">org.bukkit.generator</a></td>
<td class="colLast">
<div class="block">Classes to facilitate <a href="org/bukkit/World.html" title="interface in org.bukkit"><code>world</code></a> generation
implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/help/package-summary.html">org.bukkit.help</a></td>
<td class="colLast">
<div class="block">Classes used to manipulate the default command and topic assistance system.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/inventory/package-summary.html">org.bukkit.inventory</a></td>
<td class="colLast">
<div class="block">Classes involved in manipulating player inventories and item interactions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/inventory/meta/package-summary.html">org.bukkit.inventory.meta</a></td>
<td class="colLast">
<div class="block">The interfaces used when manipulating extra data can can be stored inside
<a href="org/bukkit/inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>item stacks</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/map/package-summary.html">org.bukkit.map</a></td>
<td class="colLast">
<div class="block">Classes to facilitate plugin handling of <a href="org/bukkit/Material.html#MAP"><code>map</code></a> displays.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/material/package-summary.html">org.bukkit.material</a></td>
<td class="colLast">
<div class="block">Classes that represents various voxel types and states.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/metadata/package-summary.html">org.bukkit.metadata</a></td>
<td class="colLast">
<div class="block">Classes dedicated to providing a layer of plugin specified data on various
Minecraft concepts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/permissions/package-summary.html">org.bukkit.permissions</a></td>
<td class="colLast">
<div class="block">Classes dedicated to providing binary state properties to players.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/plugin/package-summary.html">org.bukkit.plugin</a></td>
<td class="colLast">
<div class="block">Classes specifically relating to loading software modules at runtime.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/plugin/java/package-summary.html">org.bukkit.plugin.java</a></td>
<td class="colLast">
<div class="block">Classes for handling <a href="org/bukkit/plugin/Plugin.html" title="interface in org.bukkit.plugin"><code>plugins</code></a> written in
java.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/plugin/messaging/package-summary.html">org.bukkit.plugin.messaging</a></td>
<td class="colLast">
<div class="block">Classes dedicated to specialized plugin to client protocols.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/potion/package-summary.html">org.bukkit.potion</a></td>
<td class="colLast">
<div class="block">Classes to represent various <a href="org/bukkit/Material.html#POTION"><code>potion</code></a>
properties and manipulation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/projectiles/package-summary.html">org.bukkit.projectiles</a></td>
<td class="colLast">
<div class="block">Classes to represent the source of a projectile</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/scheduler/package-summary.html">org.bukkit.scheduler</a></td>
<td class="colLast">
<div class="block">Classes dedicated to letting <a href="org/bukkit/plugin/Plugin.html" title="interface in org.bukkit.plugin"><code>plugins</code></a> run
code at specific time intervals, including thread safety.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/scoreboard/package-summary.html">org.bukkit.scoreboard</a></td>
<td class="colLast">
<div class="block">Interfaces used to manage the client side score display system.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/util/package-summary.html">org.bukkit.util</a></td>
<td class="colLast">
<div class="block">Multi and single purpose classes to facilitate various programmatic
concepts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/util/io/package-summary.html">org.bukkit.util.io</a></td>
<td class="colLast">
<div class="block">Classes used to facilitate stream processing for specific Bukkit concepts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/bukkit/util/noise/package-summary.html">org.bukkit.util.noise</a></td>
<td class="colLast">
<div class="block">Classes dedicated to facilitating deterministic noise.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/bukkit/util/permissions/package-summary.html">org.bukkit.util.permissions</a></td>
<td class="colLast">
<div class="block">Static methods for miscellaneous <a href="org/bukkit/permissions/Permission.html" title="class in org.bukkit.permissions"><code>permission</code></a> functionality.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/spigotmc/package-summary.html">org.spigotmc</a></td>
<td class="colLast"> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/spigotmc/event/entity/package-summary.html">org.spigotmc.event.entity</a></td>
<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/spigotmc/event/player/package-summary.html">org.spigotmc.event.player</a></td>
<td class="colLast"> </td>
</tr>
</tbody>
</table>
</div>
<div class="footer"><a name="overview_description">
<!-- -->
</a>
<div class="subTitle">
<div class="block"><p>Bukkit, the plugin development framework.</p>
<p>
The documentation is for developing plugins and is split into the
respective packages for each subject matter. This documentation does not
cover running a server, contributing code back to the project, or setting
up a workspace. Working knowledge of the Java language is a prerequisite
for developing plugins.
</p><p>
For basic plugin development, see the <a href="org/bukkit/plugin/package-summary.html"><code>plugin
package</code></a>. It covers the basic requirements of a plugin jar.
</p><p>
For handling events and triggered code, see the <a href="org/bukkit/event/package-summary.html"><code>event package</code></a>.
</p></div>
</div>
</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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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 ======= -->
<p class="legalCopy"><small>Copyright © 2015. All rights reserved.</small></p>
</body>
</html>