@minecraft/server 1.7.0-beta.1.20.40-preview.23 → 1.7.0-beta.1.20.40-stable
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 +374 -431
- 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,7 +15,7 @@
|
|
|
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
|
*
|
|
@@ -115,75 +114,64 @@ export enum Difficulty {
|
|
|
115
114
|
}
|
|
116
115
|
|
|
117
116
|
/**
|
|
118
|
-
* @beta
|
|
119
117
|
* A general purpose relative direction enumeration.
|
|
120
118
|
*/
|
|
121
119
|
export enum Direction {
|
|
122
120
|
/**
|
|
123
|
-
* @beta
|
|
124
121
|
* @remarks
|
|
125
|
-
* Returns the
|
|
122
|
+
* Returns the {@link Block} beneath (y - 1) of this item.
|
|
126
123
|
*
|
|
127
124
|
*/
|
|
128
125
|
Down = 'Down',
|
|
129
126
|
/**
|
|
130
|
-
* @beta
|
|
131
127
|
* @remarks
|
|
132
|
-
* Returns the
|
|
128
|
+
* Returns the {@link Block} to the east (x + 1) of this item.
|
|
133
129
|
*
|
|
134
130
|
*/
|
|
135
131
|
East = 'East',
|
|
136
132
|
/**
|
|
137
|
-
* @beta
|
|
138
133
|
* @remarks
|
|
139
|
-
* Returns the
|
|
134
|
+
* Returns the {@link Block} to the east (z + 1) of this item.
|
|
140
135
|
*
|
|
141
136
|
*/
|
|
142
137
|
North = 'North',
|
|
143
138
|
/**
|
|
144
|
-
* @beta
|
|
145
139
|
* @remarks
|
|
146
|
-
* Returns the
|
|
140
|
+
* Returns the {@link Block} to the south (z - 1) of this item.
|
|
147
141
|
*
|
|
148
142
|
*/
|
|
149
143
|
South = 'South',
|
|
150
144
|
/**
|
|
151
|
-
* @beta
|
|
152
145
|
* @remarks
|
|
153
|
-
* Returns the
|
|
146
|
+
* Returns the {@link Block} above (y + 1) of this item.
|
|
154
147
|
*
|
|
155
148
|
*/
|
|
156
149
|
Up = 'Up',
|
|
157
150
|
/**
|
|
158
|
-
* @beta
|
|
159
151
|
* @remarks
|
|
160
|
-
* Returns the
|
|
152
|
+
* Returns the {@link Block} to the west (x - 1) of this item.
|
|
161
153
|
*
|
|
162
154
|
*/
|
|
163
155
|
West = 'West',
|
|
164
156
|
}
|
|
165
157
|
|
|
166
158
|
/**
|
|
167
|
-
* @beta
|
|
168
159
|
* Specifies a mechanism for displaying scores on a scoreboard.
|
|
169
160
|
*/
|
|
170
161
|
export enum DisplaySlotId {
|
|
171
162
|
/**
|
|
172
|
-
* @beta
|
|
173
163
|
* @remarks
|
|
174
164
|
* Displays the score below the player's name.
|
|
175
165
|
*
|
|
176
166
|
*/
|
|
177
167
|
BelowName = 'BelowName',
|
|
178
168
|
/**
|
|
179
|
-
* @beta
|
|
180
169
|
* @remarks
|
|
181
170
|
* Displays the score as a list on the pause screen.
|
|
182
171
|
*
|
|
183
172
|
*/
|
|
184
173
|
List = 'List',
|
|
185
174
|
/**
|
|
186
|
-
* @beta
|
|
187
175
|
* @remarks
|
|
188
176
|
* Displays the score on the side of the player's screen.
|
|
189
177
|
*
|
|
@@ -310,9 +298,6 @@ export enum DyeColor {
|
|
|
310
298
|
Yellow = 'Yellow',
|
|
311
299
|
}
|
|
312
300
|
|
|
313
|
-
/**
|
|
314
|
-
* @beta
|
|
315
|
-
*/
|
|
316
301
|
export enum EasingType {
|
|
317
302
|
InBack = 'InBack',
|
|
318
303
|
InBounce = 'InBounce',
|
|
@@ -349,53 +334,221 @@ export enum EasingType {
|
|
|
349
334
|
}
|
|
350
335
|
|
|
351
336
|
/**
|
|
352
|
-
*
|
|
337
|
+
* Describes the source of damage from an Entity.
|
|
353
338
|
*/
|
|
354
339
|
export enum EntityDamageCause {
|
|
340
|
+
/**
|
|
341
|
+
* @remarks
|
|
342
|
+
* Damage caused by a falling anvil.
|
|
343
|
+
*
|
|
344
|
+
*/
|
|
355
345
|
anvil = 'anvil',
|
|
346
|
+
/**
|
|
347
|
+
* @remarks
|
|
348
|
+
* Damage caused from a non-Entity explosion. For example, an
|
|
349
|
+
* exploding bed.
|
|
350
|
+
*
|
|
351
|
+
*/
|
|
356
352
|
blockExplosion = 'blockExplosion',
|
|
357
353
|
campfire = 'campfire',
|
|
354
|
+
/**
|
|
355
|
+
* @remarks
|
|
356
|
+
* Unused.
|
|
357
|
+
*
|
|
358
|
+
*/
|
|
358
359
|
charging = 'charging',
|
|
360
|
+
/**
|
|
361
|
+
* @remarks
|
|
362
|
+
* Damage caused by physically touching an Entity or Block. For
|
|
363
|
+
* example, touching a Sweet Berry bush or Pufferfish.
|
|
364
|
+
*
|
|
365
|
+
*/
|
|
359
366
|
contact = 'contact',
|
|
367
|
+
/**
|
|
368
|
+
* @remarks
|
|
369
|
+
* Damage caused by an Entity being out of air and inside a
|
|
370
|
+
* liquid block.
|
|
371
|
+
*
|
|
372
|
+
*/
|
|
360
373
|
drowning = 'drowning',
|
|
374
|
+
/**
|
|
375
|
+
* @remarks
|
|
376
|
+
* Damage caused by an Entity attack.
|
|
377
|
+
*
|
|
378
|
+
*/
|
|
361
379
|
entityAttack = 'entityAttack',
|
|
380
|
+
/**
|
|
381
|
+
* @remarks
|
|
382
|
+
* Damage caused by an Entity explosion. For example, a Creeper
|
|
383
|
+
* or Wither.
|
|
384
|
+
*
|
|
385
|
+
*/
|
|
362
386
|
entityExplosion = 'entityExplosion',
|
|
387
|
+
/**
|
|
388
|
+
* @remarks
|
|
389
|
+
* Damage caused by falling onto the ground.
|
|
390
|
+
*
|
|
391
|
+
*/
|
|
363
392
|
fall = 'fall',
|
|
393
|
+
/**
|
|
394
|
+
* @remarks
|
|
395
|
+
* Damage caused by falling blocks. Note: Anvils and
|
|
396
|
+
* Stalactites have their own damage causes.
|
|
397
|
+
*
|
|
398
|
+
*/
|
|
364
399
|
fallingBlock = 'fallingBlock',
|
|
400
|
+
/**
|
|
401
|
+
* @remarks
|
|
402
|
+
* Damage caused by catching on fire.
|
|
403
|
+
*
|
|
404
|
+
*/
|
|
365
405
|
fire = 'fire',
|
|
406
|
+
/**
|
|
407
|
+
* @remarks
|
|
408
|
+
* Damage caused by burning over time.
|
|
409
|
+
*
|
|
410
|
+
*/
|
|
366
411
|
fireTick = 'fireTick',
|
|
412
|
+
/**
|
|
413
|
+
* @remarks
|
|
414
|
+
* Damage caused by fireworks.
|
|
415
|
+
*
|
|
416
|
+
*/
|
|
367
417
|
fireworks = 'fireworks',
|
|
418
|
+
/**
|
|
419
|
+
* @remarks
|
|
420
|
+
* Damage caused by flying into a wall at high speed while
|
|
421
|
+
* gliding with Elytra.
|
|
422
|
+
*
|
|
423
|
+
*/
|
|
368
424
|
flyIntoWall = 'flyIntoWall',
|
|
425
|
+
/**
|
|
426
|
+
* @remarks
|
|
427
|
+
* Damage caused by staying inside a Powder Snow block.
|
|
428
|
+
*
|
|
429
|
+
*/
|
|
369
430
|
freezing = 'freezing',
|
|
431
|
+
/**
|
|
432
|
+
* @remarks
|
|
433
|
+
* Damage caused by touching a Lava block.
|
|
434
|
+
*
|
|
435
|
+
*/
|
|
370
436
|
lava = 'lava',
|
|
437
|
+
/**
|
|
438
|
+
* @remarks
|
|
439
|
+
* Damage caused by being struck by lightning.
|
|
440
|
+
*
|
|
441
|
+
*/
|
|
371
442
|
lightning = 'lightning',
|
|
443
|
+
/**
|
|
444
|
+
* @remarks
|
|
445
|
+
* Damage caused by magical attacks. For example, Evoker Fang
|
|
446
|
+
* or Conduit Block.
|
|
447
|
+
*
|
|
448
|
+
*/
|
|
372
449
|
magic = 'magic',
|
|
450
|
+
/**
|
|
451
|
+
* @remarks
|
|
452
|
+
* Damage caused by touching a Magma block.
|
|
453
|
+
*
|
|
454
|
+
*/
|
|
373
455
|
magma = 'magma',
|
|
456
|
+
/**
|
|
457
|
+
* @remarks
|
|
458
|
+
* Damage caused by no source. For example, from a command or
|
|
459
|
+
* script.
|
|
460
|
+
*
|
|
461
|
+
*/
|
|
374
462
|
none = 'none',
|
|
463
|
+
/**
|
|
464
|
+
* @remarks
|
|
465
|
+
* Damage caused by an indirect source. For example, setting a
|
|
466
|
+
* mob's health to 0 in a behavior pack.
|
|
467
|
+
*
|
|
468
|
+
*/
|
|
375
469
|
override = 'override',
|
|
470
|
+
/**
|
|
471
|
+
* @remarks
|
|
472
|
+
* Damage caused by a Piston.
|
|
473
|
+
*
|
|
474
|
+
*/
|
|
376
475
|
piston = 'piston',
|
|
476
|
+
/**
|
|
477
|
+
* @remarks
|
|
478
|
+
* Damage caused by a projectile.
|
|
479
|
+
*
|
|
480
|
+
*/
|
|
377
481
|
projectile = 'projectile',
|
|
378
482
|
ramAttack = 'ramAttack',
|
|
379
483
|
sonicBoom = 'sonicBoom',
|
|
380
484
|
soulCampfire = 'soulCampfire',
|
|
485
|
+
/**
|
|
486
|
+
* @remarks
|
|
487
|
+
* Damage caused by a falling Stalactite block.
|
|
488
|
+
*
|
|
489
|
+
*/
|
|
381
490
|
stalactite = 'stalactite',
|
|
491
|
+
/**
|
|
492
|
+
* @remarks
|
|
493
|
+
* Damage caused by touching a Stalagmite block.
|
|
494
|
+
*
|
|
495
|
+
*/
|
|
382
496
|
stalagmite = 'stalagmite',
|
|
497
|
+
/**
|
|
498
|
+
* @remarks
|
|
499
|
+
* Damage caused over time by having an empty hunger bar.
|
|
500
|
+
*
|
|
501
|
+
*/
|
|
383
502
|
starve = 'starve',
|
|
503
|
+
/**
|
|
504
|
+
* @remarks
|
|
505
|
+
* Damage caused by an Entity being out of air and inside a
|
|
506
|
+
* non-liquid block.
|
|
507
|
+
*
|
|
508
|
+
*/
|
|
384
509
|
suffocation = 'suffocation',
|
|
510
|
+
/**
|
|
511
|
+
* @remarks
|
|
512
|
+
* Damage caused by an Entity killing itself. For example, from
|
|
513
|
+
* the /kill command.
|
|
514
|
+
*
|
|
515
|
+
*/
|
|
385
516
|
suicide = 'suicide',
|
|
517
|
+
/**
|
|
518
|
+
* @remarks
|
|
519
|
+
* Damage caused by an Entity being in an inhabitable climate.
|
|
520
|
+
* For example, a Snow Golem in a biome with a temperature
|
|
521
|
+
* greater than 1.
|
|
522
|
+
*
|
|
523
|
+
*/
|
|
386
524
|
temperature = 'temperature',
|
|
525
|
+
/**
|
|
526
|
+
* @remarks
|
|
527
|
+
* Damage caused by the Thorns armor enchantment and by the
|
|
528
|
+
* Guardian thorns effect.
|
|
529
|
+
*
|
|
530
|
+
*/
|
|
387
531
|
thorns = 'thorns',
|
|
532
|
+
/**
|
|
533
|
+
* @remarks
|
|
534
|
+
* Damage caused over time by falling into the void.
|
|
535
|
+
*
|
|
536
|
+
*/
|
|
388
537
|
'void' = 'void',
|
|
538
|
+
/**
|
|
539
|
+
* @remarks
|
|
540
|
+
* Damage caused by the Wither effect. For example, from
|
|
541
|
+
* touching a Wither Rose.
|
|
542
|
+
*
|
|
543
|
+
*/
|
|
389
544
|
wither = 'wither',
|
|
390
545
|
}
|
|
391
546
|
|
|
392
547
|
/**
|
|
393
|
-
* @beta
|
|
394
548
|
* An enumeration describing initialization cause of an entity.
|
|
395
549
|
*/
|
|
396
550
|
export enum EntityInitializationCause {
|
|
397
551
|
/**
|
|
398
|
-
* @beta
|
|
399
552
|
* @remarks
|
|
400
553
|
* Case when an entity is created as child of other entity or
|
|
401
554
|
* entities, e.g., cows making a cow or slimes making smaller
|
|
@@ -404,7 +557,6 @@ export enum EntityInitializationCause {
|
|
|
404
557
|
*/
|
|
405
558
|
Born = 'Born',
|
|
406
559
|
/**
|
|
407
|
-
* @beta
|
|
408
560
|
* @remarks
|
|
409
561
|
* Case when an entity is created by an event, e.g., Wandering
|
|
410
562
|
* trader spawning llamas.
|
|
@@ -413,14 +565,12 @@ export enum EntityInitializationCause {
|
|
|
413
565
|
Event = 'Event',
|
|
414
566
|
Loaded = 'Loaded',
|
|
415
567
|
/**
|
|
416
|
-
* @beta
|
|
417
568
|
* @remarks
|
|
418
569
|
* Case when an entity is naturally spawned in the world.
|
|
419
570
|
*
|
|
420
571
|
*/
|
|
421
572
|
Spawned = 'Spawned',
|
|
422
573
|
/**
|
|
423
|
-
* @beta
|
|
424
574
|
* @remarks
|
|
425
575
|
* Case when an entity is transformed into another entity.
|
|
426
576
|
*
|
|
@@ -454,13 +604,11 @@ export enum EntityLifetimeState {
|
|
|
454
604
|
}
|
|
455
605
|
|
|
456
606
|
/**
|
|
457
|
-
* @beta
|
|
458
607
|
* The equipment slot of the mob. This includes armor, offhand
|
|
459
608
|
* and mainhand slots.
|
|
460
609
|
*/
|
|
461
610
|
export enum EquipmentSlot {
|
|
462
611
|
/**
|
|
463
|
-
* @beta
|
|
464
612
|
* @remarks
|
|
465
613
|
* The chest slot. This slot is used to hold items such as
|
|
466
614
|
* Chestplate or Elytra.
|
|
@@ -468,7 +616,6 @@ export enum EquipmentSlot {
|
|
|
468
616
|
*/
|
|
469
617
|
Chest = 'Chest',
|
|
470
618
|
/**
|
|
471
|
-
* @beta
|
|
472
619
|
* @remarks
|
|
473
620
|
* The feet slot. This slot is used to hold items such as
|
|
474
621
|
* Boots.
|
|
@@ -476,7 +623,6 @@ export enum EquipmentSlot {
|
|
|
476
623
|
*/
|
|
477
624
|
Feet = 'Feet',
|
|
478
625
|
/**
|
|
479
|
-
* @beta
|
|
480
626
|
* @remarks
|
|
481
627
|
* The head slot. This slot is used to hold items such as
|
|
482
628
|
* Helmets or Carved Pumpkins.
|
|
@@ -484,7 +630,6 @@ export enum EquipmentSlot {
|
|
|
484
630
|
*/
|
|
485
631
|
Head = 'Head',
|
|
486
632
|
/**
|
|
487
|
-
* @beta
|
|
488
633
|
* @remarks
|
|
489
634
|
* The legs slot. This slot is used to hold items such as
|
|
490
635
|
* Leggings.
|
|
@@ -492,7 +637,6 @@ export enum EquipmentSlot {
|
|
|
492
637
|
*/
|
|
493
638
|
Legs = 'Legs',
|
|
494
639
|
/**
|
|
495
|
-
* @beta
|
|
496
640
|
* @remarks
|
|
497
641
|
* The mainhand slot. For players, the mainhand slot refers to
|
|
498
642
|
* the currently active hotbar slot.
|
|
@@ -500,7 +644,6 @@ export enum EquipmentSlot {
|
|
|
500
644
|
*/
|
|
501
645
|
Mainhand = 'Mainhand',
|
|
502
646
|
/**
|
|
503
|
-
* @beta
|
|
504
647
|
* @remarks
|
|
505
648
|
* The offhand slot. This slot is used to hold items such as
|
|
506
649
|
* shields and maps.
|
|
@@ -546,12 +689,10 @@ export enum FluidType {
|
|
|
546
689
|
}
|
|
547
690
|
|
|
548
691
|
/**
|
|
549
|
-
* @beta
|
|
550
692
|
* Represents a game mode for the current world experience.
|
|
551
693
|
*/
|
|
552
694
|
export enum GameMode {
|
|
553
695
|
/**
|
|
554
|
-
* @beta
|
|
555
696
|
* @remarks
|
|
556
697
|
* World is in a more locked-down experience, where blocks may
|
|
557
698
|
* not be manipulated.
|
|
@@ -559,7 +700,6 @@ export enum GameMode {
|
|
|
559
700
|
*/
|
|
560
701
|
adventure = 'adventure',
|
|
561
702
|
/**
|
|
562
|
-
* @beta
|
|
563
703
|
* @remarks
|
|
564
704
|
* World is in a full creative mode. In creative mode, the
|
|
565
705
|
* player has all the resources available in the item selection
|
|
@@ -572,7 +712,6 @@ export enum GameMode {
|
|
|
572
712
|
*/
|
|
573
713
|
creative = 'creative',
|
|
574
714
|
/**
|
|
575
|
-
* @beta
|
|
576
715
|
* @remarks
|
|
577
716
|
* World is in spectator mode. In spectator mode, spectators
|
|
578
717
|
* are always flying and cannot become grounded. Spectators can
|
|
@@ -585,7 +724,6 @@ export enum GameMode {
|
|
|
585
724
|
*/
|
|
586
725
|
spectator = 'spectator',
|
|
587
726
|
/**
|
|
588
|
-
* @beta
|
|
589
727
|
* @remarks
|
|
590
728
|
* World is in a survival mode, where players can take damage
|
|
591
729
|
* and entities may not be peaceful. Survival mode is where the
|
|
@@ -598,26 +736,22 @@ export enum GameMode {
|
|
|
598
736
|
}
|
|
599
737
|
|
|
600
738
|
/**
|
|
601
|
-
* @beta
|
|
602
739
|
* Describes how an an item can be moved within a container.
|
|
603
740
|
*/
|
|
604
741
|
export enum ItemLockMode {
|
|
605
742
|
/**
|
|
606
|
-
* @beta
|
|
607
743
|
* @remarks
|
|
608
744
|
* The item cannot be dropped or crafted with.
|
|
609
745
|
*
|
|
610
746
|
*/
|
|
611
747
|
inventory = 'inventory',
|
|
612
748
|
/**
|
|
613
|
-
* @beta
|
|
614
749
|
* @remarks
|
|
615
750
|
* The item has no container restrictions.
|
|
616
751
|
*
|
|
617
752
|
*/
|
|
618
753
|
none = 'none',
|
|
619
754
|
/**
|
|
620
|
-
* @beta
|
|
621
755
|
* @remarks
|
|
622
756
|
* The item cannot be moved from its slot, dropped or crafted
|
|
623
757
|
* with.
|
|
@@ -627,30 +761,74 @@ export enum ItemLockMode {
|
|
|
627
761
|
}
|
|
628
762
|
|
|
629
763
|
/**
|
|
630
|
-
* @beta
|
|
631
764
|
* Enum containing the different phases of the moon based on
|
|
632
|
-
* the current day
|
|
633
|
-
*
|
|
765
|
+
* the current day.,Obtain the current MoonPhase using
|
|
766
|
+
* world.getMoonPhase.
|
|
767
|
+
*
|
|
768
|
+
* The fullness of the moon controls various mob behaviors such
|
|
769
|
+
* as the number of slimes that spawn in Swamp biomes, the
|
|
770
|
+
* chance skeletons and zombies have to spawn with armor, as
|
|
771
|
+
* well as the chance for spiders to spawn with certain status
|
|
772
|
+
* effects.
|
|
634
773
|
*/
|
|
635
774
|
export enum MoonPhase {
|
|
775
|
+
/**
|
|
776
|
+
* @remarks
|
|
777
|
+
* The brightest moon phase. During this phase, cats have a 50%
|
|
778
|
+
* chance of spawning as black cats.
|
|
779
|
+
*
|
|
780
|
+
*/
|
|
636
781
|
FullMoon = 0,
|
|
782
|
+
/**
|
|
783
|
+
* @remarks
|
|
784
|
+
* The phase following the Full Moon.
|
|
785
|
+
*
|
|
786
|
+
*/
|
|
637
787
|
WaningGibbous = 1,
|
|
788
|
+
/**
|
|
789
|
+
* @remarks
|
|
790
|
+
* The phase following the Waxing Crescent.
|
|
791
|
+
*
|
|
792
|
+
*/
|
|
638
793
|
FirstQuarter = 2,
|
|
794
|
+
/**
|
|
795
|
+
* @remarks
|
|
796
|
+
* The phase following the Last Quarter.
|
|
797
|
+
*
|
|
798
|
+
*/
|
|
639
799
|
WaningCrescent = 3,
|
|
800
|
+
/**
|
|
801
|
+
* @remarks
|
|
802
|
+
* The darkest moon phase.
|
|
803
|
+
*
|
|
804
|
+
*/
|
|
640
805
|
NewMoon = 4,
|
|
806
|
+
/**
|
|
807
|
+
* @remarks
|
|
808
|
+
* The phase following the New Moon.
|
|
809
|
+
*
|
|
810
|
+
*/
|
|
641
811
|
WaxingCrescent = 5,
|
|
812
|
+
/**
|
|
813
|
+
* @remarks
|
|
814
|
+
* The phase following the Waning Gibbous.
|
|
815
|
+
*
|
|
816
|
+
*/
|
|
642
817
|
LastQuarter = 6,
|
|
818
|
+
/**
|
|
819
|
+
* @remarks
|
|
820
|
+
* The phase following the First Quarter.
|
|
821
|
+
*
|
|
822
|
+
*/
|
|
643
823
|
WaxingGibbous = 7,
|
|
644
824
|
}
|
|
645
825
|
|
|
646
826
|
/**
|
|
647
|
-
* @beta
|
|
648
827
|
* Used for specifying a sort order for how to display an
|
|
649
828
|
* objective and its list of participants.
|
|
650
829
|
*/
|
|
651
830
|
export enum ObjectiveSortOrder {
|
|
652
831
|
/**
|
|
653
|
-
* @beta
|
|
654
832
|
* @remarks
|
|
655
833
|
* Objective participant list is displayed in ascending (e.g.,
|
|
656
834
|
* A-Z) order.
|
|
@@ -658,7 +836,6 @@ export enum ObjectiveSortOrder {
|
|
|
658
836
|
*/
|
|
659
837
|
Ascending = 0,
|
|
660
838
|
/**
|
|
661
|
-
* @beta
|
|
662
839
|
* @remarks
|
|
663
840
|
* Objective participant list is displayed in descending (e.g.,
|
|
664
841
|
* Z-A) order.
|
|
@@ -668,19 +845,16 @@ export enum ObjectiveSortOrder {
|
|
|
668
845
|
}
|
|
669
846
|
|
|
670
847
|
/**
|
|
671
|
-
* @beta
|
|
672
848
|
* Contains objectives and participants for the scoreboard.
|
|
673
849
|
*/
|
|
674
850
|
export enum ScoreboardIdentityType {
|
|
675
851
|
/**
|
|
676
|
-
* @beta
|
|
677
852
|
* @remarks
|
|
678
853
|
* This scoreboard participant is tied to an entity.
|
|
679
854
|
*
|
|
680
855
|
*/
|
|
681
856
|
Entity = 'Entity',
|
|
682
857
|
/**
|
|
683
|
-
* @beta
|
|
684
858
|
* @remarks
|
|
685
859
|
* This scoreboard participant is tied to a pseudo player
|
|
686
860
|
* entity - typically this is used to store scores as data or
|
|
@@ -689,7 +863,6 @@ export enum ScoreboardIdentityType {
|
|
|
689
863
|
*/
|
|
690
864
|
FakePlayer = 'FakePlayer',
|
|
691
865
|
/**
|
|
692
|
-
* @beta
|
|
693
866
|
* @remarks
|
|
694
867
|
* This scoreboard participant is tied to a player.
|
|
695
868
|
*
|
|
@@ -698,12 +871,10 @@ export enum ScoreboardIdentityType {
|
|
|
698
871
|
}
|
|
699
872
|
|
|
700
873
|
/**
|
|
701
|
-
* @beta
|
|
702
874
|
* Describes where the script event originated from.
|
|
703
875
|
*/
|
|
704
876
|
export enum ScriptEventSource {
|
|
705
877
|
/**
|
|
706
|
-
* @beta
|
|
707
878
|
* @remarks
|
|
708
879
|
* The script event originated from a Block such as a Command
|
|
709
880
|
* Block.
|
|
@@ -711,7 +882,6 @@ export enum ScriptEventSource {
|
|
|
711
882
|
*/
|
|
712
883
|
Block = 'Block',
|
|
713
884
|
/**
|
|
714
|
-
* @beta
|
|
715
885
|
* @remarks
|
|
716
886
|
* The script event originated from an Entity such as a Player,
|
|
717
887
|
* Command Block Minecart or Animation Controller.
|
|
@@ -719,14 +889,12 @@ export enum ScriptEventSource {
|
|
|
719
889
|
*/
|
|
720
890
|
Entity = 'Entity',
|
|
721
891
|
/**
|
|
722
|
-
* @beta
|
|
723
892
|
* @remarks
|
|
724
893
|
* The script event originated from an NPC dialogue.
|
|
725
894
|
*
|
|
726
895
|
*/
|
|
727
896
|
NPCDialogue = 'NPCDialogue',
|
|
728
897
|
/**
|
|
729
|
-
* @beta
|
|
730
898
|
* @remarks
|
|
731
899
|
* The script event originated from the server, such as from a
|
|
732
900
|
* runCommand API call or a dedicated server console.
|
|
@@ -757,7 +925,6 @@ export enum SignSide {
|
|
|
757
925
|
}
|
|
758
926
|
|
|
759
927
|
/**
|
|
760
|
-
* @beta
|
|
761
928
|
* Provides numeric values for common periods in the Minecraft
|
|
762
929
|
* day.
|
|
763
930
|
*/
|
|
@@ -796,27 +963,23 @@ export enum WatchdogTerminateReason {
|
|
|
796
963
|
}
|
|
797
964
|
|
|
798
965
|
/**
|
|
799
|
-
* @beta
|
|
800
966
|
* Used to specify the type of weather condition within the
|
|
801
967
|
* world.
|
|
802
968
|
*/
|
|
803
969
|
export enum WeatherType {
|
|
804
970
|
/**
|
|
805
|
-
* @beta
|
|
806
971
|
* @remarks
|
|
807
972
|
* Specifies a clear weather condition.
|
|
808
973
|
*
|
|
809
974
|
*/
|
|
810
975
|
Clear = 'Clear',
|
|
811
976
|
/**
|
|
812
|
-
* @beta
|
|
813
977
|
* @remarks
|
|
814
978
|
* Specifies a rain weather condition.
|
|
815
979
|
*
|
|
816
980
|
*/
|
|
817
981
|
Rain = 'Rain',
|
|
818
982
|
/**
|
|
819
|
-
* @beta
|
|
820
983
|
* @remarks
|
|
821
984
|
* Specifies a rain and thunder weather condition.
|
|
822
985
|
*
|
|
@@ -825,7 +988,6 @@ export enum WeatherType {
|
|
|
825
988
|
}
|
|
826
989
|
|
|
827
990
|
/**
|
|
828
|
-
* @beta
|
|
829
991
|
* Represents a block in a dimension. A block represents a
|
|
830
992
|
* unique X, Y, and Z within a dimension and get/sets the state
|
|
831
993
|
* of the block at that location. This type was significantly
|
|
@@ -840,7 +1002,6 @@ export class Block {
|
|
|
840
1002
|
*/
|
|
841
1003
|
readonly dimension: Dimension;
|
|
842
1004
|
/**
|
|
843
|
-
* @beta
|
|
844
1005
|
* @remarks
|
|
845
1006
|
* Returns true if this block is an air block (i.e., empty
|
|
846
1007
|
* space).
|
|
@@ -853,7 +1014,6 @@ export class Block {
|
|
|
853
1014
|
*/
|
|
854
1015
|
readonly isAir: boolean;
|
|
855
1016
|
/**
|
|
856
|
-
* @beta
|
|
857
1017
|
* @remarks
|
|
858
1018
|
* Returns true if this block is a liquid block - (e.g., a
|
|
859
1019
|
* water block and a lava block are liquid, while an air block
|
|
@@ -953,6 +1113,12 @@ export class Block {
|
|
|
953
1113
|
readonly z: number;
|
|
954
1114
|
/**
|
|
955
1115
|
* @beta
|
|
1116
|
+
* @remarks
|
|
1117
|
+
* Returns the {@link Block} above this block (positive in the
|
|
1118
|
+
* Y direction).
|
|
1119
|
+
*
|
|
1120
|
+
* @param steps
|
|
1121
|
+
* Number of steps above to step before returning.
|
|
956
1122
|
* @throws This function can throw errors.
|
|
957
1123
|
*
|
|
958
1124
|
* {@link LocationInUnloadedChunkError}
|
|
@@ -962,6 +1128,12 @@ export class Block {
|
|
|
962
1128
|
above(steps?: number): Block | undefined;
|
|
963
1129
|
/**
|
|
964
1130
|
* @beta
|
|
1131
|
+
* @remarks
|
|
1132
|
+
* Returns the {@link Block} below this block (negative in the
|
|
1133
|
+
* Y direction).
|
|
1134
|
+
*
|
|
1135
|
+
* @param steps
|
|
1136
|
+
* Number of steps below to step before returning.
|
|
965
1137
|
* @throws This function can throw errors.
|
|
966
1138
|
*
|
|
967
1139
|
* {@link LocationInUnloadedChunkError}
|
|
@@ -971,6 +1143,10 @@ export class Block {
|
|
|
971
1143
|
below(steps?: number): Block | undefined;
|
|
972
1144
|
/**
|
|
973
1145
|
* @beta
|
|
1146
|
+
* @remarks
|
|
1147
|
+
* Returns the {@link @minecraft/server.Location} of the center
|
|
1148
|
+
* of this block on the X and Z axis.
|
|
1149
|
+
*
|
|
974
1150
|
*/
|
|
975
1151
|
bottomCenter(): Vector3;
|
|
976
1152
|
/**
|
|
@@ -999,10 +1175,20 @@ export class Block {
|
|
|
999
1175
|
canPlace(blockToPlace: BlockPermutation | BlockType | string, faceToPlaceOn?: Direction): boolean;
|
|
1000
1176
|
/**
|
|
1001
1177
|
* @beta
|
|
1178
|
+
* @remarks
|
|
1179
|
+
* Returns the {@link @minecraft/server.Location} of the center
|
|
1180
|
+
* of this block on the X, Y, and Z axis.
|
|
1181
|
+
*
|
|
1002
1182
|
*/
|
|
1003
1183
|
center(): Vector3;
|
|
1004
1184
|
/**
|
|
1005
1185
|
* @beta
|
|
1186
|
+
* @remarks
|
|
1187
|
+
* Returns the {@link Block} to the east of this block
|
|
1188
|
+
* (positive in the X direction).
|
|
1189
|
+
*
|
|
1190
|
+
* @param steps
|
|
1191
|
+
* Number of steps to the east to step before returning.
|
|
1006
1192
|
* @throws This function can throw errors.
|
|
1007
1193
|
*
|
|
1008
1194
|
* {@link LocationInUnloadedChunkError}
|
|
@@ -1011,18 +1197,14 @@ export class Block {
|
|
|
1011
1197
|
*/
|
|
1012
1198
|
east(steps?: number): Block | undefined;
|
|
1013
1199
|
/**
|
|
1014
|
-
* @beta
|
|
1015
1200
|
* @remarks
|
|
1016
|
-
* Gets
|
|
1017
|
-
*
|
|
1018
|
-
*
|
|
1201
|
+
* Gets a component (that represents additional capabilities)
|
|
1202
|
+
* for a block - for example, an inventory component of a chest
|
|
1203
|
+
* block.
|
|
1019
1204
|
*
|
|
1020
|
-
* @param componentName
|
|
1021
|
-
* Identifier of the component. If a namespace is not
|
|
1022
|
-
* specified, minecraft: is assumed.
|
|
1023
1205
|
* @returns
|
|
1024
|
-
* Returns the component
|
|
1025
|
-
*
|
|
1206
|
+
* Returns the component if it exists on the block, otherwise
|
|
1207
|
+
* undefined.
|
|
1026
1208
|
* @throws This function can throw errors.
|
|
1027
1209
|
*
|
|
1028
1210
|
* {@link LocationInUnloadedChunkError}
|
|
@@ -1042,6 +1224,9 @@ export class Block {
|
|
|
1042
1224
|
* @param withData
|
|
1043
1225
|
* Whether additional data facets of the item stack are
|
|
1044
1226
|
* included.
|
|
1227
|
+
* @returns
|
|
1228
|
+
* An itemStack with the specified amount of items and data.
|
|
1229
|
+
* Returns undefined if block type is incompatible.
|
|
1045
1230
|
* @throws This function can throw errors.
|
|
1046
1231
|
*
|
|
1047
1232
|
* {@link LocationInUnloadedChunkError}
|
|
@@ -1108,7 +1293,6 @@ export class Block {
|
|
|
1108
1293
|
*/
|
|
1109
1294
|
hasTag(tag: string): boolean;
|
|
1110
1295
|
/**
|
|
1111
|
-
* @beta
|
|
1112
1296
|
* @remarks
|
|
1113
1297
|
* Returns true if this reference to a block is still valid
|
|
1114
1298
|
* (for example, if the block is unloaded, references to that
|
|
@@ -1120,6 +1304,12 @@ export class Block {
|
|
|
1120
1304
|
isValid(): boolean;
|
|
1121
1305
|
/**
|
|
1122
1306
|
* @beta
|
|
1307
|
+
* @remarks
|
|
1308
|
+
* Returns the {@link Block} to the north of this block
|
|
1309
|
+
* (negative in the Z direction).
|
|
1310
|
+
*
|
|
1311
|
+
* @param steps
|
|
1312
|
+
* Number of steps to the north to step before returning.
|
|
1123
1313
|
* @throws This function can throw errors.
|
|
1124
1314
|
*
|
|
1125
1315
|
* {@link LocationInUnloadedChunkError}
|
|
@@ -1174,6 +1364,12 @@ export class Block {
|
|
|
1174
1364
|
setType(blockType: BlockType | string): void;
|
|
1175
1365
|
/**
|
|
1176
1366
|
* @beta
|
|
1367
|
+
* @remarks
|
|
1368
|
+
* Returns the {@link Block} to the south of this block
|
|
1369
|
+
* (positive in the Z direction).
|
|
1370
|
+
*
|
|
1371
|
+
* @param steps
|
|
1372
|
+
* Number of steps to the south to step before returning.
|
|
1177
1373
|
* @throws This function can throw errors.
|
|
1178
1374
|
*
|
|
1179
1375
|
* {@link LocationInUnloadedChunkError}
|
|
@@ -1204,6 +1400,12 @@ export class Block {
|
|
|
1204
1400
|
trySetPermutation(permutation: BlockPermutation): boolean;
|
|
1205
1401
|
/**
|
|
1206
1402
|
* @beta
|
|
1403
|
+
* @remarks
|
|
1404
|
+
* Returns the {@link Block} to the west of this block
|
|
1405
|
+
* (negative in the X direction).
|
|
1406
|
+
*
|
|
1407
|
+
* @param steps
|
|
1408
|
+
* Number of steps to the west to step before returning.
|
|
1207
1409
|
* @throws This function can throw errors.
|
|
1208
1410
|
*
|
|
1209
1411
|
* {@link LocationInUnloadedChunkError}
|
|
@@ -1253,14 +1455,12 @@ export class BlockAreaSize {
|
|
|
1253
1455
|
}
|
|
1254
1456
|
|
|
1255
1457
|
/**
|
|
1256
|
-
* @beta
|
|
1257
1458
|
* Base type for components associated with blocks.
|
|
1258
1459
|
*/
|
|
1259
1460
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
1260
1461
|
export class BlockComponent extends Component {
|
|
1261
1462
|
private constructor();
|
|
1262
1463
|
/**
|
|
1263
|
-
* @beta
|
|
1264
1464
|
* @remarks
|
|
1265
1465
|
* Block instance that this component pertains to.
|
|
1266
1466
|
*
|
|
@@ -1269,7 +1469,6 @@ export class BlockComponent extends Component {
|
|
|
1269
1469
|
}
|
|
1270
1470
|
|
|
1271
1471
|
/**
|
|
1272
|
-
* @beta
|
|
1273
1472
|
* Contains information regarding an event that impacts a
|
|
1274
1473
|
* specific block.
|
|
1275
1474
|
*/
|
|
@@ -1341,7 +1540,6 @@ export class BlockExplodeAfterEventSignal {
|
|
|
1341
1540
|
}
|
|
1342
1541
|
|
|
1343
1542
|
/**
|
|
1344
|
-
* @beta
|
|
1345
1543
|
* Represents the inventory of a block in the world. Used with
|
|
1346
1544
|
* blocks like chests.
|
|
1347
1545
|
*/
|
|
@@ -1435,7 +1633,6 @@ export class BlockLocationIterator implements Iterable<Vector3> {
|
|
|
1435
1633
|
}
|
|
1436
1634
|
|
|
1437
1635
|
/**
|
|
1438
|
-
* @beta
|
|
1439
1636
|
* Contains the combination of type {@link BlockType} and
|
|
1440
1637
|
* properties (also sometimes called block state) which
|
|
1441
1638
|
* describe a block (but does not belong to a specific {@link
|
|
@@ -1855,8 +2052,8 @@ export class BlockStates {
|
|
|
1855
2052
|
* Retrieves a specific block state instance.
|
|
1856
2053
|
*
|
|
1857
2054
|
* @returns
|
|
1858
|
-
* Returns the
|
|
1859
|
-
* block state instance is not found returns undefined.
|
|
2055
|
+
* Returns the {@link Block} state instance if it is found. If
|
|
2056
|
+
* the block state instance is not found returns undefined.
|
|
1860
2057
|
*/
|
|
1861
2058
|
static get(stateName: string): BlockStateType | undefined;
|
|
1862
2059
|
/**
|
|
@@ -2247,7 +2444,6 @@ export class BoundingBoxUtils {
|
|
|
2247
2444
|
}
|
|
2248
2445
|
|
|
2249
2446
|
/**
|
|
2250
|
-
* @beta
|
|
2251
2447
|
* Contains information related to changes to a button push.
|
|
2252
2448
|
*/
|
|
2253
2449
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -2262,7 +2458,6 @@ export class ButtonPushAfterEvent extends BlockEvent {
|
|
|
2262
2458
|
}
|
|
2263
2459
|
|
|
2264
2460
|
/**
|
|
2265
|
-
* @beta
|
|
2266
2461
|
* Manages callbacks that are connected to when a button is
|
|
2267
2462
|
* pushed.
|
|
2268
2463
|
*/
|
|
@@ -2272,7 +2467,6 @@ export class ButtonPushAfterEventSignal extends IButtonPushAfterEventSignal {
|
|
|
2272
2467
|
}
|
|
2273
2468
|
|
|
2274
2469
|
/**
|
|
2275
|
-
* @beta
|
|
2276
2470
|
* Contains methods relating to the active camera for the
|
|
2277
2471
|
* specified player.
|
|
2278
2472
|
*/
|
|
@@ -2471,7 +2665,6 @@ export class CommandResult {
|
|
|
2471
2665
|
}
|
|
2472
2666
|
|
|
2473
2667
|
/**
|
|
2474
|
-
* @beta
|
|
2475
2668
|
* Base class for downstream Component implementations.
|
|
2476
2669
|
*/
|
|
2477
2670
|
export class Component {
|
|
@@ -2483,7 +2676,6 @@ export class Component {
|
|
|
2483
2676
|
*/
|
|
2484
2677
|
readonly typeId: string;
|
|
2485
2678
|
/**
|
|
2486
|
-
* @beta
|
|
2487
2679
|
* @remarks
|
|
2488
2680
|
* Returns whether the component is valid. A component is
|
|
2489
2681
|
* considered valid if its owner is valid, in addition to any
|
|
@@ -2748,7 +2940,6 @@ export class CompoundBlockVolume {
|
|
|
2748
2940
|
}
|
|
2749
2941
|
|
|
2750
2942
|
/**
|
|
2751
|
-
* @beta
|
|
2752
2943
|
* Represents a container that can hold sets of items. Used
|
|
2753
2944
|
* with entities such as Players, Chest Minecarts, Llamas, and
|
|
2754
2945
|
* more.
|
|
@@ -2834,7 +3025,6 @@ export class Container {
|
|
|
2834
3025
|
*/
|
|
2835
3026
|
getSlot(slot: number): ContainerSlot;
|
|
2836
3027
|
/**
|
|
2837
|
-
* @beta
|
|
2838
3028
|
* @remarks
|
|
2839
3029
|
* Returns whether a container object (or the entity or block
|
|
2840
3030
|
* that this container is associated with) is still available
|
|
@@ -2923,6 +3113,9 @@ export class Container {
|
|
|
2923
3113
|
* @param toContainer
|
|
2924
3114
|
* Target container to transfer to. Note this can be the same
|
|
2925
3115
|
* container as the source.
|
|
3116
|
+
* @returns
|
|
3117
|
+
* An itemStack with the items that couldn't be transferred.
|
|
3118
|
+
* Returns undefined if all items were transferred.
|
|
2926
3119
|
* @throws
|
|
2927
3120
|
* Throws if either this container or `toContainer` are invalid
|
|
2928
3121
|
* or if the `fromSlot` or `toSlot` indices out of bounds.
|
|
@@ -3448,7 +3641,6 @@ export class Dimension {
|
|
|
3448
3641
|
options?: BlockFillOptions,
|
|
3449
3642
|
): number;
|
|
3450
3643
|
/**
|
|
3451
|
-
* @beta
|
|
3452
3644
|
* @remarks
|
|
3453
3645
|
* Returns a block instance at the given location.
|
|
3454
3646
|
*
|
|
@@ -3473,7 +3665,6 @@ export class Dimension {
|
|
|
3473
3665
|
*/
|
|
3474
3666
|
getBlock(location: Vector3): Block | undefined;
|
|
3475
3667
|
/**
|
|
3476
|
-
* @beta
|
|
3477
3668
|
* @remarks
|
|
3478
3669
|
* Gets the first block that intersects with a vector emanating
|
|
3479
3670
|
* from a location.
|
|
@@ -3487,7 +3678,6 @@ export class Dimension {
|
|
|
3487
3678
|
*/
|
|
3488
3679
|
getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
|
|
3489
3680
|
/**
|
|
3490
|
-
* @beta
|
|
3491
3681
|
* @remarks
|
|
3492
3682
|
* Returns a set of entities based on a set of conditions
|
|
3493
3683
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -3556,7 +3746,6 @@ export class Dimension {
|
|
|
3556
3746
|
*/
|
|
3557
3747
|
getEntities(options?: EntityQueryOptions): Entity[];
|
|
3558
3748
|
/**
|
|
3559
|
-
* @beta
|
|
3560
3749
|
* @remarks
|
|
3561
3750
|
* Returns a set of entities at a particular location.
|
|
3562
3751
|
*
|
|
@@ -3567,7 +3756,6 @@ export class Dimension {
|
|
|
3567
3756
|
*/
|
|
3568
3757
|
getEntitiesAtBlockLocation(location: Vector3): Entity[];
|
|
3569
3758
|
/**
|
|
3570
|
-
* @beta
|
|
3571
3759
|
* @remarks
|
|
3572
3760
|
* Gets entities that intersect with a specified vector
|
|
3573
3761
|
* emanating from a location.
|
|
@@ -3577,7 +3765,6 @@ export class Dimension {
|
|
|
3577
3765
|
*/
|
|
3578
3766
|
getEntitiesFromRay(location: Vector3, direction: Vector3, options?: EntityRaycastOptions): EntityRaycastHit[];
|
|
3579
3767
|
/**
|
|
3580
|
-
* @beta
|
|
3581
3768
|
* @remarks
|
|
3582
3769
|
* Returns a set of players based on a set of conditions
|
|
3583
3770
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -3598,7 +3785,6 @@ export class Dimension {
|
|
|
3598
3785
|
*/
|
|
3599
3786
|
getWeather(): WeatherType;
|
|
3600
3787
|
/**
|
|
3601
|
-
* @beta
|
|
3602
3788
|
* @remarks
|
|
3603
3789
|
* Runs a command synchronously using the context of the
|
|
3604
3790
|
* broader dimenion.
|
|
@@ -3643,7 +3829,6 @@ export class Dimension {
|
|
|
3643
3829
|
*/
|
|
3644
3830
|
runCommandAsync(commandString: string): Promise<CommandResult>;
|
|
3645
3831
|
/**
|
|
3646
|
-
* @beta
|
|
3647
3832
|
* @remarks
|
|
3648
3833
|
* Sets the current weather within the dimension
|
|
3649
3834
|
*
|
|
@@ -3659,7 +3844,6 @@ export class Dimension {
|
|
|
3659
3844
|
*/
|
|
3660
3845
|
setWeather(weatherType: WeatherType, duration?: number): void;
|
|
3661
3846
|
/**
|
|
3662
|
-
* @beta
|
|
3663
3847
|
* @remarks
|
|
3664
3848
|
* Creates a new entity (e.g., a mob) at the specified
|
|
3665
3849
|
* location.
|
|
@@ -3720,7 +3904,6 @@ export class Dimension {
|
|
|
3720
3904
|
*/
|
|
3721
3905
|
spawnEntity(identifier: string, location: Vector3): Entity;
|
|
3722
3906
|
/**
|
|
3723
|
-
* @beta
|
|
3724
3907
|
* @remarks
|
|
3725
3908
|
* Creates a new item stack as an entity at the specified
|
|
3726
3909
|
* location.
|
|
@@ -3767,7 +3950,6 @@ export class Dimension {
|
|
|
3767
3950
|
*/
|
|
3768
3951
|
spawnItem(itemStack: ItemStack, location: Vector3): Entity;
|
|
3769
3952
|
/**
|
|
3770
|
-
* @beta
|
|
3771
3953
|
* @remarks
|
|
3772
3954
|
* Creates a new particle emitter at a specified location in
|
|
3773
3955
|
* the world.
|
|
@@ -3840,7 +4022,6 @@ export class DimensionTypes {
|
|
|
3840
4022
|
}
|
|
3841
4023
|
|
|
3842
4024
|
/**
|
|
3843
|
-
* @beta
|
|
3844
4025
|
* Represents an effect - like poison - that has been added to
|
|
3845
4026
|
* an Entity.
|
|
3846
4027
|
*/
|
|
@@ -3905,8 +4086,6 @@ export class EffectAddAfterEvent {
|
|
|
3905
4086
|
effect: Effect;
|
|
3906
4087
|
/**
|
|
3907
4088
|
* @remarks
|
|
3908
|
-
* Additional variant number for the effect.
|
|
3909
|
-
*
|
|
3910
4089
|
* This property can't be edited in read-only mode.
|
|
3911
4090
|
*
|
|
3912
4091
|
*/
|
|
@@ -3953,7 +4132,6 @@ export class EffectAddAfterEventSignal {
|
|
|
3953
4132
|
}
|
|
3954
4133
|
|
|
3955
4134
|
/**
|
|
3956
|
-
* @beta
|
|
3957
4135
|
* Represents a type of effect - like poison - that can be
|
|
3958
4136
|
* applied to an entity.
|
|
3959
4137
|
*/
|
|
@@ -4190,7 +4368,6 @@ export class EnchantmentTypes {
|
|
|
4190
4368
|
export class Entity {
|
|
4191
4369
|
private constructor();
|
|
4192
4370
|
/**
|
|
4193
|
-
* @beta
|
|
4194
4371
|
* @remarks
|
|
4195
4372
|
* Dimension that the entity is currently within.
|
|
4196
4373
|
*
|
|
@@ -4219,7 +4396,6 @@ export class Entity {
|
|
|
4219
4396
|
*/
|
|
4220
4397
|
readonly id: string;
|
|
4221
4398
|
/**
|
|
4222
|
-
* @beta
|
|
4223
4399
|
* @remarks
|
|
4224
4400
|
* Whether the entity is touching a climbable block. For
|
|
4225
4401
|
* example, a player next to a ladder or a spider next to a
|
|
@@ -4229,7 +4405,6 @@ export class Entity {
|
|
|
4229
4405
|
*/
|
|
4230
4406
|
readonly isClimbing: boolean;
|
|
4231
4407
|
/**
|
|
4232
|
-
* @beta
|
|
4233
4408
|
* @remarks
|
|
4234
4409
|
* Whether the entity has a fall distance greater than 0, or
|
|
4235
4410
|
* greater than 1 while gliding.
|
|
@@ -4238,7 +4413,6 @@ export class Entity {
|
|
|
4238
4413
|
*/
|
|
4239
4414
|
readonly isFalling: boolean;
|
|
4240
4415
|
/**
|
|
4241
|
-
* @beta
|
|
4242
4416
|
* @remarks
|
|
4243
4417
|
* Whether any part of the entity is inside a water block.
|
|
4244
4418
|
*
|
|
@@ -4246,7 +4420,6 @@ export class Entity {
|
|
|
4246
4420
|
*/
|
|
4247
4421
|
readonly isInWater: boolean;
|
|
4248
4422
|
/**
|
|
4249
|
-
* @beta
|
|
4250
4423
|
* @remarks
|
|
4251
4424
|
* Whether the entity is on top of a solid block.
|
|
4252
4425
|
*
|
|
@@ -4254,7 +4427,6 @@ export class Entity {
|
|
|
4254
4427
|
*/
|
|
4255
4428
|
readonly isOnGround: boolean;
|
|
4256
4429
|
/**
|
|
4257
|
-
* @beta
|
|
4258
4430
|
* @remarks
|
|
4259
4431
|
* If true, the entity is currently sleeping.
|
|
4260
4432
|
*
|
|
@@ -4262,7 +4434,6 @@ export class Entity {
|
|
|
4262
4434
|
*/
|
|
4263
4435
|
readonly isSleeping: boolean;
|
|
4264
4436
|
/**
|
|
4265
|
-
* @beta
|
|
4266
4437
|
* @remarks
|
|
4267
4438
|
* Whether the entity is sneaking - that is, moving more slowly
|
|
4268
4439
|
* and more quietly.
|
|
@@ -4272,7 +4443,6 @@ export class Entity {
|
|
|
4272
4443
|
*/
|
|
4273
4444
|
isSneaking: boolean;
|
|
4274
4445
|
/**
|
|
4275
|
-
* @beta
|
|
4276
4446
|
* @remarks
|
|
4277
4447
|
* Whether the entity is sprinting. For example, a player using
|
|
4278
4448
|
* the sprint action, an ocelot running away or a pig boosting
|
|
@@ -4282,7 +4452,6 @@ export class Entity {
|
|
|
4282
4452
|
*/
|
|
4283
4453
|
readonly isSprinting: boolean;
|
|
4284
4454
|
/**
|
|
4285
|
-
* @beta
|
|
4286
4455
|
* @remarks
|
|
4287
4456
|
* Whether the entity is in the swimming state. For example, a
|
|
4288
4457
|
* player using the swim action or a fish in water.
|
|
@@ -4301,7 +4470,6 @@ export class Entity {
|
|
|
4301
4470
|
*/
|
|
4302
4471
|
readonly lifetimeState: EntityLifetimeState;
|
|
4303
4472
|
/**
|
|
4304
|
-
* @beta
|
|
4305
4473
|
* @remarks
|
|
4306
4474
|
* Current location of the entity.
|
|
4307
4475
|
*
|
|
@@ -4309,7 +4477,6 @@ export class Entity {
|
|
|
4309
4477
|
*/
|
|
4310
4478
|
readonly location: Vector3;
|
|
4311
4479
|
/**
|
|
4312
|
-
* @beta
|
|
4313
4480
|
* @remarks
|
|
4314
4481
|
* Given name of the entity.
|
|
4315
4482
|
*
|
|
@@ -4318,7 +4485,6 @@ export class Entity {
|
|
|
4318
4485
|
*/
|
|
4319
4486
|
nameTag: string;
|
|
4320
4487
|
/**
|
|
4321
|
-
* @beta
|
|
4322
4488
|
* @remarks
|
|
4323
4489
|
* Returns a scoreboard identity that represents this entity.
|
|
4324
4490
|
* Will remain valid when the entity is killed.
|
|
@@ -4329,7 +4495,8 @@ export class Entity {
|
|
|
4329
4495
|
* @beta
|
|
4330
4496
|
* @remarks
|
|
4331
4497
|
* Retrieves or sets an entity that is used as the target of
|
|
4332
|
-
* AI-related behaviors, like attacking.
|
|
4498
|
+
* AI-related behaviors, like attacking. If the entity
|
|
4499
|
+
* currently has no target returns undefined.
|
|
4333
4500
|
*
|
|
4334
4501
|
* @throws This property can throw when used.
|
|
4335
4502
|
*/
|
|
@@ -4343,7 +4510,6 @@ export class Entity {
|
|
|
4343
4510
|
*/
|
|
4344
4511
|
readonly typeId: string;
|
|
4345
4512
|
/**
|
|
4346
|
-
* @beta
|
|
4347
4513
|
* @remarks
|
|
4348
4514
|
* Adds or updates an effect, like poison, to the entity.
|
|
4349
4515
|
*
|
|
@@ -4402,7 +4568,6 @@ export class Entity {
|
|
|
4402
4568
|
*/
|
|
4403
4569
|
addEffect(effectType: EffectType | string, duration: number, options?: EntityEffectOptions): void;
|
|
4404
4570
|
/**
|
|
4405
|
-
* @beta
|
|
4406
4571
|
* @remarks
|
|
4407
4572
|
* Adds a specified tag to an entity.
|
|
4408
4573
|
*
|
|
@@ -4437,7 +4602,6 @@ export class Entity {
|
|
|
4437
4602
|
*/
|
|
4438
4603
|
addTag(tag: string): boolean;
|
|
4439
4604
|
/**
|
|
4440
|
-
* @beta
|
|
4441
4605
|
* @remarks
|
|
4442
4606
|
* Applies a set of damage to an entity.
|
|
4443
4607
|
*
|
|
@@ -4470,7 +4634,6 @@ export class Entity {
|
|
|
4470
4634
|
*/
|
|
4471
4635
|
applyDamage(amount: number, options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions): boolean;
|
|
4472
4636
|
/**
|
|
4473
|
-
* @beta
|
|
4474
4637
|
* @remarks
|
|
4475
4638
|
* Applies impulse vector to the current velocity of the
|
|
4476
4639
|
* entity.
|
|
@@ -4492,7 +4655,6 @@ export class Entity {
|
|
|
4492
4655
|
*/
|
|
4493
4656
|
applyImpulse(vector: Vector3): void;
|
|
4494
4657
|
/**
|
|
4495
|
-
* @beta
|
|
4496
4658
|
* @remarks
|
|
4497
4659
|
* Applies impulse vector to the current velocity of the
|
|
4498
4660
|
* entity.
|
|
@@ -4533,7 +4695,6 @@ export class Entity {
|
|
|
4533
4695
|
*/
|
|
4534
4696
|
clearDynamicProperties(): void;
|
|
4535
4697
|
/**
|
|
4536
|
-
* @beta
|
|
4537
4698
|
* @remarks
|
|
4538
4699
|
* Sets the current velocity of the Entity to zero. Note that
|
|
4539
4700
|
* this method may not have an impact on Players.
|
|
@@ -4597,7 +4758,6 @@ export class Entity {
|
|
|
4597
4758
|
*/
|
|
4598
4759
|
extinguishFire(useEffects?: boolean): boolean;
|
|
4599
4760
|
/**
|
|
4600
|
-
* @beta
|
|
4601
4761
|
* @remarks
|
|
4602
4762
|
* Returns the first intersecting block from the direction that
|
|
4603
4763
|
* this entity is looking at.
|
|
@@ -4611,23 +4771,21 @@ export class Entity {
|
|
|
4611
4771
|
*/
|
|
4612
4772
|
getBlockFromViewDirection(options?: BlockRaycastOptions): BlockRaycastHit | undefined;
|
|
4613
4773
|
/**
|
|
4614
|
-
* @beta
|
|
4615
4774
|
* @remarks
|
|
4616
4775
|
* Gets a component (that represents additional capabilities)
|
|
4617
4776
|
* for an entity.
|
|
4618
4777
|
*
|
|
4619
4778
|
* @param componentId
|
|
4620
|
-
* The identifier of the component (e.g., 'minecraft:
|
|
4621
|
-
*
|
|
4622
|
-
*
|
|
4623
|
-
*
|
|
4779
|
+
* The identifier of the component (e.g., 'minecraft:health').
|
|
4780
|
+
* If no namespace prefix is specified, 'minecraft:' is
|
|
4781
|
+
* assumed. Available component IDs can be found as part of the
|
|
4782
|
+
* {@link @minecraft/server.EntityComponentTypes} enum.
|
|
4624
4783
|
* @returns
|
|
4625
4784
|
* Returns the component if it exists on the entity, otherwise
|
|
4626
4785
|
* undefined.
|
|
4627
4786
|
*/
|
|
4628
4787
|
getComponent(componentId: string): EntityComponent | undefined;
|
|
4629
4788
|
/**
|
|
4630
|
-
* @beta
|
|
4631
4789
|
* @remarks
|
|
4632
4790
|
* Returns all components that are both present on this entity
|
|
4633
4791
|
* and supported by the API.
|
|
@@ -4661,7 +4819,6 @@ export class Entity {
|
|
|
4661
4819
|
*/
|
|
4662
4820
|
getDynamicPropertyTotalByteCount(): number;
|
|
4663
4821
|
/**
|
|
4664
|
-
* @beta
|
|
4665
4822
|
* @remarks
|
|
4666
4823
|
* Returns the effect for the specified EffectType on the
|
|
4667
4824
|
* entity, undefined if the effect is not present, or throws an
|
|
@@ -4677,7 +4834,6 @@ export class Entity {
|
|
|
4677
4834
|
*/
|
|
4678
4835
|
getEffect(effectType: EffectType | string): Effect | undefined;
|
|
4679
4836
|
/**
|
|
4680
|
-
* @beta
|
|
4681
4837
|
* @remarks
|
|
4682
4838
|
* Returns a set of effects applied to this entity.
|
|
4683
4839
|
*
|
|
@@ -4687,7 +4843,6 @@ export class Entity {
|
|
|
4687
4843
|
*/
|
|
4688
4844
|
getEffects(): Effect[];
|
|
4689
4845
|
/**
|
|
4690
|
-
* @beta
|
|
4691
4846
|
* @remarks
|
|
4692
4847
|
* Gets the entities that this entity is looking at by
|
|
4693
4848
|
* performing a ray cast from the view of this entity.
|
|
@@ -4701,7 +4856,6 @@ export class Entity {
|
|
|
4701
4856
|
*/
|
|
4702
4857
|
getEntitiesFromViewDirection(options?: EntityRaycastOptions): EntityRaycastHit[];
|
|
4703
4858
|
/**
|
|
4704
|
-
* @beta
|
|
4705
4859
|
* @remarks
|
|
4706
4860
|
* Returns the current location of the head component of this
|
|
4707
4861
|
* entity.
|
|
@@ -4713,7 +4867,6 @@ export class Entity {
|
|
|
4713
4867
|
*/
|
|
4714
4868
|
getHeadLocation(): Vector3;
|
|
4715
4869
|
/**
|
|
4716
|
-
* @beta
|
|
4717
4870
|
* @remarks
|
|
4718
4871
|
* Gets an entity Property value. If the property was set using
|
|
4719
4872
|
* the setProperty function within the same tick, the updated
|
|
@@ -4731,7 +4884,6 @@ export class Entity {
|
|
|
4731
4884
|
*/
|
|
4732
4885
|
getProperty(identifier: string): boolean | number | string | undefined;
|
|
4733
4886
|
/**
|
|
4734
|
-
* @beta
|
|
4735
4887
|
* @remarks
|
|
4736
4888
|
* Returns the current rotation component of this entity.
|
|
4737
4889
|
*
|
|
@@ -4742,17 +4894,13 @@ export class Entity {
|
|
|
4742
4894
|
*/
|
|
4743
4895
|
getRotation(): Vector2;
|
|
4744
4896
|
/**
|
|
4745
|
-
* @beta
|
|
4746
4897
|
* @remarks
|
|
4747
|
-
* Returns all tags associated with an entity.
|
|
4748
|
-
*
|
|
4749
4898
|
* @returns
|
|
4750
|
-
* Returns
|
|
4899
|
+
* Returns all tags associated with an entity.
|
|
4751
4900
|
* @throws This function can throw errors.
|
|
4752
4901
|
*/
|
|
4753
4902
|
getTags(): string[];
|
|
4754
4903
|
/**
|
|
4755
|
-
* @beta
|
|
4756
4904
|
* @remarks
|
|
4757
4905
|
* Returns the current velocity vector of the entity.
|
|
4758
4906
|
*
|
|
@@ -4772,7 +4920,6 @@ export class Entity {
|
|
|
4772
4920
|
*/
|
|
4773
4921
|
getVelocity(): Vector3;
|
|
4774
4922
|
/**
|
|
4775
|
-
* @beta
|
|
4776
4923
|
* @remarks
|
|
4777
4924
|
* Returns the current view direction of the entity.
|
|
4778
4925
|
*
|
|
@@ -4782,7 +4929,6 @@ export class Entity {
|
|
|
4782
4929
|
*/
|
|
4783
4930
|
getViewDirection(): Vector3;
|
|
4784
4931
|
/**
|
|
4785
|
-
* @beta
|
|
4786
4932
|
* @remarks
|
|
4787
4933
|
* Returns true if the specified component is present on this
|
|
4788
4934
|
* entity.
|
|
@@ -4797,7 +4943,6 @@ export class Entity {
|
|
|
4797
4943
|
*/
|
|
4798
4944
|
hasComponent(componentId: string): boolean;
|
|
4799
4945
|
/**
|
|
4800
|
-
* @beta
|
|
4801
4946
|
* @remarks
|
|
4802
4947
|
* Returns whether an entity has a particular tag.
|
|
4803
4948
|
*
|
|
@@ -4809,7 +4954,6 @@ export class Entity {
|
|
|
4809
4954
|
*/
|
|
4810
4955
|
hasTag(tag: string): boolean;
|
|
4811
4956
|
/**
|
|
4812
|
-
* @beta
|
|
4813
4957
|
* @remarks
|
|
4814
4958
|
* Returns whether the entity can be manipulated by script. A
|
|
4815
4959
|
* Player is considered valid when it's EntityLifetimeState is
|
|
@@ -4820,7 +4964,6 @@ export class Entity {
|
|
|
4820
4964
|
*/
|
|
4821
4965
|
isValid(): boolean;
|
|
4822
4966
|
/**
|
|
4823
|
-
* @beta
|
|
4824
4967
|
* @remarks
|
|
4825
4968
|
* Kills this entity. The entity will drop loot as normal.
|
|
4826
4969
|
*
|
|
@@ -4853,6 +4996,14 @@ export class Entity {
|
|
|
4853
4996
|
kill(): boolean;
|
|
4854
4997
|
/**
|
|
4855
4998
|
* @beta
|
|
4999
|
+
* @remarks
|
|
5000
|
+
* Matches the entity against the passed in options. Uses the
|
|
5001
|
+
* location of the entity for matching if the location is not
|
|
5002
|
+
* specified in the passed in EntityQueryOptions.
|
|
5003
|
+
*
|
|
5004
|
+
* @returns
|
|
5005
|
+
* Returns true if the entity matches the criteria in the
|
|
5006
|
+
* passed in EntityQueryOptions, otherwise it returns false.
|
|
4856
5007
|
* @throws This function can throw errors.
|
|
4857
5008
|
*/
|
|
4858
5009
|
matches(options: EntityQueryOptions): boolean;
|
|
@@ -4884,7 +5035,6 @@ export class Entity {
|
|
|
4884
5035
|
*/
|
|
4885
5036
|
remove(): void;
|
|
4886
5037
|
/**
|
|
4887
|
-
* @beta
|
|
4888
5038
|
* @remarks
|
|
4889
5039
|
* Removes the specified EffectType on the entity, or returns
|
|
4890
5040
|
* false if the effect is not present.
|
|
@@ -4900,7 +5050,6 @@ export class Entity {
|
|
|
4900
5050
|
*/
|
|
4901
5051
|
removeEffect(effectType: EffectType | string): boolean;
|
|
4902
5052
|
/**
|
|
4903
|
-
* @beta
|
|
4904
5053
|
* @remarks
|
|
4905
5054
|
* Removes a specified tag from an entity.
|
|
4906
5055
|
*
|
|
@@ -4914,7 +5063,6 @@ export class Entity {
|
|
|
4914
5063
|
*/
|
|
4915
5064
|
removeTag(tag: string): boolean;
|
|
4916
5065
|
/**
|
|
4917
|
-
* @beta
|
|
4918
5066
|
* @remarks
|
|
4919
5067
|
* Resets an Entity Property back to its default value, as
|
|
4920
5068
|
* specified in the Entity's definition. This property change
|
|
@@ -4938,7 +5086,6 @@ export class Entity {
|
|
|
4938
5086
|
*/
|
|
4939
5087
|
resetProperty(identifier: string): boolean | number | string;
|
|
4940
5088
|
/**
|
|
4941
|
-
* @beta
|
|
4942
5089
|
* @remarks
|
|
4943
5090
|
* Runs a synchronous command on the entity.
|
|
4944
5091
|
*
|
|
@@ -5034,7 +5181,6 @@ export class Entity {
|
|
|
5034
5181
|
*/
|
|
5035
5182
|
setOnFire(seconds: number, useEffects?: boolean): boolean;
|
|
5036
5183
|
/**
|
|
5037
|
-
* @beta
|
|
5038
5184
|
* @remarks
|
|
5039
5185
|
* Sets an Entity Property to the provided value. This property
|
|
5040
5186
|
* change is not applied until the next tick.
|
|
@@ -5058,7 +5204,6 @@ export class Entity {
|
|
|
5058
5204
|
*/
|
|
5059
5205
|
setProperty(identifier: string, value: boolean | number | string): void;
|
|
5060
5206
|
/**
|
|
5061
|
-
* @beta
|
|
5062
5207
|
* @remarks
|
|
5063
5208
|
* Sets the main rotation of the entity.
|
|
5064
5209
|
*
|
|
@@ -5072,7 +5217,6 @@ export class Entity {
|
|
|
5072
5217
|
*/
|
|
5073
5218
|
setRotation(rotation: Vector2): void;
|
|
5074
5219
|
/**
|
|
5075
|
-
* @beta
|
|
5076
5220
|
* @remarks
|
|
5077
5221
|
* Teleports the selected entity to a new location
|
|
5078
5222
|
*
|
|
@@ -5105,7 +5249,6 @@ export class Entity {
|
|
|
5105
5249
|
*/
|
|
5106
5250
|
teleport(location: Vector3, teleportOptions?: TeleportOptions): void;
|
|
5107
5251
|
/**
|
|
5108
|
-
* @beta
|
|
5109
5252
|
* @remarks
|
|
5110
5253
|
* Triggers an entity type event. For every entity, a number of
|
|
5111
5254
|
* events are defined in an entities' definition for key entity
|
|
@@ -5129,7 +5272,6 @@ export class Entity {
|
|
|
5129
5272
|
*/
|
|
5130
5273
|
triggerEvent(eventName: string): void;
|
|
5131
5274
|
/**
|
|
5132
|
-
* @beta
|
|
5133
5275
|
* @remarks
|
|
5134
5276
|
* Attempts to try a teleport, but may not complete the
|
|
5135
5277
|
* teleport operation (for example, if there are blocks at the
|
|
@@ -5221,7 +5363,6 @@ export class EntityAgeableComponent extends EntityComponent {
|
|
|
5221
5363
|
}
|
|
5222
5364
|
|
|
5223
5365
|
/**
|
|
5224
|
-
* @beta
|
|
5225
5366
|
* This is a base abstract class for any entity component that
|
|
5226
5367
|
* centers around a number and can have a minimum, maximum, and
|
|
5227
5368
|
* default defined value.
|
|
@@ -5301,7 +5442,6 @@ export class EntityAttributeComponent extends EntityComponent {
|
|
|
5301
5442
|
}
|
|
5302
5443
|
|
|
5303
5444
|
/**
|
|
5304
|
-
* @beta
|
|
5305
5445
|
* Base class for a family of entity movement events.
|
|
5306
5446
|
*/
|
|
5307
5447
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5409,7 +5549,6 @@ export class EntityBreathableComponent extends EntityComponent {
|
|
|
5409
5549
|
}
|
|
5410
5550
|
|
|
5411
5551
|
/**
|
|
5412
|
-
* @beta
|
|
5413
5552
|
* When added, this component signifies that the entity can
|
|
5414
5553
|
* climb up ladders.
|
|
5415
5554
|
*/
|
|
@@ -5420,7 +5559,6 @@ export class EntityCanClimbComponent extends EntityComponent {
|
|
|
5420
5559
|
}
|
|
5421
5560
|
|
|
5422
5561
|
/**
|
|
5423
|
-
* @beta
|
|
5424
5562
|
* When added, this component signifies that the entity can
|
|
5425
5563
|
* fly, and the pathfinder won't be restricted to paths where a
|
|
5426
5564
|
* solid block is required underneath it.
|
|
@@ -5432,7 +5570,6 @@ export class EntityCanFlyComponent extends EntityComponent {
|
|
|
5432
5570
|
}
|
|
5433
5571
|
|
|
5434
5572
|
/**
|
|
5435
|
-
* @beta
|
|
5436
5573
|
* When added, this component signifies that the entity can
|
|
5437
5574
|
* power jump like the horse does within Minecraft.
|
|
5438
5575
|
*/
|
|
@@ -5443,7 +5580,6 @@ export class EntityCanPowerJumpComponent extends EntityComponent {
|
|
|
5443
5580
|
}
|
|
5444
5581
|
|
|
5445
5582
|
/**
|
|
5446
|
-
* @beta
|
|
5447
5583
|
* Defines the entity's color. Only works on certain entities
|
|
5448
5584
|
* that have predefined color values (e.g., sheep, llama,
|
|
5449
5585
|
* shulker).
|
|
@@ -5463,7 +5599,6 @@ export class EntityColorComponent extends EntityComponent {
|
|
|
5463
5599
|
}
|
|
5464
5600
|
|
|
5465
5601
|
/**
|
|
5466
|
-
* @beta
|
|
5467
5602
|
* Base class for downstream entity components.
|
|
5468
5603
|
*/
|
|
5469
5604
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5472,7 +5607,8 @@ export class EntityComponent extends Component {
|
|
|
5472
5607
|
/**
|
|
5473
5608
|
* @beta
|
|
5474
5609
|
* @remarks
|
|
5475
|
-
* The entity that owns this component.
|
|
5610
|
+
* The entity that owns this component. The entity will be
|
|
5611
|
+
* undefined if it has been removed.
|
|
5476
5612
|
*
|
|
5477
5613
|
*/
|
|
5478
5614
|
readonly entity: Entity;
|
|
@@ -5504,7 +5640,6 @@ export class EntityDefinitionFeedItem {
|
|
|
5504
5640
|
}
|
|
5505
5641
|
|
|
5506
5642
|
/**
|
|
5507
|
-
* @beta
|
|
5508
5643
|
* Contains data related to the death of an entity in the game.
|
|
5509
5644
|
*/
|
|
5510
5645
|
export class EntityDieAfterEvent {
|
|
@@ -5525,7 +5660,6 @@ export class EntityDieAfterEvent {
|
|
|
5525
5660
|
}
|
|
5526
5661
|
|
|
5527
5662
|
/**
|
|
5528
|
-
* @beta
|
|
5529
5663
|
* Supports registering for an event that fires after an entity
|
|
5530
5664
|
* has died.
|
|
5531
5665
|
*/
|
|
@@ -5563,7 +5697,6 @@ export class EntityDieAfterEventSignal {
|
|
|
5563
5697
|
}
|
|
5564
5698
|
|
|
5565
5699
|
/**
|
|
5566
|
-
* @beta
|
|
5567
5700
|
* Provides access to a mob's equipment slots. This component
|
|
5568
5701
|
* exists for all mob entities.
|
|
5569
5702
|
*/
|
|
@@ -5617,7 +5750,6 @@ export class EntityEquippableComponent extends EntityComponent {
|
|
|
5617
5750
|
}
|
|
5618
5751
|
|
|
5619
5752
|
/**
|
|
5620
|
-
* @beta
|
|
5621
5753
|
* When added, this component signifies that this entity
|
|
5622
5754
|
* doesn't take damage from fire.
|
|
5623
5755
|
*/
|
|
@@ -5628,7 +5760,6 @@ export class EntityFireImmuneComponent extends EntityComponent {
|
|
|
5628
5760
|
}
|
|
5629
5761
|
|
|
5630
5762
|
/**
|
|
5631
|
-
* @beta
|
|
5632
5763
|
* When added, this component signifies that this entity can
|
|
5633
5764
|
* float in liquid blocks.
|
|
5634
5765
|
*/
|
|
@@ -5639,7 +5770,6 @@ export class EntityFloatsInLiquidComponent extends EntityComponent {
|
|
|
5639
5770
|
}
|
|
5640
5771
|
|
|
5641
5772
|
/**
|
|
5642
|
-
* @beta
|
|
5643
5773
|
* Represents the flying speed of an entity.
|
|
5644
5774
|
*/
|
|
5645
5775
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5657,7 +5787,6 @@ export class EntityFlyingSpeedComponent extends EntityComponent {
|
|
|
5657
5787
|
}
|
|
5658
5788
|
|
|
5659
5789
|
/**
|
|
5660
|
-
* @beta
|
|
5661
5790
|
* Defines how much friction affects this entity.
|
|
5662
5791
|
*/
|
|
5663
5792
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5676,7 +5805,6 @@ export class EntityFrictionModifierComponent extends EntityComponent {
|
|
|
5676
5805
|
}
|
|
5677
5806
|
|
|
5678
5807
|
/**
|
|
5679
|
-
* @beta
|
|
5680
5808
|
* Sets the offset from the ground that the entity is actually
|
|
5681
5809
|
* at.
|
|
5682
5810
|
*/
|
|
@@ -5697,7 +5825,6 @@ export class EntityGroundOffsetComponent extends EntityComponent {
|
|
|
5697
5825
|
}
|
|
5698
5826
|
|
|
5699
5827
|
/**
|
|
5700
|
-
* @beta
|
|
5701
5828
|
* Defines the interactions with this entity for healing it.
|
|
5702
5829
|
*/
|
|
5703
5830
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5733,7 +5860,6 @@ export class EntityHealableComponent extends EntityComponent {
|
|
|
5733
5860
|
}
|
|
5734
5861
|
|
|
5735
5862
|
/**
|
|
5736
|
-
* @beta
|
|
5737
5863
|
* Contains information related to an entity when its health
|
|
5738
5864
|
* changes. Warning: don't change the health of an entity in
|
|
5739
5865
|
* this event, or it will cause an infinite loop!
|
|
@@ -5761,7 +5887,6 @@ export class EntityHealthChangedAfterEvent {
|
|
|
5761
5887
|
}
|
|
5762
5888
|
|
|
5763
5889
|
/**
|
|
5764
|
-
* @beta
|
|
5765
5890
|
* Manages callbacks that are connected to when the health of
|
|
5766
5891
|
* an entity changes.
|
|
5767
5892
|
*/
|
|
@@ -5792,7 +5917,6 @@ export class EntityHealthChangedAfterEventSignal {
|
|
|
5792
5917
|
}
|
|
5793
5918
|
|
|
5794
5919
|
/**
|
|
5795
|
-
* @beta
|
|
5796
5920
|
* Defines the health properties of an entity.
|
|
5797
5921
|
*/
|
|
5798
5922
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5802,7 +5926,6 @@ export class EntityHealthComponent extends EntityAttributeComponent {
|
|
|
5802
5926
|
}
|
|
5803
5927
|
|
|
5804
5928
|
/**
|
|
5805
|
-
* @beta
|
|
5806
5929
|
* Contains information related to an entity hitting a block.
|
|
5807
5930
|
*/
|
|
5808
5931
|
export class EntityHitBlockAfterEvent {
|
|
@@ -5828,7 +5951,6 @@ export class EntityHitBlockAfterEvent {
|
|
|
5828
5951
|
}
|
|
5829
5952
|
|
|
5830
5953
|
/**
|
|
5831
|
-
* @beta
|
|
5832
5954
|
* Manages callbacks that are connected to when an entity hits
|
|
5833
5955
|
* a block.
|
|
5834
5956
|
*/
|
|
@@ -5859,7 +5981,6 @@ export class EntityHitBlockAfterEventSignal {
|
|
|
5859
5981
|
}
|
|
5860
5982
|
|
|
5861
5983
|
/**
|
|
5862
|
-
* @beta
|
|
5863
5984
|
* Contains information related to an entity hitting (melee
|
|
5864
5985
|
* attacking) another entity.
|
|
5865
5986
|
*/
|
|
@@ -5880,7 +6001,6 @@ export class EntityHitEntityAfterEvent {
|
|
|
5880
6001
|
}
|
|
5881
6002
|
|
|
5882
6003
|
/**
|
|
5883
|
-
* @beta
|
|
5884
6004
|
* Manages callbacks that are connected to when an entity makes
|
|
5885
6005
|
* a melee attack on another entity.
|
|
5886
6006
|
*/
|
|
@@ -5911,7 +6031,6 @@ export class EntityHitEntityAfterEventSignal {
|
|
|
5911
6031
|
}
|
|
5912
6032
|
|
|
5913
6033
|
/**
|
|
5914
|
-
* @beta
|
|
5915
6034
|
* Contains information related to an entity getting hurt.
|
|
5916
6035
|
*/
|
|
5917
6036
|
export class EntityHurtAfterEvent {
|
|
@@ -5938,7 +6057,6 @@ export class EntityHurtAfterEvent {
|
|
|
5938
6057
|
}
|
|
5939
6058
|
|
|
5940
6059
|
/**
|
|
5941
|
-
* @beta
|
|
5942
6060
|
* Manages callbacks that are connected to when an entity is
|
|
5943
6061
|
* hurt.
|
|
5944
6062
|
*/
|
|
@@ -5967,7 +6085,6 @@ export class EntityHurtAfterEventSignal {
|
|
|
5967
6085
|
}
|
|
5968
6086
|
|
|
5969
6087
|
/**
|
|
5970
|
-
* @beta
|
|
5971
6088
|
* Defines this entity's inventory properties.
|
|
5972
6089
|
*/
|
|
5973
6090
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5991,7 +6108,8 @@ export class EntityInventoryComponent extends EntityComponent {
|
|
|
5991
6108
|
readonly canBeSiphonedFrom: boolean;
|
|
5992
6109
|
/**
|
|
5993
6110
|
* @remarks
|
|
5994
|
-
* Defines the container for this entity.
|
|
6111
|
+
* Defines the container for this entity. The container will be
|
|
6112
|
+
* undefined if the entity has been removed.
|
|
5995
6113
|
*
|
|
5996
6114
|
* @throws This property can throw when used.
|
|
5997
6115
|
*/
|
|
@@ -6029,7 +6147,6 @@ export class EntityInventoryComponent extends EntityComponent {
|
|
|
6029
6147
|
}
|
|
6030
6148
|
|
|
6031
6149
|
/**
|
|
6032
|
-
* @beta
|
|
6033
6150
|
* When added, this component signifies that this entity is a
|
|
6034
6151
|
* baby.
|
|
6035
6152
|
*/
|
|
@@ -6040,7 +6157,6 @@ export class EntityIsBabyComponent extends EntityComponent {
|
|
|
6040
6157
|
}
|
|
6041
6158
|
|
|
6042
6159
|
/**
|
|
6043
|
-
* @beta
|
|
6044
6160
|
* When added, this component signifies that this entity is
|
|
6045
6161
|
* charged.
|
|
6046
6162
|
*/
|
|
@@ -6051,7 +6167,6 @@ export class EntityIsChargedComponent extends EntityComponent {
|
|
|
6051
6167
|
}
|
|
6052
6168
|
|
|
6053
6169
|
/**
|
|
6054
|
-
* @beta
|
|
6055
6170
|
* When added, this component signifies that this entity is
|
|
6056
6171
|
* currently carrying a chest.
|
|
6057
6172
|
*/
|
|
@@ -6062,7 +6177,6 @@ export class EntityIsChestedComponent extends EntityComponent {
|
|
|
6062
6177
|
}
|
|
6063
6178
|
|
|
6064
6179
|
/**
|
|
6065
|
-
* @beta
|
|
6066
6180
|
* When added, this component signifies that dyes can be used
|
|
6067
6181
|
* on this entity to change its color.
|
|
6068
6182
|
*/
|
|
@@ -6073,7 +6187,6 @@ export class EntityIsDyeableComponent extends EntityComponent {
|
|
|
6073
6187
|
}
|
|
6074
6188
|
|
|
6075
6189
|
/**
|
|
6076
|
-
* @beta
|
|
6077
6190
|
* When added, this component signifies that this entity can
|
|
6078
6191
|
* hide from hostile mobs while invisible.
|
|
6079
6192
|
*/
|
|
@@ -6084,7 +6197,6 @@ export class EntityIsHiddenWhenInvisibleComponent extends EntityComponent {
|
|
|
6084
6197
|
}
|
|
6085
6198
|
|
|
6086
6199
|
/**
|
|
6087
|
-
* @beta
|
|
6088
6200
|
* When added, this component signifies that this entity this
|
|
6089
6201
|
* currently on fire.
|
|
6090
6202
|
*/
|
|
@@ -6095,7 +6207,6 @@ export class EntityIsIgnitedComponent extends EntityComponent {
|
|
|
6095
6207
|
}
|
|
6096
6208
|
|
|
6097
6209
|
/**
|
|
6098
|
-
* @beta
|
|
6099
6210
|
* When added, this component signifies that this entity is an
|
|
6100
6211
|
* illager captain.
|
|
6101
6212
|
*/
|
|
@@ -6106,7 +6217,6 @@ export class EntityIsIllagerCaptainComponent extends EntityComponent {
|
|
|
6106
6217
|
}
|
|
6107
6218
|
|
|
6108
6219
|
/**
|
|
6109
|
-
* @beta
|
|
6110
6220
|
* When added, this component signifies that this entity is
|
|
6111
6221
|
* currently saddled.
|
|
6112
6222
|
*/
|
|
@@ -6117,7 +6227,6 @@ export class EntityIsSaddledComponent extends EntityComponent {
|
|
|
6117
6227
|
}
|
|
6118
6228
|
|
|
6119
6229
|
/**
|
|
6120
|
-
* @beta
|
|
6121
6230
|
* When added, this component signifies that this entity is
|
|
6122
6231
|
* currently shaking.
|
|
6123
6232
|
*/
|
|
@@ -6128,7 +6237,6 @@ export class EntityIsShakingComponent extends EntityComponent {
|
|
|
6128
6237
|
}
|
|
6129
6238
|
|
|
6130
6239
|
/**
|
|
6131
|
-
* @beta
|
|
6132
6240
|
* When added, this component signifies that this entity is
|
|
6133
6241
|
* currently sheared.
|
|
6134
6242
|
*/
|
|
@@ -6139,7 +6247,6 @@ export class EntityIsShearedComponent extends EntityComponent {
|
|
|
6139
6247
|
}
|
|
6140
6248
|
|
|
6141
6249
|
/**
|
|
6142
|
-
* @beta
|
|
6143
6250
|
* When added, this component signifies that this entity can be
|
|
6144
6251
|
* stacked.
|
|
6145
6252
|
*/
|
|
@@ -6150,7 +6257,6 @@ export class EntityIsStackableComponent extends EntityComponent {
|
|
|
6150
6257
|
}
|
|
6151
6258
|
|
|
6152
6259
|
/**
|
|
6153
|
-
* @beta
|
|
6154
6260
|
* When added, this component signifies that this entity is
|
|
6155
6261
|
* currently stunned.
|
|
6156
6262
|
*/
|
|
@@ -6161,7 +6267,6 @@ export class EntityIsStunnedComponent extends EntityComponent {
|
|
|
6161
6267
|
}
|
|
6162
6268
|
|
|
6163
6269
|
/**
|
|
6164
|
-
* @beta
|
|
6165
6270
|
* When added, this component signifies that this entity is
|
|
6166
6271
|
* currently tamed.
|
|
6167
6272
|
*/
|
|
@@ -6172,7 +6277,6 @@ export class EntityIsTamedComponent extends EntityComponent {
|
|
|
6172
6277
|
}
|
|
6173
6278
|
|
|
6174
6279
|
/**
|
|
6175
|
-
* @beta
|
|
6176
6280
|
* If added onto the entity, this indicates that the entity
|
|
6177
6281
|
* represents a free-floating item in the world. Lets you
|
|
6178
6282
|
* retrieve the actual item stack contents via the itemStack
|
|
@@ -6268,7 +6372,6 @@ export class EntityLeashableComponent extends EntityComponent {
|
|
|
6268
6372
|
}
|
|
6269
6373
|
|
|
6270
6374
|
/**
|
|
6271
|
-
* @beta
|
|
6272
6375
|
* Contains data related to an entity loaded within the world.
|
|
6273
6376
|
* This could happen when an unloaded chunk is reloaded, or
|
|
6274
6377
|
* when an entity changes dimensions.
|
|
@@ -6286,7 +6389,6 @@ export class EntityLoadAfterEvent {
|
|
|
6286
6389
|
}
|
|
6287
6390
|
|
|
6288
6391
|
/**
|
|
6289
|
-
* @beta
|
|
6290
6392
|
* Registers a script-based event handler for handling what
|
|
6291
6393
|
* happens when an entity loads.
|
|
6292
6394
|
*/
|
|
@@ -6319,7 +6421,6 @@ export class EntityLoadAfterEventSignal {
|
|
|
6319
6421
|
}
|
|
6320
6422
|
|
|
6321
6423
|
/**
|
|
6322
|
-
* @beta
|
|
6323
6424
|
* Additional variant value. Can be used to further
|
|
6324
6425
|
* differentiate variants.
|
|
6325
6426
|
*/
|
|
@@ -6360,7 +6461,6 @@ export class EntityMountTamingComponent extends EntityComponent {
|
|
|
6360
6461
|
}
|
|
6361
6462
|
|
|
6362
6463
|
/**
|
|
6363
|
-
* @beta
|
|
6364
6464
|
* When added, this movement control allows the mob to swim in
|
|
6365
6465
|
* water and walk on land.
|
|
6366
6466
|
*/
|
|
@@ -6371,7 +6471,6 @@ export class EntityMovementAmphibiousComponent extends EntityBaseMovementCompone
|
|
|
6371
6471
|
}
|
|
6372
6472
|
|
|
6373
6473
|
/**
|
|
6374
|
-
* @beta
|
|
6375
6474
|
* This component accents the movement of an entity.
|
|
6376
6475
|
*/
|
|
6377
6476
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6391,7 +6490,6 @@ export class EntityMovementComponent extends EntityAttributeComponent {
|
|
|
6391
6490
|
}
|
|
6392
6491
|
|
|
6393
6492
|
/**
|
|
6394
|
-
* @beta
|
|
6395
6493
|
* When added, this move control causes the mob to fly.
|
|
6396
6494
|
*/
|
|
6397
6495
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6401,7 +6499,6 @@ export class EntityMovementFlyComponent extends EntityBaseMovementComponent {
|
|
|
6401
6499
|
}
|
|
6402
6500
|
|
|
6403
6501
|
/**
|
|
6404
|
-
* @beta
|
|
6405
6502
|
* When added, this move control allows a mob to fly, swim,
|
|
6406
6503
|
* climb, etc.
|
|
6407
6504
|
*/
|
|
@@ -6436,7 +6533,6 @@ export class EntityMovementGlideComponent extends EntityBaseMovementComponent {
|
|
|
6436
6533
|
}
|
|
6437
6534
|
|
|
6438
6535
|
/**
|
|
6439
|
-
* @beta
|
|
6440
6536
|
* When added, this move control causes the mob to hover.
|
|
6441
6537
|
*/
|
|
6442
6538
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6446,7 +6542,6 @@ export class EntityMovementHoverComponent extends EntityBaseMovementComponent {
|
|
|
6446
6542
|
}
|
|
6447
6543
|
|
|
6448
6544
|
/**
|
|
6449
|
-
* @beta
|
|
6450
6545
|
* Move control that causes the mob to jump as it moves with a
|
|
6451
6546
|
* specified delay between jumps.
|
|
6452
6547
|
*/
|
|
@@ -6457,7 +6552,6 @@ export class EntityMovementJumpComponent extends EntityBaseMovementComponent {
|
|
|
6457
6552
|
}
|
|
6458
6553
|
|
|
6459
6554
|
/**
|
|
6460
|
-
* @beta
|
|
6461
6555
|
* When added, this move control causes the mob to hop as it
|
|
6462
6556
|
* moves.
|
|
6463
6557
|
*/
|
|
@@ -6735,7 +6829,6 @@ export class EntityOnFireComponent extends EntityComponent {
|
|
|
6735
6829
|
}
|
|
6736
6830
|
|
|
6737
6831
|
/**
|
|
6738
|
-
* @beta
|
|
6739
6832
|
* Sets the distance through which the entity can push through.
|
|
6740
6833
|
*/
|
|
6741
6834
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6753,7 +6846,6 @@ export class EntityPushThroughComponent extends EntityComponent {
|
|
|
6753
6846
|
}
|
|
6754
6847
|
|
|
6755
6848
|
/**
|
|
6756
|
-
* @beta
|
|
6757
6849
|
* Data for an event that happens when an entity is removed
|
|
6758
6850
|
* from the world (for example, the entity is unloaded because
|
|
6759
6851
|
* it is not close to players.)
|
|
@@ -6776,7 +6868,6 @@ export class EntityRemoveAfterEvent {
|
|
|
6776
6868
|
}
|
|
6777
6869
|
|
|
6778
6870
|
/**
|
|
6779
|
-
* @beta
|
|
6780
6871
|
* Allows registration for an event that fires when an entity
|
|
6781
6872
|
* is removed from the game (for example, unloaded, or a few
|
|
6782
6873
|
* seconds after they are dead.)
|
|
@@ -6815,7 +6906,6 @@ export class EntityRemoveAfterEventSignal {
|
|
|
6815
6906
|
}
|
|
6816
6907
|
|
|
6817
6908
|
/**
|
|
6818
|
-
* @beta
|
|
6819
6909
|
* Data for an event that happens when an entity is being
|
|
6820
6910
|
* removed from the world (for example, the entity is unloaded
|
|
6821
6911
|
* because it is not close to players.)
|
|
@@ -6831,7 +6921,6 @@ export class EntityRemoveBeforeEvent {
|
|
|
6831
6921
|
}
|
|
6832
6922
|
|
|
6833
6923
|
/**
|
|
6834
|
-
* @beta
|
|
6835
6924
|
* Allows registration for an event that fires when an entity
|
|
6836
6925
|
* is being removed from the game (for example, unloaded, or a
|
|
6837
6926
|
* few seconds after they are dead.)
|
|
@@ -6999,7 +7088,6 @@ export class EntityRidingComponent extends EntityComponent {
|
|
|
6999
7088
|
}
|
|
7000
7089
|
|
|
7001
7090
|
/**
|
|
7002
|
-
* @beta
|
|
7003
7091
|
* Sets the entity's visual size.
|
|
7004
7092
|
*/
|
|
7005
7093
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -7017,7 +7105,6 @@ export class EntityScaleComponent extends EntityComponent {
|
|
|
7017
7105
|
}
|
|
7018
7106
|
|
|
7019
7107
|
/**
|
|
7020
|
-
* @beta
|
|
7021
7108
|
* Skin Id value. Can be used to differentiate skins, such as
|
|
7022
7109
|
* base skins for villagers.
|
|
7023
7110
|
*/
|
|
@@ -7036,7 +7123,6 @@ export class EntitySkinIdComponent extends EntityComponent {
|
|
|
7036
7123
|
}
|
|
7037
7124
|
|
|
7038
7125
|
/**
|
|
7039
|
-
* @beta
|
|
7040
7126
|
* Contains data related to an entity spawning within the
|
|
7041
7127
|
* world.
|
|
7042
7128
|
*/
|
|
@@ -7059,7 +7145,6 @@ export class EntitySpawnAfterEvent {
|
|
|
7059
7145
|
}
|
|
7060
7146
|
|
|
7061
7147
|
/**
|
|
7062
|
-
* @beta
|
|
7063
7148
|
* Registers a script-based event handler for handling what
|
|
7064
7149
|
* happens when an entity spawns.
|
|
7065
7150
|
*/
|
|
@@ -7236,7 +7321,6 @@ export class EntityUnderwaterMovementComponent extends EntityAttributeComponent
|
|
|
7236
7321
|
}
|
|
7237
7322
|
|
|
7238
7323
|
/**
|
|
7239
|
-
* @beta
|
|
7240
7324
|
* Used to differentiate the component group of a variant of an
|
|
7241
7325
|
* entity from others. (e.g. ocelot, villager).
|
|
7242
7326
|
*/
|
|
@@ -7255,7 +7339,6 @@ export class EntityVariantComponent extends EntityComponent {
|
|
|
7255
7339
|
}
|
|
7256
7340
|
|
|
7257
7341
|
/**
|
|
7258
|
-
* @beta
|
|
7259
7342
|
* When added, this component signifies that this entity wants
|
|
7260
7343
|
* to become a jockey.
|
|
7261
7344
|
*/
|
|
@@ -7375,7 +7458,6 @@ export class ExplosionBeforeEventSignal {
|
|
|
7375
7458
|
}
|
|
7376
7459
|
|
|
7377
7460
|
/**
|
|
7378
|
-
* @beta
|
|
7379
7461
|
* As part of the Healable component, represents a specific
|
|
7380
7462
|
* item that can be fed to an entity to cause health effects.
|
|
7381
7463
|
*/
|
|
@@ -7407,7 +7489,6 @@ export class FeedItem {
|
|
|
7407
7489
|
}
|
|
7408
7490
|
|
|
7409
7491
|
/**
|
|
7410
|
-
* @beta
|
|
7411
7492
|
* Represents an effect that is applied as a result of a food
|
|
7412
7493
|
* item being fed to an entity.
|
|
7413
7494
|
*/
|
|
@@ -7474,7 +7555,6 @@ export class FluidContainer {
|
|
|
7474
7555
|
}
|
|
7475
7556
|
|
|
7476
7557
|
/**
|
|
7477
|
-
* @beta
|
|
7478
7558
|
* Provides an adaptable interface for callers to subscribe to
|
|
7479
7559
|
* an event that fires when a button is pushed.
|
|
7480
7560
|
*/
|
|
@@ -7482,12 +7562,16 @@ export class IButtonPushAfterEventSignal {
|
|
|
7482
7562
|
private constructor();
|
|
7483
7563
|
/**
|
|
7484
7564
|
* @remarks
|
|
7565
|
+
* Subscribes to the event.
|
|
7566
|
+
*
|
|
7485
7567
|
* This function can't be called in read-only mode.
|
|
7486
7568
|
*
|
|
7487
7569
|
*/
|
|
7488
7570
|
subscribe(callback: (arg: ButtonPushAfterEvent) => void): (arg: ButtonPushAfterEvent) => void;
|
|
7489
7571
|
/**
|
|
7490
7572
|
* @remarks
|
|
7573
|
+
* Unsubscribes from the event.
|
|
7574
|
+
*
|
|
7491
7575
|
* This function can't be called in read-only mode.
|
|
7492
7576
|
*
|
|
7493
7577
|
* @throws This function can throw errors.
|
|
@@ -7496,7 +7580,6 @@ export class IButtonPushAfterEventSignal {
|
|
|
7496
7580
|
}
|
|
7497
7581
|
|
|
7498
7582
|
/**
|
|
7499
|
-
* @beta
|
|
7500
7583
|
* Provides an adaptable interface for callers to subscribe to
|
|
7501
7584
|
* an event that fires after a lever is used.
|
|
7502
7585
|
*/
|
|
@@ -7504,12 +7587,16 @@ export class ILeverActionAfterEventSignal {
|
|
|
7504
7587
|
private constructor();
|
|
7505
7588
|
/**
|
|
7506
7589
|
* @remarks
|
|
7590
|
+
* Subscribes to the event.
|
|
7591
|
+
*
|
|
7507
7592
|
* This function can't be called in read-only mode.
|
|
7508
7593
|
*
|
|
7509
7594
|
*/
|
|
7510
7595
|
subscribe(callback: (arg: LeverActionAfterEvent) => void): (arg: LeverActionAfterEvent) => void;
|
|
7511
7596
|
/**
|
|
7512
7597
|
* @remarks
|
|
7598
|
+
* Unsubscribes from the event.
|
|
7599
|
+
*
|
|
7513
7600
|
* This function can't be called in read-only mode.
|
|
7514
7601
|
*
|
|
7515
7602
|
* @throws This function can throw errors.
|
|
@@ -7518,7 +7605,6 @@ export class ILeverActionAfterEventSignal {
|
|
|
7518
7605
|
}
|
|
7519
7606
|
|
|
7520
7607
|
/**
|
|
7521
|
-
* @beta
|
|
7522
7608
|
* Provides an adaptable interface for callers to subscribe to
|
|
7523
7609
|
* an event that fires after a player joins a world.
|
|
7524
7610
|
*/
|
|
@@ -7526,12 +7612,16 @@ export class IPlayerJoinAfterEventSignal {
|
|
|
7526
7612
|
private constructor();
|
|
7527
7613
|
/**
|
|
7528
7614
|
* @remarks
|
|
7615
|
+
* Subscribes to the event.
|
|
7616
|
+
*
|
|
7529
7617
|
* This function can't be called in read-only mode.
|
|
7530
7618
|
*
|
|
7531
7619
|
*/
|
|
7532
7620
|
subscribe(callback: (arg: PlayerJoinAfterEvent) => void): (arg: PlayerJoinAfterEvent) => void;
|
|
7533
7621
|
/**
|
|
7534
7622
|
* @remarks
|
|
7623
|
+
* Unsubscribes from the event.
|
|
7624
|
+
*
|
|
7535
7625
|
* This function can't be called in read-only mode.
|
|
7536
7626
|
*
|
|
7537
7627
|
* @throws This function can throw errors.
|
|
@@ -7540,7 +7630,6 @@ export class IPlayerJoinAfterEventSignal {
|
|
|
7540
7630
|
}
|
|
7541
7631
|
|
|
7542
7632
|
/**
|
|
7543
|
-
* @beta
|
|
7544
7633
|
* Provides an adaptable interface for callers to subscribe to
|
|
7545
7634
|
* an event that fires after a player leaves a world.
|
|
7546
7635
|
*/
|
|
@@ -7548,12 +7637,16 @@ export class IPlayerLeaveAfterEventSignal {
|
|
|
7548
7637
|
private constructor();
|
|
7549
7638
|
/**
|
|
7550
7639
|
* @remarks
|
|
7640
|
+
* Subscribes to the event.
|
|
7641
|
+
*
|
|
7551
7642
|
* This function can't be called in read-only mode.
|
|
7552
7643
|
*
|
|
7553
7644
|
*/
|
|
7554
7645
|
subscribe(callback: (arg: PlayerLeaveAfterEvent) => void): (arg: PlayerLeaveAfterEvent) => void;
|
|
7555
7646
|
/**
|
|
7556
7647
|
* @remarks
|
|
7648
|
+
* Unsubscribes from the event.
|
|
7649
|
+
*
|
|
7557
7650
|
* This function can't be called in read-only mode.
|
|
7558
7651
|
*
|
|
7559
7652
|
* @throws This function can throw errors.
|
|
@@ -7562,7 +7655,6 @@ export class IPlayerLeaveAfterEventSignal {
|
|
|
7562
7655
|
}
|
|
7563
7656
|
|
|
7564
7657
|
/**
|
|
7565
|
-
* @beta
|
|
7566
7658
|
* Provides an adaptable interface for callers to subscribe to
|
|
7567
7659
|
* an event that fires after a player spawns.
|
|
7568
7660
|
*/
|
|
@@ -7570,12 +7662,16 @@ export class IPlayerSpawnAfterEventSignal {
|
|
|
7570
7662
|
private constructor();
|
|
7571
7663
|
/**
|
|
7572
7664
|
* @remarks
|
|
7665
|
+
* Subscribes to the event.
|
|
7666
|
+
*
|
|
7573
7667
|
* This function can't be called in read-only mode.
|
|
7574
7668
|
*
|
|
7575
7669
|
*/
|
|
7576
7670
|
subscribe(callback: (arg: PlayerSpawnAfterEvent) => void): (arg: PlayerSpawnAfterEvent) => void;
|
|
7577
7671
|
/**
|
|
7578
7672
|
* @remarks
|
|
7673
|
+
* Unsubscribes from the event.
|
|
7674
|
+
*
|
|
7579
7675
|
* This function can't be called in read-only mode.
|
|
7580
7676
|
*
|
|
7581
7677
|
* @throws This function can throw errors.
|
|
@@ -7584,7 +7680,6 @@ export class IPlayerSpawnAfterEventSignal {
|
|
|
7584
7680
|
}
|
|
7585
7681
|
|
|
7586
7682
|
/**
|
|
7587
|
-
* @beta
|
|
7588
7683
|
* Contains information related to a chargeable item completing
|
|
7589
7684
|
* being charged.
|
|
7590
7685
|
*/
|
|
@@ -7612,7 +7707,6 @@ export class ItemCompleteUseAfterEvent {
|
|
|
7612
7707
|
}
|
|
7613
7708
|
|
|
7614
7709
|
/**
|
|
7615
|
-
* @beta
|
|
7616
7710
|
* Manages callbacks that are connected to the completion of
|
|
7617
7711
|
* charging for a chargeable item.
|
|
7618
7712
|
*/
|
|
@@ -7640,7 +7734,6 @@ export class ItemCompleteUseAfterEventSignal {
|
|
|
7640
7734
|
}
|
|
7641
7735
|
|
|
7642
7736
|
/**
|
|
7643
|
-
* @beta
|
|
7644
7737
|
* Base class for item components.
|
|
7645
7738
|
*/
|
|
7646
7739
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -7918,7 +8011,6 @@ export class ItemFoodComponent extends ItemComponent {
|
|
|
7918
8011
|
}
|
|
7919
8012
|
|
|
7920
8013
|
/**
|
|
7921
|
-
* @beta
|
|
7922
8014
|
* Contains information related to a chargeable item when the
|
|
7923
8015
|
* player has finished using the item and released the build
|
|
7924
8016
|
* action.
|
|
@@ -7947,7 +8039,6 @@ export class ItemReleaseUseAfterEvent {
|
|
|
7947
8039
|
}
|
|
7948
8040
|
|
|
7949
8041
|
/**
|
|
7950
|
-
* @beta
|
|
7951
8042
|
* Manages callbacks that are connected to the releasing of
|
|
7952
8043
|
* charging for a chargeable item.
|
|
7953
8044
|
*/
|
|
@@ -7975,7 +8066,6 @@ export class ItemReleaseUseAfterEventSignal {
|
|
|
7975
8066
|
}
|
|
7976
8067
|
|
|
7977
8068
|
/**
|
|
7978
|
-
* @beta
|
|
7979
8069
|
* Defines a collection of items.
|
|
7980
8070
|
*/
|
|
7981
8071
|
export class ItemStack {
|
|
@@ -8070,7 +8160,6 @@ export class ItemStack {
|
|
|
8070
8160
|
*/
|
|
8071
8161
|
constructor(itemType: ItemType | string, amount?: number);
|
|
8072
8162
|
/**
|
|
8073
|
-
* @beta
|
|
8074
8163
|
* @remarks
|
|
8075
8164
|
* Creates an exact copy of the item stack, including any
|
|
8076
8165
|
* custom data or properties.
|
|
@@ -8080,7 +8169,6 @@ export class ItemStack {
|
|
|
8080
8169
|
*/
|
|
8081
8170
|
clone(): ItemStack;
|
|
8082
8171
|
/**
|
|
8083
|
-
* @beta
|
|
8084
8172
|
* @remarks
|
|
8085
8173
|
* Get the list of block types this item can break in Adventure
|
|
8086
8174
|
* mode.
|
|
@@ -8090,7 +8178,6 @@ export class ItemStack {
|
|
|
8090
8178
|
*/
|
|
8091
8179
|
getCanDestroy(): string[];
|
|
8092
8180
|
/**
|
|
8093
|
-
* @beta
|
|
8094
8181
|
* @remarks
|
|
8095
8182
|
* Get the list of block types this item can be placed on in
|
|
8096
8183
|
* Adventure mode.
|
|
@@ -8105,15 +8192,18 @@ export class ItemStack {
|
|
|
8105
8192
|
* for an item stack.
|
|
8106
8193
|
*
|
|
8107
8194
|
* @param componentId
|
|
8108
|
-
* The identifier of the component (e.g., 'minecraft:food')
|
|
8109
|
-
*
|
|
8110
|
-
*
|
|
8111
|
-
*
|
|
8195
|
+
* The identifier of the component (e.g., 'minecraft:food'). If
|
|
8196
|
+
* no namespace prefix is specified, 'minecraft:' is assumed.
|
|
8197
|
+
* Available component IDs can be found as part of the {@link
|
|
8198
|
+
* @minecraft/server.ItemComponentTypes} enum.
|
|
8199
|
+
* @returns
|
|
8200
|
+
* Returns the component if it exists on the item stack,
|
|
8201
|
+
* otherwise undefined.
|
|
8112
8202
|
* @example durability.ts
|
|
8113
8203
|
* ```typescript
|
|
8114
8204
|
* // Get the maximum durability of a custom sword item
|
|
8115
|
-
* const itemStack = new ItemStack(
|
|
8116
|
-
* const durability = itemStack.getComponent(
|
|
8205
|
+
* const itemStack = new ItemStack('custom:sword');
|
|
8206
|
+
* const durability = itemStack.getComponent(ItemComponentTypes.Durability);
|
|
8117
8207
|
* const maxDurability = durability.maxDurability;
|
|
8118
8208
|
* ```
|
|
8119
8209
|
*/
|
|
@@ -8126,7 +8216,6 @@ export class ItemStack {
|
|
|
8126
8216
|
*/
|
|
8127
8217
|
getComponents(): ItemComponent[];
|
|
8128
8218
|
/**
|
|
8129
|
-
* @beta
|
|
8130
8219
|
* @remarks
|
|
8131
8220
|
* Returns the lore value - a secondary display string - for an
|
|
8132
8221
|
* ItemStack.
|
|
@@ -8137,7 +8226,6 @@ export class ItemStack {
|
|
|
8137
8226
|
*/
|
|
8138
8227
|
getLore(): string[];
|
|
8139
8228
|
/**
|
|
8140
|
-
* @beta
|
|
8141
8229
|
* @remarks
|
|
8142
8230
|
* Returns a set of tags associated with this item stack.
|
|
8143
8231
|
*
|
|
@@ -8155,7 +8243,6 @@ export class ItemStack {
|
|
|
8155
8243
|
*/
|
|
8156
8244
|
hasComponent(componentId: string): boolean;
|
|
8157
8245
|
/**
|
|
8158
|
-
* @beta
|
|
8159
8246
|
* @remarks
|
|
8160
8247
|
* Checks whether this item stack has a particular tag
|
|
8161
8248
|
* associated with it.
|
|
@@ -8183,7 +8270,6 @@ export class ItemStack {
|
|
|
8183
8270
|
*/
|
|
8184
8271
|
isStackableWith(itemStack: ItemStack): boolean;
|
|
8185
8272
|
/**
|
|
8186
|
-
* @beta
|
|
8187
8273
|
* @remarks
|
|
8188
8274
|
* The list of block types this item can break in Adventure
|
|
8189
8275
|
* mode. The block names are displayed in the item's tooltip.
|
|
@@ -8204,7 +8290,6 @@ export class ItemStack {
|
|
|
8204
8290
|
*/
|
|
8205
8291
|
setCanDestroy(blockIdentifiers?: string[]): void;
|
|
8206
8292
|
/**
|
|
8207
|
-
* @beta
|
|
8208
8293
|
* @remarks
|
|
8209
8294
|
* The list of block types this item can be placed on in
|
|
8210
8295
|
* Adventure mode. This is only applicable to block items. The
|
|
@@ -8226,7 +8311,6 @@ export class ItemStack {
|
|
|
8226
8311
|
*/
|
|
8227
8312
|
setCanPlaceOn(blockIdentifiers?: string[]): void;
|
|
8228
8313
|
/**
|
|
8229
|
-
* @beta
|
|
8230
8314
|
* @remarks
|
|
8231
8315
|
* Sets the lore value - a secondary display string - for an
|
|
8232
8316
|
* ItemStack. The lore list is cleared if set to an empty
|
|
@@ -8283,7 +8367,6 @@ export class ItemStack {
|
|
|
8283
8367
|
}
|
|
8284
8368
|
|
|
8285
8369
|
/**
|
|
8286
|
-
* @beta
|
|
8287
8370
|
* Contains information related to a chargeable item starting
|
|
8288
8371
|
* to be charged.
|
|
8289
8372
|
*/
|
|
@@ -8311,7 +8394,6 @@ export class ItemStartUseAfterEvent {
|
|
|
8311
8394
|
}
|
|
8312
8395
|
|
|
8313
8396
|
/**
|
|
8314
|
-
* @beta
|
|
8315
8397
|
* Manages callbacks that are connected to the start of
|
|
8316
8398
|
* charging for a chargeable item.
|
|
8317
8399
|
*/
|
|
@@ -8339,7 +8421,6 @@ export class ItemStartUseAfterEventSignal {
|
|
|
8339
8421
|
}
|
|
8340
8422
|
|
|
8341
8423
|
/**
|
|
8342
|
-
* @beta
|
|
8343
8424
|
* Contains information related to an item being used on a
|
|
8344
8425
|
* block. This event fires when a player presses the the Use
|
|
8345
8426
|
* Item / Place Block button to successfully use an item or
|
|
@@ -8363,7 +8444,9 @@ export class ItemStartUseOnAfterEvent {
|
|
|
8363
8444
|
readonly blockFace: Direction;
|
|
8364
8445
|
/**
|
|
8365
8446
|
* @remarks
|
|
8366
|
-
* The impacted item stack that is starting to be used.
|
|
8447
|
+
* The impacted item stack that is starting to be used. Can be
|
|
8448
|
+
* undefined in some gameplay scenarios like pushing a button
|
|
8449
|
+
* with an empty hand.
|
|
8367
8450
|
*
|
|
8368
8451
|
*/
|
|
8369
8452
|
readonly itemStack: ItemStack;
|
|
@@ -8376,7 +8459,6 @@ export class ItemStartUseOnAfterEvent {
|
|
|
8376
8459
|
}
|
|
8377
8460
|
|
|
8378
8461
|
/**
|
|
8379
|
-
* @beta
|
|
8380
8462
|
* Manages callbacks that are connected to an item starting
|
|
8381
8463
|
* being used on a block event.
|
|
8382
8464
|
*/
|
|
@@ -8404,7 +8486,6 @@ export class ItemStartUseOnAfterEventSignal {
|
|
|
8404
8486
|
}
|
|
8405
8487
|
|
|
8406
8488
|
/**
|
|
8407
|
-
* @beta
|
|
8408
8489
|
* Contains information related to a chargeable item has
|
|
8409
8490
|
* finished an items use cycle, or when the player has released
|
|
8410
8491
|
* the use action with the item.
|
|
@@ -8414,6 +8495,8 @@ export class ItemStopUseAfterEvent {
|
|
|
8414
8495
|
/**
|
|
8415
8496
|
* @remarks
|
|
8416
8497
|
* The impacted item stack that is stopping being charged.
|
|
8498
|
+
* ItemStopUseAfterEvent can be called when teleporting to a
|
|
8499
|
+
* different dimension and this can be undefined.
|
|
8417
8500
|
*
|
|
8418
8501
|
*/
|
|
8419
8502
|
readonly itemStack: ItemStack;
|
|
@@ -8433,7 +8516,6 @@ export class ItemStopUseAfterEvent {
|
|
|
8433
8516
|
}
|
|
8434
8517
|
|
|
8435
8518
|
/**
|
|
8436
|
-
* @beta
|
|
8437
8519
|
* Manages callbacks that are connected to the stopping of
|
|
8438
8520
|
* charging for an item that has a registered
|
|
8439
8521
|
* minecraft:chargeable component.
|
|
@@ -8462,7 +8544,6 @@ export class ItemStopUseAfterEventSignal {
|
|
|
8462
8544
|
}
|
|
8463
8545
|
|
|
8464
8546
|
/**
|
|
8465
|
-
* @beta
|
|
8466
8547
|
* Contains information related to an item that has stopped
|
|
8467
8548
|
* being used on a block. This event fires when a player
|
|
8468
8549
|
* successfully uses an item or places a block by pressing the
|
|
@@ -8494,7 +8575,6 @@ export class ItemStopUseOnAfterEvent {
|
|
|
8494
8575
|
}
|
|
8495
8576
|
|
|
8496
8577
|
/**
|
|
8497
|
-
* @beta
|
|
8498
8578
|
* Manages callbacks that are connected to an item stops used
|
|
8499
8579
|
* on a block event.
|
|
8500
8580
|
*/
|
|
@@ -8522,7 +8602,6 @@ export class ItemStopUseOnAfterEventSignal {
|
|
|
8522
8602
|
}
|
|
8523
8603
|
|
|
8524
8604
|
/**
|
|
8525
|
-
* @beta
|
|
8526
8605
|
* Represents the type of an item - for example, Wool.
|
|
8527
8606
|
*/
|
|
8528
8607
|
export class ItemType {
|
|
@@ -8558,9 +8637,9 @@ export class ItemTypes {
|
|
|
8558
8637
|
}
|
|
8559
8638
|
|
|
8560
8639
|
/**
|
|
8561
|
-
*
|
|
8562
|
-
*
|
|
8563
|
-
*
|
|
8640
|
+
* Contains information related to an item being used on a
|
|
8641
|
+
* block. This event fires when an item used by a player
|
|
8642
|
+
* successfully triggers an entity interaction.
|
|
8564
8643
|
*/
|
|
8565
8644
|
export class ItemUseAfterEvent {
|
|
8566
8645
|
private constructor();
|
|
@@ -8579,7 +8658,6 @@ export class ItemUseAfterEvent {
|
|
|
8579
8658
|
}
|
|
8580
8659
|
|
|
8581
8660
|
/**
|
|
8582
|
-
* @beta
|
|
8583
8661
|
* Manages callbacks that are connected to an item use event.
|
|
8584
8662
|
*/
|
|
8585
8663
|
export class ItemUseAfterEventSignal {
|
|
@@ -8604,7 +8682,6 @@ export class ItemUseAfterEventSignal {
|
|
|
8604
8682
|
}
|
|
8605
8683
|
|
|
8606
8684
|
/**
|
|
8607
|
-
* @beta
|
|
8608
8685
|
* Contains information related to an item being used.
|
|
8609
8686
|
*/
|
|
8610
8687
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -8619,7 +8696,6 @@ export class ItemUseBeforeEvent extends ItemUseAfterEvent {
|
|
|
8619
8696
|
}
|
|
8620
8697
|
|
|
8621
8698
|
/**
|
|
8622
|
-
* @beta
|
|
8623
8699
|
* Manages callbacks that fire before an item is used.
|
|
8624
8700
|
*/
|
|
8625
8701
|
export class ItemUseBeforeEventSignal {
|
|
@@ -8644,10 +8720,9 @@ export class ItemUseBeforeEventSignal {
|
|
|
8644
8720
|
}
|
|
8645
8721
|
|
|
8646
8722
|
/**
|
|
8647
|
-
* @beta
|
|
8648
8723
|
* Contains information related to an item being used on a
|
|
8649
|
-
* block. This event fires when an item
|
|
8650
|
-
* a block
|
|
8724
|
+
* block. This event fires when an item used by a player
|
|
8725
|
+
* successfully triggers a block interaction.
|
|
8651
8726
|
*/
|
|
8652
8727
|
export class ItemUseOnAfterEvent {
|
|
8653
8728
|
private constructor();
|
|
@@ -8685,7 +8760,6 @@ export class ItemUseOnAfterEvent {
|
|
|
8685
8760
|
}
|
|
8686
8761
|
|
|
8687
8762
|
/**
|
|
8688
|
-
* @beta
|
|
8689
8763
|
* Manages callbacks that are connected to an item being used
|
|
8690
8764
|
* on a block event.
|
|
8691
8765
|
*/
|
|
@@ -8713,7 +8787,6 @@ export class ItemUseOnAfterEventSignal {
|
|
|
8713
8787
|
}
|
|
8714
8788
|
|
|
8715
8789
|
/**
|
|
8716
|
-
* @beta
|
|
8717
8790
|
* Contains information related to an item being used on a
|
|
8718
8791
|
* block.
|
|
8719
8792
|
*/
|
|
@@ -8729,7 +8802,6 @@ export class ItemUseOnBeforeEvent extends ItemUseOnAfterEvent {
|
|
|
8729
8802
|
}
|
|
8730
8803
|
|
|
8731
8804
|
/**
|
|
8732
|
-
* @beta
|
|
8733
8805
|
* Manages callbacks that fire before an item being used on a
|
|
8734
8806
|
* block event.
|
|
8735
8807
|
*/
|
|
@@ -8757,7 +8829,6 @@ export class ItemUseOnBeforeEventSignal {
|
|
|
8757
8829
|
}
|
|
8758
8830
|
|
|
8759
8831
|
/**
|
|
8760
|
-
* @beta
|
|
8761
8832
|
* Contains information related to changes to a lever
|
|
8762
8833
|
* activating or deactivating.
|
|
8763
8834
|
*/
|
|
@@ -8780,7 +8851,6 @@ export class LeverActionAfterEvent extends BlockEvent {
|
|
|
8780
8851
|
}
|
|
8781
8852
|
|
|
8782
8853
|
/**
|
|
8783
|
-
* @beta
|
|
8784
8854
|
* Manages callbacks that are connected to lever moves
|
|
8785
8855
|
* (activates or deactivates).
|
|
8786
8856
|
*/
|
|
@@ -8859,7 +8929,6 @@ export class MinecraftDimensionTypes {
|
|
|
8859
8929
|
}
|
|
8860
8930
|
|
|
8861
8931
|
/**
|
|
8862
|
-
* @beta
|
|
8863
8932
|
* Contains a set of additional variable values for further
|
|
8864
8933
|
* defining how rendering and animations function.
|
|
8865
8934
|
*/
|
|
@@ -9156,7 +9225,6 @@ export class PistonActivateBeforeEventSignal {
|
|
|
9156
9225
|
export class Player extends Entity {
|
|
9157
9226
|
private constructor();
|
|
9158
9227
|
/**
|
|
9159
|
-
* @beta
|
|
9160
9228
|
* @remarks
|
|
9161
9229
|
* The player's Camera.
|
|
9162
9230
|
*
|
|
@@ -9164,7 +9232,6 @@ export class Player extends Entity {
|
|
|
9164
9232
|
*/
|
|
9165
9233
|
readonly camera: Camera;
|
|
9166
9234
|
/**
|
|
9167
|
-
* @beta
|
|
9168
9235
|
* @remarks
|
|
9169
9236
|
* If true, the player is currently emoting.
|
|
9170
9237
|
*
|
|
@@ -9172,7 +9239,6 @@ export class Player extends Entity {
|
|
|
9172
9239
|
*/
|
|
9173
9240
|
readonly isEmoting: boolean;
|
|
9174
9241
|
/**
|
|
9175
|
-
* @beta
|
|
9176
9242
|
* @remarks
|
|
9177
9243
|
* Whether the player is flying. For example, in Creative or
|
|
9178
9244
|
* Spectator mode.
|
|
@@ -9181,7 +9247,6 @@ export class Player extends Entity {
|
|
|
9181
9247
|
*/
|
|
9182
9248
|
readonly isFlying: boolean;
|
|
9183
9249
|
/**
|
|
9184
|
-
* @beta
|
|
9185
9250
|
* @remarks
|
|
9186
9251
|
* Whether the player is gliding with Elytra.
|
|
9187
9252
|
*
|
|
@@ -9189,7 +9254,6 @@ export class Player extends Entity {
|
|
|
9189
9254
|
*/
|
|
9190
9255
|
readonly isGliding: boolean;
|
|
9191
9256
|
/**
|
|
9192
|
-
* @beta
|
|
9193
9257
|
* @remarks
|
|
9194
9258
|
* Whether the player is jumping. This will remain true while
|
|
9195
9259
|
* the player is holding the jump action.
|
|
@@ -9198,7 +9262,6 @@ export class Player extends Entity {
|
|
|
9198
9262
|
*/
|
|
9199
9263
|
readonly isJumping: boolean;
|
|
9200
9264
|
/**
|
|
9201
|
-
* @beta
|
|
9202
9265
|
* @remarks
|
|
9203
9266
|
* The current overall level for the player, based on their
|
|
9204
9267
|
* experience.
|
|
@@ -9214,7 +9277,6 @@ export class Player extends Entity {
|
|
|
9214
9277
|
*/
|
|
9215
9278
|
readonly name: string;
|
|
9216
9279
|
/**
|
|
9217
|
-
* @beta
|
|
9218
9280
|
* @remarks
|
|
9219
9281
|
* Contains methods for manipulating the on-screen display of a
|
|
9220
9282
|
* Player.
|
|
@@ -9232,7 +9294,6 @@ export class Player extends Entity {
|
|
|
9232
9294
|
*/
|
|
9233
9295
|
selectedSlot: number;
|
|
9234
9296
|
/**
|
|
9235
|
-
* @beta
|
|
9236
9297
|
* @remarks
|
|
9237
9298
|
* The overall total set of experience needed to achieve the
|
|
9238
9299
|
* next level for a player.
|
|
@@ -9241,7 +9302,6 @@ export class Player extends Entity {
|
|
|
9241
9302
|
*/
|
|
9242
9303
|
readonly totalXpNeededForNextLevel: number;
|
|
9243
9304
|
/**
|
|
9244
|
-
* @beta
|
|
9245
9305
|
* @remarks
|
|
9246
9306
|
* The current set of experience achieved for the player.
|
|
9247
9307
|
*
|
|
@@ -9249,7 +9309,6 @@ export class Player extends Entity {
|
|
|
9249
9309
|
*/
|
|
9250
9310
|
readonly xpEarnedAtCurrentLevel: number;
|
|
9251
9311
|
/**
|
|
9252
|
-
* @beta
|
|
9253
9312
|
* @remarks
|
|
9254
9313
|
* Adds/removes experience to/from the Player and returns the
|
|
9255
9314
|
* current experience of the Player.
|
|
@@ -9265,7 +9324,6 @@ export class Player extends Entity {
|
|
|
9265
9324
|
*/
|
|
9266
9325
|
addExperience(amount: number): number;
|
|
9267
9326
|
/**
|
|
9268
|
-
* @beta
|
|
9269
9327
|
* @remarks
|
|
9270
9328
|
* Adds/removes level to/from the Player and returns the
|
|
9271
9329
|
* current level of the Player.
|
|
@@ -9292,7 +9350,6 @@ export class Player extends Entity {
|
|
|
9292
9350
|
*/
|
|
9293
9351
|
getItemCooldown(itemCategory: string): number;
|
|
9294
9352
|
/**
|
|
9295
|
-
* @beta
|
|
9296
9353
|
* @remarks
|
|
9297
9354
|
* Gets the current spawn point of the player.
|
|
9298
9355
|
*
|
|
@@ -9300,7 +9357,6 @@ export class Player extends Entity {
|
|
|
9300
9357
|
*/
|
|
9301
9358
|
getSpawnPoint(): DimensionLocation | undefined;
|
|
9302
9359
|
/**
|
|
9303
|
-
* @beta
|
|
9304
9360
|
* @remarks
|
|
9305
9361
|
* Gets the total experience of the Player.
|
|
9306
9362
|
*
|
|
@@ -9331,7 +9387,6 @@ export class Player extends Entity {
|
|
|
9331
9387
|
*/
|
|
9332
9388
|
playMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
9333
9389
|
/**
|
|
9334
|
-
* @beta
|
|
9335
9390
|
* @remarks
|
|
9336
9391
|
* Plays a sound that only this particular player can hear.
|
|
9337
9392
|
*
|
|
@@ -9397,7 +9452,6 @@ export class Player extends Entity {
|
|
|
9397
9452
|
*/
|
|
9398
9453
|
queueMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
9399
9454
|
/**
|
|
9400
|
-
* @beta
|
|
9401
9455
|
* @remarks
|
|
9402
9456
|
* Resets the level of the player.
|
|
9403
9457
|
*
|
|
@@ -9407,7 +9461,6 @@ export class Player extends Entity {
|
|
|
9407
9461
|
*/
|
|
9408
9462
|
resetLevel(): void;
|
|
9409
9463
|
/**
|
|
9410
|
-
* @beta
|
|
9411
9464
|
* @remarks
|
|
9412
9465
|
* Sends a message to the player.
|
|
9413
9466
|
*
|
|
@@ -9469,7 +9522,6 @@ export class Player extends Entity {
|
|
|
9469
9522
|
*/
|
|
9470
9523
|
setOp(isOp: boolean): void;
|
|
9471
9524
|
/**
|
|
9472
|
-
* @beta
|
|
9473
9525
|
* @remarks
|
|
9474
9526
|
* Sets the current starting spawn point for this particular
|
|
9475
9527
|
* player.
|
|
@@ -9513,7 +9565,6 @@ export class Player extends Entity {
|
|
|
9513
9565
|
}
|
|
9514
9566
|
|
|
9515
9567
|
/**
|
|
9516
|
-
* @beta
|
|
9517
9568
|
* Contains information regarding an event after a player
|
|
9518
9569
|
* breaks a block.
|
|
9519
9570
|
*/
|
|
@@ -9550,7 +9601,6 @@ export class PlayerBreakBlockAfterEvent extends BlockEvent {
|
|
|
9550
9601
|
}
|
|
9551
9602
|
|
|
9552
9603
|
/**
|
|
9553
|
-
* @beta
|
|
9554
9604
|
* Manages callbacks that are connected to when a player breaks
|
|
9555
9605
|
* a block.
|
|
9556
9606
|
*/
|
|
@@ -9581,7 +9631,6 @@ export class PlayerBreakBlockAfterEventSignal {
|
|
|
9581
9631
|
}
|
|
9582
9632
|
|
|
9583
9633
|
/**
|
|
9584
|
-
* @beta
|
|
9585
9634
|
* Contains information regarding an event before a player
|
|
9586
9635
|
* breaks a block.
|
|
9587
9636
|
*/
|
|
@@ -9610,7 +9659,6 @@ export class PlayerBreakBlockBeforeEvent extends BlockEvent {
|
|
|
9610
9659
|
}
|
|
9611
9660
|
|
|
9612
9661
|
/**
|
|
9613
|
-
* @beta
|
|
9614
9662
|
* Manages callbacks that are connected to before a player
|
|
9615
9663
|
* breaks a block.
|
|
9616
9664
|
*/
|
|
@@ -9641,7 +9689,6 @@ export class PlayerBreakBlockBeforeEventSignal {
|
|
|
9641
9689
|
}
|
|
9642
9690
|
|
|
9643
9691
|
/**
|
|
9644
|
-
* @beta
|
|
9645
9692
|
* Contains information related to changes to a player's
|
|
9646
9693
|
* dimension having been changed.
|
|
9647
9694
|
*/
|
|
@@ -9681,7 +9728,6 @@ export class PlayerDimensionChangeAfterEvent {
|
|
|
9681
9728
|
}
|
|
9682
9729
|
|
|
9683
9730
|
/**
|
|
9684
|
-
* @beta
|
|
9685
9731
|
* Manages callbacks that are connected to successful player
|
|
9686
9732
|
* dimension changes.
|
|
9687
9733
|
*/
|
|
@@ -9751,11 +9797,16 @@ export class PlayerInteractWithBlockAfterEvent {
|
|
|
9751
9797
|
|
|
9752
9798
|
/**
|
|
9753
9799
|
* @beta
|
|
9800
|
+
* Manages callbacks that are connected to after a player
|
|
9801
|
+
* interacts with a block.
|
|
9754
9802
|
*/
|
|
9755
9803
|
export class PlayerInteractWithBlockAfterEventSignal {
|
|
9756
9804
|
private constructor();
|
|
9757
9805
|
/**
|
|
9758
9806
|
* @remarks
|
|
9807
|
+
* Adds a callback that will be called after a player interacts
|
|
9808
|
+
* with a block.
|
|
9809
|
+
*
|
|
9759
9810
|
* This function can't be called in read-only mode.
|
|
9760
9811
|
*
|
|
9761
9812
|
*/
|
|
@@ -9764,6 +9815,9 @@ export class PlayerInteractWithBlockAfterEventSignal {
|
|
|
9764
9815
|
): (arg: PlayerInteractWithBlockAfterEvent) => void;
|
|
9765
9816
|
/**
|
|
9766
9817
|
* @remarks
|
|
9818
|
+
* Removes a callback from being called after a player
|
|
9819
|
+
* interacts with a block.
|
|
9820
|
+
*
|
|
9767
9821
|
* This function can't be called in read-only mode.
|
|
9768
9822
|
*
|
|
9769
9823
|
* @throws This function can throw errors.
|
|
@@ -9820,11 +9874,16 @@ export class PlayerInteractWithBlockBeforeEvent {
|
|
|
9820
9874
|
|
|
9821
9875
|
/**
|
|
9822
9876
|
* @beta
|
|
9877
|
+
* Manages callbacks that are connected to before a player
|
|
9878
|
+
* interacts with a block.
|
|
9823
9879
|
*/
|
|
9824
9880
|
export class PlayerInteractWithBlockBeforeEventSignal {
|
|
9825
9881
|
private constructor();
|
|
9826
9882
|
/**
|
|
9827
9883
|
* @remarks
|
|
9884
|
+
* Adds a callback that will be called before a player
|
|
9885
|
+
* interacts with a block.
|
|
9886
|
+
*
|
|
9828
9887
|
* This function can't be called in read-only mode.
|
|
9829
9888
|
*
|
|
9830
9889
|
*/
|
|
@@ -9833,6 +9892,9 @@ export class PlayerInteractWithBlockBeforeEventSignal {
|
|
|
9833
9892
|
): (arg: PlayerInteractWithBlockBeforeEvent) => void;
|
|
9834
9893
|
/**
|
|
9835
9894
|
* @remarks
|
|
9895
|
+
* Removes a callback from being called before a player
|
|
9896
|
+
* interacts with a block.
|
|
9897
|
+
*
|
|
9836
9898
|
* This function can't be called in read-only mode.
|
|
9837
9899
|
*
|
|
9838
9900
|
* @throws This function can throw errors.
|
|
@@ -9870,11 +9932,16 @@ export class PlayerInteractWithEntityAfterEvent {
|
|
|
9870
9932
|
|
|
9871
9933
|
/**
|
|
9872
9934
|
* @beta
|
|
9935
|
+
* Manages callbacks that are connected to after a player
|
|
9936
|
+
* interacts with an entity.
|
|
9873
9937
|
*/
|
|
9874
9938
|
export class PlayerInteractWithEntityAfterEventSignal {
|
|
9875
9939
|
private constructor();
|
|
9876
9940
|
/**
|
|
9877
9941
|
* @remarks
|
|
9942
|
+
* Adds a callback that will be called after a player interacts
|
|
9943
|
+
* with an entity.
|
|
9944
|
+
*
|
|
9878
9945
|
* This function can't be called in read-only mode.
|
|
9879
9946
|
*
|
|
9880
9947
|
*/
|
|
@@ -9883,6 +9950,9 @@ export class PlayerInteractWithEntityAfterEventSignal {
|
|
|
9883
9950
|
): (arg: PlayerInteractWithEntityAfterEvent) => void;
|
|
9884
9951
|
/**
|
|
9885
9952
|
* @remarks
|
|
9953
|
+
* Removes a callback from being called after a player
|
|
9954
|
+
* interacts with an entity.
|
|
9955
|
+
*
|
|
9886
9956
|
* This function can't be called in read-only mode.
|
|
9887
9957
|
*
|
|
9888
9958
|
* @throws This function can throw errors.
|
|
@@ -9926,11 +9996,16 @@ export class PlayerInteractWithEntityBeforeEvent {
|
|
|
9926
9996
|
|
|
9927
9997
|
/**
|
|
9928
9998
|
* @beta
|
|
9999
|
+
* Manages callbacks that are connected to before a player
|
|
10000
|
+
* interacts with an entity.
|
|
9929
10001
|
*/
|
|
9930
10002
|
export class PlayerInteractWithEntityBeforeEventSignal {
|
|
9931
10003
|
private constructor();
|
|
9932
10004
|
/**
|
|
9933
10005
|
* @remarks
|
|
10006
|
+
* Adds a callback that will be called before a player
|
|
10007
|
+
* interacts with an entity.
|
|
10008
|
+
*
|
|
9934
10009
|
* This function can't be called in read-only mode.
|
|
9935
10010
|
*
|
|
9936
10011
|
*/
|
|
@@ -9939,6 +10014,9 @@ export class PlayerInteractWithEntityBeforeEventSignal {
|
|
|
9939
10014
|
): (arg: PlayerInteractWithEntityBeforeEvent) => void;
|
|
9940
10015
|
/**
|
|
9941
10016
|
* @remarks
|
|
10017
|
+
* Removes a callback from being called before a player
|
|
10018
|
+
* interacts with an entity.
|
|
10019
|
+
*
|
|
9942
10020
|
* This function can't be called in read-only mode.
|
|
9943
10021
|
*
|
|
9944
10022
|
* @throws This function can throw errors.
|
|
@@ -9973,7 +10051,6 @@ export class PlayerIterator implements Iterable<Player> {
|
|
|
9973
10051
|
}
|
|
9974
10052
|
|
|
9975
10053
|
/**
|
|
9976
|
-
* @beta
|
|
9977
10054
|
* Contains information regarding a player that has joined.
|
|
9978
10055
|
* See the playerSpawn event for more detailed information that
|
|
9979
10056
|
* could be returned after the first time a player has spawned
|
|
@@ -9996,7 +10073,6 @@ export class PlayerJoinAfterEvent {
|
|
|
9996
10073
|
}
|
|
9997
10074
|
|
|
9998
10075
|
/**
|
|
9999
|
-
* @beta
|
|
10000
10076
|
* Manages callbacks that are connected to a player joining the
|
|
10001
10077
|
* world.
|
|
10002
10078
|
*/
|
|
@@ -10006,7 +10082,6 @@ export class PlayerJoinAfterEventSignal extends IPlayerJoinAfterEventSignal {
|
|
|
10006
10082
|
}
|
|
10007
10083
|
|
|
10008
10084
|
/**
|
|
10009
|
-
* @beta
|
|
10010
10085
|
* Contains information regarding a player that has left the
|
|
10011
10086
|
* world.
|
|
10012
10087
|
*/
|
|
@@ -10028,7 +10103,6 @@ export class PlayerLeaveAfterEvent {
|
|
|
10028
10103
|
}
|
|
10029
10104
|
|
|
10030
10105
|
/**
|
|
10031
|
-
* @beta
|
|
10032
10106
|
* Manages callbacks that are connected to a player leaving the
|
|
10033
10107
|
* world.
|
|
10034
10108
|
*/
|
|
@@ -10066,7 +10140,6 @@ export class PlayerLeaveBeforeEventSignal {
|
|
|
10066
10140
|
}
|
|
10067
10141
|
|
|
10068
10142
|
/**
|
|
10069
|
-
* @beta
|
|
10070
10143
|
* Contains information regarding an event where a player
|
|
10071
10144
|
* places a block.
|
|
10072
10145
|
*/
|
|
@@ -10082,7 +10155,6 @@ export class PlayerPlaceBlockAfterEvent extends BlockEvent {
|
|
|
10082
10155
|
}
|
|
10083
10156
|
|
|
10084
10157
|
/**
|
|
10085
|
-
* @beta
|
|
10086
10158
|
* Manages callbacks that are connected to when a block is
|
|
10087
10159
|
* placed by a player.
|
|
10088
10160
|
*/
|
|
@@ -10185,7 +10257,6 @@ export class PlayerPlaceBlockBeforeEventSignal {
|
|
|
10185
10257
|
}
|
|
10186
10258
|
|
|
10187
10259
|
/**
|
|
10188
|
-
* @beta
|
|
10189
10260
|
* An event that contains more information about a player
|
|
10190
10261
|
* spawning.
|
|
10191
10262
|
*/
|
|
@@ -10211,7 +10282,6 @@ export class PlayerSpawnAfterEvent {
|
|
|
10211
10282
|
}
|
|
10212
10283
|
|
|
10213
10284
|
/**
|
|
10214
|
-
* @beta
|
|
10215
10285
|
* Registers an event when a player is spawned (or re-spawned
|
|
10216
10286
|
* after death) and fully ready within the world.
|
|
10217
10287
|
*/
|
|
@@ -10221,7 +10291,6 @@ export class PlayerSpawnAfterEventSignal extends IPlayerSpawnAfterEventSignal {
|
|
|
10221
10291
|
}
|
|
10222
10292
|
|
|
10223
10293
|
/**
|
|
10224
|
-
* @beta
|
|
10225
10294
|
* Contains information related to changes to a pressure plate
|
|
10226
10295
|
* pop.
|
|
10227
10296
|
*/
|
|
@@ -10245,7 +10314,6 @@ export class PressurePlatePopAfterEvent extends BlockEvent {
|
|
|
10245
10314
|
}
|
|
10246
10315
|
|
|
10247
10316
|
/**
|
|
10248
|
-
* @beta
|
|
10249
10317
|
* Manages callbacks that are connected to when a pressure
|
|
10250
10318
|
* plate is popped.
|
|
10251
10319
|
*/
|
|
@@ -10273,7 +10341,6 @@ export class PressurePlatePopAfterEventSignal {
|
|
|
10273
10341
|
}
|
|
10274
10342
|
|
|
10275
10343
|
/**
|
|
10276
|
-
* @beta
|
|
10277
10344
|
* Contains information related to changes to a pressure plate
|
|
10278
10345
|
* push.
|
|
10279
10346
|
*/
|
|
@@ -10303,7 +10370,6 @@ export class PressurePlatePushAfterEvent extends BlockEvent {
|
|
|
10303
10370
|
}
|
|
10304
10371
|
|
|
10305
10372
|
/**
|
|
10306
|
-
* @beta
|
|
10307
10373
|
* Manages callbacks that are connected to when a pressure
|
|
10308
10374
|
* plate is pushed.
|
|
10309
10375
|
*/
|
|
@@ -10331,7 +10397,6 @@ export class PressurePlatePushAfterEventSignal {
|
|
|
10331
10397
|
}
|
|
10332
10398
|
|
|
10333
10399
|
/**
|
|
10334
|
-
* @beta
|
|
10335
10400
|
* Contains information related to a projectile hitting a
|
|
10336
10401
|
* block.
|
|
10337
10402
|
*/
|
|
@@ -10379,7 +10444,6 @@ export class ProjectileHitBlockAfterEvent {
|
|
|
10379
10444
|
}
|
|
10380
10445
|
|
|
10381
10446
|
/**
|
|
10382
|
-
* @beta
|
|
10383
10447
|
* Manages callbacks that are connected to when a projectile
|
|
10384
10448
|
* hits a block.
|
|
10385
10449
|
*/
|
|
@@ -10407,7 +10471,6 @@ export class ProjectileHitBlockAfterEventSignal {
|
|
|
10407
10471
|
}
|
|
10408
10472
|
|
|
10409
10473
|
/**
|
|
10410
|
-
* @beta
|
|
10411
10474
|
* Contains information related to a projectile hitting an
|
|
10412
10475
|
* entity.
|
|
10413
10476
|
*/
|
|
@@ -10455,7 +10518,6 @@ export class ProjectileHitEntityAfterEvent {
|
|
|
10455
10518
|
}
|
|
10456
10519
|
|
|
10457
10520
|
/**
|
|
10458
|
-
* @beta
|
|
10459
10521
|
* Manages callbacks that are connected to when a projectile
|
|
10460
10522
|
* hits an entity.
|
|
10461
10523
|
*/
|
|
@@ -10483,7 +10545,6 @@ export class ProjectileHitEntityAfterEventSignal {
|
|
|
10483
10545
|
}
|
|
10484
10546
|
|
|
10485
10547
|
/**
|
|
10486
|
-
* @beta
|
|
10487
10548
|
* Contains objectives and participants for the scoreboard.
|
|
10488
10549
|
*/
|
|
10489
10550
|
export class Scoreboard {
|
|
@@ -10561,7 +10622,6 @@ export class Scoreboard {
|
|
|
10561
10622
|
}
|
|
10562
10623
|
|
|
10563
10624
|
/**
|
|
10564
|
-
* @beta
|
|
10565
10625
|
* Contains an identity of the scoreboard item.
|
|
10566
10626
|
*/
|
|
10567
10627
|
export class ScoreboardIdentity {
|
|
@@ -10602,7 +10662,6 @@ export class ScoreboardIdentity {
|
|
|
10602
10662
|
}
|
|
10603
10663
|
|
|
10604
10664
|
/**
|
|
10605
|
-
* @beta
|
|
10606
10665
|
* Contains objectives and participants for the scoreboard.
|
|
10607
10666
|
*/
|
|
10608
10667
|
export class ScoreboardObjective {
|
|
@@ -10700,7 +10759,6 @@ export class ScoreboardObjective {
|
|
|
10700
10759
|
}
|
|
10701
10760
|
|
|
10702
10761
|
/**
|
|
10703
|
-
* @beta
|
|
10704
10762
|
* Contains a pair of a scoreboard participant and its
|
|
10705
10763
|
* respective score.
|
|
10706
10764
|
*/
|
|
@@ -10721,7 +10779,6 @@ export class ScoreboardScoreInfo {
|
|
|
10721
10779
|
}
|
|
10722
10780
|
|
|
10723
10781
|
/**
|
|
10724
|
-
* @beta
|
|
10725
10782
|
* Contains information about user interface elements that are
|
|
10726
10783
|
* showing up on the screen.
|
|
10727
10784
|
*/
|
|
@@ -10810,7 +10867,6 @@ export class ScreenDisplay {
|
|
|
10810
10867
|
}
|
|
10811
10868
|
|
|
10812
10869
|
/**
|
|
10813
|
-
* @beta
|
|
10814
10870
|
* Returns additional data about a /scriptevent command
|
|
10815
10871
|
* invocation.
|
|
10816
10872
|
*/
|
|
@@ -10859,7 +10915,6 @@ export class ScriptEventCommandMessageAfterEvent {
|
|
|
10859
10915
|
}
|
|
10860
10916
|
|
|
10861
10917
|
/**
|
|
10862
|
-
* @beta
|
|
10863
10918
|
* Allows for registering an event handler that responds to
|
|
10864
10919
|
* inbound /scriptevent commands.
|
|
10865
10920
|
*/
|
|
@@ -10958,7 +11013,6 @@ export class ServerMessageAfterEventSignal {
|
|
|
10958
11013
|
export class System {
|
|
10959
11014
|
private constructor();
|
|
10960
11015
|
/**
|
|
10961
|
-
* @beta
|
|
10962
11016
|
* @remarks
|
|
10963
11017
|
* Returns a collection of after-events for system-level
|
|
10964
11018
|
* operations.
|
|
@@ -10974,14 +11028,12 @@ export class System {
|
|
|
10974
11028
|
*/
|
|
10975
11029
|
readonly beforeEvents: SystemBeforeEvents;
|
|
10976
11030
|
/**
|
|
10977
|
-
* @beta
|
|
10978
11031
|
* @remarks
|
|
10979
11032
|
* Represents the current world tick of the server.
|
|
10980
11033
|
*
|
|
10981
11034
|
*/
|
|
10982
11035
|
readonly currentTick: number;
|
|
10983
11036
|
/**
|
|
10984
|
-
* @beta
|
|
10985
11037
|
* @remarks
|
|
10986
11038
|
* Cancels the execution of a function run that was previously
|
|
10987
11039
|
* scheduled via the `run` function.
|
|
@@ -11018,7 +11070,6 @@ export class System {
|
|
|
11018
11070
|
*/
|
|
11019
11071
|
run(callback: () => void): number;
|
|
11020
11072
|
/**
|
|
11021
|
-
* @beta
|
|
11022
11073
|
* @remarks
|
|
11023
11074
|
* Runs a set of code on an interval.
|
|
11024
11075
|
*
|
|
@@ -11041,7 +11092,6 @@ export class System {
|
|
|
11041
11092
|
*/
|
|
11042
11093
|
runInterval(callback: () => void, tickInterval?: number): number;
|
|
11043
11094
|
/**
|
|
11044
|
-
* @beta
|
|
11045
11095
|
* @remarks
|
|
11046
11096
|
* Runs a set of code at a future time specified by tickDelay.
|
|
11047
11097
|
*
|
|
@@ -11058,7 +11108,6 @@ export class System {
|
|
|
11058
11108
|
}
|
|
11059
11109
|
|
|
11060
11110
|
/**
|
|
11061
|
-
* @beta
|
|
11062
11111
|
* Provides a set of events that fire within the broader
|
|
11063
11112
|
* scripting system within Minecraft.
|
|
11064
11113
|
*/
|
|
@@ -11097,7 +11146,6 @@ export class SystemBeforeEvents {
|
|
|
11097
11146
|
}
|
|
11098
11147
|
|
|
11099
11148
|
/**
|
|
11100
|
-
* @beta
|
|
11101
11149
|
* Contains information related to changes to a target block
|
|
11102
11150
|
* hit.
|
|
11103
11151
|
*/
|
|
@@ -11131,7 +11179,6 @@ export class TargetBlockHitAfterEvent extends BlockEvent {
|
|
|
11131
11179
|
}
|
|
11132
11180
|
|
|
11133
11181
|
/**
|
|
11134
|
-
* @beta
|
|
11135
11182
|
* Manages callbacks that are connected to when a target block
|
|
11136
11183
|
* is hit.
|
|
11137
11184
|
*/
|
|
@@ -11178,7 +11225,6 @@ export class Trigger {
|
|
|
11178
11225
|
}
|
|
11179
11226
|
|
|
11180
11227
|
/**
|
|
11181
|
-
* @beta
|
|
11182
11228
|
* Contains information related to changes to a trip wire trip.
|
|
11183
11229
|
*/
|
|
11184
11230
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -11199,7 +11245,6 @@ export class TripWireTripAfterEvent extends BlockEvent {
|
|
|
11199
11245
|
}
|
|
11200
11246
|
|
|
11201
11247
|
/**
|
|
11202
|
-
* @beta
|
|
11203
11248
|
* Manages callbacks that are connected to when a trip wire is
|
|
11204
11249
|
* tripped.
|
|
11205
11250
|
*/
|
|
@@ -11519,7 +11564,6 @@ export class WeatherChangeAfterEventSignal {
|
|
|
11519
11564
|
export class World {
|
|
11520
11565
|
private constructor();
|
|
11521
11566
|
/**
|
|
11522
|
-
* @beta
|
|
11523
11567
|
* @remarks
|
|
11524
11568
|
* Contains a set of events that are applicable to the entirety
|
|
11525
11569
|
* of the world. Event callbacks are called in a deferred
|
|
@@ -11528,7 +11572,6 @@ export class World {
|
|
|
11528
11572
|
*/
|
|
11529
11573
|
readonly afterEvents: WorldAfterEvents;
|
|
11530
11574
|
/**
|
|
11531
|
-
* @beta
|
|
11532
11575
|
* @remarks
|
|
11533
11576
|
* Contains a set of events that are applicable to the entirety
|
|
11534
11577
|
* of the world. Event callbacks are called immediately. Event
|
|
@@ -11537,7 +11580,6 @@ export class World {
|
|
|
11537
11580
|
*/
|
|
11538
11581
|
readonly beforeEvents: WorldBeforeEvents;
|
|
11539
11582
|
/**
|
|
11540
|
-
* @beta
|
|
11541
11583
|
* @remarks
|
|
11542
11584
|
* Returns the general global scoreboard that applies to the
|
|
11543
11585
|
* world.
|
|
@@ -11563,7 +11605,6 @@ export class World {
|
|
|
11563
11605
|
*/
|
|
11564
11606
|
clearDynamicProperties(): void;
|
|
11565
11607
|
/**
|
|
11566
|
-
* @beta
|
|
11567
11608
|
* @remarks
|
|
11568
11609
|
* Returns the absolute time since the start of the world.
|
|
11569
11610
|
*
|
|
@@ -11577,7 +11618,6 @@ export class World {
|
|
|
11577
11618
|
*/
|
|
11578
11619
|
getAllPlayers(): Player[];
|
|
11579
11620
|
/**
|
|
11580
|
-
* @beta
|
|
11581
11621
|
* @remarks
|
|
11582
11622
|
* Returns the current day.
|
|
11583
11623
|
*
|
|
@@ -11587,7 +11627,6 @@ export class World {
|
|
|
11587
11627
|
*/
|
|
11588
11628
|
getDay(): number;
|
|
11589
11629
|
/**
|
|
11590
|
-
* @beta
|
|
11591
11630
|
* @remarks
|
|
11592
11631
|
* Returns the default Overworld spawn location.
|
|
11593
11632
|
*
|
|
@@ -11699,14 +11738,12 @@ export class World {
|
|
|
11699
11738
|
*/
|
|
11700
11739
|
getEntity(id: string): Entity | undefined;
|
|
11701
11740
|
/**
|
|
11702
|
-
* @beta
|
|
11703
11741
|
* @remarks
|
|
11704
11742
|
* Returns the MoonPhase for the current time.
|
|
11705
11743
|
*
|
|
11706
11744
|
*/
|
|
11707
11745
|
getMoonPhase(): MoonPhase;
|
|
11708
11746
|
/**
|
|
11709
|
-
* @beta
|
|
11710
11747
|
* @remarks
|
|
11711
11748
|
* Returns a set of players based on a set of conditions
|
|
11712
11749
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -11721,7 +11758,6 @@ export class World {
|
|
|
11721
11758
|
*/
|
|
11722
11759
|
getPlayers(options?: EntityQueryOptions): Player[];
|
|
11723
11760
|
/**
|
|
11724
|
-
* @beta
|
|
11725
11761
|
* @remarks
|
|
11726
11762
|
* Returns the time of day.
|
|
11727
11763
|
*
|
|
@@ -11730,7 +11766,6 @@ export class World {
|
|
|
11730
11766
|
*/
|
|
11731
11767
|
getTimeOfDay(): number;
|
|
11732
11768
|
/**
|
|
11733
|
-
* @beta
|
|
11734
11769
|
* @remarks
|
|
11735
11770
|
* Plays a particular music track for all players.
|
|
11736
11771
|
*
|
|
@@ -11764,7 +11799,6 @@ export class World {
|
|
|
11764
11799
|
*/
|
|
11765
11800
|
playMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
11766
11801
|
/**
|
|
11767
|
-
* @beta
|
|
11768
11802
|
* @remarks
|
|
11769
11803
|
* Plays a sound for all players.
|
|
11770
11804
|
*
|
|
@@ -11802,7 +11836,6 @@ export class World {
|
|
|
11802
11836
|
*/
|
|
11803
11837
|
playSound(soundId: string, location: Vector3, soundOptions?: WorldSoundOptions): void;
|
|
11804
11838
|
/**
|
|
11805
|
-
* @beta
|
|
11806
11839
|
* @remarks
|
|
11807
11840
|
* Queues an additional music track for players. If a track is
|
|
11808
11841
|
* not playing, a music track will play.
|
|
@@ -11820,7 +11853,6 @@ export class World {
|
|
|
11820
11853
|
*/
|
|
11821
11854
|
queueMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
11822
11855
|
/**
|
|
11823
|
-
* @beta
|
|
11824
11856
|
* @remarks
|
|
11825
11857
|
* Sends a message to all players.
|
|
11826
11858
|
*
|
|
@@ -11859,7 +11891,6 @@ export class World {
|
|
|
11859
11891
|
*/
|
|
11860
11892
|
sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
|
|
11861
11893
|
/**
|
|
11862
|
-
* @beta
|
|
11863
11894
|
* @remarks
|
|
11864
11895
|
* Sets the world time.
|
|
11865
11896
|
*
|
|
@@ -11870,7 +11901,6 @@ export class World {
|
|
|
11870
11901
|
*/
|
|
11871
11902
|
setAbsoluteTime(absoluteTime: number): void;
|
|
11872
11903
|
/**
|
|
11873
|
-
* @beta
|
|
11874
11904
|
* @remarks
|
|
11875
11905
|
* Sets a default spawn location for all players.
|
|
11876
11906
|
*
|
|
@@ -11954,7 +11984,6 @@ export class World {
|
|
|
11954
11984
|
*/
|
|
11955
11985
|
setDynamicProperty(identifier: string, value?: boolean | number | string | Vector3): void;
|
|
11956
11986
|
/**
|
|
11957
|
-
* @beta
|
|
11958
11987
|
* @remarks
|
|
11959
11988
|
* Sets the time of day.
|
|
11960
11989
|
*
|
|
@@ -11968,7 +11997,6 @@ export class World {
|
|
|
11968
11997
|
*/
|
|
11969
11998
|
setTimeOfDay(timeOfDay: number | TimeOfDay): void;
|
|
11970
11999
|
/**
|
|
11971
|
-
* @beta
|
|
11972
12000
|
* @remarks
|
|
11973
12001
|
* Stops any music tracks from playing.
|
|
11974
12002
|
*
|
|
@@ -11979,7 +12007,6 @@ export class World {
|
|
|
11979
12007
|
}
|
|
11980
12008
|
|
|
11981
12009
|
/**
|
|
11982
|
-
* @beta
|
|
11983
12010
|
* Contains a set of events that are available across the scope
|
|
11984
12011
|
* of the World.
|
|
11985
12012
|
*/
|
|
@@ -12026,21 +12053,18 @@ export class WorldAfterEvents {
|
|
|
12026
12053
|
*/
|
|
12027
12054
|
readonly effectAdd: EffectAddAfterEventSignal;
|
|
12028
12055
|
/**
|
|
12029
|
-
* @beta
|
|
12030
12056
|
* @remarks
|
|
12031
12057
|
* This event fires when an entity dies.
|
|
12032
12058
|
*
|
|
12033
12059
|
*/
|
|
12034
12060
|
readonly entityDie: EntityDieAfterEventSignal;
|
|
12035
12061
|
/**
|
|
12036
|
-
* @beta
|
|
12037
12062
|
* @remarks
|
|
12038
12063
|
* This event fires when entity health changes in any degree.
|
|
12039
12064
|
*
|
|
12040
12065
|
*/
|
|
12041
12066
|
readonly entityHealthChanged: EntityHealthChangedAfterEventSignal;
|
|
12042
12067
|
/**
|
|
12043
|
-
* @beta
|
|
12044
12068
|
* @remarks
|
|
12045
12069
|
* This event fires when an entity hits (that is, melee
|
|
12046
12070
|
* attacks) a block.
|
|
@@ -12048,7 +12072,6 @@ export class WorldAfterEvents {
|
|
|
12048
12072
|
*/
|
|
12049
12073
|
readonly entityHitBlock: EntityHitBlockAfterEventSignal;
|
|
12050
12074
|
/**
|
|
12051
|
-
* @beta
|
|
12052
12075
|
* @remarks
|
|
12053
12076
|
* This event fires when an entity hits (that is, melee
|
|
12054
12077
|
* attacks) another entity.
|
|
@@ -12056,21 +12079,18 @@ export class WorldAfterEvents {
|
|
|
12056
12079
|
*/
|
|
12057
12080
|
readonly entityHitEntity: EntityHitEntityAfterEventSignal;
|
|
12058
12081
|
/**
|
|
12059
|
-
* @beta
|
|
12060
12082
|
* @remarks
|
|
12061
12083
|
* This event fires when an entity is hurt (takes damage).
|
|
12062
12084
|
*
|
|
12063
12085
|
*/
|
|
12064
12086
|
readonly entityHurt: EntityHurtAfterEventSignal;
|
|
12065
12087
|
/**
|
|
12066
|
-
* @beta
|
|
12067
12088
|
* @remarks
|
|
12068
12089
|
* Fires when an entity is loaded.
|
|
12069
12090
|
*
|
|
12070
12091
|
*/
|
|
12071
12092
|
readonly entityLoad: EntityLoadAfterEventSignal;
|
|
12072
12093
|
/**
|
|
12073
|
-
* @beta
|
|
12074
12094
|
* @remarks
|
|
12075
12095
|
* Fires when an entity is removed (for example, potentially
|
|
12076
12096
|
* unloaded, or removed after being killed).
|
|
@@ -12078,7 +12098,6 @@ export class WorldAfterEvents {
|
|
|
12078
12098
|
*/
|
|
12079
12099
|
readonly entityRemove: EntityRemoveAfterEventSignal;
|
|
12080
12100
|
/**
|
|
12081
|
-
* @beta
|
|
12082
12101
|
* @remarks
|
|
12083
12102
|
* This event fires when an entity is spawned.
|
|
12084
12103
|
*
|
|
@@ -12092,7 +12111,6 @@ export class WorldAfterEvents {
|
|
|
12092
12111
|
*/
|
|
12093
12112
|
readonly explosion: ExplosionAfterEventSignal;
|
|
12094
12113
|
/**
|
|
12095
|
-
* @beta
|
|
12096
12114
|
* @remarks
|
|
12097
12115
|
* This event fires when a chargeable item completes charging.
|
|
12098
12116
|
*
|
|
@@ -12109,7 +12127,6 @@ export class WorldAfterEvents {
|
|
|
12109
12127
|
*/
|
|
12110
12128
|
readonly itemDefinitionEvent: ItemDefinitionAfterEventSignal;
|
|
12111
12129
|
/**
|
|
12112
|
-
* @beta
|
|
12113
12130
|
* @remarks
|
|
12114
12131
|
* This event fires when a chargeable item is released from
|
|
12115
12132
|
* charging.
|
|
@@ -12117,14 +12134,12 @@ export class WorldAfterEvents {
|
|
|
12117
12134
|
*/
|
|
12118
12135
|
readonly itemReleaseUse: ItemReleaseUseAfterEventSignal;
|
|
12119
12136
|
/**
|
|
12120
|
-
* @beta
|
|
12121
12137
|
* @remarks
|
|
12122
12138
|
* This event fires when a chargeable item starts charging.
|
|
12123
12139
|
*
|
|
12124
12140
|
*/
|
|
12125
12141
|
readonly itemStartUse: ItemStartUseAfterEventSignal;
|
|
12126
12142
|
/**
|
|
12127
|
-
* @beta
|
|
12128
12143
|
* @remarks
|
|
12129
12144
|
* This event fires when a player successfully uses an item or
|
|
12130
12145
|
* places a block by pressing the Use Item / Place Block
|
|
@@ -12135,14 +12150,12 @@ export class WorldAfterEvents {
|
|
|
12135
12150
|
*/
|
|
12136
12151
|
readonly itemStartUseOn: ItemStartUseOnAfterEventSignal;
|
|
12137
12152
|
/**
|
|
12138
|
-
* @beta
|
|
12139
12153
|
* @remarks
|
|
12140
12154
|
* This event fires when a chargeable item stops charging.
|
|
12141
12155
|
*
|
|
12142
12156
|
*/
|
|
12143
12157
|
readonly itemStopUse: ItemStopUseAfterEventSignal;
|
|
12144
12158
|
/**
|
|
12145
|
-
* @beta
|
|
12146
12159
|
* @remarks
|
|
12147
12160
|
* This event fires when a player releases the Use Item / Place
|
|
12148
12161
|
* Block button after successfully using an item. Note: This
|
|
@@ -12151,7 +12164,6 @@ export class WorldAfterEvents {
|
|
|
12151
12164
|
*/
|
|
12152
12165
|
readonly itemStopUseOn: ItemStopUseOnAfterEventSignal;
|
|
12153
12166
|
/**
|
|
12154
|
-
* @beta
|
|
12155
12167
|
* @remarks
|
|
12156
12168
|
* This event fires when an item is successfully used by a
|
|
12157
12169
|
* player.
|
|
@@ -12159,7 +12171,6 @@ export class WorldAfterEvents {
|
|
|
12159
12171
|
*/
|
|
12160
12172
|
readonly itemUse: ItemUseAfterEventSignal;
|
|
12161
12173
|
/**
|
|
12162
|
-
* @beta
|
|
12163
12174
|
* @remarks
|
|
12164
12175
|
* This event fires when an item is used on a block by a
|
|
12165
12176
|
* player.
|
|
@@ -12188,14 +12199,12 @@ export class WorldAfterEvents {
|
|
|
12188
12199
|
*/
|
|
12189
12200
|
readonly pistonActivate: PistonActivateAfterEventSignal;
|
|
12190
12201
|
/**
|
|
12191
|
-
* @beta
|
|
12192
12202
|
* @remarks
|
|
12193
12203
|
* This event fires for a block that is broken by a player.
|
|
12194
12204
|
*
|
|
12195
12205
|
*/
|
|
12196
12206
|
readonly playerBreakBlock: PlayerBreakBlockAfterEventSignal;
|
|
12197
12207
|
/**
|
|
12198
|
-
* @beta
|
|
12199
12208
|
* @remarks
|
|
12200
12209
|
* Fires when a player moved to a different dimension.
|
|
12201
12210
|
*
|
|
@@ -12224,7 +12233,6 @@ export class WorldAfterEvents {
|
|
|
12224
12233
|
*/
|
|
12225
12234
|
readonly playerLeave: PlayerLeaveAfterEventSignal;
|
|
12226
12235
|
/**
|
|
12227
|
-
* @beta
|
|
12228
12236
|
* @remarks
|
|
12229
12237
|
* This event fires for a block that is placed by a player.
|
|
12230
12238
|
*
|
|
@@ -12239,7 +12247,6 @@ export class WorldAfterEvents {
|
|
|
12239
12247
|
*/
|
|
12240
12248
|
readonly playerSpawn: PlayerSpawnAfterEventSignal;
|
|
12241
12249
|
/**
|
|
12242
|
-
* @beta
|
|
12243
12250
|
* @remarks
|
|
12244
12251
|
* A pressure plate has popped back up (i.e., there are no
|
|
12245
12252
|
* entities on the pressure plate.)
|
|
@@ -12247,7 +12254,6 @@ export class WorldAfterEvents {
|
|
|
12247
12254
|
*/
|
|
12248
12255
|
readonly pressurePlatePop: PressurePlatePopAfterEventSignal;
|
|
12249
12256
|
/**
|
|
12250
|
-
* @beta
|
|
12251
12257
|
* @remarks
|
|
12252
12258
|
* A pressure plate has pushed (at least one entity has moved
|
|
12253
12259
|
* onto a pressure plate.)
|
|
@@ -12255,28 +12261,24 @@ export class WorldAfterEvents {
|
|
|
12255
12261
|
*/
|
|
12256
12262
|
readonly pressurePlatePush: PressurePlatePushAfterEventSignal;
|
|
12257
12263
|
/**
|
|
12258
|
-
* @beta
|
|
12259
12264
|
* @remarks
|
|
12260
12265
|
* This event fires when a projectile hits a block.
|
|
12261
12266
|
*
|
|
12262
12267
|
*/
|
|
12263
12268
|
readonly projectileHitBlock: ProjectileHitBlockAfterEventSignal;
|
|
12264
12269
|
/**
|
|
12265
|
-
* @beta
|
|
12266
12270
|
* @remarks
|
|
12267
12271
|
* This event fires when a projectile hits an entity.
|
|
12268
12272
|
*
|
|
12269
12273
|
*/
|
|
12270
12274
|
readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
|
|
12271
12275
|
/**
|
|
12272
|
-
* @beta
|
|
12273
12276
|
* @remarks
|
|
12274
12277
|
* A target block was hit.
|
|
12275
12278
|
*
|
|
12276
12279
|
*/
|
|
12277
12280
|
readonly targetBlockHit: TargetBlockHitAfterEventSignal;
|
|
12278
12281
|
/**
|
|
12279
|
-
* @beta
|
|
12280
12282
|
* @remarks
|
|
12281
12283
|
* A trip wire was tripped.
|
|
12282
12284
|
*
|
|
@@ -12302,7 +12304,6 @@ export class WorldAfterEvents {
|
|
|
12302
12304
|
}
|
|
12303
12305
|
|
|
12304
12306
|
/**
|
|
12305
|
-
* @beta
|
|
12306
12307
|
* A set of events that fire before an actual action occurs. In
|
|
12307
12308
|
* most cases, you can potentially cancel or modify the
|
|
12308
12309
|
* impending event. Note that in before events any APIs that
|
|
@@ -12329,7 +12330,6 @@ export class WorldBeforeEvents {
|
|
|
12329
12330
|
*/
|
|
12330
12331
|
readonly dataDrivenEntityTriggerEvent: DataDrivenEntityTriggerBeforeEventSignal;
|
|
12331
12332
|
/**
|
|
12332
|
-
* @beta
|
|
12333
12333
|
* @remarks
|
|
12334
12334
|
* Fires before an entity is removed from the world (for
|
|
12335
12335
|
* example, unloaded or removed after being killed.)
|
|
@@ -12375,7 +12375,6 @@ export class WorldBeforeEvents {
|
|
|
12375
12375
|
*/
|
|
12376
12376
|
readonly pistonActivate: PistonActivateBeforeEventSignal;
|
|
12377
12377
|
/**
|
|
12378
|
-
* @beta
|
|
12379
12378
|
* @remarks
|
|
12380
12379
|
* This event fires before a block is broken by a player.
|
|
12381
12380
|
*
|
|
@@ -12445,7 +12444,6 @@ export class WorldInitializeAfterEventSignal {
|
|
|
12445
12444
|
}
|
|
12446
12445
|
|
|
12447
12446
|
/**
|
|
12448
|
-
* @beta
|
|
12449
12447
|
* Contains optional parameters for registering a block event.
|
|
12450
12448
|
*/
|
|
12451
12449
|
export interface BlockEventOptions {
|
|
@@ -12480,7 +12478,6 @@ export interface BlockFillOptions {
|
|
|
12480
12478
|
}
|
|
12481
12479
|
|
|
12482
12480
|
/**
|
|
12483
|
-
* @beta
|
|
12484
12481
|
* Contains more information for events where a block is hit.
|
|
12485
12482
|
*/
|
|
12486
12483
|
export interface BlockHitInformation {
|
|
@@ -12506,7 +12503,6 @@ export interface BlockHitInformation {
|
|
|
12506
12503
|
}
|
|
12507
12504
|
|
|
12508
12505
|
/**
|
|
12509
|
-
* @beta
|
|
12510
12506
|
* Contains information for block raycast hit results.
|
|
12511
12507
|
*/
|
|
12512
12508
|
export interface BlockRaycastHit {
|
|
@@ -12532,7 +12528,6 @@ export interface BlockRaycastHit {
|
|
|
12532
12528
|
}
|
|
12533
12529
|
|
|
12534
12530
|
/**
|
|
12535
|
-
* @beta
|
|
12536
12531
|
* Contains additional options for configuring a block raycast
|
|
12537
12532
|
* query.
|
|
12538
12533
|
*/
|
|
@@ -12641,15 +12636,11 @@ export interface BoundingBox {
|
|
|
12641
12636
|
min: Vector3;
|
|
12642
12637
|
}
|
|
12643
12638
|
|
|
12644
|
-
/**
|
|
12645
|
-
* @beta
|
|
12646
|
-
*/
|
|
12647
12639
|
export interface CameraDefaultOptions {
|
|
12648
12640
|
easeOptions: CameraEaseOptions;
|
|
12649
12641
|
}
|
|
12650
12642
|
|
|
12651
12643
|
/**
|
|
12652
|
-
* @beta
|
|
12653
12644
|
* Contains options associated with a camera ease operation.
|
|
12654
12645
|
*/
|
|
12655
12646
|
export interface CameraEaseOptions {
|
|
@@ -12668,7 +12659,6 @@ export interface CameraEaseOptions {
|
|
|
12668
12659
|
}
|
|
12669
12660
|
|
|
12670
12661
|
/**
|
|
12671
|
-
* @beta
|
|
12672
12662
|
* Used to initiate a full-screen color fade.
|
|
12673
12663
|
*/
|
|
12674
12664
|
export interface CameraFadeOptions {
|
|
@@ -12687,7 +12677,6 @@ export interface CameraFadeOptions {
|
|
|
12687
12677
|
}
|
|
12688
12678
|
|
|
12689
12679
|
/**
|
|
12690
|
-
* @beta
|
|
12691
12680
|
* Contains timings for a fade transition.
|
|
12692
12681
|
*/
|
|
12693
12682
|
export interface CameraFadeTimeOptions {
|
|
@@ -12711,35 +12700,23 @@ export interface CameraFadeTimeOptions {
|
|
|
12711
12700
|
holdTime: number;
|
|
12712
12701
|
}
|
|
12713
12702
|
|
|
12714
|
-
/**
|
|
12715
|
-
* @beta
|
|
12716
|
-
*/
|
|
12717
12703
|
export interface CameraSetFacingOptions {
|
|
12718
12704
|
easeOptions?: CameraEaseOptions;
|
|
12719
12705
|
facingEntity: Entity;
|
|
12720
12706
|
location?: Vector3;
|
|
12721
12707
|
}
|
|
12722
12708
|
|
|
12723
|
-
/**
|
|
12724
|
-
* @beta
|
|
12725
|
-
*/
|
|
12726
12709
|
export interface CameraSetLocationOptions {
|
|
12727
12710
|
easeOptions?: CameraEaseOptions;
|
|
12728
12711
|
location: Vector3;
|
|
12729
12712
|
}
|
|
12730
12713
|
|
|
12731
|
-
/**
|
|
12732
|
-
* @beta
|
|
12733
|
-
*/
|
|
12734
12714
|
export interface CameraSetPosOptions {
|
|
12735
12715
|
easeOptions?: CameraEaseOptions;
|
|
12736
12716
|
facingLocation: Vector3;
|
|
12737
12717
|
location?: Vector3;
|
|
12738
12718
|
}
|
|
12739
12719
|
|
|
12740
|
-
/**
|
|
12741
|
-
* @beta
|
|
12742
|
-
*/
|
|
12743
12720
|
export interface CameraSetRotOptions {
|
|
12744
12721
|
easeOptions?: CameraEaseOptions;
|
|
12745
12722
|
location?: Vector3;
|
|
@@ -12781,7 +12758,6 @@ export interface CompoundBlockVolumeItem {
|
|
|
12781
12758
|
}
|
|
12782
12759
|
|
|
12783
12760
|
/**
|
|
12784
|
-
* @beta
|
|
12785
12761
|
* An exact coordinate within the world, including its
|
|
12786
12762
|
* dimension and location.
|
|
12787
12763
|
*/
|
|
@@ -12813,7 +12789,6 @@ export interface DimensionLocation {
|
|
|
12813
12789
|
}
|
|
12814
12790
|
|
|
12815
12791
|
/**
|
|
12816
|
-
* @beta
|
|
12817
12792
|
* Additional options for when damage has been applied via a
|
|
12818
12793
|
* projectile.
|
|
12819
12794
|
*/
|
|
@@ -12833,7 +12808,6 @@ export interface EntityApplyDamageByProjectileOptions {
|
|
|
12833
12808
|
}
|
|
12834
12809
|
|
|
12835
12810
|
/**
|
|
12836
|
-
* @beta
|
|
12837
12811
|
* Additional descriptions and metadata for a damage event.
|
|
12838
12812
|
*/
|
|
12839
12813
|
export interface EntityApplyDamageOptions {
|
|
@@ -12852,7 +12826,6 @@ export interface EntityApplyDamageOptions {
|
|
|
12852
12826
|
}
|
|
12853
12827
|
|
|
12854
12828
|
/**
|
|
12855
|
-
* @beta
|
|
12856
12829
|
* Provides information about how damage has been applied to an
|
|
12857
12830
|
* entity.
|
|
12858
12831
|
*/
|
|
@@ -12908,7 +12881,6 @@ export interface EntityDataDrivenTriggerEventOptions {
|
|
|
12908
12881
|
}
|
|
12909
12882
|
|
|
12910
12883
|
/**
|
|
12911
|
-
* @beta
|
|
12912
12884
|
* Contains additional options for entity effects.
|
|
12913
12885
|
*/
|
|
12914
12886
|
export interface EntityEffectOptions {
|
|
@@ -12927,7 +12899,6 @@ export interface EntityEffectOptions {
|
|
|
12927
12899
|
}
|
|
12928
12900
|
|
|
12929
12901
|
/**
|
|
12930
|
-
* @beta
|
|
12931
12902
|
* Contains optional parameters for registering an entity
|
|
12932
12903
|
* event.
|
|
12933
12904
|
*/
|
|
@@ -12949,7 +12920,6 @@ export interface EntityEventOptions {
|
|
|
12949
12920
|
}
|
|
12950
12921
|
|
|
12951
12922
|
/**
|
|
12952
|
-
* @beta
|
|
12953
12923
|
* Contains additional information about an entity that was
|
|
12954
12924
|
* hit.
|
|
12955
12925
|
*/
|
|
@@ -12963,7 +12933,6 @@ export interface EntityHitInformation {
|
|
|
12963
12933
|
}
|
|
12964
12934
|
|
|
12965
12935
|
/**
|
|
12966
|
-
* @beta
|
|
12967
12936
|
* Contains options for selecting entities within an area.
|
|
12968
12937
|
*/
|
|
12969
12938
|
export interface EntityQueryOptions {
|
|
@@ -13134,7 +13103,6 @@ export interface EntityQueryOptions {
|
|
|
13134
13103
|
}
|
|
13135
13104
|
|
|
13136
13105
|
/**
|
|
13137
|
-
* @beta
|
|
13138
13106
|
* Contains additional options for filtering players based on
|
|
13139
13107
|
* their score for an objective.
|
|
13140
13108
|
*/
|
|
@@ -13169,7 +13137,6 @@ export interface EntityQueryScoreOptions {
|
|
|
13169
13137
|
}
|
|
13170
13138
|
|
|
13171
13139
|
/**
|
|
13172
|
-
* @beta
|
|
13173
13140
|
* Contains information for entity raycast hit results.
|
|
13174
13141
|
*/
|
|
13175
13142
|
export interface EntityRaycastHit {
|
|
@@ -13188,7 +13155,6 @@ export interface EntityRaycastHit {
|
|
|
13188
13155
|
}
|
|
13189
13156
|
|
|
13190
13157
|
/**
|
|
13191
|
-
* @beta
|
|
13192
13158
|
* Contains additional options for an entity raycast operation.
|
|
13193
13159
|
*/
|
|
13194
13160
|
export interface EntityRaycastOptions {
|
|
@@ -13235,7 +13201,6 @@ export interface ExplosionOptions {
|
|
|
13235
13201
|
}
|
|
13236
13202
|
|
|
13237
13203
|
/**
|
|
13238
|
-
* @beta
|
|
13239
13204
|
* Additional configuration options for {@link
|
|
13240
13205
|
* World.playMusic}/{@link World.queueMusic} methods.
|
|
13241
13206
|
*/
|
|
@@ -13314,7 +13279,6 @@ export interface PlayAnimationOptions {
|
|
|
13314
13279
|
}
|
|
13315
13280
|
|
|
13316
13281
|
/**
|
|
13317
|
-
* @beta
|
|
13318
13282
|
* Additional options for how a sound plays for a player.
|
|
13319
13283
|
*/
|
|
13320
13284
|
export interface PlayerSoundOptions {
|
|
@@ -13340,7 +13304,6 @@ export interface PlayerSoundOptions {
|
|
|
13340
13304
|
}
|
|
13341
13305
|
|
|
13342
13306
|
/**
|
|
13343
|
-
* @beta
|
|
13344
13307
|
* Defines a JSON structure that is used for more flexible.
|
|
13345
13308
|
*/
|
|
13346
13309
|
export interface RawMessage {
|
|
@@ -13382,7 +13345,6 @@ export interface RawMessage {
|
|
|
13382
13345
|
}
|
|
13383
13346
|
|
|
13384
13347
|
/**
|
|
13385
|
-
* @beta
|
|
13386
13348
|
* Provides a description of a score token to use within a raw
|
|
13387
13349
|
* message.
|
|
13388
13350
|
*/
|
|
@@ -13419,7 +13381,6 @@ export interface RawText {
|
|
|
13419
13381
|
}
|
|
13420
13382
|
|
|
13421
13383
|
/**
|
|
13422
|
-
* @beta
|
|
13423
13384
|
* Represents a fully customizable color within Minecraft.
|
|
13424
13385
|
*/
|
|
13425
13386
|
export interface RGB {
|
|
@@ -13447,7 +13408,6 @@ export interface RGB {
|
|
|
13447
13408
|
}
|
|
13448
13409
|
|
|
13449
13410
|
/**
|
|
13450
|
-
* @beta
|
|
13451
13411
|
* Represents a fully customizable color within Minecraft.
|
|
13452
13412
|
*/
|
|
13453
13413
|
export interface RGBA {
|
|
@@ -13482,7 +13442,6 @@ export interface RGBA {
|
|
|
13482
13442
|
}
|
|
13483
13443
|
|
|
13484
13444
|
/**
|
|
13485
|
-
* @beta
|
|
13486
13445
|
* Contains additional options for how a scoreboard should be
|
|
13487
13446
|
* displayed within its display slot.
|
|
13488
13447
|
*/
|
|
@@ -13502,7 +13461,6 @@ export interface ScoreboardObjectiveDisplayOptions {
|
|
|
13502
13461
|
}
|
|
13503
13462
|
|
|
13504
13463
|
/**
|
|
13505
|
-
* @beta
|
|
13506
13464
|
* Contains additional options for registering a script event
|
|
13507
13465
|
* event callback.
|
|
13508
13466
|
*/
|
|
@@ -13517,7 +13475,6 @@ export interface ScriptEventMessageFilterOptions {
|
|
|
13517
13475
|
}
|
|
13518
13476
|
|
|
13519
13477
|
/**
|
|
13520
|
-
* @beta
|
|
13521
13478
|
* Contains additional options for teleporting an entity.
|
|
13522
13479
|
*/
|
|
13523
13480
|
export interface TeleportOptions {
|
|
@@ -13557,7 +13514,6 @@ export interface TeleportOptions {
|
|
|
13557
13514
|
}
|
|
13558
13515
|
|
|
13559
13516
|
/**
|
|
13560
|
-
* @beta
|
|
13561
13517
|
* Contains additional options for displaying a title and
|
|
13562
13518
|
* optional subtitle.
|
|
13563
13519
|
*/
|
|
@@ -13596,7 +13552,6 @@ export interface TitleDisplayOptions {
|
|
|
13596
13552
|
}
|
|
13597
13553
|
|
|
13598
13554
|
/**
|
|
13599
|
-
* @beta
|
|
13600
13555
|
* Represents a two-directional vector.
|
|
13601
13556
|
*/
|
|
13602
13557
|
export interface Vector2 {
|
|
@@ -13615,7 +13570,6 @@ export interface Vector2 {
|
|
|
13615
13570
|
}
|
|
13616
13571
|
|
|
13617
13572
|
/**
|
|
13618
|
-
* @beta
|
|
13619
13573
|
* Contains a description of a vector.
|
|
13620
13574
|
*/
|
|
13621
13575
|
export interface Vector3 {
|
|
@@ -13640,7 +13594,6 @@ export interface Vector3 {
|
|
|
13640
13594
|
}
|
|
13641
13595
|
|
|
13642
13596
|
/**
|
|
13643
|
-
* @beta
|
|
13644
13597
|
* Contains additional options for a world-level playSound
|
|
13645
13598
|
* occurrence.
|
|
13646
13599
|
*/
|
|
@@ -13659,32 +13612,22 @@ export interface WorldSoundOptions {
|
|
|
13659
13612
|
volume?: number;
|
|
13660
13613
|
}
|
|
13661
13614
|
|
|
13662
|
-
/**
|
|
13663
|
-
* @beta
|
|
13664
|
-
*/
|
|
13665
13615
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
13666
13616
|
export class CommandError extends Error {
|
|
13667
13617
|
private constructor();
|
|
13668
13618
|
}
|
|
13669
13619
|
|
|
13670
|
-
/**
|
|
13671
|
-
* @beta
|
|
13672
|
-
*/
|
|
13673
13620
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
13674
13621
|
export class LocationInUnloadedChunkError extends Error {
|
|
13675
13622
|
private constructor();
|
|
13676
13623
|
}
|
|
13677
13624
|
|
|
13678
|
-
/**
|
|
13679
|
-
* @beta
|
|
13680
|
-
*/
|
|
13681
13625
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
13682
13626
|
export class LocationOutOfWorldBoundariesError extends Error {
|
|
13683
13627
|
private constructor();
|
|
13684
13628
|
}
|
|
13685
13629
|
|
|
13686
13630
|
/**
|
|
13687
|
-
* @beta
|
|
13688
13631
|
* @remarks
|
|
13689
13632
|
* Holds the number of MoonPhases
|
|
13690
13633
|
*
|