@minecraft/server 1.7.0-beta.1.20.40-preview.24 → 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 +53 -436
- 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,47 +114,40 @@ 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
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
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
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
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
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
152
|
* Returns the {@link Block} to the west (x - 1) of this item.
|
|
161
153
|
*
|
|
@@ -164,26 +156,22 @@ export enum Direction {
|
|
|
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,19 +334,16 @@ export enum EasingType {
|
|
|
349
334
|
}
|
|
350
335
|
|
|
351
336
|
/**
|
|
352
|
-
* @beta
|
|
353
337
|
* Describes the source of damage from an Entity.
|
|
354
338
|
*/
|
|
355
339
|
export enum EntityDamageCause {
|
|
356
340
|
/**
|
|
357
|
-
* @beta
|
|
358
341
|
* @remarks
|
|
359
342
|
* Damage caused by a falling anvil.
|
|
360
343
|
*
|
|
361
344
|
*/
|
|
362
345
|
anvil = 'anvil',
|
|
363
346
|
/**
|
|
364
|
-
* @beta
|
|
365
347
|
* @remarks
|
|
366
348
|
* Damage caused from a non-Entity explosion. For example, an
|
|
367
349
|
* exploding bed.
|
|
@@ -370,14 +352,12 @@ export enum EntityDamageCause {
|
|
|
370
352
|
blockExplosion = 'blockExplosion',
|
|
371
353
|
campfire = 'campfire',
|
|
372
354
|
/**
|
|
373
|
-
* @beta
|
|
374
355
|
* @remarks
|
|
375
356
|
* Unused.
|
|
376
357
|
*
|
|
377
358
|
*/
|
|
378
359
|
charging = 'charging',
|
|
379
360
|
/**
|
|
380
|
-
* @beta
|
|
381
361
|
* @remarks
|
|
382
362
|
* Damage caused by physically touching an Entity or Block. For
|
|
383
363
|
* example, touching a Sweet Berry bush or Pufferfish.
|
|
@@ -385,7 +365,6 @@ export enum EntityDamageCause {
|
|
|
385
365
|
*/
|
|
386
366
|
contact = 'contact',
|
|
387
367
|
/**
|
|
388
|
-
* @beta
|
|
389
368
|
* @remarks
|
|
390
369
|
* Damage caused by an Entity being out of air and inside a
|
|
391
370
|
* liquid block.
|
|
@@ -393,14 +372,12 @@ export enum EntityDamageCause {
|
|
|
393
372
|
*/
|
|
394
373
|
drowning = 'drowning',
|
|
395
374
|
/**
|
|
396
|
-
* @beta
|
|
397
375
|
* @remarks
|
|
398
376
|
* Damage caused by an Entity attack.
|
|
399
377
|
*
|
|
400
378
|
*/
|
|
401
379
|
entityAttack = 'entityAttack',
|
|
402
380
|
/**
|
|
403
|
-
* @beta
|
|
404
381
|
* @remarks
|
|
405
382
|
* Damage caused by an Entity explosion. For example, a Creeper
|
|
406
383
|
* or Wither.
|
|
@@ -408,14 +385,12 @@ export enum EntityDamageCause {
|
|
|
408
385
|
*/
|
|
409
386
|
entityExplosion = 'entityExplosion',
|
|
410
387
|
/**
|
|
411
|
-
* @beta
|
|
412
388
|
* @remarks
|
|
413
389
|
* Damage caused by falling onto the ground.
|
|
414
390
|
*
|
|
415
391
|
*/
|
|
416
392
|
fall = 'fall',
|
|
417
393
|
/**
|
|
418
|
-
* @beta
|
|
419
394
|
* @remarks
|
|
420
395
|
* Damage caused by falling blocks. Note: Anvils and
|
|
421
396
|
* Stalactites have their own damage causes.
|
|
@@ -423,28 +398,24 @@ export enum EntityDamageCause {
|
|
|
423
398
|
*/
|
|
424
399
|
fallingBlock = 'fallingBlock',
|
|
425
400
|
/**
|
|
426
|
-
* @beta
|
|
427
401
|
* @remarks
|
|
428
402
|
* Damage caused by catching on fire.
|
|
429
403
|
*
|
|
430
404
|
*/
|
|
431
405
|
fire = 'fire',
|
|
432
406
|
/**
|
|
433
|
-
* @beta
|
|
434
407
|
* @remarks
|
|
435
408
|
* Damage caused by burning over time.
|
|
436
409
|
*
|
|
437
410
|
*/
|
|
438
411
|
fireTick = 'fireTick',
|
|
439
412
|
/**
|
|
440
|
-
* @beta
|
|
441
413
|
* @remarks
|
|
442
414
|
* Damage caused by fireworks.
|
|
443
415
|
*
|
|
444
416
|
*/
|
|
445
417
|
fireworks = 'fireworks',
|
|
446
418
|
/**
|
|
447
|
-
* @beta
|
|
448
419
|
* @remarks
|
|
449
420
|
* Damage caused by flying into a wall at high speed while
|
|
450
421
|
* gliding with Elytra.
|
|
@@ -452,28 +423,24 @@ export enum EntityDamageCause {
|
|
|
452
423
|
*/
|
|
453
424
|
flyIntoWall = 'flyIntoWall',
|
|
454
425
|
/**
|
|
455
|
-
* @beta
|
|
456
426
|
* @remarks
|
|
457
427
|
* Damage caused by staying inside a Powder Snow block.
|
|
458
428
|
*
|
|
459
429
|
*/
|
|
460
430
|
freezing = 'freezing',
|
|
461
431
|
/**
|
|
462
|
-
* @beta
|
|
463
432
|
* @remarks
|
|
464
433
|
* Damage caused by touching a Lava block.
|
|
465
434
|
*
|
|
466
435
|
*/
|
|
467
436
|
lava = 'lava',
|
|
468
437
|
/**
|
|
469
|
-
* @beta
|
|
470
438
|
* @remarks
|
|
471
439
|
* Damage caused by being struck by lightning.
|
|
472
440
|
*
|
|
473
441
|
*/
|
|
474
442
|
lightning = 'lightning',
|
|
475
443
|
/**
|
|
476
|
-
* @beta
|
|
477
444
|
* @remarks
|
|
478
445
|
* Damage caused by magical attacks. For example, Evoker Fang
|
|
479
446
|
* or Conduit Block.
|
|
@@ -481,14 +448,12 @@ export enum EntityDamageCause {
|
|
|
481
448
|
*/
|
|
482
449
|
magic = 'magic',
|
|
483
450
|
/**
|
|
484
|
-
* @beta
|
|
485
451
|
* @remarks
|
|
486
452
|
* Damage caused by touching a Magma block.
|
|
487
453
|
*
|
|
488
454
|
*/
|
|
489
455
|
magma = 'magma',
|
|
490
456
|
/**
|
|
491
|
-
* @beta
|
|
492
457
|
* @remarks
|
|
493
458
|
* Damage caused by no source. For example, from a command or
|
|
494
459
|
* script.
|
|
@@ -496,7 +461,6 @@ export enum EntityDamageCause {
|
|
|
496
461
|
*/
|
|
497
462
|
none = 'none',
|
|
498
463
|
/**
|
|
499
|
-
* @beta
|
|
500
464
|
* @remarks
|
|
501
465
|
* Damage caused by an indirect source. For example, setting a
|
|
502
466
|
* mob's health to 0 in a behavior pack.
|
|
@@ -504,14 +468,12 @@ export enum EntityDamageCause {
|
|
|
504
468
|
*/
|
|
505
469
|
override = 'override',
|
|
506
470
|
/**
|
|
507
|
-
* @beta
|
|
508
471
|
* @remarks
|
|
509
472
|
* Damage caused by a Piston.
|
|
510
473
|
*
|
|
511
474
|
*/
|
|
512
475
|
piston = 'piston',
|
|
513
476
|
/**
|
|
514
|
-
* @beta
|
|
515
477
|
* @remarks
|
|
516
478
|
* Damage caused by a projectile.
|
|
517
479
|
*
|
|
@@ -521,28 +483,24 @@ export enum EntityDamageCause {
|
|
|
521
483
|
sonicBoom = 'sonicBoom',
|
|
522
484
|
soulCampfire = 'soulCampfire',
|
|
523
485
|
/**
|
|
524
|
-
* @beta
|
|
525
486
|
* @remarks
|
|
526
487
|
* Damage caused by a falling Stalactite block.
|
|
527
488
|
*
|
|
528
489
|
*/
|
|
529
490
|
stalactite = 'stalactite',
|
|
530
491
|
/**
|
|
531
|
-
* @beta
|
|
532
492
|
* @remarks
|
|
533
493
|
* Damage caused by touching a Stalagmite block.
|
|
534
494
|
*
|
|
535
495
|
*/
|
|
536
496
|
stalagmite = 'stalagmite',
|
|
537
497
|
/**
|
|
538
|
-
* @beta
|
|
539
498
|
* @remarks
|
|
540
499
|
* Damage caused over time by having an empty hunger bar.
|
|
541
500
|
*
|
|
542
501
|
*/
|
|
543
502
|
starve = 'starve',
|
|
544
503
|
/**
|
|
545
|
-
* @beta
|
|
546
504
|
* @remarks
|
|
547
505
|
* Damage caused by an Entity being out of air and inside a
|
|
548
506
|
* non-liquid block.
|
|
@@ -550,7 +508,6 @@ export enum EntityDamageCause {
|
|
|
550
508
|
*/
|
|
551
509
|
suffocation = 'suffocation',
|
|
552
510
|
/**
|
|
553
|
-
* @beta
|
|
554
511
|
* @remarks
|
|
555
512
|
* Damage caused by an Entity killing itself. For example, from
|
|
556
513
|
* the /kill command.
|
|
@@ -558,7 +515,6 @@ export enum EntityDamageCause {
|
|
|
558
515
|
*/
|
|
559
516
|
suicide = 'suicide',
|
|
560
517
|
/**
|
|
561
|
-
* @beta
|
|
562
518
|
* @remarks
|
|
563
519
|
* Damage caused by an Entity being in an inhabitable climate.
|
|
564
520
|
* For example, a Snow Golem in a biome with a temperature
|
|
@@ -567,7 +523,6 @@ export enum EntityDamageCause {
|
|
|
567
523
|
*/
|
|
568
524
|
temperature = 'temperature',
|
|
569
525
|
/**
|
|
570
|
-
* @beta
|
|
571
526
|
* @remarks
|
|
572
527
|
* Damage caused by the Thorns armor enchantment and by the
|
|
573
528
|
* Guardian thorns effect.
|
|
@@ -575,14 +530,12 @@ export enum EntityDamageCause {
|
|
|
575
530
|
*/
|
|
576
531
|
thorns = 'thorns',
|
|
577
532
|
/**
|
|
578
|
-
* @beta
|
|
579
533
|
* @remarks
|
|
580
534
|
* Damage caused over time by falling into the void.
|
|
581
535
|
*
|
|
582
536
|
*/
|
|
583
537
|
'void' = 'void',
|
|
584
538
|
/**
|
|
585
|
-
* @beta
|
|
586
539
|
* @remarks
|
|
587
540
|
* Damage caused by the Wither effect. For example, from
|
|
588
541
|
* touching a Wither Rose.
|
|
@@ -592,12 +545,10 @@ export enum EntityDamageCause {
|
|
|
592
545
|
}
|
|
593
546
|
|
|
594
547
|
/**
|
|
595
|
-
* @beta
|
|
596
548
|
* An enumeration describing initialization cause of an entity.
|
|
597
549
|
*/
|
|
598
550
|
export enum EntityInitializationCause {
|
|
599
551
|
/**
|
|
600
|
-
* @beta
|
|
601
552
|
* @remarks
|
|
602
553
|
* Case when an entity is created as child of other entity or
|
|
603
554
|
* entities, e.g., cows making a cow or slimes making smaller
|
|
@@ -606,7 +557,6 @@ export enum EntityInitializationCause {
|
|
|
606
557
|
*/
|
|
607
558
|
Born = 'Born',
|
|
608
559
|
/**
|
|
609
|
-
* @beta
|
|
610
560
|
* @remarks
|
|
611
561
|
* Case when an entity is created by an event, e.g., Wandering
|
|
612
562
|
* trader spawning llamas.
|
|
@@ -615,14 +565,12 @@ export enum EntityInitializationCause {
|
|
|
615
565
|
Event = 'Event',
|
|
616
566
|
Loaded = 'Loaded',
|
|
617
567
|
/**
|
|
618
|
-
* @beta
|
|
619
568
|
* @remarks
|
|
620
569
|
* Case when an entity is naturally spawned in the world.
|
|
621
570
|
*
|
|
622
571
|
*/
|
|
623
572
|
Spawned = 'Spawned',
|
|
624
573
|
/**
|
|
625
|
-
* @beta
|
|
626
574
|
* @remarks
|
|
627
575
|
* Case when an entity is transformed into another entity.
|
|
628
576
|
*
|
|
@@ -656,13 +604,11 @@ export enum EntityLifetimeState {
|
|
|
656
604
|
}
|
|
657
605
|
|
|
658
606
|
/**
|
|
659
|
-
* @beta
|
|
660
607
|
* The equipment slot of the mob. This includes armor, offhand
|
|
661
608
|
* and mainhand slots.
|
|
662
609
|
*/
|
|
663
610
|
export enum EquipmentSlot {
|
|
664
611
|
/**
|
|
665
|
-
* @beta
|
|
666
612
|
* @remarks
|
|
667
613
|
* The chest slot. This slot is used to hold items such as
|
|
668
614
|
* Chestplate or Elytra.
|
|
@@ -670,7 +616,6 @@ export enum EquipmentSlot {
|
|
|
670
616
|
*/
|
|
671
617
|
Chest = 'Chest',
|
|
672
618
|
/**
|
|
673
|
-
* @beta
|
|
674
619
|
* @remarks
|
|
675
620
|
* The feet slot. This slot is used to hold items such as
|
|
676
621
|
* Boots.
|
|
@@ -678,7 +623,6 @@ export enum EquipmentSlot {
|
|
|
678
623
|
*/
|
|
679
624
|
Feet = 'Feet',
|
|
680
625
|
/**
|
|
681
|
-
* @beta
|
|
682
626
|
* @remarks
|
|
683
627
|
* The head slot. This slot is used to hold items such as
|
|
684
628
|
* Helmets or Carved Pumpkins.
|
|
@@ -686,7 +630,6 @@ export enum EquipmentSlot {
|
|
|
686
630
|
*/
|
|
687
631
|
Head = 'Head',
|
|
688
632
|
/**
|
|
689
|
-
* @beta
|
|
690
633
|
* @remarks
|
|
691
634
|
* The legs slot. This slot is used to hold items such as
|
|
692
635
|
* Leggings.
|
|
@@ -694,7 +637,6 @@ export enum EquipmentSlot {
|
|
|
694
637
|
*/
|
|
695
638
|
Legs = 'Legs',
|
|
696
639
|
/**
|
|
697
|
-
* @beta
|
|
698
640
|
* @remarks
|
|
699
641
|
* The mainhand slot. For players, the mainhand slot refers to
|
|
700
642
|
* the currently active hotbar slot.
|
|
@@ -702,7 +644,6 @@ export enum EquipmentSlot {
|
|
|
702
644
|
*/
|
|
703
645
|
Mainhand = 'Mainhand',
|
|
704
646
|
/**
|
|
705
|
-
* @beta
|
|
706
647
|
* @remarks
|
|
707
648
|
* The offhand slot. This slot is used to hold items such as
|
|
708
649
|
* shields and maps.
|
|
@@ -748,12 +689,10 @@ export enum FluidType {
|
|
|
748
689
|
}
|
|
749
690
|
|
|
750
691
|
/**
|
|
751
|
-
* @beta
|
|
752
692
|
* Represents a game mode for the current world experience.
|
|
753
693
|
*/
|
|
754
694
|
export enum GameMode {
|
|
755
695
|
/**
|
|
756
|
-
* @beta
|
|
757
696
|
* @remarks
|
|
758
697
|
* World is in a more locked-down experience, where blocks may
|
|
759
698
|
* not be manipulated.
|
|
@@ -761,7 +700,6 @@ export enum GameMode {
|
|
|
761
700
|
*/
|
|
762
701
|
adventure = 'adventure',
|
|
763
702
|
/**
|
|
764
|
-
* @beta
|
|
765
703
|
* @remarks
|
|
766
704
|
* World is in a full creative mode. In creative mode, the
|
|
767
705
|
* player has all the resources available in the item selection
|
|
@@ -774,7 +712,6 @@ export enum GameMode {
|
|
|
774
712
|
*/
|
|
775
713
|
creative = 'creative',
|
|
776
714
|
/**
|
|
777
|
-
* @beta
|
|
778
715
|
* @remarks
|
|
779
716
|
* World is in spectator mode. In spectator mode, spectators
|
|
780
717
|
* are always flying and cannot become grounded. Spectators can
|
|
@@ -787,7 +724,6 @@ export enum GameMode {
|
|
|
787
724
|
*/
|
|
788
725
|
spectator = 'spectator',
|
|
789
726
|
/**
|
|
790
|
-
* @beta
|
|
791
727
|
* @remarks
|
|
792
728
|
* World is in a survival mode, where players can take damage
|
|
793
729
|
* and entities may not be peaceful. Survival mode is where the
|
|
@@ -800,26 +736,22 @@ export enum GameMode {
|
|
|
800
736
|
}
|
|
801
737
|
|
|
802
738
|
/**
|
|
803
|
-
* @beta
|
|
804
739
|
* Describes how an an item can be moved within a container.
|
|
805
740
|
*/
|
|
806
741
|
export enum ItemLockMode {
|
|
807
742
|
/**
|
|
808
|
-
* @beta
|
|
809
743
|
* @remarks
|
|
810
744
|
* The item cannot be dropped or crafted with.
|
|
811
745
|
*
|
|
812
746
|
*/
|
|
813
747
|
inventory = 'inventory',
|
|
814
748
|
/**
|
|
815
|
-
* @beta
|
|
816
749
|
* @remarks
|
|
817
750
|
* The item has no container restrictions.
|
|
818
751
|
*
|
|
819
752
|
*/
|
|
820
753
|
none = 'none',
|
|
821
754
|
/**
|
|
822
|
-
* @beta
|
|
823
755
|
* @remarks
|
|
824
756
|
* The item cannot be moved from its slot, dropped or crafted
|
|
825
757
|
* with.
|
|
@@ -829,7 +761,6 @@ export enum ItemLockMode {
|
|
|
829
761
|
}
|
|
830
762
|
|
|
831
763
|
/**
|
|
832
|
-
* @beta
|
|
833
764
|
* Enum containing the different phases of the moon based on
|
|
834
765
|
* the current day.,Obtain the current MoonPhase using
|
|
835
766
|
* world.getMoonPhase.
|
|
@@ -842,7 +773,6 @@ export enum ItemLockMode {
|
|
|
842
773
|
*/
|
|
843
774
|
export enum MoonPhase {
|
|
844
775
|
/**
|
|
845
|
-
* @beta
|
|
846
776
|
* @remarks
|
|
847
777
|
* The brightest moon phase. During this phase, cats have a 50%
|
|
848
778
|
* chance of spawning as black cats.
|
|
@@ -850,49 +780,42 @@ export enum MoonPhase {
|
|
|
850
780
|
*/
|
|
851
781
|
FullMoon = 0,
|
|
852
782
|
/**
|
|
853
|
-
* @beta
|
|
854
783
|
* @remarks
|
|
855
784
|
* The phase following the Full Moon.
|
|
856
785
|
*
|
|
857
786
|
*/
|
|
858
787
|
WaningGibbous = 1,
|
|
859
788
|
/**
|
|
860
|
-
* @beta
|
|
861
789
|
* @remarks
|
|
862
790
|
* The phase following the Waxing Crescent.
|
|
863
791
|
*
|
|
864
792
|
*/
|
|
865
793
|
FirstQuarter = 2,
|
|
866
794
|
/**
|
|
867
|
-
* @beta
|
|
868
795
|
* @remarks
|
|
869
796
|
* The phase following the Last Quarter.
|
|
870
797
|
*
|
|
871
798
|
*/
|
|
872
799
|
WaningCrescent = 3,
|
|
873
800
|
/**
|
|
874
|
-
* @beta
|
|
875
801
|
* @remarks
|
|
876
802
|
* The darkest moon phase.
|
|
877
803
|
*
|
|
878
804
|
*/
|
|
879
805
|
NewMoon = 4,
|
|
880
806
|
/**
|
|
881
|
-
* @beta
|
|
882
807
|
* @remarks
|
|
883
808
|
* The phase following the New Moon.
|
|
884
809
|
*
|
|
885
810
|
*/
|
|
886
811
|
WaxingCrescent = 5,
|
|
887
812
|
/**
|
|
888
|
-
* @beta
|
|
889
813
|
* @remarks
|
|
890
814
|
* The phase following the Waning Gibbous.
|
|
891
815
|
*
|
|
892
816
|
*/
|
|
893
817
|
LastQuarter = 6,
|
|
894
818
|
/**
|
|
895
|
-
* @beta
|
|
896
819
|
* @remarks
|
|
897
820
|
* The phase following the First Quarter.
|
|
898
821
|
*
|
|
@@ -901,13 +824,11 @@ export enum MoonPhase {
|
|
|
901
824
|
}
|
|
902
825
|
|
|
903
826
|
/**
|
|
904
|
-
* @beta
|
|
905
827
|
* Used for specifying a sort order for how to display an
|
|
906
828
|
* objective and its list of participants.
|
|
907
829
|
*/
|
|
908
830
|
export enum ObjectiveSortOrder {
|
|
909
831
|
/**
|
|
910
|
-
* @beta
|
|
911
832
|
* @remarks
|
|
912
833
|
* Objective participant list is displayed in ascending (e.g.,
|
|
913
834
|
* A-Z) order.
|
|
@@ -915,7 +836,6 @@ export enum ObjectiveSortOrder {
|
|
|
915
836
|
*/
|
|
916
837
|
Ascending = 0,
|
|
917
838
|
/**
|
|
918
|
-
* @beta
|
|
919
839
|
* @remarks
|
|
920
840
|
* Objective participant list is displayed in descending (e.g.,
|
|
921
841
|
* Z-A) order.
|
|
@@ -925,19 +845,16 @@ export enum ObjectiveSortOrder {
|
|
|
925
845
|
}
|
|
926
846
|
|
|
927
847
|
/**
|
|
928
|
-
* @beta
|
|
929
848
|
* Contains objectives and participants for the scoreboard.
|
|
930
849
|
*/
|
|
931
850
|
export enum ScoreboardIdentityType {
|
|
932
851
|
/**
|
|
933
|
-
* @beta
|
|
934
852
|
* @remarks
|
|
935
853
|
* This scoreboard participant is tied to an entity.
|
|
936
854
|
*
|
|
937
855
|
*/
|
|
938
856
|
Entity = 'Entity',
|
|
939
857
|
/**
|
|
940
|
-
* @beta
|
|
941
858
|
* @remarks
|
|
942
859
|
* This scoreboard participant is tied to a pseudo player
|
|
943
860
|
* entity - typically this is used to store scores as data or
|
|
@@ -946,7 +863,6 @@ export enum ScoreboardIdentityType {
|
|
|
946
863
|
*/
|
|
947
864
|
FakePlayer = 'FakePlayer',
|
|
948
865
|
/**
|
|
949
|
-
* @beta
|
|
950
866
|
* @remarks
|
|
951
867
|
* This scoreboard participant is tied to a player.
|
|
952
868
|
*
|
|
@@ -955,12 +871,10 @@ export enum ScoreboardIdentityType {
|
|
|
955
871
|
}
|
|
956
872
|
|
|
957
873
|
/**
|
|
958
|
-
* @beta
|
|
959
874
|
* Describes where the script event originated from.
|
|
960
875
|
*/
|
|
961
876
|
export enum ScriptEventSource {
|
|
962
877
|
/**
|
|
963
|
-
* @beta
|
|
964
878
|
* @remarks
|
|
965
879
|
* The script event originated from a Block such as a Command
|
|
966
880
|
* Block.
|
|
@@ -968,7 +882,6 @@ export enum ScriptEventSource {
|
|
|
968
882
|
*/
|
|
969
883
|
Block = 'Block',
|
|
970
884
|
/**
|
|
971
|
-
* @beta
|
|
972
885
|
* @remarks
|
|
973
886
|
* The script event originated from an Entity such as a Player,
|
|
974
887
|
* Command Block Minecart or Animation Controller.
|
|
@@ -976,14 +889,12 @@ export enum ScriptEventSource {
|
|
|
976
889
|
*/
|
|
977
890
|
Entity = 'Entity',
|
|
978
891
|
/**
|
|
979
|
-
* @beta
|
|
980
892
|
* @remarks
|
|
981
893
|
* The script event originated from an NPC dialogue.
|
|
982
894
|
*
|
|
983
895
|
*/
|
|
984
896
|
NPCDialogue = 'NPCDialogue',
|
|
985
897
|
/**
|
|
986
|
-
* @beta
|
|
987
898
|
* @remarks
|
|
988
899
|
* The script event originated from the server, such as from a
|
|
989
900
|
* runCommand API call or a dedicated server console.
|
|
@@ -1014,7 +925,6 @@ export enum SignSide {
|
|
|
1014
925
|
}
|
|
1015
926
|
|
|
1016
927
|
/**
|
|
1017
|
-
* @beta
|
|
1018
928
|
* Provides numeric values for common periods in the Minecraft
|
|
1019
929
|
* day.
|
|
1020
930
|
*/
|
|
@@ -1053,27 +963,23 @@ export enum WatchdogTerminateReason {
|
|
|
1053
963
|
}
|
|
1054
964
|
|
|
1055
965
|
/**
|
|
1056
|
-
* @beta
|
|
1057
966
|
* Used to specify the type of weather condition within the
|
|
1058
967
|
* world.
|
|
1059
968
|
*/
|
|
1060
969
|
export enum WeatherType {
|
|
1061
970
|
/**
|
|
1062
|
-
* @beta
|
|
1063
971
|
* @remarks
|
|
1064
972
|
* Specifies a clear weather condition.
|
|
1065
973
|
*
|
|
1066
974
|
*/
|
|
1067
975
|
Clear = 'Clear',
|
|
1068
976
|
/**
|
|
1069
|
-
* @beta
|
|
1070
977
|
* @remarks
|
|
1071
978
|
* Specifies a rain weather condition.
|
|
1072
979
|
*
|
|
1073
980
|
*/
|
|
1074
981
|
Rain = 'Rain',
|
|
1075
982
|
/**
|
|
1076
|
-
* @beta
|
|
1077
983
|
* @remarks
|
|
1078
984
|
* Specifies a rain and thunder weather condition.
|
|
1079
985
|
*
|
|
@@ -1082,7 +988,6 @@ export enum WeatherType {
|
|
|
1082
988
|
}
|
|
1083
989
|
|
|
1084
990
|
/**
|
|
1085
|
-
* @beta
|
|
1086
991
|
* Represents a block in a dimension. A block represents a
|
|
1087
992
|
* unique X, Y, and Z within a dimension and get/sets the state
|
|
1088
993
|
* of the block at that location. This type was significantly
|
|
@@ -1097,7 +1002,6 @@ export class Block {
|
|
|
1097
1002
|
*/
|
|
1098
1003
|
readonly dimension: Dimension;
|
|
1099
1004
|
/**
|
|
1100
|
-
* @beta
|
|
1101
1005
|
* @remarks
|
|
1102
1006
|
* Returns true if this block is an air block (i.e., empty
|
|
1103
1007
|
* space).
|
|
@@ -1110,7 +1014,6 @@ export class Block {
|
|
|
1110
1014
|
*/
|
|
1111
1015
|
readonly isAir: boolean;
|
|
1112
1016
|
/**
|
|
1113
|
-
* @beta
|
|
1114
1017
|
* @remarks
|
|
1115
1018
|
* Returns true if this block is a liquid block - (e.g., a
|
|
1116
1019
|
* water block and a lava block are liquid, while an air block
|
|
@@ -1294,7 +1197,6 @@ export class Block {
|
|
|
1294
1197
|
*/
|
|
1295
1198
|
east(steps?: number): Block | undefined;
|
|
1296
1199
|
/**
|
|
1297
|
-
* @beta
|
|
1298
1200
|
* @remarks
|
|
1299
1201
|
* Gets a component (that represents additional capabilities)
|
|
1300
1202
|
* for a block - for example, an inventory component of a chest
|
|
@@ -1391,7 +1293,6 @@ export class Block {
|
|
|
1391
1293
|
*/
|
|
1392
1294
|
hasTag(tag: string): boolean;
|
|
1393
1295
|
/**
|
|
1394
|
-
* @beta
|
|
1395
1296
|
* @remarks
|
|
1396
1297
|
* Returns true if this reference to a block is still valid
|
|
1397
1298
|
* (for example, if the block is unloaded, references to that
|
|
@@ -1554,14 +1455,12 @@ export class BlockAreaSize {
|
|
|
1554
1455
|
}
|
|
1555
1456
|
|
|
1556
1457
|
/**
|
|
1557
|
-
* @beta
|
|
1558
1458
|
* Base type for components associated with blocks.
|
|
1559
1459
|
*/
|
|
1560
1460
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
1561
1461
|
export class BlockComponent extends Component {
|
|
1562
1462
|
private constructor();
|
|
1563
1463
|
/**
|
|
1564
|
-
* @beta
|
|
1565
1464
|
* @remarks
|
|
1566
1465
|
* Block instance that this component pertains to.
|
|
1567
1466
|
*
|
|
@@ -1570,7 +1469,6 @@ export class BlockComponent extends Component {
|
|
|
1570
1469
|
}
|
|
1571
1470
|
|
|
1572
1471
|
/**
|
|
1573
|
-
* @beta
|
|
1574
1472
|
* Contains information regarding an event that impacts a
|
|
1575
1473
|
* specific block.
|
|
1576
1474
|
*/
|
|
@@ -1642,7 +1540,6 @@ export class BlockExplodeAfterEventSignal {
|
|
|
1642
1540
|
}
|
|
1643
1541
|
|
|
1644
1542
|
/**
|
|
1645
|
-
* @beta
|
|
1646
1543
|
* Represents the inventory of a block in the world. Used with
|
|
1647
1544
|
* blocks like chests.
|
|
1648
1545
|
*/
|
|
@@ -1736,7 +1633,6 @@ export class BlockLocationIterator implements Iterable<Vector3> {
|
|
|
1736
1633
|
}
|
|
1737
1634
|
|
|
1738
1635
|
/**
|
|
1739
|
-
* @beta
|
|
1740
1636
|
* Contains the combination of type {@link BlockType} and
|
|
1741
1637
|
* properties (also sometimes called block state) which
|
|
1742
1638
|
* describe a block (but does not belong to a specific {@link
|
|
@@ -2548,7 +2444,6 @@ export class BoundingBoxUtils {
|
|
|
2548
2444
|
}
|
|
2549
2445
|
|
|
2550
2446
|
/**
|
|
2551
|
-
* @beta
|
|
2552
2447
|
* Contains information related to changes to a button push.
|
|
2553
2448
|
*/
|
|
2554
2449
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -2563,7 +2458,6 @@ export class ButtonPushAfterEvent extends BlockEvent {
|
|
|
2563
2458
|
}
|
|
2564
2459
|
|
|
2565
2460
|
/**
|
|
2566
|
-
* @beta
|
|
2567
2461
|
* Manages callbacks that are connected to when a button is
|
|
2568
2462
|
* pushed.
|
|
2569
2463
|
*/
|
|
@@ -2573,7 +2467,6 @@ export class ButtonPushAfterEventSignal extends IButtonPushAfterEventSignal {
|
|
|
2573
2467
|
}
|
|
2574
2468
|
|
|
2575
2469
|
/**
|
|
2576
|
-
* @beta
|
|
2577
2470
|
* Contains methods relating to the active camera for the
|
|
2578
2471
|
* specified player.
|
|
2579
2472
|
*/
|
|
@@ -2772,7 +2665,6 @@ export class CommandResult {
|
|
|
2772
2665
|
}
|
|
2773
2666
|
|
|
2774
2667
|
/**
|
|
2775
|
-
* @beta
|
|
2776
2668
|
* Base class for downstream Component implementations.
|
|
2777
2669
|
*/
|
|
2778
2670
|
export class Component {
|
|
@@ -2784,7 +2676,6 @@ export class Component {
|
|
|
2784
2676
|
*/
|
|
2785
2677
|
readonly typeId: string;
|
|
2786
2678
|
/**
|
|
2787
|
-
* @beta
|
|
2788
2679
|
* @remarks
|
|
2789
2680
|
* Returns whether the component is valid. A component is
|
|
2790
2681
|
* considered valid if its owner is valid, in addition to any
|
|
@@ -3049,7 +2940,6 @@ export class CompoundBlockVolume {
|
|
|
3049
2940
|
}
|
|
3050
2941
|
|
|
3051
2942
|
/**
|
|
3052
|
-
* @beta
|
|
3053
2943
|
* Represents a container that can hold sets of items. Used
|
|
3054
2944
|
* with entities such as Players, Chest Minecarts, Llamas, and
|
|
3055
2945
|
* more.
|
|
@@ -3135,7 +3025,6 @@ export class Container {
|
|
|
3135
3025
|
*/
|
|
3136
3026
|
getSlot(slot: number): ContainerSlot;
|
|
3137
3027
|
/**
|
|
3138
|
-
* @beta
|
|
3139
3028
|
* @remarks
|
|
3140
3029
|
* Returns whether a container object (or the entity or block
|
|
3141
3030
|
* that this container is associated with) is still available
|
|
@@ -3752,7 +3641,6 @@ export class Dimension {
|
|
|
3752
3641
|
options?: BlockFillOptions,
|
|
3753
3642
|
): number;
|
|
3754
3643
|
/**
|
|
3755
|
-
* @beta
|
|
3756
3644
|
* @remarks
|
|
3757
3645
|
* Returns a block instance at the given location.
|
|
3758
3646
|
*
|
|
@@ -3777,7 +3665,6 @@ export class Dimension {
|
|
|
3777
3665
|
*/
|
|
3778
3666
|
getBlock(location: Vector3): Block | undefined;
|
|
3779
3667
|
/**
|
|
3780
|
-
* @beta
|
|
3781
3668
|
* @remarks
|
|
3782
3669
|
* Gets the first block that intersects with a vector emanating
|
|
3783
3670
|
* from a location.
|
|
@@ -3791,7 +3678,6 @@ export class Dimension {
|
|
|
3791
3678
|
*/
|
|
3792
3679
|
getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
|
|
3793
3680
|
/**
|
|
3794
|
-
* @beta
|
|
3795
3681
|
* @remarks
|
|
3796
3682
|
* Returns a set of entities based on a set of conditions
|
|
3797
3683
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -3860,7 +3746,6 @@ export class Dimension {
|
|
|
3860
3746
|
*/
|
|
3861
3747
|
getEntities(options?: EntityQueryOptions): Entity[];
|
|
3862
3748
|
/**
|
|
3863
|
-
* @beta
|
|
3864
3749
|
* @remarks
|
|
3865
3750
|
* Returns a set of entities at a particular location.
|
|
3866
3751
|
*
|
|
@@ -3871,7 +3756,6 @@ export class Dimension {
|
|
|
3871
3756
|
*/
|
|
3872
3757
|
getEntitiesAtBlockLocation(location: Vector3): Entity[];
|
|
3873
3758
|
/**
|
|
3874
|
-
* @beta
|
|
3875
3759
|
* @remarks
|
|
3876
3760
|
* Gets entities that intersect with a specified vector
|
|
3877
3761
|
* emanating from a location.
|
|
@@ -3881,7 +3765,6 @@ export class Dimension {
|
|
|
3881
3765
|
*/
|
|
3882
3766
|
getEntitiesFromRay(location: Vector3, direction: Vector3, options?: EntityRaycastOptions): EntityRaycastHit[];
|
|
3883
3767
|
/**
|
|
3884
|
-
* @beta
|
|
3885
3768
|
* @remarks
|
|
3886
3769
|
* Returns a set of players based on a set of conditions
|
|
3887
3770
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -3902,7 +3785,6 @@ export class Dimension {
|
|
|
3902
3785
|
*/
|
|
3903
3786
|
getWeather(): WeatherType;
|
|
3904
3787
|
/**
|
|
3905
|
-
* @beta
|
|
3906
3788
|
* @remarks
|
|
3907
3789
|
* Runs a command synchronously using the context of the
|
|
3908
3790
|
* broader dimenion.
|
|
@@ -3947,7 +3829,6 @@ export class Dimension {
|
|
|
3947
3829
|
*/
|
|
3948
3830
|
runCommandAsync(commandString: string): Promise<CommandResult>;
|
|
3949
3831
|
/**
|
|
3950
|
-
* @beta
|
|
3951
3832
|
* @remarks
|
|
3952
3833
|
* Sets the current weather within the dimension
|
|
3953
3834
|
*
|
|
@@ -3963,7 +3844,6 @@ export class Dimension {
|
|
|
3963
3844
|
*/
|
|
3964
3845
|
setWeather(weatherType: WeatherType, duration?: number): void;
|
|
3965
3846
|
/**
|
|
3966
|
-
* @beta
|
|
3967
3847
|
* @remarks
|
|
3968
3848
|
* Creates a new entity (e.g., a mob) at the specified
|
|
3969
3849
|
* location.
|
|
@@ -4024,7 +3904,6 @@ export class Dimension {
|
|
|
4024
3904
|
*/
|
|
4025
3905
|
spawnEntity(identifier: string, location: Vector3): Entity;
|
|
4026
3906
|
/**
|
|
4027
|
-
* @beta
|
|
4028
3907
|
* @remarks
|
|
4029
3908
|
* Creates a new item stack as an entity at the specified
|
|
4030
3909
|
* location.
|
|
@@ -4071,7 +3950,6 @@ export class Dimension {
|
|
|
4071
3950
|
*/
|
|
4072
3951
|
spawnItem(itemStack: ItemStack, location: Vector3): Entity;
|
|
4073
3952
|
/**
|
|
4074
|
-
* @beta
|
|
4075
3953
|
* @remarks
|
|
4076
3954
|
* Creates a new particle emitter at a specified location in
|
|
4077
3955
|
* the world.
|
|
@@ -4144,7 +4022,6 @@ export class DimensionTypes {
|
|
|
4144
4022
|
}
|
|
4145
4023
|
|
|
4146
4024
|
/**
|
|
4147
|
-
* @beta
|
|
4148
4025
|
* Represents an effect - like poison - that has been added to
|
|
4149
4026
|
* an Entity.
|
|
4150
4027
|
*/
|
|
@@ -4255,7 +4132,6 @@ export class EffectAddAfterEventSignal {
|
|
|
4255
4132
|
}
|
|
4256
4133
|
|
|
4257
4134
|
/**
|
|
4258
|
-
* @beta
|
|
4259
4135
|
* Represents a type of effect - like poison - that can be
|
|
4260
4136
|
* applied to an entity.
|
|
4261
4137
|
*/
|
|
@@ -4492,7 +4368,6 @@ export class EnchantmentTypes {
|
|
|
4492
4368
|
export class Entity {
|
|
4493
4369
|
private constructor();
|
|
4494
4370
|
/**
|
|
4495
|
-
* @beta
|
|
4496
4371
|
* @remarks
|
|
4497
4372
|
* Dimension that the entity is currently within.
|
|
4498
4373
|
*
|
|
@@ -4521,7 +4396,6 @@ export class Entity {
|
|
|
4521
4396
|
*/
|
|
4522
4397
|
readonly id: string;
|
|
4523
4398
|
/**
|
|
4524
|
-
* @beta
|
|
4525
4399
|
* @remarks
|
|
4526
4400
|
* Whether the entity is touching a climbable block. For
|
|
4527
4401
|
* example, a player next to a ladder or a spider next to a
|
|
@@ -4531,7 +4405,6 @@ export class Entity {
|
|
|
4531
4405
|
*/
|
|
4532
4406
|
readonly isClimbing: boolean;
|
|
4533
4407
|
/**
|
|
4534
|
-
* @beta
|
|
4535
4408
|
* @remarks
|
|
4536
4409
|
* Whether the entity has a fall distance greater than 0, or
|
|
4537
4410
|
* greater than 1 while gliding.
|
|
@@ -4540,7 +4413,6 @@ export class Entity {
|
|
|
4540
4413
|
*/
|
|
4541
4414
|
readonly isFalling: boolean;
|
|
4542
4415
|
/**
|
|
4543
|
-
* @beta
|
|
4544
4416
|
* @remarks
|
|
4545
4417
|
* Whether any part of the entity is inside a water block.
|
|
4546
4418
|
*
|
|
@@ -4548,7 +4420,6 @@ export class Entity {
|
|
|
4548
4420
|
*/
|
|
4549
4421
|
readonly isInWater: boolean;
|
|
4550
4422
|
/**
|
|
4551
|
-
* @beta
|
|
4552
4423
|
* @remarks
|
|
4553
4424
|
* Whether the entity is on top of a solid block.
|
|
4554
4425
|
*
|
|
@@ -4556,7 +4427,6 @@ export class Entity {
|
|
|
4556
4427
|
*/
|
|
4557
4428
|
readonly isOnGround: boolean;
|
|
4558
4429
|
/**
|
|
4559
|
-
* @beta
|
|
4560
4430
|
* @remarks
|
|
4561
4431
|
* If true, the entity is currently sleeping.
|
|
4562
4432
|
*
|
|
@@ -4564,7 +4434,6 @@ export class Entity {
|
|
|
4564
4434
|
*/
|
|
4565
4435
|
readonly isSleeping: boolean;
|
|
4566
4436
|
/**
|
|
4567
|
-
* @beta
|
|
4568
4437
|
* @remarks
|
|
4569
4438
|
* Whether the entity is sneaking - that is, moving more slowly
|
|
4570
4439
|
* and more quietly.
|
|
@@ -4574,7 +4443,6 @@ export class Entity {
|
|
|
4574
4443
|
*/
|
|
4575
4444
|
isSneaking: boolean;
|
|
4576
4445
|
/**
|
|
4577
|
-
* @beta
|
|
4578
4446
|
* @remarks
|
|
4579
4447
|
* Whether the entity is sprinting. For example, a player using
|
|
4580
4448
|
* the sprint action, an ocelot running away or a pig boosting
|
|
@@ -4584,7 +4452,6 @@ export class Entity {
|
|
|
4584
4452
|
*/
|
|
4585
4453
|
readonly isSprinting: boolean;
|
|
4586
4454
|
/**
|
|
4587
|
-
* @beta
|
|
4588
4455
|
* @remarks
|
|
4589
4456
|
* Whether the entity is in the swimming state. For example, a
|
|
4590
4457
|
* player using the swim action or a fish in water.
|
|
@@ -4603,7 +4470,6 @@ export class Entity {
|
|
|
4603
4470
|
*/
|
|
4604
4471
|
readonly lifetimeState: EntityLifetimeState;
|
|
4605
4472
|
/**
|
|
4606
|
-
* @beta
|
|
4607
4473
|
* @remarks
|
|
4608
4474
|
* Current location of the entity.
|
|
4609
4475
|
*
|
|
@@ -4611,7 +4477,6 @@ export class Entity {
|
|
|
4611
4477
|
*/
|
|
4612
4478
|
readonly location: Vector3;
|
|
4613
4479
|
/**
|
|
4614
|
-
* @beta
|
|
4615
4480
|
* @remarks
|
|
4616
4481
|
* Given name of the entity.
|
|
4617
4482
|
*
|
|
@@ -4620,7 +4485,6 @@ export class Entity {
|
|
|
4620
4485
|
*/
|
|
4621
4486
|
nameTag: string;
|
|
4622
4487
|
/**
|
|
4623
|
-
* @beta
|
|
4624
4488
|
* @remarks
|
|
4625
4489
|
* Returns a scoreboard identity that represents this entity.
|
|
4626
4490
|
* Will remain valid when the entity is killed.
|
|
@@ -4631,7 +4495,8 @@ export class Entity {
|
|
|
4631
4495
|
* @beta
|
|
4632
4496
|
* @remarks
|
|
4633
4497
|
* Retrieves or sets an entity that is used as the target of
|
|
4634
|
-
* AI-related behaviors, like attacking.
|
|
4498
|
+
* AI-related behaviors, like attacking. If the entity
|
|
4499
|
+
* currently has no target returns undefined.
|
|
4635
4500
|
*
|
|
4636
4501
|
* @throws This property can throw when used.
|
|
4637
4502
|
*/
|
|
@@ -4645,7 +4510,6 @@ export class Entity {
|
|
|
4645
4510
|
*/
|
|
4646
4511
|
readonly typeId: string;
|
|
4647
4512
|
/**
|
|
4648
|
-
* @beta
|
|
4649
4513
|
* @remarks
|
|
4650
4514
|
* Adds or updates an effect, like poison, to the entity.
|
|
4651
4515
|
*
|
|
@@ -4704,7 +4568,6 @@ export class Entity {
|
|
|
4704
4568
|
*/
|
|
4705
4569
|
addEffect(effectType: EffectType | string, duration: number, options?: EntityEffectOptions): void;
|
|
4706
4570
|
/**
|
|
4707
|
-
* @beta
|
|
4708
4571
|
* @remarks
|
|
4709
4572
|
* Adds a specified tag to an entity.
|
|
4710
4573
|
*
|
|
@@ -4739,7 +4602,6 @@ export class Entity {
|
|
|
4739
4602
|
*/
|
|
4740
4603
|
addTag(tag: string): boolean;
|
|
4741
4604
|
/**
|
|
4742
|
-
* @beta
|
|
4743
4605
|
* @remarks
|
|
4744
4606
|
* Applies a set of damage to an entity.
|
|
4745
4607
|
*
|
|
@@ -4772,7 +4634,6 @@ export class Entity {
|
|
|
4772
4634
|
*/
|
|
4773
4635
|
applyDamage(amount: number, options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions): boolean;
|
|
4774
4636
|
/**
|
|
4775
|
-
* @beta
|
|
4776
4637
|
* @remarks
|
|
4777
4638
|
* Applies impulse vector to the current velocity of the
|
|
4778
4639
|
* entity.
|
|
@@ -4794,7 +4655,6 @@ export class Entity {
|
|
|
4794
4655
|
*/
|
|
4795
4656
|
applyImpulse(vector: Vector3): void;
|
|
4796
4657
|
/**
|
|
4797
|
-
* @beta
|
|
4798
4658
|
* @remarks
|
|
4799
4659
|
* Applies impulse vector to the current velocity of the
|
|
4800
4660
|
* entity.
|
|
@@ -4835,7 +4695,6 @@ export class Entity {
|
|
|
4835
4695
|
*/
|
|
4836
4696
|
clearDynamicProperties(): void;
|
|
4837
4697
|
/**
|
|
4838
|
-
* @beta
|
|
4839
4698
|
* @remarks
|
|
4840
4699
|
* Sets the current velocity of the Entity to zero. Note that
|
|
4841
4700
|
* this method may not have an impact on Players.
|
|
@@ -4899,7 +4758,6 @@ export class Entity {
|
|
|
4899
4758
|
*/
|
|
4900
4759
|
extinguishFire(useEffects?: boolean): boolean;
|
|
4901
4760
|
/**
|
|
4902
|
-
* @beta
|
|
4903
4761
|
* @remarks
|
|
4904
4762
|
* Returns the first intersecting block from the direction that
|
|
4905
4763
|
* this entity is looking at.
|
|
@@ -4913,7 +4771,6 @@ export class Entity {
|
|
|
4913
4771
|
*/
|
|
4914
4772
|
getBlockFromViewDirection(options?: BlockRaycastOptions): BlockRaycastHit | undefined;
|
|
4915
4773
|
/**
|
|
4916
|
-
* @beta
|
|
4917
4774
|
* @remarks
|
|
4918
4775
|
* Gets a component (that represents additional capabilities)
|
|
4919
4776
|
* for an entity.
|
|
@@ -4929,7 +4786,6 @@ export class Entity {
|
|
|
4929
4786
|
*/
|
|
4930
4787
|
getComponent(componentId: string): EntityComponent | undefined;
|
|
4931
4788
|
/**
|
|
4932
|
-
* @beta
|
|
4933
4789
|
* @remarks
|
|
4934
4790
|
* Returns all components that are both present on this entity
|
|
4935
4791
|
* and supported by the API.
|
|
@@ -4963,7 +4819,6 @@ export class Entity {
|
|
|
4963
4819
|
*/
|
|
4964
4820
|
getDynamicPropertyTotalByteCount(): number;
|
|
4965
4821
|
/**
|
|
4966
|
-
* @beta
|
|
4967
4822
|
* @remarks
|
|
4968
4823
|
* Returns the effect for the specified EffectType on the
|
|
4969
4824
|
* entity, undefined if the effect is not present, or throws an
|
|
@@ -4979,7 +4834,6 @@ export class Entity {
|
|
|
4979
4834
|
*/
|
|
4980
4835
|
getEffect(effectType: EffectType | string): Effect | undefined;
|
|
4981
4836
|
/**
|
|
4982
|
-
* @beta
|
|
4983
4837
|
* @remarks
|
|
4984
4838
|
* Returns a set of effects applied to this entity.
|
|
4985
4839
|
*
|
|
@@ -4989,7 +4843,6 @@ export class Entity {
|
|
|
4989
4843
|
*/
|
|
4990
4844
|
getEffects(): Effect[];
|
|
4991
4845
|
/**
|
|
4992
|
-
* @beta
|
|
4993
4846
|
* @remarks
|
|
4994
4847
|
* Gets the entities that this entity is looking at by
|
|
4995
4848
|
* performing a ray cast from the view of this entity.
|
|
@@ -5003,7 +4856,6 @@ export class Entity {
|
|
|
5003
4856
|
*/
|
|
5004
4857
|
getEntitiesFromViewDirection(options?: EntityRaycastOptions): EntityRaycastHit[];
|
|
5005
4858
|
/**
|
|
5006
|
-
* @beta
|
|
5007
4859
|
* @remarks
|
|
5008
4860
|
* Returns the current location of the head component of this
|
|
5009
4861
|
* entity.
|
|
@@ -5015,7 +4867,6 @@ export class Entity {
|
|
|
5015
4867
|
*/
|
|
5016
4868
|
getHeadLocation(): Vector3;
|
|
5017
4869
|
/**
|
|
5018
|
-
* @beta
|
|
5019
4870
|
* @remarks
|
|
5020
4871
|
* Gets an entity Property value. If the property was set using
|
|
5021
4872
|
* the setProperty function within the same tick, the updated
|
|
@@ -5033,7 +4884,6 @@ export class Entity {
|
|
|
5033
4884
|
*/
|
|
5034
4885
|
getProperty(identifier: string): boolean | number | string | undefined;
|
|
5035
4886
|
/**
|
|
5036
|
-
* @beta
|
|
5037
4887
|
* @remarks
|
|
5038
4888
|
* Returns the current rotation component of this entity.
|
|
5039
4889
|
*
|
|
@@ -5044,17 +4894,13 @@ export class Entity {
|
|
|
5044
4894
|
*/
|
|
5045
4895
|
getRotation(): Vector2;
|
|
5046
4896
|
/**
|
|
5047
|
-
* @beta
|
|
5048
4897
|
* @remarks
|
|
5049
|
-
* Returns all tags associated with an entity.
|
|
5050
|
-
*
|
|
5051
4898
|
* @returns
|
|
5052
|
-
* Returns
|
|
4899
|
+
* Returns all tags associated with an entity.
|
|
5053
4900
|
* @throws This function can throw errors.
|
|
5054
4901
|
*/
|
|
5055
4902
|
getTags(): string[];
|
|
5056
4903
|
/**
|
|
5057
|
-
* @beta
|
|
5058
4904
|
* @remarks
|
|
5059
4905
|
* Returns the current velocity vector of the entity.
|
|
5060
4906
|
*
|
|
@@ -5074,7 +4920,6 @@ export class Entity {
|
|
|
5074
4920
|
*/
|
|
5075
4921
|
getVelocity(): Vector3;
|
|
5076
4922
|
/**
|
|
5077
|
-
* @beta
|
|
5078
4923
|
* @remarks
|
|
5079
4924
|
* Returns the current view direction of the entity.
|
|
5080
4925
|
*
|
|
@@ -5084,7 +4929,6 @@ export class Entity {
|
|
|
5084
4929
|
*/
|
|
5085
4930
|
getViewDirection(): Vector3;
|
|
5086
4931
|
/**
|
|
5087
|
-
* @beta
|
|
5088
4932
|
* @remarks
|
|
5089
4933
|
* Returns true if the specified component is present on this
|
|
5090
4934
|
* entity.
|
|
@@ -5099,7 +4943,6 @@ export class Entity {
|
|
|
5099
4943
|
*/
|
|
5100
4944
|
hasComponent(componentId: string): boolean;
|
|
5101
4945
|
/**
|
|
5102
|
-
* @beta
|
|
5103
4946
|
* @remarks
|
|
5104
4947
|
* Returns whether an entity has a particular tag.
|
|
5105
4948
|
*
|
|
@@ -5111,7 +4954,6 @@ export class Entity {
|
|
|
5111
4954
|
*/
|
|
5112
4955
|
hasTag(tag: string): boolean;
|
|
5113
4956
|
/**
|
|
5114
|
-
* @beta
|
|
5115
4957
|
* @remarks
|
|
5116
4958
|
* Returns whether the entity can be manipulated by script. A
|
|
5117
4959
|
* Player is considered valid when it's EntityLifetimeState is
|
|
@@ -5122,7 +4964,6 @@ export class Entity {
|
|
|
5122
4964
|
*/
|
|
5123
4965
|
isValid(): boolean;
|
|
5124
4966
|
/**
|
|
5125
|
-
* @beta
|
|
5126
4967
|
* @remarks
|
|
5127
4968
|
* Kills this entity. The entity will drop loot as normal.
|
|
5128
4969
|
*
|
|
@@ -5155,6 +4996,14 @@ export class Entity {
|
|
|
5155
4996
|
kill(): boolean;
|
|
5156
4997
|
/**
|
|
5157
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.
|
|
5158
5007
|
* @throws This function can throw errors.
|
|
5159
5008
|
*/
|
|
5160
5009
|
matches(options: EntityQueryOptions): boolean;
|
|
@@ -5186,7 +5035,6 @@ export class Entity {
|
|
|
5186
5035
|
*/
|
|
5187
5036
|
remove(): void;
|
|
5188
5037
|
/**
|
|
5189
|
-
* @beta
|
|
5190
5038
|
* @remarks
|
|
5191
5039
|
* Removes the specified EffectType on the entity, or returns
|
|
5192
5040
|
* false if the effect is not present.
|
|
@@ -5202,7 +5050,6 @@ export class Entity {
|
|
|
5202
5050
|
*/
|
|
5203
5051
|
removeEffect(effectType: EffectType | string): boolean;
|
|
5204
5052
|
/**
|
|
5205
|
-
* @beta
|
|
5206
5053
|
* @remarks
|
|
5207
5054
|
* Removes a specified tag from an entity.
|
|
5208
5055
|
*
|
|
@@ -5216,7 +5063,6 @@ export class Entity {
|
|
|
5216
5063
|
*/
|
|
5217
5064
|
removeTag(tag: string): boolean;
|
|
5218
5065
|
/**
|
|
5219
|
-
* @beta
|
|
5220
5066
|
* @remarks
|
|
5221
5067
|
* Resets an Entity Property back to its default value, as
|
|
5222
5068
|
* specified in the Entity's definition. This property change
|
|
@@ -5240,7 +5086,6 @@ export class Entity {
|
|
|
5240
5086
|
*/
|
|
5241
5087
|
resetProperty(identifier: string): boolean | number | string;
|
|
5242
5088
|
/**
|
|
5243
|
-
* @beta
|
|
5244
5089
|
* @remarks
|
|
5245
5090
|
* Runs a synchronous command on the entity.
|
|
5246
5091
|
*
|
|
@@ -5336,7 +5181,6 @@ export class Entity {
|
|
|
5336
5181
|
*/
|
|
5337
5182
|
setOnFire(seconds: number, useEffects?: boolean): boolean;
|
|
5338
5183
|
/**
|
|
5339
|
-
* @beta
|
|
5340
5184
|
* @remarks
|
|
5341
5185
|
* Sets an Entity Property to the provided value. This property
|
|
5342
5186
|
* change is not applied until the next tick.
|
|
@@ -5360,7 +5204,6 @@ export class Entity {
|
|
|
5360
5204
|
*/
|
|
5361
5205
|
setProperty(identifier: string, value: boolean | number | string): void;
|
|
5362
5206
|
/**
|
|
5363
|
-
* @beta
|
|
5364
5207
|
* @remarks
|
|
5365
5208
|
* Sets the main rotation of the entity.
|
|
5366
5209
|
*
|
|
@@ -5374,7 +5217,6 @@ export class Entity {
|
|
|
5374
5217
|
*/
|
|
5375
5218
|
setRotation(rotation: Vector2): void;
|
|
5376
5219
|
/**
|
|
5377
|
-
* @beta
|
|
5378
5220
|
* @remarks
|
|
5379
5221
|
* Teleports the selected entity to a new location
|
|
5380
5222
|
*
|
|
@@ -5407,7 +5249,6 @@ export class Entity {
|
|
|
5407
5249
|
*/
|
|
5408
5250
|
teleport(location: Vector3, teleportOptions?: TeleportOptions): void;
|
|
5409
5251
|
/**
|
|
5410
|
-
* @beta
|
|
5411
5252
|
* @remarks
|
|
5412
5253
|
* Triggers an entity type event. For every entity, a number of
|
|
5413
5254
|
* events are defined in an entities' definition for key entity
|
|
@@ -5431,7 +5272,6 @@ export class Entity {
|
|
|
5431
5272
|
*/
|
|
5432
5273
|
triggerEvent(eventName: string): void;
|
|
5433
5274
|
/**
|
|
5434
|
-
* @beta
|
|
5435
5275
|
* @remarks
|
|
5436
5276
|
* Attempts to try a teleport, but may not complete the
|
|
5437
5277
|
* teleport operation (for example, if there are blocks at the
|
|
@@ -5523,7 +5363,6 @@ export class EntityAgeableComponent extends EntityComponent {
|
|
|
5523
5363
|
}
|
|
5524
5364
|
|
|
5525
5365
|
/**
|
|
5526
|
-
* @beta
|
|
5527
5366
|
* This is a base abstract class for any entity component that
|
|
5528
5367
|
* centers around a number and can have a minimum, maximum, and
|
|
5529
5368
|
* default defined value.
|
|
@@ -5603,7 +5442,6 @@ export class EntityAttributeComponent extends EntityComponent {
|
|
|
5603
5442
|
}
|
|
5604
5443
|
|
|
5605
5444
|
/**
|
|
5606
|
-
* @beta
|
|
5607
5445
|
* Base class for a family of entity movement events.
|
|
5608
5446
|
*/
|
|
5609
5447
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5711,7 +5549,6 @@ export class EntityBreathableComponent extends EntityComponent {
|
|
|
5711
5549
|
}
|
|
5712
5550
|
|
|
5713
5551
|
/**
|
|
5714
|
-
* @beta
|
|
5715
5552
|
* When added, this component signifies that the entity can
|
|
5716
5553
|
* climb up ladders.
|
|
5717
5554
|
*/
|
|
@@ -5722,7 +5559,6 @@ export class EntityCanClimbComponent extends EntityComponent {
|
|
|
5722
5559
|
}
|
|
5723
5560
|
|
|
5724
5561
|
/**
|
|
5725
|
-
* @beta
|
|
5726
5562
|
* When added, this component signifies that the entity can
|
|
5727
5563
|
* fly, and the pathfinder won't be restricted to paths where a
|
|
5728
5564
|
* solid block is required underneath it.
|
|
@@ -5734,7 +5570,6 @@ export class EntityCanFlyComponent extends EntityComponent {
|
|
|
5734
5570
|
}
|
|
5735
5571
|
|
|
5736
5572
|
/**
|
|
5737
|
-
* @beta
|
|
5738
5573
|
* When added, this component signifies that the entity can
|
|
5739
5574
|
* power jump like the horse does within Minecraft.
|
|
5740
5575
|
*/
|
|
@@ -5745,7 +5580,6 @@ export class EntityCanPowerJumpComponent extends EntityComponent {
|
|
|
5745
5580
|
}
|
|
5746
5581
|
|
|
5747
5582
|
/**
|
|
5748
|
-
* @beta
|
|
5749
5583
|
* Defines the entity's color. Only works on certain entities
|
|
5750
5584
|
* that have predefined color values (e.g., sheep, llama,
|
|
5751
5585
|
* shulker).
|
|
@@ -5765,7 +5599,6 @@ export class EntityColorComponent extends EntityComponent {
|
|
|
5765
5599
|
}
|
|
5766
5600
|
|
|
5767
5601
|
/**
|
|
5768
|
-
* @beta
|
|
5769
5602
|
* Base class for downstream entity components.
|
|
5770
5603
|
*/
|
|
5771
5604
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5774,7 +5607,8 @@ export class EntityComponent extends Component {
|
|
|
5774
5607
|
/**
|
|
5775
5608
|
* @beta
|
|
5776
5609
|
* @remarks
|
|
5777
|
-
* The entity that owns this component.
|
|
5610
|
+
* The entity that owns this component. The entity will be
|
|
5611
|
+
* undefined if it has been removed.
|
|
5778
5612
|
*
|
|
5779
5613
|
*/
|
|
5780
5614
|
readonly entity: Entity;
|
|
@@ -5806,7 +5640,6 @@ export class EntityDefinitionFeedItem {
|
|
|
5806
5640
|
}
|
|
5807
5641
|
|
|
5808
5642
|
/**
|
|
5809
|
-
* @beta
|
|
5810
5643
|
* Contains data related to the death of an entity in the game.
|
|
5811
5644
|
*/
|
|
5812
5645
|
export class EntityDieAfterEvent {
|
|
@@ -5827,7 +5660,6 @@ export class EntityDieAfterEvent {
|
|
|
5827
5660
|
}
|
|
5828
5661
|
|
|
5829
5662
|
/**
|
|
5830
|
-
* @beta
|
|
5831
5663
|
* Supports registering for an event that fires after an entity
|
|
5832
5664
|
* has died.
|
|
5833
5665
|
*/
|
|
@@ -5865,7 +5697,6 @@ export class EntityDieAfterEventSignal {
|
|
|
5865
5697
|
}
|
|
5866
5698
|
|
|
5867
5699
|
/**
|
|
5868
|
-
* @beta
|
|
5869
5700
|
* Provides access to a mob's equipment slots. This component
|
|
5870
5701
|
* exists for all mob entities.
|
|
5871
5702
|
*/
|
|
@@ -5919,7 +5750,6 @@ export class EntityEquippableComponent extends EntityComponent {
|
|
|
5919
5750
|
}
|
|
5920
5751
|
|
|
5921
5752
|
/**
|
|
5922
|
-
* @beta
|
|
5923
5753
|
* When added, this component signifies that this entity
|
|
5924
5754
|
* doesn't take damage from fire.
|
|
5925
5755
|
*/
|
|
@@ -5930,7 +5760,6 @@ export class EntityFireImmuneComponent extends EntityComponent {
|
|
|
5930
5760
|
}
|
|
5931
5761
|
|
|
5932
5762
|
/**
|
|
5933
|
-
* @beta
|
|
5934
5763
|
* When added, this component signifies that this entity can
|
|
5935
5764
|
* float in liquid blocks.
|
|
5936
5765
|
*/
|
|
@@ -5941,7 +5770,6 @@ export class EntityFloatsInLiquidComponent extends EntityComponent {
|
|
|
5941
5770
|
}
|
|
5942
5771
|
|
|
5943
5772
|
/**
|
|
5944
|
-
* @beta
|
|
5945
5773
|
* Represents the flying speed of an entity.
|
|
5946
5774
|
*/
|
|
5947
5775
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5959,7 +5787,6 @@ export class EntityFlyingSpeedComponent extends EntityComponent {
|
|
|
5959
5787
|
}
|
|
5960
5788
|
|
|
5961
5789
|
/**
|
|
5962
|
-
* @beta
|
|
5963
5790
|
* Defines how much friction affects this entity.
|
|
5964
5791
|
*/
|
|
5965
5792
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -5978,7 +5805,6 @@ export class EntityFrictionModifierComponent extends EntityComponent {
|
|
|
5978
5805
|
}
|
|
5979
5806
|
|
|
5980
5807
|
/**
|
|
5981
|
-
* @beta
|
|
5982
5808
|
* Sets the offset from the ground that the entity is actually
|
|
5983
5809
|
* at.
|
|
5984
5810
|
*/
|
|
@@ -5999,7 +5825,6 @@ export class EntityGroundOffsetComponent extends EntityComponent {
|
|
|
5999
5825
|
}
|
|
6000
5826
|
|
|
6001
5827
|
/**
|
|
6002
|
-
* @beta
|
|
6003
5828
|
* Defines the interactions with this entity for healing it.
|
|
6004
5829
|
*/
|
|
6005
5830
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6035,7 +5860,6 @@ export class EntityHealableComponent extends EntityComponent {
|
|
|
6035
5860
|
}
|
|
6036
5861
|
|
|
6037
5862
|
/**
|
|
6038
|
-
* @beta
|
|
6039
5863
|
* Contains information related to an entity when its health
|
|
6040
5864
|
* changes. Warning: don't change the health of an entity in
|
|
6041
5865
|
* this event, or it will cause an infinite loop!
|
|
@@ -6063,7 +5887,6 @@ export class EntityHealthChangedAfterEvent {
|
|
|
6063
5887
|
}
|
|
6064
5888
|
|
|
6065
5889
|
/**
|
|
6066
|
-
* @beta
|
|
6067
5890
|
* Manages callbacks that are connected to when the health of
|
|
6068
5891
|
* an entity changes.
|
|
6069
5892
|
*/
|
|
@@ -6094,7 +5917,6 @@ export class EntityHealthChangedAfterEventSignal {
|
|
|
6094
5917
|
}
|
|
6095
5918
|
|
|
6096
5919
|
/**
|
|
6097
|
-
* @beta
|
|
6098
5920
|
* Defines the health properties of an entity.
|
|
6099
5921
|
*/
|
|
6100
5922
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6104,7 +5926,6 @@ export class EntityHealthComponent extends EntityAttributeComponent {
|
|
|
6104
5926
|
}
|
|
6105
5927
|
|
|
6106
5928
|
/**
|
|
6107
|
-
* @beta
|
|
6108
5929
|
* Contains information related to an entity hitting a block.
|
|
6109
5930
|
*/
|
|
6110
5931
|
export class EntityHitBlockAfterEvent {
|
|
@@ -6130,7 +5951,6 @@ export class EntityHitBlockAfterEvent {
|
|
|
6130
5951
|
}
|
|
6131
5952
|
|
|
6132
5953
|
/**
|
|
6133
|
-
* @beta
|
|
6134
5954
|
* Manages callbacks that are connected to when an entity hits
|
|
6135
5955
|
* a block.
|
|
6136
5956
|
*/
|
|
@@ -6161,7 +5981,6 @@ export class EntityHitBlockAfterEventSignal {
|
|
|
6161
5981
|
}
|
|
6162
5982
|
|
|
6163
5983
|
/**
|
|
6164
|
-
* @beta
|
|
6165
5984
|
* Contains information related to an entity hitting (melee
|
|
6166
5985
|
* attacking) another entity.
|
|
6167
5986
|
*/
|
|
@@ -6182,7 +6001,6 @@ export class EntityHitEntityAfterEvent {
|
|
|
6182
6001
|
}
|
|
6183
6002
|
|
|
6184
6003
|
/**
|
|
6185
|
-
* @beta
|
|
6186
6004
|
* Manages callbacks that are connected to when an entity makes
|
|
6187
6005
|
* a melee attack on another entity.
|
|
6188
6006
|
*/
|
|
@@ -6213,7 +6031,6 @@ export class EntityHitEntityAfterEventSignal {
|
|
|
6213
6031
|
}
|
|
6214
6032
|
|
|
6215
6033
|
/**
|
|
6216
|
-
* @beta
|
|
6217
6034
|
* Contains information related to an entity getting hurt.
|
|
6218
6035
|
*/
|
|
6219
6036
|
export class EntityHurtAfterEvent {
|
|
@@ -6240,7 +6057,6 @@ export class EntityHurtAfterEvent {
|
|
|
6240
6057
|
}
|
|
6241
6058
|
|
|
6242
6059
|
/**
|
|
6243
|
-
* @beta
|
|
6244
6060
|
* Manages callbacks that are connected to when an entity is
|
|
6245
6061
|
* hurt.
|
|
6246
6062
|
*/
|
|
@@ -6269,7 +6085,6 @@ export class EntityHurtAfterEventSignal {
|
|
|
6269
6085
|
}
|
|
6270
6086
|
|
|
6271
6087
|
/**
|
|
6272
|
-
* @beta
|
|
6273
6088
|
* Defines this entity's inventory properties.
|
|
6274
6089
|
*/
|
|
6275
6090
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6293,7 +6108,8 @@ export class EntityInventoryComponent extends EntityComponent {
|
|
|
6293
6108
|
readonly canBeSiphonedFrom: boolean;
|
|
6294
6109
|
/**
|
|
6295
6110
|
* @remarks
|
|
6296
|
-
* 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.
|
|
6297
6113
|
*
|
|
6298
6114
|
* @throws This property can throw when used.
|
|
6299
6115
|
*/
|
|
@@ -6331,7 +6147,6 @@ export class EntityInventoryComponent extends EntityComponent {
|
|
|
6331
6147
|
}
|
|
6332
6148
|
|
|
6333
6149
|
/**
|
|
6334
|
-
* @beta
|
|
6335
6150
|
* When added, this component signifies that this entity is a
|
|
6336
6151
|
* baby.
|
|
6337
6152
|
*/
|
|
@@ -6342,7 +6157,6 @@ export class EntityIsBabyComponent extends EntityComponent {
|
|
|
6342
6157
|
}
|
|
6343
6158
|
|
|
6344
6159
|
/**
|
|
6345
|
-
* @beta
|
|
6346
6160
|
* When added, this component signifies that this entity is
|
|
6347
6161
|
* charged.
|
|
6348
6162
|
*/
|
|
@@ -6353,7 +6167,6 @@ export class EntityIsChargedComponent extends EntityComponent {
|
|
|
6353
6167
|
}
|
|
6354
6168
|
|
|
6355
6169
|
/**
|
|
6356
|
-
* @beta
|
|
6357
6170
|
* When added, this component signifies that this entity is
|
|
6358
6171
|
* currently carrying a chest.
|
|
6359
6172
|
*/
|
|
@@ -6364,7 +6177,6 @@ export class EntityIsChestedComponent extends EntityComponent {
|
|
|
6364
6177
|
}
|
|
6365
6178
|
|
|
6366
6179
|
/**
|
|
6367
|
-
* @beta
|
|
6368
6180
|
* When added, this component signifies that dyes can be used
|
|
6369
6181
|
* on this entity to change its color.
|
|
6370
6182
|
*/
|
|
@@ -6375,7 +6187,6 @@ export class EntityIsDyeableComponent extends EntityComponent {
|
|
|
6375
6187
|
}
|
|
6376
6188
|
|
|
6377
6189
|
/**
|
|
6378
|
-
* @beta
|
|
6379
6190
|
* When added, this component signifies that this entity can
|
|
6380
6191
|
* hide from hostile mobs while invisible.
|
|
6381
6192
|
*/
|
|
@@ -6386,7 +6197,6 @@ export class EntityIsHiddenWhenInvisibleComponent extends EntityComponent {
|
|
|
6386
6197
|
}
|
|
6387
6198
|
|
|
6388
6199
|
/**
|
|
6389
|
-
* @beta
|
|
6390
6200
|
* When added, this component signifies that this entity this
|
|
6391
6201
|
* currently on fire.
|
|
6392
6202
|
*/
|
|
@@ -6397,7 +6207,6 @@ export class EntityIsIgnitedComponent extends EntityComponent {
|
|
|
6397
6207
|
}
|
|
6398
6208
|
|
|
6399
6209
|
/**
|
|
6400
|
-
* @beta
|
|
6401
6210
|
* When added, this component signifies that this entity is an
|
|
6402
6211
|
* illager captain.
|
|
6403
6212
|
*/
|
|
@@ -6408,7 +6217,6 @@ export class EntityIsIllagerCaptainComponent extends EntityComponent {
|
|
|
6408
6217
|
}
|
|
6409
6218
|
|
|
6410
6219
|
/**
|
|
6411
|
-
* @beta
|
|
6412
6220
|
* When added, this component signifies that this entity is
|
|
6413
6221
|
* currently saddled.
|
|
6414
6222
|
*/
|
|
@@ -6419,7 +6227,6 @@ export class EntityIsSaddledComponent extends EntityComponent {
|
|
|
6419
6227
|
}
|
|
6420
6228
|
|
|
6421
6229
|
/**
|
|
6422
|
-
* @beta
|
|
6423
6230
|
* When added, this component signifies that this entity is
|
|
6424
6231
|
* currently shaking.
|
|
6425
6232
|
*/
|
|
@@ -6430,7 +6237,6 @@ export class EntityIsShakingComponent extends EntityComponent {
|
|
|
6430
6237
|
}
|
|
6431
6238
|
|
|
6432
6239
|
/**
|
|
6433
|
-
* @beta
|
|
6434
6240
|
* When added, this component signifies that this entity is
|
|
6435
6241
|
* currently sheared.
|
|
6436
6242
|
*/
|
|
@@ -6441,7 +6247,6 @@ export class EntityIsShearedComponent extends EntityComponent {
|
|
|
6441
6247
|
}
|
|
6442
6248
|
|
|
6443
6249
|
/**
|
|
6444
|
-
* @beta
|
|
6445
6250
|
* When added, this component signifies that this entity can be
|
|
6446
6251
|
* stacked.
|
|
6447
6252
|
*/
|
|
@@ -6452,7 +6257,6 @@ export class EntityIsStackableComponent extends EntityComponent {
|
|
|
6452
6257
|
}
|
|
6453
6258
|
|
|
6454
6259
|
/**
|
|
6455
|
-
* @beta
|
|
6456
6260
|
* When added, this component signifies that this entity is
|
|
6457
6261
|
* currently stunned.
|
|
6458
6262
|
*/
|
|
@@ -6463,7 +6267,6 @@ export class EntityIsStunnedComponent extends EntityComponent {
|
|
|
6463
6267
|
}
|
|
6464
6268
|
|
|
6465
6269
|
/**
|
|
6466
|
-
* @beta
|
|
6467
6270
|
* When added, this component signifies that this entity is
|
|
6468
6271
|
* currently tamed.
|
|
6469
6272
|
*/
|
|
@@ -6474,7 +6277,6 @@ export class EntityIsTamedComponent extends EntityComponent {
|
|
|
6474
6277
|
}
|
|
6475
6278
|
|
|
6476
6279
|
/**
|
|
6477
|
-
* @beta
|
|
6478
6280
|
* If added onto the entity, this indicates that the entity
|
|
6479
6281
|
* represents a free-floating item in the world. Lets you
|
|
6480
6282
|
* retrieve the actual item stack contents via the itemStack
|
|
@@ -6570,7 +6372,6 @@ export class EntityLeashableComponent extends EntityComponent {
|
|
|
6570
6372
|
}
|
|
6571
6373
|
|
|
6572
6374
|
/**
|
|
6573
|
-
* @beta
|
|
6574
6375
|
* Contains data related to an entity loaded within the world.
|
|
6575
6376
|
* This could happen when an unloaded chunk is reloaded, or
|
|
6576
6377
|
* when an entity changes dimensions.
|
|
@@ -6588,7 +6389,6 @@ export class EntityLoadAfterEvent {
|
|
|
6588
6389
|
}
|
|
6589
6390
|
|
|
6590
6391
|
/**
|
|
6591
|
-
* @beta
|
|
6592
6392
|
* Registers a script-based event handler for handling what
|
|
6593
6393
|
* happens when an entity loads.
|
|
6594
6394
|
*/
|
|
@@ -6621,7 +6421,6 @@ export class EntityLoadAfterEventSignal {
|
|
|
6621
6421
|
}
|
|
6622
6422
|
|
|
6623
6423
|
/**
|
|
6624
|
-
* @beta
|
|
6625
6424
|
* Additional variant value. Can be used to further
|
|
6626
6425
|
* differentiate variants.
|
|
6627
6426
|
*/
|
|
@@ -6662,7 +6461,6 @@ export class EntityMountTamingComponent extends EntityComponent {
|
|
|
6662
6461
|
}
|
|
6663
6462
|
|
|
6664
6463
|
/**
|
|
6665
|
-
* @beta
|
|
6666
6464
|
* When added, this movement control allows the mob to swim in
|
|
6667
6465
|
* water and walk on land.
|
|
6668
6466
|
*/
|
|
@@ -6673,7 +6471,6 @@ export class EntityMovementAmphibiousComponent extends EntityBaseMovementCompone
|
|
|
6673
6471
|
}
|
|
6674
6472
|
|
|
6675
6473
|
/**
|
|
6676
|
-
* @beta
|
|
6677
6474
|
* This component accents the movement of an entity.
|
|
6678
6475
|
*/
|
|
6679
6476
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6693,7 +6490,6 @@ export class EntityMovementComponent extends EntityAttributeComponent {
|
|
|
6693
6490
|
}
|
|
6694
6491
|
|
|
6695
6492
|
/**
|
|
6696
|
-
* @beta
|
|
6697
6493
|
* When added, this move control causes the mob to fly.
|
|
6698
6494
|
*/
|
|
6699
6495
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6703,7 +6499,6 @@ export class EntityMovementFlyComponent extends EntityBaseMovementComponent {
|
|
|
6703
6499
|
}
|
|
6704
6500
|
|
|
6705
6501
|
/**
|
|
6706
|
-
* @beta
|
|
6707
6502
|
* When added, this move control allows a mob to fly, swim,
|
|
6708
6503
|
* climb, etc.
|
|
6709
6504
|
*/
|
|
@@ -6738,7 +6533,6 @@ export class EntityMovementGlideComponent extends EntityBaseMovementComponent {
|
|
|
6738
6533
|
}
|
|
6739
6534
|
|
|
6740
6535
|
/**
|
|
6741
|
-
* @beta
|
|
6742
6536
|
* When added, this move control causes the mob to hover.
|
|
6743
6537
|
*/
|
|
6744
6538
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -6748,7 +6542,6 @@ export class EntityMovementHoverComponent extends EntityBaseMovementComponent {
|
|
|
6748
6542
|
}
|
|
6749
6543
|
|
|
6750
6544
|
/**
|
|
6751
|
-
* @beta
|
|
6752
6545
|
* Move control that causes the mob to jump as it moves with a
|
|
6753
6546
|
* specified delay between jumps.
|
|
6754
6547
|
*/
|
|
@@ -6759,7 +6552,6 @@ export class EntityMovementJumpComponent extends EntityBaseMovementComponent {
|
|
|
6759
6552
|
}
|
|
6760
6553
|
|
|
6761
6554
|
/**
|
|
6762
|
-
* @beta
|
|
6763
6555
|
* When added, this move control causes the mob to hop as it
|
|
6764
6556
|
* moves.
|
|
6765
6557
|
*/
|
|
@@ -7037,7 +6829,6 @@ export class EntityOnFireComponent extends EntityComponent {
|
|
|
7037
6829
|
}
|
|
7038
6830
|
|
|
7039
6831
|
/**
|
|
7040
|
-
* @beta
|
|
7041
6832
|
* Sets the distance through which the entity can push through.
|
|
7042
6833
|
*/
|
|
7043
6834
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -7055,7 +6846,6 @@ export class EntityPushThroughComponent extends EntityComponent {
|
|
|
7055
6846
|
}
|
|
7056
6847
|
|
|
7057
6848
|
/**
|
|
7058
|
-
* @beta
|
|
7059
6849
|
* Data for an event that happens when an entity is removed
|
|
7060
6850
|
* from the world (for example, the entity is unloaded because
|
|
7061
6851
|
* it is not close to players.)
|
|
@@ -7078,7 +6868,6 @@ export class EntityRemoveAfterEvent {
|
|
|
7078
6868
|
}
|
|
7079
6869
|
|
|
7080
6870
|
/**
|
|
7081
|
-
* @beta
|
|
7082
6871
|
* Allows registration for an event that fires when an entity
|
|
7083
6872
|
* is removed from the game (for example, unloaded, or a few
|
|
7084
6873
|
* seconds after they are dead.)
|
|
@@ -7117,7 +6906,6 @@ export class EntityRemoveAfterEventSignal {
|
|
|
7117
6906
|
}
|
|
7118
6907
|
|
|
7119
6908
|
/**
|
|
7120
|
-
* @beta
|
|
7121
6909
|
* Data for an event that happens when an entity is being
|
|
7122
6910
|
* removed from the world (for example, the entity is unloaded
|
|
7123
6911
|
* because it is not close to players.)
|
|
@@ -7133,7 +6921,6 @@ export class EntityRemoveBeforeEvent {
|
|
|
7133
6921
|
}
|
|
7134
6922
|
|
|
7135
6923
|
/**
|
|
7136
|
-
* @beta
|
|
7137
6924
|
* Allows registration for an event that fires when an entity
|
|
7138
6925
|
* is being removed from the game (for example, unloaded, or a
|
|
7139
6926
|
* few seconds after they are dead.)
|
|
@@ -7301,7 +7088,6 @@ export class EntityRidingComponent extends EntityComponent {
|
|
|
7301
7088
|
}
|
|
7302
7089
|
|
|
7303
7090
|
/**
|
|
7304
|
-
* @beta
|
|
7305
7091
|
* Sets the entity's visual size.
|
|
7306
7092
|
*/
|
|
7307
7093
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -7319,7 +7105,6 @@ export class EntityScaleComponent extends EntityComponent {
|
|
|
7319
7105
|
}
|
|
7320
7106
|
|
|
7321
7107
|
/**
|
|
7322
|
-
* @beta
|
|
7323
7108
|
* Skin Id value. Can be used to differentiate skins, such as
|
|
7324
7109
|
* base skins for villagers.
|
|
7325
7110
|
*/
|
|
@@ -7338,7 +7123,6 @@ export class EntitySkinIdComponent extends EntityComponent {
|
|
|
7338
7123
|
}
|
|
7339
7124
|
|
|
7340
7125
|
/**
|
|
7341
|
-
* @beta
|
|
7342
7126
|
* Contains data related to an entity spawning within the
|
|
7343
7127
|
* world.
|
|
7344
7128
|
*/
|
|
@@ -7361,7 +7145,6 @@ export class EntitySpawnAfterEvent {
|
|
|
7361
7145
|
}
|
|
7362
7146
|
|
|
7363
7147
|
/**
|
|
7364
|
-
* @beta
|
|
7365
7148
|
* Registers a script-based event handler for handling what
|
|
7366
7149
|
* happens when an entity spawns.
|
|
7367
7150
|
*/
|
|
@@ -7538,7 +7321,6 @@ export class EntityUnderwaterMovementComponent extends EntityAttributeComponent
|
|
|
7538
7321
|
}
|
|
7539
7322
|
|
|
7540
7323
|
/**
|
|
7541
|
-
* @beta
|
|
7542
7324
|
* Used to differentiate the component group of a variant of an
|
|
7543
7325
|
* entity from others. (e.g. ocelot, villager).
|
|
7544
7326
|
*/
|
|
@@ -7557,7 +7339,6 @@ export class EntityVariantComponent extends EntityComponent {
|
|
|
7557
7339
|
}
|
|
7558
7340
|
|
|
7559
7341
|
/**
|
|
7560
|
-
* @beta
|
|
7561
7342
|
* When added, this component signifies that this entity wants
|
|
7562
7343
|
* to become a jockey.
|
|
7563
7344
|
*/
|
|
@@ -7677,7 +7458,6 @@ export class ExplosionBeforeEventSignal {
|
|
|
7677
7458
|
}
|
|
7678
7459
|
|
|
7679
7460
|
/**
|
|
7680
|
-
* @beta
|
|
7681
7461
|
* As part of the Healable component, represents a specific
|
|
7682
7462
|
* item that can be fed to an entity to cause health effects.
|
|
7683
7463
|
*/
|
|
@@ -7709,7 +7489,6 @@ export class FeedItem {
|
|
|
7709
7489
|
}
|
|
7710
7490
|
|
|
7711
7491
|
/**
|
|
7712
|
-
* @beta
|
|
7713
7492
|
* Represents an effect that is applied as a result of a food
|
|
7714
7493
|
* item being fed to an entity.
|
|
7715
7494
|
*/
|
|
@@ -7776,7 +7555,6 @@ export class FluidContainer {
|
|
|
7776
7555
|
}
|
|
7777
7556
|
|
|
7778
7557
|
/**
|
|
7779
|
-
* @beta
|
|
7780
7558
|
* Provides an adaptable interface for callers to subscribe to
|
|
7781
7559
|
* an event that fires when a button is pushed.
|
|
7782
7560
|
*/
|
|
@@ -7802,7 +7580,6 @@ export class IButtonPushAfterEventSignal {
|
|
|
7802
7580
|
}
|
|
7803
7581
|
|
|
7804
7582
|
/**
|
|
7805
|
-
* @beta
|
|
7806
7583
|
* Provides an adaptable interface for callers to subscribe to
|
|
7807
7584
|
* an event that fires after a lever is used.
|
|
7808
7585
|
*/
|
|
@@ -7828,7 +7605,6 @@ export class ILeverActionAfterEventSignal {
|
|
|
7828
7605
|
}
|
|
7829
7606
|
|
|
7830
7607
|
/**
|
|
7831
|
-
* @beta
|
|
7832
7608
|
* Provides an adaptable interface for callers to subscribe to
|
|
7833
7609
|
* an event that fires after a player joins a world.
|
|
7834
7610
|
*/
|
|
@@ -7854,7 +7630,6 @@ export class IPlayerJoinAfterEventSignal {
|
|
|
7854
7630
|
}
|
|
7855
7631
|
|
|
7856
7632
|
/**
|
|
7857
|
-
* @beta
|
|
7858
7633
|
* Provides an adaptable interface for callers to subscribe to
|
|
7859
7634
|
* an event that fires after a player leaves a world.
|
|
7860
7635
|
*/
|
|
@@ -7880,7 +7655,6 @@ export class IPlayerLeaveAfterEventSignal {
|
|
|
7880
7655
|
}
|
|
7881
7656
|
|
|
7882
7657
|
/**
|
|
7883
|
-
* @beta
|
|
7884
7658
|
* Provides an adaptable interface for callers to subscribe to
|
|
7885
7659
|
* an event that fires after a player spawns.
|
|
7886
7660
|
*/
|
|
@@ -7906,7 +7680,6 @@ export class IPlayerSpawnAfterEventSignal {
|
|
|
7906
7680
|
}
|
|
7907
7681
|
|
|
7908
7682
|
/**
|
|
7909
|
-
* @beta
|
|
7910
7683
|
* Contains information related to a chargeable item completing
|
|
7911
7684
|
* being charged.
|
|
7912
7685
|
*/
|
|
@@ -7934,7 +7707,6 @@ export class ItemCompleteUseAfterEvent {
|
|
|
7934
7707
|
}
|
|
7935
7708
|
|
|
7936
7709
|
/**
|
|
7937
|
-
* @beta
|
|
7938
7710
|
* Manages callbacks that are connected to the completion of
|
|
7939
7711
|
* charging for a chargeable item.
|
|
7940
7712
|
*/
|
|
@@ -7962,7 +7734,6 @@ export class ItemCompleteUseAfterEventSignal {
|
|
|
7962
7734
|
}
|
|
7963
7735
|
|
|
7964
7736
|
/**
|
|
7965
|
-
* @beta
|
|
7966
7737
|
* Base class for item components.
|
|
7967
7738
|
*/
|
|
7968
7739
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -8240,7 +8011,6 @@ export class ItemFoodComponent extends ItemComponent {
|
|
|
8240
8011
|
}
|
|
8241
8012
|
|
|
8242
8013
|
/**
|
|
8243
|
-
* @beta
|
|
8244
8014
|
* Contains information related to a chargeable item when the
|
|
8245
8015
|
* player has finished using the item and released the build
|
|
8246
8016
|
* action.
|
|
@@ -8269,7 +8039,6 @@ export class ItemReleaseUseAfterEvent {
|
|
|
8269
8039
|
}
|
|
8270
8040
|
|
|
8271
8041
|
/**
|
|
8272
|
-
* @beta
|
|
8273
8042
|
* Manages callbacks that are connected to the releasing of
|
|
8274
8043
|
* charging for a chargeable item.
|
|
8275
8044
|
*/
|
|
@@ -8297,7 +8066,6 @@ export class ItemReleaseUseAfterEventSignal {
|
|
|
8297
8066
|
}
|
|
8298
8067
|
|
|
8299
8068
|
/**
|
|
8300
|
-
* @beta
|
|
8301
8069
|
* Defines a collection of items.
|
|
8302
8070
|
*/
|
|
8303
8071
|
export class ItemStack {
|
|
@@ -8392,7 +8160,6 @@ export class ItemStack {
|
|
|
8392
8160
|
*/
|
|
8393
8161
|
constructor(itemType: ItemType | string, amount?: number);
|
|
8394
8162
|
/**
|
|
8395
|
-
* @beta
|
|
8396
8163
|
* @remarks
|
|
8397
8164
|
* Creates an exact copy of the item stack, including any
|
|
8398
8165
|
* custom data or properties.
|
|
@@ -8402,7 +8169,6 @@ export class ItemStack {
|
|
|
8402
8169
|
*/
|
|
8403
8170
|
clone(): ItemStack;
|
|
8404
8171
|
/**
|
|
8405
|
-
* @beta
|
|
8406
8172
|
* @remarks
|
|
8407
8173
|
* Get the list of block types this item can break in Adventure
|
|
8408
8174
|
* mode.
|
|
@@ -8412,7 +8178,6 @@ export class ItemStack {
|
|
|
8412
8178
|
*/
|
|
8413
8179
|
getCanDestroy(): string[];
|
|
8414
8180
|
/**
|
|
8415
|
-
* @beta
|
|
8416
8181
|
* @remarks
|
|
8417
8182
|
* Get the list of block types this item can be placed on in
|
|
8418
8183
|
* Adventure mode.
|
|
@@ -8451,7 +8216,6 @@ export class ItemStack {
|
|
|
8451
8216
|
*/
|
|
8452
8217
|
getComponents(): ItemComponent[];
|
|
8453
8218
|
/**
|
|
8454
|
-
* @beta
|
|
8455
8219
|
* @remarks
|
|
8456
8220
|
* Returns the lore value - a secondary display string - for an
|
|
8457
8221
|
* ItemStack.
|
|
@@ -8462,7 +8226,6 @@ export class ItemStack {
|
|
|
8462
8226
|
*/
|
|
8463
8227
|
getLore(): string[];
|
|
8464
8228
|
/**
|
|
8465
|
-
* @beta
|
|
8466
8229
|
* @remarks
|
|
8467
8230
|
* Returns a set of tags associated with this item stack.
|
|
8468
8231
|
*
|
|
@@ -8480,7 +8243,6 @@ export class ItemStack {
|
|
|
8480
8243
|
*/
|
|
8481
8244
|
hasComponent(componentId: string): boolean;
|
|
8482
8245
|
/**
|
|
8483
|
-
* @beta
|
|
8484
8246
|
* @remarks
|
|
8485
8247
|
* Checks whether this item stack has a particular tag
|
|
8486
8248
|
* associated with it.
|
|
@@ -8508,7 +8270,6 @@ export class ItemStack {
|
|
|
8508
8270
|
*/
|
|
8509
8271
|
isStackableWith(itemStack: ItemStack): boolean;
|
|
8510
8272
|
/**
|
|
8511
|
-
* @beta
|
|
8512
8273
|
* @remarks
|
|
8513
8274
|
* The list of block types this item can break in Adventure
|
|
8514
8275
|
* mode. The block names are displayed in the item's tooltip.
|
|
@@ -8529,7 +8290,6 @@ export class ItemStack {
|
|
|
8529
8290
|
*/
|
|
8530
8291
|
setCanDestroy(blockIdentifiers?: string[]): void;
|
|
8531
8292
|
/**
|
|
8532
|
-
* @beta
|
|
8533
8293
|
* @remarks
|
|
8534
8294
|
* The list of block types this item can be placed on in
|
|
8535
8295
|
* Adventure mode. This is only applicable to block items. The
|
|
@@ -8551,7 +8311,6 @@ export class ItemStack {
|
|
|
8551
8311
|
*/
|
|
8552
8312
|
setCanPlaceOn(blockIdentifiers?: string[]): void;
|
|
8553
8313
|
/**
|
|
8554
|
-
* @beta
|
|
8555
8314
|
* @remarks
|
|
8556
8315
|
* Sets the lore value - a secondary display string - for an
|
|
8557
8316
|
* ItemStack. The lore list is cleared if set to an empty
|
|
@@ -8608,7 +8367,6 @@ export class ItemStack {
|
|
|
8608
8367
|
}
|
|
8609
8368
|
|
|
8610
8369
|
/**
|
|
8611
|
-
* @beta
|
|
8612
8370
|
* Contains information related to a chargeable item starting
|
|
8613
8371
|
* to be charged.
|
|
8614
8372
|
*/
|
|
@@ -8636,7 +8394,6 @@ export class ItemStartUseAfterEvent {
|
|
|
8636
8394
|
}
|
|
8637
8395
|
|
|
8638
8396
|
/**
|
|
8639
|
-
* @beta
|
|
8640
8397
|
* Manages callbacks that are connected to the start of
|
|
8641
8398
|
* charging for a chargeable item.
|
|
8642
8399
|
*/
|
|
@@ -8664,7 +8421,6 @@ export class ItemStartUseAfterEventSignal {
|
|
|
8664
8421
|
}
|
|
8665
8422
|
|
|
8666
8423
|
/**
|
|
8667
|
-
* @beta
|
|
8668
8424
|
* Contains information related to an item being used on a
|
|
8669
8425
|
* block. This event fires when a player presses the the Use
|
|
8670
8426
|
* Item / Place Block button to successfully use an item or
|
|
@@ -8688,7 +8444,9 @@ export class ItemStartUseOnAfterEvent {
|
|
|
8688
8444
|
readonly blockFace: Direction;
|
|
8689
8445
|
/**
|
|
8690
8446
|
* @remarks
|
|
8691
|
-
* 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.
|
|
8692
8450
|
*
|
|
8693
8451
|
*/
|
|
8694
8452
|
readonly itemStack: ItemStack;
|
|
@@ -8701,7 +8459,6 @@ export class ItemStartUseOnAfterEvent {
|
|
|
8701
8459
|
}
|
|
8702
8460
|
|
|
8703
8461
|
/**
|
|
8704
|
-
* @beta
|
|
8705
8462
|
* Manages callbacks that are connected to an item starting
|
|
8706
8463
|
* being used on a block event.
|
|
8707
8464
|
*/
|
|
@@ -8729,7 +8486,6 @@ export class ItemStartUseOnAfterEventSignal {
|
|
|
8729
8486
|
}
|
|
8730
8487
|
|
|
8731
8488
|
/**
|
|
8732
|
-
* @beta
|
|
8733
8489
|
* Contains information related to a chargeable item has
|
|
8734
8490
|
* finished an items use cycle, or when the player has released
|
|
8735
8491
|
* the use action with the item.
|
|
@@ -8739,6 +8495,8 @@ export class ItemStopUseAfterEvent {
|
|
|
8739
8495
|
/**
|
|
8740
8496
|
* @remarks
|
|
8741
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.
|
|
8742
8500
|
*
|
|
8743
8501
|
*/
|
|
8744
8502
|
readonly itemStack: ItemStack;
|
|
@@ -8758,7 +8516,6 @@ export class ItemStopUseAfterEvent {
|
|
|
8758
8516
|
}
|
|
8759
8517
|
|
|
8760
8518
|
/**
|
|
8761
|
-
* @beta
|
|
8762
8519
|
* Manages callbacks that are connected to the stopping of
|
|
8763
8520
|
* charging for an item that has a registered
|
|
8764
8521
|
* minecraft:chargeable component.
|
|
@@ -8787,7 +8544,6 @@ export class ItemStopUseAfterEventSignal {
|
|
|
8787
8544
|
}
|
|
8788
8545
|
|
|
8789
8546
|
/**
|
|
8790
|
-
* @beta
|
|
8791
8547
|
* Contains information related to an item that has stopped
|
|
8792
8548
|
* being used on a block. This event fires when a player
|
|
8793
8549
|
* successfully uses an item or places a block by pressing the
|
|
@@ -8819,7 +8575,6 @@ export class ItemStopUseOnAfterEvent {
|
|
|
8819
8575
|
}
|
|
8820
8576
|
|
|
8821
8577
|
/**
|
|
8822
|
-
* @beta
|
|
8823
8578
|
* Manages callbacks that are connected to an item stops used
|
|
8824
8579
|
* on a block event.
|
|
8825
8580
|
*/
|
|
@@ -8847,7 +8602,6 @@ export class ItemStopUseOnAfterEventSignal {
|
|
|
8847
8602
|
}
|
|
8848
8603
|
|
|
8849
8604
|
/**
|
|
8850
|
-
* @beta
|
|
8851
8605
|
* Represents the type of an item - for example, Wool.
|
|
8852
8606
|
*/
|
|
8853
8607
|
export class ItemType {
|
|
@@ -8883,7 +8637,6 @@ export class ItemTypes {
|
|
|
8883
8637
|
}
|
|
8884
8638
|
|
|
8885
8639
|
/**
|
|
8886
|
-
* @beta
|
|
8887
8640
|
* Contains information related to an item being used on a
|
|
8888
8641
|
* block. This event fires when an item used by a player
|
|
8889
8642
|
* successfully triggers an entity interaction.
|
|
@@ -8905,7 +8658,6 @@ export class ItemUseAfterEvent {
|
|
|
8905
8658
|
}
|
|
8906
8659
|
|
|
8907
8660
|
/**
|
|
8908
|
-
* @beta
|
|
8909
8661
|
* Manages callbacks that are connected to an item use event.
|
|
8910
8662
|
*/
|
|
8911
8663
|
export class ItemUseAfterEventSignal {
|
|
@@ -8930,7 +8682,6 @@ export class ItemUseAfterEventSignal {
|
|
|
8930
8682
|
}
|
|
8931
8683
|
|
|
8932
8684
|
/**
|
|
8933
|
-
* @beta
|
|
8934
8685
|
* Contains information related to an item being used.
|
|
8935
8686
|
*/
|
|
8936
8687
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -8945,7 +8696,6 @@ export class ItemUseBeforeEvent extends ItemUseAfterEvent {
|
|
|
8945
8696
|
}
|
|
8946
8697
|
|
|
8947
8698
|
/**
|
|
8948
|
-
* @beta
|
|
8949
8699
|
* Manages callbacks that fire before an item is used.
|
|
8950
8700
|
*/
|
|
8951
8701
|
export class ItemUseBeforeEventSignal {
|
|
@@ -8970,7 +8720,6 @@ export class ItemUseBeforeEventSignal {
|
|
|
8970
8720
|
}
|
|
8971
8721
|
|
|
8972
8722
|
/**
|
|
8973
|
-
* @beta
|
|
8974
8723
|
* Contains information related to an item being used on a
|
|
8975
8724
|
* block. This event fires when an item used by a player
|
|
8976
8725
|
* successfully triggers a block interaction.
|
|
@@ -9011,7 +8760,6 @@ export class ItemUseOnAfterEvent {
|
|
|
9011
8760
|
}
|
|
9012
8761
|
|
|
9013
8762
|
/**
|
|
9014
|
-
* @beta
|
|
9015
8763
|
* Manages callbacks that are connected to an item being used
|
|
9016
8764
|
* on a block event.
|
|
9017
8765
|
*/
|
|
@@ -9039,7 +8787,6 @@ export class ItemUseOnAfterEventSignal {
|
|
|
9039
8787
|
}
|
|
9040
8788
|
|
|
9041
8789
|
/**
|
|
9042
|
-
* @beta
|
|
9043
8790
|
* Contains information related to an item being used on a
|
|
9044
8791
|
* block.
|
|
9045
8792
|
*/
|
|
@@ -9055,7 +8802,6 @@ export class ItemUseOnBeforeEvent extends ItemUseOnAfterEvent {
|
|
|
9055
8802
|
}
|
|
9056
8803
|
|
|
9057
8804
|
/**
|
|
9058
|
-
* @beta
|
|
9059
8805
|
* Manages callbacks that fire before an item being used on a
|
|
9060
8806
|
* block event.
|
|
9061
8807
|
*/
|
|
@@ -9083,7 +8829,6 @@ export class ItemUseOnBeforeEventSignal {
|
|
|
9083
8829
|
}
|
|
9084
8830
|
|
|
9085
8831
|
/**
|
|
9086
|
-
* @beta
|
|
9087
8832
|
* Contains information related to changes to a lever
|
|
9088
8833
|
* activating or deactivating.
|
|
9089
8834
|
*/
|
|
@@ -9106,7 +8851,6 @@ export class LeverActionAfterEvent extends BlockEvent {
|
|
|
9106
8851
|
}
|
|
9107
8852
|
|
|
9108
8853
|
/**
|
|
9109
|
-
* @beta
|
|
9110
8854
|
* Manages callbacks that are connected to lever moves
|
|
9111
8855
|
* (activates or deactivates).
|
|
9112
8856
|
*/
|
|
@@ -9185,7 +8929,6 @@ export class MinecraftDimensionTypes {
|
|
|
9185
8929
|
}
|
|
9186
8930
|
|
|
9187
8931
|
/**
|
|
9188
|
-
* @beta
|
|
9189
8932
|
* Contains a set of additional variable values for further
|
|
9190
8933
|
* defining how rendering and animations function.
|
|
9191
8934
|
*/
|
|
@@ -9482,7 +9225,6 @@ export class PistonActivateBeforeEventSignal {
|
|
|
9482
9225
|
export class Player extends Entity {
|
|
9483
9226
|
private constructor();
|
|
9484
9227
|
/**
|
|
9485
|
-
* @beta
|
|
9486
9228
|
* @remarks
|
|
9487
9229
|
* The player's Camera.
|
|
9488
9230
|
*
|
|
@@ -9490,7 +9232,6 @@ export class Player extends Entity {
|
|
|
9490
9232
|
*/
|
|
9491
9233
|
readonly camera: Camera;
|
|
9492
9234
|
/**
|
|
9493
|
-
* @beta
|
|
9494
9235
|
* @remarks
|
|
9495
9236
|
* If true, the player is currently emoting.
|
|
9496
9237
|
*
|
|
@@ -9498,7 +9239,6 @@ export class Player extends Entity {
|
|
|
9498
9239
|
*/
|
|
9499
9240
|
readonly isEmoting: boolean;
|
|
9500
9241
|
/**
|
|
9501
|
-
* @beta
|
|
9502
9242
|
* @remarks
|
|
9503
9243
|
* Whether the player is flying. For example, in Creative or
|
|
9504
9244
|
* Spectator mode.
|
|
@@ -9507,7 +9247,6 @@ export class Player extends Entity {
|
|
|
9507
9247
|
*/
|
|
9508
9248
|
readonly isFlying: boolean;
|
|
9509
9249
|
/**
|
|
9510
|
-
* @beta
|
|
9511
9250
|
* @remarks
|
|
9512
9251
|
* Whether the player is gliding with Elytra.
|
|
9513
9252
|
*
|
|
@@ -9515,7 +9254,6 @@ export class Player extends Entity {
|
|
|
9515
9254
|
*/
|
|
9516
9255
|
readonly isGliding: boolean;
|
|
9517
9256
|
/**
|
|
9518
|
-
* @beta
|
|
9519
9257
|
* @remarks
|
|
9520
9258
|
* Whether the player is jumping. This will remain true while
|
|
9521
9259
|
* the player is holding the jump action.
|
|
@@ -9524,7 +9262,6 @@ export class Player extends Entity {
|
|
|
9524
9262
|
*/
|
|
9525
9263
|
readonly isJumping: boolean;
|
|
9526
9264
|
/**
|
|
9527
|
-
* @beta
|
|
9528
9265
|
* @remarks
|
|
9529
9266
|
* The current overall level for the player, based on their
|
|
9530
9267
|
* experience.
|
|
@@ -9540,7 +9277,6 @@ export class Player extends Entity {
|
|
|
9540
9277
|
*/
|
|
9541
9278
|
readonly name: string;
|
|
9542
9279
|
/**
|
|
9543
|
-
* @beta
|
|
9544
9280
|
* @remarks
|
|
9545
9281
|
* Contains methods for manipulating the on-screen display of a
|
|
9546
9282
|
* Player.
|
|
@@ -9558,7 +9294,6 @@ export class Player extends Entity {
|
|
|
9558
9294
|
*/
|
|
9559
9295
|
selectedSlot: number;
|
|
9560
9296
|
/**
|
|
9561
|
-
* @beta
|
|
9562
9297
|
* @remarks
|
|
9563
9298
|
* The overall total set of experience needed to achieve the
|
|
9564
9299
|
* next level for a player.
|
|
@@ -9567,7 +9302,6 @@ export class Player extends Entity {
|
|
|
9567
9302
|
*/
|
|
9568
9303
|
readonly totalXpNeededForNextLevel: number;
|
|
9569
9304
|
/**
|
|
9570
|
-
* @beta
|
|
9571
9305
|
* @remarks
|
|
9572
9306
|
* The current set of experience achieved for the player.
|
|
9573
9307
|
*
|
|
@@ -9575,7 +9309,6 @@ export class Player extends Entity {
|
|
|
9575
9309
|
*/
|
|
9576
9310
|
readonly xpEarnedAtCurrentLevel: number;
|
|
9577
9311
|
/**
|
|
9578
|
-
* @beta
|
|
9579
9312
|
* @remarks
|
|
9580
9313
|
* Adds/removes experience to/from the Player and returns the
|
|
9581
9314
|
* current experience of the Player.
|
|
@@ -9591,7 +9324,6 @@ export class Player extends Entity {
|
|
|
9591
9324
|
*/
|
|
9592
9325
|
addExperience(amount: number): number;
|
|
9593
9326
|
/**
|
|
9594
|
-
* @beta
|
|
9595
9327
|
* @remarks
|
|
9596
9328
|
* Adds/removes level to/from the Player and returns the
|
|
9597
9329
|
* current level of the Player.
|
|
@@ -9618,7 +9350,6 @@ export class Player extends Entity {
|
|
|
9618
9350
|
*/
|
|
9619
9351
|
getItemCooldown(itemCategory: string): number;
|
|
9620
9352
|
/**
|
|
9621
|
-
* @beta
|
|
9622
9353
|
* @remarks
|
|
9623
9354
|
* Gets the current spawn point of the player.
|
|
9624
9355
|
*
|
|
@@ -9626,7 +9357,6 @@ export class Player extends Entity {
|
|
|
9626
9357
|
*/
|
|
9627
9358
|
getSpawnPoint(): DimensionLocation | undefined;
|
|
9628
9359
|
/**
|
|
9629
|
-
* @beta
|
|
9630
9360
|
* @remarks
|
|
9631
9361
|
* Gets the total experience of the Player.
|
|
9632
9362
|
*
|
|
@@ -9657,7 +9387,6 @@ export class Player extends Entity {
|
|
|
9657
9387
|
*/
|
|
9658
9388
|
playMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
9659
9389
|
/**
|
|
9660
|
-
* @beta
|
|
9661
9390
|
* @remarks
|
|
9662
9391
|
* Plays a sound that only this particular player can hear.
|
|
9663
9392
|
*
|
|
@@ -9723,7 +9452,6 @@ export class Player extends Entity {
|
|
|
9723
9452
|
*/
|
|
9724
9453
|
queueMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
9725
9454
|
/**
|
|
9726
|
-
* @beta
|
|
9727
9455
|
* @remarks
|
|
9728
9456
|
* Resets the level of the player.
|
|
9729
9457
|
*
|
|
@@ -9733,7 +9461,6 @@ export class Player extends Entity {
|
|
|
9733
9461
|
*/
|
|
9734
9462
|
resetLevel(): void;
|
|
9735
9463
|
/**
|
|
9736
|
-
* @beta
|
|
9737
9464
|
* @remarks
|
|
9738
9465
|
* Sends a message to the player.
|
|
9739
9466
|
*
|
|
@@ -9795,7 +9522,6 @@ export class Player extends Entity {
|
|
|
9795
9522
|
*/
|
|
9796
9523
|
setOp(isOp: boolean): void;
|
|
9797
9524
|
/**
|
|
9798
|
-
* @beta
|
|
9799
9525
|
* @remarks
|
|
9800
9526
|
* Sets the current starting spawn point for this particular
|
|
9801
9527
|
* player.
|
|
@@ -9839,7 +9565,6 @@ export class Player extends Entity {
|
|
|
9839
9565
|
}
|
|
9840
9566
|
|
|
9841
9567
|
/**
|
|
9842
|
-
* @beta
|
|
9843
9568
|
* Contains information regarding an event after a player
|
|
9844
9569
|
* breaks a block.
|
|
9845
9570
|
*/
|
|
@@ -9876,7 +9601,6 @@ export class PlayerBreakBlockAfterEvent extends BlockEvent {
|
|
|
9876
9601
|
}
|
|
9877
9602
|
|
|
9878
9603
|
/**
|
|
9879
|
-
* @beta
|
|
9880
9604
|
* Manages callbacks that are connected to when a player breaks
|
|
9881
9605
|
* a block.
|
|
9882
9606
|
*/
|
|
@@ -9907,7 +9631,6 @@ export class PlayerBreakBlockAfterEventSignal {
|
|
|
9907
9631
|
}
|
|
9908
9632
|
|
|
9909
9633
|
/**
|
|
9910
|
-
* @beta
|
|
9911
9634
|
* Contains information regarding an event before a player
|
|
9912
9635
|
* breaks a block.
|
|
9913
9636
|
*/
|
|
@@ -9936,7 +9659,6 @@ export class PlayerBreakBlockBeforeEvent extends BlockEvent {
|
|
|
9936
9659
|
}
|
|
9937
9660
|
|
|
9938
9661
|
/**
|
|
9939
|
-
* @beta
|
|
9940
9662
|
* Manages callbacks that are connected to before a player
|
|
9941
9663
|
* breaks a block.
|
|
9942
9664
|
*/
|
|
@@ -9967,7 +9689,6 @@ export class PlayerBreakBlockBeforeEventSignal {
|
|
|
9967
9689
|
}
|
|
9968
9690
|
|
|
9969
9691
|
/**
|
|
9970
|
-
* @beta
|
|
9971
9692
|
* Contains information related to changes to a player's
|
|
9972
9693
|
* dimension having been changed.
|
|
9973
9694
|
*/
|
|
@@ -10007,7 +9728,6 @@ export class PlayerDimensionChangeAfterEvent {
|
|
|
10007
9728
|
}
|
|
10008
9729
|
|
|
10009
9730
|
/**
|
|
10010
|
-
* @beta
|
|
10011
9731
|
* Manages callbacks that are connected to successful player
|
|
10012
9732
|
* dimension changes.
|
|
10013
9733
|
*/
|
|
@@ -10077,11 +9797,16 @@ export class PlayerInteractWithBlockAfterEvent {
|
|
|
10077
9797
|
|
|
10078
9798
|
/**
|
|
10079
9799
|
* @beta
|
|
9800
|
+
* Manages callbacks that are connected to after a player
|
|
9801
|
+
* interacts with a block.
|
|
10080
9802
|
*/
|
|
10081
9803
|
export class PlayerInteractWithBlockAfterEventSignal {
|
|
10082
9804
|
private constructor();
|
|
10083
9805
|
/**
|
|
10084
9806
|
* @remarks
|
|
9807
|
+
* Adds a callback that will be called after a player interacts
|
|
9808
|
+
* with a block.
|
|
9809
|
+
*
|
|
10085
9810
|
* This function can't be called in read-only mode.
|
|
10086
9811
|
*
|
|
10087
9812
|
*/
|
|
@@ -10090,6 +9815,9 @@ export class PlayerInteractWithBlockAfterEventSignal {
|
|
|
10090
9815
|
): (arg: PlayerInteractWithBlockAfterEvent) => void;
|
|
10091
9816
|
/**
|
|
10092
9817
|
* @remarks
|
|
9818
|
+
* Removes a callback from being called after a player
|
|
9819
|
+
* interacts with a block.
|
|
9820
|
+
*
|
|
10093
9821
|
* This function can't be called in read-only mode.
|
|
10094
9822
|
*
|
|
10095
9823
|
* @throws This function can throw errors.
|
|
@@ -10146,11 +9874,16 @@ export class PlayerInteractWithBlockBeforeEvent {
|
|
|
10146
9874
|
|
|
10147
9875
|
/**
|
|
10148
9876
|
* @beta
|
|
9877
|
+
* Manages callbacks that are connected to before a player
|
|
9878
|
+
* interacts with a block.
|
|
10149
9879
|
*/
|
|
10150
9880
|
export class PlayerInteractWithBlockBeforeEventSignal {
|
|
10151
9881
|
private constructor();
|
|
10152
9882
|
/**
|
|
10153
9883
|
* @remarks
|
|
9884
|
+
* Adds a callback that will be called before a player
|
|
9885
|
+
* interacts with a block.
|
|
9886
|
+
*
|
|
10154
9887
|
* This function can't be called in read-only mode.
|
|
10155
9888
|
*
|
|
10156
9889
|
*/
|
|
@@ -10159,6 +9892,9 @@ export class PlayerInteractWithBlockBeforeEventSignal {
|
|
|
10159
9892
|
): (arg: PlayerInteractWithBlockBeforeEvent) => void;
|
|
10160
9893
|
/**
|
|
10161
9894
|
* @remarks
|
|
9895
|
+
* Removes a callback from being called before a player
|
|
9896
|
+
* interacts with a block.
|
|
9897
|
+
*
|
|
10162
9898
|
* This function can't be called in read-only mode.
|
|
10163
9899
|
*
|
|
10164
9900
|
* @throws This function can throw errors.
|
|
@@ -10196,11 +9932,16 @@ export class PlayerInteractWithEntityAfterEvent {
|
|
|
10196
9932
|
|
|
10197
9933
|
/**
|
|
10198
9934
|
* @beta
|
|
9935
|
+
* Manages callbacks that are connected to after a player
|
|
9936
|
+
* interacts with an entity.
|
|
10199
9937
|
*/
|
|
10200
9938
|
export class PlayerInteractWithEntityAfterEventSignal {
|
|
10201
9939
|
private constructor();
|
|
10202
9940
|
/**
|
|
10203
9941
|
* @remarks
|
|
9942
|
+
* Adds a callback that will be called after a player interacts
|
|
9943
|
+
* with an entity.
|
|
9944
|
+
*
|
|
10204
9945
|
* This function can't be called in read-only mode.
|
|
10205
9946
|
*
|
|
10206
9947
|
*/
|
|
@@ -10209,6 +9950,9 @@ export class PlayerInteractWithEntityAfterEventSignal {
|
|
|
10209
9950
|
): (arg: PlayerInteractWithEntityAfterEvent) => void;
|
|
10210
9951
|
/**
|
|
10211
9952
|
* @remarks
|
|
9953
|
+
* Removes a callback from being called after a player
|
|
9954
|
+
* interacts with an entity.
|
|
9955
|
+
*
|
|
10212
9956
|
* This function can't be called in read-only mode.
|
|
10213
9957
|
*
|
|
10214
9958
|
* @throws This function can throw errors.
|
|
@@ -10252,11 +9996,16 @@ export class PlayerInteractWithEntityBeforeEvent {
|
|
|
10252
9996
|
|
|
10253
9997
|
/**
|
|
10254
9998
|
* @beta
|
|
9999
|
+
* Manages callbacks that are connected to before a player
|
|
10000
|
+
* interacts with an entity.
|
|
10255
10001
|
*/
|
|
10256
10002
|
export class PlayerInteractWithEntityBeforeEventSignal {
|
|
10257
10003
|
private constructor();
|
|
10258
10004
|
/**
|
|
10259
10005
|
* @remarks
|
|
10006
|
+
* Adds a callback that will be called before a player
|
|
10007
|
+
* interacts with an entity.
|
|
10008
|
+
*
|
|
10260
10009
|
* This function can't be called in read-only mode.
|
|
10261
10010
|
*
|
|
10262
10011
|
*/
|
|
@@ -10265,6 +10014,9 @@ export class PlayerInteractWithEntityBeforeEventSignal {
|
|
|
10265
10014
|
): (arg: PlayerInteractWithEntityBeforeEvent) => void;
|
|
10266
10015
|
/**
|
|
10267
10016
|
* @remarks
|
|
10017
|
+
* Removes a callback from being called before a player
|
|
10018
|
+
* interacts with an entity.
|
|
10019
|
+
*
|
|
10268
10020
|
* This function can't be called in read-only mode.
|
|
10269
10021
|
*
|
|
10270
10022
|
* @throws This function can throw errors.
|
|
@@ -10299,7 +10051,6 @@ export class PlayerIterator implements Iterable<Player> {
|
|
|
10299
10051
|
}
|
|
10300
10052
|
|
|
10301
10053
|
/**
|
|
10302
|
-
* @beta
|
|
10303
10054
|
* Contains information regarding a player that has joined.
|
|
10304
10055
|
* See the playerSpawn event for more detailed information that
|
|
10305
10056
|
* could be returned after the first time a player has spawned
|
|
@@ -10322,7 +10073,6 @@ export class PlayerJoinAfterEvent {
|
|
|
10322
10073
|
}
|
|
10323
10074
|
|
|
10324
10075
|
/**
|
|
10325
|
-
* @beta
|
|
10326
10076
|
* Manages callbacks that are connected to a player joining the
|
|
10327
10077
|
* world.
|
|
10328
10078
|
*/
|
|
@@ -10332,7 +10082,6 @@ export class PlayerJoinAfterEventSignal extends IPlayerJoinAfterEventSignal {
|
|
|
10332
10082
|
}
|
|
10333
10083
|
|
|
10334
10084
|
/**
|
|
10335
|
-
* @beta
|
|
10336
10085
|
* Contains information regarding a player that has left the
|
|
10337
10086
|
* world.
|
|
10338
10087
|
*/
|
|
@@ -10354,7 +10103,6 @@ export class PlayerLeaveAfterEvent {
|
|
|
10354
10103
|
}
|
|
10355
10104
|
|
|
10356
10105
|
/**
|
|
10357
|
-
* @beta
|
|
10358
10106
|
* Manages callbacks that are connected to a player leaving the
|
|
10359
10107
|
* world.
|
|
10360
10108
|
*/
|
|
@@ -10392,7 +10140,6 @@ export class PlayerLeaveBeforeEventSignal {
|
|
|
10392
10140
|
}
|
|
10393
10141
|
|
|
10394
10142
|
/**
|
|
10395
|
-
* @beta
|
|
10396
10143
|
* Contains information regarding an event where a player
|
|
10397
10144
|
* places a block.
|
|
10398
10145
|
*/
|
|
@@ -10408,7 +10155,6 @@ export class PlayerPlaceBlockAfterEvent extends BlockEvent {
|
|
|
10408
10155
|
}
|
|
10409
10156
|
|
|
10410
10157
|
/**
|
|
10411
|
-
* @beta
|
|
10412
10158
|
* Manages callbacks that are connected to when a block is
|
|
10413
10159
|
* placed by a player.
|
|
10414
10160
|
*/
|
|
@@ -10511,7 +10257,6 @@ export class PlayerPlaceBlockBeforeEventSignal {
|
|
|
10511
10257
|
}
|
|
10512
10258
|
|
|
10513
10259
|
/**
|
|
10514
|
-
* @beta
|
|
10515
10260
|
* An event that contains more information about a player
|
|
10516
10261
|
* spawning.
|
|
10517
10262
|
*/
|
|
@@ -10537,7 +10282,6 @@ export class PlayerSpawnAfterEvent {
|
|
|
10537
10282
|
}
|
|
10538
10283
|
|
|
10539
10284
|
/**
|
|
10540
|
-
* @beta
|
|
10541
10285
|
* Registers an event when a player is spawned (or re-spawned
|
|
10542
10286
|
* after death) and fully ready within the world.
|
|
10543
10287
|
*/
|
|
@@ -10547,7 +10291,6 @@ export class PlayerSpawnAfterEventSignal extends IPlayerSpawnAfterEventSignal {
|
|
|
10547
10291
|
}
|
|
10548
10292
|
|
|
10549
10293
|
/**
|
|
10550
|
-
* @beta
|
|
10551
10294
|
* Contains information related to changes to a pressure plate
|
|
10552
10295
|
* pop.
|
|
10553
10296
|
*/
|
|
@@ -10571,7 +10314,6 @@ export class PressurePlatePopAfterEvent extends BlockEvent {
|
|
|
10571
10314
|
}
|
|
10572
10315
|
|
|
10573
10316
|
/**
|
|
10574
|
-
* @beta
|
|
10575
10317
|
* Manages callbacks that are connected to when a pressure
|
|
10576
10318
|
* plate is popped.
|
|
10577
10319
|
*/
|
|
@@ -10599,7 +10341,6 @@ export class PressurePlatePopAfterEventSignal {
|
|
|
10599
10341
|
}
|
|
10600
10342
|
|
|
10601
10343
|
/**
|
|
10602
|
-
* @beta
|
|
10603
10344
|
* Contains information related to changes to a pressure plate
|
|
10604
10345
|
* push.
|
|
10605
10346
|
*/
|
|
@@ -10629,7 +10370,6 @@ export class PressurePlatePushAfterEvent extends BlockEvent {
|
|
|
10629
10370
|
}
|
|
10630
10371
|
|
|
10631
10372
|
/**
|
|
10632
|
-
* @beta
|
|
10633
10373
|
* Manages callbacks that are connected to when a pressure
|
|
10634
10374
|
* plate is pushed.
|
|
10635
10375
|
*/
|
|
@@ -10657,7 +10397,6 @@ export class PressurePlatePushAfterEventSignal {
|
|
|
10657
10397
|
}
|
|
10658
10398
|
|
|
10659
10399
|
/**
|
|
10660
|
-
* @beta
|
|
10661
10400
|
* Contains information related to a projectile hitting a
|
|
10662
10401
|
* block.
|
|
10663
10402
|
*/
|
|
@@ -10705,7 +10444,6 @@ export class ProjectileHitBlockAfterEvent {
|
|
|
10705
10444
|
}
|
|
10706
10445
|
|
|
10707
10446
|
/**
|
|
10708
|
-
* @beta
|
|
10709
10447
|
* Manages callbacks that are connected to when a projectile
|
|
10710
10448
|
* hits a block.
|
|
10711
10449
|
*/
|
|
@@ -10733,7 +10471,6 @@ export class ProjectileHitBlockAfterEventSignal {
|
|
|
10733
10471
|
}
|
|
10734
10472
|
|
|
10735
10473
|
/**
|
|
10736
|
-
* @beta
|
|
10737
10474
|
* Contains information related to a projectile hitting an
|
|
10738
10475
|
* entity.
|
|
10739
10476
|
*/
|
|
@@ -10781,7 +10518,6 @@ export class ProjectileHitEntityAfterEvent {
|
|
|
10781
10518
|
}
|
|
10782
10519
|
|
|
10783
10520
|
/**
|
|
10784
|
-
* @beta
|
|
10785
10521
|
* Manages callbacks that are connected to when a projectile
|
|
10786
10522
|
* hits an entity.
|
|
10787
10523
|
*/
|
|
@@ -10809,7 +10545,6 @@ export class ProjectileHitEntityAfterEventSignal {
|
|
|
10809
10545
|
}
|
|
10810
10546
|
|
|
10811
10547
|
/**
|
|
10812
|
-
* @beta
|
|
10813
10548
|
* Contains objectives and participants for the scoreboard.
|
|
10814
10549
|
*/
|
|
10815
10550
|
export class Scoreboard {
|
|
@@ -10887,7 +10622,6 @@ export class Scoreboard {
|
|
|
10887
10622
|
}
|
|
10888
10623
|
|
|
10889
10624
|
/**
|
|
10890
|
-
* @beta
|
|
10891
10625
|
* Contains an identity of the scoreboard item.
|
|
10892
10626
|
*/
|
|
10893
10627
|
export class ScoreboardIdentity {
|
|
@@ -10928,7 +10662,6 @@ export class ScoreboardIdentity {
|
|
|
10928
10662
|
}
|
|
10929
10663
|
|
|
10930
10664
|
/**
|
|
10931
|
-
* @beta
|
|
10932
10665
|
* Contains objectives and participants for the scoreboard.
|
|
10933
10666
|
*/
|
|
10934
10667
|
export class ScoreboardObjective {
|
|
@@ -11026,7 +10759,6 @@ export class ScoreboardObjective {
|
|
|
11026
10759
|
}
|
|
11027
10760
|
|
|
11028
10761
|
/**
|
|
11029
|
-
* @beta
|
|
11030
10762
|
* Contains a pair of a scoreboard participant and its
|
|
11031
10763
|
* respective score.
|
|
11032
10764
|
*/
|
|
@@ -11047,7 +10779,6 @@ export class ScoreboardScoreInfo {
|
|
|
11047
10779
|
}
|
|
11048
10780
|
|
|
11049
10781
|
/**
|
|
11050
|
-
* @beta
|
|
11051
10782
|
* Contains information about user interface elements that are
|
|
11052
10783
|
* showing up on the screen.
|
|
11053
10784
|
*/
|
|
@@ -11136,7 +10867,6 @@ export class ScreenDisplay {
|
|
|
11136
10867
|
}
|
|
11137
10868
|
|
|
11138
10869
|
/**
|
|
11139
|
-
* @beta
|
|
11140
10870
|
* Returns additional data about a /scriptevent command
|
|
11141
10871
|
* invocation.
|
|
11142
10872
|
*/
|
|
@@ -11185,7 +10915,6 @@ export class ScriptEventCommandMessageAfterEvent {
|
|
|
11185
10915
|
}
|
|
11186
10916
|
|
|
11187
10917
|
/**
|
|
11188
|
-
* @beta
|
|
11189
10918
|
* Allows for registering an event handler that responds to
|
|
11190
10919
|
* inbound /scriptevent commands.
|
|
11191
10920
|
*/
|
|
@@ -11284,7 +11013,6 @@ export class ServerMessageAfterEventSignal {
|
|
|
11284
11013
|
export class System {
|
|
11285
11014
|
private constructor();
|
|
11286
11015
|
/**
|
|
11287
|
-
* @beta
|
|
11288
11016
|
* @remarks
|
|
11289
11017
|
* Returns a collection of after-events for system-level
|
|
11290
11018
|
* operations.
|
|
@@ -11300,14 +11028,12 @@ export class System {
|
|
|
11300
11028
|
*/
|
|
11301
11029
|
readonly beforeEvents: SystemBeforeEvents;
|
|
11302
11030
|
/**
|
|
11303
|
-
* @beta
|
|
11304
11031
|
* @remarks
|
|
11305
11032
|
* Represents the current world tick of the server.
|
|
11306
11033
|
*
|
|
11307
11034
|
*/
|
|
11308
11035
|
readonly currentTick: number;
|
|
11309
11036
|
/**
|
|
11310
|
-
* @beta
|
|
11311
11037
|
* @remarks
|
|
11312
11038
|
* Cancels the execution of a function run that was previously
|
|
11313
11039
|
* scheduled via the `run` function.
|
|
@@ -11344,7 +11070,6 @@ export class System {
|
|
|
11344
11070
|
*/
|
|
11345
11071
|
run(callback: () => void): number;
|
|
11346
11072
|
/**
|
|
11347
|
-
* @beta
|
|
11348
11073
|
* @remarks
|
|
11349
11074
|
* Runs a set of code on an interval.
|
|
11350
11075
|
*
|
|
@@ -11367,7 +11092,6 @@ export class System {
|
|
|
11367
11092
|
*/
|
|
11368
11093
|
runInterval(callback: () => void, tickInterval?: number): number;
|
|
11369
11094
|
/**
|
|
11370
|
-
* @beta
|
|
11371
11095
|
* @remarks
|
|
11372
11096
|
* Runs a set of code at a future time specified by tickDelay.
|
|
11373
11097
|
*
|
|
@@ -11384,7 +11108,6 @@ export class System {
|
|
|
11384
11108
|
}
|
|
11385
11109
|
|
|
11386
11110
|
/**
|
|
11387
|
-
* @beta
|
|
11388
11111
|
* Provides a set of events that fire within the broader
|
|
11389
11112
|
* scripting system within Minecraft.
|
|
11390
11113
|
*/
|
|
@@ -11423,7 +11146,6 @@ export class SystemBeforeEvents {
|
|
|
11423
11146
|
}
|
|
11424
11147
|
|
|
11425
11148
|
/**
|
|
11426
|
-
* @beta
|
|
11427
11149
|
* Contains information related to changes to a target block
|
|
11428
11150
|
* hit.
|
|
11429
11151
|
*/
|
|
@@ -11457,7 +11179,6 @@ export class TargetBlockHitAfterEvent extends BlockEvent {
|
|
|
11457
11179
|
}
|
|
11458
11180
|
|
|
11459
11181
|
/**
|
|
11460
|
-
* @beta
|
|
11461
11182
|
* Manages callbacks that are connected to when a target block
|
|
11462
11183
|
* is hit.
|
|
11463
11184
|
*/
|
|
@@ -11504,7 +11225,6 @@ export class Trigger {
|
|
|
11504
11225
|
}
|
|
11505
11226
|
|
|
11506
11227
|
/**
|
|
11507
|
-
* @beta
|
|
11508
11228
|
* Contains information related to changes to a trip wire trip.
|
|
11509
11229
|
*/
|
|
11510
11230
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
@@ -11525,7 +11245,6 @@ export class TripWireTripAfterEvent extends BlockEvent {
|
|
|
11525
11245
|
}
|
|
11526
11246
|
|
|
11527
11247
|
/**
|
|
11528
|
-
* @beta
|
|
11529
11248
|
* Manages callbacks that are connected to when a trip wire is
|
|
11530
11249
|
* tripped.
|
|
11531
11250
|
*/
|
|
@@ -11845,7 +11564,6 @@ export class WeatherChangeAfterEventSignal {
|
|
|
11845
11564
|
export class World {
|
|
11846
11565
|
private constructor();
|
|
11847
11566
|
/**
|
|
11848
|
-
* @beta
|
|
11849
11567
|
* @remarks
|
|
11850
11568
|
* Contains a set of events that are applicable to the entirety
|
|
11851
11569
|
* of the world. Event callbacks are called in a deferred
|
|
@@ -11854,7 +11572,6 @@ export class World {
|
|
|
11854
11572
|
*/
|
|
11855
11573
|
readonly afterEvents: WorldAfterEvents;
|
|
11856
11574
|
/**
|
|
11857
|
-
* @beta
|
|
11858
11575
|
* @remarks
|
|
11859
11576
|
* Contains a set of events that are applicable to the entirety
|
|
11860
11577
|
* of the world. Event callbacks are called immediately. Event
|
|
@@ -11863,7 +11580,6 @@ export class World {
|
|
|
11863
11580
|
*/
|
|
11864
11581
|
readonly beforeEvents: WorldBeforeEvents;
|
|
11865
11582
|
/**
|
|
11866
|
-
* @beta
|
|
11867
11583
|
* @remarks
|
|
11868
11584
|
* Returns the general global scoreboard that applies to the
|
|
11869
11585
|
* world.
|
|
@@ -11889,7 +11605,6 @@ export class World {
|
|
|
11889
11605
|
*/
|
|
11890
11606
|
clearDynamicProperties(): void;
|
|
11891
11607
|
/**
|
|
11892
|
-
* @beta
|
|
11893
11608
|
* @remarks
|
|
11894
11609
|
* Returns the absolute time since the start of the world.
|
|
11895
11610
|
*
|
|
@@ -11903,7 +11618,6 @@ export class World {
|
|
|
11903
11618
|
*/
|
|
11904
11619
|
getAllPlayers(): Player[];
|
|
11905
11620
|
/**
|
|
11906
|
-
* @beta
|
|
11907
11621
|
* @remarks
|
|
11908
11622
|
* Returns the current day.
|
|
11909
11623
|
*
|
|
@@ -11913,7 +11627,6 @@ export class World {
|
|
|
11913
11627
|
*/
|
|
11914
11628
|
getDay(): number;
|
|
11915
11629
|
/**
|
|
11916
|
-
* @beta
|
|
11917
11630
|
* @remarks
|
|
11918
11631
|
* Returns the default Overworld spawn location.
|
|
11919
11632
|
*
|
|
@@ -12025,14 +11738,12 @@ export class World {
|
|
|
12025
11738
|
*/
|
|
12026
11739
|
getEntity(id: string): Entity | undefined;
|
|
12027
11740
|
/**
|
|
12028
|
-
* @beta
|
|
12029
11741
|
* @remarks
|
|
12030
11742
|
* Returns the MoonPhase for the current time.
|
|
12031
11743
|
*
|
|
12032
11744
|
*/
|
|
12033
11745
|
getMoonPhase(): MoonPhase;
|
|
12034
11746
|
/**
|
|
12035
|
-
* @beta
|
|
12036
11747
|
* @remarks
|
|
12037
11748
|
* Returns a set of players based on a set of conditions
|
|
12038
11749
|
* defined via the EntityQueryOptions set of filter criteria.
|
|
@@ -12047,7 +11758,6 @@ export class World {
|
|
|
12047
11758
|
*/
|
|
12048
11759
|
getPlayers(options?: EntityQueryOptions): Player[];
|
|
12049
11760
|
/**
|
|
12050
|
-
* @beta
|
|
12051
11761
|
* @remarks
|
|
12052
11762
|
* Returns the time of day.
|
|
12053
11763
|
*
|
|
@@ -12056,7 +11766,6 @@ export class World {
|
|
|
12056
11766
|
*/
|
|
12057
11767
|
getTimeOfDay(): number;
|
|
12058
11768
|
/**
|
|
12059
|
-
* @beta
|
|
12060
11769
|
* @remarks
|
|
12061
11770
|
* Plays a particular music track for all players.
|
|
12062
11771
|
*
|
|
@@ -12090,7 +11799,6 @@ export class World {
|
|
|
12090
11799
|
*/
|
|
12091
11800
|
playMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
12092
11801
|
/**
|
|
12093
|
-
* @beta
|
|
12094
11802
|
* @remarks
|
|
12095
11803
|
* Plays a sound for all players.
|
|
12096
11804
|
*
|
|
@@ -12128,7 +11836,6 @@ export class World {
|
|
|
12128
11836
|
*/
|
|
12129
11837
|
playSound(soundId: string, location: Vector3, soundOptions?: WorldSoundOptions): void;
|
|
12130
11838
|
/**
|
|
12131
|
-
* @beta
|
|
12132
11839
|
* @remarks
|
|
12133
11840
|
* Queues an additional music track for players. If a track is
|
|
12134
11841
|
* not playing, a music track will play.
|
|
@@ -12146,7 +11853,6 @@ export class World {
|
|
|
12146
11853
|
*/
|
|
12147
11854
|
queueMusic(trackId: string, musicOptions?: MusicOptions): void;
|
|
12148
11855
|
/**
|
|
12149
|
-
* @beta
|
|
12150
11856
|
* @remarks
|
|
12151
11857
|
* Sends a message to all players.
|
|
12152
11858
|
*
|
|
@@ -12185,7 +11891,6 @@ export class World {
|
|
|
12185
11891
|
*/
|
|
12186
11892
|
sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
|
|
12187
11893
|
/**
|
|
12188
|
-
* @beta
|
|
12189
11894
|
* @remarks
|
|
12190
11895
|
* Sets the world time.
|
|
12191
11896
|
*
|
|
@@ -12196,7 +11901,6 @@ export class World {
|
|
|
12196
11901
|
*/
|
|
12197
11902
|
setAbsoluteTime(absoluteTime: number): void;
|
|
12198
11903
|
/**
|
|
12199
|
-
* @beta
|
|
12200
11904
|
* @remarks
|
|
12201
11905
|
* Sets a default spawn location for all players.
|
|
12202
11906
|
*
|
|
@@ -12280,7 +11984,6 @@ export class World {
|
|
|
12280
11984
|
*/
|
|
12281
11985
|
setDynamicProperty(identifier: string, value?: boolean | number | string | Vector3): void;
|
|
12282
11986
|
/**
|
|
12283
|
-
* @beta
|
|
12284
11987
|
* @remarks
|
|
12285
11988
|
* Sets the time of day.
|
|
12286
11989
|
*
|
|
@@ -12294,7 +11997,6 @@ export class World {
|
|
|
12294
11997
|
*/
|
|
12295
11998
|
setTimeOfDay(timeOfDay: number | TimeOfDay): void;
|
|
12296
11999
|
/**
|
|
12297
|
-
* @beta
|
|
12298
12000
|
* @remarks
|
|
12299
12001
|
* Stops any music tracks from playing.
|
|
12300
12002
|
*
|
|
@@ -12305,7 +12007,6 @@ export class World {
|
|
|
12305
12007
|
}
|
|
12306
12008
|
|
|
12307
12009
|
/**
|
|
12308
|
-
* @beta
|
|
12309
12010
|
* Contains a set of events that are available across the scope
|
|
12310
12011
|
* of the World.
|
|
12311
12012
|
*/
|
|
@@ -12352,21 +12053,18 @@ export class WorldAfterEvents {
|
|
|
12352
12053
|
*/
|
|
12353
12054
|
readonly effectAdd: EffectAddAfterEventSignal;
|
|
12354
12055
|
/**
|
|
12355
|
-
* @beta
|
|
12356
12056
|
* @remarks
|
|
12357
12057
|
* This event fires when an entity dies.
|
|
12358
12058
|
*
|
|
12359
12059
|
*/
|
|
12360
12060
|
readonly entityDie: EntityDieAfterEventSignal;
|
|
12361
12061
|
/**
|
|
12362
|
-
* @beta
|
|
12363
12062
|
* @remarks
|
|
12364
12063
|
* This event fires when entity health changes in any degree.
|
|
12365
12064
|
*
|
|
12366
12065
|
*/
|
|
12367
12066
|
readonly entityHealthChanged: EntityHealthChangedAfterEventSignal;
|
|
12368
12067
|
/**
|
|
12369
|
-
* @beta
|
|
12370
12068
|
* @remarks
|
|
12371
12069
|
* This event fires when an entity hits (that is, melee
|
|
12372
12070
|
* attacks) a block.
|
|
@@ -12374,7 +12072,6 @@ export class WorldAfterEvents {
|
|
|
12374
12072
|
*/
|
|
12375
12073
|
readonly entityHitBlock: EntityHitBlockAfterEventSignal;
|
|
12376
12074
|
/**
|
|
12377
|
-
* @beta
|
|
12378
12075
|
* @remarks
|
|
12379
12076
|
* This event fires when an entity hits (that is, melee
|
|
12380
12077
|
* attacks) another entity.
|
|
@@ -12382,21 +12079,18 @@ export class WorldAfterEvents {
|
|
|
12382
12079
|
*/
|
|
12383
12080
|
readonly entityHitEntity: EntityHitEntityAfterEventSignal;
|
|
12384
12081
|
/**
|
|
12385
|
-
* @beta
|
|
12386
12082
|
* @remarks
|
|
12387
12083
|
* This event fires when an entity is hurt (takes damage).
|
|
12388
12084
|
*
|
|
12389
12085
|
*/
|
|
12390
12086
|
readonly entityHurt: EntityHurtAfterEventSignal;
|
|
12391
12087
|
/**
|
|
12392
|
-
* @beta
|
|
12393
12088
|
* @remarks
|
|
12394
12089
|
* Fires when an entity is loaded.
|
|
12395
12090
|
*
|
|
12396
12091
|
*/
|
|
12397
12092
|
readonly entityLoad: EntityLoadAfterEventSignal;
|
|
12398
12093
|
/**
|
|
12399
|
-
* @beta
|
|
12400
12094
|
* @remarks
|
|
12401
12095
|
* Fires when an entity is removed (for example, potentially
|
|
12402
12096
|
* unloaded, or removed after being killed).
|
|
@@ -12404,7 +12098,6 @@ export class WorldAfterEvents {
|
|
|
12404
12098
|
*/
|
|
12405
12099
|
readonly entityRemove: EntityRemoveAfterEventSignal;
|
|
12406
12100
|
/**
|
|
12407
|
-
* @beta
|
|
12408
12101
|
* @remarks
|
|
12409
12102
|
* This event fires when an entity is spawned.
|
|
12410
12103
|
*
|
|
@@ -12418,7 +12111,6 @@ export class WorldAfterEvents {
|
|
|
12418
12111
|
*/
|
|
12419
12112
|
readonly explosion: ExplosionAfterEventSignal;
|
|
12420
12113
|
/**
|
|
12421
|
-
* @beta
|
|
12422
12114
|
* @remarks
|
|
12423
12115
|
* This event fires when a chargeable item completes charging.
|
|
12424
12116
|
*
|
|
@@ -12435,7 +12127,6 @@ export class WorldAfterEvents {
|
|
|
12435
12127
|
*/
|
|
12436
12128
|
readonly itemDefinitionEvent: ItemDefinitionAfterEventSignal;
|
|
12437
12129
|
/**
|
|
12438
|
-
* @beta
|
|
12439
12130
|
* @remarks
|
|
12440
12131
|
* This event fires when a chargeable item is released from
|
|
12441
12132
|
* charging.
|
|
@@ -12443,14 +12134,12 @@ export class WorldAfterEvents {
|
|
|
12443
12134
|
*/
|
|
12444
12135
|
readonly itemReleaseUse: ItemReleaseUseAfterEventSignal;
|
|
12445
12136
|
/**
|
|
12446
|
-
* @beta
|
|
12447
12137
|
* @remarks
|
|
12448
12138
|
* This event fires when a chargeable item starts charging.
|
|
12449
12139
|
*
|
|
12450
12140
|
*/
|
|
12451
12141
|
readonly itemStartUse: ItemStartUseAfterEventSignal;
|
|
12452
12142
|
/**
|
|
12453
|
-
* @beta
|
|
12454
12143
|
* @remarks
|
|
12455
12144
|
* This event fires when a player successfully uses an item or
|
|
12456
12145
|
* places a block by pressing the Use Item / Place Block
|
|
@@ -12461,14 +12150,12 @@ export class WorldAfterEvents {
|
|
|
12461
12150
|
*/
|
|
12462
12151
|
readonly itemStartUseOn: ItemStartUseOnAfterEventSignal;
|
|
12463
12152
|
/**
|
|
12464
|
-
* @beta
|
|
12465
12153
|
* @remarks
|
|
12466
12154
|
* This event fires when a chargeable item stops charging.
|
|
12467
12155
|
*
|
|
12468
12156
|
*/
|
|
12469
12157
|
readonly itemStopUse: ItemStopUseAfterEventSignal;
|
|
12470
12158
|
/**
|
|
12471
|
-
* @beta
|
|
12472
12159
|
* @remarks
|
|
12473
12160
|
* This event fires when a player releases the Use Item / Place
|
|
12474
12161
|
* Block button after successfully using an item. Note: This
|
|
@@ -12477,7 +12164,6 @@ export class WorldAfterEvents {
|
|
|
12477
12164
|
*/
|
|
12478
12165
|
readonly itemStopUseOn: ItemStopUseOnAfterEventSignal;
|
|
12479
12166
|
/**
|
|
12480
|
-
* @beta
|
|
12481
12167
|
* @remarks
|
|
12482
12168
|
* This event fires when an item is successfully used by a
|
|
12483
12169
|
* player.
|
|
@@ -12485,7 +12171,6 @@ export class WorldAfterEvents {
|
|
|
12485
12171
|
*/
|
|
12486
12172
|
readonly itemUse: ItemUseAfterEventSignal;
|
|
12487
12173
|
/**
|
|
12488
|
-
* @beta
|
|
12489
12174
|
* @remarks
|
|
12490
12175
|
* This event fires when an item is used on a block by a
|
|
12491
12176
|
* player.
|
|
@@ -12514,14 +12199,12 @@ export class WorldAfterEvents {
|
|
|
12514
12199
|
*/
|
|
12515
12200
|
readonly pistonActivate: PistonActivateAfterEventSignal;
|
|
12516
12201
|
/**
|
|
12517
|
-
* @beta
|
|
12518
12202
|
* @remarks
|
|
12519
12203
|
* This event fires for a block that is broken by a player.
|
|
12520
12204
|
*
|
|
12521
12205
|
*/
|
|
12522
12206
|
readonly playerBreakBlock: PlayerBreakBlockAfterEventSignal;
|
|
12523
12207
|
/**
|
|
12524
|
-
* @beta
|
|
12525
12208
|
* @remarks
|
|
12526
12209
|
* Fires when a player moved to a different dimension.
|
|
12527
12210
|
*
|
|
@@ -12550,7 +12233,6 @@ export class WorldAfterEvents {
|
|
|
12550
12233
|
*/
|
|
12551
12234
|
readonly playerLeave: PlayerLeaveAfterEventSignal;
|
|
12552
12235
|
/**
|
|
12553
|
-
* @beta
|
|
12554
12236
|
* @remarks
|
|
12555
12237
|
* This event fires for a block that is placed by a player.
|
|
12556
12238
|
*
|
|
@@ -12565,7 +12247,6 @@ export class WorldAfterEvents {
|
|
|
12565
12247
|
*/
|
|
12566
12248
|
readonly playerSpawn: PlayerSpawnAfterEventSignal;
|
|
12567
12249
|
/**
|
|
12568
|
-
* @beta
|
|
12569
12250
|
* @remarks
|
|
12570
12251
|
* A pressure plate has popped back up (i.e., there are no
|
|
12571
12252
|
* entities on the pressure plate.)
|
|
@@ -12573,7 +12254,6 @@ export class WorldAfterEvents {
|
|
|
12573
12254
|
*/
|
|
12574
12255
|
readonly pressurePlatePop: PressurePlatePopAfterEventSignal;
|
|
12575
12256
|
/**
|
|
12576
|
-
* @beta
|
|
12577
12257
|
* @remarks
|
|
12578
12258
|
* A pressure plate has pushed (at least one entity has moved
|
|
12579
12259
|
* onto a pressure plate.)
|
|
@@ -12581,28 +12261,24 @@ export class WorldAfterEvents {
|
|
|
12581
12261
|
*/
|
|
12582
12262
|
readonly pressurePlatePush: PressurePlatePushAfterEventSignal;
|
|
12583
12263
|
/**
|
|
12584
|
-
* @beta
|
|
12585
12264
|
* @remarks
|
|
12586
12265
|
* This event fires when a projectile hits a block.
|
|
12587
12266
|
*
|
|
12588
12267
|
*/
|
|
12589
12268
|
readonly projectileHitBlock: ProjectileHitBlockAfterEventSignal;
|
|
12590
12269
|
/**
|
|
12591
|
-
* @beta
|
|
12592
12270
|
* @remarks
|
|
12593
12271
|
* This event fires when a projectile hits an entity.
|
|
12594
12272
|
*
|
|
12595
12273
|
*/
|
|
12596
12274
|
readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
|
|
12597
12275
|
/**
|
|
12598
|
-
* @beta
|
|
12599
12276
|
* @remarks
|
|
12600
12277
|
* A target block was hit.
|
|
12601
12278
|
*
|
|
12602
12279
|
*/
|
|
12603
12280
|
readonly targetBlockHit: TargetBlockHitAfterEventSignal;
|
|
12604
12281
|
/**
|
|
12605
|
-
* @beta
|
|
12606
12282
|
* @remarks
|
|
12607
12283
|
* A trip wire was tripped.
|
|
12608
12284
|
*
|
|
@@ -12628,7 +12304,6 @@ export class WorldAfterEvents {
|
|
|
12628
12304
|
}
|
|
12629
12305
|
|
|
12630
12306
|
/**
|
|
12631
|
-
* @beta
|
|
12632
12307
|
* A set of events that fire before an actual action occurs. In
|
|
12633
12308
|
* most cases, you can potentially cancel or modify the
|
|
12634
12309
|
* impending event. Note that in before events any APIs that
|
|
@@ -12655,7 +12330,6 @@ export class WorldBeforeEvents {
|
|
|
12655
12330
|
*/
|
|
12656
12331
|
readonly dataDrivenEntityTriggerEvent: DataDrivenEntityTriggerBeforeEventSignal;
|
|
12657
12332
|
/**
|
|
12658
|
-
* @beta
|
|
12659
12333
|
* @remarks
|
|
12660
12334
|
* Fires before an entity is removed from the world (for
|
|
12661
12335
|
* example, unloaded or removed after being killed.)
|
|
@@ -12701,7 +12375,6 @@ export class WorldBeforeEvents {
|
|
|
12701
12375
|
*/
|
|
12702
12376
|
readonly pistonActivate: PistonActivateBeforeEventSignal;
|
|
12703
12377
|
/**
|
|
12704
|
-
* @beta
|
|
12705
12378
|
* @remarks
|
|
12706
12379
|
* This event fires before a block is broken by a player.
|
|
12707
12380
|
*
|
|
@@ -12771,7 +12444,6 @@ export class WorldInitializeAfterEventSignal {
|
|
|
12771
12444
|
}
|
|
12772
12445
|
|
|
12773
12446
|
/**
|
|
12774
|
-
* @beta
|
|
12775
12447
|
* Contains optional parameters for registering a block event.
|
|
12776
12448
|
*/
|
|
12777
12449
|
export interface BlockEventOptions {
|
|
@@ -12806,7 +12478,6 @@ export interface BlockFillOptions {
|
|
|
12806
12478
|
}
|
|
12807
12479
|
|
|
12808
12480
|
/**
|
|
12809
|
-
* @beta
|
|
12810
12481
|
* Contains more information for events where a block is hit.
|
|
12811
12482
|
*/
|
|
12812
12483
|
export interface BlockHitInformation {
|
|
@@ -12832,7 +12503,6 @@ export interface BlockHitInformation {
|
|
|
12832
12503
|
}
|
|
12833
12504
|
|
|
12834
12505
|
/**
|
|
12835
|
-
* @beta
|
|
12836
12506
|
* Contains information for block raycast hit results.
|
|
12837
12507
|
*/
|
|
12838
12508
|
export interface BlockRaycastHit {
|
|
@@ -12858,7 +12528,6 @@ export interface BlockRaycastHit {
|
|
|
12858
12528
|
}
|
|
12859
12529
|
|
|
12860
12530
|
/**
|
|
12861
|
-
* @beta
|
|
12862
12531
|
* Contains additional options for configuring a block raycast
|
|
12863
12532
|
* query.
|
|
12864
12533
|
*/
|
|
@@ -12967,15 +12636,11 @@ export interface BoundingBox {
|
|
|
12967
12636
|
min: Vector3;
|
|
12968
12637
|
}
|
|
12969
12638
|
|
|
12970
|
-
/**
|
|
12971
|
-
* @beta
|
|
12972
|
-
*/
|
|
12973
12639
|
export interface CameraDefaultOptions {
|
|
12974
12640
|
easeOptions: CameraEaseOptions;
|
|
12975
12641
|
}
|
|
12976
12642
|
|
|
12977
12643
|
/**
|
|
12978
|
-
* @beta
|
|
12979
12644
|
* Contains options associated with a camera ease operation.
|
|
12980
12645
|
*/
|
|
12981
12646
|
export interface CameraEaseOptions {
|
|
@@ -12994,7 +12659,6 @@ export interface CameraEaseOptions {
|
|
|
12994
12659
|
}
|
|
12995
12660
|
|
|
12996
12661
|
/**
|
|
12997
|
-
* @beta
|
|
12998
12662
|
* Used to initiate a full-screen color fade.
|
|
12999
12663
|
*/
|
|
13000
12664
|
export interface CameraFadeOptions {
|
|
@@ -13013,7 +12677,6 @@ export interface CameraFadeOptions {
|
|
|
13013
12677
|
}
|
|
13014
12678
|
|
|
13015
12679
|
/**
|
|
13016
|
-
* @beta
|
|
13017
12680
|
* Contains timings for a fade transition.
|
|
13018
12681
|
*/
|
|
13019
12682
|
export interface CameraFadeTimeOptions {
|
|
@@ -13037,35 +12700,23 @@ export interface CameraFadeTimeOptions {
|
|
|
13037
12700
|
holdTime: number;
|
|
13038
12701
|
}
|
|
13039
12702
|
|
|
13040
|
-
/**
|
|
13041
|
-
* @beta
|
|
13042
|
-
*/
|
|
13043
12703
|
export interface CameraSetFacingOptions {
|
|
13044
12704
|
easeOptions?: CameraEaseOptions;
|
|
13045
12705
|
facingEntity: Entity;
|
|
13046
12706
|
location?: Vector3;
|
|
13047
12707
|
}
|
|
13048
12708
|
|
|
13049
|
-
/**
|
|
13050
|
-
* @beta
|
|
13051
|
-
*/
|
|
13052
12709
|
export interface CameraSetLocationOptions {
|
|
13053
12710
|
easeOptions?: CameraEaseOptions;
|
|
13054
12711
|
location: Vector3;
|
|
13055
12712
|
}
|
|
13056
12713
|
|
|
13057
|
-
/**
|
|
13058
|
-
* @beta
|
|
13059
|
-
*/
|
|
13060
12714
|
export interface CameraSetPosOptions {
|
|
13061
12715
|
easeOptions?: CameraEaseOptions;
|
|
13062
12716
|
facingLocation: Vector3;
|
|
13063
12717
|
location?: Vector3;
|
|
13064
12718
|
}
|
|
13065
12719
|
|
|
13066
|
-
/**
|
|
13067
|
-
* @beta
|
|
13068
|
-
*/
|
|
13069
12720
|
export interface CameraSetRotOptions {
|
|
13070
12721
|
easeOptions?: CameraEaseOptions;
|
|
13071
12722
|
location?: Vector3;
|
|
@@ -13107,7 +12758,6 @@ export interface CompoundBlockVolumeItem {
|
|
|
13107
12758
|
}
|
|
13108
12759
|
|
|
13109
12760
|
/**
|
|
13110
|
-
* @beta
|
|
13111
12761
|
* An exact coordinate within the world, including its
|
|
13112
12762
|
* dimension and location.
|
|
13113
12763
|
*/
|
|
@@ -13139,7 +12789,6 @@ export interface DimensionLocation {
|
|
|
13139
12789
|
}
|
|
13140
12790
|
|
|
13141
12791
|
/**
|
|
13142
|
-
* @beta
|
|
13143
12792
|
* Additional options for when damage has been applied via a
|
|
13144
12793
|
* projectile.
|
|
13145
12794
|
*/
|
|
@@ -13159,7 +12808,6 @@ export interface EntityApplyDamageByProjectileOptions {
|
|
|
13159
12808
|
}
|
|
13160
12809
|
|
|
13161
12810
|
/**
|
|
13162
|
-
* @beta
|
|
13163
12811
|
* Additional descriptions and metadata for a damage event.
|
|
13164
12812
|
*/
|
|
13165
12813
|
export interface EntityApplyDamageOptions {
|
|
@@ -13178,7 +12826,6 @@ export interface EntityApplyDamageOptions {
|
|
|
13178
12826
|
}
|
|
13179
12827
|
|
|
13180
12828
|
/**
|
|
13181
|
-
* @beta
|
|
13182
12829
|
* Provides information about how damage has been applied to an
|
|
13183
12830
|
* entity.
|
|
13184
12831
|
*/
|
|
@@ -13234,7 +12881,6 @@ export interface EntityDataDrivenTriggerEventOptions {
|
|
|
13234
12881
|
}
|
|
13235
12882
|
|
|
13236
12883
|
/**
|
|
13237
|
-
* @beta
|
|
13238
12884
|
* Contains additional options for entity effects.
|
|
13239
12885
|
*/
|
|
13240
12886
|
export interface EntityEffectOptions {
|
|
@@ -13253,7 +12899,6 @@ export interface EntityEffectOptions {
|
|
|
13253
12899
|
}
|
|
13254
12900
|
|
|
13255
12901
|
/**
|
|
13256
|
-
* @beta
|
|
13257
12902
|
* Contains optional parameters for registering an entity
|
|
13258
12903
|
* event.
|
|
13259
12904
|
*/
|
|
@@ -13275,7 +12920,6 @@ export interface EntityEventOptions {
|
|
|
13275
12920
|
}
|
|
13276
12921
|
|
|
13277
12922
|
/**
|
|
13278
|
-
* @beta
|
|
13279
12923
|
* Contains additional information about an entity that was
|
|
13280
12924
|
* hit.
|
|
13281
12925
|
*/
|
|
@@ -13289,7 +12933,6 @@ export interface EntityHitInformation {
|
|
|
13289
12933
|
}
|
|
13290
12934
|
|
|
13291
12935
|
/**
|
|
13292
|
-
* @beta
|
|
13293
12936
|
* Contains options for selecting entities within an area.
|
|
13294
12937
|
*/
|
|
13295
12938
|
export interface EntityQueryOptions {
|
|
@@ -13460,7 +13103,6 @@ export interface EntityQueryOptions {
|
|
|
13460
13103
|
}
|
|
13461
13104
|
|
|
13462
13105
|
/**
|
|
13463
|
-
* @beta
|
|
13464
13106
|
* Contains additional options for filtering players based on
|
|
13465
13107
|
* their score for an objective.
|
|
13466
13108
|
*/
|
|
@@ -13495,7 +13137,6 @@ export interface EntityQueryScoreOptions {
|
|
|
13495
13137
|
}
|
|
13496
13138
|
|
|
13497
13139
|
/**
|
|
13498
|
-
* @beta
|
|
13499
13140
|
* Contains information for entity raycast hit results.
|
|
13500
13141
|
*/
|
|
13501
13142
|
export interface EntityRaycastHit {
|
|
@@ -13514,7 +13155,6 @@ export interface EntityRaycastHit {
|
|
|
13514
13155
|
}
|
|
13515
13156
|
|
|
13516
13157
|
/**
|
|
13517
|
-
* @beta
|
|
13518
13158
|
* Contains additional options for an entity raycast operation.
|
|
13519
13159
|
*/
|
|
13520
13160
|
export interface EntityRaycastOptions {
|
|
@@ -13561,7 +13201,6 @@ export interface ExplosionOptions {
|
|
|
13561
13201
|
}
|
|
13562
13202
|
|
|
13563
13203
|
/**
|
|
13564
|
-
* @beta
|
|
13565
13204
|
* Additional configuration options for {@link
|
|
13566
13205
|
* World.playMusic}/{@link World.queueMusic} methods.
|
|
13567
13206
|
*/
|
|
@@ -13640,7 +13279,6 @@ export interface PlayAnimationOptions {
|
|
|
13640
13279
|
}
|
|
13641
13280
|
|
|
13642
13281
|
/**
|
|
13643
|
-
* @beta
|
|
13644
13282
|
* Additional options for how a sound plays for a player.
|
|
13645
13283
|
*/
|
|
13646
13284
|
export interface PlayerSoundOptions {
|
|
@@ -13666,7 +13304,6 @@ export interface PlayerSoundOptions {
|
|
|
13666
13304
|
}
|
|
13667
13305
|
|
|
13668
13306
|
/**
|
|
13669
|
-
* @beta
|
|
13670
13307
|
* Defines a JSON structure that is used for more flexible.
|
|
13671
13308
|
*/
|
|
13672
13309
|
export interface RawMessage {
|
|
@@ -13708,7 +13345,6 @@ export interface RawMessage {
|
|
|
13708
13345
|
}
|
|
13709
13346
|
|
|
13710
13347
|
/**
|
|
13711
|
-
* @beta
|
|
13712
13348
|
* Provides a description of a score token to use within a raw
|
|
13713
13349
|
* message.
|
|
13714
13350
|
*/
|
|
@@ -13745,7 +13381,6 @@ export interface RawText {
|
|
|
13745
13381
|
}
|
|
13746
13382
|
|
|
13747
13383
|
/**
|
|
13748
|
-
* @beta
|
|
13749
13384
|
* Represents a fully customizable color within Minecraft.
|
|
13750
13385
|
*/
|
|
13751
13386
|
export interface RGB {
|
|
@@ -13773,7 +13408,6 @@ export interface RGB {
|
|
|
13773
13408
|
}
|
|
13774
13409
|
|
|
13775
13410
|
/**
|
|
13776
|
-
* @beta
|
|
13777
13411
|
* Represents a fully customizable color within Minecraft.
|
|
13778
13412
|
*/
|
|
13779
13413
|
export interface RGBA {
|
|
@@ -13808,7 +13442,6 @@ export interface RGBA {
|
|
|
13808
13442
|
}
|
|
13809
13443
|
|
|
13810
13444
|
/**
|
|
13811
|
-
* @beta
|
|
13812
13445
|
* Contains additional options for how a scoreboard should be
|
|
13813
13446
|
* displayed within its display slot.
|
|
13814
13447
|
*/
|
|
@@ -13828,7 +13461,6 @@ export interface ScoreboardObjectiveDisplayOptions {
|
|
|
13828
13461
|
}
|
|
13829
13462
|
|
|
13830
13463
|
/**
|
|
13831
|
-
* @beta
|
|
13832
13464
|
* Contains additional options for registering a script event
|
|
13833
13465
|
* event callback.
|
|
13834
13466
|
*/
|
|
@@ -13843,7 +13475,6 @@ export interface ScriptEventMessageFilterOptions {
|
|
|
13843
13475
|
}
|
|
13844
13476
|
|
|
13845
13477
|
/**
|
|
13846
|
-
* @beta
|
|
13847
13478
|
* Contains additional options for teleporting an entity.
|
|
13848
13479
|
*/
|
|
13849
13480
|
export interface TeleportOptions {
|
|
@@ -13883,7 +13514,6 @@ export interface TeleportOptions {
|
|
|
13883
13514
|
}
|
|
13884
13515
|
|
|
13885
13516
|
/**
|
|
13886
|
-
* @beta
|
|
13887
13517
|
* Contains additional options for displaying a title and
|
|
13888
13518
|
* optional subtitle.
|
|
13889
13519
|
*/
|
|
@@ -13922,7 +13552,6 @@ export interface TitleDisplayOptions {
|
|
|
13922
13552
|
}
|
|
13923
13553
|
|
|
13924
13554
|
/**
|
|
13925
|
-
* @beta
|
|
13926
13555
|
* Represents a two-directional vector.
|
|
13927
13556
|
*/
|
|
13928
13557
|
export interface Vector2 {
|
|
@@ -13941,7 +13570,6 @@ export interface Vector2 {
|
|
|
13941
13570
|
}
|
|
13942
13571
|
|
|
13943
13572
|
/**
|
|
13944
|
-
* @beta
|
|
13945
13573
|
* Contains a description of a vector.
|
|
13946
13574
|
*/
|
|
13947
13575
|
export interface Vector3 {
|
|
@@ -13966,7 +13594,6 @@ export interface Vector3 {
|
|
|
13966
13594
|
}
|
|
13967
13595
|
|
|
13968
13596
|
/**
|
|
13969
|
-
* @beta
|
|
13970
13597
|
* Contains additional options for a world-level playSound
|
|
13971
13598
|
* occurrence.
|
|
13972
13599
|
*/
|
|
@@ -13985,32 +13612,22 @@ export interface WorldSoundOptions {
|
|
|
13985
13612
|
volume?: number;
|
|
13986
13613
|
}
|
|
13987
13614
|
|
|
13988
|
-
/**
|
|
13989
|
-
* @beta
|
|
13990
|
-
*/
|
|
13991
13615
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
13992
13616
|
export class CommandError extends Error {
|
|
13993
13617
|
private constructor();
|
|
13994
13618
|
}
|
|
13995
13619
|
|
|
13996
|
-
/**
|
|
13997
|
-
* @beta
|
|
13998
|
-
*/
|
|
13999
13620
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
14000
13621
|
export class LocationInUnloadedChunkError extends Error {
|
|
14001
13622
|
private constructor();
|
|
14002
13623
|
}
|
|
14003
13624
|
|
|
14004
|
-
/**
|
|
14005
|
-
* @beta
|
|
14006
|
-
*/
|
|
14007
13625
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
14008
13626
|
export class LocationOutOfWorldBoundariesError extends Error {
|
|
14009
13627
|
private constructor();
|
|
14010
13628
|
}
|
|
14011
13629
|
|
|
14012
13630
|
/**
|
|
14013
|
-
* @beta
|
|
14014
13631
|
* @remarks
|
|
14015
13632
|
* Holds the number of MoonPhases
|
|
14016
13633
|
*
|