levistone 0.9.3__2-cp311-cp311-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of levistone might be problematic. Click here for more details.
- endstone/__init__.py +30 -0
- endstone/__main__.py +4 -0
- endstone/_internal/__init__.py +0 -0
- endstone/_internal/bootstrap/__init__.py +79 -0
- endstone/_internal/bootstrap/base.py +262 -0
- endstone/_internal/bootstrap/linux.py +86 -0
- endstone/_internal/bootstrap/windows.py +59 -0
- endstone/_internal/endstone_python.cp311-win_amd64.pyd +0 -0
- endstone/_internal/endstone_python.pyi +4599 -0
- endstone/_internal/metrics.py +101 -0
- endstone/_internal/plugin_loader.py +241 -0
- endstone/_internal/version.py +14 -0
- endstone/actor.py +3 -0
- endstone/ban.py +3 -0
- endstone/block.py +3 -0
- endstone/boss.py +3 -0
- endstone/command.py +17 -0
- endstone/config/endstone.toml +4 -0
- endstone/damage.py +3 -0
- endstone/enchantments.py +3 -0
- endstone/event.py +123 -0
- endstone/form.py +27 -0
- endstone/inventory.py +21 -0
- endstone/lang.py +3 -0
- endstone/level.py +9 -0
- endstone/map.py +3 -0
- endstone/permissions.py +9 -0
- endstone/plugin.py +142 -0
- endstone/scheduler.py +3 -0
- endstone/scoreboard.py +3 -0
- endstone/util.py +3 -0
- endstone_runtime.dll +0 -0
- endstone_runtime.pdb +0 -0
- levistone-0.9.3.dist-info/METADATA +49 -0
- levistone-0.9.3.dist-info/RECORD +40 -0
- levistone-0.9.3.dist-info/WHEEL +5 -0
- levistone-0.9.3.dist-info/entry_points.txt +2 -0
- levistone-0.9.3.dist-info/licenses/LICENSE +201 -0
- levistone-0.9.3.dist-info/top_level.txt +2 -0
- manifest.json +6 -0
|
@@ -0,0 +1,4599 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
import datetime
|
|
3
|
+
import numpy
|
|
4
|
+
import os
|
|
5
|
+
import typing
|
|
6
|
+
import uuid
|
|
7
|
+
__all__ = ['ActionForm', 'Actor', 'ActorDamageEvent', 'ActorDeathEvent', 'ActorEvent', 'ActorExplodeEvent', 'ActorKnockbackEvent', 'ActorRemoveEvent', 'ActorSpawnEvent', 'ActorTeleportEvent', 'BanEntry', 'BarColor', 'BarFlag', 'BarStyle', 'Block', 'BlockBreakEvent', 'BlockData', 'BlockEvent', 'BlockFace', 'BlockPlaceEvent', 'BlockState', 'BossBar', 'BroadcastMessageEvent', 'Cancellable', 'Chunk', 'ChunkEvent', 'ChunkLoadEvent', 'ChunkUnloadEvent', 'ColorFormat', 'Command', 'CommandExecutor', 'CommandSender', 'CommandSenderWrapper', 'ConsoleCommandSender', 'Criteria', 'DamageSource', 'Dimension', 'DimensionEvent', 'DisplaySlot', 'Divider', 'Dropdown', 'Enchantment', 'EnchantmentRegistry', 'EquipmentSlot', 'Event', 'EventPriority', 'GameMode', 'Header', 'Inventory', 'IpBanEntry', 'IpBanList', 'ItemFactory', 'ItemMeta', 'ItemRegistry', 'ItemStack', 'ItemType', 'Label', 'Language', 'Level', 'LevelEvent', 'Location', 'Logger', 'MapCanvas', 'MapMeta', 'MapRenderer', 'MapView', 'MessageForm', 'Mob', 'MobEvent', 'ModalForm', 'NamespacedKey', 'Objective', 'ObjectiveSortOrder', 'OfflinePlayer', 'PacketReceiveEvent', 'PacketSendEvent', 'Permissible', 'Permission', 'PermissionAttachment', 'PermissionAttachmentInfo', 'PermissionDefault', 'Player', 'PlayerBanEntry', 'PlayerBanList', 'PlayerChatEvent', 'PlayerCommandEvent', 'PlayerDeathEvent', 'PlayerDropItemEvent', 'PlayerEmoteEvent', 'PlayerEvent', 'PlayerGameModeChangeEvent', 'PlayerInteractActorEvent', 'PlayerInteractEvent', 'PlayerInventory', 'PlayerItemConsumeEvent', 'PlayerJoinEvent', 'PlayerJumpEvent', 'PlayerKickEvent', 'PlayerLoginEvent', 'PlayerMoveEvent', 'PlayerPickupItemEvent', 'PlayerQuitEvent', 'PlayerRespawnEvent', 'PlayerTeleportEvent', 'Plugin', 'PluginCommand', 'PluginDescription', 'PluginDisableEvent', 'PluginEnableEvent', 'PluginLoadOrder', 'PluginLoader', 'PluginManager', 'Position', 'ProxiedCommandSender', 'RenderType', 'Scheduler', 'Score', 'Scoreboard', 'ScriptMessageEvent', 'Server', 'ServerCommandEvent', 'ServerEvent', 'ServerListPingEvent', 'ServerLoadEvent', 'Service', 'ServiceManager', 'ServicePriority', 'Skin', 'Slider', 'SocketAddress', 'StepSlider', 'Task', 'TextInput', 'ThunderChangeEvent', 'Toggle', 'Translatable', 'Vector', 'WeatherChangeEvent', 'WeatherEvent']
|
|
8
|
+
class ActionForm:
|
|
9
|
+
"""
|
|
10
|
+
Represents a form with buttons that let the player take action.
|
|
11
|
+
"""
|
|
12
|
+
class Button:
|
|
13
|
+
"""
|
|
14
|
+
Represents a button with text and an optional icon.
|
|
15
|
+
"""
|
|
16
|
+
def __init__(self, text: str | Translatable = '', icon: str | None = None, on_click: typing.Callable[[Player], None] = None) -> None:
|
|
17
|
+
...
|
|
18
|
+
@property
|
|
19
|
+
def icon(self) -> str | None:
|
|
20
|
+
"""
|
|
21
|
+
Gets or sets the icon path or URL of the button
|
|
22
|
+
"""
|
|
23
|
+
@icon.setter
|
|
24
|
+
def icon(self, arg1: str) -> ActionForm.Button:
|
|
25
|
+
...
|
|
26
|
+
@property
|
|
27
|
+
def on_click(self) -> typing.Callable[[Player], None]:
|
|
28
|
+
"""
|
|
29
|
+
Gets or sets the on click callback.
|
|
30
|
+
"""
|
|
31
|
+
@on_click.setter
|
|
32
|
+
def on_click(self, arg1: typing.Callable[[Player], None]) -> ActionForm.Button:
|
|
33
|
+
...
|
|
34
|
+
@property
|
|
35
|
+
def text(self) -> str | Translatable:
|
|
36
|
+
"""
|
|
37
|
+
Gets or sets the text of the button
|
|
38
|
+
"""
|
|
39
|
+
@text.setter
|
|
40
|
+
def text(self, arg1: str | Translatable) -> ActionForm.Button:
|
|
41
|
+
...
|
|
42
|
+
def __init__(self, title: str | Translatable = '', content: str | Translatable = '', buttons: list[ActionForm.Button | Divider | Header | Label] | None = None, on_submit: typing.Callable[[Player, int], None] = None, on_close: typing.Callable[[Player], None] = None) -> None:
|
|
43
|
+
...
|
|
44
|
+
def add_button(self, text: str | Translatable, icon: str | None = None, on_click: typing.Callable[[Player], None] = None) -> ActionForm:
|
|
45
|
+
"""
|
|
46
|
+
Adds a button to the form.
|
|
47
|
+
"""
|
|
48
|
+
def add_divider(self) -> ActionForm:
|
|
49
|
+
"""
|
|
50
|
+
Adds a divider to the form.
|
|
51
|
+
"""
|
|
52
|
+
def add_header(self, text: str | Translatable) -> ActionForm:
|
|
53
|
+
"""
|
|
54
|
+
Adds a header to the form.
|
|
55
|
+
"""
|
|
56
|
+
def add_label(self, text: str | Translatable) -> ActionForm:
|
|
57
|
+
"""
|
|
58
|
+
Adds a label to the form.
|
|
59
|
+
"""
|
|
60
|
+
@property
|
|
61
|
+
def content(self) -> str | Translatable:
|
|
62
|
+
"""
|
|
63
|
+
Gets or sets the content of the form.
|
|
64
|
+
"""
|
|
65
|
+
@content.setter
|
|
66
|
+
def content(self, arg1: str | Translatable) -> ActionForm:
|
|
67
|
+
...
|
|
68
|
+
@property
|
|
69
|
+
def controls(self) -> list[ActionForm.Button | Divider | Header | Label]:
|
|
70
|
+
"""
|
|
71
|
+
Gets or sets the controls of the action form.
|
|
72
|
+
"""
|
|
73
|
+
@controls.setter
|
|
74
|
+
def controls(self, arg1: list[ActionForm.Button | Divider | Header | Label]) -> ActionForm:
|
|
75
|
+
...
|
|
76
|
+
@property
|
|
77
|
+
def on_close(self) -> typing.Callable[[Player], None]:
|
|
78
|
+
"""
|
|
79
|
+
Gets or sets the on close callback.
|
|
80
|
+
"""
|
|
81
|
+
@on_close.setter
|
|
82
|
+
def on_close(self, arg1: typing.Callable[[Player], None]) -> ActionForm:
|
|
83
|
+
...
|
|
84
|
+
@property
|
|
85
|
+
def on_submit(self) -> typing.Callable[[Player, int], None]:
|
|
86
|
+
"""
|
|
87
|
+
Gets or sets the on submit callback.
|
|
88
|
+
"""
|
|
89
|
+
@on_submit.setter
|
|
90
|
+
def on_submit(self, arg1: typing.Callable[[Player, int], None]) -> ActionForm:
|
|
91
|
+
...
|
|
92
|
+
@property
|
|
93
|
+
def title(self) -> str | Translatable:
|
|
94
|
+
"""
|
|
95
|
+
Gets or sets the title of the form.
|
|
96
|
+
"""
|
|
97
|
+
@title.setter
|
|
98
|
+
def title(self, arg1: str | Translatable) -> ActionForm:
|
|
99
|
+
...
|
|
100
|
+
class Actor(CommandSender):
|
|
101
|
+
"""
|
|
102
|
+
Represents a base actor in the level.
|
|
103
|
+
"""
|
|
104
|
+
def add_scoreboard_tag(self, tag: str) -> bool:
|
|
105
|
+
"""
|
|
106
|
+
Adds a tag to this actor.
|
|
107
|
+
"""
|
|
108
|
+
def remove(self) -> None:
|
|
109
|
+
"""
|
|
110
|
+
Remove this actor from the level.
|
|
111
|
+
"""
|
|
112
|
+
def remove_scoreboard_tag(self, tag: str) -> bool:
|
|
113
|
+
"""
|
|
114
|
+
Removes a given tag from this actor.
|
|
115
|
+
"""
|
|
116
|
+
def set_rotation(self, yaw: float, pitch: float) -> None:
|
|
117
|
+
"""
|
|
118
|
+
Sets the actor's rotation.
|
|
119
|
+
"""
|
|
120
|
+
@typing.overload
|
|
121
|
+
def teleport(self, location: Location) -> None:
|
|
122
|
+
"""
|
|
123
|
+
Teleports this actor to the given location.
|
|
124
|
+
"""
|
|
125
|
+
@typing.overload
|
|
126
|
+
def teleport(self, target: Actor) -> None:
|
|
127
|
+
"""
|
|
128
|
+
Teleports this actor to the target Actor.
|
|
129
|
+
"""
|
|
130
|
+
@property
|
|
131
|
+
def dimension(self) -> Dimension:
|
|
132
|
+
"""
|
|
133
|
+
Gets the current Dimension this actor resides in.
|
|
134
|
+
"""
|
|
135
|
+
@property
|
|
136
|
+
def health(self) -> int:
|
|
137
|
+
"""
|
|
138
|
+
Gets or sets the entity's health from 0 to its max possible value, where 0 is dead.
|
|
139
|
+
"""
|
|
140
|
+
@health.setter
|
|
141
|
+
def health(self, arg1: int) -> None:
|
|
142
|
+
...
|
|
143
|
+
@property
|
|
144
|
+
def id(self) -> int:
|
|
145
|
+
"""
|
|
146
|
+
Returns a unique id for this actor.
|
|
147
|
+
"""
|
|
148
|
+
@property
|
|
149
|
+
def is_dead(self) -> bool:
|
|
150
|
+
"""
|
|
151
|
+
Returns true if this actor has been marked for removal.
|
|
152
|
+
"""
|
|
153
|
+
@property
|
|
154
|
+
def is_in_lava(self) -> bool:
|
|
155
|
+
"""
|
|
156
|
+
Returns true if the actor is in lava.
|
|
157
|
+
"""
|
|
158
|
+
@property
|
|
159
|
+
def is_in_water(self) -> bool:
|
|
160
|
+
"""
|
|
161
|
+
Returns true if the actor is in water.
|
|
162
|
+
"""
|
|
163
|
+
@property
|
|
164
|
+
def is_name_tag_always_visible(self) -> bool:
|
|
165
|
+
"""
|
|
166
|
+
Gets or sets if the actor's name tag is always visible or not.
|
|
167
|
+
"""
|
|
168
|
+
@is_name_tag_always_visible.setter
|
|
169
|
+
def is_name_tag_always_visible(self, arg1: bool) -> None:
|
|
170
|
+
...
|
|
171
|
+
@property
|
|
172
|
+
def is_name_tag_visible(self) -> bool:
|
|
173
|
+
"""
|
|
174
|
+
Gets or sets if the actor's name tag is visible or not.
|
|
175
|
+
"""
|
|
176
|
+
@is_name_tag_visible.setter
|
|
177
|
+
def is_name_tag_visible(self, arg1: bool) -> None:
|
|
178
|
+
...
|
|
179
|
+
@property
|
|
180
|
+
def is_on_ground(self) -> bool:
|
|
181
|
+
"""
|
|
182
|
+
Returns true if the actor is supported by a block, i.e. on ground.
|
|
183
|
+
"""
|
|
184
|
+
@property
|
|
185
|
+
def is_valid(self) -> bool:
|
|
186
|
+
"""
|
|
187
|
+
Returns false if the entity has died, been despawned for some other reason, or has not been added to the level.
|
|
188
|
+
"""
|
|
189
|
+
@property
|
|
190
|
+
def level(self) -> Level:
|
|
191
|
+
"""
|
|
192
|
+
Gets the current Level this actor resides in.
|
|
193
|
+
"""
|
|
194
|
+
@property
|
|
195
|
+
def location(self) -> Location:
|
|
196
|
+
"""
|
|
197
|
+
Gets the actor's current position.
|
|
198
|
+
"""
|
|
199
|
+
@property
|
|
200
|
+
def max_health(self) -> int:
|
|
201
|
+
"""
|
|
202
|
+
Gets the maximum health this entity has.
|
|
203
|
+
"""
|
|
204
|
+
@property
|
|
205
|
+
def name_tag(self) -> str:
|
|
206
|
+
"""
|
|
207
|
+
Gets or sets the current name tag of the actor.
|
|
208
|
+
"""
|
|
209
|
+
@name_tag.setter
|
|
210
|
+
def name_tag(self, arg1: str) -> None:
|
|
211
|
+
...
|
|
212
|
+
@property
|
|
213
|
+
def runtime_id(self) -> int:
|
|
214
|
+
"""
|
|
215
|
+
Returns the runtime id for this actor.
|
|
216
|
+
"""
|
|
217
|
+
@property
|
|
218
|
+
def score_tag(self) -> str:
|
|
219
|
+
"""
|
|
220
|
+
Gets or sets the current score tag of the actor.
|
|
221
|
+
"""
|
|
222
|
+
@score_tag.setter
|
|
223
|
+
def score_tag(self, arg1: str) -> None:
|
|
224
|
+
...
|
|
225
|
+
@property
|
|
226
|
+
def scoreboard_tags(self) -> list[str]:
|
|
227
|
+
"""
|
|
228
|
+
Returns a list of scoreboard tags for this actor.
|
|
229
|
+
"""
|
|
230
|
+
@property
|
|
231
|
+
def type(self) -> str:
|
|
232
|
+
"""
|
|
233
|
+
Gets the type of the actor.
|
|
234
|
+
"""
|
|
235
|
+
@property
|
|
236
|
+
def velocity(self) -> Vector:
|
|
237
|
+
"""
|
|
238
|
+
Gets this actor's current velocity.
|
|
239
|
+
"""
|
|
240
|
+
class ActorDamageEvent(MobEvent, Cancellable):
|
|
241
|
+
"""
|
|
242
|
+
Called when an Actor is damaged.
|
|
243
|
+
"""
|
|
244
|
+
@property
|
|
245
|
+
def damage(self) -> float:
|
|
246
|
+
"""
|
|
247
|
+
Gets or sets the amount of damage caused by the event
|
|
248
|
+
"""
|
|
249
|
+
@damage.setter
|
|
250
|
+
def damage(self, arg1: float) -> None:
|
|
251
|
+
...
|
|
252
|
+
@property
|
|
253
|
+
def damage_source(self) -> DamageSource:
|
|
254
|
+
"""
|
|
255
|
+
Gets the source of damage.
|
|
256
|
+
"""
|
|
257
|
+
class ActorDeathEvent(MobEvent):
|
|
258
|
+
"""
|
|
259
|
+
Called when an Actor dies.
|
|
260
|
+
"""
|
|
261
|
+
@property
|
|
262
|
+
def damage_source(self) -> DamageSource:
|
|
263
|
+
"""
|
|
264
|
+
Gets the source of damage which caused the death.
|
|
265
|
+
"""
|
|
266
|
+
class ActorEvent(Event):
|
|
267
|
+
"""
|
|
268
|
+
Represents an Actor-related event.
|
|
269
|
+
"""
|
|
270
|
+
@property
|
|
271
|
+
def actor(self) -> Actor:
|
|
272
|
+
"""
|
|
273
|
+
Returns the Actor involved in this event
|
|
274
|
+
"""
|
|
275
|
+
class ActorExplodeEvent(ActorEvent, Cancellable):
|
|
276
|
+
"""
|
|
277
|
+
Called when an Actor explodes.
|
|
278
|
+
"""
|
|
279
|
+
@property
|
|
280
|
+
def block_list(self) -> list[Block]:
|
|
281
|
+
"""
|
|
282
|
+
Gets or sets the list of blocks that would have been removed or were removed from the explosion event.
|
|
283
|
+
"""
|
|
284
|
+
@block_list.setter
|
|
285
|
+
def block_list(self, arg1: list[Block]) -> None:
|
|
286
|
+
...
|
|
287
|
+
@property
|
|
288
|
+
def location(self) -> Location:
|
|
289
|
+
"""
|
|
290
|
+
Returns the location where the explosion happened.
|
|
291
|
+
"""
|
|
292
|
+
class ActorKnockbackEvent(MobEvent, Cancellable):
|
|
293
|
+
"""
|
|
294
|
+
Called when a living entity receives knockback.
|
|
295
|
+
"""
|
|
296
|
+
@property
|
|
297
|
+
def knockback(self) -> Vector:
|
|
298
|
+
"""
|
|
299
|
+
Gets or sets the knockback that will be applied to the entity.
|
|
300
|
+
"""
|
|
301
|
+
@knockback.setter
|
|
302
|
+
def knockback(self, arg1: Vector) -> None:
|
|
303
|
+
...
|
|
304
|
+
@property
|
|
305
|
+
def source(self) -> Actor:
|
|
306
|
+
"""
|
|
307
|
+
Get the source actor that has caused knockback to the defender, if exists.
|
|
308
|
+
"""
|
|
309
|
+
class ActorRemoveEvent(ActorEvent):
|
|
310
|
+
"""
|
|
311
|
+
Called when an Actor is removed.
|
|
312
|
+
"""
|
|
313
|
+
class ActorSpawnEvent(ActorEvent, Cancellable):
|
|
314
|
+
"""
|
|
315
|
+
Called when an Actor is spawned into a world.
|
|
316
|
+
"""
|
|
317
|
+
class ActorTeleportEvent(ActorEvent, Cancellable):
|
|
318
|
+
"""
|
|
319
|
+
Called when a non-player entity is teleported from one location to another.
|
|
320
|
+
"""
|
|
321
|
+
@property
|
|
322
|
+
def from_location(self) -> Location:
|
|
323
|
+
"""
|
|
324
|
+
Gets or sets the location that this actor moved from.
|
|
325
|
+
"""
|
|
326
|
+
@from_location.setter
|
|
327
|
+
def from_location(self, arg1: Location) -> None:
|
|
328
|
+
...
|
|
329
|
+
@property
|
|
330
|
+
def to_location(self) -> Location:
|
|
331
|
+
"""
|
|
332
|
+
Gets or sets the location that this actor moved to.
|
|
333
|
+
"""
|
|
334
|
+
@to_location.setter
|
|
335
|
+
def to_location(self, arg1: Location) -> None:
|
|
336
|
+
...
|
|
337
|
+
class BanEntry:
|
|
338
|
+
"""
|
|
339
|
+
A single entry from a ban list.
|
|
340
|
+
"""
|
|
341
|
+
@property
|
|
342
|
+
def created(self) -> datetime.datetime:
|
|
343
|
+
"""
|
|
344
|
+
Gets or sets the date this ban entry was created.
|
|
345
|
+
"""
|
|
346
|
+
@created.setter
|
|
347
|
+
def created(self, arg1: datetime.datetime) -> None:
|
|
348
|
+
...
|
|
349
|
+
@property
|
|
350
|
+
def expiration(self) -> datetime.datetime | None:
|
|
351
|
+
"""
|
|
352
|
+
Gets or sets the date this ban expires on.
|
|
353
|
+
"""
|
|
354
|
+
@expiration.setter
|
|
355
|
+
def expiration(self, arg1: datetime.datetime | None) -> None:
|
|
356
|
+
...
|
|
357
|
+
@property
|
|
358
|
+
def reason(self) -> str:
|
|
359
|
+
"""
|
|
360
|
+
Gets or sets the reason for this ban.
|
|
361
|
+
"""
|
|
362
|
+
@reason.setter
|
|
363
|
+
def reason(self, arg1: str) -> None:
|
|
364
|
+
...
|
|
365
|
+
@property
|
|
366
|
+
def source(self) -> str:
|
|
367
|
+
"""
|
|
368
|
+
Gets or sets the source of this ban.
|
|
369
|
+
"""
|
|
370
|
+
@source.setter
|
|
371
|
+
def source(self, arg1: str) -> None:
|
|
372
|
+
...
|
|
373
|
+
class BarColor:
|
|
374
|
+
BLUE: typing.ClassVar[BarColor] # value = <BarColor.BLUE: 1>
|
|
375
|
+
GREEN: typing.ClassVar[BarColor] # value = <BarColor.GREEN: 3>
|
|
376
|
+
PINK: typing.ClassVar[BarColor] # value = <BarColor.PINK: 0>
|
|
377
|
+
PURPLE: typing.ClassVar[BarColor] # value = <BarColor.PURPLE: 5>
|
|
378
|
+
REBECCA_PURPLE: typing.ClassVar[BarColor] # value = <BarColor.REBECCA_PURPLE: 6>
|
|
379
|
+
RED: typing.ClassVar[BarColor] # value = <BarColor.RED: 2>
|
|
380
|
+
WHITE: typing.ClassVar[BarColor] # value = <BarColor.WHITE: 7>
|
|
381
|
+
YELLOW: typing.ClassVar[BarColor] # value = <BarColor.YELLOW: 4>
|
|
382
|
+
__members__: typing.ClassVar[dict[str, BarColor]] # value = {'PINK': <BarColor.PINK: 0>, 'BLUE': <BarColor.BLUE: 1>, 'RED': <BarColor.RED: 2>, 'GREEN': <BarColor.GREEN: 3>, 'YELLOW': <BarColor.YELLOW: 4>, 'PURPLE': <BarColor.PURPLE: 5>, 'REBECCA_PURPLE': <BarColor.REBECCA_PURPLE: 6>, 'WHITE': <BarColor.WHITE: 7>}
|
|
383
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
384
|
+
...
|
|
385
|
+
def __getstate__(self) -> int:
|
|
386
|
+
...
|
|
387
|
+
def __hash__(self) -> int:
|
|
388
|
+
...
|
|
389
|
+
def __index__(self) -> int:
|
|
390
|
+
...
|
|
391
|
+
def __init__(self, value: int) -> None:
|
|
392
|
+
...
|
|
393
|
+
def __int__(self) -> int:
|
|
394
|
+
...
|
|
395
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
396
|
+
...
|
|
397
|
+
def __repr__(self) -> str:
|
|
398
|
+
...
|
|
399
|
+
def __setstate__(self, state: int) -> None:
|
|
400
|
+
...
|
|
401
|
+
def __str__(self) -> str:
|
|
402
|
+
...
|
|
403
|
+
@property
|
|
404
|
+
def name(self) -> str:
|
|
405
|
+
...
|
|
406
|
+
@property
|
|
407
|
+
def value(self) -> int:
|
|
408
|
+
...
|
|
409
|
+
class BarFlag:
|
|
410
|
+
DARKEN_SKY: typing.ClassVar[BarFlag] # value = <BarFlag.DARKEN_SKY: 0>
|
|
411
|
+
__members__: typing.ClassVar[dict[str, BarFlag]] # value = {'DARKEN_SKY': <BarFlag.DARKEN_SKY: 0>}
|
|
412
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
413
|
+
...
|
|
414
|
+
def __getstate__(self) -> int:
|
|
415
|
+
...
|
|
416
|
+
def __hash__(self) -> int:
|
|
417
|
+
...
|
|
418
|
+
def __index__(self) -> int:
|
|
419
|
+
...
|
|
420
|
+
def __init__(self, value: int) -> None:
|
|
421
|
+
...
|
|
422
|
+
def __int__(self) -> int:
|
|
423
|
+
...
|
|
424
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
425
|
+
...
|
|
426
|
+
def __repr__(self) -> str:
|
|
427
|
+
...
|
|
428
|
+
def __setstate__(self, state: int) -> None:
|
|
429
|
+
...
|
|
430
|
+
def __str__(self) -> str:
|
|
431
|
+
...
|
|
432
|
+
@property
|
|
433
|
+
def name(self) -> str:
|
|
434
|
+
...
|
|
435
|
+
@property
|
|
436
|
+
def value(self) -> int:
|
|
437
|
+
...
|
|
438
|
+
class BarStyle:
|
|
439
|
+
SEGMENTED_10: typing.ClassVar[BarStyle] # value = <BarStyle.SEGMENTED_10: 2>
|
|
440
|
+
SEGMENTED_12: typing.ClassVar[BarStyle] # value = <BarStyle.SEGMENTED_12: 3>
|
|
441
|
+
SEGMENTED_20: typing.ClassVar[BarStyle] # value = <BarStyle.SEGMENTED_20: 4>
|
|
442
|
+
SEGMENTED_6: typing.ClassVar[BarStyle] # value = <BarStyle.SEGMENTED_6: 1>
|
|
443
|
+
SOLID: typing.ClassVar[BarStyle] # value = <BarStyle.SOLID: 0>
|
|
444
|
+
__members__: typing.ClassVar[dict[str, BarStyle]] # value = {'SOLID': <BarStyle.SOLID: 0>, 'SEGMENTED_6': <BarStyle.SEGMENTED_6: 1>, 'SEGMENTED_10': <BarStyle.SEGMENTED_10: 2>, 'SEGMENTED_12': <BarStyle.SEGMENTED_12: 3>, 'SEGMENTED_20': <BarStyle.SEGMENTED_20: 4>}
|
|
445
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
446
|
+
...
|
|
447
|
+
def __getstate__(self) -> int:
|
|
448
|
+
...
|
|
449
|
+
def __hash__(self) -> int:
|
|
450
|
+
...
|
|
451
|
+
def __index__(self) -> int:
|
|
452
|
+
...
|
|
453
|
+
def __init__(self, value: int) -> None:
|
|
454
|
+
...
|
|
455
|
+
def __int__(self) -> int:
|
|
456
|
+
...
|
|
457
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
458
|
+
...
|
|
459
|
+
def __repr__(self) -> str:
|
|
460
|
+
...
|
|
461
|
+
def __setstate__(self, state: int) -> None:
|
|
462
|
+
...
|
|
463
|
+
def __str__(self) -> str:
|
|
464
|
+
...
|
|
465
|
+
@property
|
|
466
|
+
def name(self) -> str:
|
|
467
|
+
...
|
|
468
|
+
@property
|
|
469
|
+
def value(self) -> int:
|
|
470
|
+
...
|
|
471
|
+
class Block:
|
|
472
|
+
"""
|
|
473
|
+
Represents a block.
|
|
474
|
+
"""
|
|
475
|
+
def __str__(self) -> str:
|
|
476
|
+
...
|
|
477
|
+
def capture_state(self) -> BlockState:
|
|
478
|
+
"""
|
|
479
|
+
Captures the current state of this block. The returned object will never be updated, and you are not guaranteed that (for example) a sign is still a sign after you capture its state.
|
|
480
|
+
"""
|
|
481
|
+
@typing.overload
|
|
482
|
+
def get_relative(self, offset_x: int, offset_y: int, offset_z: int) -> Block:
|
|
483
|
+
"""
|
|
484
|
+
Gets the block at the given offsets
|
|
485
|
+
"""
|
|
486
|
+
@typing.overload
|
|
487
|
+
def get_relative(self, face: BlockFace, distance: int = 1) -> Block:
|
|
488
|
+
"""
|
|
489
|
+
Gets the block at the given distance of the given face
|
|
490
|
+
"""
|
|
491
|
+
def set_data(self, data: BlockData, apply_physics: bool = True) -> None:
|
|
492
|
+
"""
|
|
493
|
+
Sets the complete data for this block
|
|
494
|
+
"""
|
|
495
|
+
def set_type(self, type: str, apply_physics: bool = True) -> None:
|
|
496
|
+
"""
|
|
497
|
+
Sets the type of this block
|
|
498
|
+
"""
|
|
499
|
+
@property
|
|
500
|
+
def data(self) -> BlockData:
|
|
501
|
+
"""
|
|
502
|
+
Gets the complete data for this block
|
|
503
|
+
"""
|
|
504
|
+
@property
|
|
505
|
+
def dimension(self) -> Dimension:
|
|
506
|
+
"""
|
|
507
|
+
Gets the dimension which contains this Block
|
|
508
|
+
"""
|
|
509
|
+
@property
|
|
510
|
+
def location(self) -> Location:
|
|
511
|
+
"""
|
|
512
|
+
Gets the Location of the block
|
|
513
|
+
"""
|
|
514
|
+
@property
|
|
515
|
+
def type(self) -> str:
|
|
516
|
+
"""
|
|
517
|
+
Gets or sets the type of the block.
|
|
518
|
+
"""
|
|
519
|
+
@property
|
|
520
|
+
def x(self) -> int:
|
|
521
|
+
"""
|
|
522
|
+
Gets the x-coordinate of this block
|
|
523
|
+
"""
|
|
524
|
+
@property
|
|
525
|
+
def y(self) -> int:
|
|
526
|
+
"""
|
|
527
|
+
Gets the y-coordinate of this block
|
|
528
|
+
"""
|
|
529
|
+
@property
|
|
530
|
+
def z(self) -> int:
|
|
531
|
+
"""
|
|
532
|
+
Gets the z-coordinate of this block
|
|
533
|
+
"""
|
|
534
|
+
class BlockBreakEvent(BlockEvent, Cancellable):
|
|
535
|
+
"""
|
|
536
|
+
Called when a block is broken by a player.
|
|
537
|
+
"""
|
|
538
|
+
@property
|
|
539
|
+
def player(self) -> Player:
|
|
540
|
+
"""
|
|
541
|
+
Gets the Player that is breaking the block involved in this event.
|
|
542
|
+
"""
|
|
543
|
+
class BlockData:
|
|
544
|
+
"""
|
|
545
|
+
Represents the data related to a live block
|
|
546
|
+
"""
|
|
547
|
+
def __str__(self) -> str:
|
|
548
|
+
...
|
|
549
|
+
@property
|
|
550
|
+
def block_states(self) -> dict[str, bool | str | int]:
|
|
551
|
+
"""
|
|
552
|
+
Gets the block states for this block.
|
|
553
|
+
"""
|
|
554
|
+
@property
|
|
555
|
+
def runtime_id(self) -> int:
|
|
556
|
+
"""
|
|
557
|
+
Gets the runtime id for this block.
|
|
558
|
+
"""
|
|
559
|
+
@property
|
|
560
|
+
def type(self) -> str:
|
|
561
|
+
"""
|
|
562
|
+
Get the block type represented by this block data.
|
|
563
|
+
"""
|
|
564
|
+
class BlockEvent(Event):
|
|
565
|
+
"""
|
|
566
|
+
Represents an Block-related event
|
|
567
|
+
"""
|
|
568
|
+
@property
|
|
569
|
+
def block(self) -> Block:
|
|
570
|
+
"""
|
|
571
|
+
Gets the block involved in this event.
|
|
572
|
+
"""
|
|
573
|
+
class BlockFace:
|
|
574
|
+
DOWN: typing.ClassVar[BlockFace] # value = <BlockFace.DOWN: 0>
|
|
575
|
+
EAST: typing.ClassVar[BlockFace] # value = <BlockFace.EAST: 5>
|
|
576
|
+
NORTH: typing.ClassVar[BlockFace] # value = <BlockFace.NORTH: 2>
|
|
577
|
+
SOUTH: typing.ClassVar[BlockFace] # value = <BlockFace.SOUTH: 3>
|
|
578
|
+
UP: typing.ClassVar[BlockFace] # value = <BlockFace.UP: 1>
|
|
579
|
+
WEST: typing.ClassVar[BlockFace] # value = <BlockFace.WEST: 4>
|
|
580
|
+
__members__: typing.ClassVar[dict[str, BlockFace]] # value = {'DOWN': <BlockFace.DOWN: 0>, 'UP': <BlockFace.UP: 1>, 'NORTH': <BlockFace.NORTH: 2>, 'SOUTH': <BlockFace.SOUTH: 3>, 'WEST': <BlockFace.WEST: 4>, 'EAST': <BlockFace.EAST: 5>}
|
|
581
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
582
|
+
...
|
|
583
|
+
def __getstate__(self) -> int:
|
|
584
|
+
...
|
|
585
|
+
def __hash__(self) -> int:
|
|
586
|
+
...
|
|
587
|
+
def __index__(self) -> int:
|
|
588
|
+
...
|
|
589
|
+
def __init__(self, value: int) -> None:
|
|
590
|
+
...
|
|
591
|
+
def __int__(self) -> int:
|
|
592
|
+
...
|
|
593
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
594
|
+
...
|
|
595
|
+
def __repr__(self) -> str:
|
|
596
|
+
...
|
|
597
|
+
def __setstate__(self, state: int) -> None:
|
|
598
|
+
...
|
|
599
|
+
def __str__(self) -> str:
|
|
600
|
+
...
|
|
601
|
+
@property
|
|
602
|
+
def name(self) -> str:
|
|
603
|
+
...
|
|
604
|
+
@property
|
|
605
|
+
def value(self) -> int:
|
|
606
|
+
...
|
|
607
|
+
class BlockPlaceEvent(BlockEvent, Cancellable):
|
|
608
|
+
"""
|
|
609
|
+
Called when a block is placed by a player.
|
|
610
|
+
"""
|
|
611
|
+
@property
|
|
612
|
+
def block_against(self) -> Block:
|
|
613
|
+
"""
|
|
614
|
+
Gets the block that this block was placed against
|
|
615
|
+
"""
|
|
616
|
+
@property
|
|
617
|
+
def block_placed_state(self) -> BlockState:
|
|
618
|
+
"""
|
|
619
|
+
Gets the BlockState for the block which was placed.
|
|
620
|
+
"""
|
|
621
|
+
@property
|
|
622
|
+
def block_replaced(self) -> Block:
|
|
623
|
+
"""
|
|
624
|
+
Gets the block which was replaced.
|
|
625
|
+
"""
|
|
626
|
+
@property
|
|
627
|
+
def player(self) -> Player:
|
|
628
|
+
"""
|
|
629
|
+
Gets the player who placed the block involved in this event.
|
|
630
|
+
"""
|
|
631
|
+
class BlockState:
|
|
632
|
+
"""
|
|
633
|
+
Represents a captured state of a block, which will not update automatically.
|
|
634
|
+
"""
|
|
635
|
+
def __str__(self) -> str:
|
|
636
|
+
...
|
|
637
|
+
def update(self, force: bool = False, apply_physics: bool = True) -> bool:
|
|
638
|
+
"""
|
|
639
|
+
Attempts to update the block represented by this state.
|
|
640
|
+
"""
|
|
641
|
+
@property
|
|
642
|
+
def block(self) -> Block:
|
|
643
|
+
"""
|
|
644
|
+
Gets the block represented by this block state.
|
|
645
|
+
"""
|
|
646
|
+
@property
|
|
647
|
+
def data(self) -> BlockData:
|
|
648
|
+
"""
|
|
649
|
+
Gets or sets the data for this block state.
|
|
650
|
+
"""
|
|
651
|
+
@data.setter
|
|
652
|
+
def data(self, arg1: BlockData) -> None:
|
|
653
|
+
...
|
|
654
|
+
@property
|
|
655
|
+
def dimension(self) -> Dimension:
|
|
656
|
+
"""
|
|
657
|
+
Gets the dimension which contains the block represented by this block state.
|
|
658
|
+
"""
|
|
659
|
+
@property
|
|
660
|
+
def location(self) -> Location:
|
|
661
|
+
"""
|
|
662
|
+
Gets the location of this block state.
|
|
663
|
+
"""
|
|
664
|
+
@property
|
|
665
|
+
def type(self) -> str:
|
|
666
|
+
"""
|
|
667
|
+
Gets or sets the type of this block state.
|
|
668
|
+
"""
|
|
669
|
+
@type.setter
|
|
670
|
+
def type(self, arg1: str) -> None:
|
|
671
|
+
...
|
|
672
|
+
@property
|
|
673
|
+
def x(self) -> int:
|
|
674
|
+
"""
|
|
675
|
+
Gets the x-coordinate of this block state.
|
|
676
|
+
"""
|
|
677
|
+
@property
|
|
678
|
+
def y(self) -> int:
|
|
679
|
+
"""
|
|
680
|
+
Gets the y-coordinate of this block state.
|
|
681
|
+
"""
|
|
682
|
+
@property
|
|
683
|
+
def z(self) -> int:
|
|
684
|
+
"""
|
|
685
|
+
Gets the z-coordinate of this block state.
|
|
686
|
+
"""
|
|
687
|
+
class BossBar:
|
|
688
|
+
"""
|
|
689
|
+
Represents a boss bar that is displayed to players.
|
|
690
|
+
"""
|
|
691
|
+
def add_flag(self, flag: BarFlag) -> None:
|
|
692
|
+
"""
|
|
693
|
+
Adds an optional flag to this boss bar.
|
|
694
|
+
"""
|
|
695
|
+
def add_player(self, player: Player) -> None:
|
|
696
|
+
"""
|
|
697
|
+
Adds the player to this boss bar causing it to display on their screen.
|
|
698
|
+
"""
|
|
699
|
+
def has_flag(self, flag: BarFlag) -> bool:
|
|
700
|
+
"""
|
|
701
|
+
Checks whether this boss bar has the passed flag set.
|
|
702
|
+
"""
|
|
703
|
+
def remove_all(self) -> None:
|
|
704
|
+
"""
|
|
705
|
+
Removes all players from this boss bar.
|
|
706
|
+
"""
|
|
707
|
+
def remove_flag(self, flag: BarFlag) -> None:
|
|
708
|
+
"""
|
|
709
|
+
Removes an existing flag on this boss bar.
|
|
710
|
+
"""
|
|
711
|
+
def remove_player(self, player: Player) -> None:
|
|
712
|
+
"""
|
|
713
|
+
Removes the player from this boss bar causing it to be removed from their screen.
|
|
714
|
+
"""
|
|
715
|
+
@property
|
|
716
|
+
def color(self) -> BarColor:
|
|
717
|
+
"""
|
|
718
|
+
The color of this boss bar.
|
|
719
|
+
"""
|
|
720
|
+
@color.setter
|
|
721
|
+
def color(self, arg1: BarColor) -> None:
|
|
722
|
+
...
|
|
723
|
+
@property
|
|
724
|
+
def is_visible(self) -> bool:
|
|
725
|
+
"""
|
|
726
|
+
If the boss bar is displayed to attached players.
|
|
727
|
+
"""
|
|
728
|
+
@is_visible.setter
|
|
729
|
+
def is_visible(self, arg1: bool) -> None:
|
|
730
|
+
...
|
|
731
|
+
@property
|
|
732
|
+
def players(self) -> list[Player]:
|
|
733
|
+
"""
|
|
734
|
+
Returns all players viewing this boss bar.
|
|
735
|
+
"""
|
|
736
|
+
@property
|
|
737
|
+
def progress(self) -> float:
|
|
738
|
+
"""
|
|
739
|
+
The progress of the bar between 0.0 and 1.0.
|
|
740
|
+
"""
|
|
741
|
+
@progress.setter
|
|
742
|
+
def progress(self, arg1: float) -> None:
|
|
743
|
+
...
|
|
744
|
+
@property
|
|
745
|
+
def style(self) -> BarStyle:
|
|
746
|
+
"""
|
|
747
|
+
The style of this boss bar.
|
|
748
|
+
"""
|
|
749
|
+
@style.setter
|
|
750
|
+
def style(self, arg1: BarStyle) -> None:
|
|
751
|
+
...
|
|
752
|
+
@property
|
|
753
|
+
def title(self) -> str:
|
|
754
|
+
"""
|
|
755
|
+
The title of this boss bar.
|
|
756
|
+
"""
|
|
757
|
+
@title.setter
|
|
758
|
+
def title(self, arg1: str) -> None:
|
|
759
|
+
...
|
|
760
|
+
class BroadcastMessageEvent(ServerEvent, Cancellable):
|
|
761
|
+
"""
|
|
762
|
+
Event triggered for server broadcast messages such as from Server.broadcast
|
|
763
|
+
"""
|
|
764
|
+
@property
|
|
765
|
+
def message(self) -> str | Translatable:
|
|
766
|
+
"""
|
|
767
|
+
Gets or sets the message to broadcast.
|
|
768
|
+
"""
|
|
769
|
+
@message.setter
|
|
770
|
+
def message(self, arg1: str | Translatable) -> None:
|
|
771
|
+
...
|
|
772
|
+
@property
|
|
773
|
+
def recipients(self) -> set[CommandSender]:
|
|
774
|
+
"""
|
|
775
|
+
Gets a set of recipients that this broadcast message will be displayed to.
|
|
776
|
+
"""
|
|
777
|
+
class Cancellable:
|
|
778
|
+
"""
|
|
779
|
+
Represents an event that may be cancelled by a plugin or the server.
|
|
780
|
+
"""
|
|
781
|
+
def cancel(self) -> None:
|
|
782
|
+
"""
|
|
783
|
+
Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
|
|
784
|
+
"""
|
|
785
|
+
@property
|
|
786
|
+
def cancelled(self) -> bool:
|
|
787
|
+
"""
|
|
788
|
+
Gets or sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins. [Warning] Deprecated: Use is_cancelled instead.
|
|
789
|
+
"""
|
|
790
|
+
@cancelled.setter
|
|
791
|
+
def cancelled(self, arg1: bool) -> None:
|
|
792
|
+
...
|
|
793
|
+
@property
|
|
794
|
+
def is_cancelled(self) -> bool:
|
|
795
|
+
"""
|
|
796
|
+
Gets or sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
|
|
797
|
+
"""
|
|
798
|
+
@is_cancelled.setter
|
|
799
|
+
def is_cancelled(self, arg1: bool) -> None:
|
|
800
|
+
...
|
|
801
|
+
class Chunk:
|
|
802
|
+
"""
|
|
803
|
+
Represents a chunk of blocks.
|
|
804
|
+
"""
|
|
805
|
+
def __repr__(self) -> str:
|
|
806
|
+
...
|
|
807
|
+
def __str__(self) -> str:
|
|
808
|
+
...
|
|
809
|
+
@property
|
|
810
|
+
def dimension(self) -> Dimension:
|
|
811
|
+
"""
|
|
812
|
+
Gets the dimension containing this chunk
|
|
813
|
+
"""
|
|
814
|
+
@property
|
|
815
|
+
def level(self) -> Level:
|
|
816
|
+
"""
|
|
817
|
+
Gets the level containing this chunk
|
|
818
|
+
"""
|
|
819
|
+
@property
|
|
820
|
+
def x(self) -> int:
|
|
821
|
+
"""
|
|
822
|
+
Gets the X-coordinate of this chunk
|
|
823
|
+
"""
|
|
824
|
+
@property
|
|
825
|
+
def z(self) -> int:
|
|
826
|
+
"""
|
|
827
|
+
Gets the Z-coordinate of this chunk
|
|
828
|
+
"""
|
|
829
|
+
class ChunkEvent(DimensionEvent):
|
|
830
|
+
"""
|
|
831
|
+
Represents a Chunk related event
|
|
832
|
+
"""
|
|
833
|
+
@property
|
|
834
|
+
def chunk(self) -> Chunk:
|
|
835
|
+
"""
|
|
836
|
+
Gets the chunk being loaded/unloaded
|
|
837
|
+
"""
|
|
838
|
+
class ChunkLoadEvent(ChunkEvent):
|
|
839
|
+
"""
|
|
840
|
+
Called when a chunk is loaded
|
|
841
|
+
"""
|
|
842
|
+
class ChunkUnloadEvent(ChunkEvent):
|
|
843
|
+
"""
|
|
844
|
+
Called when a chunk is unloaded
|
|
845
|
+
"""
|
|
846
|
+
class ColorFormat:
|
|
847
|
+
"""
|
|
848
|
+
All supported color and format codes.
|
|
849
|
+
"""
|
|
850
|
+
AQUA: typing.ClassVar[str] = '§b'
|
|
851
|
+
BLACK: typing.ClassVar[str] = '§0'
|
|
852
|
+
BLUE: typing.ClassVar[str] = '§9'
|
|
853
|
+
BOLD: typing.ClassVar[str] = '§l'
|
|
854
|
+
DARK_AQUA: typing.ClassVar[str] = '§3'
|
|
855
|
+
DARK_BLUE: typing.ClassVar[str] = '§1'
|
|
856
|
+
DARK_GRAY: typing.ClassVar[str] = '§8'
|
|
857
|
+
DARK_GREEN: typing.ClassVar[str] = '§2'
|
|
858
|
+
DARK_PURPLE: typing.ClassVar[str] = '§5'
|
|
859
|
+
DARK_RED: typing.ClassVar[str] = '§4'
|
|
860
|
+
GOLD: typing.ClassVar[str] = '§6'
|
|
861
|
+
GRAY: typing.ClassVar[str] = '§7'
|
|
862
|
+
GREEN: typing.ClassVar[str] = '§a'
|
|
863
|
+
ITALIC: typing.ClassVar[str] = '§o'
|
|
864
|
+
LIGHT_PURPLE: typing.ClassVar[str] = '§d'
|
|
865
|
+
MATERIAL_AMETHYST: typing.ClassVar[str] = '§u'
|
|
866
|
+
MATERIAL_COPPER: typing.ClassVar[str] = '§n'
|
|
867
|
+
MATERIAL_DIAMOND: typing.ClassVar[str] = '§s'
|
|
868
|
+
MATERIAL_EMERALD: typing.ClassVar[str] = '§q'
|
|
869
|
+
MATERIAL_GOLD: typing.ClassVar[str] = '§p'
|
|
870
|
+
MATERIAL_IRON: typing.ClassVar[str] = '§i'
|
|
871
|
+
MATERIAL_LAPIS: typing.ClassVar[str] = '§t'
|
|
872
|
+
MATERIAL_NETHERITE: typing.ClassVar[str] = '§j'
|
|
873
|
+
MATERIAL_QUARTZ: typing.ClassVar[str] = '§h'
|
|
874
|
+
MATERIAL_REDSTONE: typing.ClassVar[str] = '§m'
|
|
875
|
+
MATERIAL_RESIN: typing.ClassVar[str] = '§v'
|
|
876
|
+
MINECOIN_GOLD: typing.ClassVar[str] = '§g'
|
|
877
|
+
OBFUSCATED: typing.ClassVar[str] = '§k'
|
|
878
|
+
RED: typing.ClassVar[str] = '§c'
|
|
879
|
+
RESET: typing.ClassVar[str] = '§r'
|
|
880
|
+
WHITE: typing.ClassVar[str] = '§f'
|
|
881
|
+
YELLOW: typing.ClassVar[str] = '§e'
|
|
882
|
+
class Command:
|
|
883
|
+
"""
|
|
884
|
+
Represents a Command, which executes various tasks upon user input
|
|
885
|
+
"""
|
|
886
|
+
def __init__(self, name: str, description: str | None = None, usages: list[str] | None = None, aliases: list[str] | None = None, permissions: list[str] | None = None, *args, **kwargs) -> None:
|
|
887
|
+
...
|
|
888
|
+
def execute(self, sender: CommandSender, args: list[str]) -> bool:
|
|
889
|
+
"""
|
|
890
|
+
Executes the command, returning its success
|
|
891
|
+
"""
|
|
892
|
+
def test_permission(self, target: CommandSender) -> bool:
|
|
893
|
+
"""
|
|
894
|
+
Tests the given CommandSender to see if they can perform this command.
|
|
895
|
+
"""
|
|
896
|
+
def test_permission_silently(self, target: CommandSender) -> bool:
|
|
897
|
+
"""
|
|
898
|
+
Tests the given CommandSender to see if they can perform this command. No error is sent to the sender.
|
|
899
|
+
"""
|
|
900
|
+
@property
|
|
901
|
+
def aliases(self) -> list[str]:
|
|
902
|
+
"""
|
|
903
|
+
List of aliases of this command
|
|
904
|
+
"""
|
|
905
|
+
@aliases.setter
|
|
906
|
+
def aliases(self, arg1: list[str]) -> None:
|
|
907
|
+
...
|
|
908
|
+
@property
|
|
909
|
+
def description(self) -> str:
|
|
910
|
+
"""
|
|
911
|
+
Brief description of this command
|
|
912
|
+
"""
|
|
913
|
+
@description.setter
|
|
914
|
+
def description(self, arg1: str) -> None:
|
|
915
|
+
...
|
|
916
|
+
@property
|
|
917
|
+
def is_registered(self) -> bool:
|
|
918
|
+
"""
|
|
919
|
+
Returns the current registered state of this command
|
|
920
|
+
"""
|
|
921
|
+
@property
|
|
922
|
+
def name(self) -> str:
|
|
923
|
+
"""
|
|
924
|
+
Name of this command.
|
|
925
|
+
"""
|
|
926
|
+
@name.setter
|
|
927
|
+
def name(self, arg1: str) -> None:
|
|
928
|
+
...
|
|
929
|
+
@property
|
|
930
|
+
def permissions(self) -> list[str]:
|
|
931
|
+
"""
|
|
932
|
+
The permissions required by users to be able to perform this command
|
|
933
|
+
"""
|
|
934
|
+
@permissions.setter
|
|
935
|
+
def permissions(self, arg1: list[str]) -> None:
|
|
936
|
+
...
|
|
937
|
+
@property
|
|
938
|
+
def usages(self) -> list[str]:
|
|
939
|
+
"""
|
|
940
|
+
List of usages of this command
|
|
941
|
+
"""
|
|
942
|
+
@usages.setter
|
|
943
|
+
def usages(self, arg1: list[str]) -> None:
|
|
944
|
+
...
|
|
945
|
+
class CommandExecutor:
|
|
946
|
+
"""
|
|
947
|
+
Represents a class which contains a single method for executing commands
|
|
948
|
+
"""
|
|
949
|
+
def __init__(self) -> None:
|
|
950
|
+
...
|
|
951
|
+
def on_command(self, sender: CommandSender, command: Command, args: list[str]) -> bool:
|
|
952
|
+
"""
|
|
953
|
+
Executes the given command, returning its success.
|
|
954
|
+
"""
|
|
955
|
+
class CommandSender(Permissible):
|
|
956
|
+
"""
|
|
957
|
+
Represents a command sender.
|
|
958
|
+
"""
|
|
959
|
+
def send_error_message(self, message: str | Translatable) -> None:
|
|
960
|
+
"""
|
|
961
|
+
Sends this sender an error message
|
|
962
|
+
"""
|
|
963
|
+
def send_message(self, message: str | Translatable) -> None:
|
|
964
|
+
"""
|
|
965
|
+
Sends this sender a message
|
|
966
|
+
"""
|
|
967
|
+
@property
|
|
968
|
+
def name(self) -> str:
|
|
969
|
+
"""
|
|
970
|
+
Gets the name of this command sender
|
|
971
|
+
"""
|
|
972
|
+
@property
|
|
973
|
+
def server(self) -> Server:
|
|
974
|
+
"""
|
|
975
|
+
Returns the server instance that this command is running on
|
|
976
|
+
"""
|
|
977
|
+
class CommandSenderWrapper(CommandSender):
|
|
978
|
+
"""
|
|
979
|
+
Represents a wrapper that forwards commands to the wrapped CommandSender and captures its output
|
|
980
|
+
"""
|
|
981
|
+
def __init__(self, sender: CommandSender, on_message: typing.Callable[[str | Translatable], None] = None, on_error: typing.Callable[[str | Translatable], None] = None) -> None:
|
|
982
|
+
...
|
|
983
|
+
class ConsoleCommandSender(CommandSender):
|
|
984
|
+
"""
|
|
985
|
+
Represents a console command sender.
|
|
986
|
+
"""
|
|
987
|
+
class Criteria:
|
|
988
|
+
"""
|
|
989
|
+
Represents a scoreboard criteria.
|
|
990
|
+
"""
|
|
991
|
+
class Type:
|
|
992
|
+
"""
|
|
993
|
+
Represents a scoreboard criteria.
|
|
994
|
+
"""
|
|
995
|
+
DUMMY: typing.ClassVar[Criteria.Type] # value = <Type.DUMMY: 0>
|
|
996
|
+
__members__: typing.ClassVar[dict[str, Criteria.Type]] # value = {'DUMMY': <Type.DUMMY: 0>}
|
|
997
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
998
|
+
...
|
|
999
|
+
def __getstate__(self) -> int:
|
|
1000
|
+
...
|
|
1001
|
+
def __hash__(self) -> int:
|
|
1002
|
+
...
|
|
1003
|
+
def __index__(self) -> int:
|
|
1004
|
+
...
|
|
1005
|
+
def __init__(self, value: int) -> None:
|
|
1006
|
+
...
|
|
1007
|
+
def __int__(self) -> int:
|
|
1008
|
+
...
|
|
1009
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
1010
|
+
...
|
|
1011
|
+
def __repr__(self) -> str:
|
|
1012
|
+
...
|
|
1013
|
+
def __setstate__(self, state: int) -> None:
|
|
1014
|
+
...
|
|
1015
|
+
def __str__(self) -> str:
|
|
1016
|
+
...
|
|
1017
|
+
@property
|
|
1018
|
+
def name(self) -> str:
|
|
1019
|
+
...
|
|
1020
|
+
@property
|
|
1021
|
+
def value(self) -> int:
|
|
1022
|
+
...
|
|
1023
|
+
DUMMY: typing.ClassVar[Criteria.Type] # value = <Type.DUMMY: 0>
|
|
1024
|
+
@property
|
|
1025
|
+
def default_render_type(self) -> RenderType:
|
|
1026
|
+
...
|
|
1027
|
+
@property
|
|
1028
|
+
def is_read_only(self) -> bool:
|
|
1029
|
+
...
|
|
1030
|
+
@property
|
|
1031
|
+
def name(self) -> str:
|
|
1032
|
+
...
|
|
1033
|
+
class DamageSource:
|
|
1034
|
+
"""
|
|
1035
|
+
Represents a source of damage.
|
|
1036
|
+
"""
|
|
1037
|
+
def __str__(self) -> str:
|
|
1038
|
+
...
|
|
1039
|
+
@property
|
|
1040
|
+
def actor(self) -> Actor:
|
|
1041
|
+
"""
|
|
1042
|
+
Get the actor that caused the damage to occur.
|
|
1043
|
+
"""
|
|
1044
|
+
@property
|
|
1045
|
+
def damaging_actor(self) -> Actor:
|
|
1046
|
+
"""
|
|
1047
|
+
Get the actor that directly caused the damage.
|
|
1048
|
+
"""
|
|
1049
|
+
@property
|
|
1050
|
+
def is_indirect(self) -> bool:
|
|
1051
|
+
"""
|
|
1052
|
+
Get if this damage is indirect.
|
|
1053
|
+
"""
|
|
1054
|
+
@property
|
|
1055
|
+
def type(self) -> str:
|
|
1056
|
+
"""
|
|
1057
|
+
Get the damage type.
|
|
1058
|
+
"""
|
|
1059
|
+
class Dimension:
|
|
1060
|
+
"""
|
|
1061
|
+
Represents a dimension within a Level.
|
|
1062
|
+
"""
|
|
1063
|
+
class Type:
|
|
1064
|
+
"""
|
|
1065
|
+
Represents various dimension types.
|
|
1066
|
+
"""
|
|
1067
|
+
CUSTOM: typing.ClassVar[Dimension.Type] # value = <Type.CUSTOM: 999>
|
|
1068
|
+
NETHER: typing.ClassVar[Dimension.Type] # value = <Type.NETHER: 1>
|
|
1069
|
+
OVERWORLD: typing.ClassVar[Dimension.Type] # value = <Type.OVERWORLD: 0>
|
|
1070
|
+
THE_END: typing.ClassVar[Dimension.Type] # value = <Type.THE_END: 2>
|
|
1071
|
+
__members__: typing.ClassVar[dict[str, Dimension.Type]] # value = {'OVERWORLD': <Type.OVERWORLD: 0>, 'NETHER': <Type.NETHER: 1>, 'THE_END': <Type.THE_END: 2>, 'CUSTOM': <Type.CUSTOM: 999>}
|
|
1072
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
1073
|
+
...
|
|
1074
|
+
def __getstate__(self) -> int:
|
|
1075
|
+
...
|
|
1076
|
+
def __hash__(self) -> int:
|
|
1077
|
+
...
|
|
1078
|
+
def __index__(self) -> int:
|
|
1079
|
+
...
|
|
1080
|
+
def __init__(self, value: int) -> None:
|
|
1081
|
+
...
|
|
1082
|
+
def __int__(self) -> int:
|
|
1083
|
+
...
|
|
1084
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
1085
|
+
...
|
|
1086
|
+
def __repr__(self) -> str:
|
|
1087
|
+
...
|
|
1088
|
+
def __setstate__(self, state: int) -> None:
|
|
1089
|
+
...
|
|
1090
|
+
def __str__(self) -> str:
|
|
1091
|
+
...
|
|
1092
|
+
@property
|
|
1093
|
+
def name(self) -> str:
|
|
1094
|
+
...
|
|
1095
|
+
@property
|
|
1096
|
+
def value(self) -> int:
|
|
1097
|
+
...
|
|
1098
|
+
CUSTOM: typing.ClassVar[Dimension.Type] # value = <Type.CUSTOM: 999>
|
|
1099
|
+
NETHER: typing.ClassVar[Dimension.Type] # value = <Type.NETHER: 1>
|
|
1100
|
+
OVERWORLD: typing.ClassVar[Dimension.Type] # value = <Type.OVERWORLD: 0>
|
|
1101
|
+
THE_END: typing.ClassVar[Dimension.Type] # value = <Type.THE_END: 2>
|
|
1102
|
+
@typing.overload
|
|
1103
|
+
def get_block_at(self, location: Location) -> Block:
|
|
1104
|
+
"""
|
|
1105
|
+
Gets the Block at the given Location
|
|
1106
|
+
"""
|
|
1107
|
+
@typing.overload
|
|
1108
|
+
def get_block_at(self, x: int, y: int, z: int) -> Block:
|
|
1109
|
+
"""
|
|
1110
|
+
Gets the Block at the given coordinates
|
|
1111
|
+
"""
|
|
1112
|
+
@typing.overload
|
|
1113
|
+
def get_highest_block_at(self, location: Location) -> Block:
|
|
1114
|
+
"""
|
|
1115
|
+
Gets the highest non-empty (impassable) block at the given Location.
|
|
1116
|
+
"""
|
|
1117
|
+
@typing.overload
|
|
1118
|
+
def get_highest_block_at(self, x: int, z: int) -> Block:
|
|
1119
|
+
"""
|
|
1120
|
+
Gets the highest non-empty (impassable) block at the given coordinates.
|
|
1121
|
+
"""
|
|
1122
|
+
def get_highest_block_y_at(self, x: int, z: int) -> int:
|
|
1123
|
+
"""
|
|
1124
|
+
Gets the highest non-empty (impassable) coordinate at the given coordinates.
|
|
1125
|
+
"""
|
|
1126
|
+
@property
|
|
1127
|
+
def level(self) -> Level:
|
|
1128
|
+
"""
|
|
1129
|
+
Gets the level to which this dimension belongs
|
|
1130
|
+
"""
|
|
1131
|
+
@property
|
|
1132
|
+
def loaded_chunks(self) -> list[Chunk]:
|
|
1133
|
+
"""
|
|
1134
|
+
Gets a list of all loaded Chunks
|
|
1135
|
+
"""
|
|
1136
|
+
@property
|
|
1137
|
+
def name(self) -> str:
|
|
1138
|
+
"""
|
|
1139
|
+
Gets the name of this dimension
|
|
1140
|
+
"""
|
|
1141
|
+
@property
|
|
1142
|
+
def type(self) -> Dimension.Type:
|
|
1143
|
+
"""
|
|
1144
|
+
Gets the type of this dimension
|
|
1145
|
+
"""
|
|
1146
|
+
class DimensionEvent(LevelEvent):
|
|
1147
|
+
"""
|
|
1148
|
+
Represents events within a dimension
|
|
1149
|
+
"""
|
|
1150
|
+
@property
|
|
1151
|
+
def dimension(self) -> Dimension:
|
|
1152
|
+
"""
|
|
1153
|
+
Gets the dimension primarily involved with this event
|
|
1154
|
+
"""
|
|
1155
|
+
class DisplaySlot:
|
|
1156
|
+
"""
|
|
1157
|
+
Locations for displaying objectives to the player
|
|
1158
|
+
"""
|
|
1159
|
+
BELOW_NAME: typing.ClassVar[DisplaySlot] # value = <DisplaySlot.BELOW_NAME: 0>
|
|
1160
|
+
PLAYER_LIST: typing.ClassVar[DisplaySlot] # value = <DisplaySlot.PLAYER_LIST: 1>
|
|
1161
|
+
SIDE_BAR: typing.ClassVar[DisplaySlot] # value = <DisplaySlot.SIDE_BAR: 2>
|
|
1162
|
+
__members__: typing.ClassVar[dict[str, DisplaySlot]] # value = {'BELOW_NAME': <DisplaySlot.BELOW_NAME: 0>, 'PLAYER_LIST': <DisplaySlot.PLAYER_LIST: 1>, 'SIDE_BAR': <DisplaySlot.SIDE_BAR: 2>}
|
|
1163
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
1164
|
+
...
|
|
1165
|
+
def __getstate__(self) -> int:
|
|
1166
|
+
...
|
|
1167
|
+
def __hash__(self) -> int:
|
|
1168
|
+
...
|
|
1169
|
+
def __index__(self) -> int:
|
|
1170
|
+
...
|
|
1171
|
+
def __init__(self, value: int) -> None:
|
|
1172
|
+
...
|
|
1173
|
+
def __int__(self) -> int:
|
|
1174
|
+
...
|
|
1175
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
1176
|
+
...
|
|
1177
|
+
def __repr__(self) -> str:
|
|
1178
|
+
...
|
|
1179
|
+
def __setstate__(self, state: int) -> None:
|
|
1180
|
+
...
|
|
1181
|
+
def __str__(self) -> str:
|
|
1182
|
+
...
|
|
1183
|
+
@property
|
|
1184
|
+
def name(self) -> str:
|
|
1185
|
+
...
|
|
1186
|
+
@property
|
|
1187
|
+
def value(self) -> int:
|
|
1188
|
+
...
|
|
1189
|
+
class Divider:
|
|
1190
|
+
"""
|
|
1191
|
+
Represents a divider.
|
|
1192
|
+
"""
|
|
1193
|
+
def __init__(self) -> None:
|
|
1194
|
+
...
|
|
1195
|
+
class Dropdown:
|
|
1196
|
+
"""
|
|
1197
|
+
Represents a dropdown with a set of predefined options.
|
|
1198
|
+
"""
|
|
1199
|
+
def __init__(self, label: str | Translatable = '', options: list[str] | None = None, default_index: int | None = None) -> None:
|
|
1200
|
+
...
|
|
1201
|
+
def add_option(self, option: str) -> Dropdown:
|
|
1202
|
+
"""
|
|
1203
|
+
Adds a new option to the dropdown.
|
|
1204
|
+
"""
|
|
1205
|
+
@property
|
|
1206
|
+
def default_index(self) -> int | None:
|
|
1207
|
+
"""
|
|
1208
|
+
Gets or sets the optional default index of the dropdown.
|
|
1209
|
+
"""
|
|
1210
|
+
@default_index.setter
|
|
1211
|
+
def default_index(self, arg1: int | None) -> Dropdown:
|
|
1212
|
+
...
|
|
1213
|
+
@property
|
|
1214
|
+
def label(self) -> str | Translatable:
|
|
1215
|
+
"""
|
|
1216
|
+
Gets or sets the label of the dropdown.
|
|
1217
|
+
"""
|
|
1218
|
+
@label.setter
|
|
1219
|
+
def label(self, arg1: str | Translatable) -> Dropdown:
|
|
1220
|
+
...
|
|
1221
|
+
@property
|
|
1222
|
+
def options(self) -> list[str]:
|
|
1223
|
+
"""
|
|
1224
|
+
Gets or sets the options of the dropdown.
|
|
1225
|
+
"""
|
|
1226
|
+
@options.setter
|
|
1227
|
+
def options(self, arg1: list[str]) -> Dropdown:
|
|
1228
|
+
...
|
|
1229
|
+
class Enchantment:
|
|
1230
|
+
def can_enchant_item(self, item: ItemStack) -> bool:
|
|
1231
|
+
"""
|
|
1232
|
+
Checks if this Enchantment may be applied to the given ItemStack.
|
|
1233
|
+
|
|
1234
|
+
This does not check if it conflicts with any enchantments already applied to the item.
|
|
1235
|
+
"""
|
|
1236
|
+
def conflicts_with(self, other: Enchantment) -> bool:
|
|
1237
|
+
"""
|
|
1238
|
+
Check if this enchantment conflicts with another enchantment.
|
|
1239
|
+
"""
|
|
1240
|
+
@property
|
|
1241
|
+
def key(self) -> NamespacedKey:
|
|
1242
|
+
"""
|
|
1243
|
+
Return the namespaced identifier for this enchantment.
|
|
1244
|
+
"""
|
|
1245
|
+
@property
|
|
1246
|
+
def max_level(self) -> int:
|
|
1247
|
+
"""
|
|
1248
|
+
Gets the maximum level that this Enchantment may become.
|
|
1249
|
+
"""
|
|
1250
|
+
@property
|
|
1251
|
+
def start_level(self) -> int:
|
|
1252
|
+
"""
|
|
1253
|
+
Gets the level that this Enchantment should start at (also known as minimum level).
|
|
1254
|
+
"""
|
|
1255
|
+
@property
|
|
1256
|
+
def translation_key(self) -> str:
|
|
1257
|
+
"""
|
|
1258
|
+
Get the translation key, suitable for use in a translation component.
|
|
1259
|
+
"""
|
|
1260
|
+
class EnchantmentRegistry:
|
|
1261
|
+
@typing.overload
|
|
1262
|
+
def __contains__(self, key: NamespacedKey) -> bool:
|
|
1263
|
+
...
|
|
1264
|
+
@typing.overload
|
|
1265
|
+
def __contains__(self, key: str) -> bool:
|
|
1266
|
+
...
|
|
1267
|
+
@typing.overload
|
|
1268
|
+
def __getitem__(self, key: NamespacedKey) -> Enchantment:
|
|
1269
|
+
...
|
|
1270
|
+
@typing.overload
|
|
1271
|
+
def __getitem__(self, key: str) -> Enchantment:
|
|
1272
|
+
...
|
|
1273
|
+
def __iter__(self) -> list:
|
|
1274
|
+
...
|
|
1275
|
+
def get(self, key: NamespacedKey) -> Enchantment:
|
|
1276
|
+
...
|
|
1277
|
+
def get_or_throw(self, key: NamespacedKey) -> Enchantment:
|
|
1278
|
+
...
|
|
1279
|
+
class EquipmentSlot:
|
|
1280
|
+
BODY: typing.ClassVar[EquipmentSlot] # value = <EquipmentSlot.BODY: 6>
|
|
1281
|
+
CHEST: typing.ClassVar[EquipmentSlot] # value = <EquipmentSlot.CHEST: 4>
|
|
1282
|
+
FEET: typing.ClassVar[EquipmentSlot] # value = <EquipmentSlot.FEET: 2>
|
|
1283
|
+
HAND: typing.ClassVar[EquipmentSlot] # value = <EquipmentSlot.HAND: 0>
|
|
1284
|
+
HEAD: typing.ClassVar[EquipmentSlot] # value = <EquipmentSlot.HEAD: 5>
|
|
1285
|
+
LEGS: typing.ClassVar[EquipmentSlot] # value = <EquipmentSlot.LEGS: 3>
|
|
1286
|
+
OFF_HAND: typing.ClassVar[EquipmentSlot] # value = <EquipmentSlot.OFF_HAND: 1>
|
|
1287
|
+
__members__: typing.ClassVar[dict[str, EquipmentSlot]] # value = {'HAND': <EquipmentSlot.HAND: 0>, 'OFF_HAND': <EquipmentSlot.OFF_HAND: 1>, 'FEET': <EquipmentSlot.FEET: 2>, 'LEGS': <EquipmentSlot.LEGS: 3>, 'CHEST': <EquipmentSlot.CHEST: 4>, 'HEAD': <EquipmentSlot.HEAD: 5>, 'BODY': <EquipmentSlot.BODY: 6>}
|
|
1288
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
1289
|
+
...
|
|
1290
|
+
def __getstate__(self) -> int:
|
|
1291
|
+
...
|
|
1292
|
+
def __hash__(self) -> int:
|
|
1293
|
+
...
|
|
1294
|
+
def __index__(self) -> int:
|
|
1295
|
+
...
|
|
1296
|
+
def __init__(self, value: int) -> None:
|
|
1297
|
+
...
|
|
1298
|
+
def __int__(self) -> int:
|
|
1299
|
+
...
|
|
1300
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
1301
|
+
...
|
|
1302
|
+
def __repr__(self) -> str:
|
|
1303
|
+
...
|
|
1304
|
+
def __setstate__(self, state: int) -> None:
|
|
1305
|
+
...
|
|
1306
|
+
def __str__(self) -> str:
|
|
1307
|
+
...
|
|
1308
|
+
@property
|
|
1309
|
+
def name(self) -> str:
|
|
1310
|
+
...
|
|
1311
|
+
@property
|
|
1312
|
+
def value(self) -> int:
|
|
1313
|
+
...
|
|
1314
|
+
class Event:
|
|
1315
|
+
"""
|
|
1316
|
+
Represents an event.
|
|
1317
|
+
"""
|
|
1318
|
+
@property
|
|
1319
|
+
def event_name(self) -> str:
|
|
1320
|
+
"""
|
|
1321
|
+
Gets a user-friendly identifier for this event.
|
|
1322
|
+
"""
|
|
1323
|
+
@property
|
|
1324
|
+
def is_asynchronous(self) -> bool:
|
|
1325
|
+
"""
|
|
1326
|
+
Whether the event fires asynchronously.
|
|
1327
|
+
"""
|
|
1328
|
+
class EventPriority:
|
|
1329
|
+
"""
|
|
1330
|
+
Listeners are called in following order: LOWEST -> LOW -> NORMAL -> HIGH -> HIGHEST -> MONITOR
|
|
1331
|
+
"""
|
|
1332
|
+
HIGH: typing.ClassVar[EventPriority] # value = <EventPriority.HIGH: 3>
|
|
1333
|
+
HIGHEST: typing.ClassVar[EventPriority] # value = <EventPriority.HIGHEST: 4>
|
|
1334
|
+
LOW: typing.ClassVar[EventPriority] # value = <EventPriority.LOW: 1>
|
|
1335
|
+
LOWEST: typing.ClassVar[EventPriority] # value = <EventPriority.LOWEST: 0>
|
|
1336
|
+
MONITOR: typing.ClassVar[EventPriority] # value = <EventPriority.MONITOR: 5>
|
|
1337
|
+
NORMAL: typing.ClassVar[EventPriority] # value = <EventPriority.NORMAL: 2>
|
|
1338
|
+
__members__: typing.ClassVar[dict[str, EventPriority]] # value = {'LOWEST': <EventPriority.LOWEST: 0>, 'LOW': <EventPriority.LOW: 1>, 'NORMAL': <EventPriority.NORMAL: 2>, 'HIGH': <EventPriority.HIGH: 3>, 'HIGHEST': <EventPriority.HIGHEST: 4>, 'MONITOR': <EventPriority.MONITOR: 5>}
|
|
1339
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
1340
|
+
...
|
|
1341
|
+
def __getstate__(self) -> int:
|
|
1342
|
+
...
|
|
1343
|
+
def __hash__(self) -> int:
|
|
1344
|
+
...
|
|
1345
|
+
def __index__(self) -> int:
|
|
1346
|
+
...
|
|
1347
|
+
def __init__(self, value: int) -> None:
|
|
1348
|
+
...
|
|
1349
|
+
def __int__(self) -> int:
|
|
1350
|
+
...
|
|
1351
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
1352
|
+
...
|
|
1353
|
+
def __repr__(self) -> str:
|
|
1354
|
+
...
|
|
1355
|
+
def __setstate__(self, state: int) -> None:
|
|
1356
|
+
...
|
|
1357
|
+
def __str__(self) -> str:
|
|
1358
|
+
...
|
|
1359
|
+
@property
|
|
1360
|
+
def name(self) -> str:
|
|
1361
|
+
...
|
|
1362
|
+
@property
|
|
1363
|
+
def value(self) -> int:
|
|
1364
|
+
...
|
|
1365
|
+
class GameMode:
|
|
1366
|
+
"""
|
|
1367
|
+
Represents the various type of game modes that Players may have.
|
|
1368
|
+
"""
|
|
1369
|
+
ADVENTURE: typing.ClassVar[GameMode] # value = <GameMode.ADVENTURE: 2>
|
|
1370
|
+
CREATIVE: typing.ClassVar[GameMode] # value = <GameMode.CREATIVE: 1>
|
|
1371
|
+
SPECTATOR: typing.ClassVar[GameMode] # value = <GameMode.SPECTATOR: 3>
|
|
1372
|
+
SURVIVAL: typing.ClassVar[GameMode] # value = <GameMode.SURVIVAL: 0>
|
|
1373
|
+
__members__: typing.ClassVar[dict[str, GameMode]] # value = {'SURVIVAL': <GameMode.SURVIVAL: 0>, 'CREATIVE': <GameMode.CREATIVE: 1>, 'ADVENTURE': <GameMode.ADVENTURE: 2>, 'SPECTATOR': <GameMode.SPECTATOR: 3>}
|
|
1374
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
1375
|
+
...
|
|
1376
|
+
def __getstate__(self) -> int:
|
|
1377
|
+
...
|
|
1378
|
+
def __hash__(self) -> int:
|
|
1379
|
+
...
|
|
1380
|
+
def __index__(self) -> int:
|
|
1381
|
+
...
|
|
1382
|
+
def __init__(self, value: int) -> None:
|
|
1383
|
+
...
|
|
1384
|
+
def __int__(self) -> int:
|
|
1385
|
+
...
|
|
1386
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
1387
|
+
...
|
|
1388
|
+
def __repr__(self) -> str:
|
|
1389
|
+
...
|
|
1390
|
+
def __setstate__(self, state: int) -> None:
|
|
1391
|
+
...
|
|
1392
|
+
def __str__(self) -> str:
|
|
1393
|
+
...
|
|
1394
|
+
@property
|
|
1395
|
+
def name(self) -> str:
|
|
1396
|
+
...
|
|
1397
|
+
@property
|
|
1398
|
+
def value(self) -> int:
|
|
1399
|
+
...
|
|
1400
|
+
class Header:
|
|
1401
|
+
"""
|
|
1402
|
+
Represents a header with a label.
|
|
1403
|
+
"""
|
|
1404
|
+
def __init__(self, label: str | Translatable = '') -> None:
|
|
1405
|
+
...
|
|
1406
|
+
@property
|
|
1407
|
+
def label(self) -> str | Translatable:
|
|
1408
|
+
"""
|
|
1409
|
+
Gets or sets the label of the header.
|
|
1410
|
+
"""
|
|
1411
|
+
@label.setter
|
|
1412
|
+
def label(self, arg1: str | Translatable) -> Header:
|
|
1413
|
+
...
|
|
1414
|
+
class Inventory:
|
|
1415
|
+
"""
|
|
1416
|
+
Interface to the various inventories.
|
|
1417
|
+
"""
|
|
1418
|
+
@typing.overload
|
|
1419
|
+
def __contains__(self, item: ItemStack) -> bool:
|
|
1420
|
+
"""
|
|
1421
|
+
Checks if the inventory contains any ItemStacks with the given ItemStack.
|
|
1422
|
+
"""
|
|
1423
|
+
@typing.overload
|
|
1424
|
+
def __contains__(self, type: str) -> bool:
|
|
1425
|
+
"""
|
|
1426
|
+
Checks if the inventory contains any ItemStacks with the given ItemType.
|
|
1427
|
+
"""
|
|
1428
|
+
def __getitem__(self, index: int) -> ItemStack:
|
|
1429
|
+
"""
|
|
1430
|
+
Returns the ItemStack found in the slot at the given index
|
|
1431
|
+
"""
|
|
1432
|
+
def __len__(self) -> int:
|
|
1433
|
+
"""
|
|
1434
|
+
Returns the size of the inventory
|
|
1435
|
+
"""
|
|
1436
|
+
def __setitem__(self, index: int, item: ItemStack) -> None:
|
|
1437
|
+
"""
|
|
1438
|
+
Stores the ItemStack at the given index of the inventory.
|
|
1439
|
+
"""
|
|
1440
|
+
def add_item(self, *args) -> dict[int, ItemStack]:
|
|
1441
|
+
"""
|
|
1442
|
+
Stores the given ItemStacks in the inventory.
|
|
1443
|
+
This will try to fill existing stacks and empty slots as well as it can.
|
|
1444
|
+
|
|
1445
|
+
The returned map contains what it couldn't store, where the key is the index, and the value is the ItemStack.
|
|
1446
|
+
If all items are stored, it will return an empty dict.
|
|
1447
|
+
"""
|
|
1448
|
+
@typing.overload
|
|
1449
|
+
def all(self, item: ItemStack) -> dict[int, ItemStack]:
|
|
1450
|
+
"""
|
|
1451
|
+
Finds all slots in the inventory containing any ItemStacks with the given ItemStack.
|
|
1452
|
+
This will only match slots if both the type and the amount of the stack match
|
|
1453
|
+
The returned map contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack is found, an empty dict is returned.
|
|
1454
|
+
"""
|
|
1455
|
+
@typing.overload
|
|
1456
|
+
def all(self, type: str) -> dict[int, ItemStack]:
|
|
1457
|
+
"""
|
|
1458
|
+
Finds all slots in the inventory containing any ItemStacks with the given ItemType.
|
|
1459
|
+
The returned map contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack is found, an empty dict is returned.
|
|
1460
|
+
"""
|
|
1461
|
+
@typing.overload
|
|
1462
|
+
def clear(self, index: int) -> None:
|
|
1463
|
+
"""
|
|
1464
|
+
Clears out a particular slot in the index.
|
|
1465
|
+
"""
|
|
1466
|
+
@typing.overload
|
|
1467
|
+
def clear(self) -> None:
|
|
1468
|
+
"""
|
|
1469
|
+
Clears out the whole Inventory.
|
|
1470
|
+
"""
|
|
1471
|
+
@typing.overload
|
|
1472
|
+
def contains(self, item: ItemStack, amount: int) -> bool:
|
|
1473
|
+
"""
|
|
1474
|
+
Checks if the inventory contains at least the minimum amount specified of exactly matching ItemStacks.
|
|
1475
|
+
An ItemStack only counts if both the type and the amount of the stack match.
|
|
1476
|
+
"""
|
|
1477
|
+
@typing.overload
|
|
1478
|
+
def contains(self, item: ItemStack) -> bool:
|
|
1479
|
+
"""
|
|
1480
|
+
Checks if the inventory contains any ItemStacks with the given ItemStack.
|
|
1481
|
+
This will only return true if both the type and the amount of the stack match.
|
|
1482
|
+
"""
|
|
1483
|
+
@typing.overload
|
|
1484
|
+
def contains(self, type: str) -> bool:
|
|
1485
|
+
"""
|
|
1486
|
+
Checks if the inventory contains any ItemStacks with the given ItemType.
|
|
1487
|
+
"""
|
|
1488
|
+
@typing.overload
|
|
1489
|
+
def contains_at_least(self, item: ItemStack, amount: int) -> bool:
|
|
1490
|
+
"""
|
|
1491
|
+
Checks if the inventory contains ItemStacks matching the given ItemStack whose amounts sum to at least the minimum amount specified.
|
|
1492
|
+
"""
|
|
1493
|
+
@typing.overload
|
|
1494
|
+
def contains_at_least(self, type: str, amount: int) -> bool:
|
|
1495
|
+
"""
|
|
1496
|
+
Checks if the inventory contains any ItemStacks with the given ItemType, adding to at least the minimum amount specified.
|
|
1497
|
+
"""
|
|
1498
|
+
@typing.overload
|
|
1499
|
+
def first(self, item: ItemStack) -> int:
|
|
1500
|
+
"""
|
|
1501
|
+
Returns the first slot in the inventory containing an ItemStack with the given stack.
|
|
1502
|
+
This will only match slots if both the type and the amount of the stack match
|
|
1503
|
+
The returned map contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack is found, an empty dict is returned.
|
|
1504
|
+
"""
|
|
1505
|
+
@typing.overload
|
|
1506
|
+
def first(self, type: str) -> int:
|
|
1507
|
+
"""
|
|
1508
|
+
Finds the first slot in the inventory containing an ItemStack with the given ItemType.
|
|
1509
|
+
The returned map contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack is found, an empty dict is returned.
|
|
1510
|
+
"""
|
|
1511
|
+
def get_item(self, index: int) -> ItemStack:
|
|
1512
|
+
"""
|
|
1513
|
+
Returns the ItemStack found in the slot at the given index
|
|
1514
|
+
"""
|
|
1515
|
+
@typing.overload
|
|
1516
|
+
def remove(self, item: ItemStack) -> None:
|
|
1517
|
+
"""
|
|
1518
|
+
Removes all stacks in the inventory matching the given stack.
|
|
1519
|
+
This will only match a slot if both the type and the amount of the stack match
|
|
1520
|
+
"""
|
|
1521
|
+
@typing.overload
|
|
1522
|
+
def remove(self, type: str) -> None:
|
|
1523
|
+
"""
|
|
1524
|
+
Removes all stacks in the inventory matching the given ItemType.
|
|
1525
|
+
"""
|
|
1526
|
+
def remove_item(self, *args) -> dict[int, ItemStack]:
|
|
1527
|
+
"""
|
|
1528
|
+
Removes the given ItemStacks from the inventory.
|
|
1529
|
+
It will try to remove 'as much as possible' from the types and amounts you give as arguments.
|
|
1530
|
+
|
|
1531
|
+
The returned HashMap contains what it couldn't remove, where the key is the index, and the value is the ItemStack.
|
|
1532
|
+
If all the given ItemStacks are removed, it will return an empty dict.
|
|
1533
|
+
"""
|
|
1534
|
+
def set_item(self, index: int, item: ItemStack) -> None:
|
|
1535
|
+
"""
|
|
1536
|
+
Stores the ItemStack at the given index of the inventory.
|
|
1537
|
+
"""
|
|
1538
|
+
@property
|
|
1539
|
+
def contents(self) -> list[ItemStack]:
|
|
1540
|
+
"""
|
|
1541
|
+
Returns all ItemStacks from the inventory
|
|
1542
|
+
"""
|
|
1543
|
+
@contents.setter
|
|
1544
|
+
def contents(self, arg1: list[ItemStack]) -> None:
|
|
1545
|
+
...
|
|
1546
|
+
@property
|
|
1547
|
+
def first_empty(self) -> int:
|
|
1548
|
+
"""
|
|
1549
|
+
Returns the first empty Slot.
|
|
1550
|
+
"""
|
|
1551
|
+
@property
|
|
1552
|
+
def is_empty(self) -> bool:
|
|
1553
|
+
"""
|
|
1554
|
+
Check whether this inventory is empty. An inventory is considered to be empty if there are no ItemStacks in any slot of this inventory.
|
|
1555
|
+
"""
|
|
1556
|
+
@property
|
|
1557
|
+
def max_stack_size(self) -> int:
|
|
1558
|
+
"""
|
|
1559
|
+
Returns the maximum stack size for an ItemStack in this inventory.
|
|
1560
|
+
"""
|
|
1561
|
+
@property
|
|
1562
|
+
def size(self) -> int:
|
|
1563
|
+
"""
|
|
1564
|
+
Returns the size of the inventory
|
|
1565
|
+
"""
|
|
1566
|
+
class IpBanEntry(BanEntry):
|
|
1567
|
+
"""
|
|
1568
|
+
Represents a ban entry for an IP address.
|
|
1569
|
+
"""
|
|
1570
|
+
def __init__(self, address: str) -> None:
|
|
1571
|
+
...
|
|
1572
|
+
@property
|
|
1573
|
+
def address(self) -> str:
|
|
1574
|
+
"""
|
|
1575
|
+
Gets the banned IP address.
|
|
1576
|
+
"""
|
|
1577
|
+
class IpBanList:
|
|
1578
|
+
"""
|
|
1579
|
+
Represents a ban list containing banned IP addresses.
|
|
1580
|
+
"""
|
|
1581
|
+
def add_ban(self, address: str, reason: str | None = None, expires: datetime.datetime | None = None, source: str | None = None) -> IpBanEntry:
|
|
1582
|
+
"""
|
|
1583
|
+
Adds a ban to this list, or updates an existing one.
|
|
1584
|
+
"""
|
|
1585
|
+
def get_ban_entry(self, address: str) -> IpBanEntry:
|
|
1586
|
+
"""
|
|
1587
|
+
Gets a BanEntry by IP address.
|
|
1588
|
+
"""
|
|
1589
|
+
def is_banned(self, address: str) -> bool:
|
|
1590
|
+
"""
|
|
1591
|
+
Checks if a BanEntry exists for the target by IP address.
|
|
1592
|
+
"""
|
|
1593
|
+
def remove_ban(self, address: str) -> None:
|
|
1594
|
+
"""
|
|
1595
|
+
Removes an IP address from the ban list.
|
|
1596
|
+
"""
|
|
1597
|
+
@property
|
|
1598
|
+
def entries(self) -> list[IpBanEntry]:
|
|
1599
|
+
"""
|
|
1600
|
+
Gets a vector of pointers to entries in the ban list.
|
|
1601
|
+
"""
|
|
1602
|
+
class ItemFactory:
|
|
1603
|
+
def as_meta_for(self, meta: ItemMeta, type: ItemType) -> ItemMeta:
|
|
1604
|
+
"""
|
|
1605
|
+
Returns an appropriate item meta for the specified item type.
|
|
1606
|
+
"""
|
|
1607
|
+
def equals(self, meta1: ItemMeta, meta2: ItemMeta) -> bool:
|
|
1608
|
+
"""
|
|
1609
|
+
This method is used to compare two ItemMeta objects.
|
|
1610
|
+
"""
|
|
1611
|
+
def get_item_meta(self, type: ItemType) -> ItemMeta:
|
|
1612
|
+
"""
|
|
1613
|
+
This creates a new item meta for the item type.
|
|
1614
|
+
"""
|
|
1615
|
+
def is_applicable(self, meta: ItemMeta, type: ItemType) -> bool:
|
|
1616
|
+
"""
|
|
1617
|
+
This method checks the item meta to confirm that it is applicable (no data lost if applied) to the specified ItemStack
|
|
1618
|
+
"""
|
|
1619
|
+
class ItemMeta:
|
|
1620
|
+
"""
|
|
1621
|
+
Represents the metadata of a generic item.
|
|
1622
|
+
"""
|
|
1623
|
+
def add_enchant(self, id: str, level: int, force: bool = False) -> bool:
|
|
1624
|
+
"""
|
|
1625
|
+
Adds the specified enchantment to this item meta.
|
|
1626
|
+
"""
|
|
1627
|
+
def clone(self) -> ItemMeta:
|
|
1628
|
+
"""
|
|
1629
|
+
Creates a clone of the current metadata.
|
|
1630
|
+
"""
|
|
1631
|
+
def get_enchant_level(self, id: str) -> int:
|
|
1632
|
+
"""
|
|
1633
|
+
Checks for the level of the specified enchantment.
|
|
1634
|
+
"""
|
|
1635
|
+
def has_enchant(self, id: str) -> bool:
|
|
1636
|
+
"""
|
|
1637
|
+
Checks for existence of the specified enchantment.
|
|
1638
|
+
"""
|
|
1639
|
+
def remove_enchant(self, id: str) -> bool:
|
|
1640
|
+
"""
|
|
1641
|
+
Removes the specified enchantment from this item meta.
|
|
1642
|
+
"""
|
|
1643
|
+
def remove_enchants(self) -> None:
|
|
1644
|
+
"""
|
|
1645
|
+
Removes all enchantments from this item meta.
|
|
1646
|
+
"""
|
|
1647
|
+
@property
|
|
1648
|
+
def damage(self) -> int:
|
|
1649
|
+
"""
|
|
1650
|
+
Gets or sets the damage.
|
|
1651
|
+
"""
|
|
1652
|
+
@damage.setter
|
|
1653
|
+
def damage(self, arg1: int) -> None:
|
|
1654
|
+
...
|
|
1655
|
+
@property
|
|
1656
|
+
def display_name(self) -> str | None:
|
|
1657
|
+
"""
|
|
1658
|
+
Gets or sets the display name.
|
|
1659
|
+
"""
|
|
1660
|
+
@display_name.setter
|
|
1661
|
+
def display_name(self, arg1: str | None) -> None:
|
|
1662
|
+
...
|
|
1663
|
+
@property
|
|
1664
|
+
def enchants(self) -> dict[str, int]:
|
|
1665
|
+
"""
|
|
1666
|
+
Returns a copy the enchantments in this ItemMeta.
|
|
1667
|
+
"""
|
|
1668
|
+
@property
|
|
1669
|
+
def has_damage(self) -> bool:
|
|
1670
|
+
"""
|
|
1671
|
+
Checks to see if this item has damage.
|
|
1672
|
+
"""
|
|
1673
|
+
@property
|
|
1674
|
+
def has_display_name(self) -> bool:
|
|
1675
|
+
"""
|
|
1676
|
+
Checks for existence of a display name.
|
|
1677
|
+
"""
|
|
1678
|
+
@property
|
|
1679
|
+
def has_enchants(self) -> bool:
|
|
1680
|
+
"""
|
|
1681
|
+
Checks for the existence of any enchantments.
|
|
1682
|
+
"""
|
|
1683
|
+
@property
|
|
1684
|
+
def has_lore(self) -> bool:
|
|
1685
|
+
"""
|
|
1686
|
+
Checks for existence of lore.
|
|
1687
|
+
"""
|
|
1688
|
+
@property
|
|
1689
|
+
def has_repair_cost(self) -> bool:
|
|
1690
|
+
"""
|
|
1691
|
+
Checks to see if this item has a repair penalty.
|
|
1692
|
+
"""
|
|
1693
|
+
@property
|
|
1694
|
+
def is_unbreakable(self) -> bool:
|
|
1695
|
+
"""
|
|
1696
|
+
Gets or sets the unbreakable tag. An unbreakable item will not lose durability.
|
|
1697
|
+
"""
|
|
1698
|
+
@is_unbreakable.setter
|
|
1699
|
+
def is_unbreakable(self, arg1: bool) -> None:
|
|
1700
|
+
...
|
|
1701
|
+
@property
|
|
1702
|
+
def lore(self) -> list[str] | None:
|
|
1703
|
+
"""
|
|
1704
|
+
Gets or sets the lore for this item.
|
|
1705
|
+
"""
|
|
1706
|
+
@lore.setter
|
|
1707
|
+
def lore(self, arg1: list[str] | None) -> None:
|
|
1708
|
+
...
|
|
1709
|
+
@property
|
|
1710
|
+
def repair_cost(self) -> int:
|
|
1711
|
+
"""
|
|
1712
|
+
Gets or sets the repair penalty.
|
|
1713
|
+
"""
|
|
1714
|
+
@repair_cost.setter
|
|
1715
|
+
def repair_cost(self, arg1: int) -> None:
|
|
1716
|
+
...
|
|
1717
|
+
class ItemRegistry:
|
|
1718
|
+
@typing.overload
|
|
1719
|
+
def __contains__(self, key: NamespacedKey) -> bool:
|
|
1720
|
+
...
|
|
1721
|
+
@typing.overload
|
|
1722
|
+
def __contains__(self, key: str) -> bool:
|
|
1723
|
+
...
|
|
1724
|
+
@typing.overload
|
|
1725
|
+
def __getitem__(self, key: NamespacedKey) -> ItemType:
|
|
1726
|
+
...
|
|
1727
|
+
@typing.overload
|
|
1728
|
+
def __getitem__(self, key: str) -> ItemType:
|
|
1729
|
+
...
|
|
1730
|
+
def __iter__(self) -> list:
|
|
1731
|
+
...
|
|
1732
|
+
def get(self, key: NamespacedKey) -> ItemType:
|
|
1733
|
+
...
|
|
1734
|
+
def get_or_throw(self, key: NamespacedKey) -> ItemType:
|
|
1735
|
+
...
|
|
1736
|
+
class ItemStack:
|
|
1737
|
+
"""
|
|
1738
|
+
Represents a stack of items.
|
|
1739
|
+
"""
|
|
1740
|
+
__hash__: typing.ClassVar[None] = None
|
|
1741
|
+
def __eq__(self, arg0: ItemStack) -> bool:
|
|
1742
|
+
...
|
|
1743
|
+
def __init__(self, type: ItemType | str, amount: int = 1) -> None:
|
|
1744
|
+
...
|
|
1745
|
+
def __ne__(self, arg0: ItemStack) -> bool:
|
|
1746
|
+
...
|
|
1747
|
+
def __str__(self) -> str:
|
|
1748
|
+
...
|
|
1749
|
+
def is_similar(self, other: ItemStack) -> bool:
|
|
1750
|
+
"""
|
|
1751
|
+
Checks if the two stacks are equal, but does not consider stack size (amount).
|
|
1752
|
+
"""
|
|
1753
|
+
def set_item_meta(self, meta: ItemMeta) -> bool:
|
|
1754
|
+
"""
|
|
1755
|
+
Set the ItemMeta of this ItemStack.
|
|
1756
|
+
"""
|
|
1757
|
+
@property
|
|
1758
|
+
def amount(self) -> int:
|
|
1759
|
+
"""
|
|
1760
|
+
Gets or sets the amount of items in this stack.
|
|
1761
|
+
"""
|
|
1762
|
+
@amount.setter
|
|
1763
|
+
def amount(self, arg1: int) -> None:
|
|
1764
|
+
...
|
|
1765
|
+
@property
|
|
1766
|
+
def item_meta(self) -> ItemMeta:
|
|
1767
|
+
"""
|
|
1768
|
+
Gets a copy of the ItemMeta of this ItemStack.
|
|
1769
|
+
"""
|
|
1770
|
+
@property
|
|
1771
|
+
def max_stack_size(self) -> int:
|
|
1772
|
+
"""
|
|
1773
|
+
Get the maximum stack size for this item.
|
|
1774
|
+
"""
|
|
1775
|
+
@property
|
|
1776
|
+
def type(self) -> ItemType:
|
|
1777
|
+
"""
|
|
1778
|
+
Gets or sets the type of this item.
|
|
1779
|
+
"""
|
|
1780
|
+
@type.setter
|
|
1781
|
+
def type(self, arg1: ItemType | str) -> None:
|
|
1782
|
+
...
|
|
1783
|
+
class ItemType:
|
|
1784
|
+
"""
|
|
1785
|
+
Represents an item type.
|
|
1786
|
+
"""
|
|
1787
|
+
__hash__: typing.ClassVar[None] = None
|
|
1788
|
+
@staticmethod
|
|
1789
|
+
def get(name: str) -> ItemType:
|
|
1790
|
+
"""
|
|
1791
|
+
Attempts to get the ItemType with the given name.
|
|
1792
|
+
"""
|
|
1793
|
+
@typing.overload
|
|
1794
|
+
def __eq__(self, arg0: ItemType) -> bool:
|
|
1795
|
+
...
|
|
1796
|
+
@typing.overload
|
|
1797
|
+
def __eq__(self, arg0: str) -> bool:
|
|
1798
|
+
...
|
|
1799
|
+
@typing.overload
|
|
1800
|
+
def __ne__(self, arg0: ItemType) -> bool:
|
|
1801
|
+
...
|
|
1802
|
+
@typing.overload
|
|
1803
|
+
def __ne__(self, arg0: str) -> bool:
|
|
1804
|
+
...
|
|
1805
|
+
def __str__(self) -> str:
|
|
1806
|
+
...
|
|
1807
|
+
@property
|
|
1808
|
+
def id(self) -> str:
|
|
1809
|
+
"""
|
|
1810
|
+
Return the identifier of this item type.
|
|
1811
|
+
"""
|
|
1812
|
+
@property
|
|
1813
|
+
def key(self) -> NamespacedKey:
|
|
1814
|
+
"""
|
|
1815
|
+
Return the namespaced identifier of this item type.
|
|
1816
|
+
"""
|
|
1817
|
+
@property
|
|
1818
|
+
def max_durability(self) -> int:
|
|
1819
|
+
"""
|
|
1820
|
+
Gets the maximum durability of this item type
|
|
1821
|
+
"""
|
|
1822
|
+
@property
|
|
1823
|
+
def max_stack_size(self) -> int:
|
|
1824
|
+
"""
|
|
1825
|
+
Gets the maximum amount of this item type that can be held in a stack.
|
|
1826
|
+
"""
|
|
1827
|
+
@property
|
|
1828
|
+
def translation_key(self) -> str:
|
|
1829
|
+
"""
|
|
1830
|
+
Get the translation key, suitable for use in a translation component.
|
|
1831
|
+
"""
|
|
1832
|
+
class Label:
|
|
1833
|
+
"""
|
|
1834
|
+
Represents a text label.
|
|
1835
|
+
"""
|
|
1836
|
+
def __init__(self, text: str | Translatable = '') -> None:
|
|
1837
|
+
...
|
|
1838
|
+
@property
|
|
1839
|
+
def text(self) -> str | Translatable:
|
|
1840
|
+
"""
|
|
1841
|
+
Gets or sets the text of the label.
|
|
1842
|
+
"""
|
|
1843
|
+
@text.setter
|
|
1844
|
+
def text(self, arg1: str | Translatable) -> Label:
|
|
1845
|
+
...
|
|
1846
|
+
class Language:
|
|
1847
|
+
"""
|
|
1848
|
+
Represents the interface for translating text into different languages.
|
|
1849
|
+
"""
|
|
1850
|
+
@typing.overload
|
|
1851
|
+
def translate(self, text: str, params: list[str] | None = None, locale: str | None = None) -> str:
|
|
1852
|
+
"""
|
|
1853
|
+
Translates a given text using a set of parameters for a specific locale.
|
|
1854
|
+
"""
|
|
1855
|
+
@typing.overload
|
|
1856
|
+
def translate(self, translatable: Translatable, locale: str | None = None) -> str:
|
|
1857
|
+
"""
|
|
1858
|
+
Translates a Translatable object into a specific locale.
|
|
1859
|
+
"""
|
|
1860
|
+
@property
|
|
1861
|
+
def locale(self) -> str:
|
|
1862
|
+
"""
|
|
1863
|
+
Gets the current locale.
|
|
1864
|
+
"""
|
|
1865
|
+
class Level:
|
|
1866
|
+
def get_dimension(self, name: str) -> Dimension:
|
|
1867
|
+
"""
|
|
1868
|
+
Gets the dimension with the given name.
|
|
1869
|
+
"""
|
|
1870
|
+
@property
|
|
1871
|
+
def actors(self) -> list[Actor]:
|
|
1872
|
+
"""
|
|
1873
|
+
Get a list of all actors in this level
|
|
1874
|
+
"""
|
|
1875
|
+
@property
|
|
1876
|
+
def dimensions(self) -> list[Dimension]:
|
|
1877
|
+
"""
|
|
1878
|
+
Gets a list of all dimensions within this level.
|
|
1879
|
+
"""
|
|
1880
|
+
@property
|
|
1881
|
+
def name(self) -> str:
|
|
1882
|
+
"""
|
|
1883
|
+
Gets the unique name of this level
|
|
1884
|
+
"""
|
|
1885
|
+
@property
|
|
1886
|
+
def time(self) -> int:
|
|
1887
|
+
"""
|
|
1888
|
+
Gets and sets the relative in-game time on the server
|
|
1889
|
+
"""
|
|
1890
|
+
@time.setter
|
|
1891
|
+
def time(self, arg1: int) -> None:
|
|
1892
|
+
...
|
|
1893
|
+
class LevelEvent(Event):
|
|
1894
|
+
"""
|
|
1895
|
+
Represents events within a level
|
|
1896
|
+
"""
|
|
1897
|
+
@property
|
|
1898
|
+
def level(self) -> Level:
|
|
1899
|
+
"""
|
|
1900
|
+
Gets the level primarily involved with this event
|
|
1901
|
+
"""
|
|
1902
|
+
class Location(Position):
|
|
1903
|
+
"""
|
|
1904
|
+
Represents a 3-dimensional location in a dimension within a level.
|
|
1905
|
+
"""
|
|
1906
|
+
def __init__(self, dimension: Dimension, x: float, y: float, z: float, pitch: float = 0.0, yaw: float = 0.0) -> None:
|
|
1907
|
+
...
|
|
1908
|
+
def __repr__(self) -> str:
|
|
1909
|
+
...
|
|
1910
|
+
def __str__(self) -> str:
|
|
1911
|
+
...
|
|
1912
|
+
@property
|
|
1913
|
+
def pitch(self) -> float:
|
|
1914
|
+
"""
|
|
1915
|
+
The pitch of this location, measured in degrees.
|
|
1916
|
+
"""
|
|
1917
|
+
@pitch.setter
|
|
1918
|
+
def pitch(self, arg1: float) -> None:
|
|
1919
|
+
...
|
|
1920
|
+
@property
|
|
1921
|
+
def yaw(self) -> float:
|
|
1922
|
+
"""
|
|
1923
|
+
The yaw of this location, measured in degrees.
|
|
1924
|
+
"""
|
|
1925
|
+
@yaw.setter
|
|
1926
|
+
def yaw(self, arg1: float) -> None:
|
|
1927
|
+
...
|
|
1928
|
+
class Logger:
|
|
1929
|
+
"""
|
|
1930
|
+
Logger class which can format and output varies levels of logs.
|
|
1931
|
+
"""
|
|
1932
|
+
class Level:
|
|
1933
|
+
"""
|
|
1934
|
+
Specifies the log level.
|
|
1935
|
+
"""
|
|
1936
|
+
CRITICAL: typing.ClassVar[Logger.Level] # value = <Level.CRITICAL: 5>
|
|
1937
|
+
DEBUG: typing.ClassVar[Logger.Level] # value = <Level.DEBUG: 1>
|
|
1938
|
+
ERROR: typing.ClassVar[Logger.Level] # value = <Level.ERROR: 4>
|
|
1939
|
+
INFO: typing.ClassVar[Logger.Level] # value = <Level.INFO: 2>
|
|
1940
|
+
TRACE: typing.ClassVar[Logger.Level] # value = <Level.TRACE: 0>
|
|
1941
|
+
WARNING: typing.ClassVar[Logger.Level] # value = <Level.WARNING: 3>
|
|
1942
|
+
__members__: typing.ClassVar[dict[str, Logger.Level]] # value = {'TRACE': <Level.TRACE: 0>, 'DEBUG': <Level.DEBUG: 1>, 'INFO': <Level.INFO: 2>, 'WARNING': <Level.WARNING: 3>, 'ERROR': <Level.ERROR: 4>, 'CRITICAL': <Level.CRITICAL: 5>}
|
|
1943
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
1944
|
+
...
|
|
1945
|
+
def __getstate__(self) -> int:
|
|
1946
|
+
...
|
|
1947
|
+
def __hash__(self) -> int:
|
|
1948
|
+
...
|
|
1949
|
+
def __index__(self) -> int:
|
|
1950
|
+
...
|
|
1951
|
+
def __init__(self, value: int) -> None:
|
|
1952
|
+
...
|
|
1953
|
+
def __int__(self) -> int:
|
|
1954
|
+
...
|
|
1955
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
1956
|
+
...
|
|
1957
|
+
def __repr__(self) -> str:
|
|
1958
|
+
...
|
|
1959
|
+
def __setstate__(self, state: int) -> None:
|
|
1960
|
+
...
|
|
1961
|
+
def __str__(self) -> str:
|
|
1962
|
+
...
|
|
1963
|
+
@property
|
|
1964
|
+
def name(self) -> str:
|
|
1965
|
+
...
|
|
1966
|
+
@property
|
|
1967
|
+
def value(self) -> int:
|
|
1968
|
+
...
|
|
1969
|
+
CRITICAL: typing.ClassVar[Logger.Level] # value = <Level.CRITICAL: 5>
|
|
1970
|
+
DEBUG: typing.ClassVar[Logger.Level] # value = <Level.DEBUG: 1>
|
|
1971
|
+
ERROR: typing.ClassVar[Logger.Level] # value = <Level.ERROR: 4>
|
|
1972
|
+
INFO: typing.ClassVar[Logger.Level] # value = <Level.INFO: 2>
|
|
1973
|
+
TRACE: typing.ClassVar[Logger.Level] # value = <Level.TRACE: 0>
|
|
1974
|
+
WARNING: typing.ClassVar[Logger.Level] # value = <Level.WARNING: 3>
|
|
1975
|
+
def critical(self, message: str) -> None:
|
|
1976
|
+
"""
|
|
1977
|
+
Log a message at the CRITICAL level.
|
|
1978
|
+
"""
|
|
1979
|
+
def debug(self, message: str) -> None:
|
|
1980
|
+
"""
|
|
1981
|
+
Log a message at the DEBUG level.
|
|
1982
|
+
"""
|
|
1983
|
+
def error(self, message: str) -> None:
|
|
1984
|
+
"""
|
|
1985
|
+
Log a message at the ERROR level.
|
|
1986
|
+
"""
|
|
1987
|
+
def info(self, message: str) -> None:
|
|
1988
|
+
"""
|
|
1989
|
+
Log a message at the INFO level.
|
|
1990
|
+
"""
|
|
1991
|
+
def is_enabled_for(self, level: Logger.Level) -> bool:
|
|
1992
|
+
"""
|
|
1993
|
+
Check if the Logger instance is enabled for the given log Level.
|
|
1994
|
+
"""
|
|
1995
|
+
def set_level(self, level: Logger.Level) -> None:
|
|
1996
|
+
"""
|
|
1997
|
+
Set the logging level for this Logger instance.
|
|
1998
|
+
"""
|
|
1999
|
+
def trace(self, message: str) -> None:
|
|
2000
|
+
"""
|
|
2001
|
+
Log a message at the TRACE level.
|
|
2002
|
+
"""
|
|
2003
|
+
def warning(self, message: str) -> None:
|
|
2004
|
+
"""
|
|
2005
|
+
Log a message at the WARNING level.
|
|
2006
|
+
"""
|
|
2007
|
+
@property
|
|
2008
|
+
def name(self) -> str:
|
|
2009
|
+
"""
|
|
2010
|
+
Get the name of this Logger instance.
|
|
2011
|
+
"""
|
|
2012
|
+
class MapCanvas:
|
|
2013
|
+
"""
|
|
2014
|
+
Represents a canvas for drawing to a map. Each canvas is associated with a specific MapRenderer and represents that renderer's layer on the map.
|
|
2015
|
+
"""
|
|
2016
|
+
def draw_image(self, x: int, y: int, image: numpy.ndarray[numpy.uint8]) -> None:
|
|
2017
|
+
"""
|
|
2018
|
+
Draw an image to the map. The image will be clipped if necessary.
|
|
2019
|
+
"""
|
|
2020
|
+
def get_base_pixel_color(self, x: int, y: int) -> tuple[int, ...]:
|
|
2021
|
+
"""
|
|
2022
|
+
Get a pixel from the layers below this canvas.
|
|
2023
|
+
"""
|
|
2024
|
+
def get_pixel_color(self, x: int, y: int) -> tuple[int, ...] | None:
|
|
2025
|
+
"""
|
|
2026
|
+
Get a pixel from the canvas.
|
|
2027
|
+
|
|
2028
|
+
If no color is set at the given position for this canvas, then None is returned and the color returned by get_base_pixel_color() is shown on the map
|
|
2029
|
+
"""
|
|
2030
|
+
def set_pixel_color(self, x: int, y: int, color: tuple[int, ...] | None) -> None:
|
|
2031
|
+
"""
|
|
2032
|
+
Draw a pixel to the canvas.
|
|
2033
|
+
|
|
2034
|
+
If None is used as color, then the color returned by get_base_pixel_color() is shown on the map.
|
|
2035
|
+
"""
|
|
2036
|
+
@property
|
|
2037
|
+
def map_view(self) -> MapView:
|
|
2038
|
+
"""
|
|
2039
|
+
Get the map this canvas is attached to.
|
|
2040
|
+
"""
|
|
2041
|
+
class MapMeta(ItemMeta):
|
|
2042
|
+
"""
|
|
2043
|
+
Represents the metadata for a map item.
|
|
2044
|
+
"""
|
|
2045
|
+
class MapRenderer:
|
|
2046
|
+
"""
|
|
2047
|
+
Represents a renderer for a map.
|
|
2048
|
+
"""
|
|
2049
|
+
def __init__(self, is_contextual: bool = False) -> None:
|
|
2050
|
+
"""
|
|
2051
|
+
Initialize the map renderer base with the given contextual status.
|
|
2052
|
+
"""
|
|
2053
|
+
def initialize(self, view: MapView) -> None:
|
|
2054
|
+
"""
|
|
2055
|
+
Initialize this MapRenderer for the given map.
|
|
2056
|
+
"""
|
|
2057
|
+
def render(self, map: MapView, canvas: MapCanvas, player: Player) -> None:
|
|
2058
|
+
"""
|
|
2059
|
+
Render to the given map.
|
|
2060
|
+
"""
|
|
2061
|
+
class MapView:
|
|
2062
|
+
"""
|
|
2063
|
+
Represents a map item.
|
|
2064
|
+
"""
|
|
2065
|
+
class Scale:
|
|
2066
|
+
"""
|
|
2067
|
+
An enum representing all possible scales a map can be set to.
|
|
2068
|
+
"""
|
|
2069
|
+
CLOSE: typing.ClassVar[MapView.Scale] # value = <Scale.CLOSE: 1>
|
|
2070
|
+
CLOSEST: typing.ClassVar[MapView.Scale] # value = <Scale.CLOSEST: 0>
|
|
2071
|
+
FAR: typing.ClassVar[MapView.Scale] # value = <Scale.FAR: 3>
|
|
2072
|
+
FARTHEST: typing.ClassVar[MapView.Scale] # value = <Scale.FARTHEST: 4>
|
|
2073
|
+
NORMAL: typing.ClassVar[MapView.Scale] # value = <Scale.NORMAL: 2>
|
|
2074
|
+
__members__: typing.ClassVar[dict[str, MapView.Scale]] # value = {'CLOSEST': <Scale.CLOSEST: 0>, 'CLOSE': <Scale.CLOSE: 1>, 'NORMAL': <Scale.NORMAL: 2>, 'FAR': <Scale.FAR: 3>, 'FARTHEST': <Scale.FARTHEST: 4>}
|
|
2075
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
2076
|
+
...
|
|
2077
|
+
def __getstate__(self) -> int:
|
|
2078
|
+
...
|
|
2079
|
+
def __hash__(self) -> int:
|
|
2080
|
+
...
|
|
2081
|
+
def __index__(self) -> int:
|
|
2082
|
+
...
|
|
2083
|
+
def __init__(self, value: int) -> None:
|
|
2084
|
+
...
|
|
2085
|
+
def __int__(self) -> int:
|
|
2086
|
+
...
|
|
2087
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
2088
|
+
...
|
|
2089
|
+
def __repr__(self) -> str:
|
|
2090
|
+
...
|
|
2091
|
+
def __setstate__(self, state: int) -> None:
|
|
2092
|
+
...
|
|
2093
|
+
def __str__(self) -> str:
|
|
2094
|
+
...
|
|
2095
|
+
@property
|
|
2096
|
+
def name(self) -> str:
|
|
2097
|
+
...
|
|
2098
|
+
@property
|
|
2099
|
+
def value(self) -> int:
|
|
2100
|
+
...
|
|
2101
|
+
def add_renderer(self, renderer: MapRenderer) -> None:
|
|
2102
|
+
"""
|
|
2103
|
+
Add a renderer to this map.
|
|
2104
|
+
"""
|
|
2105
|
+
def remove_renderer(self, renderer: MapRenderer) -> bool:
|
|
2106
|
+
"""
|
|
2107
|
+
Remove a renderer from this map.
|
|
2108
|
+
"""
|
|
2109
|
+
@property
|
|
2110
|
+
def center_x(self) -> int:
|
|
2111
|
+
"""
|
|
2112
|
+
Get or set the center X position of this map.
|
|
2113
|
+
"""
|
|
2114
|
+
@center_x.setter
|
|
2115
|
+
def center_x(self, arg1: int) -> None:
|
|
2116
|
+
...
|
|
2117
|
+
@property
|
|
2118
|
+
def center_z(self) -> int:
|
|
2119
|
+
"""
|
|
2120
|
+
Get or set the center Z position of this map.
|
|
2121
|
+
"""
|
|
2122
|
+
@center_z.setter
|
|
2123
|
+
def center_z(self, arg1: int) -> None:
|
|
2124
|
+
...
|
|
2125
|
+
@property
|
|
2126
|
+
def dimension(self) -> Dimension:
|
|
2127
|
+
"""
|
|
2128
|
+
Get or set the dimension that this map is associated with.
|
|
2129
|
+
"""
|
|
2130
|
+
@dimension.setter
|
|
2131
|
+
def dimension(self, arg1: Dimension) -> None:
|
|
2132
|
+
...
|
|
2133
|
+
@property
|
|
2134
|
+
def id(self) -> int:
|
|
2135
|
+
"""
|
|
2136
|
+
Get the ID of this map item for use with MapMeta.
|
|
2137
|
+
"""
|
|
2138
|
+
@property
|
|
2139
|
+
def is_unlimited_tracking(self) -> bool:
|
|
2140
|
+
"""
|
|
2141
|
+
Whether the map will show a smaller position cursor (true), or no position cursor (false) when cursor is outside of map's range.
|
|
2142
|
+
"""
|
|
2143
|
+
@is_unlimited_tracking.setter
|
|
2144
|
+
def is_unlimited_tracking(self, arg1: bool) -> None:
|
|
2145
|
+
...
|
|
2146
|
+
@property
|
|
2147
|
+
def is_virtual(self) -> bool:
|
|
2148
|
+
"""
|
|
2149
|
+
Check whether this map is virtual.
|
|
2150
|
+
"""
|
|
2151
|
+
@property
|
|
2152
|
+
def locked(self) -> bool:
|
|
2153
|
+
"""
|
|
2154
|
+
Whether the map is locked or not. A locked map may not be explored further.
|
|
2155
|
+
"""
|
|
2156
|
+
@locked.setter
|
|
2157
|
+
def locked(self, arg1: bool) -> None:
|
|
2158
|
+
...
|
|
2159
|
+
@property
|
|
2160
|
+
def renderers(self) -> list[MapRenderer]:
|
|
2161
|
+
"""
|
|
2162
|
+
Get a copied list of MapRenderers currently in effect.
|
|
2163
|
+
"""
|
|
2164
|
+
@property
|
|
2165
|
+
def scale(self) -> MapView.Scale:
|
|
2166
|
+
"""
|
|
2167
|
+
Get or set the scale of this map.
|
|
2168
|
+
"""
|
|
2169
|
+
@scale.setter
|
|
2170
|
+
def scale(self, arg1: MapView.Scale) -> None:
|
|
2171
|
+
...
|
|
2172
|
+
class MessageForm:
|
|
2173
|
+
"""
|
|
2174
|
+
Represents a form with two buttons.
|
|
2175
|
+
"""
|
|
2176
|
+
def __init__(self, title: str | Translatable = '', content: str | Translatable = '', button1: str | Translatable = '', button2: str | Translatable = '', on_submit: typing.Callable[[Player, int], None] = None, on_close: typing.Callable[[Player], None] = None) -> None:
|
|
2177
|
+
...
|
|
2178
|
+
@property
|
|
2179
|
+
def button1(self) -> str | Translatable:
|
|
2180
|
+
"""
|
|
2181
|
+
Gets or sets the text of button1.
|
|
2182
|
+
"""
|
|
2183
|
+
@button1.setter
|
|
2184
|
+
def button1(self, arg1: str | Translatable) -> MessageForm:
|
|
2185
|
+
...
|
|
2186
|
+
@property
|
|
2187
|
+
def button2(self) -> str | Translatable:
|
|
2188
|
+
"""
|
|
2189
|
+
Gets or sets the text of button2.
|
|
2190
|
+
"""
|
|
2191
|
+
@button2.setter
|
|
2192
|
+
def button2(self, arg1: str | Translatable) -> MessageForm:
|
|
2193
|
+
...
|
|
2194
|
+
@property
|
|
2195
|
+
def content(self) -> str | Translatable:
|
|
2196
|
+
"""
|
|
2197
|
+
Gets or sets the content of the form.
|
|
2198
|
+
"""
|
|
2199
|
+
@content.setter
|
|
2200
|
+
def content(self, arg1: str | Translatable) -> MessageForm:
|
|
2201
|
+
...
|
|
2202
|
+
@property
|
|
2203
|
+
def on_close(self) -> typing.Callable[[Player], None]:
|
|
2204
|
+
"""
|
|
2205
|
+
Gets or sets the on close callback.
|
|
2206
|
+
"""
|
|
2207
|
+
@on_close.setter
|
|
2208
|
+
def on_close(self, arg1: typing.Callable[[Player], None]) -> MessageForm:
|
|
2209
|
+
...
|
|
2210
|
+
@property
|
|
2211
|
+
def on_submit(self) -> typing.Callable[[Player, int], None]:
|
|
2212
|
+
"""
|
|
2213
|
+
Gets or sets the on submit callback.
|
|
2214
|
+
"""
|
|
2215
|
+
@on_submit.setter
|
|
2216
|
+
def on_submit(self, arg1: typing.Callable[[Player, int], None]) -> MessageForm:
|
|
2217
|
+
...
|
|
2218
|
+
@property
|
|
2219
|
+
def title(self) -> str | Translatable:
|
|
2220
|
+
"""
|
|
2221
|
+
Gets or sets the title of the form.
|
|
2222
|
+
"""
|
|
2223
|
+
@title.setter
|
|
2224
|
+
def title(self, arg1: str | Translatable) -> MessageForm:
|
|
2225
|
+
...
|
|
2226
|
+
class Mob(Actor):
|
|
2227
|
+
"""
|
|
2228
|
+
Represents a mobile entity (i.e. living entity), such as a monster or player.
|
|
2229
|
+
"""
|
|
2230
|
+
@property
|
|
2231
|
+
def is_gliding(self) -> bool:
|
|
2232
|
+
"""
|
|
2233
|
+
Checks to see if an actor is gliding, such as using an Elytra.
|
|
2234
|
+
"""
|
|
2235
|
+
class MobEvent(Event):
|
|
2236
|
+
"""
|
|
2237
|
+
Represents an Mob-related event.
|
|
2238
|
+
"""
|
|
2239
|
+
@property
|
|
2240
|
+
def actor(self) -> Mob:
|
|
2241
|
+
"""
|
|
2242
|
+
Returns the Mob involved in this event
|
|
2243
|
+
"""
|
|
2244
|
+
class ModalForm:
|
|
2245
|
+
"""
|
|
2246
|
+
Represents a modal form with controls.
|
|
2247
|
+
"""
|
|
2248
|
+
def __init__(self, title: str | Translatable = '', controls: list[Dropdown | Label | Slider | StepSlider | TextInput | Toggle | Divider | Header] | None = None, submit_button: str | Translatable | None = None, icon: str | None = None, on_submit: typing.Callable[[Player, str], None] = None, on_close: typing.Callable[[Player], None] = None) -> None:
|
|
2249
|
+
...
|
|
2250
|
+
def add_control(self, control: Dropdown | Label | Slider | StepSlider | TextInput | Toggle | Divider | Header) -> ModalForm:
|
|
2251
|
+
"""
|
|
2252
|
+
Adds a control to the form.
|
|
2253
|
+
"""
|
|
2254
|
+
@property
|
|
2255
|
+
def controls(self) -> list[Dropdown | Label | Slider | StepSlider | TextInput | Toggle | Divider | Header]:
|
|
2256
|
+
"""
|
|
2257
|
+
Gets or sets the controls of the modal form.
|
|
2258
|
+
"""
|
|
2259
|
+
@controls.setter
|
|
2260
|
+
def controls(self, arg1: list[Dropdown | Label | Slider | StepSlider | TextInput | Toggle | Divider | Header]) -> ModalForm:
|
|
2261
|
+
...
|
|
2262
|
+
@property
|
|
2263
|
+
def icon(self) -> str | None:
|
|
2264
|
+
"""
|
|
2265
|
+
Gets or sets the icon of the form.
|
|
2266
|
+
"""
|
|
2267
|
+
@icon.setter
|
|
2268
|
+
def icon(self, arg1: str | None) -> ModalForm:
|
|
2269
|
+
...
|
|
2270
|
+
@property
|
|
2271
|
+
def on_close(self) -> typing.Callable[[Player], None]:
|
|
2272
|
+
"""
|
|
2273
|
+
Gets or sets the on close callback.
|
|
2274
|
+
"""
|
|
2275
|
+
@on_close.setter
|
|
2276
|
+
def on_close(self, arg1: typing.Callable[[Player], None]) -> ModalForm:
|
|
2277
|
+
...
|
|
2278
|
+
@property
|
|
2279
|
+
def on_submit(self) -> typing.Callable[[Player, str], None]:
|
|
2280
|
+
"""
|
|
2281
|
+
Gets or sets the on submit callback.
|
|
2282
|
+
"""
|
|
2283
|
+
@on_submit.setter
|
|
2284
|
+
def on_submit(self, arg1: typing.Callable[[Player, str], None]) -> ModalForm:
|
|
2285
|
+
...
|
|
2286
|
+
@property
|
|
2287
|
+
def submit_button(self) -> str | Translatable | None:
|
|
2288
|
+
"""
|
|
2289
|
+
Gets or sets the submit button message of the form.
|
|
2290
|
+
"""
|
|
2291
|
+
@submit_button.setter
|
|
2292
|
+
def submit_button(self, arg1: str | Translatable | None) -> ModalForm:
|
|
2293
|
+
...
|
|
2294
|
+
@property
|
|
2295
|
+
def title(self) -> str | Translatable:
|
|
2296
|
+
"""
|
|
2297
|
+
Gets or sets the title of the form.
|
|
2298
|
+
"""
|
|
2299
|
+
@title.setter
|
|
2300
|
+
def title(self, arg1: str | Translatable) -> ModalForm:
|
|
2301
|
+
...
|
|
2302
|
+
class NamespacedKey:
|
|
2303
|
+
"""
|
|
2304
|
+
Represents a string-based key which consists of two components - a namespace and a key.
|
|
2305
|
+
"""
|
|
2306
|
+
@staticmethod
|
|
2307
|
+
def from_string(input: str, plugin: Plugin = None) -> NamespacedKey:
|
|
2308
|
+
"""
|
|
2309
|
+
Parses a NamespacedKey from a string.
|
|
2310
|
+
"""
|
|
2311
|
+
def __init__(self, arg0: Plugin, arg1: str) -> None:
|
|
2312
|
+
...
|
|
2313
|
+
def __repr__(self) -> str:
|
|
2314
|
+
...
|
|
2315
|
+
def __str__(self) -> str:
|
|
2316
|
+
...
|
|
2317
|
+
@property
|
|
2318
|
+
def key(self) -> str:
|
|
2319
|
+
"""
|
|
2320
|
+
Returns the key of the NamespacedKey.
|
|
2321
|
+
"""
|
|
2322
|
+
@property
|
|
2323
|
+
def namespace(self) -> str:
|
|
2324
|
+
"""
|
|
2325
|
+
Returns the namespace of the NamespacedKey.
|
|
2326
|
+
"""
|
|
2327
|
+
class Objective:
|
|
2328
|
+
"""
|
|
2329
|
+
Represents an objective on a scoreboard that can show scores specific to entries.
|
|
2330
|
+
"""
|
|
2331
|
+
__hash__: typing.ClassVar[None] = None
|
|
2332
|
+
def __eq__(self, arg0: Objective) -> bool:
|
|
2333
|
+
...
|
|
2334
|
+
def __ne__(self, arg0: Objective) -> bool:
|
|
2335
|
+
...
|
|
2336
|
+
def get_score(self, entry: Player | Actor | str) -> Score:
|
|
2337
|
+
"""
|
|
2338
|
+
Gets an entry's Score for this objective
|
|
2339
|
+
"""
|
|
2340
|
+
def set_display(self, slot: DisplaySlot | None, order: ObjectiveSortOrder | None = None) -> None:
|
|
2341
|
+
"""
|
|
2342
|
+
Sets the display slot and sort order for this objective. This will remove it from any other display slot.
|
|
2343
|
+
"""
|
|
2344
|
+
def unregister(self) -> None:
|
|
2345
|
+
"""
|
|
2346
|
+
Unregisters this objective from the associated Scoreboard.
|
|
2347
|
+
"""
|
|
2348
|
+
@property
|
|
2349
|
+
def criteria(self) -> Criteria:
|
|
2350
|
+
"""
|
|
2351
|
+
Gets the criteria this objective tracks
|
|
2352
|
+
"""
|
|
2353
|
+
@property
|
|
2354
|
+
def display_name(self) -> str:
|
|
2355
|
+
"""
|
|
2356
|
+
Gets or sets the name displayed to players for this objective
|
|
2357
|
+
"""
|
|
2358
|
+
@display_name.setter
|
|
2359
|
+
def display_name(self, arg1: str) -> None:
|
|
2360
|
+
...
|
|
2361
|
+
@property
|
|
2362
|
+
def display_slot(self) -> DisplaySlot | None:
|
|
2363
|
+
"""
|
|
2364
|
+
Gets the display slot this objective is displayed at
|
|
2365
|
+
"""
|
|
2366
|
+
@property
|
|
2367
|
+
def is_displayed(self) -> bool:
|
|
2368
|
+
"""
|
|
2369
|
+
Gets if the objective is currently displayed in a slot.
|
|
2370
|
+
"""
|
|
2371
|
+
@property
|
|
2372
|
+
def is_modifiable(self) -> bool:
|
|
2373
|
+
"""
|
|
2374
|
+
Gets if the objective's scores can be modified directly by a plugin
|
|
2375
|
+
"""
|
|
2376
|
+
@property
|
|
2377
|
+
def name(self) -> str:
|
|
2378
|
+
"""
|
|
2379
|
+
Gets the name of this Objective
|
|
2380
|
+
"""
|
|
2381
|
+
@property
|
|
2382
|
+
def render_type(self) -> RenderType:
|
|
2383
|
+
"""
|
|
2384
|
+
Gets and sets the manner in which this objective will be rendered.
|
|
2385
|
+
"""
|
|
2386
|
+
@render_type.setter
|
|
2387
|
+
def render_type(self, arg1: RenderType) -> None:
|
|
2388
|
+
...
|
|
2389
|
+
@property
|
|
2390
|
+
def scoreboard(self) -> Scoreboard:
|
|
2391
|
+
"""
|
|
2392
|
+
Gets the scoreboard to which this objective is attached
|
|
2393
|
+
"""
|
|
2394
|
+
@property
|
|
2395
|
+
def sort_order(self) -> ObjectiveSortOrder | None:
|
|
2396
|
+
"""
|
|
2397
|
+
Gets and sets the sort order for this objective
|
|
2398
|
+
"""
|
|
2399
|
+
class ObjectiveSortOrder:
|
|
2400
|
+
"""
|
|
2401
|
+
Represents the sort order of objectives on a DisplaySlot.
|
|
2402
|
+
"""
|
|
2403
|
+
ASCENDING: typing.ClassVar[ObjectiveSortOrder] # value = <ObjectiveSortOrder.ASCENDING: 0>
|
|
2404
|
+
DESCENDING: typing.ClassVar[ObjectiveSortOrder] # value = <ObjectiveSortOrder.DESCENDING: 1>
|
|
2405
|
+
__members__: typing.ClassVar[dict[str, ObjectiveSortOrder]] # value = {'ASCENDING': <ObjectiveSortOrder.ASCENDING: 0>, 'DESCENDING': <ObjectiveSortOrder.DESCENDING: 1>}
|
|
2406
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
2407
|
+
...
|
|
2408
|
+
def __getstate__(self) -> int:
|
|
2409
|
+
...
|
|
2410
|
+
def __hash__(self) -> int:
|
|
2411
|
+
...
|
|
2412
|
+
def __index__(self) -> int:
|
|
2413
|
+
...
|
|
2414
|
+
def __init__(self, value: int) -> None:
|
|
2415
|
+
...
|
|
2416
|
+
def __int__(self) -> int:
|
|
2417
|
+
...
|
|
2418
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
2419
|
+
...
|
|
2420
|
+
def __repr__(self) -> str:
|
|
2421
|
+
...
|
|
2422
|
+
def __setstate__(self, state: int) -> None:
|
|
2423
|
+
...
|
|
2424
|
+
def __str__(self) -> str:
|
|
2425
|
+
...
|
|
2426
|
+
@property
|
|
2427
|
+
def name(self) -> str:
|
|
2428
|
+
...
|
|
2429
|
+
@property
|
|
2430
|
+
def value(self) -> int:
|
|
2431
|
+
...
|
|
2432
|
+
class OfflinePlayer:
|
|
2433
|
+
"""
|
|
2434
|
+
Represents a reference to a player identity and the data belonging to a player that is stored on the disk and can, thus, be retrieved without the player needing to be online.
|
|
2435
|
+
"""
|
|
2436
|
+
@property
|
|
2437
|
+
def name(self) -> str:
|
|
2438
|
+
"""
|
|
2439
|
+
Returns the name of this player
|
|
2440
|
+
"""
|
|
2441
|
+
@property
|
|
2442
|
+
def unique_id(self) -> uuid.UUID:
|
|
2443
|
+
"""
|
|
2444
|
+
Returns the UUID of this player
|
|
2445
|
+
"""
|
|
2446
|
+
class PacketReceiveEvent(ServerEvent, Cancellable):
|
|
2447
|
+
"""
|
|
2448
|
+
Called when the server receives a packet from a connected client.
|
|
2449
|
+
"""
|
|
2450
|
+
@property
|
|
2451
|
+
def address(self) -> SocketAddress:
|
|
2452
|
+
"""
|
|
2453
|
+
Gets the network address to which this packet is being sent.
|
|
2454
|
+
"""
|
|
2455
|
+
@property
|
|
2456
|
+
def packet_id(self) -> int:
|
|
2457
|
+
"""
|
|
2458
|
+
Gets the ID of the packet.
|
|
2459
|
+
"""
|
|
2460
|
+
@property
|
|
2461
|
+
def payload(self) -> bytes:
|
|
2462
|
+
"""
|
|
2463
|
+
Gets or sets the raw packet data **excluding** the header.
|
|
2464
|
+
"""
|
|
2465
|
+
@payload.setter
|
|
2466
|
+
def payload(self, arg1: bytes) -> None:
|
|
2467
|
+
...
|
|
2468
|
+
@property
|
|
2469
|
+
def player(self) -> Player:
|
|
2470
|
+
"""
|
|
2471
|
+
Gets the player involved in this event
|
|
2472
|
+
NOTE: This may return None if the packet is sent before the player completes the login process.
|
|
2473
|
+
"""
|
|
2474
|
+
@property
|
|
2475
|
+
def sub_client_id(self) -> int:
|
|
2476
|
+
"""
|
|
2477
|
+
Gets the SubClient ID (0 = primary client; 1-3 = split-screen clients).
|
|
2478
|
+
"""
|
|
2479
|
+
class PacketSendEvent(ServerEvent, Cancellable):
|
|
2480
|
+
"""
|
|
2481
|
+
Called when the server sends a packet to a connected client.
|
|
2482
|
+
"""
|
|
2483
|
+
@property
|
|
2484
|
+
def address(self) -> SocketAddress:
|
|
2485
|
+
"""
|
|
2486
|
+
Gets the network address to which this packet is being sent.
|
|
2487
|
+
"""
|
|
2488
|
+
@property
|
|
2489
|
+
def packet_id(self) -> int:
|
|
2490
|
+
"""
|
|
2491
|
+
Gets the ID of the packet.
|
|
2492
|
+
"""
|
|
2493
|
+
@property
|
|
2494
|
+
def payload(self) -> bytes:
|
|
2495
|
+
"""
|
|
2496
|
+
Gets or sets the raw packet data **excluding** the header.
|
|
2497
|
+
"""
|
|
2498
|
+
@payload.setter
|
|
2499
|
+
def payload(self, arg1: bytes) -> None:
|
|
2500
|
+
...
|
|
2501
|
+
@property
|
|
2502
|
+
def player(self) -> Player:
|
|
2503
|
+
"""
|
|
2504
|
+
Gets the player involved in this event
|
|
2505
|
+
NOTE: This may return None if the packet is sent before the player completes the login process.
|
|
2506
|
+
"""
|
|
2507
|
+
@property
|
|
2508
|
+
def sub_client_id(self) -> int:
|
|
2509
|
+
"""
|
|
2510
|
+
Gets the SubClient ID (0 = primary client; 1-3 = split-screen clients).
|
|
2511
|
+
"""
|
|
2512
|
+
class Permissible:
|
|
2513
|
+
"""
|
|
2514
|
+
Represents an object that may become a server operator and can be assigned permissions.
|
|
2515
|
+
"""
|
|
2516
|
+
@typing.overload
|
|
2517
|
+
def add_attachment(self, plugin: Plugin, name: str, value: bool) -> PermissionAttachment:
|
|
2518
|
+
"""
|
|
2519
|
+
Adds a new PermissionAttachment.
|
|
2520
|
+
"""
|
|
2521
|
+
@typing.overload
|
|
2522
|
+
def add_attachment(self, plugin: Plugin) -> PermissionAttachment:
|
|
2523
|
+
"""
|
|
2524
|
+
Adds a new PermissionAttachment.
|
|
2525
|
+
"""
|
|
2526
|
+
@typing.overload
|
|
2527
|
+
def has_permission(self, name: str) -> bool:
|
|
2528
|
+
"""
|
|
2529
|
+
Checks if a permissions is available by name.
|
|
2530
|
+
"""
|
|
2531
|
+
@typing.overload
|
|
2532
|
+
def has_permission(self, perm: Permission) -> bool:
|
|
2533
|
+
"""
|
|
2534
|
+
Checks if a permissions is available by permission.
|
|
2535
|
+
"""
|
|
2536
|
+
@typing.overload
|
|
2537
|
+
def is_permission_set(self, name: str) -> bool:
|
|
2538
|
+
"""
|
|
2539
|
+
Checks if a permissions is set by name.
|
|
2540
|
+
"""
|
|
2541
|
+
@typing.overload
|
|
2542
|
+
def is_permission_set(self, perm: Permission) -> bool:
|
|
2543
|
+
"""
|
|
2544
|
+
Checks if a permissions is set by permission.
|
|
2545
|
+
"""
|
|
2546
|
+
def recalculate_permissions(self) -> None:
|
|
2547
|
+
"""
|
|
2548
|
+
Recalculates the permissions.
|
|
2549
|
+
"""
|
|
2550
|
+
def remove_attachment(self, attachment: PermissionAttachment) -> None:
|
|
2551
|
+
"""
|
|
2552
|
+
Removes a given PermissionAttachment.
|
|
2553
|
+
"""
|
|
2554
|
+
@property
|
|
2555
|
+
def effective_permissions(self) -> set[PermissionAttachmentInfo]:
|
|
2556
|
+
"""
|
|
2557
|
+
Gets effective permissions.
|
|
2558
|
+
"""
|
|
2559
|
+
@property
|
|
2560
|
+
def is_op(self) -> bool:
|
|
2561
|
+
"""
|
|
2562
|
+
The operator status of this object
|
|
2563
|
+
"""
|
|
2564
|
+
@is_op.setter
|
|
2565
|
+
def is_op(self, arg1: bool) -> None:
|
|
2566
|
+
...
|
|
2567
|
+
class Permission:
|
|
2568
|
+
"""
|
|
2569
|
+
Represents a unique permission that may be attached to a Permissible
|
|
2570
|
+
"""
|
|
2571
|
+
def __init__(self, name: str, description: str | None = None, default: PermissionDefault | None = None, children: dict[str, bool] | None = None, *args, **kwargs) -> None:
|
|
2572
|
+
...
|
|
2573
|
+
@typing.overload
|
|
2574
|
+
def add_parent(self, name: str, value: bool) -> Permission:
|
|
2575
|
+
"""
|
|
2576
|
+
Adds this permission to the specified parent permission.
|
|
2577
|
+
"""
|
|
2578
|
+
@typing.overload
|
|
2579
|
+
def add_parent(self, perm: Permission, value: bool) -> None:
|
|
2580
|
+
"""
|
|
2581
|
+
Adds this permission to the specified parent permission.
|
|
2582
|
+
"""
|
|
2583
|
+
def recalculate_permissibles(self) -> None:
|
|
2584
|
+
"""
|
|
2585
|
+
Recalculates all Permissibles that contain this permission.
|
|
2586
|
+
"""
|
|
2587
|
+
@property
|
|
2588
|
+
def children(self) -> dict[str, bool]:
|
|
2589
|
+
"""
|
|
2590
|
+
Gets the children of this permission.
|
|
2591
|
+
"""
|
|
2592
|
+
@property
|
|
2593
|
+
def default(self) -> PermissionDefault:
|
|
2594
|
+
"""
|
|
2595
|
+
The default value of this permission.
|
|
2596
|
+
"""
|
|
2597
|
+
@default.setter
|
|
2598
|
+
def default(self, arg1: PermissionDefault) -> None:
|
|
2599
|
+
...
|
|
2600
|
+
@property
|
|
2601
|
+
def description(self) -> str:
|
|
2602
|
+
"""
|
|
2603
|
+
The brief description of this permission
|
|
2604
|
+
"""
|
|
2605
|
+
@description.setter
|
|
2606
|
+
def description(self, arg1: str) -> None:
|
|
2607
|
+
...
|
|
2608
|
+
@property
|
|
2609
|
+
def name(self) -> str:
|
|
2610
|
+
"""
|
|
2611
|
+
Gets the unique fully qualified name of this Permission.
|
|
2612
|
+
"""
|
|
2613
|
+
@property
|
|
2614
|
+
def permissibles(self) -> set[Permissible]:
|
|
2615
|
+
"""
|
|
2616
|
+
Gets a set containing every Permissible that has this permission.
|
|
2617
|
+
"""
|
|
2618
|
+
class PermissionAttachment:
|
|
2619
|
+
"""
|
|
2620
|
+
Holds information about a permission attachment on a Permissible object
|
|
2621
|
+
"""
|
|
2622
|
+
def __init__(self, plugin: Plugin, permissible: Permissible) -> None:
|
|
2623
|
+
...
|
|
2624
|
+
def remove(self) -> bool:
|
|
2625
|
+
"""
|
|
2626
|
+
Removes this attachment from its registered Permissible.
|
|
2627
|
+
"""
|
|
2628
|
+
@typing.overload
|
|
2629
|
+
def set_permission(self, name: str, value: bool) -> None:
|
|
2630
|
+
"""
|
|
2631
|
+
Sets a permission to the given value, by its fully qualified name.
|
|
2632
|
+
"""
|
|
2633
|
+
@typing.overload
|
|
2634
|
+
def set_permission(self, perm: Permission, value: bool) -> None:
|
|
2635
|
+
"""
|
|
2636
|
+
Sets a permission to the given value.
|
|
2637
|
+
"""
|
|
2638
|
+
@typing.overload
|
|
2639
|
+
def unset_permission(self, name: str) -> None:
|
|
2640
|
+
"""
|
|
2641
|
+
Removes the specified permission from this attachment by name.
|
|
2642
|
+
"""
|
|
2643
|
+
@typing.overload
|
|
2644
|
+
def unset_permission(self, perm: Permission) -> None:
|
|
2645
|
+
"""
|
|
2646
|
+
Removes the specified permission from this attachment.
|
|
2647
|
+
"""
|
|
2648
|
+
@property
|
|
2649
|
+
def permissible(self) -> Permissible:
|
|
2650
|
+
"""
|
|
2651
|
+
Gets the Permissible that this is attached to.
|
|
2652
|
+
"""
|
|
2653
|
+
@property
|
|
2654
|
+
def permissions(self) -> dict[str, bool]:
|
|
2655
|
+
"""
|
|
2656
|
+
Gets a copy of all set permissions and values contained within this attachment.
|
|
2657
|
+
"""
|
|
2658
|
+
@property
|
|
2659
|
+
def plugin(self) -> Plugin:
|
|
2660
|
+
"""
|
|
2661
|
+
Gets the plugin responsible for this attachment.
|
|
2662
|
+
"""
|
|
2663
|
+
@property
|
|
2664
|
+
def removal_callback(self) -> typing.Callable[[PermissionAttachment], None]:
|
|
2665
|
+
"""
|
|
2666
|
+
The callback to be called when this attachment is removed.
|
|
2667
|
+
"""
|
|
2668
|
+
@removal_callback.setter
|
|
2669
|
+
def removal_callback(self, arg1: typing.Callable[[PermissionAttachment], None]) -> None:
|
|
2670
|
+
...
|
|
2671
|
+
class PermissionAttachmentInfo:
|
|
2672
|
+
"""
|
|
2673
|
+
Holds information on a permission and which PermissionAttachment provides it
|
|
2674
|
+
"""
|
|
2675
|
+
def __init__(self, permissible: Permissible, permission: str, attachment: PermissionAttachment, value: bool) -> None:
|
|
2676
|
+
...
|
|
2677
|
+
@property
|
|
2678
|
+
def attachment(self) -> PermissionAttachment:
|
|
2679
|
+
"""
|
|
2680
|
+
Gets the attachment providing this permission.
|
|
2681
|
+
"""
|
|
2682
|
+
@property
|
|
2683
|
+
def permissible(self) -> Permissible:
|
|
2684
|
+
"""
|
|
2685
|
+
Get the permissible this is attached to
|
|
2686
|
+
"""
|
|
2687
|
+
@property
|
|
2688
|
+
def permission(self) -> str:
|
|
2689
|
+
"""
|
|
2690
|
+
Gets the permission being set
|
|
2691
|
+
"""
|
|
2692
|
+
@property
|
|
2693
|
+
def value(self) -> bool:
|
|
2694
|
+
"""
|
|
2695
|
+
Gets the value of this permission
|
|
2696
|
+
"""
|
|
2697
|
+
class PermissionDefault:
|
|
2698
|
+
"""
|
|
2699
|
+
Represents the possible default values for permissions
|
|
2700
|
+
"""
|
|
2701
|
+
FALSE: typing.ClassVar[PermissionDefault] # value = <PermissionDefault.FALSE: 1>
|
|
2702
|
+
NOT_OP: typing.ClassVar[PermissionDefault] # value = <PermissionDefault.NOT_OP: 3>
|
|
2703
|
+
NOT_OPERATOR: typing.ClassVar[PermissionDefault] # value = <PermissionDefault.NOT_OP: 3>
|
|
2704
|
+
OP: typing.ClassVar[PermissionDefault] # value = <PermissionDefault.OP: 2>
|
|
2705
|
+
OPERATOR: typing.ClassVar[PermissionDefault] # value = <PermissionDefault.OP: 2>
|
|
2706
|
+
TRUE: typing.ClassVar[PermissionDefault] # value = <PermissionDefault.TRUE: 0>
|
|
2707
|
+
__members__: typing.ClassVar[dict[str, PermissionDefault]] # value = {'TRUE': <PermissionDefault.TRUE: 0>, 'FALSE': <PermissionDefault.FALSE: 1>, 'OP': <PermissionDefault.OP: 2>, 'OPERATOR': <PermissionDefault.OP: 2>, 'NOT_OP': <PermissionDefault.NOT_OP: 3>, 'NOT_OPERATOR': <PermissionDefault.NOT_OP: 3>}
|
|
2708
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
2709
|
+
...
|
|
2710
|
+
def __getstate__(self) -> int:
|
|
2711
|
+
...
|
|
2712
|
+
def __hash__(self) -> int:
|
|
2713
|
+
...
|
|
2714
|
+
def __index__(self) -> int:
|
|
2715
|
+
...
|
|
2716
|
+
def __init__(self, value: int) -> None:
|
|
2717
|
+
...
|
|
2718
|
+
def __int__(self) -> int:
|
|
2719
|
+
...
|
|
2720
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
2721
|
+
...
|
|
2722
|
+
def __repr__(self) -> str:
|
|
2723
|
+
...
|
|
2724
|
+
def __setstate__(self, state: int) -> None:
|
|
2725
|
+
...
|
|
2726
|
+
def __str__(self) -> str:
|
|
2727
|
+
...
|
|
2728
|
+
@property
|
|
2729
|
+
def name(self) -> str:
|
|
2730
|
+
...
|
|
2731
|
+
@property
|
|
2732
|
+
def value(self) -> int:
|
|
2733
|
+
...
|
|
2734
|
+
class Player(Mob, OfflinePlayer):
|
|
2735
|
+
"""
|
|
2736
|
+
Represents a player.
|
|
2737
|
+
"""
|
|
2738
|
+
def close_form(self) -> None:
|
|
2739
|
+
"""
|
|
2740
|
+
Closes the forms that are currently open for the player.
|
|
2741
|
+
"""
|
|
2742
|
+
def give_exp(self, amount: int) -> None:
|
|
2743
|
+
"""
|
|
2744
|
+
Gives the player the amount of experience specified.
|
|
2745
|
+
"""
|
|
2746
|
+
def give_exp_levels(self, amount: int) -> None:
|
|
2747
|
+
"""
|
|
2748
|
+
Gives the player the amount of experience levels specified.
|
|
2749
|
+
"""
|
|
2750
|
+
def kick(self, message: str) -> None:
|
|
2751
|
+
"""
|
|
2752
|
+
Kicks player with custom kick message.
|
|
2753
|
+
"""
|
|
2754
|
+
def perform_command(self, command: str) -> bool:
|
|
2755
|
+
"""
|
|
2756
|
+
Makes the player perform the given command.
|
|
2757
|
+
"""
|
|
2758
|
+
def play_sound(self, location: Location, sound: str, volume: float = 1.0, pitch: float = 1.0) -> None:
|
|
2759
|
+
"""
|
|
2760
|
+
Play a sound for a player at the location.
|
|
2761
|
+
"""
|
|
2762
|
+
def reset_title(self) -> None:
|
|
2763
|
+
"""
|
|
2764
|
+
Resets the title displayed to the player. This will clear the displayed title / subtitle and reset timings to their default values.
|
|
2765
|
+
"""
|
|
2766
|
+
def send_form(self, form: MessageForm | ActionForm | ModalForm) -> None:
|
|
2767
|
+
"""
|
|
2768
|
+
Sends a form to the player.
|
|
2769
|
+
"""
|
|
2770
|
+
def send_packet(self, packet_id: int, payload: bytes) -> None:
|
|
2771
|
+
"""
|
|
2772
|
+
Sends a packet to the player.
|
|
2773
|
+
"""
|
|
2774
|
+
def send_popup(self, message: str) -> None:
|
|
2775
|
+
"""
|
|
2776
|
+
Sends this player a popup message
|
|
2777
|
+
"""
|
|
2778
|
+
def send_tip(self, message: str) -> None:
|
|
2779
|
+
"""
|
|
2780
|
+
Sends this player a tip message
|
|
2781
|
+
"""
|
|
2782
|
+
def send_title(self, title: str, subtitle: str, fade_in: int = 10, stay: int = 70, fade_out: int = 20) -> None:
|
|
2783
|
+
"""
|
|
2784
|
+
Sends a title and a subtitle message to the player. If they are empty strings, the display will be updated as such.
|
|
2785
|
+
"""
|
|
2786
|
+
def send_toast(self, title: str, content: str) -> None:
|
|
2787
|
+
"""
|
|
2788
|
+
Sends this player a toast notification.
|
|
2789
|
+
"""
|
|
2790
|
+
@typing.overload
|
|
2791
|
+
def spawn_particle(self, name: str, location: Location, molang_variables_json: str | None = None) -> None:
|
|
2792
|
+
"""
|
|
2793
|
+
Spawns the particle at the target location.
|
|
2794
|
+
"""
|
|
2795
|
+
@typing.overload
|
|
2796
|
+
def spawn_particle(self, name: str, x: float, y: float, z: float, molang_variables_json: str | None = None) -> None:
|
|
2797
|
+
"""
|
|
2798
|
+
Spawns the particle at the target location.
|
|
2799
|
+
"""
|
|
2800
|
+
def stop_all_sounds(self) -> None:
|
|
2801
|
+
"""
|
|
2802
|
+
Stop all sounds from playing.
|
|
2803
|
+
"""
|
|
2804
|
+
def stop_sound(self, sound: str) -> None:
|
|
2805
|
+
"""
|
|
2806
|
+
Stop the specified sound from playing.
|
|
2807
|
+
"""
|
|
2808
|
+
def transfer(self, host: str, port: int = 19132) -> None:
|
|
2809
|
+
"""
|
|
2810
|
+
Transfers the player to another server.
|
|
2811
|
+
"""
|
|
2812
|
+
def update_commands(self) -> None:
|
|
2813
|
+
"""
|
|
2814
|
+
Send the list of commands to the client.
|
|
2815
|
+
"""
|
|
2816
|
+
@property
|
|
2817
|
+
def address(self) -> SocketAddress:
|
|
2818
|
+
"""
|
|
2819
|
+
Gets the socket address of this player
|
|
2820
|
+
"""
|
|
2821
|
+
@property
|
|
2822
|
+
def allow_flight(self) -> bool:
|
|
2823
|
+
"""
|
|
2824
|
+
If the Player is allowed to fly via jump key double-tap.
|
|
2825
|
+
"""
|
|
2826
|
+
@allow_flight.setter
|
|
2827
|
+
def allow_flight(self, arg1: bool) -> None:
|
|
2828
|
+
...
|
|
2829
|
+
@property
|
|
2830
|
+
def device_id(self) -> str:
|
|
2831
|
+
"""
|
|
2832
|
+
Get the player's current device id.
|
|
2833
|
+
"""
|
|
2834
|
+
@property
|
|
2835
|
+
def device_os(self) -> str:
|
|
2836
|
+
"""
|
|
2837
|
+
Get the player's current device's operation system (OS).
|
|
2838
|
+
"""
|
|
2839
|
+
@property
|
|
2840
|
+
def exp_level(self) -> int:
|
|
2841
|
+
"""
|
|
2842
|
+
Gets or sets the players current experience level.
|
|
2843
|
+
"""
|
|
2844
|
+
@exp_level.setter
|
|
2845
|
+
def exp_level(self, arg1: int) -> None:
|
|
2846
|
+
...
|
|
2847
|
+
@property
|
|
2848
|
+
def exp_progress(self) -> float:
|
|
2849
|
+
"""
|
|
2850
|
+
Gets or sets the players current experience progress towards the next level.
|
|
2851
|
+
"""
|
|
2852
|
+
@exp_progress.setter
|
|
2853
|
+
def exp_progress(self, arg1: float) -> None:
|
|
2854
|
+
...
|
|
2855
|
+
@property
|
|
2856
|
+
def fly_speed(self) -> float:
|
|
2857
|
+
"""
|
|
2858
|
+
Gets or sets the current allowed speed that a client can fly.
|
|
2859
|
+
"""
|
|
2860
|
+
@fly_speed.setter
|
|
2861
|
+
def fly_speed(self, arg1: float) -> None:
|
|
2862
|
+
...
|
|
2863
|
+
@property
|
|
2864
|
+
def game_mode(self) -> GameMode:
|
|
2865
|
+
"""
|
|
2866
|
+
The player's current game mode.
|
|
2867
|
+
"""
|
|
2868
|
+
@game_mode.setter
|
|
2869
|
+
def game_mode(self, arg1: GameMode) -> None:
|
|
2870
|
+
...
|
|
2871
|
+
@property
|
|
2872
|
+
def game_version(self) -> str:
|
|
2873
|
+
"""
|
|
2874
|
+
Get the player's current game version.
|
|
2875
|
+
"""
|
|
2876
|
+
@property
|
|
2877
|
+
def inventory(self) -> PlayerInventory:
|
|
2878
|
+
"""
|
|
2879
|
+
Get the player's inventory.
|
|
2880
|
+
"""
|
|
2881
|
+
@property
|
|
2882
|
+
def is_flying(self) -> bool:
|
|
2883
|
+
"""
|
|
2884
|
+
If the player is currently flying or not.
|
|
2885
|
+
"""
|
|
2886
|
+
@is_flying.setter
|
|
2887
|
+
def is_flying(self, arg1: bool) -> None:
|
|
2888
|
+
...
|
|
2889
|
+
@property
|
|
2890
|
+
def is_sneaking(self) -> bool:
|
|
2891
|
+
"""
|
|
2892
|
+
Gets or sets the sneak mode of the player
|
|
2893
|
+
"""
|
|
2894
|
+
@is_sneaking.setter
|
|
2895
|
+
def is_sneaking(self, arg1: bool) -> None:
|
|
2896
|
+
...
|
|
2897
|
+
@property
|
|
2898
|
+
def is_sprinting(self) -> bool:
|
|
2899
|
+
"""
|
|
2900
|
+
Gets or sets whether the player is sprinting or not.
|
|
2901
|
+
"""
|
|
2902
|
+
@is_sprinting.setter
|
|
2903
|
+
def is_sprinting(self, arg1: bool) -> None:
|
|
2904
|
+
...
|
|
2905
|
+
@property
|
|
2906
|
+
def locale(self) -> str:
|
|
2907
|
+
"""
|
|
2908
|
+
Get the player's current locale.
|
|
2909
|
+
"""
|
|
2910
|
+
@property
|
|
2911
|
+
def name(self) -> str:
|
|
2912
|
+
"""
|
|
2913
|
+
Returns the name of this player
|
|
2914
|
+
"""
|
|
2915
|
+
@property
|
|
2916
|
+
def ping(self) -> int:
|
|
2917
|
+
"""
|
|
2918
|
+
Gets the player's average ping in milliseconds.
|
|
2919
|
+
"""
|
|
2920
|
+
@property
|
|
2921
|
+
def scoreboard(self) -> Scoreboard:
|
|
2922
|
+
"""
|
|
2923
|
+
Gets or sets the player's visible Scoreboard.
|
|
2924
|
+
"""
|
|
2925
|
+
@scoreboard.setter
|
|
2926
|
+
def scoreboard(self, arg1: Scoreboard) -> None:
|
|
2927
|
+
...
|
|
2928
|
+
@property
|
|
2929
|
+
def skin(self) -> Skin:
|
|
2930
|
+
"""
|
|
2931
|
+
Get the player's skin.
|
|
2932
|
+
"""
|
|
2933
|
+
@property
|
|
2934
|
+
def total_exp(self) -> int:
|
|
2935
|
+
"""
|
|
2936
|
+
Gets the players total experience points.
|
|
2937
|
+
"""
|
|
2938
|
+
@property
|
|
2939
|
+
def unique_id(self) -> uuid.UUID:
|
|
2940
|
+
"""
|
|
2941
|
+
Returns the UUID of this player
|
|
2942
|
+
"""
|
|
2943
|
+
@property
|
|
2944
|
+
def walk_speed(self) -> float:
|
|
2945
|
+
"""
|
|
2946
|
+
Gets or sets the current allowed speed that a client can walk.
|
|
2947
|
+
"""
|
|
2948
|
+
@walk_speed.setter
|
|
2949
|
+
def walk_speed(self, arg1: float) -> None:
|
|
2950
|
+
...
|
|
2951
|
+
@property
|
|
2952
|
+
def xuid(self) -> str:
|
|
2953
|
+
"""
|
|
2954
|
+
Returns the Xbox User ID (XUID) of this player
|
|
2955
|
+
"""
|
|
2956
|
+
class PlayerBanEntry(BanEntry):
|
|
2957
|
+
"""
|
|
2958
|
+
Represents a ban entry for a player.
|
|
2959
|
+
"""
|
|
2960
|
+
def __init__(self, name: str, uuid: uuid.UUID | None = None, xuid: str | None = None) -> None:
|
|
2961
|
+
...
|
|
2962
|
+
@property
|
|
2963
|
+
def name(self) -> str:
|
|
2964
|
+
"""
|
|
2965
|
+
Gets the banned player's name.
|
|
2966
|
+
"""
|
|
2967
|
+
@property
|
|
2968
|
+
def unique_id(self) -> uuid.UUID | None:
|
|
2969
|
+
"""
|
|
2970
|
+
Gets the banned player's unique ID, or None if not available.
|
|
2971
|
+
"""
|
|
2972
|
+
@property
|
|
2973
|
+
def xuid(self) -> str | None:
|
|
2974
|
+
"""
|
|
2975
|
+
Gets the banned player's Xbox user ID (XUID), or None if not available.
|
|
2976
|
+
"""
|
|
2977
|
+
class PlayerBanList:
|
|
2978
|
+
"""
|
|
2979
|
+
Represents a ban list containing banned players.
|
|
2980
|
+
"""
|
|
2981
|
+
def add_ban(self, name: str, uuid: uuid.UUID | None = None, xuid: str | None = None, reason: str | None = None, expires: datetime.datetime | None = None, source: str | None = None) -> PlayerBanEntry:
|
|
2982
|
+
"""
|
|
2983
|
+
Adds a ban to this list, or updates an existing one.
|
|
2984
|
+
"""
|
|
2985
|
+
def get_ban_entry(self, name: str, uuid: uuid.UUID | None = None, xuid: str | None = None) -> PlayerBanEntry:
|
|
2986
|
+
"""
|
|
2987
|
+
Gets a BanEntry by player name, UUID, or XUID.
|
|
2988
|
+
"""
|
|
2989
|
+
def is_banned(self, name: str, uuid: uuid.UUID | None = None, xuid: str | None = None) -> bool:
|
|
2990
|
+
"""
|
|
2991
|
+
Checks if a BanEntry exists for the target by name, UUID, or XUID.
|
|
2992
|
+
"""
|
|
2993
|
+
def remove_ban(self, name: str, uuid: uuid.UUID | None = None, xuid: str | None = None) -> None:
|
|
2994
|
+
"""
|
|
2995
|
+
Removes a player from the ban list by name, UUID, or XUID.
|
|
2996
|
+
"""
|
|
2997
|
+
@property
|
|
2998
|
+
def entries(self) -> list[PlayerBanEntry]:
|
|
2999
|
+
"""
|
|
3000
|
+
Gets a vector of pointers to entries in the ban list.
|
|
3001
|
+
"""
|
|
3002
|
+
class PlayerChatEvent(PlayerEvent, Cancellable):
|
|
3003
|
+
"""
|
|
3004
|
+
Called when a player sends a chat message.
|
|
3005
|
+
"""
|
|
3006
|
+
@property
|
|
3007
|
+
def message(self) -> str:
|
|
3008
|
+
"""
|
|
3009
|
+
Gets or sets the message that the player will send.
|
|
3010
|
+
"""
|
|
3011
|
+
@message.setter
|
|
3012
|
+
def message(self, arg1: str) -> None:
|
|
3013
|
+
...
|
|
3014
|
+
class PlayerCommandEvent(PlayerEvent, Cancellable):
|
|
3015
|
+
"""
|
|
3016
|
+
Called whenever a player runs a command.
|
|
3017
|
+
"""
|
|
3018
|
+
@property
|
|
3019
|
+
def command(self) -> str:
|
|
3020
|
+
"""
|
|
3021
|
+
Gets or sets the command that the player will send.
|
|
3022
|
+
"""
|
|
3023
|
+
@command.setter
|
|
3024
|
+
def command(self, arg1: str) -> None:
|
|
3025
|
+
...
|
|
3026
|
+
class PlayerDeathEvent(ActorDeathEvent, PlayerEvent):
|
|
3027
|
+
"""
|
|
3028
|
+
Called when a player dies
|
|
3029
|
+
"""
|
|
3030
|
+
@property
|
|
3031
|
+
def death_message(self) -> str:
|
|
3032
|
+
"""
|
|
3033
|
+
Gets or sets the death message that will appear to everyone on the server.
|
|
3034
|
+
"""
|
|
3035
|
+
@death_message.setter
|
|
3036
|
+
def death_message(self, arg1: str) -> None:
|
|
3037
|
+
...
|
|
3038
|
+
class PlayerDropItemEvent(PlayerEvent, Cancellable):
|
|
3039
|
+
"""
|
|
3040
|
+
Called when a player drops an item from their inventory
|
|
3041
|
+
"""
|
|
3042
|
+
@property
|
|
3043
|
+
def item(self) -> ItemStack:
|
|
3044
|
+
"""
|
|
3045
|
+
Gets the ItemStack dropped by the player
|
|
3046
|
+
"""
|
|
3047
|
+
class PlayerEmoteEvent(PlayerEvent):
|
|
3048
|
+
"""
|
|
3049
|
+
Called when a player uses and emote
|
|
3050
|
+
"""
|
|
3051
|
+
@property
|
|
3052
|
+
def emote_id(self) -> str:
|
|
3053
|
+
"""
|
|
3054
|
+
Gets the emote ID
|
|
3055
|
+
"""
|
|
3056
|
+
class PlayerEvent(Event):
|
|
3057
|
+
"""
|
|
3058
|
+
Represents a player related event
|
|
3059
|
+
"""
|
|
3060
|
+
@property
|
|
3061
|
+
def player(self) -> Player:
|
|
3062
|
+
"""
|
|
3063
|
+
Returns the player involved in this event.
|
|
3064
|
+
"""
|
|
3065
|
+
class PlayerGameModeChangeEvent(PlayerEvent, Cancellable):
|
|
3066
|
+
"""
|
|
3067
|
+
Called when the GameMode of the player is changed.
|
|
3068
|
+
"""
|
|
3069
|
+
@property
|
|
3070
|
+
def new_game_mode(self) -> GameMode:
|
|
3071
|
+
"""
|
|
3072
|
+
Gets the GameMode the player is switched to.
|
|
3073
|
+
"""
|
|
3074
|
+
class PlayerInteractActorEvent(PlayerEvent, Cancellable):
|
|
3075
|
+
"""
|
|
3076
|
+
Represents an event that is called when a player right-clicks an actor.
|
|
3077
|
+
"""
|
|
3078
|
+
@property
|
|
3079
|
+
def actor(self) -> Actor:
|
|
3080
|
+
"""
|
|
3081
|
+
Gets the actor that was right-clicked by the player.
|
|
3082
|
+
"""
|
|
3083
|
+
class PlayerInteractEvent(PlayerEvent, Cancellable):
|
|
3084
|
+
"""
|
|
3085
|
+
Represents an event that is called when a player right-clicks a block.
|
|
3086
|
+
"""
|
|
3087
|
+
@property
|
|
3088
|
+
def block(self) -> Block:
|
|
3089
|
+
"""
|
|
3090
|
+
Returns the clicked block
|
|
3091
|
+
"""
|
|
3092
|
+
@property
|
|
3093
|
+
def block_face(self) -> BlockFace:
|
|
3094
|
+
"""
|
|
3095
|
+
Returns the face of the block that was clicked
|
|
3096
|
+
"""
|
|
3097
|
+
@property
|
|
3098
|
+
def clicked_position(self) -> Vector:
|
|
3099
|
+
"""
|
|
3100
|
+
Gets the exact position on the block the player interacted with.
|
|
3101
|
+
"""
|
|
3102
|
+
@property
|
|
3103
|
+
def has_block(self) -> bool:
|
|
3104
|
+
"""
|
|
3105
|
+
Check if this event involved a block
|
|
3106
|
+
"""
|
|
3107
|
+
@property
|
|
3108
|
+
def has_item(self) -> bool:
|
|
3109
|
+
"""
|
|
3110
|
+
Check if this event involved an item
|
|
3111
|
+
"""
|
|
3112
|
+
@property
|
|
3113
|
+
def item(self) -> ItemStack:
|
|
3114
|
+
"""
|
|
3115
|
+
Returns the item in hand represented by this event
|
|
3116
|
+
"""
|
|
3117
|
+
class PlayerInventory(Inventory):
|
|
3118
|
+
"""
|
|
3119
|
+
Interface to the inventory of a Player, including the four armor slots and any extra slots.
|
|
3120
|
+
"""
|
|
3121
|
+
@property
|
|
3122
|
+
def boots(self) -> ItemStack:
|
|
3123
|
+
"""
|
|
3124
|
+
Gets or sets the ItemStack in the boots slot
|
|
3125
|
+
"""
|
|
3126
|
+
@boots.setter
|
|
3127
|
+
def boots(self, arg1: ItemStack) -> None:
|
|
3128
|
+
...
|
|
3129
|
+
@property
|
|
3130
|
+
def chestplate(self) -> ItemStack:
|
|
3131
|
+
"""
|
|
3132
|
+
Gets or sets the ItemStack in the chestplate slot
|
|
3133
|
+
"""
|
|
3134
|
+
@chestplate.setter
|
|
3135
|
+
def chestplate(self, arg1: ItemStack) -> None:
|
|
3136
|
+
...
|
|
3137
|
+
@property
|
|
3138
|
+
def held_item_slot(self) -> int:
|
|
3139
|
+
"""
|
|
3140
|
+
Gets or sets the slot number of the currently held item
|
|
3141
|
+
"""
|
|
3142
|
+
@held_item_slot.setter
|
|
3143
|
+
def held_item_slot(self, arg1: int) -> None:
|
|
3144
|
+
...
|
|
3145
|
+
@property
|
|
3146
|
+
def helmet(self) -> ItemStack:
|
|
3147
|
+
"""
|
|
3148
|
+
Gets or sets the ItemStack in the helmet slot
|
|
3149
|
+
"""
|
|
3150
|
+
@helmet.setter
|
|
3151
|
+
def helmet(self, arg1: ItemStack) -> None:
|
|
3152
|
+
...
|
|
3153
|
+
@property
|
|
3154
|
+
def item_in_main_hand(self) -> ItemStack:
|
|
3155
|
+
"""
|
|
3156
|
+
Gets or sets the item the player is currently holding in their main hand.
|
|
3157
|
+
"""
|
|
3158
|
+
@item_in_main_hand.setter
|
|
3159
|
+
def item_in_main_hand(self, arg1: ItemStack) -> None:
|
|
3160
|
+
...
|
|
3161
|
+
@property
|
|
3162
|
+
def item_in_off_hand(self) -> ItemStack:
|
|
3163
|
+
"""
|
|
3164
|
+
Gets or sets the item the player is currently holding in their off hand.
|
|
3165
|
+
"""
|
|
3166
|
+
@item_in_off_hand.setter
|
|
3167
|
+
def item_in_off_hand(self, arg1: ItemStack) -> None:
|
|
3168
|
+
...
|
|
3169
|
+
@property
|
|
3170
|
+
def leggings(self) -> ItemStack:
|
|
3171
|
+
"""
|
|
3172
|
+
Gets or sets the ItemStack in the leg slot
|
|
3173
|
+
"""
|
|
3174
|
+
@leggings.setter
|
|
3175
|
+
def leggings(self, arg1: ItemStack) -> None:
|
|
3176
|
+
...
|
|
3177
|
+
class PlayerItemConsumeEvent(PlayerEvent, Cancellable):
|
|
3178
|
+
"""
|
|
3179
|
+
Called when a player is finishing consuming an item (food, potion, milk bucket).
|
|
3180
|
+
"""
|
|
3181
|
+
@property
|
|
3182
|
+
def hand(self) -> EquipmentSlot:
|
|
3183
|
+
"""
|
|
3184
|
+
Get the hand used to consume the item.
|
|
3185
|
+
"""
|
|
3186
|
+
@property
|
|
3187
|
+
def item(self) -> ItemStack:
|
|
3188
|
+
"""
|
|
3189
|
+
Gets or sets the item that is being consumed.
|
|
3190
|
+
"""
|
|
3191
|
+
class PlayerJoinEvent(PlayerEvent):
|
|
3192
|
+
"""
|
|
3193
|
+
Called when a player joins a server
|
|
3194
|
+
"""
|
|
3195
|
+
@property
|
|
3196
|
+
def join_message(self) -> str:
|
|
3197
|
+
"""
|
|
3198
|
+
Gets or sets the join message to send to all online players.
|
|
3199
|
+
"""
|
|
3200
|
+
@join_message.setter
|
|
3201
|
+
def join_message(self, arg1: str) -> None:
|
|
3202
|
+
...
|
|
3203
|
+
class PlayerJumpEvent(PlayerMoveEvent):
|
|
3204
|
+
"""
|
|
3205
|
+
Called when a player jumps.
|
|
3206
|
+
"""
|
|
3207
|
+
class PlayerKickEvent(PlayerEvent, Cancellable):
|
|
3208
|
+
"""
|
|
3209
|
+
Called when a player gets kicked from the server
|
|
3210
|
+
"""
|
|
3211
|
+
@property
|
|
3212
|
+
def reason(self) -> str:
|
|
3213
|
+
"""
|
|
3214
|
+
Gets or sets the reason why the player is getting kicked
|
|
3215
|
+
"""
|
|
3216
|
+
@reason.setter
|
|
3217
|
+
def reason(self, arg1: str) -> None:
|
|
3218
|
+
...
|
|
3219
|
+
class PlayerLoginEvent(PlayerEvent, Cancellable):
|
|
3220
|
+
"""
|
|
3221
|
+
Called when a player attempts to login in.
|
|
3222
|
+
"""
|
|
3223
|
+
@property
|
|
3224
|
+
def kick_message(self) -> str:
|
|
3225
|
+
"""
|
|
3226
|
+
Gets or sets kick message to display if event is cancelled
|
|
3227
|
+
"""
|
|
3228
|
+
@kick_message.setter
|
|
3229
|
+
def kick_message(self, arg1: str) -> None:
|
|
3230
|
+
...
|
|
3231
|
+
class PlayerMoveEvent(PlayerEvent, Cancellable):
|
|
3232
|
+
"""
|
|
3233
|
+
Called when a player moves.
|
|
3234
|
+
"""
|
|
3235
|
+
@property
|
|
3236
|
+
def from_location(self) -> Location:
|
|
3237
|
+
"""
|
|
3238
|
+
Gets or sets the location that this player moved from.
|
|
3239
|
+
"""
|
|
3240
|
+
@from_location.setter
|
|
3241
|
+
def from_location(self, arg1: Location) -> None:
|
|
3242
|
+
...
|
|
3243
|
+
@property
|
|
3244
|
+
def to_location(self) -> Location:
|
|
3245
|
+
"""
|
|
3246
|
+
Gets or sets the location that this player moved to.
|
|
3247
|
+
"""
|
|
3248
|
+
@to_location.setter
|
|
3249
|
+
def to_location(self, arg1: Location) -> None:
|
|
3250
|
+
...
|
|
3251
|
+
class PlayerPickupItemEvent(PlayerEvent, Cancellable):
|
|
3252
|
+
"""
|
|
3253
|
+
Called when a player picks an item up from the ground.
|
|
3254
|
+
"""
|
|
3255
|
+
@property
|
|
3256
|
+
def item(self) -> ItemStack:
|
|
3257
|
+
"""
|
|
3258
|
+
Gets the Item picked up by the entity.
|
|
3259
|
+
"""
|
|
3260
|
+
class PlayerQuitEvent(PlayerEvent):
|
|
3261
|
+
"""
|
|
3262
|
+
Called when a player leaves a server.
|
|
3263
|
+
"""
|
|
3264
|
+
@property
|
|
3265
|
+
def quit_message(self) -> str:
|
|
3266
|
+
"""
|
|
3267
|
+
Gets or sets the quit message to send to all online players.
|
|
3268
|
+
"""
|
|
3269
|
+
@quit_message.setter
|
|
3270
|
+
def quit_message(self, arg1: str) -> None:
|
|
3271
|
+
...
|
|
3272
|
+
class PlayerRespawnEvent(PlayerEvent):
|
|
3273
|
+
"""
|
|
3274
|
+
Called when a player respawns.
|
|
3275
|
+
"""
|
|
3276
|
+
class PlayerTeleportEvent(PlayerMoveEvent):
|
|
3277
|
+
"""
|
|
3278
|
+
Called when a player is teleported from one location to another.
|
|
3279
|
+
"""
|
|
3280
|
+
class Plugin(CommandExecutor):
|
|
3281
|
+
"""
|
|
3282
|
+
Represents a Plugin
|
|
3283
|
+
"""
|
|
3284
|
+
def __init__(self) -> None:
|
|
3285
|
+
...
|
|
3286
|
+
def _get_description(self) -> PluginDescription:
|
|
3287
|
+
...
|
|
3288
|
+
def get_command(self, name: str) -> PluginCommand:
|
|
3289
|
+
"""
|
|
3290
|
+
Gets the command with the given name, specific to this plugin.
|
|
3291
|
+
"""
|
|
3292
|
+
def on_disable(self) -> None:
|
|
3293
|
+
"""
|
|
3294
|
+
Called when this plugin is disabled
|
|
3295
|
+
"""
|
|
3296
|
+
def on_enable(self) -> None:
|
|
3297
|
+
"""
|
|
3298
|
+
Called when this plugin is enabled
|
|
3299
|
+
"""
|
|
3300
|
+
def on_load(self) -> None:
|
|
3301
|
+
"""
|
|
3302
|
+
Called after a plugin is loaded but before it has been enabled.
|
|
3303
|
+
"""
|
|
3304
|
+
@property
|
|
3305
|
+
def data_folder(self) -> os.PathLike:
|
|
3306
|
+
"""
|
|
3307
|
+
Returns the folder that the plugin data's files are located in.
|
|
3308
|
+
"""
|
|
3309
|
+
@property
|
|
3310
|
+
def is_enabled(self) -> bool:
|
|
3311
|
+
"""
|
|
3312
|
+
Returns a value indicating whether this plugin is currently enabled
|
|
3313
|
+
"""
|
|
3314
|
+
@property
|
|
3315
|
+
def logger(self) -> Logger:
|
|
3316
|
+
"""
|
|
3317
|
+
Returns the plugin logger associated with this server's logger.
|
|
3318
|
+
"""
|
|
3319
|
+
@property
|
|
3320
|
+
def name(self) -> str:
|
|
3321
|
+
"""
|
|
3322
|
+
Returns the name of the plugin.
|
|
3323
|
+
"""
|
|
3324
|
+
@property
|
|
3325
|
+
def plugin_loader(self) -> PluginLoader:
|
|
3326
|
+
"""
|
|
3327
|
+
Gets the associated PluginLoader responsible for this plugin
|
|
3328
|
+
"""
|
|
3329
|
+
@property
|
|
3330
|
+
def server(self) -> Server:
|
|
3331
|
+
"""
|
|
3332
|
+
Returns the Server instance currently running this plugin
|
|
3333
|
+
"""
|
|
3334
|
+
class PluginCommand(Command):
|
|
3335
|
+
"""
|
|
3336
|
+
Represents a Command belonging to a Plugin
|
|
3337
|
+
"""
|
|
3338
|
+
@property
|
|
3339
|
+
def executor(self) -> CommandExecutor:
|
|
3340
|
+
"""
|
|
3341
|
+
The CommandExecutor to run when parsing this command
|
|
3342
|
+
"""
|
|
3343
|
+
@executor.setter
|
|
3344
|
+
def executor(self, arg1: CommandExecutor) -> None:
|
|
3345
|
+
...
|
|
3346
|
+
@property
|
|
3347
|
+
def plugin(self) -> Plugin:
|
|
3348
|
+
"""
|
|
3349
|
+
The owner of this PluginCommand
|
|
3350
|
+
"""
|
|
3351
|
+
class PluginDescription:
|
|
3352
|
+
"""
|
|
3353
|
+
Represents the basic information about a plugin that the plugin loader needs to know.
|
|
3354
|
+
"""
|
|
3355
|
+
def __init__(self, name: str, version: str, description: str | None = None, load: PluginLoadOrder | None = None, authors: list[str] | None = None, contributors: list[str] | None = None, website: str | None = None, prefix: str | None = None, provides: list[str] | None = None, depend: list[str] | None = None, soft_depend: list[str] | None = None, load_before: list[str] | None = None, default_permission: PermissionDefault | None = None, commands: list[Command] | None = None, permissions: list[Permission] | None = None, *args, **kwargs) -> None:
|
|
3356
|
+
...
|
|
3357
|
+
@property
|
|
3358
|
+
def api_version(self) -> str:
|
|
3359
|
+
"""
|
|
3360
|
+
Gives the API version which this plugin is designed to support.
|
|
3361
|
+
"""
|
|
3362
|
+
@property
|
|
3363
|
+
def authors(self) -> list[str]:
|
|
3364
|
+
"""
|
|
3365
|
+
Gives the list of authors for the plugin.
|
|
3366
|
+
"""
|
|
3367
|
+
@property
|
|
3368
|
+
def commands(self) -> list[Command]:
|
|
3369
|
+
"""
|
|
3370
|
+
Gives the list of commands the plugin will register at runtime.
|
|
3371
|
+
"""
|
|
3372
|
+
@property
|
|
3373
|
+
def contributors(self) -> list[str]:
|
|
3374
|
+
"""
|
|
3375
|
+
Gives the list of contributors for the plugin.
|
|
3376
|
+
"""
|
|
3377
|
+
@property
|
|
3378
|
+
def default_permission(self) -> PermissionDefault:
|
|
3379
|
+
"""
|
|
3380
|
+
Gives the default value of permissions registered for the plugin.
|
|
3381
|
+
"""
|
|
3382
|
+
@property
|
|
3383
|
+
def depend(self) -> list[str]:
|
|
3384
|
+
"""
|
|
3385
|
+
Gives a list of other plugins that the plugin requires.
|
|
3386
|
+
"""
|
|
3387
|
+
@property
|
|
3388
|
+
def description(self) -> str:
|
|
3389
|
+
"""
|
|
3390
|
+
Gives a human-friendly description of the functionality the plugin provides.
|
|
3391
|
+
"""
|
|
3392
|
+
@property
|
|
3393
|
+
def full_name(self) -> str:
|
|
3394
|
+
"""
|
|
3395
|
+
Returns the name of a plugin, including the version.
|
|
3396
|
+
"""
|
|
3397
|
+
@property
|
|
3398
|
+
def load(self) -> PluginLoadOrder:
|
|
3399
|
+
"""
|
|
3400
|
+
Gives the phase of server startup that the plugin should be loaded.
|
|
3401
|
+
"""
|
|
3402
|
+
@property
|
|
3403
|
+
def load_before(self) -> list[str]:
|
|
3404
|
+
"""
|
|
3405
|
+
Gets the list of plugins that should consider this plugin a soft-dependency.
|
|
3406
|
+
"""
|
|
3407
|
+
@property
|
|
3408
|
+
def name(self) -> str:
|
|
3409
|
+
"""
|
|
3410
|
+
Gives the name of the plugin. This name is a unique identifier for plugins.
|
|
3411
|
+
"""
|
|
3412
|
+
@property
|
|
3413
|
+
def permissions(self) -> list[Permission]:
|
|
3414
|
+
"""
|
|
3415
|
+
Gives the list of permissions the plugin will register at runtime, immediately proceeding enabling.
|
|
3416
|
+
"""
|
|
3417
|
+
@property
|
|
3418
|
+
def prefix(self) -> str:
|
|
3419
|
+
"""
|
|
3420
|
+
Gives the token to prefix plugin-specific logging messages with.
|
|
3421
|
+
"""
|
|
3422
|
+
@property
|
|
3423
|
+
def provides(self) -> list[str]:
|
|
3424
|
+
"""
|
|
3425
|
+
Gives the list of other plugin APIs which this plugin provides. These are usable for other plugins to depend on.
|
|
3426
|
+
"""
|
|
3427
|
+
@property
|
|
3428
|
+
def soft_depend(self) -> list[str]:
|
|
3429
|
+
"""
|
|
3430
|
+
Gives a list of other plugins that the plugin requires for full functionality.
|
|
3431
|
+
"""
|
|
3432
|
+
@property
|
|
3433
|
+
def version(self) -> str:
|
|
3434
|
+
"""
|
|
3435
|
+
Gives the version of the plugin.
|
|
3436
|
+
"""
|
|
3437
|
+
@property
|
|
3438
|
+
def website(self) -> str:
|
|
3439
|
+
"""
|
|
3440
|
+
Gives the plugin's or plugin's author's website.
|
|
3441
|
+
"""
|
|
3442
|
+
class PluginDisableEvent(ServerEvent):
|
|
3443
|
+
"""
|
|
3444
|
+
Called when a plugin is disabled.
|
|
3445
|
+
"""
|
|
3446
|
+
@property
|
|
3447
|
+
def plugin(self) -> Plugin:
|
|
3448
|
+
...
|
|
3449
|
+
class PluginEnableEvent(ServerEvent):
|
|
3450
|
+
"""
|
|
3451
|
+
Called when a plugin is enabled.
|
|
3452
|
+
"""
|
|
3453
|
+
@property
|
|
3454
|
+
def plugin(self) -> Plugin:
|
|
3455
|
+
...
|
|
3456
|
+
class PluginLoadOrder:
|
|
3457
|
+
"""
|
|
3458
|
+
Represents the order in which a plugin should be initialized and enabled.
|
|
3459
|
+
"""
|
|
3460
|
+
POSTWORLD: typing.ClassVar[PluginLoadOrder] # value = <PluginLoadOrder.POSTWORLD: 1>
|
|
3461
|
+
STARTUP: typing.ClassVar[PluginLoadOrder] # value = <PluginLoadOrder.STARTUP: 0>
|
|
3462
|
+
__members__: typing.ClassVar[dict[str, PluginLoadOrder]] # value = {'STARTUP': <PluginLoadOrder.STARTUP: 0>, 'POSTWORLD': <PluginLoadOrder.POSTWORLD: 1>}
|
|
3463
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
3464
|
+
...
|
|
3465
|
+
def __getstate__(self) -> int:
|
|
3466
|
+
...
|
|
3467
|
+
def __hash__(self) -> int:
|
|
3468
|
+
...
|
|
3469
|
+
def __index__(self) -> int:
|
|
3470
|
+
...
|
|
3471
|
+
def __init__(self, value: int) -> None:
|
|
3472
|
+
...
|
|
3473
|
+
def __int__(self) -> int:
|
|
3474
|
+
...
|
|
3475
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
3476
|
+
...
|
|
3477
|
+
def __repr__(self) -> str:
|
|
3478
|
+
...
|
|
3479
|
+
def __setstate__(self, state: int) -> None:
|
|
3480
|
+
...
|
|
3481
|
+
def __str__(self) -> str:
|
|
3482
|
+
...
|
|
3483
|
+
@property
|
|
3484
|
+
def name(self) -> str:
|
|
3485
|
+
...
|
|
3486
|
+
@property
|
|
3487
|
+
def value(self) -> int:
|
|
3488
|
+
...
|
|
3489
|
+
class PluginLoader:
|
|
3490
|
+
"""
|
|
3491
|
+
Represents a plugin loader, which handles direct access to specific types of plugins
|
|
3492
|
+
"""
|
|
3493
|
+
def __init__(self, server: Server) -> None:
|
|
3494
|
+
...
|
|
3495
|
+
def disable_plugin(self, plugin: Plugin) -> None:
|
|
3496
|
+
"""
|
|
3497
|
+
Disables the specified plugin
|
|
3498
|
+
"""
|
|
3499
|
+
def enable_plugin(self, plugin: Plugin) -> None:
|
|
3500
|
+
"""
|
|
3501
|
+
Enables the specified plugin
|
|
3502
|
+
"""
|
|
3503
|
+
def load_plugin(self, file: str) -> Plugin:
|
|
3504
|
+
"""
|
|
3505
|
+
Loads the plugin contained in the specified file
|
|
3506
|
+
"""
|
|
3507
|
+
def load_plugins(self, directory: str) -> list[Plugin]:
|
|
3508
|
+
"""
|
|
3509
|
+
Loads the plugin contained within the specified directory
|
|
3510
|
+
"""
|
|
3511
|
+
@property
|
|
3512
|
+
def plugin_file_filters(self) -> list[str]:
|
|
3513
|
+
"""
|
|
3514
|
+
Returns a list of all filename filters expected by this PluginLoader
|
|
3515
|
+
"""
|
|
3516
|
+
@property
|
|
3517
|
+
def server(self) -> Server:
|
|
3518
|
+
"""
|
|
3519
|
+
Retrieves the Server object associated with the PluginLoader.
|
|
3520
|
+
"""
|
|
3521
|
+
class PluginManager:
|
|
3522
|
+
"""
|
|
3523
|
+
Represents a plugin manager that handles all plugins from the Server
|
|
3524
|
+
"""
|
|
3525
|
+
def call_event(self, event: Event) -> None:
|
|
3526
|
+
"""
|
|
3527
|
+
Calls an event which will be passed to plugins.
|
|
3528
|
+
"""
|
|
3529
|
+
def clear_plugins(self) -> None:
|
|
3530
|
+
"""
|
|
3531
|
+
Disables and removes all plugins
|
|
3532
|
+
"""
|
|
3533
|
+
def disable_plugin(self, plugin: Plugin) -> None:
|
|
3534
|
+
"""
|
|
3535
|
+
Disables the specified plugin
|
|
3536
|
+
"""
|
|
3537
|
+
def disable_plugins(self) -> None:
|
|
3538
|
+
"""
|
|
3539
|
+
Disables all the loaded plugins
|
|
3540
|
+
"""
|
|
3541
|
+
def enable_plugin(self, plugin: Plugin) -> None:
|
|
3542
|
+
"""
|
|
3543
|
+
Enables the specified plugin
|
|
3544
|
+
"""
|
|
3545
|
+
def enable_plugins(self) -> None:
|
|
3546
|
+
"""
|
|
3547
|
+
Enable all the loaded plugins
|
|
3548
|
+
"""
|
|
3549
|
+
def get_default_perm_subscriptions(self, op: bool) -> set[Permissible]:
|
|
3550
|
+
"""
|
|
3551
|
+
Gets a set containing all subscribed Permissibles to the given default list, by op status.
|
|
3552
|
+
"""
|
|
3553
|
+
def get_default_permissions(self, op: bool) -> set[Permission]:
|
|
3554
|
+
"""
|
|
3555
|
+
Gets the default permissions for the given op status.
|
|
3556
|
+
"""
|
|
3557
|
+
def get_permission(self, name: str) -> Permission:
|
|
3558
|
+
"""
|
|
3559
|
+
Gets a Permission from its fully qualified name.
|
|
3560
|
+
"""
|
|
3561
|
+
def get_permission_subscriptions(self, permission: str) -> set[Permissible]:
|
|
3562
|
+
"""
|
|
3563
|
+
Gets a set containing all subscribed Permissibles to the given permission.
|
|
3564
|
+
"""
|
|
3565
|
+
def get_plugin(self, name: str) -> Plugin:
|
|
3566
|
+
"""
|
|
3567
|
+
Checks if the given plugin is loaded and returns it when applicable.
|
|
3568
|
+
"""
|
|
3569
|
+
@typing.overload
|
|
3570
|
+
def is_plugin_enabled(self, plugin: str) -> bool:
|
|
3571
|
+
"""
|
|
3572
|
+
Checks if the given plugin is enabled or not
|
|
3573
|
+
"""
|
|
3574
|
+
@typing.overload
|
|
3575
|
+
def is_plugin_enabled(self, plugin: Plugin) -> bool:
|
|
3576
|
+
"""
|
|
3577
|
+
Checks if the given plugin is enabled or not
|
|
3578
|
+
"""
|
|
3579
|
+
def load_plugin(self, file: str) -> Plugin:
|
|
3580
|
+
"""
|
|
3581
|
+
Loads the plugin in the specified file
|
|
3582
|
+
"""
|
|
3583
|
+
@typing.overload
|
|
3584
|
+
def load_plugins(self, directory: str) -> list[Plugin]:
|
|
3585
|
+
"""
|
|
3586
|
+
Loads the plugin contained within the specified directory
|
|
3587
|
+
"""
|
|
3588
|
+
@typing.overload
|
|
3589
|
+
def load_plugins(self, files: list[str]) -> list[Plugin]:
|
|
3590
|
+
"""
|
|
3591
|
+
Loads the plugins in the list of the files
|
|
3592
|
+
"""
|
|
3593
|
+
def recalculate_permission_defaults(self, perm: Permission) -> None:
|
|
3594
|
+
"""
|
|
3595
|
+
Recalculates the defaults for the given Permission.
|
|
3596
|
+
"""
|
|
3597
|
+
def register_event(self, name: str, executor: typing.Callable[[Event], None], priority: EventPriority, plugin: Plugin, ignore_cancelled: bool) -> None:
|
|
3598
|
+
"""
|
|
3599
|
+
Registers the given event
|
|
3600
|
+
"""
|
|
3601
|
+
@typing.overload
|
|
3602
|
+
def remove_permission(self, perm: Permission) -> None:
|
|
3603
|
+
"""
|
|
3604
|
+
Removes a Permission registration from this plugin manager by permission object.
|
|
3605
|
+
"""
|
|
3606
|
+
@typing.overload
|
|
3607
|
+
def remove_permission(self, name: str) -> None:
|
|
3608
|
+
"""
|
|
3609
|
+
Removes a Permission registration from this plugin manager by name.
|
|
3610
|
+
"""
|
|
3611
|
+
def subscribe_to_default_perms(self, op: bool, permissible: Permissible) -> None:
|
|
3612
|
+
"""
|
|
3613
|
+
Subscribes to the given Default permissions by operator status.
|
|
3614
|
+
"""
|
|
3615
|
+
def subscribe_to_permission(self, permission: str, permissible: Permissible) -> None:
|
|
3616
|
+
"""
|
|
3617
|
+
Subscribes the given Permissible for information about the requested Permission.
|
|
3618
|
+
"""
|
|
3619
|
+
def unsubscribe_from_default_perms(self, op: bool, permissible: Permissible) -> None:
|
|
3620
|
+
"""
|
|
3621
|
+
Unsubscribes from the given Default permissions by operator status.
|
|
3622
|
+
"""
|
|
3623
|
+
def unsubscribe_from_permission(self, permission: str, permissible: Permissible) -> None:
|
|
3624
|
+
"""
|
|
3625
|
+
Unsubscribes the given Permissible for information about the requested Permission.
|
|
3626
|
+
"""
|
|
3627
|
+
@property
|
|
3628
|
+
def permissions(self) -> set[Permission]:
|
|
3629
|
+
"""
|
|
3630
|
+
Gets a set of all registered permissions.
|
|
3631
|
+
"""
|
|
3632
|
+
@property
|
|
3633
|
+
def plugins(self) -> list[Plugin]:
|
|
3634
|
+
"""
|
|
3635
|
+
Gets a list of all currently loaded plugins
|
|
3636
|
+
"""
|
|
3637
|
+
class Position(Vector):
|
|
3638
|
+
"""
|
|
3639
|
+
Represents a 3-dimensional position in a dimension within a level.
|
|
3640
|
+
"""
|
|
3641
|
+
def __init__(self, dimension: Dimension, x: float, y: float, z: float) -> None:
|
|
3642
|
+
...
|
|
3643
|
+
def __repr__(self) -> str:
|
|
3644
|
+
...
|
|
3645
|
+
def __str__(self) -> str:
|
|
3646
|
+
...
|
|
3647
|
+
@property
|
|
3648
|
+
def block_x(self) -> int:
|
|
3649
|
+
"""
|
|
3650
|
+
Gets the floored value of the X component, indicating the block that this location is contained with.
|
|
3651
|
+
"""
|
|
3652
|
+
@property
|
|
3653
|
+
def block_y(self) -> int:
|
|
3654
|
+
"""
|
|
3655
|
+
Gets the floored value of the Y component, indicating the block that this location is contained with.
|
|
3656
|
+
"""
|
|
3657
|
+
@property
|
|
3658
|
+
def block_z(self) -> int:
|
|
3659
|
+
"""
|
|
3660
|
+
Gets the floored value of the Z component, indicating the block that this location is contained with.
|
|
3661
|
+
"""
|
|
3662
|
+
@property
|
|
3663
|
+
def dimension(self) -> Dimension:
|
|
3664
|
+
"""
|
|
3665
|
+
The Dimension that contains this position
|
|
3666
|
+
"""
|
|
3667
|
+
@dimension.setter
|
|
3668
|
+
def dimension(self, arg1: Dimension) -> None:
|
|
3669
|
+
...
|
|
3670
|
+
class ProxiedCommandSender(CommandSender):
|
|
3671
|
+
"""
|
|
3672
|
+
Represents a proxied command sender.
|
|
3673
|
+
"""
|
|
3674
|
+
@property
|
|
3675
|
+
def callee(self) -> CommandSender:
|
|
3676
|
+
"""
|
|
3677
|
+
Returns the CommandSender which is being used to call the command.
|
|
3678
|
+
"""
|
|
3679
|
+
@property
|
|
3680
|
+
def caller(self) -> CommandSender:
|
|
3681
|
+
"""
|
|
3682
|
+
Returns the CommandSender which triggered this proxied command.
|
|
3683
|
+
"""
|
|
3684
|
+
class RenderType:
|
|
3685
|
+
"""
|
|
3686
|
+
Controls the way in which an Objective is rendered on the client side.
|
|
3687
|
+
"""
|
|
3688
|
+
INTEGER: typing.ClassVar[RenderType] # value = <RenderType.INTEGER: 0>
|
|
3689
|
+
__members__: typing.ClassVar[dict[str, RenderType]] # value = {'INTEGER': <RenderType.INTEGER: 0>}
|
|
3690
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
3691
|
+
...
|
|
3692
|
+
def __getstate__(self) -> int:
|
|
3693
|
+
...
|
|
3694
|
+
def __hash__(self) -> int:
|
|
3695
|
+
...
|
|
3696
|
+
def __index__(self) -> int:
|
|
3697
|
+
...
|
|
3698
|
+
def __init__(self, value: int) -> None:
|
|
3699
|
+
...
|
|
3700
|
+
def __int__(self) -> int:
|
|
3701
|
+
...
|
|
3702
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
3703
|
+
...
|
|
3704
|
+
def __repr__(self) -> str:
|
|
3705
|
+
...
|
|
3706
|
+
def __setstate__(self, state: int) -> None:
|
|
3707
|
+
...
|
|
3708
|
+
def __str__(self) -> str:
|
|
3709
|
+
...
|
|
3710
|
+
@property
|
|
3711
|
+
def name(self) -> str:
|
|
3712
|
+
...
|
|
3713
|
+
@property
|
|
3714
|
+
def value(self) -> int:
|
|
3715
|
+
...
|
|
3716
|
+
class Scheduler:
|
|
3717
|
+
"""
|
|
3718
|
+
Represents a scheduler that executes various tasks
|
|
3719
|
+
"""
|
|
3720
|
+
def cancel_task(self, id: int) -> None:
|
|
3721
|
+
"""
|
|
3722
|
+
Removes task from scheduler.
|
|
3723
|
+
"""
|
|
3724
|
+
def cancel_tasks(self, plugin: Plugin) -> None:
|
|
3725
|
+
"""
|
|
3726
|
+
Removes all tasks associated with a particular plugin from the scheduler.
|
|
3727
|
+
"""
|
|
3728
|
+
def get_pending_tasks(self) -> list[Task]:
|
|
3729
|
+
"""
|
|
3730
|
+
Returns a vector of all pending tasks.
|
|
3731
|
+
"""
|
|
3732
|
+
def is_queued(self, id: int) -> bool:
|
|
3733
|
+
"""
|
|
3734
|
+
Check if the task queued to be run later.
|
|
3735
|
+
"""
|
|
3736
|
+
def is_running(self, id: int) -> bool:
|
|
3737
|
+
"""
|
|
3738
|
+
Check if the task currently running.
|
|
3739
|
+
"""
|
|
3740
|
+
def run_task(self, plugin: Plugin, task: typing.Callable[[], None], delay: int = 0, period: int = 0) -> Task:
|
|
3741
|
+
"""
|
|
3742
|
+
Returns a task that will be executed synchronously
|
|
3743
|
+
"""
|
|
3744
|
+
class Score:
|
|
3745
|
+
"""
|
|
3746
|
+
Represents a score for an objective on a scoreboard.
|
|
3747
|
+
"""
|
|
3748
|
+
@property
|
|
3749
|
+
def entry(self) -> Player | Actor | str:
|
|
3750
|
+
"""
|
|
3751
|
+
Gets the entry being tracked by this Score
|
|
3752
|
+
"""
|
|
3753
|
+
@property
|
|
3754
|
+
def is_score_set(self) -> bool:
|
|
3755
|
+
"""
|
|
3756
|
+
Shows if this score has been set at any point in time.
|
|
3757
|
+
"""
|
|
3758
|
+
@property
|
|
3759
|
+
def objective(self) -> Objective:
|
|
3760
|
+
"""
|
|
3761
|
+
Gets the Objective being tracked by this Score.
|
|
3762
|
+
"""
|
|
3763
|
+
@property
|
|
3764
|
+
def scoreboard(self) -> Scoreboard:
|
|
3765
|
+
"""
|
|
3766
|
+
Gets the scoreboard for the associated objective.
|
|
3767
|
+
"""
|
|
3768
|
+
@property
|
|
3769
|
+
def value(self) -> int:
|
|
3770
|
+
"""
|
|
3771
|
+
Gets or sets the current score.
|
|
3772
|
+
"""
|
|
3773
|
+
@value.setter
|
|
3774
|
+
def value(self, arg1: int) -> None:
|
|
3775
|
+
...
|
|
3776
|
+
class Scoreboard:
|
|
3777
|
+
"""
|
|
3778
|
+
Represents a scoreboard
|
|
3779
|
+
"""
|
|
3780
|
+
def add_objective(self, name: str, criteria: Criteria.Type, display_name: str | None = None, render_type: RenderType = RenderType.INTEGER) -> Objective:
|
|
3781
|
+
"""
|
|
3782
|
+
Registers an Objective on this Scoreboard with a name displayed to players
|
|
3783
|
+
"""
|
|
3784
|
+
def clear_slot(self, slot: DisplaySlot) -> None:
|
|
3785
|
+
"""
|
|
3786
|
+
Clears any objective in the specified slot
|
|
3787
|
+
"""
|
|
3788
|
+
@typing.overload
|
|
3789
|
+
def get_objective(self, name: str) -> Objective:
|
|
3790
|
+
"""
|
|
3791
|
+
Gets an Objective on this Scoreboard by name
|
|
3792
|
+
"""
|
|
3793
|
+
@typing.overload
|
|
3794
|
+
def get_objective(self, slot: DisplaySlot) -> Objective:
|
|
3795
|
+
"""
|
|
3796
|
+
Gets the Objective currently displayed in a DisplaySlot on this Scoreboard
|
|
3797
|
+
"""
|
|
3798
|
+
def get_objectives_by_criteria(self, criteria: Criteria.Type) -> list[Objective]:
|
|
3799
|
+
"""
|
|
3800
|
+
Gets all Objectives of a Criteria on the Scoreboard
|
|
3801
|
+
"""
|
|
3802
|
+
def get_scores(self, entry: Player | Actor | str) -> list[Score]:
|
|
3803
|
+
"""
|
|
3804
|
+
Gets all scores for an entry on this Scoreboard
|
|
3805
|
+
"""
|
|
3806
|
+
def reset_scores(self, entry: Player | Actor | str) -> None:
|
|
3807
|
+
"""
|
|
3808
|
+
Removes all scores for an entry on this Scoreboard
|
|
3809
|
+
"""
|
|
3810
|
+
@property
|
|
3811
|
+
def entries(self) -> list[Player | Actor | str]:
|
|
3812
|
+
"""
|
|
3813
|
+
Gets all entries tracked by this Scoreboard
|
|
3814
|
+
"""
|
|
3815
|
+
@property
|
|
3816
|
+
def objectives(self) -> list[Objective]:
|
|
3817
|
+
"""
|
|
3818
|
+
Gets all Objectives on this Scoreboard
|
|
3819
|
+
"""
|
|
3820
|
+
class ScriptMessageEvent(ServerEvent, Cancellable):
|
|
3821
|
+
"""
|
|
3822
|
+
Called when a message is sent by `/scriptevent` command
|
|
3823
|
+
"""
|
|
3824
|
+
@property
|
|
3825
|
+
def message(self) -> str:
|
|
3826
|
+
"""
|
|
3827
|
+
Get the message to send.
|
|
3828
|
+
"""
|
|
3829
|
+
@property
|
|
3830
|
+
def message_id(self) -> str:
|
|
3831
|
+
"""
|
|
3832
|
+
Get the message id to send.
|
|
3833
|
+
"""
|
|
3834
|
+
@property
|
|
3835
|
+
def sender(self) -> CommandSender:
|
|
3836
|
+
"""
|
|
3837
|
+
Gets the command sender who initiated the command.
|
|
3838
|
+
"""
|
|
3839
|
+
class Server:
|
|
3840
|
+
"""
|
|
3841
|
+
Represents a server implementation.
|
|
3842
|
+
"""
|
|
3843
|
+
def broadcast(self, message: str | Translatable, permission: str) -> None:
|
|
3844
|
+
"""
|
|
3845
|
+
Broadcasts the specified message to every user with the given permission name.
|
|
3846
|
+
"""
|
|
3847
|
+
def broadcast_message(self, message: str | Translatable) -> None:
|
|
3848
|
+
"""
|
|
3849
|
+
Broadcasts the specified message to every user with permission endstone.broadcast.user
|
|
3850
|
+
"""
|
|
3851
|
+
def create_block_data(self, type: str, block_states: dict[str, bool | str | int] | None = None) -> BlockData:
|
|
3852
|
+
"""
|
|
3853
|
+
Creates a new BlockData instance for the specified block type, with all properties initialized to defaults, except for those provided.
|
|
3854
|
+
"""
|
|
3855
|
+
def create_boss_bar(self, title: str, color: BarColor, style: BarStyle, flags: list[BarFlag] | None = None) -> BossBar:
|
|
3856
|
+
"""
|
|
3857
|
+
Creates a boss bar instance to display to players. The progress defaults to 1.0.
|
|
3858
|
+
"""
|
|
3859
|
+
def create_scoreboard(self) -> Scoreboard:
|
|
3860
|
+
"""
|
|
3861
|
+
Creates a new Scoreboard to be tracked by the server.
|
|
3862
|
+
"""
|
|
3863
|
+
def dispatch_command(self, sender: CommandSender, command_line: str) -> bool:
|
|
3864
|
+
"""
|
|
3865
|
+
Dispatches a command on this server, and executes it if found.
|
|
3866
|
+
"""
|
|
3867
|
+
@typing.overload
|
|
3868
|
+
def get_player(self, name: str) -> Player:
|
|
3869
|
+
"""
|
|
3870
|
+
Gets the player with the exact given name, case insensitive.
|
|
3871
|
+
"""
|
|
3872
|
+
@typing.overload
|
|
3873
|
+
def get_player(self, unique_id: uuid.UUID) -> Player:
|
|
3874
|
+
"""
|
|
3875
|
+
Gets the player with the given UUID.
|
|
3876
|
+
"""
|
|
3877
|
+
def get_plugin_command(self, name: str) -> PluginCommand:
|
|
3878
|
+
"""
|
|
3879
|
+
Gets a PluginCommand with the given name or alias.
|
|
3880
|
+
"""
|
|
3881
|
+
def reload(self) -> None:
|
|
3882
|
+
"""
|
|
3883
|
+
Reloads the server configuration, functions, scripts and plugins.
|
|
3884
|
+
"""
|
|
3885
|
+
def reload_data(self) -> None:
|
|
3886
|
+
"""
|
|
3887
|
+
Reload only the Minecraft data for the server.
|
|
3888
|
+
"""
|
|
3889
|
+
def shutdown(self) -> None:
|
|
3890
|
+
"""
|
|
3891
|
+
Shutdowns the server, stopping everything.
|
|
3892
|
+
"""
|
|
3893
|
+
@property
|
|
3894
|
+
def average_mspt(self) -> float:
|
|
3895
|
+
"""
|
|
3896
|
+
Gets the average milliseconds per tick (MSPT).
|
|
3897
|
+
"""
|
|
3898
|
+
@property
|
|
3899
|
+
def average_tick_usage(self) -> float:
|
|
3900
|
+
"""
|
|
3901
|
+
Gets the average tick usage of the server.
|
|
3902
|
+
"""
|
|
3903
|
+
@property
|
|
3904
|
+
def average_tps(self) -> float:
|
|
3905
|
+
"""
|
|
3906
|
+
Gets the average ticks per second (TPS).
|
|
3907
|
+
"""
|
|
3908
|
+
@property
|
|
3909
|
+
def ban_list(self) -> PlayerBanList:
|
|
3910
|
+
"""
|
|
3911
|
+
Gets the player ban list.
|
|
3912
|
+
"""
|
|
3913
|
+
@property
|
|
3914
|
+
def command_sender(self) -> ConsoleCommandSender:
|
|
3915
|
+
"""
|
|
3916
|
+
Gets a CommandSender for this server.
|
|
3917
|
+
"""
|
|
3918
|
+
@property
|
|
3919
|
+
def current_mspt(self) -> float:
|
|
3920
|
+
"""
|
|
3921
|
+
Gets the current milliseconds per tick (MSPT).
|
|
3922
|
+
"""
|
|
3923
|
+
@property
|
|
3924
|
+
def current_tick_usage(self) -> float:
|
|
3925
|
+
"""
|
|
3926
|
+
Gets the current tick usage of the server.
|
|
3927
|
+
"""
|
|
3928
|
+
@property
|
|
3929
|
+
def current_tps(self) -> float:
|
|
3930
|
+
"""
|
|
3931
|
+
Gets the current ticks per second (TPS).
|
|
3932
|
+
"""
|
|
3933
|
+
@property
|
|
3934
|
+
def enchantment_registry(self) -> EnchantmentRegistry:
|
|
3935
|
+
"""
|
|
3936
|
+
Returns the registry for all the enchantments.
|
|
3937
|
+
"""
|
|
3938
|
+
@property
|
|
3939
|
+
def ip_ban_list(self) -> IpBanList:
|
|
3940
|
+
"""
|
|
3941
|
+
Gets the IP ban list.
|
|
3942
|
+
"""
|
|
3943
|
+
@property
|
|
3944
|
+
def item_factory(self) -> ItemFactory:
|
|
3945
|
+
"""
|
|
3946
|
+
Gets the instance of the item factory (for ItemMeta).
|
|
3947
|
+
"""
|
|
3948
|
+
@property
|
|
3949
|
+
def item_registry(self) -> ItemRegistry:
|
|
3950
|
+
"""
|
|
3951
|
+
Returns the registry for all the item types.
|
|
3952
|
+
"""
|
|
3953
|
+
@property
|
|
3954
|
+
def language(self) -> Language:
|
|
3955
|
+
"""
|
|
3956
|
+
Gets the current language interface used by the server.
|
|
3957
|
+
"""
|
|
3958
|
+
@property
|
|
3959
|
+
def level(self) -> Level:
|
|
3960
|
+
"""
|
|
3961
|
+
Gets the server level.
|
|
3962
|
+
"""
|
|
3963
|
+
@property
|
|
3964
|
+
def logger(self) -> Logger:
|
|
3965
|
+
"""
|
|
3966
|
+
Returns the primary logger associated with this server instance.
|
|
3967
|
+
"""
|
|
3968
|
+
@property
|
|
3969
|
+
def max_players(self) -> int:
|
|
3970
|
+
"""
|
|
3971
|
+
The maximum amount of players which can login to this server.
|
|
3972
|
+
"""
|
|
3973
|
+
@max_players.setter
|
|
3974
|
+
def max_players(self, arg1: int) -> None:
|
|
3975
|
+
...
|
|
3976
|
+
@property
|
|
3977
|
+
def minecraft_version(self) -> str:
|
|
3978
|
+
"""
|
|
3979
|
+
Gets the Minecraft version that this server is running.
|
|
3980
|
+
"""
|
|
3981
|
+
@property
|
|
3982
|
+
def name(self) -> str:
|
|
3983
|
+
"""
|
|
3984
|
+
Gets the name of this server implementation.
|
|
3985
|
+
"""
|
|
3986
|
+
@property
|
|
3987
|
+
def online_mode(self) -> bool:
|
|
3988
|
+
"""
|
|
3989
|
+
Gets whether the Server is in online mode or not.
|
|
3990
|
+
"""
|
|
3991
|
+
@property
|
|
3992
|
+
def online_players(self) -> list[Player]:
|
|
3993
|
+
"""
|
|
3994
|
+
Gets a list of all currently online players.
|
|
3995
|
+
"""
|
|
3996
|
+
@property
|
|
3997
|
+
def plugin_manager(self) -> PluginManager:
|
|
3998
|
+
"""
|
|
3999
|
+
Gets the plugin manager for interfacing with plugins.
|
|
4000
|
+
"""
|
|
4001
|
+
@property
|
|
4002
|
+
def port(self) -> int:
|
|
4003
|
+
"""
|
|
4004
|
+
Get the game port that the server runs on.
|
|
4005
|
+
"""
|
|
4006
|
+
@property
|
|
4007
|
+
def port_v6(self) -> int:
|
|
4008
|
+
"""
|
|
4009
|
+
Get the game port (IPv6) that the server runs on.
|
|
4010
|
+
"""
|
|
4011
|
+
@property
|
|
4012
|
+
def scheduler(self) -> Scheduler:
|
|
4013
|
+
"""
|
|
4014
|
+
Gets the scheduler for managing scheduled events.
|
|
4015
|
+
"""
|
|
4016
|
+
@property
|
|
4017
|
+
def scoreboard(self) -> Scoreboard:
|
|
4018
|
+
"""
|
|
4019
|
+
Gets the primary Scoreboard controlled by the server.
|
|
4020
|
+
"""
|
|
4021
|
+
@property
|
|
4022
|
+
def service_manager(self) -> ServiceManager:
|
|
4023
|
+
"""
|
|
4024
|
+
Gets the service manager.
|
|
4025
|
+
"""
|
|
4026
|
+
@property
|
|
4027
|
+
def start_time(self) -> datetime.datetime:
|
|
4028
|
+
"""
|
|
4029
|
+
Gets the start time of the server.
|
|
4030
|
+
"""
|
|
4031
|
+
@property
|
|
4032
|
+
def version(self) -> str:
|
|
4033
|
+
"""
|
|
4034
|
+
Gets the version of this server implementation.
|
|
4035
|
+
"""
|
|
4036
|
+
class ServerCommandEvent(ServerEvent, Cancellable):
|
|
4037
|
+
"""
|
|
4038
|
+
Called when the console runs a command, early in the process.
|
|
4039
|
+
"""
|
|
4040
|
+
@property
|
|
4041
|
+
def command(self) -> str:
|
|
4042
|
+
"""
|
|
4043
|
+
Gets or sets the command that the server will execute
|
|
4044
|
+
"""
|
|
4045
|
+
@command.setter
|
|
4046
|
+
def command(self, arg1: str) -> None:
|
|
4047
|
+
...
|
|
4048
|
+
@property
|
|
4049
|
+
def sender(self) -> CommandSender:
|
|
4050
|
+
"""
|
|
4051
|
+
Get the command sender.
|
|
4052
|
+
"""
|
|
4053
|
+
class ServerEvent(Event):
|
|
4054
|
+
"""
|
|
4055
|
+
Represents a server-related event
|
|
4056
|
+
"""
|
|
4057
|
+
class ServerListPingEvent(ServerEvent, Cancellable):
|
|
4058
|
+
"""
|
|
4059
|
+
Called when a server ping is coming in.
|
|
4060
|
+
"""
|
|
4061
|
+
@property
|
|
4062
|
+
def game_mode(self) -> GameMode:
|
|
4063
|
+
"""
|
|
4064
|
+
Gets or sets the current game mode.
|
|
4065
|
+
"""
|
|
4066
|
+
@game_mode.setter
|
|
4067
|
+
def game_mode(self, arg1: GameMode) -> None:
|
|
4068
|
+
...
|
|
4069
|
+
@property
|
|
4070
|
+
def level_name(self) -> str:
|
|
4071
|
+
"""
|
|
4072
|
+
Gets or sets the level name.
|
|
4073
|
+
"""
|
|
4074
|
+
@level_name.setter
|
|
4075
|
+
def level_name(self, arg1: str) -> None:
|
|
4076
|
+
...
|
|
4077
|
+
@property
|
|
4078
|
+
def local_port(self) -> int:
|
|
4079
|
+
"""
|
|
4080
|
+
Get or set the local port of the server.
|
|
4081
|
+
"""
|
|
4082
|
+
@local_port.setter
|
|
4083
|
+
def local_port(self, arg1: int) -> None:
|
|
4084
|
+
...
|
|
4085
|
+
@property
|
|
4086
|
+
def local_port_v6(self) -> int:
|
|
4087
|
+
"""
|
|
4088
|
+
Get or set the local port of the server for IPv6 support
|
|
4089
|
+
"""
|
|
4090
|
+
@local_port_v6.setter
|
|
4091
|
+
def local_port_v6(self, arg1: int) -> None:
|
|
4092
|
+
...
|
|
4093
|
+
@property
|
|
4094
|
+
def max_players(self) -> int:
|
|
4095
|
+
"""
|
|
4096
|
+
Gets or sets the maximum number of players allowed.
|
|
4097
|
+
"""
|
|
4098
|
+
@max_players.setter
|
|
4099
|
+
def max_players(self, arg1: int) -> None:
|
|
4100
|
+
...
|
|
4101
|
+
@property
|
|
4102
|
+
def minecraft_version_network(self) -> str:
|
|
4103
|
+
"""
|
|
4104
|
+
Gets or sets the network version of Minecraft that is supported by this server
|
|
4105
|
+
"""
|
|
4106
|
+
@minecraft_version_network.setter
|
|
4107
|
+
def minecraft_version_network(self, arg1: str) -> None:
|
|
4108
|
+
...
|
|
4109
|
+
@property
|
|
4110
|
+
def motd(self) -> str:
|
|
4111
|
+
"""
|
|
4112
|
+
Gets or sets the message of the day message.
|
|
4113
|
+
"""
|
|
4114
|
+
@motd.setter
|
|
4115
|
+
def motd(self, arg1: str) -> None:
|
|
4116
|
+
...
|
|
4117
|
+
@property
|
|
4118
|
+
def network_protocol_version(self) -> int:
|
|
4119
|
+
"""
|
|
4120
|
+
Get the network protocol version of this server
|
|
4121
|
+
"""
|
|
4122
|
+
@property
|
|
4123
|
+
def num_players(self) -> int:
|
|
4124
|
+
"""
|
|
4125
|
+
Gets or sets the number of players online.
|
|
4126
|
+
"""
|
|
4127
|
+
@num_players.setter
|
|
4128
|
+
def num_players(self, arg1: int) -> None:
|
|
4129
|
+
...
|
|
4130
|
+
@property
|
|
4131
|
+
def remote_host(self) -> str:
|
|
4132
|
+
"""
|
|
4133
|
+
Get the host the ping is coming from.
|
|
4134
|
+
"""
|
|
4135
|
+
@property
|
|
4136
|
+
def remote_port(self) -> int:
|
|
4137
|
+
"""
|
|
4138
|
+
Get the port the ping is coming from.
|
|
4139
|
+
"""
|
|
4140
|
+
@property
|
|
4141
|
+
def server_guid(self) -> str:
|
|
4142
|
+
"""
|
|
4143
|
+
Get or set the unique identifier of the server.
|
|
4144
|
+
"""
|
|
4145
|
+
@server_guid.setter
|
|
4146
|
+
def server_guid(self, arg1: str) -> None:
|
|
4147
|
+
...
|
|
4148
|
+
class ServerLoadEvent(Event):
|
|
4149
|
+
"""
|
|
4150
|
+
Called when either the server startup or reload has completed.
|
|
4151
|
+
"""
|
|
4152
|
+
class LoadType:
|
|
4153
|
+
STARTUP: typing.ClassVar[ServerLoadEvent.LoadType] # value = <LoadType.STARTUP: 0>
|
|
4154
|
+
__members__: typing.ClassVar[dict[str, ServerLoadEvent.LoadType]] # value = {'STARTUP': <LoadType.STARTUP: 0>}
|
|
4155
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
4156
|
+
...
|
|
4157
|
+
def __getstate__(self) -> int:
|
|
4158
|
+
...
|
|
4159
|
+
def __hash__(self) -> int:
|
|
4160
|
+
...
|
|
4161
|
+
def __index__(self) -> int:
|
|
4162
|
+
...
|
|
4163
|
+
def __init__(self, value: int) -> None:
|
|
4164
|
+
...
|
|
4165
|
+
def __int__(self) -> int:
|
|
4166
|
+
...
|
|
4167
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
4168
|
+
...
|
|
4169
|
+
def __repr__(self) -> str:
|
|
4170
|
+
...
|
|
4171
|
+
def __setstate__(self, state: int) -> None:
|
|
4172
|
+
...
|
|
4173
|
+
def __str__(self) -> str:
|
|
4174
|
+
...
|
|
4175
|
+
@property
|
|
4176
|
+
def name(self) -> str:
|
|
4177
|
+
...
|
|
4178
|
+
@property
|
|
4179
|
+
def value(self) -> int:
|
|
4180
|
+
...
|
|
4181
|
+
STARTUP: typing.ClassVar[ServerLoadEvent.LoadType] # value = <LoadType.STARTUP: 0>
|
|
4182
|
+
@property
|
|
4183
|
+
def type(self) -> ServerLoadEvent.LoadType:
|
|
4184
|
+
...
|
|
4185
|
+
class Service:
|
|
4186
|
+
"""
|
|
4187
|
+
Represents a list of methods.
|
|
4188
|
+
"""
|
|
4189
|
+
def __init__(self) -> None:
|
|
4190
|
+
...
|
|
4191
|
+
class ServiceManager:
|
|
4192
|
+
"""
|
|
4193
|
+
Represent a service manager that manages services and service providers.
|
|
4194
|
+
"""
|
|
4195
|
+
def load(self, name: str) -> Service:
|
|
4196
|
+
...
|
|
4197
|
+
def register(self, name: str, provider: Service, plugin: Plugin, priority: ServicePriority) -> None:
|
|
4198
|
+
"""
|
|
4199
|
+
Register a provider of a service.
|
|
4200
|
+
"""
|
|
4201
|
+
@typing.overload
|
|
4202
|
+
def unregister(self, name: str, provider: Service) -> None:
|
|
4203
|
+
"""
|
|
4204
|
+
Unregister a particular provider for a particular service.
|
|
4205
|
+
"""
|
|
4206
|
+
@typing.overload
|
|
4207
|
+
def unregister(self, provider: Service) -> None:
|
|
4208
|
+
"""
|
|
4209
|
+
Unregister a particular provider.
|
|
4210
|
+
"""
|
|
4211
|
+
def unregister_all(self, plugin: Plugin) -> None:
|
|
4212
|
+
"""
|
|
4213
|
+
Unregister all the services registered by a particular plugin.
|
|
4214
|
+
"""
|
|
4215
|
+
class ServicePriority:
|
|
4216
|
+
"""
|
|
4217
|
+
Represents various priorities of a provider.
|
|
4218
|
+
"""
|
|
4219
|
+
HIGH: typing.ClassVar[ServicePriority] # value = <ServicePriority.HIGH: 3>
|
|
4220
|
+
HIGHEST: typing.ClassVar[ServicePriority] # value = <ServicePriority.HIGHEST: 4>
|
|
4221
|
+
LOW: typing.ClassVar[ServicePriority] # value = <ServicePriority.LOW: 1>
|
|
4222
|
+
LOWEST: typing.ClassVar[ServicePriority] # value = <ServicePriority.LOWEST: 0>
|
|
4223
|
+
NORMAL: typing.ClassVar[ServicePriority] # value = <ServicePriority.NORMAL: 2>
|
|
4224
|
+
__members__: typing.ClassVar[dict[str, ServicePriority]] # value = {'LOWEST': <ServicePriority.LOWEST: 0>, 'LOW': <ServicePriority.LOW: 1>, 'NORMAL': <ServicePriority.NORMAL: 2>, 'HIGH': <ServicePriority.HIGH: 3>, 'HIGHEST': <ServicePriority.HIGHEST: 4>}
|
|
4225
|
+
def __eq__(self, other: typing.Any) -> bool:
|
|
4226
|
+
...
|
|
4227
|
+
def __getstate__(self) -> int:
|
|
4228
|
+
...
|
|
4229
|
+
def __hash__(self) -> int:
|
|
4230
|
+
...
|
|
4231
|
+
def __index__(self) -> int:
|
|
4232
|
+
...
|
|
4233
|
+
def __init__(self, value: int) -> None:
|
|
4234
|
+
...
|
|
4235
|
+
def __int__(self) -> int:
|
|
4236
|
+
...
|
|
4237
|
+
def __ne__(self, other: typing.Any) -> bool:
|
|
4238
|
+
...
|
|
4239
|
+
def __repr__(self) -> str:
|
|
4240
|
+
...
|
|
4241
|
+
def __setstate__(self, state: int) -> None:
|
|
4242
|
+
...
|
|
4243
|
+
def __str__(self) -> str:
|
|
4244
|
+
...
|
|
4245
|
+
@property
|
|
4246
|
+
def name(self) -> str:
|
|
4247
|
+
...
|
|
4248
|
+
@property
|
|
4249
|
+
def value(self) -> int:
|
|
4250
|
+
...
|
|
4251
|
+
class Skin:
|
|
4252
|
+
"""
|
|
4253
|
+
Represents a player skin.
|
|
4254
|
+
"""
|
|
4255
|
+
def __init__(self, id: str, image: numpy.ndarray[numpy.uint8], cape_id: str | None = None, cape_image: numpy.ndarray[numpy.uint8] | None = None) -> None:
|
|
4256
|
+
...
|
|
4257
|
+
@property
|
|
4258
|
+
def cape_id(self) -> str | None:
|
|
4259
|
+
"""
|
|
4260
|
+
Get the Cape ID.
|
|
4261
|
+
"""
|
|
4262
|
+
@property
|
|
4263
|
+
def cape_image(self) -> numpy.ndarray[numpy.uint8]:
|
|
4264
|
+
"""
|
|
4265
|
+
Get the Cape image.
|
|
4266
|
+
"""
|
|
4267
|
+
@property
|
|
4268
|
+
def id(self) -> str:
|
|
4269
|
+
"""
|
|
4270
|
+
Get the Skin ID.
|
|
4271
|
+
"""
|
|
4272
|
+
@property
|
|
4273
|
+
def image(self) -> numpy.ndarray[numpy.uint8]:
|
|
4274
|
+
"""
|
|
4275
|
+
Get the Skin image.
|
|
4276
|
+
"""
|
|
4277
|
+
class Slider:
|
|
4278
|
+
"""
|
|
4279
|
+
Represents a slider with a label.
|
|
4280
|
+
"""
|
|
4281
|
+
def __init__(self, label: str | Translatable = '', min: float = 0, max: float = 100, step: float = 20, default_value: float | None = None) -> None:
|
|
4282
|
+
...
|
|
4283
|
+
@property
|
|
4284
|
+
def default_value(self) -> float | None:
|
|
4285
|
+
"""
|
|
4286
|
+
Gets or sets the optional default value of the slider.
|
|
4287
|
+
"""
|
|
4288
|
+
@default_value.setter
|
|
4289
|
+
def default_value(self, arg1: float | None) -> Slider:
|
|
4290
|
+
...
|
|
4291
|
+
@property
|
|
4292
|
+
def label(self) -> str | Translatable:
|
|
4293
|
+
"""
|
|
4294
|
+
Gets or sets the label of the slider.
|
|
4295
|
+
"""
|
|
4296
|
+
@label.setter
|
|
4297
|
+
def label(self, arg1: str | Translatable) -> Slider:
|
|
4298
|
+
...
|
|
4299
|
+
@property
|
|
4300
|
+
def max(self) -> float:
|
|
4301
|
+
"""
|
|
4302
|
+
Gets or sets the maximum value of the slider.
|
|
4303
|
+
"""
|
|
4304
|
+
@max.setter
|
|
4305
|
+
def max(self, arg1: float) -> Slider:
|
|
4306
|
+
...
|
|
4307
|
+
@property
|
|
4308
|
+
def min(self) -> float:
|
|
4309
|
+
"""
|
|
4310
|
+
Gets or sets the minimum value of the slider.
|
|
4311
|
+
"""
|
|
4312
|
+
@min.setter
|
|
4313
|
+
def min(self, arg1: float) -> Slider:
|
|
4314
|
+
...
|
|
4315
|
+
@property
|
|
4316
|
+
def step(self) -> float:
|
|
4317
|
+
"""
|
|
4318
|
+
Gets or sets the step size of the slider.
|
|
4319
|
+
"""
|
|
4320
|
+
@step.setter
|
|
4321
|
+
def step(self, arg1: float) -> Slider:
|
|
4322
|
+
...
|
|
4323
|
+
class SocketAddress:
|
|
4324
|
+
"""
|
|
4325
|
+
Represents an IP Socket Address (hostname + port number).
|
|
4326
|
+
"""
|
|
4327
|
+
@typing.overload
|
|
4328
|
+
def __init__(self) -> None:
|
|
4329
|
+
...
|
|
4330
|
+
@typing.overload
|
|
4331
|
+
def __init__(self, hostname: str, port: int) -> None:
|
|
4332
|
+
...
|
|
4333
|
+
def __repr__(self) -> str:
|
|
4334
|
+
...
|
|
4335
|
+
def __str__(self) -> str:
|
|
4336
|
+
...
|
|
4337
|
+
@property
|
|
4338
|
+
def hostname(self) -> str:
|
|
4339
|
+
"""
|
|
4340
|
+
Gets the hostname.
|
|
4341
|
+
"""
|
|
4342
|
+
@property
|
|
4343
|
+
def port(self) -> int:
|
|
4344
|
+
"""
|
|
4345
|
+
Gets the port number.
|
|
4346
|
+
"""
|
|
4347
|
+
class StepSlider:
|
|
4348
|
+
"""
|
|
4349
|
+
Represents a step slider with a set of predefined options.
|
|
4350
|
+
"""
|
|
4351
|
+
def __init__(self, label: str | Translatable = '', options: list[str] | None = None, default_index: int | None = None) -> None:
|
|
4352
|
+
...
|
|
4353
|
+
def add_option(self, option: str) -> Dropdown:
|
|
4354
|
+
"""
|
|
4355
|
+
Adds a new option to the step slider.
|
|
4356
|
+
"""
|
|
4357
|
+
@property
|
|
4358
|
+
def default_index(self) -> int | None:
|
|
4359
|
+
"""
|
|
4360
|
+
Gets or sets the optional default index of the step slider.
|
|
4361
|
+
"""
|
|
4362
|
+
@default_index.setter
|
|
4363
|
+
def default_index(self, arg1: int | None) -> Dropdown:
|
|
4364
|
+
...
|
|
4365
|
+
@property
|
|
4366
|
+
def label(self) -> str | Translatable:
|
|
4367
|
+
"""
|
|
4368
|
+
Gets or sets the label of the step slider.
|
|
4369
|
+
"""
|
|
4370
|
+
@label.setter
|
|
4371
|
+
def label(self, arg1: str | Translatable) -> Dropdown:
|
|
4372
|
+
...
|
|
4373
|
+
@property
|
|
4374
|
+
def options(self) -> list[str]:
|
|
4375
|
+
"""
|
|
4376
|
+
Gets or sets the options of the step slider.
|
|
4377
|
+
"""
|
|
4378
|
+
@options.setter
|
|
4379
|
+
def options(self, arg1: list[str]) -> Dropdown:
|
|
4380
|
+
...
|
|
4381
|
+
class Task:
|
|
4382
|
+
"""
|
|
4383
|
+
Represents a task being executed by the scheduler
|
|
4384
|
+
"""
|
|
4385
|
+
def cancel(self) -> None:
|
|
4386
|
+
"""
|
|
4387
|
+
Attempts to cancel this task.
|
|
4388
|
+
"""
|
|
4389
|
+
@property
|
|
4390
|
+
def is_cancelled(self) -> bool:
|
|
4391
|
+
"""
|
|
4392
|
+
Returns true if the task has been cancelled.
|
|
4393
|
+
"""
|
|
4394
|
+
@property
|
|
4395
|
+
def is_sync(self) -> bool:
|
|
4396
|
+
"""
|
|
4397
|
+
Returns true if the task is run by server thread.
|
|
4398
|
+
"""
|
|
4399
|
+
@property
|
|
4400
|
+
def owner(self) -> Plugin:
|
|
4401
|
+
"""
|
|
4402
|
+
Returns the Plugin that owns the task.
|
|
4403
|
+
"""
|
|
4404
|
+
@property
|
|
4405
|
+
def task_id(self) -> int:
|
|
4406
|
+
"""
|
|
4407
|
+
Returns the task id.
|
|
4408
|
+
"""
|
|
4409
|
+
class TextInput:
|
|
4410
|
+
"""
|
|
4411
|
+
Represents a text input field.
|
|
4412
|
+
"""
|
|
4413
|
+
def __init__(self, label: str | Translatable = '', placeholder: str | Translatable = '', default_value: str | None = None) -> None:
|
|
4414
|
+
...
|
|
4415
|
+
@property
|
|
4416
|
+
def default_value(self) -> str | None:
|
|
4417
|
+
"""
|
|
4418
|
+
Gets or sets the optional default text of the text input field.
|
|
4419
|
+
"""
|
|
4420
|
+
@default_value.setter
|
|
4421
|
+
def default_value(self, arg1: str | None) -> TextInput:
|
|
4422
|
+
...
|
|
4423
|
+
@property
|
|
4424
|
+
def label(self) -> str | Translatable:
|
|
4425
|
+
"""
|
|
4426
|
+
Gets or sets the label of the text input field.
|
|
4427
|
+
"""
|
|
4428
|
+
@label.setter
|
|
4429
|
+
def label(self, arg1: str | Translatable) -> TextInput:
|
|
4430
|
+
...
|
|
4431
|
+
@property
|
|
4432
|
+
def placeholder(self) -> str | Translatable:
|
|
4433
|
+
"""
|
|
4434
|
+
Gets or sets the placeholder of the text input field.
|
|
4435
|
+
"""
|
|
4436
|
+
@placeholder.setter
|
|
4437
|
+
def placeholder(self, arg1: str | Translatable) -> TextInput:
|
|
4438
|
+
...
|
|
4439
|
+
class ThunderChangeEvent(WeatherEvent, Cancellable):
|
|
4440
|
+
"""
|
|
4441
|
+
Called when the thunder state in a world is changing.
|
|
4442
|
+
"""
|
|
4443
|
+
@property
|
|
4444
|
+
def to_thunder_state(self) -> bool:
|
|
4445
|
+
"""
|
|
4446
|
+
Gets the state of thunder that the world is being set to
|
|
4447
|
+
"""
|
|
4448
|
+
class Toggle:
|
|
4449
|
+
"""
|
|
4450
|
+
Represents a toggle button with a label.
|
|
4451
|
+
"""
|
|
4452
|
+
def __init__(self, label: str | Translatable = '', default_value: bool = False) -> None:
|
|
4453
|
+
...
|
|
4454
|
+
@property
|
|
4455
|
+
def default_value(self) -> bool:
|
|
4456
|
+
"""
|
|
4457
|
+
Gets or sets the value of the toggle.
|
|
4458
|
+
"""
|
|
4459
|
+
@default_value.setter
|
|
4460
|
+
def default_value(self, arg1: bool) -> Toggle:
|
|
4461
|
+
...
|
|
4462
|
+
@property
|
|
4463
|
+
def label(self) -> str | Translatable:
|
|
4464
|
+
"""
|
|
4465
|
+
Gets or sets the label of the toggle.
|
|
4466
|
+
"""
|
|
4467
|
+
@label.setter
|
|
4468
|
+
def label(self, arg1: str | Translatable) -> Toggle:
|
|
4469
|
+
...
|
|
4470
|
+
class Translatable:
|
|
4471
|
+
"""
|
|
4472
|
+
Represents an object with a text representation that can be translated by the Minecraft client.
|
|
4473
|
+
"""
|
|
4474
|
+
def __init__(self, text: str, params: list[str] | None = None) -> None:
|
|
4475
|
+
...
|
|
4476
|
+
@property
|
|
4477
|
+
def params(self) -> list[str]:
|
|
4478
|
+
"""
|
|
4479
|
+
Get the translation parameters.
|
|
4480
|
+
"""
|
|
4481
|
+
@property
|
|
4482
|
+
def text(self) -> str:
|
|
4483
|
+
"""
|
|
4484
|
+
Get the text to be translated.
|
|
4485
|
+
"""
|
|
4486
|
+
class Vector:
|
|
4487
|
+
"""
|
|
4488
|
+
Represents a 3-dimensional vector.
|
|
4489
|
+
"""
|
|
4490
|
+
@typing.overload
|
|
4491
|
+
def __add__(self, arg0: Vector) -> Vector:
|
|
4492
|
+
...
|
|
4493
|
+
@typing.overload
|
|
4494
|
+
def __add__(self, arg0: float) -> Vector:
|
|
4495
|
+
...
|
|
4496
|
+
def __iadd__(self, arg0: Vector) -> Vector:
|
|
4497
|
+
...
|
|
4498
|
+
def __imul__(self, arg0: Vector) -> Vector:
|
|
4499
|
+
...
|
|
4500
|
+
@typing.overload
|
|
4501
|
+
def __init__(self) -> None:
|
|
4502
|
+
...
|
|
4503
|
+
@typing.overload
|
|
4504
|
+
def __init__(self, x: float, y: float, z: float) -> None:
|
|
4505
|
+
...
|
|
4506
|
+
def __isub__(self, arg0: Vector) -> Vector:
|
|
4507
|
+
...
|
|
4508
|
+
def __itruediv__(self, arg0: Vector) -> Vector:
|
|
4509
|
+
...
|
|
4510
|
+
@typing.overload
|
|
4511
|
+
def __mul__(self, arg0: Vector) -> Vector:
|
|
4512
|
+
...
|
|
4513
|
+
@typing.overload
|
|
4514
|
+
def __mul__(self, arg0: float) -> Vector:
|
|
4515
|
+
...
|
|
4516
|
+
def __radd__(self, arg0: float) -> Vector:
|
|
4517
|
+
...
|
|
4518
|
+
def __repr__(self) -> str:
|
|
4519
|
+
...
|
|
4520
|
+
def __rmul__(self, arg0: float) -> Vector:
|
|
4521
|
+
...
|
|
4522
|
+
def __rsub__(self, arg0: float) -> Vector:
|
|
4523
|
+
...
|
|
4524
|
+
def __rtruediv__(self, arg0: float) -> Vector:
|
|
4525
|
+
...
|
|
4526
|
+
def __str__(self) -> str:
|
|
4527
|
+
...
|
|
4528
|
+
@typing.overload
|
|
4529
|
+
def __sub__(self, arg0: Vector) -> Vector:
|
|
4530
|
+
...
|
|
4531
|
+
@typing.overload
|
|
4532
|
+
def __sub__(self, arg0: float) -> Vector:
|
|
4533
|
+
...
|
|
4534
|
+
@typing.overload
|
|
4535
|
+
def __truediv__(self, arg0: Vector) -> Vector:
|
|
4536
|
+
...
|
|
4537
|
+
@typing.overload
|
|
4538
|
+
def __truediv__(self, arg0: float) -> Vector:
|
|
4539
|
+
...
|
|
4540
|
+
def distance(self, other: Vector) -> float:
|
|
4541
|
+
"""
|
|
4542
|
+
The distance between this Vector and another
|
|
4543
|
+
"""
|
|
4544
|
+
def distance_squared(self, other: Vector) -> float:
|
|
4545
|
+
"""
|
|
4546
|
+
The squared distance between this Vector and another
|
|
4547
|
+
"""
|
|
4548
|
+
@property
|
|
4549
|
+
def length(self) -> float:
|
|
4550
|
+
"""
|
|
4551
|
+
The magnitude of the Vector
|
|
4552
|
+
"""
|
|
4553
|
+
@property
|
|
4554
|
+
def length_squared(self) -> float:
|
|
4555
|
+
"""
|
|
4556
|
+
The squared magnitude of the Vector
|
|
4557
|
+
"""
|
|
4558
|
+
@property
|
|
4559
|
+
def x(self) -> float:
|
|
4560
|
+
"""
|
|
4561
|
+
The X component of the vector
|
|
4562
|
+
"""
|
|
4563
|
+
@x.setter
|
|
4564
|
+
def x(self, arg1: float) -> None:
|
|
4565
|
+
...
|
|
4566
|
+
@property
|
|
4567
|
+
def y(self) -> float:
|
|
4568
|
+
"""
|
|
4569
|
+
The Y component of the vector
|
|
4570
|
+
"""
|
|
4571
|
+
@y.setter
|
|
4572
|
+
def y(self, arg1: float) -> None:
|
|
4573
|
+
...
|
|
4574
|
+
@property
|
|
4575
|
+
def z(self) -> float:
|
|
4576
|
+
"""
|
|
4577
|
+
The Z component of the vector
|
|
4578
|
+
"""
|
|
4579
|
+
@z.setter
|
|
4580
|
+
def z(self, arg1: float) -> None:
|
|
4581
|
+
...
|
|
4582
|
+
class WeatherChangeEvent(WeatherEvent, Cancellable):
|
|
4583
|
+
"""
|
|
4584
|
+
Called when the weather (rain) state in a world is changing.
|
|
4585
|
+
"""
|
|
4586
|
+
@property
|
|
4587
|
+
def to_weather_state(self) -> bool:
|
|
4588
|
+
"""
|
|
4589
|
+
Gets the state of weather that the world is being set to
|
|
4590
|
+
"""
|
|
4591
|
+
class WeatherEvent(Event):
|
|
4592
|
+
"""
|
|
4593
|
+
Represents a weather-related event
|
|
4594
|
+
"""
|
|
4595
|
+
@property
|
|
4596
|
+
def level(self) -> Level:
|
|
4597
|
+
"""
|
|
4598
|
+
Returns the Level where this event is occurring
|
|
4599
|
+
"""
|