@minecraft/server 1.6.0-rc.1.20.50-preview.21 → 1.6.0
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.
- package/README.md +0 -2
- package/index.d.ts +12 -442
- package/package.json +2 -2
package/index.d.ts
CHANGED
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
Copyright (c) Microsoft Corporation.
|
|
8
8
|
***************************************************************************** */
|
|
9
9
|
/**
|
|
10
|
-
* @beta
|
|
11
10
|
* @packageDocumentation
|
|
12
11
|
* Contains many types related to manipulating a Minecraft
|
|
13
12
|
* world, including entities, blocks, dimensions, and more.
|
|
@@ -16,54 +15,47 @@
|
|
|
16
15
|
* ```json
|
|
17
16
|
* {
|
|
18
17
|
* "module_name": "@minecraft/server",
|
|
19
|
-
* "version": "1.
|
|
18
|
+
* "version": "1.6.0"
|
|
20
19
|
* }
|
|
21
20
|
* ```
|
|
22
21
|
*
|
|
23
22
|
*/
|
|
24
23
|
import * as minecraftcommon from '@minecraft/common';
|
|
25
24
|
/**
|
|
26
|
-
* @beta
|
|
27
25
|
* A general purpose relative direction enumeration.
|
|
28
26
|
*/
|
|
29
27
|
export enum Direction {
|
|
30
28
|
/**
|
|
31
|
-
* @beta
|
|
32
29
|
* @remarks
|
|
33
30
|
* Returns the {@link Block} beneath (y - 1) of this item.
|
|
34
31
|
*
|
|
35
32
|
*/
|
|
36
33
|
Down = 'Down',
|
|
37
34
|
/**
|
|
38
|
-
* @beta
|
|
39
35
|
* @remarks
|
|
40
36
|
* Returns the {@link Block} to the east (x + 1) of this item.
|
|
41
37
|
*
|
|
42
38
|
*/
|
|
43
39
|
East = 'East',
|
|
44
40
|
/**
|
|
45
|
-
* @beta
|
|
46
41
|
* @remarks
|
|
47
42
|
* Returns the {@link Block} to the east (z + 1) of this item.
|
|
48
43
|
*
|
|
49
44
|
*/
|
|
50
45
|
North = 'North',
|
|
51
46
|
/**
|
|
52
|
-
* @beta
|
|
53
47
|
* @remarks
|
|
54
48
|
* Returns the {@link Block} to the south (z - 1) of this item.
|
|
55
49
|
*
|
|
56
50
|
*/
|
|
57
51
|
South = 'South',
|
|
58
52
|
/**
|
|
59
|
-
* @beta
|
|
60
53
|
* @remarks
|
|
61
54
|
* Returns the {@link Block} above (y + 1) of this item.
|
|
62
55
|
*
|
|
63
56
|
*/
|
|
64
57
|
Up = 'Up',
|
|
65
58
|
/**
|
|
66
|
-
* @beta
|
|
67
59
|
* @remarks
|
|
68
60
|
* Returns the {@link Block} to the west (x - 1) of this item.
|
|
69
61
|
*
|
|
@@ -72,26 +64,22 @@ export enum Direction {
|
|
|
72
64
|
}
|
|
73
65
|
|
|
74
66
|
/**
|
|
75
|
-
* @beta
|
|
76
67
|
* Specifies a mechanism for displaying scores on a scoreboard.
|
|
77
68
|
*/
|
|
78
69
|
export enum DisplaySlotId {
|
|
79
70
|
/**
|
|
80
|
-
* @beta
|
|
81
71
|
* @remarks
|
|
82
72
|
* Displays the score below the player's name.
|
|
83
73
|
*
|
|
84
74
|
*/
|
|
85
75
|
BelowName = 'BelowName',
|
|
86
76
|
/**
|
|
87
|
-
* @beta
|
|
88
77
|
* @remarks
|
|
89
78
|
* Displays the score as a list on the pause screen.
|
|
90
79
|
*
|
|
91
80
|
*/
|
|
92
81
|
List = 'List',
|
|
93
82
|
/**
|
|
94
|
-
* @beta
|
|
95
83
|
* @remarks
|
|
96
84
|
* Displays the score on the side of the player's screen.
|
|
97
85
|
*
|
|
@@ -99,9 +87,6 @@ export enum DisplaySlotId {
|
|
|
99
87
|
Sidebar = 'Sidebar',
|
|
100
88
|
}
|
|
101
89
|
|
|
102
|
-
/**
|
|
103
|
-
* @beta
|
|
104
|
-
*/
|
|
105
90
|
export enum EasingType {
|
|
106
91
|
InBack = 'InBack',
|
|
107
92
|
InBounce = 'InBounce',
|
|
@@ -138,19 +123,16 @@ export enum EasingType {
|
|
|
138
123
|
}
|
|
139
124
|
|
|
140
125
|
/**
|
|
141
|
-
* @beta
|
|
142
126
|
* Describes the source of damage from an Entity.
|
|
143
127
|
*/
|
|
144
128
|
export enum EntityDamageCause {
|
|
145
129
|
/**
|
|
146
|
-
* @beta
|
|
147
130
|
* @remarks
|
|
148
131
|
* Damage caused by a falling anvil.
|
|
149
132
|
*
|
|
150
133
|
*/
|
|
151
134
|
anvil = 'anvil',
|
|
152
135
|
/**
|
|
153
|
-
* @beta
|
|
154
136
|
* @remarks
|
|
155
137
|
* Damage caused from a non-Entity explosion. For example, an
|
|
156
138
|
* exploding bed.
|
|
@@ -159,14 +141,12 @@ export enum EntityDamageCause {
|
|
|
159
141
|
blockExplosion = 'blockExplosion',
|
|
160
142
|
campfire = 'campfire',
|
|
161
143
|
/**
|
|
162
|
-
* @beta
|
|
163
144
|
* @remarks
|
|
164
145
|
* Unused.
|
|
165
146
|
*
|
|
166
147
|
*/
|
|
167
148
|
charging = 'charging',
|
|
168
149
|
/**
|
|
169
|
-
* @beta
|
|
170
150
|
* @remarks
|
|
171
151
|
* Damage caused by physically touching an Entity or Block. For
|
|
172
152
|
* example, touching a Sweet Berry bush or Pufferfish.
|
|
@@ -174,7 +154,6 @@ export enum EntityDamageCause {
|
|
|
174
154
|
*/
|
|
175
155
|
contact = 'contact',
|
|
176
156
|
/**
|
|
177
|
-
* @beta
|
|
178
157
|
* @remarks
|
|
179
158
|
* Damage caused by an Entity being out of air and inside a
|
|
180
159
|
* liquid block.
|
|
@@ -182,14 +161,12 @@ export enum EntityDamageCause {
|
|
|
182
161
|
*/
|
|
183
162
|
drowning = 'drowning',
|
|
184
163
|
/**
|
|
185
|
-
* @beta
|
|
186
164
|
* @remarks
|
|
187
165
|
* Damage caused by an Entity attack.
|
|
188
166
|
*
|
|
189
167
|
*/
|
|
190
168
|
entityAttack = 'entityAttack',
|
|
191
169
|
/**
|
|
192
|
-
* @beta
|
|
193
170
|
* @remarks
|
|
194
171
|
* Damage caused by an Entity explosion. For example, a Creeper
|
|
195
172
|
* or Wither.
|
|
@@ -197,14 +174,12 @@ export enum EntityDamageCause {
|
|
|
197
174
|
*/
|
|
198
175
|
entityExplosion = 'entityExplosion',
|
|
199
176
|
/**
|
|
200
|
-
* @beta
|
|
201
177
|
* @remarks
|
|
202
178
|
* Damage caused by falling onto the ground.
|
|
203
179
|
*
|
|
204
180
|
*/
|
|
205
181
|
fall = 'fall',
|
|
206
182
|
/**
|
|
207
|
-
* @beta
|
|
208
183
|
* @remarks
|
|
209
184
|
* Damage caused by falling blocks. Note: Anvils and
|
|
210
185
|
* Stalactites have their own damage causes.
|
|
@@ -212,28 +187,24 @@ export enum EntityDamageCause {
|
|
|
212
187
|
*/
|
|
213
188
|
fallingBlock = 'fallingBlock',
|
|
214
189
|
/**
|
|
215
|
-
* @beta
|
|
216
190
|
* @remarks
|
|
217
191
|
* Damage caused by catching on fire.
|
|
218
192
|
*
|
|
219
193
|
*/
|
|
220
194
|
fire = 'fire',
|
|
221
195
|
/**
|
|
222
|
-
* @beta
|
|
223
196
|
* @remarks
|
|
224
197
|
* Damage caused by burning over time.
|
|
225
198
|
*
|
|
226
199
|
*/
|
|
227
200
|
fireTick = 'fireTick',
|
|
228
201
|
/**
|
|
229
|
-
* @beta
|
|
230
202
|
* @remarks
|
|
231
203
|
* Damage caused by fireworks.
|
|
232
204
|
*
|
|
233
205
|
*/
|
|
234
206
|
fireworks = 'fireworks',
|
|
235
207
|
/**
|
|
236
|
-
* @beta
|
|
237
208
|
* @remarks
|
|
238
209
|
* Damage caused by flying into a wall at high speed while
|
|
239
210
|
* gliding with Elytra.
|
|
@@ -241,28 +212,24 @@ export enum EntityDamageCause {
|
|
|
241
212
|
*/
|
|
242
213
|
flyIntoWall = 'flyIntoWall',
|
|
243
214
|
/**
|
|
244
|
-
* @beta
|
|
245
215
|
* @remarks
|
|
246
216
|
* Damage caused by staying inside a Powder Snow block.
|
|
247
217
|
*
|
|
248
218
|
*/
|
|
249
219
|
freezing = 'freezing',
|
|
250
220
|
/**
|
|
251
|
-
* @beta
|
|
252
221
|
* @remarks
|
|
253
222
|
* Damage caused by touching a Lava block.
|
|
254
223
|
*
|
|
255
224
|
*/
|
|
256
225
|
lava = 'lava',
|
|
257
226
|
/**
|
|
258
|
-
* @beta
|
|
259
227
|
* @remarks
|
|
260
228
|
* Damage caused by being struck by lightning.
|
|
261
229
|
*
|
|
262
230
|
*/
|
|
263
231
|
lightning = 'lightning',
|
|
264
232
|
/**
|
|
265
|
-
* @beta
|
|
266
233
|
* @remarks
|
|
267
234
|
* Damage caused by magical attacks. For example, Evoker Fang
|
|
268
235
|
* or Conduit Block.
|
|
@@ -270,14 +237,12 @@ export enum EntityDamageCause {
|
|
|
270
237
|
*/
|
|
271
238
|
magic = 'magic',
|
|
272
239
|
/**
|
|
273
|
-
* @beta
|
|
274
240
|
* @remarks
|
|
275
241
|
* Damage caused by touching a Magma block.
|
|
276
242
|
*
|
|
277
243
|
*/
|
|
278
244
|
magma = 'magma',
|
|
279
245
|
/**
|
|
280
|
-
* @beta
|
|
281
246
|
* @remarks
|
|
282
247
|
* Damage caused by no source. For example, from a command or
|
|
283
248
|
* script.
|
|
@@ -285,7 +250,6 @@ export enum EntityDamageCause {
|
|
|
285
250
|
*/
|
|
286
251
|
none = 'none',
|
|
287
252
|
/**
|
|
288
|
-
* @beta
|
|
289
253
|
* @remarks
|
|
290
254
|
* Damage caused by an indirect source. For example, setting a
|
|
291
255
|
* mob's health to 0 in a behavior pack.
|
|
@@ -293,14 +257,12 @@ export enum EntityDamageCause {
|
|
|
293
257
|
*/
|
|
294
258
|
override = 'override',
|
|
295
259
|
/**
|
|
296
|
-
* @beta
|
|
297
260
|
* @remarks
|
|
298
261
|
* Damage caused by a Piston.
|
|
299
262
|
*
|
|
300
263
|
*/
|
|
301
264
|
piston = 'piston',
|
|
302
265
|
/**
|
|
303
|
-
* @beta
|
|
304
266
|
* @remarks
|
|
305
267
|
* Damage caused by a projectile.
|
|
306
268
|
*
|
|
@@ -310,28 +272,24 @@ export enum EntityDamageCause {
|
|
|
310
272
|
sonicBoom = 'sonicBoom',
|
|
311
273
|
soulCampfire = 'soulCampfire',
|
|
312
274
|
/**
|
|
313
|
-
* @beta
|
|
314
275
|
* @remarks
|
|
315
276
|
* Damage caused by a falling Stalactite block.
|
|
316
277
|
*
|
|
317
278
|
*/
|
|
318
279
|
stalactite = 'stalactite',
|
|
319
280
|
/**
|
|
320
|
-
* @beta
|
|
321
281
|
* @remarks
|
|
322
282
|
* Damage caused by touching a Stalagmite block.
|
|
323
283
|
*
|
|
324
284
|
*/
|
|
325
285
|
stalagmite = 'stalagmite',
|
|
326
286
|
/**
|
|
327
|
-
* @beta
|
|
328
287
|
* @remarks
|
|
329
288
|
* Damage caused over time by having an empty hunger bar.
|
|
330
289
|
*
|
|
331
290
|
*/
|
|
332
291
|
starve = 'starve',
|
|
333
292
|
/**
|
|
334
|
-
* @beta
|
|
335
293
|
* @remarks
|
|
336
294
|
* Damage caused by an Entity being out of air and inside a
|
|
337
295
|
* non-liquid block.
|
|
@@ -339,7 +297,6 @@ export enum EntityDamageCause {
|
|
|
339
297
|
*/
|
|
340
298
|
suffocation = 'suffocation',
|
|
341
299
|
/**
|
|
342
|
-
* @beta
|
|
343
300
|
* @remarks
|
|
344
301
|
* Damage caused by an Entity killing itself. For example, from
|
|
345
302
|
* the /kill command.
|
|
@@ -347,7 +304,6 @@ export enum EntityDamageCause {
|
|
|
347
304
|
*/
|
|
348
305
|
suicide = 'suicide',
|
|
349
306
|
/**
|
|
350
|
-
* @beta
|
|
351
307
|
* @remarks
|
|
352
308
|
* Damage caused by an Entity being in an inhabitable climate.
|
|
353
309
|
* For example, a Snow Golem in a biome with a temperature
|
|
@@ -356,7 +312,6 @@ export enum EntityDamageCause {
|
|
|
356
312
|
*/
|
|
357
313
|
temperature = 'temperature',
|
|
358
314
|
/**
|
|
359
|
-
* @beta
|
|
360
315
|
* @remarks
|
|
361
316
|
* Damage caused by the Thorns armor enchantment and by the
|
|
362
317
|
* Guardian thorns effect.
|
|
@@ -364,14 +319,12 @@ export enum EntityDamageCause {
|
|
|
364
319
|
*/
|
|
365
320
|
thorns = 'thorns',
|
|
366
321
|
/**
|
|
367
|
-
* @beta
|
|
368
322
|
* @remarks
|
|
369
323
|
* Damage caused over time by falling into the void.
|
|
370
324
|
*
|
|
371
325
|
*/
|
|
372
326
|
'void' = 'void',
|
|
373
327
|
/**
|
|
374
|
-
* @beta
|
|
375
328
|
* @remarks
|
|
376
329
|
* Damage caused by the Wither effect. For example, from
|
|
377
330
|
* touching a Wither Rose.
|
|
@@ -381,12 +334,10 @@ export enum EntityDamageCause {
|
|
|
381
334
|
}
|
|
382
335
|
|
|
383
336
|
/**
|
|
384
|
-
* @beta
|
|
385
337
|
* An enumeration describing initialization cause of an entity.
|
|
386
338
|
*/
|
|
387
339
|
export enum EntityInitializationCause {
|
|
388
340
|
/**
|
|
389
|
-
* @beta
|
|
390
341
|
* @remarks
|
|
391
342
|
* Case when an entity is created as child of other entity or
|
|
392
343
|
* entities, e.g., cows making a cow or slimes making smaller
|
|
@@ -395,7 +346,6 @@ export enum EntityInitializationCause {
|
|
|
395
346
|
*/
|
|
396
347
|
Born = 'Born',
|
|
397
348
|
/**
|
|
398
|
-
* @beta
|
|
399
349
|
* @remarks
|
|
400
350
|
* Case when an entity is created by an event, e.g., Wandering
|
|
401
351
|
* trader spawning llamas.
|
|
@@ -404,14 +354,12 @@ export enum EntityInitializationCause {
|
|
|
404
354
|
Event = 'Event',
|
|
405
355
|
Loaded = 'Loaded',
|
|
406
356
|
/**
|
|
407
|
-
* @beta
|
|
408
357
|
* @remarks
|
|
409
358
|
* Case when an entity is naturally spawned in the world.
|
|
410
359
|
*
|
|
411
360
|
*/
|
|
412
361
|
Spawned = 'Spawned',
|
|
413
362
|
/**
|
|
414
|
-
* @beta
|
|
415
363
|
* @remarks
|
|
416
364
|
* Case when an entity is transformed into another entity.
|
|
417
365
|
*
|
|
@@ -420,13 +368,11 @@ export enum EntityInitializationCause {
|
|
|
420
368
|
}
|
|
421
369
|
|
|
422
370
|
/**
|
|
423
|
-
* @beta
|
|
424
371
|
* The equipment slot of the mob. This includes armor, offhand
|
|
425
372
|
* and mainhand slots.
|
|
426
373
|
*/
|
|
427
374
|
export enum EquipmentSlot {
|
|
428
375
|
/**
|
|
429
|
-
* @beta
|
|
430
376
|
* @remarks
|
|
431
377
|
* The chest slot. This slot is used to hold items such as
|
|
432
378
|
* Chestplate or Elytra.
|
|
@@ -434,7 +380,6 @@ export enum EquipmentSlot {
|
|
|
434
380
|
*/
|
|
435
381
|
Chest = 'Chest',
|
|
436
382
|
/**
|
|
437
|
-
* @beta
|
|
438
383
|
* @remarks
|
|
439
384
|
* The feet slot. This slot is used to hold items such as
|
|
440
385
|
* Boots.
|
|
@@ -442,7 +387,6 @@ export enum EquipmentSlot {
|
|
|
442
387
|
*/
|
|
443
388
|
Feet = 'Feet',
|
|
444
389
|
/**
|
|
445
|
-
* @beta
|
|
446
390
|
* @remarks
|
|
447
391
|
* The head slot. This slot is used to hold items such as
|
|
448
392
|
* Helmets or Carved Pumpkins.
|
|
@@ -450,7 +394,6 @@ export enum EquipmentSlot {
|
|
|
450
394
|
*/
|
|
451
395
|
Head = 'Head',
|
|
452
396
|
/**
|
|
453
|
-
* @beta
|
|
454
397
|
* @remarks
|
|
455
398
|
* The legs slot. This slot is used to hold items such as
|
|
456
399
|
* Leggings.
|
|
@@ -458,7 +401,6 @@ export enum EquipmentSlot {
|
|
|
458
401
|
*/
|
|
459
402
|
Legs = 'Legs',
|
|
460
403
|
/**
|
|
461
|
-
* @beta
|
|
462
404
|
* @remarks
|
|
463
405
|
* The mainhand slot. For players, the mainhand slot refers to
|
|
464
406
|
* the currently active hotbar slot.
|
|
@@ -466,7 +408,6 @@ export enum EquipmentSlot {
|
|
|
466
408
|
*/
|
|
467
409
|
Mainhand = 'Mainhand',
|
|
468
410
|
/**
|
|
469
|
-
* @beta
|
|
470
411
|
* @remarks
|
|
471
412
|
* The offhand slot. This slot is used to hold items such as
|
|
472
413
|
* shields and maps.
|
|
@@ -476,12 +417,10 @@ export enum EquipmentSlot {
|
|
|
476
417
|
}
|
|
477
418
|
|
|
478
419
|
/**
|
|
479
|
-
* @beta
|
|
480
420
|
* Represents a game mode for the current world experience.
|
|
481
421
|
*/
|
|
482
422
|
export enum GameMode {
|
|
483
423
|
/**
|
|
484
|
-
* @beta
|
|
485
424
|
* @remarks
|
|
486
425
|
* World is in a more locked-down experience, where blocks may
|
|
487
426
|
* not be manipulated.
|
|
@@ -489,7 +428,6 @@ export enum GameMode {
|
|
|
489
428
|
*/
|
|
490
429
|
adventure = 'adventure',
|
|
491
430
|
/**
|
|
492
|
-
* @beta
|
|
493
431
|
* @remarks
|
|
494
432
|
* World is in a full creative mode. In creative mode, the
|
|
495
433
|
* player has all the resources available in the item selection
|
|
@@ -502,7 +440,6 @@ export enum GameMode {
|
|
|
502
440
|
*/
|
|
503
441
|
creative = 'creative',
|
|
504
442
|
/**
|
|
505
|
-
* @beta
|
|
506
443
|
* @remarks
|
|
507
444
|
* World is in spectator mode. In spectator mode, spectators
|
|
508
445
|
* are always flying and cannot become grounded. Spectators can
|
|
@@ -515,7 +452,6 @@ export enum GameMode {
|
|
|
515
452
|
*/
|
|
516
453
|
spectator = 'spectator',
|
|
517
454
|
/**
|
|
518
|
-
* @beta
|
|
519
455
|
* @remarks
|
|
520
456
|
* World is in a survival mode, where players can take damage
|
|
521
457
|
* and entities may not be peaceful. Survival mode is where the
|
|
@@ -528,26 +464,22 @@ export enum GameMode {
|
|
|
528
464
|
}
|
|
529
465
|
|
|
530
466
|
/**
|
|
531
|
-
* @beta
|
|
532
467
|
* Describes how an an item can be moved within a container.
|
|
533
468
|
*/
|
|
534
469
|
export enum ItemLockMode {
|
|
535
470
|
/**
|
|
536
|
-
* @beta
|
|
537
471
|
* @remarks
|
|
538
472
|
* The item cannot be dropped or crafted with.
|
|
539
473
|
*
|
|
540
474
|
*/
|
|
541
475
|
inventory = 'inventory',
|
|
542
476
|
/**
|
|
543
|
-
* @beta
|
|
544
477
|
* @remarks
|
|
545
478
|
* The item has no container restrictions.
|
|
546
479
|
*
|
|
547
480
|
*/
|
|
548
481
|
none = 'none',
|
|
549
482
|
/**
|
|
550
|
-
* @beta
|
|
551
483
|
* @remarks
|
|
552
484
|
* The item cannot be moved from its slot, dropped or crafted
|
|
553
485
|
* with.
|
|
@@ -557,7 +489,6 @@ export enum ItemLockMode {
|
|
|
557
489
|
}
|
|
558
490
|
|
|
559
491
|
/**
|
|
560
|
-
* @beta
|
|
561
492
|
* Enum containing the different phases of the moon based on
|
|
562
493
|
* the current day.,Obtain the current MoonPhase using
|
|
563
494
|
* world.getMoonPhase.
|
|
@@ -570,7 +501,6 @@ export enum ItemLockMode {
|
|
|
570
501
|
*/
|
|
571
502
|
export enum MoonPhase {
|
|
572
503
|
/**
|
|
573
|
-
* @beta
|
|
574
504
|
* @remarks
|
|
575
505
|
* The brightest moon phase. During this phase, cats have a 50%
|
|
576
506
|
* chance of spawning as black cats.
|
|
@@ -578,49 +508,42 @@ export enum MoonPhase {
|
|
|
578
508
|
*/
|
|
579
509
|
FullMoon = 0,
|
|
580
510
|
/**
|
|
581
|
-
* @beta
|
|
582
511
|
* @remarks
|
|
583
512
|
* The phase following the Full Moon.
|
|
584
513
|
*
|
|
585
514
|
*/
|
|
586
515
|
WaningGibbous = 1,
|
|
587
516
|
/**
|
|
588
|
-
* @beta
|
|
589
517
|
* @remarks
|
|
590
518
|
* The phase following the Waxing Crescent.
|
|
591
519
|
*
|
|
592
520
|
*/
|
|
593
521
|
FirstQuarter = 2,
|
|
594
522
|
/**
|
|
595
|
-
* @beta
|
|
596
523
|
* @remarks
|
|
597
524
|
* The phase following the Last Quarter.
|
|
598
525
|
*
|
|
599
526
|
*/
|
|
600
527
|
WaningCrescent = 3,
|
|
601
528
|
/**
|
|
602
|
-
* @beta
|
|
603
529
|
* @remarks
|
|
604
530
|
* The darkest moon phase.
|
|
605
531
|
*
|
|
606
532
|
*/
|
|
607
533
|
NewMoon = 4,
|
|
608
534
|
/**
|
|
609
|
-
* @beta
|
|
610
535
|
* @remarks
|
|
611
536
|
* The phase following the New Moon.
|
|
612
537
|
*
|
|
613
538
|
*/
|
|
614
539
|
WaxingCrescent = 5,
|
|
615
540
|
/**
|
|
616
|
-
* @beta
|
|
617
541
|
* @remarks
|
|
618
542
|
* The phase following the Waning Gibbous.
|
|
619
543
|
*
|
|
620
544
|
*/
|
|
621
545
|
LastQuarter = 6,
|
|
622
546
|
/**
|
|
623
|
-
* @beta
|
|
624
547
|
* @remarks
|
|
625
548
|
* The phase following the First Quarter.
|
|
626
549
|
*
|
|
@@ -629,13 +552,11 @@ export enum MoonPhase {
|
|
|
629
552
|
}
|
|
630
553
|
|
|
631
554
|
/**
|
|
632
|
-
* @beta
|
|
633
555
|
* Used for specifying a sort order for how to display an
|
|
634
556
|
* objective and its list of participants.
|
|
635
557
|
*/
|
|
636
558
|
export enum ObjectiveSortOrder {
|
|
637
559
|
/**
|
|
638
|
-
* @beta
|
|
639
560
|
* @remarks
|
|
640
561
|
* Objective participant list is displayed in ascending (e.g.,
|
|
641
562
|
* A-Z) order.
|
|
@@ -643,7 +564,6 @@ export enum ObjectiveSortOrder {
|
|
|
643
564
|
*/
|
|
644
565
|
Ascending = 0,
|
|
645
566
|
/**
|
|
646
|
-
* @beta
|
|
647
567
|
* @remarks
|
|
648
568
|
* Objective participant list is displayed in descending (e.g.,
|
|
649
569
|
* Z-A) order.
|
|
@@ -653,19 +573,16 @@ export enum ObjectiveSortOrder {
|
|
|
653
573
|
}
|
|
654
574
|
|
|
655
575
|
/**
|
|
656
|
-
* @beta
|
|
657
576
|
* Contains objectives and participants for the scoreboard.
|
|
658
577
|
*/
|
|
659
578
|
export enum ScoreboardIdentityType {
|
|
660
579
|
/**
|
|
661
|
-
* @beta
|
|
662
580
|
* @remarks
|
|
663
581
|
* This scoreboard participant is tied to an entity.
|
|
664
582
|
*
|
|
665
583
|
*/
|
|
666
584
|
Entity = 'Entity',
|
|
667
585
|
/**
|
|
668
|
-
* @beta
|
|
669
586
|
* @remarks
|
|
670
587
|
* This scoreboard participant is tied to a pseudo player
|
|
671
588
|
* entity - typically this is used to store scores as data or
|
|
@@ -674,7 +591,6 @@ export enum ScoreboardIdentityType {
|
|
|
674
591
|
*/
|
|
675
592
|
FakePlayer = 'FakePlayer',
|
|
676
593
|
/**
|
|
677
|
-
* @beta
|
|
678
594
|
* @remarks
|
|
679
595
|
* This scoreboard participant is tied to a player.
|
|
680
596
|
*
|
|
@@ -683,12 +599,10 @@ export enum ScoreboardIdentityType {
|
|
|
683
599
|
}
|
|
684
600
|
|
|
685
601
|
/**
|
|
686
|
-
* @beta
|
|
687
602
|
* Describes where the script event originated from.
|
|
688
603
|
*/
|
|
689
604
|
export enum ScriptEventSource {
|
|
690
605
|
/**
|
|
691
|
-
* @beta
|
|
692
606
|
* @remarks
|
|
693
607
|
* The script event originated from a Block such as a Command
|
|
694
608
|
* Block.
|
|
@@ -696,7 +610,6 @@ export enum ScriptEventSource {
|
|
|
696
610
|
*/
|
|
697
611
|
Block = 'Block',
|
|
698
612
|
/**
|
|
699
|
-
* @beta
|
|
700
613
|
* @remarks
|
|
701
614
|
* The script event originated from an Entity such as a Player,
|
|
702
615
|
* Command Block Minecart or Animation Controller.
|
|
@@ -704,14 +617,12 @@ export enum ScriptEventSource {
|
|
|
704
617
|
*/
|
|
705
618
|
Entity = 'Entity',
|
|
706
619
|
/**
|
|
707
|
-
* @beta
|
|
708
620
|
* @remarks
|
|
709
621
|
* The script event originated from an NPC dialogue.
|
|
710
622
|
*
|
|
711
623
|
*/
|
|
712
624
|
NPCDialogue = 'NPCDialogue',
|
|
713
625
|
/**
|
|
714
|
-
* @beta
|
|
715
626
|
* @remarks
|
|
716
627
|
* The script event originated from the server, such as from a
|
|
717
628
|
* runCommand API call or a dedicated server console.
|
|
@@ -721,7 +632,6 @@ export enum ScriptEventSource {
|
|
|
721
632
|
}
|
|
722
633
|
|
|
723
634
|
/**
|
|
724
|
-
* @beta
|
|
725
635
|
* Provides numeric values for common periods in the Minecraft
|
|
726
636
|
* day.
|
|
727
637
|
*/
|
|
@@ -735,27 +645,23 @@ export enum TimeOfDay {
|
|
|
735
645
|
}
|
|
736
646
|
|
|
737
647
|
/**
|
|
738
|
-
* @beta
|
|
739
648
|
* Used to specify the type of weather condition within the
|
|
740
649
|
* world.
|
|
741
650
|
*/
|
|
742
651
|
export enum WeatherType {
|
|
743
652
|
/**
|
|
744
|
-
* @beta
|
|
745
653
|
* @remarks
|
|
746
654
|
* Specifies a clear weather condition.
|
|
747
655
|
*
|
|
748
656
|
*/
|
|
749
657
|
Clear = 'Clear',
|
|
750
658
|
/**
|
|
751
|
-
* @beta
|
|
752
659
|
* @remarks
|
|
753
660
|
* Specifies a rain weather condition.
|
|
754
661
|
*
|
|
755
662
|
*/
|
|
756
663
|
Rain = 'Rain',
|
|
757
664
|
/**
|
|
758
|
-
* @beta
|
|
759
665
|
* @remarks
|
|
760
666
|
* Specifies a rain and thunder weather condition.
|
|
761
667
|
*
|
|
@@ -764,7 +670,6 @@ export enum WeatherType {
|
|
|
764
670
|
}
|
|
765
671
|
|
|
766
672
|
/**
|
|
767
|
-
* @beta
|
|
768
673
|
* Represents a block in a dimension. A block represents a
|
|
769
674
|
* unique X, Y, and Z within a dimension and get/sets the state
|
|
770
675
|
* of the block at that location. This type was significantly
|
|
@@ -779,7 +684,6 @@ export class Block {
|
|
|
779
684
|
*/
|
|
780
685
|
readonly dimension: Dimension;
|
|
781
686
|
/**
|
|
782
|
-
* @beta
|
|
783
687
|
* @remarks
|
|
784
688
|
* Returns true if this block is an air block (i.e., empty
|
|
785
689
|
* space).
|
|
@@ -792,7 +696,6 @@ export class Block {
|
|
|
792
696
|
*/
|
|
793
697
|
readonly isAir: boolean;
|
|
794
698
|
/**
|
|
795
|
-
* @beta
|
|
796
699
|
* @remarks
|
|
797
700
|
* Returns true if this block is a liquid block - (e.g., a
|
|
798
701
|
* water block and a lava block are liquid, while an air block
|
|
@@ -844,17 +747,11 @@ export class Block {
|
|
|
844
747
|
*/
|
|
845
748
|
readonly z: number;
|
|
846
749
|
/**
|
|
847
|
-
* @beta
|
|
848
750
|
* @remarks
|
|
849
751
|
* Gets a component (that represents additional capabilities)
|
|
850
752
|
* for a block - for example, an inventory component of a chest
|
|
851
753
|
* block.
|
|
852
754
|
*
|
|
853
|
-
* @param componentId
|
|
854
|
-
* The identifier of the component (e.g.,
|
|
855
|
-
* 'minecraft:inventory'). If no namespace prefix is specified,
|
|
856
|
-
* 'minecraft:' is assumed. Available component IDs can be
|
|
857
|
-
* found as part of the {@link BlockComponentTypes} enum.
|
|
858
755
|
* @returns
|
|
859
756
|
* Returns the component if it exists on the block, otherwise
|
|
860
757
|
* undefined.
|
|
@@ -864,9 +761,8 @@ export class Block {
|
|
|
864
761
|
*
|
|
865
762
|
* {@link LocationOutOfWorldBoundariesError}
|
|
866
763
|
*/
|
|
867
|
-
getComponent(
|
|
764
|
+
getComponent(componentName: string): BlockComponent | undefined;
|
|
868
765
|
/**
|
|
869
|
-
* @beta
|
|
870
766
|
* @remarks
|
|
871
767
|
* Returns true if this reference to a block is still valid
|
|
872
768
|
* (for example, if the block is unloaded, references to that
|
|
@@ -896,14 +792,12 @@ export class Block {
|
|
|
896
792
|
}
|
|
897
793
|
|
|
898
794
|
/**
|
|
899
|
-
* @beta
|
|
900
795
|
* Base type for components associated with blocks.
|
|
901
796
|
*/
|
|
902
797
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
903
798
|
export class BlockComponent extends Component {
|
|
904
799
|
private constructor();
|
|
905
800
|
/**
|
|
906
|
-
* @beta
|
|
907
801
|
* @remarks
|
|
908
802
|
* Block instance that this component pertains to.
|
|
909
803
|
*
|
|
@@ -912,7 +806,6 @@ export class BlockComponent extends Component {
|
|
|
912
806
|
}
|
|
913
807
|
|
|
914
808
|
/**
|
|
915
|
-
* @beta
|
|
916
809
|
* Contains information regarding an event that impacts a
|
|
917
810
|
* specific block.
|
|
918
811
|
*/
|
|
@@ -934,7 +827,6 @@ export class BlockEvent {
|
|
|
934
827
|
}
|
|
935
828
|
|
|
936
829
|
/**
|
|
937
|
-
* @beta
|
|
938
830
|
* Represents the inventory of a block in the world. Used with
|
|
939
831
|
* blocks like chests.
|
|
940
832
|
*/
|
|
@@ -952,7 +844,6 @@ export class BlockInventoryComponent extends BlockComponent {
|
|
|
952
844
|
}
|
|
953
845
|
|
|
954
846
|
/**
|
|
955
|
-
* @beta
|
|
956
847
|
* Contains the combination of type {@link BlockType} and
|
|
957
848
|
* properties (also sometimes called block state) which
|
|
958
849
|
* describe a block (but does not belong to a specific {@link
|
|
@@ -1024,7 +915,6 @@ export class BlockPermutation {
|
|
|
1024
915
|
}
|
|
1025
916
|
|
|
1026
917
|
/**
|
|
1027
|
-
* @beta
|
|
1028
918
|
* Contains information related to changes to a button push.
|
|
1029
919
|
*/
|
|
1030
920
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -1039,7 +929,6 @@ export class ButtonPushAfterEvent extends BlockEvent {
|
|
|
1039
929
|
}
|
|
1040
930
|
|
|
1041
931
|
/**
|
|
1042
|
-
* @beta
|
|
1043
932
|
* Manages callbacks that are connected to when a button is
|
|
1044
933
|
* pushed.
|
|
1045
934
|
*/
|
|
@@ -1049,7 +938,6 @@ export class ButtonPushAfterEventSignal extends IButtonPushAfterEventSignal {
|
|
|
1049
938
|
}
|
|
1050
939
|
|
|
1051
940
|
/**
|
|
1052
|
-
* @beta
|
|
1053
941
|
* Contains methods relating to the active camera for the
|
|
1054
942
|
* specified player.
|
|
1055
943
|
*/
|
|
@@ -1118,7 +1006,6 @@ export class CommandResult {
|
|
|
1118
1006
|
}
|
|
1119
1007
|
|
|
1120
1008
|
/**
|
|
1121
|
-
* @beta
|
|
1122
1009
|
* Base class for downstream Component implementations.
|
|
1123
1010
|
*/
|
|
1124
1011
|
export class Component {
|
|
@@ -1130,7 +1017,6 @@ export class Component {
|
|
|
1130
1017
|
*/
|
|
1131
1018
|
readonly typeId: string;
|
|
1132
1019
|
/**
|
|
1133
|
-
* @beta
|
|
1134
1020
|
* @remarks
|
|
1135
1021
|
* Returns whether the component is valid. A component is
|
|
1136
1022
|
* considered valid if its owner is valid, in addition to any
|
|
@@ -1144,7 +1030,6 @@ export class Component {
|
|
|
1144
1030
|
}
|
|
1145
1031
|
|
|
1146
1032
|
/**
|
|
1147
|
-
* @beta
|
|
1148
1033
|
* Represents a container that can hold sets of items. Used
|
|
1149
1034
|
* with entities such as Players, Chest Minecarts, Llamas, and
|
|
1150
1035
|
* more.
|
|
@@ -1216,7 +1101,6 @@ export class Container {
|
|
|
1216
1101
|
*/
|
|
1217
1102
|
getItem(slot: number): ItemStack | undefined;
|
|
1218
1103
|
/**
|
|
1219
|
-
* @beta
|
|
1220
1104
|
* @remarks
|
|
1221
1105
|
* Returns whether a container object (or the entity or block
|
|
1222
1106
|
* that this container is associated with) is still available
|
|
@@ -1335,7 +1219,6 @@ export class Dimension {
|
|
|
1335
1219
|
*/
|
|
1336
1220
|
readonly id: string;
|
|
1337
1221
|
/**
|
|
1338
|
-
* @beta
|
|
1339
1222
|
* @remarks
|
|
1340
1223
|
* Returns a block instance at the given location.
|
|
1341
1224
|
*
|
|
@@ -1360,7 +1243,6 @@ export class Dimension {
|
|
|
1360
1243
|
*/
|
|
1361
1244
|
getBlock(location: Vector3): Block | undefined;
|
|
1362
1245
|
/**
|
|
1363
|
-
* @beta
|
|
1364
1246
|
* @remarks
|
|
1365
1247
|
* Gets the first block that intersects with a vector emanating
|
|
1366
1248
|
* from a location.
|
|
@@ -1374,7 +1256,6 @@ export class Dimension {
|
|
|
1374
1256
|
*/
|
|
1375
1257
|
getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
|
|
1376
1258
|
/**
|
|
1377
|
-
* @beta
|
|
1378
1259
|
* @remarks
|
|
1379
1260
|
* Returns a set of entities based on a set of conditions
|
|
1380
1261
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -1443,7 +1324,6 @@ export class Dimension {
|
|
|
1443
1324
|
*/
|
|
1444
1325
|
getEntities(options?: EntityQueryOptions): Entity[];
|
|
1445
1326
|
/**
|
|
1446
|
-
* @beta
|
|
1447
1327
|
* @remarks
|
|
1448
1328
|
* Returns a set of entities at a particular location.
|
|
1449
1329
|
*
|
|
@@ -1454,7 +1334,6 @@ export class Dimension {
|
|
|
1454
1334
|
*/
|
|
1455
1335
|
getEntitiesAtBlockLocation(location: Vector3): Entity[];
|
|
1456
1336
|
/**
|
|
1457
|
-
* @beta
|
|
1458
1337
|
* @remarks
|
|
1459
1338
|
* Gets entities that intersect with a specified vector
|
|
1460
1339
|
* emanating from a location.
|
|
@@ -1464,7 +1343,6 @@ export class Dimension {
|
|
|
1464
1343
|
*/
|
|
1465
1344
|
getEntitiesFromRay(location: Vector3, direction: Vector3, options?: EntityRaycastOptions): EntityRaycastHit[];
|
|
1466
1345
|
/**
|
|
1467
|
-
* @beta
|
|
1468
1346
|
* @remarks
|
|
1469
1347
|
* Returns a set of players based on a set of conditions
|
|
1470
1348
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -1478,7 +1356,6 @@ export class Dimension {
|
|
|
1478
1356
|
*/
|
|
1479
1357
|
getPlayers(options?: EntityQueryOptions): Player[];
|
|
1480
1358
|
/**
|
|
1481
|
-
* @beta
|
|
1482
1359
|
* @remarks
|
|
1483
1360
|
* Runs a command synchronously using the context of the
|
|
1484
1361
|
* broader dimenion.
|
|
@@ -1523,7 +1400,6 @@ export class Dimension {
|
|
|
1523
1400
|
*/
|
|
1524
1401
|
runCommandAsync(commandString: string): Promise<CommandResult>;
|
|
1525
1402
|
/**
|
|
1526
|
-
* @beta
|
|
1527
1403
|
* @remarks
|
|
1528
1404
|
* Sets the current weather within the dimension
|
|
1529
1405
|
*
|
|
@@ -1539,7 +1415,6 @@ export class Dimension {
|
|
|
1539
1415
|
*/
|
|
1540
1416
|
setWeather(weatherType: WeatherType, duration?: number): void;
|
|
1541
1417
|
/**
|
|
1542
|
-
* @beta
|
|
1543
1418
|
* @remarks
|
|
1544
1419
|
* Creates a new entity (e.g., a mob) at the specified
|
|
1545
1420
|
* location.
|
|
@@ -1600,7 +1475,6 @@ export class Dimension {
|
|
|
1600
1475
|
*/
|
|
1601
1476
|
spawnEntity(identifier: string, location: Vector3): Entity;
|
|
1602
1477
|
/**
|
|
1603
|
-
* @beta
|
|
1604
1478
|
* @remarks
|
|
1605
1479
|
* Creates a new item stack as an entity at the specified
|
|
1606
1480
|
* location.
|
|
@@ -1647,7 +1521,6 @@ export class Dimension {
|
|
|
1647
1521
|
*/
|
|
1648
1522
|
spawnItem(itemStack: ItemStack, location: Vector3): Entity;
|
|
1649
1523
|
/**
|
|
1650
|
-
* @beta
|
|
1651
1524
|
* @remarks
|
|
1652
1525
|
* Creates a new particle emitter at a specified location in
|
|
1653
1526
|
* the world.
|
|
@@ -1686,7 +1559,6 @@ export class Dimension {
|
|
|
1686
1559
|
}
|
|
1687
1560
|
|
|
1688
1561
|
/**
|
|
1689
|
-
* @beta
|
|
1690
1562
|
* Represents an effect - like poison - that has been added to
|
|
1691
1563
|
* an Entity.
|
|
1692
1564
|
*/
|
|
@@ -1735,7 +1607,6 @@ export class Effect {
|
|
|
1735
1607
|
}
|
|
1736
1608
|
|
|
1737
1609
|
/**
|
|
1738
|
-
* @beta
|
|
1739
1610
|
* Represents a type of effect - like poison - that can be
|
|
1740
1611
|
* applied to an entity.
|
|
1741
1612
|
*/
|
|
@@ -1758,7 +1629,6 @@ export class EffectType {
|
|
|
1758
1629
|
export class Entity {
|
|
1759
1630
|
private constructor();
|
|
1760
1631
|
/**
|
|
1761
|
-
* @beta
|
|
1762
1632
|
* @remarks
|
|
1763
1633
|
* Dimension that the entity is currently within.
|
|
1764
1634
|
*
|
|
@@ -1777,7 +1647,6 @@ export class Entity {
|
|
|
1777
1647
|
*/
|
|
1778
1648
|
readonly id: string;
|
|
1779
1649
|
/**
|
|
1780
|
-
* @beta
|
|
1781
1650
|
* @remarks
|
|
1782
1651
|
* Whether the entity is touching a climbable block. For
|
|
1783
1652
|
* example, a player next to a ladder or a spider next to a
|
|
@@ -1787,7 +1656,6 @@ export class Entity {
|
|
|
1787
1656
|
*/
|
|
1788
1657
|
readonly isClimbing: boolean;
|
|
1789
1658
|
/**
|
|
1790
|
-
* @beta
|
|
1791
1659
|
* @remarks
|
|
1792
1660
|
* Whether the entity has a fall distance greater than 0, or
|
|
1793
1661
|
* greater than 1 while gliding.
|
|
@@ -1796,7 +1664,6 @@ export class Entity {
|
|
|
1796
1664
|
*/
|
|
1797
1665
|
readonly isFalling: boolean;
|
|
1798
1666
|
/**
|
|
1799
|
-
* @beta
|
|
1800
1667
|
* @remarks
|
|
1801
1668
|
* Whether any part of the entity is inside a water block.
|
|
1802
1669
|
*
|
|
@@ -1804,7 +1671,6 @@ export class Entity {
|
|
|
1804
1671
|
*/
|
|
1805
1672
|
readonly isInWater: boolean;
|
|
1806
1673
|
/**
|
|
1807
|
-
* @beta
|
|
1808
1674
|
* @remarks
|
|
1809
1675
|
* Whether the entity is on top of a solid block.
|
|
1810
1676
|
*
|
|
@@ -1812,7 +1678,6 @@ export class Entity {
|
|
|
1812
1678
|
*/
|
|
1813
1679
|
readonly isOnGround: boolean;
|
|
1814
1680
|
/**
|
|
1815
|
-
* @beta
|
|
1816
1681
|
* @remarks
|
|
1817
1682
|
* If true, the entity is currently sleeping.
|
|
1818
1683
|
*
|
|
@@ -1820,7 +1685,6 @@ export class Entity {
|
|
|
1820
1685
|
*/
|
|
1821
1686
|
readonly isSleeping: boolean;
|
|
1822
1687
|
/**
|
|
1823
|
-
* @beta
|
|
1824
1688
|
* @remarks
|
|
1825
1689
|
* Whether the entity is sneaking - that is, moving more slowly
|
|
1826
1690
|
* and more quietly.
|
|
@@ -1830,7 +1694,6 @@ export class Entity {
|
|
|
1830
1694
|
*/
|
|
1831
1695
|
isSneaking: boolean;
|
|
1832
1696
|
/**
|
|
1833
|
-
* @beta
|
|
1834
1697
|
* @remarks
|
|
1835
1698
|
* Whether the entity is sprinting. For example, a player using
|
|
1836
1699
|
* the sprint action, an ocelot running away or a pig boosting
|
|
@@ -1840,7 +1703,6 @@ export class Entity {
|
|
|
1840
1703
|
*/
|
|
1841
1704
|
readonly isSprinting: boolean;
|
|
1842
1705
|
/**
|
|
1843
|
-
* @beta
|
|
1844
1706
|
* @remarks
|
|
1845
1707
|
* Whether the entity is in the swimming state. For example, a
|
|
1846
1708
|
* player using the swim action or a fish in water.
|
|
@@ -1849,7 +1711,6 @@ export class Entity {
|
|
|
1849
1711
|
*/
|
|
1850
1712
|
readonly isSwimming: boolean;
|
|
1851
1713
|
/**
|
|
1852
|
-
* @beta
|
|
1853
1714
|
* @remarks
|
|
1854
1715
|
* Current location of the entity.
|
|
1855
1716
|
*
|
|
@@ -1857,7 +1718,6 @@ export class Entity {
|
|
|
1857
1718
|
*/
|
|
1858
1719
|
readonly location: Vector3;
|
|
1859
1720
|
/**
|
|
1860
|
-
* @beta
|
|
1861
1721
|
* @remarks
|
|
1862
1722
|
* Given name of the entity.
|
|
1863
1723
|
*
|
|
@@ -1866,7 +1726,6 @@ export class Entity {
|
|
|
1866
1726
|
*/
|
|
1867
1727
|
nameTag: string;
|
|
1868
1728
|
/**
|
|
1869
|
-
* @beta
|
|
1870
1729
|
* @remarks
|
|
1871
1730
|
* Returns a scoreboard identity that represents this entity.
|
|
1872
1731
|
* Will remain valid when the entity is killed.
|
|
@@ -1882,7 +1741,6 @@ export class Entity {
|
|
|
1882
1741
|
*/
|
|
1883
1742
|
readonly typeId: string;
|
|
1884
1743
|
/**
|
|
1885
|
-
* @beta
|
|
1886
1744
|
* @remarks
|
|
1887
1745
|
* Adds or updates an effect, like poison, to the entity.
|
|
1888
1746
|
*
|
|
@@ -1941,7 +1799,6 @@ export class Entity {
|
|
|
1941
1799
|
*/
|
|
1942
1800
|
addEffect(effectType: EffectType | string, duration: number, options?: EntityEffectOptions): void;
|
|
1943
1801
|
/**
|
|
1944
|
-
* @beta
|
|
1945
1802
|
* @remarks
|
|
1946
1803
|
* Adds a specified tag to an entity.
|
|
1947
1804
|
*
|
|
@@ -1976,7 +1833,6 @@ export class Entity {
|
|
|
1976
1833
|
*/
|
|
1977
1834
|
addTag(tag: string): boolean;
|
|
1978
1835
|
/**
|
|
1979
|
-
* @beta
|
|
1980
1836
|
* @remarks
|
|
1981
1837
|
* Applies a set of damage to an entity.
|
|
1982
1838
|
*
|
|
@@ -2009,7 +1865,6 @@ export class Entity {
|
|
|
2009
1865
|
*/
|
|
2010
1866
|
applyDamage(amount: number, options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions): boolean;
|
|
2011
1867
|
/**
|
|
2012
|
-
* @beta
|
|
2013
1868
|
* @remarks
|
|
2014
1869
|
* Applies impulse vector to the current velocity of the
|
|
2015
1870
|
* entity.
|
|
@@ -2031,7 +1886,6 @@ export class Entity {
|
|
|
2031
1886
|
*/
|
|
2032
1887
|
applyImpulse(vector: Vector3): void;
|
|
2033
1888
|
/**
|
|
2034
|
-
* @beta
|
|
2035
1889
|
* @remarks
|
|
2036
1890
|
* Applies impulse vector to the current velocity of the
|
|
2037
1891
|
* entity.
|
|
@@ -2067,7 +1921,6 @@ export class Entity {
|
|
|
2067
1921
|
*/
|
|
2068
1922
|
applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void;
|
|
2069
1923
|
/**
|
|
2070
|
-
* @beta
|
|
2071
1924
|
* @remarks
|
|
2072
1925
|
* Sets the current velocity of the Entity to zero. Note that
|
|
2073
1926
|
* this method may not have an impact on Players.
|
|
@@ -2087,7 +1940,6 @@ export class Entity {
|
|
|
2087
1940
|
*/
|
|
2088
1941
|
clearVelocity(): void;
|
|
2089
1942
|
/**
|
|
2090
|
-
* @beta
|
|
2091
1943
|
* @remarks
|
|
2092
1944
|
* Returns the first intersecting block from the direction that
|
|
2093
1945
|
* this entity is looking at.
|
|
@@ -2101,7 +1953,6 @@ export class Entity {
|
|
|
2101
1953
|
*/
|
|
2102
1954
|
getBlockFromViewDirection(options?: BlockRaycastOptions): BlockRaycastHit | undefined;
|
|
2103
1955
|
/**
|
|
2104
|
-
* @beta
|
|
2105
1956
|
* @remarks
|
|
2106
1957
|
* Gets a component (that represents additional capabilities)
|
|
2107
1958
|
* for an entity.
|
|
@@ -2110,14 +1961,13 @@ export class Entity {
|
|
|
2110
1961
|
* The identifier of the component (e.g., 'minecraft:health').
|
|
2111
1962
|
* If no namespace prefix is specified, 'minecraft:' is
|
|
2112
1963
|
* assumed. Available component IDs can be found as part of the
|
|
2113
|
-
* {@link EntityComponentTypes} enum.
|
|
1964
|
+
* {@link @minecraft/server.EntityComponentTypes} enum.
|
|
2114
1965
|
* @returns
|
|
2115
1966
|
* Returns the component if it exists on the entity, otherwise
|
|
2116
1967
|
* undefined.
|
|
2117
1968
|
*/
|
|
2118
1969
|
getComponent(componentId: string): EntityComponent | undefined;
|
|
2119
1970
|
/**
|
|
2120
|
-
* @beta
|
|
2121
1971
|
* @remarks
|
|
2122
1972
|
* Returns all components that are both present on this entity
|
|
2123
1973
|
* and supported by the API.
|
|
@@ -2128,7 +1978,6 @@ export class Entity {
|
|
|
2128
1978
|
*/
|
|
2129
1979
|
getComponents(): EntityComponent[];
|
|
2130
1980
|
/**
|
|
2131
|
-
* @beta
|
|
2132
1981
|
* @remarks
|
|
2133
1982
|
* Returns the effect for the specified EffectType on the
|
|
2134
1983
|
* entity, undefined if the effect is not present, or throws an
|
|
@@ -2144,7 +1993,6 @@ export class Entity {
|
|
|
2144
1993
|
*/
|
|
2145
1994
|
getEffect(effectType: EffectType | string): Effect | undefined;
|
|
2146
1995
|
/**
|
|
2147
|
-
* @beta
|
|
2148
1996
|
* @remarks
|
|
2149
1997
|
* Returns a set of effects applied to this entity.
|
|
2150
1998
|
*
|
|
@@ -2154,7 +2002,6 @@ export class Entity {
|
|
|
2154
2002
|
*/
|
|
2155
2003
|
getEffects(): Effect[];
|
|
2156
2004
|
/**
|
|
2157
|
-
* @beta
|
|
2158
2005
|
* @remarks
|
|
2159
2006
|
* Gets the entities that this entity is looking at by
|
|
2160
2007
|
* performing a ray cast from the view of this entity.
|
|
@@ -2168,7 +2015,6 @@ export class Entity {
|
|
|
2168
2015
|
*/
|
|
2169
2016
|
getEntitiesFromViewDirection(options?: EntityRaycastOptions): EntityRaycastHit[];
|
|
2170
2017
|
/**
|
|
2171
|
-
* @beta
|
|
2172
2018
|
* @remarks
|
|
2173
2019
|
* Returns the current location of the head component of this
|
|
2174
2020
|
* entity.
|
|
@@ -2180,7 +2026,6 @@ export class Entity {
|
|
|
2180
2026
|
*/
|
|
2181
2027
|
getHeadLocation(): Vector3;
|
|
2182
2028
|
/**
|
|
2183
|
-
* @beta
|
|
2184
2029
|
* @remarks
|
|
2185
2030
|
* Gets an entity Property value. If the property was set using
|
|
2186
2031
|
* the setProperty function within the same tick, the updated
|
|
@@ -2198,7 +2043,6 @@ export class Entity {
|
|
|
2198
2043
|
*/
|
|
2199
2044
|
getProperty(identifier: string): boolean | number | string | undefined;
|
|
2200
2045
|
/**
|
|
2201
|
-
* @beta
|
|
2202
2046
|
* @remarks
|
|
2203
2047
|
* Returns the current rotation component of this entity.
|
|
2204
2048
|
*
|
|
@@ -2209,17 +2053,13 @@ export class Entity {
|
|
|
2209
2053
|
*/
|
|
2210
2054
|
getRotation(): Vector2;
|
|
2211
2055
|
/**
|
|
2212
|
-
* @beta
|
|
2213
2056
|
* @remarks
|
|
2214
|
-
* Returns all tags associated with an entity.
|
|
2215
|
-
*
|
|
2216
2057
|
* @returns
|
|
2217
|
-
* Returns
|
|
2058
|
+
* Returns all tags associated with an entity.
|
|
2218
2059
|
* @throws This function can throw errors.
|
|
2219
2060
|
*/
|
|
2220
2061
|
getTags(): string[];
|
|
2221
2062
|
/**
|
|
2222
|
-
* @beta
|
|
2223
2063
|
* @remarks
|
|
2224
2064
|
* Returns the current velocity vector of the entity.
|
|
2225
2065
|
*
|
|
@@ -2239,7 +2079,6 @@ export class Entity {
|
|
|
2239
2079
|
*/
|
|
2240
2080
|
getVelocity(): Vector3;
|
|
2241
2081
|
/**
|
|
2242
|
-
* @beta
|
|
2243
2082
|
* @remarks
|
|
2244
2083
|
* Returns the current view direction of the entity.
|
|
2245
2084
|
*
|
|
@@ -2249,7 +2088,6 @@ export class Entity {
|
|
|
2249
2088
|
*/
|
|
2250
2089
|
getViewDirection(): Vector3;
|
|
2251
2090
|
/**
|
|
2252
|
-
* @beta
|
|
2253
2091
|
* @remarks
|
|
2254
2092
|
* Returns true if the specified component is present on this
|
|
2255
2093
|
* entity.
|
|
@@ -2264,7 +2102,6 @@ export class Entity {
|
|
|
2264
2102
|
*/
|
|
2265
2103
|
hasComponent(componentId: string): boolean;
|
|
2266
2104
|
/**
|
|
2267
|
-
* @beta
|
|
2268
2105
|
* @remarks
|
|
2269
2106
|
* Returns whether an entity has a particular tag.
|
|
2270
2107
|
*
|
|
@@ -2276,7 +2113,6 @@ export class Entity {
|
|
|
2276
2113
|
*/
|
|
2277
2114
|
hasTag(tag: string): boolean;
|
|
2278
2115
|
/**
|
|
2279
|
-
* @beta
|
|
2280
2116
|
* @remarks
|
|
2281
2117
|
* Returns whether the entity can be manipulated by script. A
|
|
2282
2118
|
* Player is considered valid when it's EntityLifetimeState is
|
|
@@ -2287,7 +2123,6 @@ export class Entity {
|
|
|
2287
2123
|
*/
|
|
2288
2124
|
isValid(): boolean;
|
|
2289
2125
|
/**
|
|
2290
|
-
* @beta
|
|
2291
2126
|
* @remarks
|
|
2292
2127
|
* Kills this entity. The entity will drop loot as normal.
|
|
2293
2128
|
*
|
|
@@ -2319,7 +2154,6 @@ export class Entity {
|
|
|
2319
2154
|
*/
|
|
2320
2155
|
kill(): boolean;
|
|
2321
2156
|
/**
|
|
2322
|
-
* @beta
|
|
2323
2157
|
* @remarks
|
|
2324
2158
|
* Removes the specified EffectType on the entity, or returns
|
|
2325
2159
|
* false if the effect is not present.
|
|
@@ -2335,7 +2169,6 @@ export class Entity {
|
|
|
2335
2169
|
*/
|
|
2336
2170
|
removeEffect(effectType: EffectType | string): boolean;
|
|
2337
2171
|
/**
|
|
2338
|
-
* @beta
|
|
2339
2172
|
* @remarks
|
|
2340
2173
|
* Removes a specified tag from an entity.
|
|
2341
2174
|
*
|
|
@@ -2349,7 +2182,6 @@ export class Entity {
|
|
|
2349
2182
|
*/
|
|
2350
2183
|
removeTag(tag: string): boolean;
|
|
2351
2184
|
/**
|
|
2352
|
-
* @beta
|
|
2353
2185
|
* @remarks
|
|
2354
2186
|
* Resets an Entity Property back to its default value, as
|
|
2355
2187
|
* specified in the Entity's definition. This property change
|
|
@@ -2373,7 +2205,6 @@ export class Entity {
|
|
|
2373
2205
|
*/
|
|
2374
2206
|
resetProperty(identifier: string): boolean | number | string;
|
|
2375
2207
|
/**
|
|
2376
|
-
* @beta
|
|
2377
2208
|
* @remarks
|
|
2378
2209
|
* Runs a synchronous command on the entity.
|
|
2379
2210
|
*
|
|
@@ -2408,7 +2239,6 @@ export class Entity {
|
|
|
2408
2239
|
*/
|
|
2409
2240
|
runCommandAsync(commandString: string): Promise<CommandResult>;
|
|
2410
2241
|
/**
|
|
2411
|
-
* @beta
|
|
2412
2242
|
* @remarks
|
|
2413
2243
|
* Sets an Entity Property to the provided value. This property
|
|
2414
2244
|
* change is not applied until the next tick.
|
|
@@ -2432,7 +2262,6 @@ export class Entity {
|
|
|
2432
2262
|
*/
|
|
2433
2263
|
setProperty(identifier: string, value: boolean | number | string): void;
|
|
2434
2264
|
/**
|
|
2435
|
-
* @beta
|
|
2436
2265
|
* @remarks
|
|
2437
2266
|
* Sets the main rotation of the entity.
|
|
2438
2267
|
*
|
|
@@ -2446,7 +2275,6 @@ export class Entity {
|
|
|
2446
2275
|
*/
|
|
2447
2276
|
setRotation(rotation: Vector2): void;
|
|
2448
2277
|
/**
|
|
2449
|
-
* @beta
|
|
2450
2278
|
* @remarks
|
|
2451
2279
|
* Teleports the selected entity to a new location
|
|
2452
2280
|
*
|
|
@@ -2479,7 +2307,6 @@ export class Entity {
|
|
|
2479
2307
|
*/
|
|
2480
2308
|
teleport(location: Vector3, teleportOptions?: TeleportOptions): void;
|
|
2481
2309
|
/**
|
|
2482
|
-
* @beta
|
|
2483
2310
|
* @remarks
|
|
2484
2311
|
* Triggers an entity type event. For every entity, a number of
|
|
2485
2312
|
* events are defined in an entities' definition for key entity
|
|
@@ -2503,7 +2330,6 @@ export class Entity {
|
|
|
2503
2330
|
*/
|
|
2504
2331
|
triggerEvent(eventName: string): void;
|
|
2505
2332
|
/**
|
|
2506
|
-
* @beta
|
|
2507
2333
|
* @remarks
|
|
2508
2334
|
* Attempts to try a teleport, but may not complete the
|
|
2509
2335
|
* teleport operation (for example, if there are blocks at the
|
|
@@ -2525,7 +2351,6 @@ export class Entity {
|
|
|
2525
2351
|
}
|
|
2526
2352
|
|
|
2527
2353
|
/**
|
|
2528
|
-
* @beta
|
|
2529
2354
|
* This is a base abstract class for any entity component that
|
|
2530
2355
|
* centers around a number and can have a minimum, maximum, and
|
|
2531
2356
|
* default defined value.
|
|
@@ -2605,7 +2430,6 @@ export class EntityAttributeComponent extends EntityComponent {
|
|
|
2605
2430
|
}
|
|
2606
2431
|
|
|
2607
2432
|
/**
|
|
2608
|
-
* @beta
|
|
2609
2433
|
* Base class for a family of entity movement events.
|
|
2610
2434
|
*/
|
|
2611
2435
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -2621,7 +2445,6 @@ export class EntityBaseMovementComponent extends EntityComponent {
|
|
|
2621
2445
|
}
|
|
2622
2446
|
|
|
2623
2447
|
/**
|
|
2624
|
-
* @beta
|
|
2625
2448
|
* When added, this component signifies that the entity can
|
|
2626
2449
|
* climb up ladders.
|
|
2627
2450
|
*/
|
|
@@ -2632,7 +2455,6 @@ export class EntityCanClimbComponent extends EntityComponent {
|
|
|
2632
2455
|
}
|
|
2633
2456
|
|
|
2634
2457
|
/**
|
|
2635
|
-
* @beta
|
|
2636
2458
|
* When added, this component signifies that the entity can
|
|
2637
2459
|
* fly, and the pathfinder won't be restricted to paths where a
|
|
2638
2460
|
* solid block is required underneath it.
|
|
@@ -2644,7 +2466,6 @@ export class EntityCanFlyComponent extends EntityComponent {
|
|
|
2644
2466
|
}
|
|
2645
2467
|
|
|
2646
2468
|
/**
|
|
2647
|
-
* @beta
|
|
2648
2469
|
* When added, this component signifies that the entity can
|
|
2649
2470
|
* power jump like the horse does within Minecraft.
|
|
2650
2471
|
*/
|
|
@@ -2655,7 +2476,6 @@ export class EntityCanPowerJumpComponent extends EntityComponent {
|
|
|
2655
2476
|
}
|
|
2656
2477
|
|
|
2657
2478
|
/**
|
|
2658
|
-
* @beta
|
|
2659
2479
|
* Defines the entity's color. Only works on certain entities
|
|
2660
2480
|
* that have predefined color values (e.g., sheep, llama,
|
|
2661
2481
|
* shulker).
|
|
@@ -2675,7 +2495,6 @@ export class EntityColorComponent extends EntityComponent {
|
|
|
2675
2495
|
}
|
|
2676
2496
|
|
|
2677
2497
|
/**
|
|
2678
|
-
* @beta
|
|
2679
2498
|
* Base class for downstream entity components.
|
|
2680
2499
|
*/
|
|
2681
2500
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -2684,7 +2503,6 @@ export class EntityComponent extends Component {
|
|
|
2684
2503
|
}
|
|
2685
2504
|
|
|
2686
2505
|
/**
|
|
2687
|
-
* @beta
|
|
2688
2506
|
* Contains data related to the death of an entity in the game.
|
|
2689
2507
|
*/
|
|
2690
2508
|
export class EntityDieAfterEvent {
|
|
@@ -2705,7 +2523,6 @@ export class EntityDieAfterEvent {
|
|
|
2705
2523
|
}
|
|
2706
2524
|
|
|
2707
2525
|
/**
|
|
2708
|
-
* @beta
|
|
2709
2526
|
* Supports registering for an event that fires after an entity
|
|
2710
2527
|
* has died.
|
|
2711
2528
|
*/
|
|
@@ -2743,7 +2560,6 @@ export class EntityDieAfterEventSignal {
|
|
|
2743
2560
|
}
|
|
2744
2561
|
|
|
2745
2562
|
/**
|
|
2746
|
-
* @beta
|
|
2747
2563
|
* Provides access to a mob's equipment slots. This component
|
|
2748
2564
|
* exists for all mob entities.
|
|
2749
2565
|
*/
|
|
@@ -2781,7 +2597,6 @@ export class EntityEquippableComponent extends EntityComponent {
|
|
|
2781
2597
|
}
|
|
2782
2598
|
|
|
2783
2599
|
/**
|
|
2784
|
-
* @beta
|
|
2785
2600
|
* When added, this component signifies that this entity
|
|
2786
2601
|
* doesn't take damage from fire.
|
|
2787
2602
|
*/
|
|
@@ -2792,7 +2607,6 @@ export class EntityFireImmuneComponent extends EntityComponent {
|
|
|
2792
2607
|
}
|
|
2793
2608
|
|
|
2794
2609
|
/**
|
|
2795
|
-
* @beta
|
|
2796
2610
|
* When added, this component signifies that this entity can
|
|
2797
2611
|
* float in liquid blocks.
|
|
2798
2612
|
*/
|
|
@@ -2803,7 +2617,6 @@ export class EntityFloatsInLiquidComponent extends EntityComponent {
|
|
|
2803
2617
|
}
|
|
2804
2618
|
|
|
2805
2619
|
/**
|
|
2806
|
-
* @beta
|
|
2807
2620
|
* Represents the flying speed of an entity.
|
|
2808
2621
|
*/
|
|
2809
2622
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -2821,7 +2634,6 @@ export class EntityFlyingSpeedComponent extends EntityComponent {
|
|
|
2821
2634
|
}
|
|
2822
2635
|
|
|
2823
2636
|
/**
|
|
2824
|
-
* @beta
|
|
2825
2637
|
* Defines how much friction affects this entity.
|
|
2826
2638
|
*/
|
|
2827
2639
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -2840,7 +2652,6 @@ export class EntityFrictionModifierComponent extends EntityComponent {
|
|
|
2840
2652
|
}
|
|
2841
2653
|
|
|
2842
2654
|
/**
|
|
2843
|
-
* @beta
|
|
2844
2655
|
* Sets the offset from the ground that the entity is actually
|
|
2845
2656
|
* at.
|
|
2846
2657
|
*/
|
|
@@ -2861,7 +2672,6 @@ export class EntityGroundOffsetComponent extends EntityComponent {
|
|
|
2861
2672
|
}
|
|
2862
2673
|
|
|
2863
2674
|
/**
|
|
2864
|
-
* @beta
|
|
2865
2675
|
* Defines the interactions with this entity for healing it.
|
|
2866
2676
|
*/
|
|
2867
2677
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -2888,7 +2698,6 @@ export class EntityHealableComponent extends EntityComponent {
|
|
|
2888
2698
|
}
|
|
2889
2699
|
|
|
2890
2700
|
/**
|
|
2891
|
-
* @beta
|
|
2892
2701
|
* Contains information related to an entity when its health
|
|
2893
2702
|
* changes. Warning: don't change the health of an entity in
|
|
2894
2703
|
* this event, or it will cause an infinite loop!
|
|
@@ -2916,7 +2725,6 @@ export class EntityHealthChangedAfterEvent {
|
|
|
2916
2725
|
}
|
|
2917
2726
|
|
|
2918
2727
|
/**
|
|
2919
|
-
* @beta
|
|
2920
2728
|
* Manages callbacks that are connected to when the health of
|
|
2921
2729
|
* an entity changes.
|
|
2922
2730
|
*/
|
|
@@ -2947,7 +2755,6 @@ export class EntityHealthChangedAfterEventSignal {
|
|
|
2947
2755
|
}
|
|
2948
2756
|
|
|
2949
2757
|
/**
|
|
2950
|
-
* @beta
|
|
2951
2758
|
* Defines the health properties of an entity.
|
|
2952
2759
|
*/
|
|
2953
2760
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -2957,7 +2764,6 @@ export class EntityHealthComponent extends EntityAttributeComponent {
|
|
|
2957
2764
|
}
|
|
2958
2765
|
|
|
2959
2766
|
/**
|
|
2960
|
-
* @beta
|
|
2961
2767
|
* Contains information related to an entity hitting a block.
|
|
2962
2768
|
*/
|
|
2963
2769
|
export class EntityHitBlockAfterEvent {
|
|
@@ -2983,7 +2789,6 @@ export class EntityHitBlockAfterEvent {
|
|
|
2983
2789
|
}
|
|
2984
2790
|
|
|
2985
2791
|
/**
|
|
2986
|
-
* @beta
|
|
2987
2792
|
* Manages callbacks that are connected to when an entity hits
|
|
2988
2793
|
* a block.
|
|
2989
2794
|
*/
|
|
@@ -3014,7 +2819,6 @@ export class EntityHitBlockAfterEventSignal {
|
|
|
3014
2819
|
}
|
|
3015
2820
|
|
|
3016
2821
|
/**
|
|
3017
|
-
* @beta
|
|
3018
2822
|
* Contains information related to an entity hitting (melee
|
|
3019
2823
|
* attacking) another entity.
|
|
3020
2824
|
*/
|
|
@@ -3035,7 +2839,6 @@ export class EntityHitEntityAfterEvent {
|
|
|
3035
2839
|
}
|
|
3036
2840
|
|
|
3037
2841
|
/**
|
|
3038
|
-
* @beta
|
|
3039
2842
|
* Manages callbacks that are connected to when an entity makes
|
|
3040
2843
|
* a melee attack on another entity.
|
|
3041
2844
|
*/
|
|
@@ -3066,7 +2869,6 @@ export class EntityHitEntityAfterEventSignal {
|
|
|
3066
2869
|
}
|
|
3067
2870
|
|
|
3068
2871
|
/**
|
|
3069
|
-
* @beta
|
|
3070
2872
|
* Contains information related to an entity getting hurt.
|
|
3071
2873
|
*/
|
|
3072
2874
|
export class EntityHurtAfterEvent {
|
|
@@ -3093,7 +2895,6 @@ export class EntityHurtAfterEvent {
|
|
|
3093
2895
|
}
|
|
3094
2896
|
|
|
3095
2897
|
/**
|
|
3096
|
-
* @beta
|
|
3097
2898
|
* Manages callbacks that are connected to when an entity is
|
|
3098
2899
|
* hurt.
|
|
3099
2900
|
*/
|
|
@@ -3122,7 +2923,6 @@ export class EntityHurtAfterEventSignal {
|
|
|
3122
2923
|
}
|
|
3123
2924
|
|
|
3124
2925
|
/**
|
|
3125
|
-
* @beta
|
|
3126
2926
|
* Defines this entity's inventory properties.
|
|
3127
2927
|
*/
|
|
3128
2928
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -3146,7 +2946,8 @@ export class EntityInventoryComponent extends EntityComponent {
|
|
|
3146
2946
|
readonly canBeSiphonedFrom: boolean;
|
|
3147
2947
|
/**
|
|
3148
2948
|
* @remarks
|
|
3149
|
-
* Defines the container for this entity.
|
|
2949
|
+
* Defines the container for this entity. The container will be
|
|
2950
|
+
* undefined if the entity has been removed.
|
|
3150
2951
|
*
|
|
3151
2952
|
* @throws This property can throw when used.
|
|
3152
2953
|
*/
|
|
@@ -3184,7 +2985,6 @@ export class EntityInventoryComponent extends EntityComponent {
|
|
|
3184
2985
|
}
|
|
3185
2986
|
|
|
3186
2987
|
/**
|
|
3187
|
-
* @beta
|
|
3188
2988
|
* When added, this component signifies that this entity is a
|
|
3189
2989
|
* baby.
|
|
3190
2990
|
*/
|
|
@@ -3195,7 +2995,6 @@ export class EntityIsBabyComponent extends EntityComponent {
|
|
|
3195
2995
|
}
|
|
3196
2996
|
|
|
3197
2997
|
/**
|
|
3198
|
-
* @beta
|
|
3199
2998
|
* When added, this component signifies that this entity is
|
|
3200
2999
|
* charged.
|
|
3201
3000
|
*/
|
|
@@ -3206,7 +3005,6 @@ export class EntityIsChargedComponent extends EntityComponent {
|
|
|
3206
3005
|
}
|
|
3207
3006
|
|
|
3208
3007
|
/**
|
|
3209
|
-
* @beta
|
|
3210
3008
|
* When added, this component signifies that this entity is
|
|
3211
3009
|
* currently carrying a chest.
|
|
3212
3010
|
*/
|
|
@@ -3217,7 +3015,6 @@ export class EntityIsChestedComponent extends EntityComponent {
|
|
|
3217
3015
|
}
|
|
3218
3016
|
|
|
3219
3017
|
/**
|
|
3220
|
-
* @beta
|
|
3221
3018
|
* When added, this component signifies that dyes can be used
|
|
3222
3019
|
* on this entity to change its color.
|
|
3223
3020
|
*/
|
|
@@ -3228,7 +3025,6 @@ export class EntityIsDyeableComponent extends EntityComponent {
|
|
|
3228
3025
|
}
|
|
3229
3026
|
|
|
3230
3027
|
/**
|
|
3231
|
-
* @beta
|
|
3232
3028
|
* When added, this component signifies that this entity can
|
|
3233
3029
|
* hide from hostile mobs while invisible.
|
|
3234
3030
|
*/
|
|
@@ -3239,7 +3035,6 @@ export class EntityIsHiddenWhenInvisibleComponent extends EntityComponent {
|
|
|
3239
3035
|
}
|
|
3240
3036
|
|
|
3241
3037
|
/**
|
|
3242
|
-
* @beta
|
|
3243
3038
|
* When added, this component signifies that this entity this
|
|
3244
3039
|
* currently on fire.
|
|
3245
3040
|
*/
|
|
@@ -3250,7 +3045,6 @@ export class EntityIsIgnitedComponent extends EntityComponent {
|
|
|
3250
3045
|
}
|
|
3251
3046
|
|
|
3252
3047
|
/**
|
|
3253
|
-
* @beta
|
|
3254
3048
|
* When added, this component signifies that this entity is an
|
|
3255
3049
|
* illager captain.
|
|
3256
3050
|
*/
|
|
@@ -3261,7 +3055,6 @@ export class EntityIsIllagerCaptainComponent extends EntityComponent {
|
|
|
3261
3055
|
}
|
|
3262
3056
|
|
|
3263
3057
|
/**
|
|
3264
|
-
* @beta
|
|
3265
3058
|
* When added, this component signifies that this entity is
|
|
3266
3059
|
* currently saddled.
|
|
3267
3060
|
*/
|
|
@@ -3272,7 +3065,6 @@ export class EntityIsSaddledComponent extends EntityComponent {
|
|
|
3272
3065
|
}
|
|
3273
3066
|
|
|
3274
3067
|
/**
|
|
3275
|
-
* @beta
|
|
3276
3068
|
* When added, this component signifies that this entity is
|
|
3277
3069
|
* currently shaking.
|
|
3278
3070
|
*/
|
|
@@ -3283,7 +3075,6 @@ export class EntityIsShakingComponent extends EntityComponent {
|
|
|
3283
3075
|
}
|
|
3284
3076
|
|
|
3285
3077
|
/**
|
|
3286
|
-
* @beta
|
|
3287
3078
|
* When added, this component signifies that this entity is
|
|
3288
3079
|
* currently sheared.
|
|
3289
3080
|
*/
|
|
@@ -3294,7 +3085,6 @@ export class EntityIsShearedComponent extends EntityComponent {
|
|
|
3294
3085
|
}
|
|
3295
3086
|
|
|
3296
3087
|
/**
|
|
3297
|
-
* @beta
|
|
3298
3088
|
* When added, this component signifies that this entity can be
|
|
3299
3089
|
* stacked.
|
|
3300
3090
|
*/
|
|
@@ -3305,7 +3095,6 @@ export class EntityIsStackableComponent extends EntityComponent {
|
|
|
3305
3095
|
}
|
|
3306
3096
|
|
|
3307
3097
|
/**
|
|
3308
|
-
* @beta
|
|
3309
3098
|
* When added, this component signifies that this entity is
|
|
3310
3099
|
* currently stunned.
|
|
3311
3100
|
*/
|
|
@@ -3316,7 +3105,6 @@ export class EntityIsStunnedComponent extends EntityComponent {
|
|
|
3316
3105
|
}
|
|
3317
3106
|
|
|
3318
3107
|
/**
|
|
3319
|
-
* @beta
|
|
3320
3108
|
* When added, this component signifies that this entity is
|
|
3321
3109
|
* currently tamed.
|
|
3322
3110
|
*/
|
|
@@ -3327,7 +3115,6 @@ export class EntityIsTamedComponent extends EntityComponent {
|
|
|
3327
3115
|
}
|
|
3328
3116
|
|
|
3329
3117
|
/**
|
|
3330
|
-
* @beta
|
|
3331
3118
|
* If added onto the entity, this indicates that the entity
|
|
3332
3119
|
* represents a free-floating item in the world. Lets you
|
|
3333
3120
|
* retrieve the actual item stack contents via the itemStack
|
|
@@ -3347,7 +3134,6 @@ export class EntityItemComponent extends EntityComponent {
|
|
|
3347
3134
|
}
|
|
3348
3135
|
|
|
3349
3136
|
/**
|
|
3350
|
-
* @beta
|
|
3351
3137
|
* Contains data related to an entity loaded within the world.
|
|
3352
3138
|
* This could happen when an unloaded chunk is reloaded, or
|
|
3353
3139
|
* when an entity changes dimensions.
|
|
@@ -3365,7 +3151,6 @@ export class EntityLoadAfterEvent {
|
|
|
3365
3151
|
}
|
|
3366
3152
|
|
|
3367
3153
|
/**
|
|
3368
|
-
* @beta
|
|
3369
3154
|
* Registers a script-based event handler for handling what
|
|
3370
3155
|
* happens when an entity loads.
|
|
3371
3156
|
*/
|
|
@@ -3398,7 +3183,6 @@ export class EntityLoadAfterEventSignal {
|
|
|
3398
3183
|
}
|
|
3399
3184
|
|
|
3400
3185
|
/**
|
|
3401
|
-
* @beta
|
|
3402
3186
|
* Additional variant value. Can be used to further
|
|
3403
3187
|
* differentiate variants.
|
|
3404
3188
|
*/
|
|
@@ -3417,7 +3201,6 @@ export class EntityMarkVariantComponent extends EntityComponent {
|
|
|
3417
3201
|
}
|
|
3418
3202
|
|
|
3419
3203
|
/**
|
|
3420
|
-
* @beta
|
|
3421
3204
|
* When added, this movement control allows the mob to swim in
|
|
3422
3205
|
* water and walk on land.
|
|
3423
3206
|
*/
|
|
@@ -3428,7 +3211,6 @@ export class EntityMovementAmphibiousComponent extends EntityBaseMovementCompone
|
|
|
3428
3211
|
}
|
|
3429
3212
|
|
|
3430
3213
|
/**
|
|
3431
|
-
* @beta
|
|
3432
3214
|
* This component accents the movement of an entity.
|
|
3433
3215
|
*/
|
|
3434
3216
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -3438,7 +3220,6 @@ export class EntityMovementBasicComponent extends EntityBaseMovementComponent {
|
|
|
3438
3220
|
}
|
|
3439
3221
|
|
|
3440
3222
|
/**
|
|
3441
|
-
* @beta
|
|
3442
3223
|
* When added, this move control causes the mob to fly.
|
|
3443
3224
|
*/
|
|
3444
3225
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -3448,7 +3229,6 @@ export class EntityMovementFlyComponent extends EntityBaseMovementComponent {
|
|
|
3448
3229
|
}
|
|
3449
3230
|
|
|
3450
3231
|
/**
|
|
3451
|
-
* @beta
|
|
3452
3232
|
* When added, this move control allows a mob to fly, swim,
|
|
3453
3233
|
* climb, etc.
|
|
3454
3234
|
*/
|
|
@@ -3459,7 +3239,6 @@ export class EntityMovementGenericComponent extends EntityBaseMovementComponent
|
|
|
3459
3239
|
}
|
|
3460
3240
|
|
|
3461
3241
|
/**
|
|
3462
|
-
* @beta
|
|
3463
3242
|
* When added, this move control causes the mob to hover.
|
|
3464
3243
|
*/
|
|
3465
3244
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -3469,7 +3248,6 @@ export class EntityMovementHoverComponent extends EntityBaseMovementComponent {
|
|
|
3469
3248
|
}
|
|
3470
3249
|
|
|
3471
3250
|
/**
|
|
3472
|
-
* @beta
|
|
3473
3251
|
* Move control that causes the mob to jump as it moves with a
|
|
3474
3252
|
* specified delay between jumps.
|
|
3475
3253
|
*/
|
|
@@ -3480,7 +3258,6 @@ export class EntityMovementJumpComponent extends EntityBaseMovementComponent {
|
|
|
3480
3258
|
}
|
|
3481
3259
|
|
|
3482
3260
|
/**
|
|
3483
|
-
* @beta
|
|
3484
3261
|
* When added, this move control causes the mob to hop as it
|
|
3485
3262
|
* moves.
|
|
3486
3263
|
*/
|
|
@@ -3491,7 +3268,6 @@ export class EntityMovementSkipComponent extends EntityBaseMovementComponent {
|
|
|
3491
3268
|
}
|
|
3492
3269
|
|
|
3493
3270
|
/**
|
|
3494
|
-
* @beta
|
|
3495
3271
|
* Sets the distance through which the entity can push through.
|
|
3496
3272
|
*/
|
|
3497
3273
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -3509,7 +3285,6 @@ export class EntityPushThroughComponent extends EntityComponent {
|
|
|
3509
3285
|
}
|
|
3510
3286
|
|
|
3511
3287
|
/**
|
|
3512
|
-
* @beta
|
|
3513
3288
|
* Data for an event that happens when an entity is removed
|
|
3514
3289
|
* from the world (for example, the entity is unloaded because
|
|
3515
3290
|
* it is not close to players.)
|
|
@@ -3532,7 +3307,6 @@ export class EntityRemoveAfterEvent {
|
|
|
3532
3307
|
}
|
|
3533
3308
|
|
|
3534
3309
|
/**
|
|
3535
|
-
* @beta
|
|
3536
3310
|
* Allows registration for an event that fires when an entity
|
|
3537
3311
|
* is removed from the game (for example, unloaded, or a few
|
|
3538
3312
|
* seconds after they are dead.)
|
|
@@ -3571,7 +3345,6 @@ export class EntityRemoveAfterEventSignal {
|
|
|
3571
3345
|
}
|
|
3572
3346
|
|
|
3573
3347
|
/**
|
|
3574
|
-
* @beta
|
|
3575
3348
|
* Data for an event that happens when an entity is being
|
|
3576
3349
|
* removed from the world (for example, the entity is unloaded
|
|
3577
3350
|
* because it is not close to players.)
|
|
@@ -3587,7 +3360,6 @@ export class EntityRemoveBeforeEvent {
|
|
|
3587
3360
|
}
|
|
3588
3361
|
|
|
3589
3362
|
/**
|
|
3590
|
-
* @beta
|
|
3591
3363
|
* Allows registration for an event that fires when an entity
|
|
3592
3364
|
* is being removed from the game (for example, unloaded, or a
|
|
3593
3365
|
* few seconds after they are dead.)
|
|
@@ -3621,7 +3393,6 @@ export class EntityRemoveBeforeEventSignal {
|
|
|
3621
3393
|
}
|
|
3622
3394
|
|
|
3623
3395
|
/**
|
|
3624
|
-
* @beta
|
|
3625
3396
|
* Sets the entity's visual size.
|
|
3626
3397
|
*/
|
|
3627
3398
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -3639,7 +3410,6 @@ export class EntityScaleComponent extends EntityComponent {
|
|
|
3639
3410
|
}
|
|
3640
3411
|
|
|
3641
3412
|
/**
|
|
3642
|
-
* @beta
|
|
3643
3413
|
* Skin Id value. Can be used to differentiate skins, such as
|
|
3644
3414
|
* base skins for villagers.
|
|
3645
3415
|
*/
|
|
@@ -3658,7 +3428,6 @@ export class EntitySkinIdComponent extends EntityComponent {
|
|
|
3658
3428
|
}
|
|
3659
3429
|
|
|
3660
3430
|
/**
|
|
3661
|
-
* @beta
|
|
3662
3431
|
* Contains data related to an entity spawning within the
|
|
3663
3432
|
* world.
|
|
3664
3433
|
*/
|
|
@@ -3681,7 +3450,6 @@ export class EntitySpawnAfterEvent {
|
|
|
3681
3450
|
}
|
|
3682
3451
|
|
|
3683
3452
|
/**
|
|
3684
|
-
* @beta
|
|
3685
3453
|
* Registers a script-based event handler for handling what
|
|
3686
3454
|
* happens when an entity spawns.
|
|
3687
3455
|
*/
|
|
@@ -3729,7 +3497,6 @@ export class EntitySpawnAfterEventSignal {
|
|
|
3729
3497
|
}
|
|
3730
3498
|
|
|
3731
3499
|
/**
|
|
3732
|
-
* @beta
|
|
3733
3500
|
* Used to differentiate the component group of a variant of an
|
|
3734
3501
|
* entity from others. (e.g. ocelot, villager).
|
|
3735
3502
|
*/
|
|
@@ -3748,7 +3515,6 @@ export class EntityVariantComponent extends EntityComponent {
|
|
|
3748
3515
|
}
|
|
3749
3516
|
|
|
3750
3517
|
/**
|
|
3751
|
-
* @beta
|
|
3752
3518
|
* When added, this component signifies that this entity wants
|
|
3753
3519
|
* to become a jockey.
|
|
3754
3520
|
*/
|
|
@@ -3759,7 +3525,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
|
|
|
3759
3525
|
}
|
|
3760
3526
|
|
|
3761
3527
|
/**
|
|
3762
|
-
* @beta
|
|
3763
3528
|
* As part of the Healable component, represents a specific
|
|
3764
3529
|
* item that can be fed to an entity to cause health effects.
|
|
3765
3530
|
*/
|
|
@@ -3791,7 +3556,6 @@ export class FeedItem {
|
|
|
3791
3556
|
}
|
|
3792
3557
|
|
|
3793
3558
|
/**
|
|
3794
|
-
* @beta
|
|
3795
3559
|
* Represents an effect that is applied as a result of a food
|
|
3796
3560
|
* item being fed to an entity.
|
|
3797
3561
|
*/
|
|
@@ -3828,7 +3592,6 @@ export class FeedItemEffect {
|
|
|
3828
3592
|
}
|
|
3829
3593
|
|
|
3830
3594
|
/**
|
|
3831
|
-
* @beta
|
|
3832
3595
|
* Provides an adaptable interface for callers to subscribe to
|
|
3833
3596
|
* an event that fires when a button is pushed.
|
|
3834
3597
|
*/
|
|
@@ -3854,7 +3617,6 @@ export class IButtonPushAfterEventSignal {
|
|
|
3854
3617
|
}
|
|
3855
3618
|
|
|
3856
3619
|
/**
|
|
3857
|
-
* @beta
|
|
3858
3620
|
* Provides an adaptable interface for callers to subscribe to
|
|
3859
3621
|
* an event that fires after a lever is used.
|
|
3860
3622
|
*/
|
|
@@ -3880,7 +3642,6 @@ export class ILeverActionAfterEventSignal {
|
|
|
3880
3642
|
}
|
|
3881
3643
|
|
|
3882
3644
|
/**
|
|
3883
|
-
* @beta
|
|
3884
3645
|
* Provides an adaptable interface for callers to subscribe to
|
|
3885
3646
|
* an event that fires after a player joins a world.
|
|
3886
3647
|
*/
|
|
@@ -3906,7 +3667,6 @@ export class IPlayerJoinAfterEventSignal {
|
|
|
3906
3667
|
}
|
|
3907
3668
|
|
|
3908
3669
|
/**
|
|
3909
|
-
* @beta
|
|
3910
3670
|
* Provides an adaptable interface for callers to subscribe to
|
|
3911
3671
|
* an event that fires after a player leaves a world.
|
|
3912
3672
|
*/
|
|
@@ -3932,7 +3692,6 @@ export class IPlayerLeaveAfterEventSignal {
|
|
|
3932
3692
|
}
|
|
3933
3693
|
|
|
3934
3694
|
/**
|
|
3935
|
-
* @beta
|
|
3936
3695
|
* Provides an adaptable interface for callers to subscribe to
|
|
3937
3696
|
* an event that fires after a player spawns.
|
|
3938
3697
|
*/
|
|
@@ -3958,7 +3717,6 @@ export class IPlayerSpawnAfterEventSignal {
|
|
|
3958
3717
|
}
|
|
3959
3718
|
|
|
3960
3719
|
/**
|
|
3961
|
-
* @beta
|
|
3962
3720
|
* Contains information related to a chargeable item completing
|
|
3963
3721
|
* being charged.
|
|
3964
3722
|
*/
|
|
@@ -3986,7 +3744,6 @@ export class ItemCompleteUseAfterEvent {
|
|
|
3986
3744
|
}
|
|
3987
3745
|
|
|
3988
3746
|
/**
|
|
3989
|
-
* @beta
|
|
3990
3747
|
* Manages callbacks that are connected to the completion of
|
|
3991
3748
|
* charging for a chargeable item.
|
|
3992
3749
|
*/
|
|
@@ -4014,7 +3771,6 @@ export class ItemCompleteUseAfterEventSignal {
|
|
|
4014
3771
|
}
|
|
4015
3772
|
|
|
4016
3773
|
/**
|
|
4017
|
-
* @beta
|
|
4018
3774
|
* Base class for item components.
|
|
4019
3775
|
*/
|
|
4020
3776
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -4023,7 +3779,6 @@ export class ItemComponent extends Component {
|
|
|
4023
3779
|
}
|
|
4024
3780
|
|
|
4025
3781
|
/**
|
|
4026
|
-
* @beta
|
|
4027
3782
|
* Contains information related to a chargeable item when the
|
|
4028
3783
|
* player has finished using the item and released the build
|
|
4029
3784
|
* action.
|
|
@@ -4052,7 +3807,6 @@ export class ItemReleaseUseAfterEvent {
|
|
|
4052
3807
|
}
|
|
4053
3808
|
|
|
4054
3809
|
/**
|
|
4055
|
-
* @beta
|
|
4056
3810
|
* Manages callbacks that are connected to the releasing of
|
|
4057
3811
|
* charging for a chargeable item.
|
|
4058
3812
|
*/
|
|
@@ -4080,7 +3834,6 @@ export class ItemReleaseUseAfterEventSignal {
|
|
|
4080
3834
|
}
|
|
4081
3835
|
|
|
4082
3836
|
/**
|
|
4083
|
-
* @beta
|
|
4084
3837
|
* Defines a collection of items.
|
|
4085
3838
|
*/
|
|
4086
3839
|
export class ItemStack {
|
|
@@ -4175,7 +3928,6 @@ export class ItemStack {
|
|
|
4175
3928
|
*/
|
|
4176
3929
|
constructor(itemType: ItemType | string, amount?: number);
|
|
4177
3930
|
/**
|
|
4178
|
-
* @beta
|
|
4179
3931
|
* @remarks
|
|
4180
3932
|
* Creates an exact copy of the item stack, including any
|
|
4181
3933
|
* custom data or properties.
|
|
@@ -4185,7 +3937,6 @@ export class ItemStack {
|
|
|
4185
3937
|
*/
|
|
4186
3938
|
clone(): ItemStack;
|
|
4187
3939
|
/**
|
|
4188
|
-
* @beta
|
|
4189
3940
|
* @remarks
|
|
4190
3941
|
* Get the list of block types this item can break in Adventure
|
|
4191
3942
|
* mode.
|
|
@@ -4195,7 +3946,6 @@ export class ItemStack {
|
|
|
4195
3946
|
*/
|
|
4196
3947
|
getCanDestroy(): string[];
|
|
4197
3948
|
/**
|
|
4198
|
-
* @beta
|
|
4199
3949
|
* @remarks
|
|
4200
3950
|
* Get the list of block types this item can be placed on in
|
|
4201
3951
|
* Adventure mode.
|
|
@@ -4213,7 +3963,7 @@ export class ItemStack {
|
|
|
4213
3963
|
* The identifier of the component (e.g., 'minecraft:food'). If
|
|
4214
3964
|
* no namespace prefix is specified, 'minecraft:' is assumed.
|
|
4215
3965
|
* Available component IDs can be found as part of the {@link
|
|
4216
|
-
* ItemComponentTypes} enum.
|
|
3966
|
+
* @minecraft/server.ItemComponentTypes} enum.
|
|
4217
3967
|
* @returns
|
|
4218
3968
|
* Returns the component if it exists on the item stack,
|
|
4219
3969
|
* otherwise undefined.
|
|
@@ -4234,7 +3984,6 @@ export class ItemStack {
|
|
|
4234
3984
|
*/
|
|
4235
3985
|
getComponents(): ItemComponent[];
|
|
4236
3986
|
/**
|
|
4237
|
-
* @beta
|
|
4238
3987
|
* @remarks
|
|
4239
3988
|
* Returns the lore value - a secondary display string - for an
|
|
4240
3989
|
* ItemStack.
|
|
@@ -4245,7 +3994,6 @@ export class ItemStack {
|
|
|
4245
3994
|
*/
|
|
4246
3995
|
getLore(): string[];
|
|
4247
3996
|
/**
|
|
4248
|
-
* @beta
|
|
4249
3997
|
* @remarks
|
|
4250
3998
|
* Returns a set of tags associated with this item stack.
|
|
4251
3999
|
*
|
|
@@ -4263,7 +4011,6 @@ export class ItemStack {
|
|
|
4263
4011
|
*/
|
|
4264
4012
|
hasComponent(componentId: string): boolean;
|
|
4265
4013
|
/**
|
|
4266
|
-
* @beta
|
|
4267
4014
|
* @remarks
|
|
4268
4015
|
* Checks whether this item stack has a particular tag
|
|
4269
4016
|
* associated with it.
|
|
@@ -4291,7 +4038,6 @@ export class ItemStack {
|
|
|
4291
4038
|
*/
|
|
4292
4039
|
isStackableWith(itemStack: ItemStack): boolean;
|
|
4293
4040
|
/**
|
|
4294
|
-
* @beta
|
|
4295
4041
|
* @remarks
|
|
4296
4042
|
* The list of block types this item can break in Adventure
|
|
4297
4043
|
* mode. The block names are displayed in the item's tooltip.
|
|
@@ -4312,7 +4058,6 @@ export class ItemStack {
|
|
|
4312
4058
|
*/
|
|
4313
4059
|
setCanDestroy(blockIdentifiers?: string[]): void;
|
|
4314
4060
|
/**
|
|
4315
|
-
* @beta
|
|
4316
4061
|
* @remarks
|
|
4317
4062
|
* The list of block types this item can be placed on in
|
|
4318
4063
|
* Adventure mode. This is only applicable to block items. The
|
|
@@ -4334,7 +4079,6 @@ export class ItemStack {
|
|
|
4334
4079
|
*/
|
|
4335
4080
|
setCanPlaceOn(blockIdentifiers?: string[]): void;
|
|
4336
4081
|
/**
|
|
4337
|
-
* @beta
|
|
4338
4082
|
* @remarks
|
|
4339
4083
|
* Sets the lore value - a secondary display string - for an
|
|
4340
4084
|
* ItemStack. The lore list is cleared if set to an empty
|
|
@@ -4377,7 +4121,6 @@ export class ItemStack {
|
|
|
4377
4121
|
}
|
|
4378
4122
|
|
|
4379
4123
|
/**
|
|
4380
|
-
* @beta
|
|
4381
4124
|
* Contains information related to a chargeable item starting
|
|
4382
4125
|
* to be charged.
|
|
4383
4126
|
*/
|
|
@@ -4405,7 +4148,6 @@ export class ItemStartUseAfterEvent {
|
|
|
4405
4148
|
}
|
|
4406
4149
|
|
|
4407
4150
|
/**
|
|
4408
|
-
* @beta
|
|
4409
4151
|
* Manages callbacks that are connected to the start of
|
|
4410
4152
|
* charging for a chargeable item.
|
|
4411
4153
|
*/
|
|
@@ -4433,7 +4175,6 @@ export class ItemStartUseAfterEventSignal {
|
|
|
4433
4175
|
}
|
|
4434
4176
|
|
|
4435
4177
|
/**
|
|
4436
|
-
* @beta
|
|
4437
4178
|
* Contains information related to an item being used on a
|
|
4438
4179
|
* block. This event fires when a player presses the the Use
|
|
4439
4180
|
* Item / Place Block button to successfully use an item or
|
|
@@ -4457,7 +4198,9 @@ export class ItemStartUseOnAfterEvent {
|
|
|
4457
4198
|
readonly blockFace: Direction;
|
|
4458
4199
|
/**
|
|
4459
4200
|
* @remarks
|
|
4460
|
-
* The impacted item stack that is starting to be used.
|
|
4201
|
+
* The impacted item stack that is starting to be used. Can be
|
|
4202
|
+
* undefined in some gameplay scenarios like pushing a button
|
|
4203
|
+
* with an empty hand.
|
|
4461
4204
|
*
|
|
4462
4205
|
*/
|
|
4463
4206
|
readonly itemStack: ItemStack;
|
|
@@ -4470,7 +4213,6 @@ export class ItemStartUseOnAfterEvent {
|
|
|
4470
4213
|
}
|
|
4471
4214
|
|
|
4472
4215
|
/**
|
|
4473
|
-
* @beta
|
|
4474
4216
|
* Manages callbacks that are connected to an item starting
|
|
4475
4217
|
* being used on a block event.
|
|
4476
4218
|
*/
|
|
@@ -4498,7 +4240,6 @@ export class ItemStartUseOnAfterEventSignal {
|
|
|
4498
4240
|
}
|
|
4499
4241
|
|
|
4500
4242
|
/**
|
|
4501
|
-
* @beta
|
|
4502
4243
|
* Contains information related to a chargeable item has
|
|
4503
4244
|
* finished an items use cycle, or when the player has released
|
|
4504
4245
|
* the use action with the item.
|
|
@@ -4508,6 +4249,8 @@ export class ItemStopUseAfterEvent {
|
|
|
4508
4249
|
/**
|
|
4509
4250
|
* @remarks
|
|
4510
4251
|
* The impacted item stack that is stopping being charged.
|
|
4252
|
+
* ItemStopUseAfterEvent can be called when teleporting to a
|
|
4253
|
+
* different dimension and this can be undefined.
|
|
4511
4254
|
*
|
|
4512
4255
|
*/
|
|
4513
4256
|
readonly itemStack: ItemStack;
|
|
@@ -4527,7 +4270,6 @@ export class ItemStopUseAfterEvent {
|
|
|
4527
4270
|
}
|
|
4528
4271
|
|
|
4529
4272
|
/**
|
|
4530
|
-
* @beta
|
|
4531
4273
|
* Manages callbacks that are connected to the stopping of
|
|
4532
4274
|
* charging for an item that has a registered
|
|
4533
4275
|
* minecraft:chargeable component.
|
|
@@ -4556,7 +4298,6 @@ export class ItemStopUseAfterEventSignal {
|
|
|
4556
4298
|
}
|
|
4557
4299
|
|
|
4558
4300
|
/**
|
|
4559
|
-
* @beta
|
|
4560
4301
|
* Contains information related to an item that has stopped
|
|
4561
4302
|
* being used on a block. This event fires when a player
|
|
4562
4303
|
* successfully uses an item or places a block by pressing the
|
|
@@ -4588,7 +4329,6 @@ export class ItemStopUseOnAfterEvent {
|
|
|
4588
4329
|
}
|
|
4589
4330
|
|
|
4590
4331
|
/**
|
|
4591
|
-
* @beta
|
|
4592
4332
|
* Manages callbacks that are connected to an item stops used
|
|
4593
4333
|
* on a block event.
|
|
4594
4334
|
*/
|
|
@@ -4616,7 +4356,6 @@ export class ItemStopUseOnAfterEventSignal {
|
|
|
4616
4356
|
}
|
|
4617
4357
|
|
|
4618
4358
|
/**
|
|
4619
|
-
* @beta
|
|
4620
4359
|
* Represents the type of an item - for example, Wool.
|
|
4621
4360
|
*/
|
|
4622
4361
|
export class ItemType {
|
|
@@ -4631,7 +4370,6 @@ export class ItemType {
|
|
|
4631
4370
|
}
|
|
4632
4371
|
|
|
4633
4372
|
/**
|
|
4634
|
-
* @beta
|
|
4635
4373
|
* Contains information related to an item being used on a
|
|
4636
4374
|
* block. This event fires when an item used by a player
|
|
4637
4375
|
* successfully triggers an entity interaction.
|
|
@@ -4653,7 +4391,6 @@ export class ItemUseAfterEvent {
|
|
|
4653
4391
|
}
|
|
4654
4392
|
|
|
4655
4393
|
/**
|
|
4656
|
-
* @beta
|
|
4657
4394
|
* Manages callbacks that are connected to an item use event.
|
|
4658
4395
|
*/
|
|
4659
4396
|
export class ItemUseAfterEventSignal {
|
|
@@ -4678,7 +4415,6 @@ export class ItemUseAfterEventSignal {
|
|
|
4678
4415
|
}
|
|
4679
4416
|
|
|
4680
4417
|
/**
|
|
4681
|
-
* @beta
|
|
4682
4418
|
* Contains information related to an item being used.
|
|
4683
4419
|
*/
|
|
4684
4420
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -4693,7 +4429,6 @@ export class ItemUseBeforeEvent extends ItemUseAfterEvent {
|
|
|
4693
4429
|
}
|
|
4694
4430
|
|
|
4695
4431
|
/**
|
|
4696
|
-
* @beta
|
|
4697
4432
|
* Manages callbacks that fire before an item is used.
|
|
4698
4433
|
*/
|
|
4699
4434
|
export class ItemUseBeforeEventSignal {
|
|
@@ -4718,7 +4453,6 @@ export class ItemUseBeforeEventSignal {
|
|
|
4718
4453
|
}
|
|
4719
4454
|
|
|
4720
4455
|
/**
|
|
4721
|
-
* @beta
|
|
4722
4456
|
* Contains information related to an item being used on a
|
|
4723
4457
|
* block. This event fires when an item used by a player
|
|
4724
4458
|
* successfully triggers a block interaction.
|
|
@@ -4759,7 +4493,6 @@ export class ItemUseOnAfterEvent {
|
|
|
4759
4493
|
}
|
|
4760
4494
|
|
|
4761
4495
|
/**
|
|
4762
|
-
* @beta
|
|
4763
4496
|
* Manages callbacks that are connected to an item being used
|
|
4764
4497
|
* on a block event.
|
|
4765
4498
|
*/
|
|
@@ -4787,7 +4520,6 @@ export class ItemUseOnAfterEventSignal {
|
|
|
4787
4520
|
}
|
|
4788
4521
|
|
|
4789
4522
|
/**
|
|
4790
|
-
* @beta
|
|
4791
4523
|
* Contains information related to an item being used on a
|
|
4792
4524
|
* block.
|
|
4793
4525
|
*/
|
|
@@ -4803,7 +4535,6 @@ export class ItemUseOnBeforeEvent extends ItemUseOnAfterEvent {
|
|
|
4803
4535
|
}
|
|
4804
4536
|
|
|
4805
4537
|
/**
|
|
4806
|
-
* @beta
|
|
4807
4538
|
* Manages callbacks that fire before an item being used on a
|
|
4808
4539
|
* block event.
|
|
4809
4540
|
*/
|
|
@@ -4831,7 +4562,6 @@ export class ItemUseOnBeforeEventSignal {
|
|
|
4831
4562
|
}
|
|
4832
4563
|
|
|
4833
4564
|
/**
|
|
4834
|
-
* @beta
|
|
4835
4565
|
* Contains information related to changes to a lever
|
|
4836
4566
|
* activating or deactivating.
|
|
4837
4567
|
*/
|
|
@@ -4854,7 +4584,6 @@ export class LeverActionAfterEvent extends BlockEvent {
|
|
|
4854
4584
|
}
|
|
4855
4585
|
|
|
4856
4586
|
/**
|
|
4857
|
-
* @beta
|
|
4858
4587
|
* Manages callbacks that are connected to lever moves
|
|
4859
4588
|
* (activates or deactivates).
|
|
4860
4589
|
*/
|
|
@@ -4906,7 +4635,6 @@ export class MinecraftDimensionTypes {
|
|
|
4906
4635
|
}
|
|
4907
4636
|
|
|
4908
4637
|
/**
|
|
4909
|
-
* @beta
|
|
4910
4638
|
* Contains a set of additional variable values for further
|
|
4911
4639
|
* defining how rendering and animations function.
|
|
4912
4640
|
*/
|
|
@@ -4981,7 +4709,6 @@ export class MolangVariableMap {
|
|
|
4981
4709
|
export class Player extends Entity {
|
|
4982
4710
|
private constructor();
|
|
4983
4711
|
/**
|
|
4984
|
-
* @beta
|
|
4985
4712
|
* @remarks
|
|
4986
4713
|
* The player's Camera.
|
|
4987
4714
|
*
|
|
@@ -4989,7 +4716,6 @@ export class Player extends Entity {
|
|
|
4989
4716
|
*/
|
|
4990
4717
|
readonly camera: Camera;
|
|
4991
4718
|
/**
|
|
4992
|
-
* @beta
|
|
4993
4719
|
* @remarks
|
|
4994
4720
|
* If true, the player is currently emoting.
|
|
4995
4721
|
*
|
|
@@ -4997,7 +4723,6 @@ export class Player extends Entity {
|
|
|
4997
4723
|
*/
|
|
4998
4724
|
readonly isEmoting: boolean;
|
|
4999
4725
|
/**
|
|
5000
|
-
* @beta
|
|
5001
4726
|
* @remarks
|
|
5002
4727
|
* Whether the player is flying. For example, in Creative or
|
|
5003
4728
|
* Spectator mode.
|
|
@@ -5006,7 +4731,6 @@ export class Player extends Entity {
|
|
|
5006
4731
|
*/
|
|
5007
4732
|
readonly isFlying: boolean;
|
|
5008
4733
|
/**
|
|
5009
|
-
* @beta
|
|
5010
4734
|
* @remarks
|
|
5011
4735
|
* Whether the player is gliding with Elytra.
|
|
5012
4736
|
*
|
|
@@ -5014,7 +4738,6 @@ export class Player extends Entity {
|
|
|
5014
4738
|
*/
|
|
5015
4739
|
readonly isGliding: boolean;
|
|
5016
4740
|
/**
|
|
5017
|
-
* @beta
|
|
5018
4741
|
* @remarks
|
|
5019
4742
|
* Whether the player is jumping. This will remain true while
|
|
5020
4743
|
* the player is holding the jump action.
|
|
@@ -5023,7 +4746,6 @@ export class Player extends Entity {
|
|
|
5023
4746
|
*/
|
|
5024
4747
|
readonly isJumping: boolean;
|
|
5025
4748
|
/**
|
|
5026
|
-
* @beta
|
|
5027
4749
|
* @remarks
|
|
5028
4750
|
* The current overall level for the player, based on their
|
|
5029
4751
|
* experience.
|
|
@@ -5039,7 +4761,6 @@ export class Player extends Entity {
|
|
|
5039
4761
|
*/
|
|
5040
4762
|
readonly name: string;
|
|
5041
4763
|
/**
|
|
5042
|
-
* @beta
|
|
5043
4764
|
* @remarks
|
|
5044
4765
|
* Contains methods for manipulating the on-screen display of a
|
|
5045
4766
|
* Player.
|
|
@@ -5048,7 +4769,6 @@ export class Player extends Entity {
|
|
|
5048
4769
|
*/
|
|
5049
4770
|
readonly onScreenDisplay: ScreenDisplay;
|
|
5050
4771
|
/**
|
|
5051
|
-
* @beta
|
|
5052
4772
|
* @remarks
|
|
5053
4773
|
* The overall total set of experience needed to achieve the
|
|
5054
4774
|
* next level for a player.
|
|
@@ -5057,7 +4777,6 @@ export class Player extends Entity {
|
|
|
5057
4777
|
*/
|
|
5058
4778
|
readonly totalXpNeededForNextLevel: number;
|
|
5059
4779
|
/**
|
|
5060
|
-
* @beta
|
|
5061
4780
|
* @remarks
|
|
5062
4781
|
* The current set of experience achieved for the player.
|
|
5063
4782
|
*
|
|
@@ -5065,7 +4784,6 @@ export class Player extends Entity {
|
|
|
5065
4784
|
*/
|
|
5066
4785
|
readonly xpEarnedAtCurrentLevel: number;
|
|
5067
4786
|
/**
|
|
5068
|
-
* @beta
|
|
5069
4787
|
* @remarks
|
|
5070
4788
|
* Adds/removes experience to/from the Player and returns the
|
|
5071
4789
|
* current experience of the Player.
|
|
@@ -5081,7 +4799,6 @@ export class Player extends Entity {
|
|
|
5081
4799
|
*/
|
|
5082
4800
|
addExperience(amount: number): number;
|
|
5083
4801
|
/**
|
|
5084
|
-
* @beta
|
|
5085
4802
|
* @remarks
|
|
5086
4803
|
* Adds/removes level to/from the Player and returns the
|
|
5087
4804
|
* current level of the Player.
|
|
@@ -5096,7 +4813,6 @@ export class Player extends Entity {
|
|
|
5096
4813
|
*/
|
|
5097
4814
|
addLevels(amount: number): number;
|
|
5098
4815
|
/**
|
|
5099
|
-
* @beta
|
|
5100
4816
|
* @remarks
|
|
5101
4817
|
* Gets the current spawn point of the player.
|
|
5102
4818
|
*
|
|
@@ -5104,7 +4820,6 @@ export class Player extends Entity {
|
|
|
5104
4820
|
*/
|
|
5105
4821
|
getSpawnPoint(): DimensionLocation | undefined;
|
|
5106
4822
|
/**
|
|
5107
|
-
* @beta
|
|
5108
4823
|
* @remarks
|
|
5109
4824
|
* Gets the total experience of the Player.
|
|
5110
4825
|
*
|
|
@@ -5112,7 +4827,6 @@ export class Player extends Entity {
|
|
|
5112
4827
|
*/
|
|
5113
4828
|
getTotalXp(): number;
|
|
5114
4829
|
/**
|
|
5115
|
-
* @beta
|
|
5116
4830
|
* @remarks
|
|
5117
4831
|
* Plays a sound that only this particular player can hear.
|
|
5118
4832
|
*
|
|
@@ -5148,7 +4862,6 @@ export class Player extends Entity {
|
|
|
5148
4862
|
*/
|
|
5149
4863
|
playSound(soundId: string, soundOptions?: PlayerSoundOptions): void;
|
|
5150
4864
|
/**
|
|
5151
|
-
* @beta
|
|
5152
4865
|
* @remarks
|
|
5153
4866
|
* Resets the level of the player.
|
|
5154
4867
|
*
|
|
@@ -5158,7 +4871,6 @@ export class Player extends Entity {
|
|
|
5158
4871
|
*/
|
|
5159
4872
|
resetLevel(): void;
|
|
5160
4873
|
/**
|
|
5161
|
-
* @beta
|
|
5162
4874
|
* @remarks
|
|
5163
4875
|
* Sends a message to the player.
|
|
5164
4876
|
*
|
|
@@ -5209,7 +4921,6 @@ export class Player extends Entity {
|
|
|
5209
4921
|
*/
|
|
5210
4922
|
sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
|
|
5211
4923
|
/**
|
|
5212
|
-
* @beta
|
|
5213
4924
|
* @remarks
|
|
5214
4925
|
* Sets the current starting spawn point for this particular
|
|
5215
4926
|
* player.
|
|
@@ -5226,7 +4937,6 @@ export class Player extends Entity {
|
|
|
5226
4937
|
}
|
|
5227
4938
|
|
|
5228
4939
|
/**
|
|
5229
|
-
* @beta
|
|
5230
4940
|
* Contains information regarding an event after a player
|
|
5231
4941
|
* breaks a block.
|
|
5232
4942
|
*/
|
|
@@ -5263,7 +4973,6 @@ export class PlayerBreakBlockAfterEvent extends BlockEvent {
|
|
|
5263
4973
|
}
|
|
5264
4974
|
|
|
5265
4975
|
/**
|
|
5266
|
-
* @beta
|
|
5267
4976
|
* Manages callbacks that are connected to when a player breaks
|
|
5268
4977
|
* a block.
|
|
5269
4978
|
*/
|
|
@@ -5294,7 +5003,6 @@ export class PlayerBreakBlockAfterEventSignal {
|
|
|
5294
5003
|
}
|
|
5295
5004
|
|
|
5296
5005
|
/**
|
|
5297
|
-
* @beta
|
|
5298
5006
|
* Contains information regarding an event before a player
|
|
5299
5007
|
* breaks a block.
|
|
5300
5008
|
*/
|
|
@@ -5323,7 +5031,6 @@ export class PlayerBreakBlockBeforeEvent extends BlockEvent {
|
|
|
5323
5031
|
}
|
|
5324
5032
|
|
|
5325
5033
|
/**
|
|
5326
|
-
* @beta
|
|
5327
5034
|
* Manages callbacks that are connected to before a player
|
|
5328
5035
|
* breaks a block.
|
|
5329
5036
|
*/
|
|
@@ -5354,7 +5061,6 @@ export class PlayerBreakBlockBeforeEventSignal {
|
|
|
5354
5061
|
}
|
|
5355
5062
|
|
|
5356
5063
|
/**
|
|
5357
|
-
* @beta
|
|
5358
5064
|
* Contains information related to changes to a player's
|
|
5359
5065
|
* dimension having been changed.
|
|
5360
5066
|
*/
|
|
@@ -5394,7 +5100,6 @@ export class PlayerDimensionChangeAfterEvent {
|
|
|
5394
5100
|
}
|
|
5395
5101
|
|
|
5396
5102
|
/**
|
|
5397
|
-
* @beta
|
|
5398
5103
|
* Manages callbacks that are connected to successful player
|
|
5399
5104
|
* dimension changes.
|
|
5400
5105
|
*/
|
|
@@ -5422,7 +5127,6 @@ export class PlayerDimensionChangeAfterEventSignal {
|
|
|
5422
5127
|
}
|
|
5423
5128
|
|
|
5424
5129
|
/**
|
|
5425
|
-
* @beta
|
|
5426
5130
|
* Contains information regarding a player that has joined.
|
|
5427
5131
|
* See the playerSpawn event for more detailed information that
|
|
5428
5132
|
* could be returned after the first time a player has spawned
|
|
@@ -5445,7 +5149,6 @@ export class PlayerJoinAfterEvent {
|
|
|
5445
5149
|
}
|
|
5446
5150
|
|
|
5447
5151
|
/**
|
|
5448
|
-
* @beta
|
|
5449
5152
|
* Manages callbacks that are connected to a player joining the
|
|
5450
5153
|
* world.
|
|
5451
5154
|
*/
|
|
@@ -5455,7 +5158,6 @@ export class PlayerJoinAfterEventSignal extends IPlayerJoinAfterEventSignal {
|
|
|
5455
5158
|
}
|
|
5456
5159
|
|
|
5457
5160
|
/**
|
|
5458
|
-
* @beta
|
|
5459
5161
|
* Contains information regarding a player that has left the
|
|
5460
5162
|
* world.
|
|
5461
5163
|
*/
|
|
@@ -5477,7 +5179,6 @@ export class PlayerLeaveAfterEvent {
|
|
|
5477
5179
|
}
|
|
5478
5180
|
|
|
5479
5181
|
/**
|
|
5480
|
-
* @beta
|
|
5481
5182
|
* Manages callbacks that are connected to a player leaving the
|
|
5482
5183
|
* world.
|
|
5483
5184
|
*/
|
|
@@ -5487,7 +5188,6 @@ export class PlayerLeaveAfterEventSignal extends IPlayerLeaveAfterEventSignal {
|
|
|
5487
5188
|
}
|
|
5488
5189
|
|
|
5489
5190
|
/**
|
|
5490
|
-
* @beta
|
|
5491
5191
|
* Contains information regarding an event where a player
|
|
5492
5192
|
* places a block.
|
|
5493
5193
|
*/
|
|
@@ -5503,7 +5203,6 @@ export class PlayerPlaceBlockAfterEvent extends BlockEvent {
|
|
|
5503
5203
|
}
|
|
5504
5204
|
|
|
5505
5205
|
/**
|
|
5506
|
-
* @beta
|
|
5507
5206
|
* Manages callbacks that are connected to when a block is
|
|
5508
5207
|
* placed by a player.
|
|
5509
5208
|
*/
|
|
@@ -5534,7 +5233,6 @@ export class PlayerPlaceBlockAfterEventSignal {
|
|
|
5534
5233
|
}
|
|
5535
5234
|
|
|
5536
5235
|
/**
|
|
5537
|
-
* @beta
|
|
5538
5236
|
* An event that contains more information about a player
|
|
5539
5237
|
* spawning.
|
|
5540
5238
|
*/
|
|
@@ -5560,7 +5258,6 @@ export class PlayerSpawnAfterEvent {
|
|
|
5560
5258
|
}
|
|
5561
5259
|
|
|
5562
5260
|
/**
|
|
5563
|
-
* @beta
|
|
5564
5261
|
* Registers an event when a player is spawned (or re-spawned
|
|
5565
5262
|
* after death) and fully ready within the world.
|
|
5566
5263
|
*/
|
|
@@ -5570,7 +5267,6 @@ export class PlayerSpawnAfterEventSignal extends IPlayerSpawnAfterEventSignal {
|
|
|
5570
5267
|
}
|
|
5571
5268
|
|
|
5572
5269
|
/**
|
|
5573
|
-
* @beta
|
|
5574
5270
|
* Contains information related to changes to a pressure plate
|
|
5575
5271
|
* pop.
|
|
5576
5272
|
*/
|
|
@@ -5594,7 +5290,6 @@ export class PressurePlatePopAfterEvent extends BlockEvent {
|
|
|
5594
5290
|
}
|
|
5595
5291
|
|
|
5596
5292
|
/**
|
|
5597
|
-
* @beta
|
|
5598
5293
|
* Manages callbacks that are connected to when a pressure
|
|
5599
5294
|
* plate is popped.
|
|
5600
5295
|
*/
|
|
@@ -5622,7 +5317,6 @@ export class PressurePlatePopAfterEventSignal {
|
|
|
5622
5317
|
}
|
|
5623
5318
|
|
|
5624
5319
|
/**
|
|
5625
|
-
* @beta
|
|
5626
5320
|
* Contains information related to changes to a pressure plate
|
|
5627
5321
|
* push.
|
|
5628
5322
|
*/
|
|
@@ -5652,7 +5346,6 @@ export class PressurePlatePushAfterEvent extends BlockEvent {
|
|
|
5652
5346
|
}
|
|
5653
5347
|
|
|
5654
5348
|
/**
|
|
5655
|
-
* @beta
|
|
5656
5349
|
* Manages callbacks that are connected to when a pressure
|
|
5657
5350
|
* plate is pushed.
|
|
5658
5351
|
*/
|
|
@@ -5680,7 +5373,6 @@ export class PressurePlatePushAfterEventSignal {
|
|
|
5680
5373
|
}
|
|
5681
5374
|
|
|
5682
5375
|
/**
|
|
5683
|
-
* @beta
|
|
5684
5376
|
* Contains information related to a projectile hitting a
|
|
5685
5377
|
* block.
|
|
5686
5378
|
*/
|
|
@@ -5728,7 +5420,6 @@ export class ProjectileHitBlockAfterEvent {
|
|
|
5728
5420
|
}
|
|
5729
5421
|
|
|
5730
5422
|
/**
|
|
5731
|
-
* @beta
|
|
5732
5423
|
* Manages callbacks that are connected to when a projectile
|
|
5733
5424
|
* hits a block.
|
|
5734
5425
|
*/
|
|
@@ -5756,7 +5447,6 @@ export class ProjectileHitBlockAfterEventSignal {
|
|
|
5756
5447
|
}
|
|
5757
5448
|
|
|
5758
5449
|
/**
|
|
5759
|
-
* @beta
|
|
5760
5450
|
* Contains information related to a projectile hitting an
|
|
5761
5451
|
* entity.
|
|
5762
5452
|
*/
|
|
@@ -5804,7 +5494,6 @@ export class ProjectileHitEntityAfterEvent {
|
|
|
5804
5494
|
}
|
|
5805
5495
|
|
|
5806
5496
|
/**
|
|
5807
|
-
* @beta
|
|
5808
5497
|
* Manages callbacks that are connected to when a projectile
|
|
5809
5498
|
* hits an entity.
|
|
5810
5499
|
*/
|
|
@@ -5832,7 +5521,6 @@ export class ProjectileHitEntityAfterEventSignal {
|
|
|
5832
5521
|
}
|
|
5833
5522
|
|
|
5834
5523
|
/**
|
|
5835
|
-
* @beta
|
|
5836
5524
|
* Contains objectives and participants for the scoreboard.
|
|
5837
5525
|
*/
|
|
5838
5526
|
export class Scoreboard {
|
|
@@ -5910,7 +5598,6 @@ export class Scoreboard {
|
|
|
5910
5598
|
}
|
|
5911
5599
|
|
|
5912
5600
|
/**
|
|
5913
|
-
* @beta
|
|
5914
5601
|
* Contains an identity of the scoreboard item.
|
|
5915
5602
|
*/
|
|
5916
5603
|
export class ScoreboardIdentity {
|
|
@@ -5951,7 +5638,6 @@ export class ScoreboardIdentity {
|
|
|
5951
5638
|
}
|
|
5952
5639
|
|
|
5953
5640
|
/**
|
|
5954
|
-
* @beta
|
|
5955
5641
|
* Contains objectives and participants for the scoreboard.
|
|
5956
5642
|
*/
|
|
5957
5643
|
export class ScoreboardObjective {
|
|
@@ -6049,7 +5735,6 @@ export class ScoreboardObjective {
|
|
|
6049
5735
|
}
|
|
6050
5736
|
|
|
6051
5737
|
/**
|
|
6052
|
-
* @beta
|
|
6053
5738
|
* Contains a pair of a scoreboard participant and its
|
|
6054
5739
|
* respective score.
|
|
6055
5740
|
*/
|
|
@@ -6070,7 +5755,6 @@ export class ScoreboardScoreInfo {
|
|
|
6070
5755
|
}
|
|
6071
5756
|
|
|
6072
5757
|
/**
|
|
6073
|
-
* @beta
|
|
6074
5758
|
* Contains information about user interface elements that are
|
|
6075
5759
|
* showing up on the screen.
|
|
6076
5760
|
*/
|
|
@@ -6159,7 +5843,6 @@ export class ScreenDisplay {
|
|
|
6159
5843
|
}
|
|
6160
5844
|
|
|
6161
5845
|
/**
|
|
6162
|
-
* @beta
|
|
6163
5846
|
* Returns additional data about a /scriptevent command
|
|
6164
5847
|
* invocation.
|
|
6165
5848
|
*/
|
|
@@ -6208,7 +5891,6 @@ export class ScriptEventCommandMessageAfterEvent {
|
|
|
6208
5891
|
}
|
|
6209
5892
|
|
|
6210
5893
|
/**
|
|
6211
|
-
* @beta
|
|
6212
5894
|
* Allows for registering an event handler that responds to
|
|
6213
5895
|
* inbound /scriptevent commands.
|
|
6214
5896
|
*/
|
|
@@ -6242,7 +5924,6 @@ export class ScriptEventCommandMessageAfterEventSignal {
|
|
|
6242
5924
|
export class System {
|
|
6243
5925
|
private constructor();
|
|
6244
5926
|
/**
|
|
6245
|
-
* @beta
|
|
6246
5927
|
* @remarks
|
|
6247
5928
|
* Returns a collection of after-events for system-level
|
|
6248
5929
|
* operations.
|
|
@@ -6250,14 +5931,12 @@ export class System {
|
|
|
6250
5931
|
*/
|
|
6251
5932
|
readonly afterEvents: SystemAfterEvents;
|
|
6252
5933
|
/**
|
|
6253
|
-
* @beta
|
|
6254
5934
|
* @remarks
|
|
6255
5935
|
* Represents the current world tick of the server.
|
|
6256
5936
|
*
|
|
6257
5937
|
*/
|
|
6258
5938
|
readonly currentTick: number;
|
|
6259
5939
|
/**
|
|
6260
|
-
* @beta
|
|
6261
5940
|
* @remarks
|
|
6262
5941
|
* Cancels the execution of a function run that was previously
|
|
6263
5942
|
* scheduled via the `run` function.
|
|
@@ -6294,7 +5973,6 @@ export class System {
|
|
|
6294
5973
|
*/
|
|
6295
5974
|
run(callback: () => void): number;
|
|
6296
5975
|
/**
|
|
6297
|
-
* @beta
|
|
6298
5976
|
* @remarks
|
|
6299
5977
|
* Runs a set of code on an interval.
|
|
6300
5978
|
*
|
|
@@ -6317,7 +5995,6 @@ export class System {
|
|
|
6317
5995
|
*/
|
|
6318
5996
|
runInterval(callback: () => void, tickInterval?: number): number;
|
|
6319
5997
|
/**
|
|
6320
|
-
* @beta
|
|
6321
5998
|
* @remarks
|
|
6322
5999
|
* Runs a set of code at a future time specified by tickDelay.
|
|
6323
6000
|
*
|
|
@@ -6334,7 +6011,6 @@ export class System {
|
|
|
6334
6011
|
}
|
|
6335
6012
|
|
|
6336
6013
|
/**
|
|
6337
|
-
* @beta
|
|
6338
6014
|
* Provides a set of events that fire within the broader
|
|
6339
6015
|
* scripting system within Minecraft.
|
|
6340
6016
|
*/
|
|
@@ -6351,7 +6027,6 @@ export class SystemAfterEvents {
|
|
|
6351
6027
|
}
|
|
6352
6028
|
|
|
6353
6029
|
/**
|
|
6354
|
-
* @beta
|
|
6355
6030
|
* Contains information related to changes to a target block
|
|
6356
6031
|
* hit.
|
|
6357
6032
|
*/
|
|
@@ -6385,7 +6060,6 @@ export class TargetBlockHitAfterEvent extends BlockEvent {
|
|
|
6385
6060
|
}
|
|
6386
6061
|
|
|
6387
6062
|
/**
|
|
6388
|
-
* @beta
|
|
6389
6063
|
* Manages callbacks that are connected to when a target block
|
|
6390
6064
|
* is hit.
|
|
6391
6065
|
*/
|
|
@@ -6413,7 +6087,6 @@ export class TargetBlockHitAfterEventSignal {
|
|
|
6413
6087
|
}
|
|
6414
6088
|
|
|
6415
6089
|
/**
|
|
6416
|
-
* @beta
|
|
6417
6090
|
* Contains information related to changes to a trip wire trip.
|
|
6418
6091
|
*/
|
|
6419
6092
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6434,7 +6107,6 @@ export class TripWireTripAfterEvent extends BlockEvent {
|
|
|
6434
6107
|
}
|
|
6435
6108
|
|
|
6436
6109
|
/**
|
|
6437
|
-
* @beta
|
|
6438
6110
|
* Manages callbacks that are connected to when a trip wire is
|
|
6439
6111
|
* tripped.
|
|
6440
6112
|
*/
|
|
@@ -6468,7 +6140,6 @@ export class TripWireTripAfterEventSignal {
|
|
|
6468
6140
|
export class World {
|
|
6469
6141
|
private constructor();
|
|
6470
6142
|
/**
|
|
6471
|
-
* @beta
|
|
6472
6143
|
* @remarks
|
|
6473
6144
|
* Contains a set of events that are applicable to the entirety
|
|
6474
6145
|
* of the world. Event callbacks are called in a deferred
|
|
@@ -6477,7 +6148,6 @@ export class World {
|
|
|
6477
6148
|
*/
|
|
6478
6149
|
readonly afterEvents: WorldAfterEvents;
|
|
6479
6150
|
/**
|
|
6480
|
-
* @beta
|
|
6481
6151
|
* @remarks
|
|
6482
6152
|
* Contains a set of events that are applicable to the entirety
|
|
6483
6153
|
* of the world. Event callbacks are called immediately. Event
|
|
@@ -6486,7 +6156,6 @@ export class World {
|
|
|
6486
6156
|
*/
|
|
6487
6157
|
readonly beforeEvents: WorldBeforeEvents;
|
|
6488
6158
|
/**
|
|
6489
|
-
* @beta
|
|
6490
6159
|
* @remarks
|
|
6491
6160
|
* Returns the general global scoreboard that applies to the
|
|
6492
6161
|
* world.
|
|
@@ -6494,7 +6163,6 @@ export class World {
|
|
|
6494
6163
|
*/
|
|
6495
6164
|
readonly scoreboard: Scoreboard;
|
|
6496
6165
|
/**
|
|
6497
|
-
* @beta
|
|
6498
6166
|
* @remarks
|
|
6499
6167
|
* Returns the absolute time since the start of the world.
|
|
6500
6168
|
*
|
|
@@ -6508,7 +6176,6 @@ export class World {
|
|
|
6508
6176
|
*/
|
|
6509
6177
|
getAllPlayers(): Player[];
|
|
6510
6178
|
/**
|
|
6511
|
-
* @beta
|
|
6512
6179
|
* @remarks
|
|
6513
6180
|
* Returns the current day.
|
|
6514
6181
|
*
|
|
@@ -6518,7 +6185,6 @@ export class World {
|
|
|
6518
6185
|
*/
|
|
6519
6186
|
getDay(): number;
|
|
6520
6187
|
/**
|
|
6521
|
-
* @beta
|
|
6522
6188
|
* @remarks
|
|
6523
6189
|
* Returns the default Overworld spawn location.
|
|
6524
6190
|
*
|
|
@@ -6542,14 +6208,12 @@ export class World {
|
|
|
6542
6208
|
*/
|
|
6543
6209
|
getDimension(dimensionId: string): Dimension;
|
|
6544
6210
|
/**
|
|
6545
|
-
* @beta
|
|
6546
6211
|
* @remarks
|
|
6547
6212
|
* Returns the MoonPhase for the current time.
|
|
6548
6213
|
*
|
|
6549
6214
|
*/
|
|
6550
6215
|
getMoonPhase(): MoonPhase;
|
|
6551
6216
|
/**
|
|
6552
|
-
* @beta
|
|
6553
6217
|
* @remarks
|
|
6554
6218
|
* Returns a set of players based on a set of conditions
|
|
6555
6219
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -6564,7 +6228,6 @@ export class World {
|
|
|
6564
6228
|
*/
|
|
6565
6229
|
getPlayers(options?: EntityQueryOptions): Player[];
|
|
6566
6230
|
/**
|
|
6567
|
-
* @beta
|
|
6568
6231
|
* @remarks
|
|
6569
6232
|
* Returns the time of day.
|
|
6570
6233
|
*
|
|
@@ -6573,7 +6236,6 @@ export class World {
|
|
|
6573
6236
|
*/
|
|
6574
6237
|
getTimeOfDay(): number;
|
|
6575
6238
|
/**
|
|
6576
|
-
* @beta
|
|
6577
6239
|
* @remarks
|
|
6578
6240
|
* Plays a particular music track for all players.
|
|
6579
6241
|
*
|
|
@@ -6607,7 +6269,6 @@ export class World {
|
|
|
6607
6269
|
*/
|
|
6608
6270
|
playMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
6609
6271
|
/**
|
|
6610
|
-
* @beta
|
|
6611
6272
|
* @remarks
|
|
6612
6273
|
* Plays a sound for all players.
|
|
6613
6274
|
*
|
|
@@ -6645,7 +6306,6 @@ export class World {
|
|
|
6645
6306
|
*/
|
|
6646
6307
|
playSound(soundId: string, location: Vector3, soundOptions?: WorldSoundOptions): void;
|
|
6647
6308
|
/**
|
|
6648
|
-
* @beta
|
|
6649
6309
|
* @remarks
|
|
6650
6310
|
* Queues an additional music track for players. If a track is
|
|
6651
6311
|
* not playing, a music track will play.
|
|
@@ -6663,7 +6323,6 @@ export class World {
|
|
|
6663
6323
|
*/
|
|
6664
6324
|
queueMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
6665
6325
|
/**
|
|
6666
|
-
* @beta
|
|
6667
6326
|
* @remarks
|
|
6668
6327
|
* Sends a message to all players.
|
|
6669
6328
|
*
|
|
@@ -6702,7 +6361,6 @@ export class World {
|
|
|
6702
6361
|
*/
|
|
6703
6362
|
sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
|
|
6704
6363
|
/**
|
|
6705
|
-
* @beta
|
|
6706
6364
|
* @remarks
|
|
6707
6365
|
* Sets the world time.
|
|
6708
6366
|
*
|
|
@@ -6713,7 +6371,6 @@ export class World {
|
|
|
6713
6371
|
*/
|
|
6714
6372
|
setAbsoluteTime(absoluteTime: number): void;
|
|
6715
6373
|
/**
|
|
6716
|
-
* @beta
|
|
6717
6374
|
* @remarks
|
|
6718
6375
|
* Sets a default spawn location for all players.
|
|
6719
6376
|
*
|
|
@@ -6731,7 +6388,6 @@ export class World {
|
|
|
6731
6388
|
*/
|
|
6732
6389
|
setDefaultSpawnLocation(spawnLocation: Vector3): void;
|
|
6733
6390
|
/**
|
|
6734
|
-
* @beta
|
|
6735
6391
|
* @remarks
|
|
6736
6392
|
* Sets the time of day.
|
|
6737
6393
|
*
|
|
@@ -6745,7 +6401,6 @@ export class World {
|
|
|
6745
6401
|
*/
|
|
6746
6402
|
setTimeOfDay(timeOfDay: number | TimeOfDay): void;
|
|
6747
6403
|
/**
|
|
6748
|
-
* @beta
|
|
6749
6404
|
* @remarks
|
|
6750
6405
|
* Stops any music tracks from playing.
|
|
6751
6406
|
*
|
|
@@ -6756,7 +6411,6 @@ export class World {
|
|
|
6756
6411
|
}
|
|
6757
6412
|
|
|
6758
6413
|
/**
|
|
6759
|
-
* @beta
|
|
6760
6414
|
* Contains a set of events that are available across the scope
|
|
6761
6415
|
* of the World.
|
|
6762
6416
|
*/
|
|
@@ -6769,21 +6423,18 @@ export class WorldAfterEvents {
|
|
|
6769
6423
|
*/
|
|
6770
6424
|
readonly buttonPush: ButtonPushAfterEventSignal;
|
|
6771
6425
|
/**
|
|
6772
|
-
* @beta
|
|
6773
6426
|
* @remarks
|
|
6774
6427
|
* This event fires when an entity dies.
|
|
6775
6428
|
*
|
|
6776
6429
|
*/
|
|
6777
6430
|
readonly entityDie: EntityDieAfterEventSignal;
|
|
6778
6431
|
/**
|
|
6779
|
-
* @beta
|
|
6780
6432
|
* @remarks
|
|
6781
6433
|
* This event fires when entity health changes in any degree.
|
|
6782
6434
|
*
|
|
6783
6435
|
*/
|
|
6784
6436
|
readonly entityHealthChanged: EntityHealthChangedAfterEventSignal;
|
|
6785
6437
|
/**
|
|
6786
|
-
* @beta
|
|
6787
6438
|
* @remarks
|
|
6788
6439
|
* This event fires when an entity hits (that is, melee
|
|
6789
6440
|
* attacks) a block.
|
|
@@ -6791,7 +6442,6 @@ export class WorldAfterEvents {
|
|
|
6791
6442
|
*/
|
|
6792
6443
|
readonly entityHitBlock: EntityHitBlockAfterEventSignal;
|
|
6793
6444
|
/**
|
|
6794
|
-
* @beta
|
|
6795
6445
|
* @remarks
|
|
6796
6446
|
* This event fires when an entity hits (that is, melee
|
|
6797
6447
|
* attacks) another entity.
|
|
@@ -6799,21 +6449,18 @@ export class WorldAfterEvents {
|
|
|
6799
6449
|
*/
|
|
6800
6450
|
readonly entityHitEntity: EntityHitEntityAfterEventSignal;
|
|
6801
6451
|
/**
|
|
6802
|
-
* @beta
|
|
6803
6452
|
* @remarks
|
|
6804
6453
|
* This event fires when an entity is hurt (takes damage).
|
|
6805
6454
|
*
|
|
6806
6455
|
*/
|
|
6807
6456
|
readonly entityHurt: EntityHurtAfterEventSignal;
|
|
6808
6457
|
/**
|
|
6809
|
-
* @beta
|
|
6810
6458
|
* @remarks
|
|
6811
6459
|
* Fires when an entity is loaded.
|
|
6812
6460
|
*
|
|
6813
6461
|
*/
|
|
6814
6462
|
readonly entityLoad: EntityLoadAfterEventSignal;
|
|
6815
6463
|
/**
|
|
6816
|
-
* @beta
|
|
6817
6464
|
* @remarks
|
|
6818
6465
|
* Fires when an entity is removed (for example, potentially
|
|
6819
6466
|
* unloaded, or removed after being killed).
|
|
@@ -6821,21 +6468,18 @@ export class WorldAfterEvents {
|
|
|
6821
6468
|
*/
|
|
6822
6469
|
readonly entityRemove: EntityRemoveAfterEventSignal;
|
|
6823
6470
|
/**
|
|
6824
|
-
* @beta
|
|
6825
6471
|
* @remarks
|
|
6826
6472
|
* This event fires when an entity is spawned.
|
|
6827
6473
|
*
|
|
6828
6474
|
*/
|
|
6829
6475
|
readonly entitySpawn: EntitySpawnAfterEventSignal;
|
|
6830
6476
|
/**
|
|
6831
|
-
* @beta
|
|
6832
6477
|
* @remarks
|
|
6833
6478
|
* This event fires when a chargeable item completes charging.
|
|
6834
6479
|
*
|
|
6835
6480
|
*/
|
|
6836
6481
|
readonly itemCompleteUse: ItemCompleteUseAfterEventSignal;
|
|
6837
6482
|
/**
|
|
6838
|
-
* @beta
|
|
6839
6483
|
* @remarks
|
|
6840
6484
|
* This event fires when a chargeable item is released from
|
|
6841
6485
|
* charging.
|
|
@@ -6843,14 +6487,12 @@ export class WorldAfterEvents {
|
|
|
6843
6487
|
*/
|
|
6844
6488
|
readonly itemReleaseUse: ItemReleaseUseAfterEventSignal;
|
|
6845
6489
|
/**
|
|
6846
|
-
* @beta
|
|
6847
6490
|
* @remarks
|
|
6848
6491
|
* This event fires when a chargeable item starts charging.
|
|
6849
6492
|
*
|
|
6850
6493
|
*/
|
|
6851
6494
|
readonly itemStartUse: ItemStartUseAfterEventSignal;
|
|
6852
6495
|
/**
|
|
6853
|
-
* @beta
|
|
6854
6496
|
* @remarks
|
|
6855
6497
|
* This event fires when a player successfully uses an item or
|
|
6856
6498
|
* places a block by pressing the Use Item / Place Block
|
|
@@ -6861,14 +6503,12 @@ export class WorldAfterEvents {
|
|
|
6861
6503
|
*/
|
|
6862
6504
|
readonly itemStartUseOn: ItemStartUseOnAfterEventSignal;
|
|
6863
6505
|
/**
|
|
6864
|
-
* @beta
|
|
6865
6506
|
* @remarks
|
|
6866
6507
|
* This event fires when a chargeable item stops charging.
|
|
6867
6508
|
*
|
|
6868
6509
|
*/
|
|
6869
6510
|
readonly itemStopUse: ItemStopUseAfterEventSignal;
|
|
6870
6511
|
/**
|
|
6871
|
-
* @beta
|
|
6872
6512
|
* @remarks
|
|
6873
6513
|
* This event fires when a player releases the Use Item / Place
|
|
6874
6514
|
* Block button after successfully using an item. Note: This
|
|
@@ -6877,7 +6517,6 @@ export class WorldAfterEvents {
|
|
|
6877
6517
|
*/
|
|
6878
6518
|
readonly itemStopUseOn: ItemStopUseOnAfterEventSignal;
|
|
6879
6519
|
/**
|
|
6880
|
-
* @beta
|
|
6881
6520
|
* @remarks
|
|
6882
6521
|
* This event fires when an item is successfully used by a
|
|
6883
6522
|
* player.
|
|
@@ -6885,7 +6524,6 @@ export class WorldAfterEvents {
|
|
|
6885
6524
|
*/
|
|
6886
6525
|
readonly itemUse: ItemUseAfterEventSignal;
|
|
6887
6526
|
/**
|
|
6888
|
-
* @beta
|
|
6889
6527
|
* @remarks
|
|
6890
6528
|
* This event fires when an item is used on a block by a
|
|
6891
6529
|
* player.
|
|
@@ -6899,14 +6537,12 @@ export class WorldAfterEvents {
|
|
|
6899
6537
|
*/
|
|
6900
6538
|
readonly leverAction: LeverActionAfterEventSignal;
|
|
6901
6539
|
/**
|
|
6902
|
-
* @beta
|
|
6903
6540
|
* @remarks
|
|
6904
6541
|
* This event fires for a block that is broken by a player.
|
|
6905
6542
|
*
|
|
6906
6543
|
*/
|
|
6907
6544
|
readonly playerBreakBlock: PlayerBreakBlockAfterEventSignal;
|
|
6908
6545
|
/**
|
|
6909
|
-
* @beta
|
|
6910
6546
|
* @remarks
|
|
6911
6547
|
* Fires when a player moved to a different dimension.
|
|
6912
6548
|
*
|
|
@@ -6927,7 +6563,6 @@ export class WorldAfterEvents {
|
|
|
6927
6563
|
*/
|
|
6928
6564
|
readonly playerLeave: PlayerLeaveAfterEventSignal;
|
|
6929
6565
|
/**
|
|
6930
|
-
* @beta
|
|
6931
6566
|
* @remarks
|
|
6932
6567
|
* This event fires for a block that is placed by a player.
|
|
6933
6568
|
*
|
|
@@ -6942,7 +6577,6 @@ export class WorldAfterEvents {
|
|
|
6942
6577
|
*/
|
|
6943
6578
|
readonly playerSpawn: PlayerSpawnAfterEventSignal;
|
|
6944
6579
|
/**
|
|
6945
|
-
* @beta
|
|
6946
6580
|
* @remarks
|
|
6947
6581
|
* A pressure plate has popped back up (i.e., there are no
|
|
6948
6582
|
* entities on the pressure plate.)
|
|
@@ -6950,7 +6584,6 @@ export class WorldAfterEvents {
|
|
|
6950
6584
|
*/
|
|
6951
6585
|
readonly pressurePlatePop: PressurePlatePopAfterEventSignal;
|
|
6952
6586
|
/**
|
|
6953
|
-
* @beta
|
|
6954
6587
|
* @remarks
|
|
6955
6588
|
* A pressure plate has pushed (at least one entity has moved
|
|
6956
6589
|
* onto a pressure plate.)
|
|
@@ -6958,28 +6591,24 @@ export class WorldAfterEvents {
|
|
|
6958
6591
|
*/
|
|
6959
6592
|
readonly pressurePlatePush: PressurePlatePushAfterEventSignal;
|
|
6960
6593
|
/**
|
|
6961
|
-
* @beta
|
|
6962
6594
|
* @remarks
|
|
6963
6595
|
* This event fires when a projectile hits a block.
|
|
6964
6596
|
*
|
|
6965
6597
|
*/
|
|
6966
6598
|
readonly projectileHitBlock: ProjectileHitBlockAfterEventSignal;
|
|
6967
6599
|
/**
|
|
6968
|
-
* @beta
|
|
6969
6600
|
* @remarks
|
|
6970
6601
|
* This event fires when a projectile hits an entity.
|
|
6971
6602
|
*
|
|
6972
6603
|
*/
|
|
6973
6604
|
readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
|
|
6974
6605
|
/**
|
|
6975
|
-
* @beta
|
|
6976
6606
|
* @remarks
|
|
6977
6607
|
* A target block was hit.
|
|
6978
6608
|
*
|
|
6979
6609
|
*/
|
|
6980
6610
|
readonly targetBlockHit: TargetBlockHitAfterEventSignal;
|
|
6981
6611
|
/**
|
|
6982
|
-
* @beta
|
|
6983
6612
|
* @remarks
|
|
6984
6613
|
* A trip wire was tripped.
|
|
6985
6614
|
*
|
|
@@ -6988,7 +6617,6 @@ export class WorldAfterEvents {
|
|
|
6988
6617
|
}
|
|
6989
6618
|
|
|
6990
6619
|
/**
|
|
6991
|
-
* @beta
|
|
6992
6620
|
* A set of events that fire before an actual action occurs. In
|
|
6993
6621
|
* most cases, you can potentially cancel or modify the
|
|
6994
6622
|
* impending event. Note that in before events any APIs that
|
|
@@ -6998,7 +6626,6 @@ export class WorldAfterEvents {
|
|
|
6998
6626
|
export class WorldBeforeEvents {
|
|
6999
6627
|
private constructor();
|
|
7000
6628
|
/**
|
|
7001
|
-
* @beta
|
|
7002
6629
|
* @remarks
|
|
7003
6630
|
* Fires before an entity is removed from the world (for
|
|
7004
6631
|
* example, unloaded or removed after being killed.)
|
|
@@ -7020,7 +6647,6 @@ export class WorldBeforeEvents {
|
|
|
7020
6647
|
*/
|
|
7021
6648
|
readonly itemUseOn: ItemUseOnBeforeEventSignal;
|
|
7022
6649
|
/**
|
|
7023
|
-
* @beta
|
|
7024
6650
|
* @remarks
|
|
7025
6651
|
* This event fires before a block is broken by a player.
|
|
7026
6652
|
*
|
|
@@ -7029,7 +6655,6 @@ export class WorldBeforeEvents {
|
|
|
7029
6655
|
}
|
|
7030
6656
|
|
|
7031
6657
|
/**
|
|
7032
|
-
* @beta
|
|
7033
6658
|
* Contains optional parameters for registering a block event.
|
|
7034
6659
|
*/
|
|
7035
6660
|
export interface BlockEventOptions {
|
|
@@ -7050,7 +6675,6 @@ export interface BlockEventOptions {
|
|
|
7050
6675
|
}
|
|
7051
6676
|
|
|
7052
6677
|
/**
|
|
7053
|
-
* @beta
|
|
7054
6678
|
* Contains more information for events where a block is hit.
|
|
7055
6679
|
*/
|
|
7056
6680
|
export interface BlockHitInformation {
|
|
@@ -7076,7 +6700,6 @@ export interface BlockHitInformation {
|
|
|
7076
6700
|
}
|
|
7077
6701
|
|
|
7078
6702
|
/**
|
|
7079
|
-
* @beta
|
|
7080
6703
|
* Contains information for block raycast hit results.
|
|
7081
6704
|
*/
|
|
7082
6705
|
export interface BlockRaycastHit {
|
|
@@ -7102,7 +6725,6 @@ export interface BlockRaycastHit {
|
|
|
7102
6725
|
}
|
|
7103
6726
|
|
|
7104
6727
|
/**
|
|
7105
|
-
* @beta
|
|
7106
6728
|
* Contains additional options for configuring a block raycast
|
|
7107
6729
|
* query.
|
|
7108
6730
|
*/
|
|
@@ -7129,15 +6751,11 @@ export interface BlockRaycastOptions {
|
|
|
7129
6751
|
maxDistance?: number;
|
|
7130
6752
|
}
|
|
7131
6753
|
|
|
7132
|
-
/**
|
|
7133
|
-
* @beta
|
|
7134
|
-
*/
|
|
7135
6754
|
export interface CameraDefaultOptions {
|
|
7136
6755
|
easeOptions: CameraEaseOptions;
|
|
7137
6756
|
}
|
|
7138
6757
|
|
|
7139
6758
|
/**
|
|
7140
|
-
* @beta
|
|
7141
6759
|
* Contains options associated with a camera ease operation.
|
|
7142
6760
|
*/
|
|
7143
6761
|
export interface CameraEaseOptions {
|
|
@@ -7156,7 +6774,6 @@ export interface CameraEaseOptions {
|
|
|
7156
6774
|
}
|
|
7157
6775
|
|
|
7158
6776
|
/**
|
|
7159
|
-
* @beta
|
|
7160
6777
|
* Used to initiate a full-screen color fade.
|
|
7161
6778
|
*/
|
|
7162
6779
|
export interface CameraFadeOptions {
|
|
@@ -7175,7 +6792,6 @@ export interface CameraFadeOptions {
|
|
|
7175
6792
|
}
|
|
7176
6793
|
|
|
7177
6794
|
/**
|
|
7178
|
-
* @beta
|
|
7179
6795
|
* Contains timings for a fade transition.
|
|
7180
6796
|
*/
|
|
7181
6797
|
export interface CameraFadeTimeOptions {
|
|
@@ -7199,35 +6815,23 @@ export interface CameraFadeTimeOptions {
|
|
|
7199
6815
|
holdTime: number;
|
|
7200
6816
|
}
|
|
7201
6817
|
|
|
7202
|
-
/**
|
|
7203
|
-
* @beta
|
|
7204
|
-
*/
|
|
7205
6818
|
export interface CameraSetFacingOptions {
|
|
7206
6819
|
easeOptions?: CameraEaseOptions;
|
|
7207
6820
|
facingEntity: Entity;
|
|
7208
6821
|
location?: Vector3;
|
|
7209
6822
|
}
|
|
7210
6823
|
|
|
7211
|
-
/**
|
|
7212
|
-
* @beta
|
|
7213
|
-
*/
|
|
7214
6824
|
export interface CameraSetLocationOptions {
|
|
7215
6825
|
easeOptions?: CameraEaseOptions;
|
|
7216
6826
|
location: Vector3;
|
|
7217
6827
|
}
|
|
7218
6828
|
|
|
7219
|
-
/**
|
|
7220
|
-
* @beta
|
|
7221
|
-
*/
|
|
7222
6829
|
export interface CameraSetPosOptions {
|
|
7223
6830
|
easeOptions?: CameraEaseOptions;
|
|
7224
6831
|
facingLocation: Vector3;
|
|
7225
6832
|
location?: Vector3;
|
|
7226
6833
|
}
|
|
7227
6834
|
|
|
7228
|
-
/**
|
|
7229
|
-
* @beta
|
|
7230
|
-
*/
|
|
7231
6835
|
export interface CameraSetRotOptions {
|
|
7232
6836
|
easeOptions?: CameraEaseOptions;
|
|
7233
6837
|
location?: Vector3;
|
|
@@ -7235,7 +6839,6 @@ export interface CameraSetRotOptions {
|
|
|
7235
6839
|
}
|
|
7236
6840
|
|
|
7237
6841
|
/**
|
|
7238
|
-
* @beta
|
|
7239
6842
|
* An exact coordinate within the world, including its
|
|
7240
6843
|
* dimension and location.
|
|
7241
6844
|
*/
|
|
@@ -7267,7 +6870,6 @@ export interface DimensionLocation {
|
|
|
7267
6870
|
}
|
|
7268
6871
|
|
|
7269
6872
|
/**
|
|
7270
|
-
* @beta
|
|
7271
6873
|
* Additional options for when damage has been applied via a
|
|
7272
6874
|
* projectile.
|
|
7273
6875
|
*/
|
|
@@ -7287,7 +6889,6 @@ export interface EntityApplyDamageByProjectileOptions {
|
|
|
7287
6889
|
}
|
|
7288
6890
|
|
|
7289
6891
|
/**
|
|
7290
|
-
* @beta
|
|
7291
6892
|
* Additional descriptions and metadata for a damage event.
|
|
7292
6893
|
*/
|
|
7293
6894
|
export interface EntityApplyDamageOptions {
|
|
@@ -7306,7 +6907,6 @@ export interface EntityApplyDamageOptions {
|
|
|
7306
6907
|
}
|
|
7307
6908
|
|
|
7308
6909
|
/**
|
|
7309
|
-
* @beta
|
|
7310
6910
|
* Provides information about how damage has been applied to an
|
|
7311
6911
|
* entity.
|
|
7312
6912
|
*/
|
|
@@ -7332,7 +6932,6 @@ export interface EntityDamageSource {
|
|
|
7332
6932
|
}
|
|
7333
6933
|
|
|
7334
6934
|
/**
|
|
7335
|
-
* @beta
|
|
7336
6935
|
* Contains additional options for entity effects.
|
|
7337
6936
|
*/
|
|
7338
6937
|
export interface EntityEffectOptions {
|
|
@@ -7351,7 +6950,6 @@ export interface EntityEffectOptions {
|
|
|
7351
6950
|
}
|
|
7352
6951
|
|
|
7353
6952
|
/**
|
|
7354
|
-
* @beta
|
|
7355
6953
|
* Contains optional parameters for registering an entity
|
|
7356
6954
|
* event.
|
|
7357
6955
|
*/
|
|
@@ -7373,7 +6971,6 @@ export interface EntityEventOptions {
|
|
|
7373
6971
|
}
|
|
7374
6972
|
|
|
7375
6973
|
/**
|
|
7376
|
-
* @beta
|
|
7377
6974
|
* Contains additional information about an entity that was
|
|
7378
6975
|
* hit.
|
|
7379
6976
|
*/
|
|
@@ -7387,7 +6984,6 @@ export interface EntityHitInformation {
|
|
|
7387
6984
|
}
|
|
7388
6985
|
|
|
7389
6986
|
/**
|
|
7390
|
-
* @beta
|
|
7391
6987
|
* Contains options for selecting entities within an area.
|
|
7392
6988
|
*/
|
|
7393
6989
|
export interface EntityQueryOptions {
|
|
@@ -7550,7 +7146,6 @@ export interface EntityQueryOptions {
|
|
|
7550
7146
|
}
|
|
7551
7147
|
|
|
7552
7148
|
/**
|
|
7553
|
-
* @beta
|
|
7554
7149
|
* Contains additional options for filtering players based on
|
|
7555
7150
|
* their score for an objective.
|
|
7556
7151
|
*/
|
|
@@ -7585,7 +7180,6 @@ export interface EntityQueryScoreOptions {
|
|
|
7585
7180
|
}
|
|
7586
7181
|
|
|
7587
7182
|
/**
|
|
7588
|
-
* @beta
|
|
7589
7183
|
* Contains information for entity raycast hit results.
|
|
7590
7184
|
*/
|
|
7591
7185
|
export interface EntityRaycastHit {
|
|
@@ -7604,7 +7198,6 @@ export interface EntityRaycastHit {
|
|
|
7604
7198
|
}
|
|
7605
7199
|
|
|
7606
7200
|
/**
|
|
7607
|
-
* @beta
|
|
7608
7201
|
* Contains additional options for an entity raycast operation.
|
|
7609
7202
|
*/
|
|
7610
7203
|
export interface EntityRaycastOptions {
|
|
@@ -7617,7 +7210,6 @@ export interface EntityRaycastOptions {
|
|
|
7617
7210
|
}
|
|
7618
7211
|
|
|
7619
7212
|
/**
|
|
7620
|
-
* @beta
|
|
7621
7213
|
* Additional configuration options for {@link
|
|
7622
7214
|
* World.playMusic}/{@link World.queueMusic} methods.
|
|
7623
7215
|
*/
|
|
@@ -7643,7 +7235,6 @@ export interface MusicOptions {
|
|
|
7643
7235
|
}
|
|
7644
7236
|
|
|
7645
7237
|
/**
|
|
7646
|
-
* @beta
|
|
7647
7238
|
* Additional options for how a sound plays for a player.
|
|
7648
7239
|
*/
|
|
7649
7240
|
export interface PlayerSoundOptions {
|
|
@@ -7669,7 +7260,6 @@ export interface PlayerSoundOptions {
|
|
|
7669
7260
|
}
|
|
7670
7261
|
|
|
7671
7262
|
/**
|
|
7672
|
-
* @beta
|
|
7673
7263
|
* Defines a JSON structure that is used for more flexible.
|
|
7674
7264
|
*/
|
|
7675
7265
|
export interface RawMessage {
|
|
@@ -7711,7 +7301,6 @@ export interface RawMessage {
|
|
|
7711
7301
|
}
|
|
7712
7302
|
|
|
7713
7303
|
/**
|
|
7714
|
-
* @beta
|
|
7715
7304
|
* Provides a description of a score token to use within a raw
|
|
7716
7305
|
* message.
|
|
7717
7306
|
*/
|
|
@@ -7731,7 +7320,6 @@ export interface RawMessageScore {
|
|
|
7731
7320
|
}
|
|
7732
7321
|
|
|
7733
7322
|
/**
|
|
7734
|
-
* @beta
|
|
7735
7323
|
* Represents a fully customizable color within Minecraft.
|
|
7736
7324
|
*/
|
|
7737
7325
|
export interface RGB {
|
|
@@ -7759,7 +7347,6 @@ export interface RGB {
|
|
|
7759
7347
|
}
|
|
7760
7348
|
|
|
7761
7349
|
/**
|
|
7762
|
-
* @beta
|
|
7763
7350
|
* Represents a fully customizable color within Minecraft.
|
|
7764
7351
|
*/
|
|
7765
7352
|
export interface RGBA {
|
|
@@ -7794,7 +7381,6 @@ export interface RGBA {
|
|
|
7794
7381
|
}
|
|
7795
7382
|
|
|
7796
7383
|
/**
|
|
7797
|
-
* @beta
|
|
7798
7384
|
* Contains additional options for how a scoreboard should be
|
|
7799
7385
|
* displayed within its display slot.
|
|
7800
7386
|
*/
|
|
@@ -7814,7 +7400,6 @@ export interface ScoreboardObjectiveDisplayOptions {
|
|
|
7814
7400
|
}
|
|
7815
7401
|
|
|
7816
7402
|
/**
|
|
7817
|
-
* @beta
|
|
7818
7403
|
* Contains additional options for registering a script event
|
|
7819
7404
|
* event callback.
|
|
7820
7405
|
*/
|
|
@@ -7829,7 +7414,6 @@ export interface ScriptEventMessageFilterOptions {
|
|
|
7829
7414
|
}
|
|
7830
7415
|
|
|
7831
7416
|
/**
|
|
7832
|
-
* @beta
|
|
7833
7417
|
* Contains additional options for teleporting an entity.
|
|
7834
7418
|
*/
|
|
7835
7419
|
export interface TeleportOptions {
|
|
@@ -7869,7 +7453,6 @@ export interface TeleportOptions {
|
|
|
7869
7453
|
}
|
|
7870
7454
|
|
|
7871
7455
|
/**
|
|
7872
|
-
* @beta
|
|
7873
7456
|
* Contains additional options for displaying a title and
|
|
7874
7457
|
* optional subtitle.
|
|
7875
7458
|
*/
|
|
@@ -7908,7 +7491,6 @@ export interface TitleDisplayOptions {
|
|
|
7908
7491
|
}
|
|
7909
7492
|
|
|
7910
7493
|
/**
|
|
7911
|
-
* @beta
|
|
7912
7494
|
* Represents a two-directional vector.
|
|
7913
7495
|
*/
|
|
7914
7496
|
export interface Vector2 {
|
|
@@ -7927,7 +7509,6 @@ export interface Vector2 {
|
|
|
7927
7509
|
}
|
|
7928
7510
|
|
|
7929
7511
|
/**
|
|
7930
|
-
* @beta
|
|
7931
7512
|
* Contains a description of a vector.
|
|
7932
7513
|
*/
|
|
7933
7514
|
export interface Vector3 {
|
|
@@ -7952,7 +7533,6 @@ export interface Vector3 {
|
|
|
7952
7533
|
}
|
|
7953
7534
|
|
|
7954
7535
|
/**
|
|
7955
|
-
* @beta
|
|
7956
7536
|
* Contains additional options for a world-level playSound
|
|
7957
7537
|
* occurrence.
|
|
7958
7538
|
*/
|
|
@@ -7971,32 +7551,22 @@ export interface WorldSoundOptions {
|
|
|
7971
7551
|
volume?: number;
|
|
7972
7552
|
}
|
|
7973
7553
|
|
|
7974
|
-
/**
|
|
7975
|
-
* @beta
|
|
7976
|
-
*/
|
|
7977
7554
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
7978
7555
|
export class CommandError extends Error {
|
|
7979
7556
|
private constructor();
|
|
7980
7557
|
}
|
|
7981
7558
|
|
|
7982
|
-
/**
|
|
7983
|
-
* @beta
|
|
7984
|
-
*/
|
|
7985
7559
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
7986
7560
|
export class LocationInUnloadedChunkError extends Error {
|
|
7987
7561
|
private constructor();
|
|
7988
7562
|
}
|
|
7989
7563
|
|
|
7990
|
-
/**
|
|
7991
|
-
* @beta
|
|
7992
|
-
*/
|
|
7993
7564
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
7994
7565
|
export class LocationOutOfWorldBoundariesError extends Error {
|
|
7995
7566
|
private constructor();
|
|
7996
7567
|
}
|
|
7997
7568
|
|
|
7998
7569
|
/**
|
|
7999
|
-
* @beta
|
|
8000
7570
|
* @remarks
|
|
8001
7571
|
* Holds the number of MoonPhases
|
|
8002
7572
|
*
|