@minecraft/server 1.2.0-beta.1.19.80-preview.21 → 1.2.0-beta.1.19.80-preview.23

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.
Files changed (2) hide show
  1. package/index.d.ts +410 -606
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -16,7 +16,7 @@
16
16
  * ```json
17
17
  * {
18
18
  * "module_name": "@minecraft/server",
19
- * "version": "1.2.0-internal.1.19.80-preview.21"
19
+ * "version": "1.2.0-internal.1.19.80-preview.23"
20
20
  * }
21
21
  * ```
22
22
  *
@@ -110,6 +110,9 @@ export enum DyeColor {
110
110
  white = 'white',
111
111
  yellow = 'yellow',
112
112
  }
113
+ /**
114
+ * @beta
115
+ */
113
116
  export enum EntityDamageCause {
114
117
  anvil = 'anvil',
115
118
  blockExplosion = 'blockExplosion',
@@ -143,6 +146,9 @@ export enum EntityDamageCause {
143
146
  'void' = 'void',
144
147
  wither = 'wither',
145
148
  }
149
+ /**
150
+ * @beta
151
+ */
146
152
  export enum EquipmentSlot {
147
153
  chest = 'chest',
148
154
  feet = 'feet',
@@ -211,11 +217,17 @@ export enum GameMode {
211
217
  */
212
218
  survival = 'survival',
213
219
  }
220
+ /**
221
+ * @beta
222
+ */
214
223
  export enum ItemLockMode {
215
224
  inventory = 'inventory',
216
225
  none = 'none',
217
226
  slot = 'slot',
218
227
  }
228
+ /**
229
+ * @beta
230
+ */
219
231
  export enum MessageSourceType {
220
232
  clientScript = 'clientScript',
221
233
  commandBlock = 'commandBlock',
@@ -266,6 +278,9 @@ export enum ScoreboardIdentityType {
266
278
  */
267
279
  player = 'player',
268
280
  }
281
+ /**
282
+ * @beta
283
+ */
269
284
  export enum TimeOfDay {
270
285
  Day = 1000,
271
286
  Noon = 6000,
@@ -296,159 +311,114 @@ export enum WatchdogTerminateReason {
296
311
  }
297
312
  /**
298
313
  * @beta
299
- * An event that fires as players enter chat messages.
300
314
  */
301
315
  export class BeforeChatEvent extends ChatEvent {
302
316
  protected constructor();
303
- /**
304
- * If set to true in a beforeChat event handler, this message
305
- * is not broadcast out.
306
- */
307
317
  cancel: boolean;
308
318
  setTargets(players: Player[]): void;
309
319
  }
310
- // tslint:disable-next-line:no-unnecessary-class
320
+ /**
321
+ * @beta
322
+ */
311
323
  export class BeforeChatEventSignal_deprecated extends IBeforeChatEventSignal_deprecated {
312
324
  protected constructor();
313
325
  }
314
326
  /**
315
327
  * @beta
316
- * Contains information related to firing of a data driven
317
- * entity event - for example, the minecraft:ageable_grow_up
318
- * event on a chicken.
319
328
  */
320
329
  export class BeforeDataDrivenEntityTriggerEvent {
321
330
  protected constructor();
322
- /**
323
- * If set to true, this entity event is not triggered.
324
- */
325
331
  cancel: boolean;
326
- /**
327
- * Entity that the event triggered on.
328
- */
329
332
  readonly entity: Entity;
330
- /**
331
- * Name of the data driven event being triggered.
332
- */
333
333
  readonly id: string;
334
334
  getModifiers(): DefinitionModifier[];
335
335
  setModifiers(modifiers: DefinitionModifier[]): void;
336
336
  }
337
- // tslint:disable-next-line:no-unnecessary-class
337
+ /**
338
+ * @beta
339
+ */
338
340
  export class BeforeDataDrivenEntityTriggerEventSignal_deprecated extends IBeforeDataDrivenEntityTriggerEventSignal_deprecated {
339
341
  protected constructor();
340
342
  }
341
343
  /**
342
344
  * @beta
343
- * Contains information regarding an explosion that has
344
- * happened.
345
345
  */
346
346
  export class BeforeExplosionEvent extends ExplosionEvent {
347
347
  protected constructor();
348
- /**
349
- * If set to true, cancels the explosion event.
350
- */
351
348
  cancel: boolean;
352
349
  setImpactedBlocks(blocks: Vector3[]): void;
353
350
  }
354
- // tslint:disable-next-line:no-unnecessary-class
351
+ /**
352
+ * @beta
353
+ */
355
354
  export class BeforeExplosionEventSignal_deprecated extends IBeforeExplosionEventSignal_deprecated {
356
355
  protected constructor();
357
356
  }
358
- // tslint:disable-next-line:no-unnecessary-class
357
+ /**
358
+ * @beta
359
+ */
359
360
  export class BeforeItemDefinitionEventSignal_deprecated extends IBeforeItemDefinitionEventSignal_deprecated {
360
361
  protected constructor();
361
362
  }
362
363
  /**
363
364
  * @beta
364
- * Contains information related to a triggering of a custom
365
- * item definition change.
366
365
  */
367
366
  export class BeforeItemDefinitionTriggeredEvent extends ItemDefinitionTriggeredEvent {
368
367
  protected constructor();
369
- /**
370
- * If set to true, will cancel the application of this item
371
- * definition change.
372
- */
373
368
  cancel: boolean;
374
369
  }
375
370
  /**
376
371
  * @beta
377
- * Contains information related to an item being used.
378
372
  */
379
373
  export class BeforeItemUseEvent extends ItemUseEvent {
380
374
  protected constructor();
381
- /**
382
- * If set to true, this will cancel the item use behavior.
383
- */
384
375
  cancel: boolean;
385
376
  }
386
- // tslint:disable-next-line:no-unnecessary-class
377
+ /**
378
+ * @beta
379
+ */
387
380
  export class BeforeItemUseEventSignal_deprecated extends IBeforeItemUseEventSignal_deprecated {
388
381
  protected constructor();
389
382
  }
390
383
  /**
391
384
  * @beta
392
- * Contains information related to an item being used on a
393
- * block.
394
385
  */
395
386
  export class BeforeItemUseOnEvent extends ItemUseOnEvent {
396
387
  protected constructor();
397
- /**
398
- * If set to true, this will cancel the item use behavior.
399
- */
400
388
  cancel: boolean;
401
389
  }
402
- // tslint:disable-next-line:no-unnecessary-class
390
+ /**
391
+ * @beta
392
+ */
403
393
  export class BeforeItemUseOnEventSignal_deprecated extends IBeforeItemUseOnEventSignal_deprecated {
404
394
  protected constructor();
405
395
  }
406
396
  /**
407
397
  * @beta
408
- * Contains information related to changes before a piston
409
- * expands or retracts.
410
398
  */
411
399
  export class BeforePistonActivateEvent extends BlockEvent {
412
400
  protected constructor();
413
- /**
414
- * If this is set to true within an event handler, the piston
415
- * activation is canceled.
416
- */
417
401
  cancel: boolean;
418
- /**
419
- * True if the piston is the process of expanding.
420
- */
421
402
  readonly isExpanding: boolean;
422
- /**
423
- * Contains additional properties and details of the piston.
424
- */
425
403
  readonly piston: BlockPistonComponent;
426
404
  }
427
- // tslint:disable-next-line:no-unnecessary-class
405
+ /**
406
+ * @beta
407
+ */
428
408
  export class BeforePistonActivateEventSignal_deprecated extends IBeforePistonActivateEventSignal_deprecated {
429
409
  protected constructor();
430
410
  }
431
411
  /**
432
412
  * @beta
433
- * Contains information related to a script watchdog
434
- * termination.
435
413
  */
436
414
  export class BeforeWatchdogTerminateEvent {
437
415
  protected constructor();
438
- /**
439
- * If set to true, cancels the termination of the script
440
- * runtime. Note that depending on server configuration
441
- * settings, cancellation of the termination may not be
442
- * allowed.
443
- */
444
416
  cancel: boolean;
445
- /**
446
- * Contains the reason why a script runtime is to be
447
- * terminated.
448
- */
449
417
  readonly terminateReason: WatchdogTerminateReason;
450
418
  }
451
- // tslint:disable-next-line:no-unnecessary-class
419
+ /**
420
+ * @beta
421
+ */
452
422
  export class BeforeWatchdogTerminateEventSignal_deprecated extends IBeforeWatchdogTerminateEventSignal {
453
423
  protected constructor();
454
424
  }
@@ -537,6 +507,9 @@ export class Block {
537
507
  * @throws This function can throw errors.
538
508
  */
539
509
  getComponent(componentName: string): BlockComponent | undefined;
510
+ /**
511
+ * @beta
512
+ */
540
513
  getItemStack(amount?: number, withData?: boolean): ItemStack;
541
514
  /**
542
515
  * @beta
@@ -582,8 +555,20 @@ export class Block {
582
555
  * ```
583
556
  */
584
557
  hasTag(tag: string): boolean;
558
+ /**
559
+ * @beta
560
+ * @throws This function can throw errors.
561
+ */
585
562
  isAir(): boolean;
563
+ /**
564
+ * @beta
565
+ * @throws This function can throw errors.
566
+ */
586
567
  isLiquid(): boolean;
568
+ /**
569
+ * @beta
570
+ * @throws This function can throw errors.
571
+ */
587
572
  isSolid(): boolean;
588
573
  /**
589
574
  * @remarks
@@ -641,37 +626,26 @@ export class BlockAreaSize {
641
626
  /**
642
627
  * @remarks
643
628
  * Creates a new BlockAreaSize object.
644
- * @param x
645
- * @param y
646
- * @param z
647
629
  */
648
630
  constructor(x: number, y: number, z: number);
649
631
  /**
650
632
  * @remarks
651
633
  * Tests whether this block area size is equal to another
652
634
  * BlockAreaSize object.
653
- * @param other
654
635
  */
655
636
  equals(other: BlockAreaSize): boolean;
656
637
  }
657
638
  /**
658
639
  * @beta
659
- * Contains information regarding an event where a player
660
- * breaks a block.
661
640
  */
662
641
  export class BlockBreakEvent extends BlockEvent {
663
642
  protected constructor();
664
- /**
665
- * Returns permutation information about this block before it
666
- * was broken.
667
- */
668
643
  readonly brokenBlockPermutation: BlockPermutation;
669
- /**
670
- * Player that broke the block for this event.
671
- */
672
644
  readonly player: Player;
673
645
  }
674
- // tslint:disable-next-line:no-unnecessary-class
646
+ /**
647
+ * @beta
648
+ */
675
649
  export class BlockBreakEventSignal_deprecated extends IBlockBreakEventSignal {
676
650
  protected constructor();
677
651
  }
@@ -702,17 +676,14 @@ export class BlockEvent {
702
676
  }
703
677
  /**
704
678
  * @beta
705
- * Contains information regarding an explosion that has
706
- * occurred for a specific block.
707
679
  */
708
680
  export class BlockExplodeEvent extends BlockEvent {
709
681
  protected constructor();
710
- /**
711
- * Optional source of the explosion.
712
- */
713
682
  readonly source: Entity;
714
683
  }
715
- // tslint:disable-next-line:no-unnecessary-class
684
+ /**
685
+ * @beta
686
+ */
716
687
  export class BlockExplodeEventSignal_deprecated extends IBlockExplodeEventSignal {
717
688
  protected constructor();
718
689
  }
@@ -739,7 +710,6 @@ export class BlockInventoryComponent extends BlockComponent {
739
710
  * Represents a fluid container block that currently contains
740
711
  * lava.
741
712
  */
742
- // tslint:disable-next-line:no-unnecessary-class
743
713
  export class BlockLavaContainerComponent extends BlockLiquidContainerComponent {
744
714
  protected constructor();
745
715
  /**
@@ -748,6 +718,9 @@ export class BlockLavaContainerComponent extends BlockLiquidContainerComponent {
748
718
  */
749
719
  static readonly componentId = 'minecraft:lavaContainer';
750
720
  }
721
+ /**
722
+ * @beta
723
+ */
751
724
  export class BlockLiquidContainerComponent extends BlockComponent {
752
725
  protected constructor();
753
726
  fillLevel: number;
@@ -783,12 +756,14 @@ export class BlockPermutation {
783
756
  * permutation has.
784
757
  */
785
758
  getAllProperties(): Record<string, boolean | number | string>;
759
+ /**
760
+ * @beta
761
+ */
786
762
  getItemStack(amount?: number): ItemStack;
787
763
  /**
788
764
  * @beta
789
765
  * @remarks
790
766
  * Gets a property for the permutation.
791
- * @param propertyName
792
767
  * @returns
793
768
  * Returns the property if the permutation has it, else `null`.
794
769
  */
@@ -803,7 +778,6 @@ export class BlockPermutation {
803
778
  * @beta
804
779
  * @remarks
805
780
  * Checks to see if the permutation has a specific tag.
806
- * @param tag
807
781
  * @returns
808
782
  * Returns `true` if the permutation has the tag, else `false`.
809
783
  * @example check_block_tags.js
@@ -822,6 +796,10 @@ export class BlockPermutation {
822
796
  */
823
797
  hasTag(tag: string): boolean;
824
798
  matches(blockName: string, properties?: Record<string, boolean | number | string>): boolean;
799
+ /**
800
+ * @beta
801
+ * @throws This function can throw errors.
802
+ */
825
803
  withProperty(name: string, value: boolean | number | string): BlockPermutation;
826
804
  static resolve(blockName: string, properties?: Record<string, boolean | number | string>): BlockPermutation;
827
805
  }
@@ -866,17 +844,14 @@ export class BlockPistonComponent extends BlockComponent {
866
844
  }
867
845
  /**
868
846
  * @beta
869
- * Contains information regarding an event where a player
870
- * places a block.
871
847
  */
872
848
  export class BlockPlaceEvent extends BlockEvent {
873
849
  protected constructor();
874
- /**
875
- * Player that placed the block for this event.
876
- */
877
850
  readonly player: Player;
878
851
  }
879
- // tslint:disable-next-line:no-unnecessary-class
852
+ /**
853
+ * @beta
854
+ */
880
855
  export class BlockPlaceEventSignal_deprecated extends IBlockPlaceEventSignal {
881
856
  protected constructor();
882
857
  }
@@ -906,16 +881,21 @@ export class BlockPotionContainerComponent extends BlockLiquidContainerComponent
906
881
  * @beta
907
882
  * Returns an enumeration of available block properties.
908
883
  */
909
- // tslint:disable-next-line:no-unnecessary-class
910
884
  export class BlockProperties {
911
885
  protected constructor();
912
886
  static get(propertyName: string): BlockPropertyType;
913
887
  static getAll(): BlockPropertyType[];
914
888
  }
889
+ /**
890
+ * @beta
891
+ */
915
892
  export class BlockProperty {
916
893
  protected constructor();
917
894
  readonly name: string;
918
895
  }
896
+ /**
897
+ * @beta
898
+ */
919
899
  export class BlockPropertyType {
920
900
  protected constructor();
921
901
  readonly id: string;
@@ -949,7 +929,6 @@ export class BlockRecordPlayerComponent extends BlockComponent {
949
929
  /**
950
930
  * @remarks
951
931
  * Sets and plays a record based on an item type.
952
- * @param recordItemType
953
932
  * @throws This function can throw errors.
954
933
  */
955
934
  setRecord(recordItemType: ItemType): void;
@@ -1037,7 +1016,6 @@ export class BlockSignComponent extends BlockComponent {
1037
1016
  * Represents a fluid container block that currently contains
1038
1017
  * snow.
1039
1018
  */
1040
- // tslint:disable-next-line:no-unnecessary-class
1041
1019
  export class BlockSnowContainerComponent extends BlockLiquidContainerComponent {
1042
1020
  protected constructor();
1043
1021
  /**
@@ -1079,7 +1057,6 @@ export class BlockWaterContainerComponent extends BlockLiquidContainerComponent
1079
1057
  /**
1080
1058
  * @remarks
1081
1059
  * Adds an item and colors the water based on a dye item type.
1082
- * @param itemType
1083
1060
  * @throws This function can throw errors.
1084
1061
  */
1085
1062
  addDye(itemType: ItemType): void;
@@ -1088,43 +1065,30 @@ export class BlockWaterContainerComponent extends BlockLiquidContainerComponent
1088
1065
  }
1089
1066
  /**
1090
1067
  * @beta
1091
- * Contains information related to changes to a button push.
1092
1068
  */
1093
1069
  export class ButtonPushEvent extends BlockEvent {
1094
1070
  protected constructor();
1095
- /**
1096
- * Optional source that triggered the button push.
1097
- */
1098
1071
  readonly source: Entity;
1099
1072
  }
1100
- // tslint:disable-next-line:no-unnecessary-class
1073
+ /**
1074
+ * @beta
1075
+ */
1101
1076
  export class ButtonPushEventSignal_deprecated extends IButtonPushEventSignal {
1102
1077
  protected constructor();
1103
1078
  }
1104
1079
  /**
1105
1080
  * @beta
1106
- * An event that fires as players enter chat messages.
1107
1081
  */
1108
1082
  export class ChatEvent {
1109
1083
  protected constructor();
1110
- /**
1111
- * Message that is being broadcast. In a beforeChat event
1112
- * handler, _message_ can be updated with edits before the
1113
- * message is displayed to players.
1114
- */
1115
1084
  message: string;
1116
- /**
1117
- * Player that sent the chat message.
1118
- */
1119
1085
  sender: Player;
1120
- /**
1121
- * If true, this message is directly targeted to one or more
1122
- * players (i.e., is not broadcast.)
1123
- */
1124
1086
  sendToTargets: boolean;
1125
1087
  getTargets(): Player[];
1126
1088
  }
1127
- // tslint:disable-next-line:no-unnecessary-class
1089
+ /**
1090
+ * @beta
1091
+ */
1128
1092
  export class ChatEventSignal_deprecated extends IChatEventSignal {
1129
1093
  protected constructor();
1130
1094
  }
@@ -1140,6 +1104,9 @@ export class CommandResult {
1140
1104
  */
1141
1105
  readonly successCount: number;
1142
1106
  }
1107
+ /**
1108
+ * @beta
1109
+ */
1143
1110
  export class Component {
1144
1111
  protected constructor();
1145
1112
  readonly typeId: string;
@@ -1400,7 +1367,6 @@ export class ContainerSlot {
1400
1367
  * type and any custom data and properties associated with the
1401
1368
  * item stacks. The amount of each item stack is not taken into
1402
1369
  * consideration.
1403
- * @param itemStack
1404
1370
  * @throws
1405
1371
  * Throws if the slot's container is invalid.
1406
1372
  */
@@ -1410,7 +1376,6 @@ export class ContainerSlot {
1410
1376
  * The list of block types this item can break in Adventure
1411
1377
  * mode. The block names are displayed in the item's tooltip.
1412
1378
  * Setting the value to undefined will clear the list.
1413
- * @param blockIdentifiers
1414
1379
  * @throws
1415
1380
  * Throws if the slot's container is invalid. Also throws if
1416
1381
  * any of the provided block identifiers are invalid.
@@ -1422,7 +1387,6 @@ export class ContainerSlot {
1422
1387
  * Adventure mode. This is only applicable to block items. The
1423
1388
  * block names are displayed in the item's tooltip. Setting the
1424
1389
  * value to undefined will clear the list.
1425
- * @param blockIdentifiers
1426
1390
  * @throws
1427
1391
  * Throws if the slot's container is invalid. Also throws if
1428
1392
  * any of the provided block identifiers are invalid.
@@ -1433,7 +1397,6 @@ export class ContainerSlot {
1433
1397
  * @remarks
1434
1398
  * Sets the lore value - a secondary display string - for an
1435
1399
  * ItemStack.
1436
- * @param loreList
1437
1400
  * @throws
1438
1401
  * Throws if the slot's container is invalid.
1439
1402
  */
@@ -1441,23 +1404,16 @@ export class ContainerSlot {
1441
1404
  }
1442
1405
  /**
1443
1406
  * @beta
1444
- * Contains information related to firing of a data driven
1445
- * entity event - for example, the minecraft:ageable_grow_up
1446
- * event on a chicken.
1447
1407
  */
1448
1408
  export class DataDrivenEntityTriggerEvent {
1449
1409
  protected constructor();
1450
- /**
1451
- * Entity that the event triggered on.
1452
- */
1453
1410
  readonly entity: Entity;
1454
- /**
1455
- * Name of the data driven event being triggered.
1456
- */
1457
1411
  readonly id: string;
1458
1412
  getModifiers(): DefinitionModifier[];
1459
1413
  }
1460
- // tslint:disable-next-line:no-unnecessary-class
1414
+ /**
1415
+ * @beta
1416
+ */
1461
1417
  export class DataDrivenEntityTriggerEventSignal_deprecated extends IDataDrivenEntityTriggerEventSignal {
1462
1418
  protected constructor();
1463
1419
  }
@@ -1574,8 +1530,6 @@ export class Dimension {
1574
1530
  * @remarks
1575
1531
  * Gets the first block that intersects with a vector emanating
1576
1532
  * from a location.
1577
- * @param location
1578
- * @param direction
1579
1533
  * @param options
1580
1534
  * Additional options for processing this raycast query.
1581
1535
  * @throws This function can throw errors.
@@ -1628,8 +1582,6 @@ export class Dimension {
1628
1582
  * @remarks
1629
1583
  * Gets entities that intersect with a specified vector
1630
1584
  * emanating from a location.
1631
- * @param location
1632
- * @param direction
1633
1585
  * @param options
1634
1586
  * Additional options for processing this raycast query.
1635
1587
  * @throws This function can throw errors.
@@ -1648,6 +1600,10 @@ export class Dimension {
1648
1600
  * @throws This function can throw errors.
1649
1601
  */
1650
1602
  getPlayers(options?: EntityQueryOptions): Player[];
1603
+ /**
1604
+ * @beta
1605
+ * @throws This function can throw errors.
1606
+ */
1651
1607
  runCommand(commandString: string): CommandResult;
1652
1608
  /**
1653
1609
  * @remarks
@@ -1722,7 +1678,6 @@ export class Dimension {
1722
1678
  * @remarks
1723
1679
  * Creates a new item stack as an entity at the specified
1724
1680
  * location.
1725
- * @param item
1726
1681
  * @param location
1727
1682
  * The location at which to create the item stack.
1728
1683
  * @returns
@@ -1792,22 +1747,18 @@ export class DynamicPropertiesDefinition {
1792
1747
  /**
1793
1748
  * @remarks
1794
1749
  * Defines a boolean dynamic property.
1795
- * @param identifier
1796
1750
  * @throws This function can throw errors.
1797
1751
  */
1798
1752
  defineBoolean(identifier: string): void;
1799
1753
  /**
1800
1754
  * @remarks
1801
1755
  * Defines a number dynamic property.
1802
- * @param identifier
1803
1756
  * @throws This function can throw errors.
1804
1757
  */
1805
1758
  defineNumber(identifier: string): void;
1806
1759
  /**
1807
1760
  * @remarks
1808
1761
  * Defines a string dynamic property.
1809
- * @param identifier
1810
- * @param maxLength
1811
1762
  * @throws This function can throw errors.
1812
1763
  */
1813
1764
  defineString(identifier: string, maxLength: number): void;
@@ -1840,25 +1791,16 @@ export class Effect {
1840
1791
  }
1841
1792
  /**
1842
1793
  * @beta
1843
- * Contains information related to changes to an effect - like
1844
- * poison - being added to an entity.
1845
1794
  */
1846
1795
  export class EffectAddEvent {
1847
1796
  protected constructor();
1848
- /**
1849
- * Additional properties and details of the effect.
1850
- */
1851
1797
  effect: Effect;
1852
- /**
1853
- * Additional variant number for the effect.
1854
- */
1855
1798
  effectState: number;
1856
- /**
1857
- * Entity that the effect is being added to.
1858
- */
1859
1799
  entity: Entity;
1860
1800
  }
1861
- // tslint:disable-next-line:no-unnecessary-class
1801
+ /**
1802
+ * @beta
1803
+ */
1862
1804
  export class EffectAddEventSignal_deprecated extends IEffectAddEventSignal {
1863
1805
  protected constructor();
1864
1806
  }
@@ -1914,7 +1856,6 @@ export class EnchantmentList implements Iterable<Enchantment> {
1914
1856
  /**
1915
1857
  * @remarks
1916
1858
  * Creates a new EnchantmentList.
1917
- * @param enchantmentSlot
1918
1859
  */
1919
1860
  constructor(enchantmentSlot: number);
1920
1861
  [Symbol.iterator](): Iterator<Enchantment>;
@@ -1922,20 +1863,17 @@ export class EnchantmentList implements Iterable<Enchantment> {
1922
1863
  * @remarks
1923
1864
  * Attempts to add the enchantment to this collection. Returns
1924
1865
  * true if successful.
1925
- * @param enchantment
1926
1866
  */
1927
1867
  addEnchantment(enchantment: Enchantment): boolean;
1928
1868
  /**
1929
1869
  * @remarks
1930
1870
  * Returns whether or not the provided EnchantmentInstance can
1931
1871
  * be added to this collection.
1932
- * @param enchantment
1933
1872
  */
1934
1873
  canAddEnchantment(enchantment: Enchantment): boolean;
1935
1874
  /**
1936
1875
  * @remarks
1937
1876
  * Returns an enchantment associated with a type.
1938
- * @param enchantmentType
1939
1877
  */
1940
1878
  getEnchantment(enchantmentType: EnchantmentType): Enchantment;
1941
1879
  /**
@@ -1943,7 +1881,6 @@ export class EnchantmentList implements Iterable<Enchantment> {
1943
1881
  * If this collection has an EnchantmentInstance with type,
1944
1882
  * returns the level of the enchantment. Returns 0 if not
1945
1883
  * present.
1946
- * @param enchantmentType
1947
1884
  */
1948
1885
  hasEnchantment(enchantmentType: EnchantmentType): number;
1949
1886
  next(): IteratorResult<Enchantment>;
@@ -1951,7 +1888,6 @@ export class EnchantmentList implements Iterable<Enchantment> {
1951
1888
  * @remarks
1952
1889
  * Removes an EnchantmentInstance with type from this
1953
1890
  * collection if present.
1954
- * @param enchantmentType
1955
1891
  */
1956
1892
  removeEnchantment(enchantmentType: EnchantmentType): void;
1957
1893
  }
@@ -1960,7 +1896,6 @@ export class EnchantmentList implements Iterable<Enchantment> {
1960
1896
  * This enum represents the item slot or type that an
1961
1897
  * enchantment can be applied to.
1962
1898
  */
1963
- // tslint:disable-next-line:no-unnecessary-class
1964
1899
  export class EnchantmentSlot {
1965
1900
  protected constructor();
1966
1901
  static readonly all = -1;
@@ -2042,7 +1977,6 @@ export class Entity {
2042
1977
  nameTag: string;
2043
1978
  /**
2044
1979
  * @beta
2045
- * Returns a scoreboard identity that represents this entity.
2046
1980
  * @throws This property can throw when used.
2047
1981
  */
2048
1982
  readonly scoreboard: ScoreboardIdentity;
@@ -2069,7 +2003,6 @@ export class Entity {
2069
2003
  * Amount of time, in ticks, for the effect to apply.
2070
2004
  * @param amplifier
2071
2005
  * Optional amplification of the effect to apply.
2072
- * @param showParticles
2073
2006
  * @throws This function can throw errors.
2074
2007
  * @example addEffect.js
2075
2008
  * ```typescript
@@ -2120,15 +2053,23 @@ export class Entity {
2120
2053
  * Applies a set of damage to an entity.
2121
2054
  * @param amount
2122
2055
  * Amount of damage to apply.
2123
- * @param source
2124
- * Additional option about the source of damage, which may add
2125
- * additional effects or spur additional behaviors on this
2126
- * entity.
2127
2056
  * @throws This function can throw errors.
2128
2057
  */
2129
2058
  applyDamage(amount: number, source?: EntityDamageSource): boolean;
2059
+ /**
2060
+ * @beta
2061
+ * @throws This function can throw errors.
2062
+ */
2130
2063
  applyImpulse(vector: Vector3): void;
2064
+ /**
2065
+ * @beta
2066
+ * @throws This function can throw errors.
2067
+ */
2131
2068
  applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void;
2069
+ /**
2070
+ * @beta
2071
+ * @throws This function can throw errors.
2072
+ */
2132
2073
  clearVelocity(): void;
2133
2074
  /**
2134
2075
  * @beta
@@ -2147,7 +2088,6 @@ export class Entity {
2147
2088
  * @remarks
2148
2089
  * Returns the first intersecting block from the direction that
2149
2090
  * this entity is looking at.
2150
- * @param options
2151
2091
  * @throws This function can throw errors.
2152
2092
  */
2153
2093
  getBlockFromViewDirection(options?: BlockRaycastOptions): Block;
@@ -2174,7 +2114,6 @@ export class Entity {
2174
2114
  * @beta
2175
2115
  * @remarks
2176
2116
  * Returns a property value.
2177
- * @param identifier
2178
2117
  * @returns
2179
2118
  * Returns the value for the property, or undefined if the
2180
2119
  * property has not been set.
@@ -2186,7 +2125,6 @@ export class Entity {
2186
2125
  * @remarks
2187
2126
  * Returns the effect for the specified EffectType on the
2188
2127
  * entity, or undefined if the effect is not present.
2189
- * @param effectType
2190
2128
  * @returns
2191
2129
  * Effect object for the specified effect, or undefined if the
2192
2130
  * effect is not present.
@@ -2207,11 +2145,18 @@ export class Entity {
2207
2145
  * @remarks
2208
2146
  * Returns a potential set of entities from the direction that
2209
2147
  * this entity is looking at.
2210
- * @param options
2211
2148
  * @throws This function can throw errors.
2212
2149
  */
2213
2150
  getEntitiesFromViewDirection(options?: EntityRaycastOptions): Entity[];
2151
+ /**
2152
+ * @beta
2153
+ * @throws This function can throw errors.
2154
+ */
2214
2155
  getHeadLocation(): Vector3;
2156
+ /**
2157
+ * @beta
2158
+ * @throws This function can throw errors.
2159
+ */
2215
2160
  getRotation(): XYRotation;
2216
2161
  /**
2217
2162
  * @beta
@@ -2220,7 +2165,15 @@ export class Entity {
2220
2165
  * @throws This function can throw errors.
2221
2166
  */
2222
2167
  getTags(): string[];
2168
+ /**
2169
+ * @beta
2170
+ * @throws This function can throw errors.
2171
+ */
2223
2172
  getVelocity(): Vector3;
2173
+ /**
2174
+ * @beta
2175
+ * @throws This function can throw errors.
2176
+ */
2224
2177
  getViewDirection(): Vector3;
2225
2178
  /**
2226
2179
  * @beta
@@ -2246,15 +2199,21 @@ export class Entity {
2246
2199
  * @beta
2247
2200
  * @remarks
2248
2201
  * Kills this entity. The entity will drop loot as normal.
2202
+ * @returns
2203
+ * Returns true if entity can be killed (even if it is already
2204
+ * dead), otherwise it returns false.
2249
2205
  * @throws This function can throw errors.
2250
2206
  */
2251
2207
  kill(): void;
2208
+ /**
2209
+ * @beta
2210
+ * @throws This function can throw errors.
2211
+ */
2252
2212
  playAnimation(animationName: string, options?: PlayAnimationOptions): void;
2253
2213
  /**
2254
2214
  * @beta
2255
2215
  * @remarks
2256
2216
  * Removes a specified property.
2257
- * @param identifier
2258
2217
  * @throws This function can throw errors.
2259
2218
  */
2260
2219
  removeDynamicProperty(identifier: string): boolean;
@@ -2267,6 +2226,10 @@ export class Entity {
2267
2226
  * @throws This function can throw errors.
2268
2227
  */
2269
2228
  removeTag(tag: string): boolean;
2229
+ /**
2230
+ * @beta
2231
+ * @throws This function can throw errors.
2232
+ */
2270
2233
  runCommand(commandString: string): CommandResult;
2271
2234
  /**
2272
2235
  * @remarks
@@ -2286,7 +2249,6 @@ export class Entity {
2286
2249
  * @beta
2287
2250
  * @remarks
2288
2251
  * Sets a specified property to a value.
2289
- * @param identifier
2290
2252
  * @param value
2291
2253
  * Data value of the property to set.
2292
2254
  * @throws This function can throw errors.
@@ -2300,7 +2262,6 @@ export class Entity {
2300
2262
  * present, the entity is on fire.
2301
2263
  * @param seconds
2302
2264
  * Length of time to set the entity on fire.
2303
- * @param useEffects
2304
2265
  * @throws This function can throw errors.
2305
2266
  */
2306
2267
  setOnFire(seconds: number, useEffects?: boolean): boolean;
@@ -2308,8 +2269,6 @@ export class Entity {
2308
2269
  * @beta
2309
2270
  * @remarks
2310
2271
  * Sets the main rotation of the entity.
2311
- * @param degreesX
2312
- * @param degreesY
2313
2272
  * @throws This function can throw errors.
2314
2273
  */
2315
2274
  setRotation(degreesX: number, degreesY: number): void;
@@ -2325,7 +2284,6 @@ export class Entity {
2325
2284
  * X rotation of the entity after teleportation.
2326
2285
  * @param yRotation
2327
2286
  * Y rotation of the entity after teleportation.
2328
- * @param keepVelocity
2329
2287
  * @throws This function can throw errors.
2330
2288
  */
2331
2289
  teleport(
@@ -2346,7 +2304,6 @@ export class Entity {
2346
2304
  * Dimension to move the selected entity to.
2347
2305
  * @param facingLocation
2348
2306
  * Location that this entity will be facing.
2349
- * @param keepVelocity
2350
2307
  * @throws This function can throw errors.
2351
2308
  */
2352
2309
  teleportFacing(location: Vector3, dimension: Dimension, facingLocation: Vector3, keepVelocity?: boolean): void;
@@ -2416,6 +2373,9 @@ export class EntityAgeableComponent extends EntityComponent {
2416
2373
  getDropItems(): string[];
2417
2374
  getFeedItems(): EntityDefinitionFeedItem[];
2418
2375
  }
2376
+ /**
2377
+ * @beta
2378
+ */
2419
2379
  export class EntityAttributeComponent extends EntityComponent {
2420
2380
  protected constructor();
2421
2381
  readonly current: number;
@@ -2425,6 +2385,9 @@ export class EntityAttributeComponent extends EntityComponent {
2425
2385
  resetToMinValue(): void;
2426
2386
  setCurrent(value: number): boolean;
2427
2387
  }
2388
+ /**
2389
+ * @beta
2390
+ */
2428
2391
  export class EntityBaseMovementComponent extends EntityComponent {
2429
2392
  protected constructor();
2430
2393
  readonly maxTurn: number;
@@ -2498,7 +2461,6 @@ export class EntityBreathableComponent extends EntityComponent {
2498
2461
  * When added, this component signifies that the entity can
2499
2462
  * climb up ladders.
2500
2463
  */
2501
- // tslint:disable-next-line:no-unnecessary-class
2502
2464
  export class EntityCanClimbComponent extends EntityComponent {
2503
2465
  protected constructor();
2504
2466
  /**
@@ -2513,7 +2475,6 @@ export class EntityCanClimbComponent extends EntityComponent {
2513
2475
  * fly, and the pathfinder won't be restricted to paths where a
2514
2476
  * solid block is required underneath it.
2515
2477
  */
2516
- // tslint:disable-next-line:no-unnecessary-class
2517
2478
  export class EntityCanFlyComponent extends EntityComponent {
2518
2479
  protected constructor();
2519
2480
  /**
@@ -2527,7 +2488,6 @@ export class EntityCanFlyComponent extends EntityComponent {
2527
2488
  * When added, this component signifies that the entity can
2528
2489
  * power jump like the horse does within Minecraft.
2529
2490
  */
2530
- // tslint:disable-next-line:no-unnecessary-class
2531
2491
  export class EntityCanPowerJumpComponent extends EntityComponent {
2532
2492
  protected constructor();
2533
2493
  /**
@@ -2553,7 +2513,9 @@ export class EntityColorComponent extends EntityComponent {
2553
2513
  */
2554
2514
  static readonly componentId = 'minecraft:color';
2555
2515
  }
2556
- // tslint:disable-next-line:no-unnecessary-class
2516
+ /**
2517
+ * @beta
2518
+ */
2557
2519
  export class EntityComponent extends Component {
2558
2520
  protected constructor();
2559
2521
  }
@@ -2577,15 +2539,23 @@ export class EntityDefinitionFeedItem {
2577
2539
  */
2578
2540
  readonly item: string;
2579
2541
  }
2542
+ /**
2543
+ * @beta
2544
+ */
2580
2545
  export class EntityDieEvent {
2581
2546
  protected constructor();
2582
2547
  readonly damageSource: EntityDamageSource;
2583
2548
  readonly deadEntity: Entity;
2584
2549
  }
2585
- // tslint:disable-next-line:no-unnecessary-class
2550
+ /**
2551
+ * @beta
2552
+ */
2586
2553
  export class EntityDieEventSignal_deprecated extends IEntityDieEventSignal {
2587
2554
  protected constructor();
2588
2555
  }
2556
+ /**
2557
+ * @beta
2558
+ */
2589
2559
  export class EntityEquipmentInventoryComponent extends EntityComponent {
2590
2560
  protected constructor();
2591
2561
  static readonly componentId = 'minecraft:equipment_inventory';
@@ -2598,7 +2568,6 @@ export class EntityEquipmentInventoryComponent extends EntityComponent {
2598
2568
  * When added, this component signifies that this entity
2599
2569
  * doesn't take damage from fire.
2600
2570
  */
2601
- // tslint:disable-next-line:no-unnecessary-class
2602
2571
  export class EntityFireImmuneComponent extends EntityComponent {
2603
2572
  protected constructor();
2604
2573
  /**
@@ -2612,7 +2581,6 @@ export class EntityFireImmuneComponent extends EntityComponent {
2612
2581
  * When added, this component signifies that this entity can
2613
2582
  * float in liquid blocks.
2614
2583
  */
2615
- // tslint:disable-next-line:no-unnecessary-class
2616
2584
  export class EntityFloatsInLiquidComponent extends EntityComponent {
2617
2585
  protected constructor();
2618
2586
  /**
@@ -2701,7 +2669,6 @@ export class EntityHealableComponent extends EntityComponent {
2701
2669
  * @beta
2702
2670
  * Defines the health properties of an entity.
2703
2671
  */
2704
- // tslint:disable-next-line:no-unnecessary-class
2705
2672
  export class EntityHealthComponent extends EntityAttributeComponent {
2706
2673
  protected constructor();
2707
2674
  /**
@@ -2712,56 +2679,31 @@ export class EntityHealthComponent extends EntityAttributeComponent {
2712
2679
  }
2713
2680
  /**
2714
2681
  * @beta
2715
- * Contains information related to an entity hitting (melee
2716
- * attacking) another entity.
2717
2682
  */
2718
2683
  export class EntityHitEvent {
2719
2684
  protected constructor();
2720
- /**
2721
- * Entity that made a hit/melee attack.
2722
- */
2723
2685
  readonly entity: Entity;
2724
- /**
2725
- * Block that was hit by the attack, or undefined if the hit
2726
- * attack did not hit a block. If both hitEntity and hitBlock
2727
- * are undefined, then the entity basically swiped into the
2728
- * air.
2729
- */
2730
2686
  readonly hitBlock?: Block;
2731
- /**
2732
- * Entity that was hit by the attack, or undefined if the hit
2733
- * attack did not hit an entity. If both hitEntity and hitBlock
2734
- * are undefined, then the entity basically swiped into the
2735
- * air.
2736
- */
2737
2687
  readonly hitEntity?: Entity;
2738
2688
  }
2739
- // tslint:disable-next-line:no-unnecessary-class
2689
+ /**
2690
+ * @beta
2691
+ */
2740
2692
  export class EntityHitEventSignal_deprecated extends IEntityHitEventSignal {
2741
2693
  protected constructor();
2742
2694
  }
2743
2695
  /**
2744
2696
  * @beta
2745
- * Contains information related to an entity getting hurt by
2746
- * another entity.
2747
2697
  */
2748
2698
  export class EntityHurtEvent {
2749
2699
  protected constructor();
2750
- /**
2751
- * Describes the amount of damage caused.
2752
- */
2753
2700
  readonly damage: number;
2754
- /**
2755
- * Source information on the entity that may have applied this
2756
- * damage.
2757
- */
2758
2701
  readonly damageSource: EntityDamageSource;
2759
- /**
2760
- * Entity that was hurt.
2761
- */
2762
2702
  readonly hurtEntity: Entity;
2763
2703
  }
2764
- // tslint:disable-next-line:no-unnecessary-class
2704
+ /**
2705
+ * @beta
2706
+ */
2765
2707
  export class EntityHurtEventSignal_deprecated extends IEntityHurtEventSignal {
2766
2708
  protected constructor();
2767
2709
  }
@@ -2820,7 +2762,6 @@ export class EntityInventoryComponent extends EntityComponent {
2820
2762
  * When added, this component signifies that this entity is a
2821
2763
  * baby.
2822
2764
  */
2823
- // tslint:disable-next-line:no-unnecessary-class
2824
2765
  export class EntityIsBabyComponent extends EntityComponent {
2825
2766
  protected constructor();
2826
2767
  /**
@@ -2834,7 +2775,6 @@ export class EntityIsBabyComponent extends EntityComponent {
2834
2775
  * When added, this component signifies that this entity is
2835
2776
  * charged.
2836
2777
  */
2837
- // tslint:disable-next-line:no-unnecessary-class
2838
2778
  export class EntityIsChargedComponent extends EntityComponent {
2839
2779
  protected constructor();
2840
2780
  /**
@@ -2848,7 +2788,6 @@ export class EntityIsChargedComponent extends EntityComponent {
2848
2788
  * When added, this component signifies that this entity is
2849
2789
  * currently carrying a chest.
2850
2790
  */
2851
- // tslint:disable-next-line:no-unnecessary-class
2852
2791
  export class EntityIsChestedComponent extends EntityComponent {
2853
2792
  protected constructor();
2854
2793
  /**
@@ -2862,7 +2801,6 @@ export class EntityIsChestedComponent extends EntityComponent {
2862
2801
  * When added, this component signifies that dyes can be used
2863
2802
  * on this entity to change its color.
2864
2803
  */
2865
- // tslint:disable-next-line:no-unnecessary-class
2866
2804
  export class EntityIsDyableComponent extends EntityComponent {
2867
2805
  protected constructor();
2868
2806
  /**
@@ -2876,7 +2814,6 @@ export class EntityIsDyableComponent extends EntityComponent {
2876
2814
  * When added, this component signifies that this entity can
2877
2815
  * hide from hostile mobs while invisible.
2878
2816
  */
2879
- // tslint:disable-next-line:no-unnecessary-class
2880
2817
  export class EntityIsHiddenWhenInvisibleComponent extends EntityComponent {
2881
2818
  protected constructor();
2882
2819
  /**
@@ -2890,7 +2827,6 @@ export class EntityIsHiddenWhenInvisibleComponent extends EntityComponent {
2890
2827
  * When added, this component signifies that this entity this
2891
2828
  * currently on fire.
2892
2829
  */
2893
- // tslint:disable-next-line:no-unnecessary-class
2894
2830
  export class EntityIsIgnitedComponent extends EntityComponent {
2895
2831
  protected constructor();
2896
2832
  /**
@@ -2904,7 +2840,6 @@ export class EntityIsIgnitedComponent extends EntityComponent {
2904
2840
  * When added, this component signifies that this entity is an
2905
2841
  * illager captain.
2906
2842
  */
2907
- // tslint:disable-next-line:no-unnecessary-class
2908
2843
  export class EntityIsIllagerCaptainComponent extends EntityComponent {
2909
2844
  protected constructor();
2910
2845
  /**
@@ -2918,7 +2853,6 @@ export class EntityIsIllagerCaptainComponent extends EntityComponent {
2918
2853
  * When added, this component signifies that this entity is
2919
2854
  * currently saddled.
2920
2855
  */
2921
- // tslint:disable-next-line:no-unnecessary-class
2922
2856
  export class EntityIsSaddledComponent extends EntityComponent {
2923
2857
  protected constructor();
2924
2858
  /**
@@ -2932,7 +2866,6 @@ export class EntityIsSaddledComponent extends EntityComponent {
2932
2866
  * When added, this component signifies that this entity is
2933
2867
  * currently shaking.
2934
2868
  */
2935
- // tslint:disable-next-line:no-unnecessary-class
2936
2869
  export class EntityIsShakingComponent extends EntityComponent {
2937
2870
  protected constructor();
2938
2871
  /**
@@ -2946,7 +2879,6 @@ export class EntityIsShakingComponent extends EntityComponent {
2946
2879
  * When added, this component signifies that this entity is
2947
2880
  * currently sheared.
2948
2881
  */
2949
- // tslint:disable-next-line:no-unnecessary-class
2950
2882
  export class EntityIsShearedComponent extends EntityComponent {
2951
2883
  protected constructor();
2952
2884
  /**
@@ -2960,7 +2892,6 @@ export class EntityIsShearedComponent extends EntityComponent {
2960
2892
  * When added, this component signifies that this entity can be
2961
2893
  * stacked.
2962
2894
  */
2963
- // tslint:disable-next-line:no-unnecessary-class
2964
2895
  export class EntityIsStackableComponent extends EntityComponent {
2965
2896
  protected constructor();
2966
2897
  /**
@@ -2974,7 +2905,6 @@ export class EntityIsStackableComponent extends EntityComponent {
2974
2905
  * When added, this component signifies that this entity is
2975
2906
  * currently stunned.
2976
2907
  */
2977
- // tslint:disable-next-line:no-unnecessary-class
2978
2908
  export class EntityIsStunnedComponent extends EntityComponent {
2979
2909
  protected constructor();
2980
2910
  /**
@@ -2988,7 +2918,6 @@ export class EntityIsStunnedComponent extends EntityComponent {
2988
2918
  * When added, this component signifies that this entity is
2989
2919
  * currently tamed.
2990
2920
  */
2991
- // tslint:disable-next-line:no-unnecessary-class
2992
2921
  export class EntityIsTamedComponent extends EntityComponent {
2993
2922
  protected constructor();
2994
2923
  /**
@@ -3037,7 +2966,6 @@ export class EntityIterator implements Iterable<Entity> {
3037
2966
  * @beta
3038
2967
  * Defines the base movement speed in lava of this entity.
3039
2968
  */
3040
- // tslint:disable-next-line:no-unnecessary-class
3041
2969
  export class EntityLavaMovementComponent extends EntityAttributeComponent {
3042
2970
  protected constructor();
3043
2971
  /**
@@ -3158,7 +3086,6 @@ export class EntityMovementBasicComponent extends EntityComponent {
3158
3086
  * @beta
3159
3087
  * Defines the general movement speed of this entity.
3160
3088
  */
3161
- // tslint:disable-next-line:no-unnecessary-class
3162
3089
  export class EntityMovementComponent extends EntityAttributeComponent {
3163
3090
  protected constructor();
3164
3091
  /**
@@ -3171,7 +3098,6 @@ export class EntityMovementComponent extends EntityAttributeComponent {
3171
3098
  * @beta
3172
3099
  * When added, this move control causes the mob to fly.
3173
3100
  */
3174
- // tslint:disable-next-line:no-unnecessary-class
3175
3101
  export class EntityMovementFlyComponent extends EntityBaseMovementComponent {
3176
3102
  protected constructor();
3177
3103
  /**
@@ -3185,7 +3111,6 @@ export class EntityMovementFlyComponent extends EntityBaseMovementComponent {
3185
3111
  * When added, this move control allows a mob to fly, swim,
3186
3112
  * climb, etc.
3187
3113
  */
3188
- // tslint:disable-next-line:no-unnecessary-class
3189
3114
  export class EntityMovementGenericComponent extends EntityBaseMovementComponent {
3190
3115
  protected constructor();
3191
3116
  /**
@@ -3220,7 +3145,6 @@ export class EntityMovementGlideComponent extends EntityBaseMovementComponent {
3220
3145
  * @beta
3221
3146
  * When added, this move control causes the mob to hover.
3222
3147
  */
3223
- // tslint:disable-next-line:no-unnecessary-class
3224
3148
  export class EntityMovementHoverComponent extends EntityBaseMovementComponent {
3225
3149
  protected constructor();
3226
3150
  /**
@@ -3234,7 +3158,6 @@ export class EntityMovementHoverComponent extends EntityBaseMovementComponent {
3234
3158
  * Move control that causes the mob to jump as it moves with a
3235
3159
  * specified delay between jumps.
3236
3160
  */
3237
- // tslint:disable-next-line:no-unnecessary-class
3238
3161
  export class EntityMovementJumpComponent extends EntityBaseMovementComponent {
3239
3162
  protected constructor();
3240
3163
  /**
@@ -3248,7 +3171,6 @@ export class EntityMovementJumpComponent extends EntityBaseMovementComponent {
3248
3171
  * When added, this move control causes the mob to hop as it
3249
3172
  * moves.
3250
3173
  */
3251
- // tslint:disable-next-line:no-unnecessary-class
3252
3174
  export class EntityMovementSkipComponent extends EntityBaseMovementComponent {
3253
3175
  protected constructor();
3254
3176
  /**
@@ -3285,7 +3207,6 @@ export class EntityMovementSwayComponent extends EntityBaseMovementComponent {
3285
3207
  * Allows this entity to generate paths that include vertical
3286
3208
  * walls (for example, like Minecraft spiders do.)
3287
3209
  */
3288
- // tslint:disable-next-line:no-unnecessary-class
3289
3210
  export class EntityNavigationClimbComponent extends EntityNavigationComponent {
3290
3211
  protected constructor();
3291
3212
  /**
@@ -3294,6 +3215,9 @@ export class EntityNavigationClimbComponent extends EntityNavigationComponent {
3294
3215
  */
3295
3216
  static readonly componentId = 'minecraft:navigation.climb';
3296
3217
  }
3218
+ /**
3219
+ * @beta
3220
+ */
3297
3221
  export class EntityNavigationComponent extends EntityComponent {
3298
3222
  protected constructor();
3299
3223
  readonly avoidDamageBlocks: boolean;
@@ -3321,7 +3245,6 @@ export class EntityNavigationComponent extends EntityComponent {
3321
3245
  * Allows this entity to generate paths by flying around the
3322
3246
  * air like the regular Ghast.
3323
3247
  */
3324
- // tslint:disable-next-line:no-unnecessary-class
3325
3248
  export class EntityNavigationFloatComponent extends EntityNavigationComponent {
3326
3249
  protected constructor();
3327
3250
  /**
@@ -3335,7 +3258,6 @@ export class EntityNavigationFloatComponent extends EntityNavigationComponent {
3335
3258
  * Allows this entity to generate paths in the air (for
3336
3259
  * example, like Minecraft parrots do.)
3337
3260
  */
3338
- // tslint:disable-next-line:no-unnecessary-class
3339
3261
  export class EntityNavigationFlyComponent extends EntityNavigationComponent {
3340
3262
  protected constructor();
3341
3263
  /**
@@ -3350,7 +3272,6 @@ export class EntityNavigationFlyComponent extends EntityNavigationComponent {
3350
3272
  * flying and/or climbing around and jumping up and down a
3351
3273
  * block.
3352
3274
  */
3353
- // tslint:disable-next-line:no-unnecessary-class
3354
3275
  export class EntityNavigationGenericComponent extends EntityNavigationComponent {
3355
3276
  protected constructor();
3356
3277
  /**
@@ -3365,7 +3286,6 @@ export class EntityNavigationGenericComponent extends EntityNavigationComponent
3365
3286
  * example, like the Minecraft Bees do.) Keeps them from
3366
3287
  * falling out of the skies and doing predictive movement.
3367
3288
  */
3368
- // tslint:disable-next-line:no-unnecessary-class
3369
3289
  export class EntityNavigationHoverComponent extends EntityNavigationComponent {
3370
3290
  protected constructor();
3371
3291
  /**
@@ -3379,7 +3299,6 @@ export class EntityNavigationHoverComponent extends EntityNavigationComponent {
3379
3299
  * Allows this entity to generate paths by walking around and
3380
3300
  * jumping up and down a block like regular mobs.
3381
3301
  */
3382
- // tslint:disable-next-line:no-unnecessary-class
3383
3302
  export class EntityNavigationWalkComponent extends EntityNavigationComponent {
3384
3303
  protected constructor();
3385
3304
  /**
@@ -3566,17 +3485,14 @@ export class EntitySkinIdComponent extends EntityComponent {
3566
3485
  }
3567
3486
  /**
3568
3487
  * @beta
3569
- * Contains data related to an entity spawning within the
3570
- * world.
3571
3488
  */
3572
3489
  export class EntitySpawnEvent {
3573
3490
  protected constructor();
3574
- /**
3575
- * Entity that was spawned.
3576
- */
3577
3491
  entity: Entity;
3578
3492
  }
3579
- // tslint:disable-next-line:no-unnecessary-class
3493
+ /**
3494
+ * @beta
3495
+ */
3580
3496
  export class EntitySpawnEventSignal_deprecated extends IEntitySpawnEventSignal {
3581
3497
  protected constructor();
3582
3498
  }
@@ -3662,13 +3578,11 @@ export class EntityTypeIterator implements Iterable<EntityType> {
3662
3578
  * Used for accessing all entity types currently available for
3663
3579
  * use within the world.
3664
3580
  */
3665
- // tslint:disable-next-line:no-unnecessary-class
3666
3581
  export class EntityTypes {
3667
3582
  protected constructor();
3668
3583
  /**
3669
3584
  * @remarks
3670
3585
  * Retrieves an entity type using a string-based identifier.
3671
- * @param identifier
3672
3586
  */
3673
3587
  static get(identifier: string): EntityType;
3674
3588
  /**
@@ -3682,7 +3596,6 @@ export class EntityTypes {
3682
3596
  * Defines the general movement speed underwater of this
3683
3597
  * entity.
3684
3598
  */
3685
- // tslint:disable-next-line:no-unnecessary-class
3686
3599
  export class EntityUnderwaterMovementComponent extends EntityAttributeComponent {
3687
3600
  protected constructor();
3688
3601
  /**
@@ -3715,7 +3628,6 @@ export class EntityVariantComponent extends EntityComponent {
3715
3628
  * When added, this component signifies that this entity wants
3716
3629
  * to become a jockey.
3717
3630
  */
3718
- // tslint:disable-next-line:no-unnecessary-class
3719
3631
  export class EntityWantsJockeyComponent extends EntityComponent {
3720
3632
  protected constructor();
3721
3633
  /**
@@ -3731,11 +3643,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
3731
3643
  */
3732
3644
  export class Events {
3733
3645
  protected constructor();
3734
- /**
3735
- * This event fires before a chat message is broadcast or
3736
- * delivered. The event can be canceled, and the message can
3737
- * also be updated.
3738
- */
3739
3646
  readonly beforeChat: BeforeChatEventSignal_deprecated;
3740
3647
  /**
3741
3648
  * This event is fired before the triggering of an entity event
@@ -3787,10 +3694,6 @@ export class Events {
3787
3694
  * This event fires when a button is pushed.
3788
3695
  */
3789
3696
  readonly buttonPush: ButtonPushEventSignal_deprecated;
3790
- /**
3791
- * This event is triggered after a chat message has been
3792
- * broadcast or sent to players.
3793
- */
3794
3697
  readonly chat: ChatEventSignal_deprecated;
3795
3698
  /**
3796
3699
  * This event is fired when an entity event has been triggered
@@ -3912,22 +3815,16 @@ export class Events {
3912
3815
  }
3913
3816
  /**
3914
3817
  * @beta
3915
- * Contains information regarding an explosion that has
3916
- * happened.
3917
3818
  */
3918
3819
  export class ExplosionEvent {
3919
3820
  protected constructor();
3920
- /**
3921
- * Dimension where the explosion has occurred.
3922
- */
3923
3821
  readonly dimension: Dimension;
3924
- /**
3925
- * Optional source of the explosion.
3926
- */
3927
3822
  readonly source: Entity;
3928
3823
  getImpactedBlocks(): Vector3[];
3929
3824
  }
3930
- // tslint:disable-next-line:no-unnecessary-class
3825
+ /**
3826
+ * @beta
3827
+ */
3931
3828
  export class ExplosionEventSignal_deprecated extends IExplosionEventSignal {
3932
3829
  protected constructor();
3933
3830
  }
@@ -3984,7 +3881,6 @@ export class FeedItemEffect {
3984
3881
  * @beta
3985
3882
  * Represents a set of filters for when an event should occur.
3986
3883
  */
3987
- // tslint:disable-next-line:no-unnecessary-class
3988
3884
  export class FilterGroup {
3989
3885
  protected constructor();
3990
3886
  }
@@ -3992,7 +3888,6 @@ export class FilterGroup {
3992
3888
  * @beta
3993
3889
  * Represents constants related to fluid containers.
3994
3890
  */
3995
- // tslint:disable-next-line:no-unnecessary-class
3996
3891
  export class FluidContainer {
3997
3892
  protected constructor();
3998
3893
  /**
@@ -4006,11 +3901,17 @@ export class FluidContainer {
4006
3901
  */
4007
3902
  static readonly minFillLevel = 0;
4008
3903
  }
3904
+ /**
3905
+ * @beta
3906
+ */
4009
3907
  export class IBeforeChatEventSignal_deprecated {
4010
3908
  protected constructor();
4011
3909
  subscribe(callback: (arg: BeforeChatEvent) => void): (arg: BeforeChatEvent) => void;
4012
3910
  unsubscribe(callback: (arg: BeforeChatEvent) => void): void;
4013
3911
  }
3912
+ /**
3913
+ * @beta
3914
+ */
4014
3915
  export class IBeforeDataDrivenEntityTriggerEventSignal_deprecated {
4015
3916
  protected constructor();
4016
3917
  subscribe(
@@ -4019,11 +3920,17 @@ export class IBeforeDataDrivenEntityTriggerEventSignal_deprecated {
4019
3920
  ): (arg: BeforeDataDrivenEntityTriggerEvent) => void;
4020
3921
  unsubscribe(callback: (arg: BeforeDataDrivenEntityTriggerEvent) => void): void;
4021
3922
  }
3923
+ /**
3924
+ * @beta
3925
+ */
4022
3926
  export class IBeforeExplosionEventSignal_deprecated {
4023
3927
  protected constructor();
4024
3928
  subscribe(callback: (arg: BeforeExplosionEvent) => void): (arg: BeforeExplosionEvent) => void;
4025
3929
  unsubscribe(callback: (arg: BeforeExplosionEvent) => void): void;
4026
3930
  }
3931
+ /**
3932
+ * @beta
3933
+ */
4027
3934
  export class IBeforeItemDefinitionEventSignal_deprecated {
4028
3935
  protected constructor();
4029
3936
  subscribe(
@@ -4031,51 +3938,81 @@ export class IBeforeItemDefinitionEventSignal_deprecated {
4031
3938
  ): (arg: BeforeItemDefinitionTriggeredEvent) => void;
4032
3939
  unsubscribe(callback: (arg: BeforeItemDefinitionTriggeredEvent) => void): void;
4033
3940
  }
3941
+ /**
3942
+ * @beta
3943
+ */
4034
3944
  export class IBeforeItemUseEventSignal_deprecated {
4035
3945
  protected constructor();
4036
3946
  subscribe(callback: (arg: BeforeItemUseEvent) => void): (arg: BeforeItemUseEvent) => void;
4037
3947
  unsubscribe(callback: (arg: BeforeItemUseEvent) => void): void;
4038
3948
  }
3949
+ /**
3950
+ * @beta
3951
+ */
4039
3952
  export class IBeforeItemUseOnEventSignal_deprecated {
4040
3953
  protected constructor();
4041
3954
  subscribe(callback: (arg: BeforeItemUseOnEvent) => void): (arg: BeforeItemUseOnEvent) => void;
4042
3955
  unsubscribe(callback: (arg: BeforeItemUseOnEvent) => void): void;
4043
3956
  }
3957
+ /**
3958
+ * @beta
3959
+ */
4044
3960
  export class IBeforePistonActivateEventSignal_deprecated {
4045
3961
  protected constructor();
4046
3962
  subscribe(callback: (arg: BeforePistonActivateEvent) => void): (arg: BeforePistonActivateEvent) => void;
4047
3963
  unsubscribe(callback: (arg: BeforePistonActivateEvent) => void): void;
4048
3964
  }
3965
+ /**
3966
+ * @beta
3967
+ */
4049
3968
  export class IBeforeWatchdogTerminateEventSignal {
4050
3969
  protected constructor();
4051
3970
  subscribe(callback: (arg: BeforeWatchdogTerminateEvent) => void): (arg: BeforeWatchdogTerminateEvent) => void;
4052
3971
  unsubscribe(callback: (arg: BeforeWatchdogTerminateEvent) => void): void;
4053
3972
  }
3973
+ /**
3974
+ * @beta
3975
+ */
4054
3976
  export class IBlockBreakEventSignal {
4055
3977
  protected constructor();
4056
3978
  subscribe(callback: (arg: BlockBreakEvent) => void): (arg: BlockBreakEvent) => void;
4057
3979
  unsubscribe(callback: (arg: BlockBreakEvent) => void): void;
4058
3980
  }
3981
+ /**
3982
+ * @beta
3983
+ */
4059
3984
  export class IBlockExplodeEventSignal {
4060
3985
  protected constructor();
4061
3986
  subscribe(callback: (arg: BlockExplodeEvent) => void): (arg: BlockExplodeEvent) => void;
4062
3987
  unsubscribe(callback: (arg: BlockExplodeEvent) => void): void;
4063
3988
  }
3989
+ /**
3990
+ * @beta
3991
+ */
4064
3992
  export class IBlockPlaceEventSignal {
4065
3993
  protected constructor();
4066
3994
  subscribe(callback: (arg: BlockPlaceEvent) => void): (arg: BlockPlaceEvent) => void;
4067
3995
  unsubscribe(callback: (arg: BlockPlaceEvent) => void): void;
4068
3996
  }
3997
+ /**
3998
+ * @beta
3999
+ */
4069
4000
  export class IButtonPushEventSignal {
4070
4001
  protected constructor();
4071
4002
  subscribe(callback: (arg: ButtonPushEvent) => void): (arg: ButtonPushEvent) => void;
4072
4003
  unsubscribe(callback: (arg: ButtonPushEvent) => void): void;
4073
4004
  }
4005
+ /**
4006
+ * @beta
4007
+ */
4074
4008
  export class IChatEventSignal {
4075
4009
  protected constructor();
4076
4010
  subscribe(callback: (arg: ChatEvent) => void): (arg: ChatEvent) => void;
4077
4011
  unsubscribe(callback: (arg: ChatEvent) => void): void;
4078
4012
  }
4013
+ /**
4014
+ * @beta
4015
+ */
4079
4016
  export class IDataDrivenEntityTriggerEventSignal {
4080
4017
  protected constructor();
4081
4018
  subscribe(
@@ -4084,111 +4021,177 @@ export class IDataDrivenEntityTriggerEventSignal {
4084
4021
  ): (arg: DataDrivenEntityTriggerEvent) => void;
4085
4022
  unsubscribe(callback: (arg: DataDrivenEntityTriggerEvent) => void): void;
4086
4023
  }
4024
+ /**
4025
+ * @beta
4026
+ */
4087
4027
  export class IEffectAddEventSignal {
4088
4028
  protected constructor();
4089
4029
  subscribe(callback: (arg: EffectAddEvent) => void, options?: EntityEventOptions): (arg: EffectAddEvent) => void;
4090
4030
  unsubscribe(callback: (arg: EffectAddEvent) => void): void;
4091
4031
  }
4032
+ /**
4033
+ * @beta
4034
+ */
4092
4035
  export class IEntityDieEventSignal {
4093
4036
  protected constructor();
4094
4037
  subscribe(callback: (arg: EntityDieEvent) => void, options?: EntityEventOptions): (arg: EntityDieEvent) => void;
4095
4038
  unsubscribe(callback: (arg: EntityDieEvent) => void): void;
4096
4039
  }
4040
+ /**
4041
+ * @beta
4042
+ */
4097
4043
  export class IEntityHitEventSignal {
4098
4044
  protected constructor();
4099
4045
  subscribe(callback: (arg: EntityHitEvent) => void, options?: EntityEventOptions): (arg: EntityHitEvent) => void;
4100
4046
  unsubscribe(callback: (arg: EntityHitEvent) => void): void;
4101
4047
  }
4048
+ /**
4049
+ * @beta
4050
+ */
4102
4051
  export class IEntityHurtEventSignal {
4103
4052
  protected constructor();
4104
4053
  subscribe(callback: (arg: EntityHurtEvent) => void, options?: EntityEventOptions): (arg: EntityHurtEvent) => void;
4105
4054
  unsubscribe(callback: (arg: EntityHurtEvent) => void): void;
4106
4055
  }
4056
+ /**
4057
+ * @beta
4058
+ */
4107
4059
  export class IEntitySpawnEventSignal {
4108
4060
  protected constructor();
4109
4061
  subscribe(callback: (arg: EntitySpawnEvent) => void): (arg: EntitySpawnEvent) => void;
4110
4062
  unsubscribe(callback: (arg: EntitySpawnEvent) => void): void;
4111
4063
  }
4064
+ /**
4065
+ * @beta
4066
+ */
4112
4067
  export class IExplosionEventSignal {
4113
4068
  protected constructor();
4114
4069
  subscribe(callback: (arg: ExplosionEvent) => void): (arg: ExplosionEvent) => void;
4115
4070
  unsubscribe(callback: (arg: ExplosionEvent) => void): void;
4116
4071
  }
4072
+ /**
4073
+ * @beta
4074
+ */
4117
4075
  export class IItemCompleteChargeEventSignal {
4118
4076
  protected constructor();
4119
4077
  subscribe(callback: (arg: ItemCompleteChargeEvent) => void): (arg: ItemCompleteChargeEvent) => void;
4120
4078
  unsubscribe(callback: (arg: ItemCompleteChargeEvent) => void): void;
4121
4079
  }
4080
+ /**
4081
+ * @beta
4082
+ */
4122
4083
  export class IItemDefinitionEventSignal {
4123
4084
  protected constructor();
4124
4085
  subscribe(callback: (arg: ItemDefinitionTriggeredEvent) => void): (arg: ItemDefinitionTriggeredEvent) => void;
4125
4086
  unsubscribe(callback: (arg: ItemDefinitionTriggeredEvent) => void): void;
4126
4087
  }
4088
+ /**
4089
+ * @beta
4090
+ */
4127
4091
  export class IItemReleaseChargeEventSignal {
4128
4092
  protected constructor();
4129
4093
  subscribe(callback: (arg: ItemReleaseChargeEvent) => void): (arg: ItemReleaseChargeEvent) => void;
4130
4094
  unsubscribe(callback: (arg: ItemReleaseChargeEvent) => void): void;
4131
4095
  }
4096
+ /**
4097
+ * @beta
4098
+ */
4132
4099
  export class IItemStartChargeEventSignal {
4133
4100
  protected constructor();
4134
4101
  subscribe(callback: (arg: ItemStartChargeEvent) => void): (arg: ItemStartChargeEvent) => void;
4135
4102
  unsubscribe(callback: (arg: ItemStartChargeEvent) => void): void;
4136
4103
  }
4104
+ /**
4105
+ * @beta
4106
+ */
4137
4107
  export class IItemStartUseOnEventSignal {
4138
4108
  protected constructor();
4139
4109
  subscribe(callback: (arg: ItemStartUseOnEvent) => void): (arg: ItemStartUseOnEvent) => void;
4140
4110
  unsubscribe(callback: (arg: ItemStartUseOnEvent) => void): void;
4141
4111
  }
4112
+ /**
4113
+ * @beta
4114
+ */
4142
4115
  export class IItemStopChargeEventSignal {
4143
4116
  protected constructor();
4144
4117
  subscribe(callback: (arg: ItemStopChargeEvent) => void): (arg: ItemStopChargeEvent) => void;
4145
4118
  unsubscribe(callback: (arg: ItemStopChargeEvent) => void): void;
4146
4119
  }
4120
+ /**
4121
+ * @beta
4122
+ */
4147
4123
  export class IItemStopUseOnEventSignal {
4148
4124
  protected constructor();
4149
4125
  subscribe(callback: (arg: ItemStopUseOnEvent) => void): (arg: ItemStopUseOnEvent) => void;
4150
4126
  unsubscribe(callback: (arg: ItemStopUseOnEvent) => void): void;
4151
4127
  }
4128
+ /**
4129
+ * @beta
4130
+ */
4152
4131
  export class IItemUseEventSignal {
4153
4132
  protected constructor();
4154
4133
  subscribe(callback: (arg: ItemUseEvent) => void): (arg: ItemUseEvent) => void;
4155
4134
  unsubscribe(callback: (arg: ItemUseEvent) => void): void;
4156
4135
  }
4136
+ /**
4137
+ * @beta
4138
+ */
4157
4139
  export class IItemUseOnEventSignal {
4158
4140
  protected constructor();
4159
4141
  subscribe(callback: (arg: ItemUseOnEvent) => void): (arg: ItemUseOnEvent) => void;
4160
4142
  unsubscribe(callback: (arg: ItemUseOnEvent) => void): void;
4161
4143
  }
4144
+ /**
4145
+ * @beta
4146
+ */
4162
4147
  export class ILeverActionEventSignal {
4163
4148
  protected constructor();
4164
4149
  subscribe(callback: (arg: LeverActionEvent) => void): (arg: LeverActionEvent) => void;
4165
4150
  unsubscribe(callback: (arg: LeverActionEvent) => void): void;
4166
4151
  }
4152
+ /**
4153
+ * @beta
4154
+ */
4167
4155
  export class IPistonActivateEventSignal {
4168
4156
  protected constructor();
4169
4157
  subscribe(callback: (arg: PistonActivateEvent) => void): (arg: PistonActivateEvent) => void;
4170
4158
  unsubscribe(callback: (arg: PistonActivateEvent) => void): void;
4171
4159
  }
4160
+ /**
4161
+ * @beta
4162
+ */
4172
4163
  export class IPlayerJoinEventSignal {
4173
4164
  protected constructor();
4174
4165
  subscribe(callback: (arg: PlayerJoinEvent) => void): (arg: PlayerJoinEvent) => void;
4175
4166
  unsubscribe(callback: (arg: PlayerJoinEvent) => void): void;
4176
4167
  }
4168
+ /**
4169
+ * @beta
4170
+ */
4177
4171
  export class IPlayerLeaveEventSignal {
4178
4172
  protected constructor();
4179
4173
  subscribe(callback: (arg: PlayerLeaveEvent) => void): (arg: PlayerLeaveEvent) => void;
4180
4174
  unsubscribe(callback: (arg: PlayerLeaveEvent) => void): void;
4181
4175
  }
4176
+ /**
4177
+ * @beta
4178
+ */
4182
4179
  export class IPlayerSpawnEventSignal {
4183
4180
  protected constructor();
4184
4181
  subscribe(callback: (arg: PlayerSpawnEvent) => void): (arg: PlayerSpawnEvent) => void;
4185
4182
  unsubscribe(callback: (arg: PlayerSpawnEvent) => void): void;
4186
4183
  }
4184
+ /**
4185
+ * @beta
4186
+ */
4187
4187
  export class IProjectileHitEventSignal {
4188
4188
  protected constructor();
4189
4189
  subscribe(callback: (arg: ProjectileHitEvent) => void): (arg: ProjectileHitEvent) => void;
4190
4190
  unsubscribe(callback: (arg: ProjectileHitEvent) => void): void;
4191
4191
  }
4192
+ /**
4193
+ * @beta
4194
+ */
4192
4195
  export class IScriptEventCommandMessageSignal {
4193
4196
  protected constructor();
4194
4197
  subscribe(
@@ -4197,6 +4200,9 @@ export class IScriptEventCommandMessageSignal {
4197
4200
  ): (arg: ScriptEventCommandMessageEvent) => void;
4198
4201
  unsubscribe(callback: (arg: ScriptEventCommandMessageEvent) => void): void;
4199
4202
  }
4203
+ /**
4204
+ * @beta
4205
+ */
4200
4206
  export class IServerMessageSignal {
4201
4207
  protected constructor();
4202
4208
  subscribe(callback: (arg: MessageReceiveEvent) => void): (arg: MessageReceiveEvent) => void;
@@ -4204,30 +4210,22 @@ export class IServerMessageSignal {
4204
4210
  }
4205
4211
  /**
4206
4212
  * @beta
4207
- * Contains information related to a chargeable item completing
4208
- * being charged.
4209
4213
  */
4210
4214
  export class ItemCompleteChargeEvent {
4211
- protected constructor();
4212
- /**
4213
- * Returns the item stack that has completed charging.
4214
- */
4215
+ protected constructor();
4215
4216
  readonly itemStack: ItemStack;
4216
- /**
4217
- * Returns the source entity that triggered this item event.
4218
- */
4219
4217
  readonly source: Entity;
4220
- /**
4221
- * Returns the time, in ticks, for the remaining duration left
4222
- * before the charge completes its cycle.
4223
- */
4224
4218
  readonly useDuration: number;
4225
4219
  }
4226
- // tslint:disable-next-line:no-unnecessary-class
4220
+ /**
4221
+ * @beta
4222
+ */
4227
4223
  export class ItemCompleteChargeEventSignal_deprecated extends IItemCompleteChargeEventSignal {
4228
4224
  protected constructor();
4229
4225
  }
4230
- // tslint:disable-next-line:no-unnecessary-class
4226
+ /**
4227
+ * @beta
4228
+ */
4231
4229
  export class ItemComponent extends Component {
4232
4230
  protected constructor();
4233
4231
  }
@@ -4258,34 +4256,23 @@ export class ItemCooldownComponent extends ItemComponent {
4258
4256
  /**
4259
4257
  * @remarks
4260
4258
  * Starts a new cooldown period for this item.
4261
- * @param player
4262
4259
  * @throws This function can throw errors.
4263
4260
  */
4264
4261
  startCooldown(player: Player): void;
4265
4262
  }
4266
- // tslint:disable-next-line:no-unnecessary-class
4263
+ /**
4264
+ * @beta
4265
+ */
4267
4266
  export class ItemDefinitionEventSignal_deprecated extends IItemDefinitionEventSignal {
4268
4267
  protected constructor();
4269
4268
  }
4270
4269
  /**
4271
4270
  * @beta
4272
- * Contains information related to a custom item having a data
4273
- * definition change being triggered.
4274
4271
  */
4275
4272
  export class ItemDefinitionTriggeredEvent {
4276
4273
  protected constructor();
4277
- /**
4278
- * Name of the data-driven item event that is triggering this
4279
- * change.
4280
- */
4281
4274
  readonly eventName: string;
4282
- /**
4283
- * The impacted item stack that is being used.
4284
- */
4285
4275
  item: ItemStack;
4286
- /**
4287
- * Returns the source entity that triggered this item event.
4288
- */
4289
4276
  readonly source: Entity;
4290
4277
  }
4291
4278
  /**
@@ -4389,27 +4376,16 @@ export class ItemFoodComponent extends ItemComponent {
4389
4376
  }
4390
4377
  /**
4391
4378
  * @beta
4392
- * Contains information related to a chargeable item when the
4393
- * player has finished using the item and released the build
4394
- * action.
4395
4379
  */
4396
4380
  export class ItemReleaseChargeEvent {
4397
4381
  protected constructor();
4398
- /**
4399
- * Returns the item stack that triggered this item event.
4400
- */
4401
4382
  readonly itemStack: ItemStack;
4402
- /**
4403
- * Returns the source entity that triggered this item event.
4404
- */
4405
4383
  readonly source: Entity;
4406
- /**
4407
- * Returns the time, in ticks, for the remaining duration left
4408
- * before the charge completes its cycle.
4409
- */
4410
4384
  readonly useDuration: number;
4411
4385
  }
4412
- // tslint:disable-next-line:no-unnecessary-class
4386
+ /**
4387
+ * @beta
4388
+ */
4413
4389
  export class ItemReleaseChargeEventSignal_deprecated extends IItemReleaseChargeEventSignal {
4414
4390
  protected constructor();
4415
4391
  }
@@ -4418,7 +4394,6 @@ export class ItemReleaseChargeEventSignal_deprecated extends IItemReleaseChargeE
4418
4394
  * Represents a collection of all of the available item types
4419
4395
  * in Minecraft.
4420
4396
  */
4421
- // tslint:disable-next-line:no-unnecessary-class
4422
4397
  export class Items {
4423
4398
  protected constructor();
4424
4399
  /**
@@ -4558,7 +4533,6 @@ export class ItemStack {
4558
4533
  * type and any custom data and properties associated with the
4559
4534
  * item stacks. The amount of each item stack is not taken into
4560
4535
  * consideration.
4561
- * @param itemStack
4562
4536
  */
4563
4537
  isStackableWith(itemStack: ItemStack): boolean;
4564
4538
  /**
@@ -4566,7 +4540,6 @@ export class ItemStack {
4566
4540
  * The list of block types this item can break in Adventure
4567
4541
  * mode. The block names are displayed in the item's tooltip.
4568
4542
  * Setting the value to undefined will clear the list.
4569
- * @param blockIdentifiers
4570
4543
  * @throws
4571
4544
  * Throws if any of the provided block identifiers are invalid.
4572
4545
  * @example example.ts
@@ -4584,7 +4557,6 @@ export class ItemStack {
4584
4557
  * Adventure mode. This is only applicable to block items. The
4585
4558
  * block names are displayed in the item's tooltip. Setting the
4586
4559
  * value to undefined will clear the list.
4587
- * @param blockIdentifiers
4588
4560
  * @throws
4589
4561
  * Throws if any of the provided block identifiers are invalid.
4590
4562
  * @example example.ts
@@ -4600,7 +4572,6 @@ export class ItemStack {
4600
4572
  * @remarks
4601
4573
  * Sets the lore value - a secondary display string - for an
4602
4574
  * ItemStack.
4603
- * @param loreList
4604
4575
  * @example multilineLore.ts
4605
4576
  * ```typescript
4606
4577
  * // Set the lore of an item to multiple lines of text
@@ -4623,99 +4594,63 @@ export class ItemStack {
4623
4594
  }
4624
4595
  /**
4625
4596
  * @beta
4626
- * Contains information related to a chargeable item starting
4627
- * to be charged.
4628
4597
  */
4629
4598
  export class ItemStartChargeEvent {
4630
4599
  protected constructor();
4631
- /**
4632
- * The impacted item stack that is starting to be charged.
4633
- */
4634
4600
  readonly itemStack: ItemStack;
4635
- /**
4636
- * Returns the source entity that triggered this item event.
4637
- */
4638
4601
  readonly source: Entity;
4639
- /**
4640
- * Returns the time, in ticks, for the remaining duration left
4641
- * before the charge completes its cycle.
4642
- */
4643
4602
  readonly useDuration: number;
4644
4603
  }
4645
- // tslint:disable-next-line:no-unnecessary-class
4604
+ /**
4605
+ * @beta
4606
+ */
4646
4607
  export class ItemStartChargeEventSignal_deprecated extends IItemStartChargeEventSignal {
4647
4608
  protected constructor();
4648
4609
  }
4649
4610
  /**
4650
4611
  * @beta
4651
- * Contains information related to an item being used on a
4652
- * block.
4653
4612
  */
4654
4613
  export class ItemStartUseOnEvent {
4655
4614
  protected constructor();
4656
- /**
4657
- * The face of the block that an item is being used on.
4658
- */
4659
4615
  readonly blockFace: Direction;
4660
- /**
4661
- * The impacted item stack that is starting to be used.
4662
- */
4663
4616
  item: ItemStack;
4664
- /**
4665
- * Returns the source entity that triggered this item event.
4666
- */
4667
4617
  readonly source: Entity;
4668
4618
  getBlockLocation(): Vector3;
4669
4619
  getBuildBlockLocation(): Vector3;
4670
4620
  }
4671
- // tslint:disable-next-line:no-unnecessary-class
4621
+ /**
4622
+ * @beta
4623
+ */
4672
4624
  export class ItemStartUseOnEventSignal_deprecated extends IItemStartUseOnEventSignal {
4673
4625
  protected constructor();
4674
4626
  }
4675
4627
  /**
4676
4628
  * @beta
4677
- * Contains information related to a chargeable item has
4678
- * finished an items use cycle, or when the player has released
4679
- * the use action with the item.
4680
4629
  */
4681
4630
  export class ItemStopChargeEvent {
4682
4631
  protected constructor();
4683
- /**
4684
- * The impacted item stack that is stopping being charged.
4685
- */
4686
4632
  readonly itemStack: ItemStack;
4687
- /**
4688
- * Returns the source entity that triggered this item event.
4689
- */
4690
4633
  readonly source: Entity;
4691
- /**
4692
- * Returns the time, in ticks, for the remaining duration left
4693
- * before the charge completes its cycle.
4694
- */
4695
4634
  readonly useDuration: number;
4696
4635
  }
4697
- // tslint:disable-next-line:no-unnecessary-class
4636
+ /**
4637
+ * @beta
4638
+ */
4698
4639
  export class ItemStopChargeEventSignal_deprecated extends IItemStopChargeEventSignal {
4699
4640
  protected constructor();
4700
4641
  }
4701
4642
  /**
4702
4643
  * @beta
4703
- * Contains information related to an item that has stopped
4704
- * being used on a block.
4705
4644
  */
4706
4645
  export class ItemStopUseOnEvent {
4707
4646
  protected constructor();
4708
- /**
4709
- * The impacted item stack that is being used on a block.
4710
- */
4711
4647
  item: ItemStack;
4712
- /**
4713
- * Returns the source entity that triggered this item event.
4714
- */
4715
4648
  readonly source: Entity;
4716
4649
  getBlockLocation(): Vector3;
4717
4650
  }
4718
- // tslint:disable-next-line:no-unnecessary-class
4651
+ /**
4652
+ * @beta
4653
+ */
4719
4654
  export class ItemStopUseOnEventSignal_deprecated extends IItemStopUseOnEventSignal {
4720
4655
  protected constructor();
4721
4656
  }
@@ -4744,13 +4679,11 @@ export class ItemTypeIterator implements Iterable<ItemType> {
4744
4679
  * @beta
4745
4680
  * Returns the set of item types registered within Minecraft.
4746
4681
  */
4747
- // tslint:disable-next-line:no-unnecessary-class
4748
4682
  export class ItemTypes {
4749
4683
  protected constructor();
4750
4684
  /**
4751
4685
  * @remarks
4752
4686
  * Returns a specific item type, if available within Minecraft.
4753
- * @param itemId
4754
4687
  */
4755
4688
  static get(itemId: string): ItemType;
4756
4689
  /**
@@ -4762,63 +4695,47 @@ export class ItemTypes {
4762
4695
  }
4763
4696
  /**
4764
4697
  * @beta
4765
- * Contains information related to an item being used.
4766
4698
  */
4767
4699
  export class ItemUseEvent {
4768
4700
  protected constructor();
4769
- /**
4770
- * The impacted item stack that is being used.
4771
- */
4772
4701
  item: ItemStack;
4773
- /**
4774
- * Returns the source entity that triggered this item event.
4775
- */
4776
4702
  readonly source: Entity;
4777
4703
  }
4778
- // tslint:disable-next-line:no-unnecessary-class
4704
+ /**
4705
+ * @beta
4706
+ */
4779
4707
  export class ItemUseEventSignal_deprecated extends IItemUseEventSignal {
4780
4708
  protected constructor();
4781
4709
  }
4782
4710
  /**
4783
4711
  * @beta
4784
- * Contains information related to an item being used on a
4785
- * block.
4786
4712
  */
4787
4713
  export class ItemUseOnEvent {
4788
4714
  protected constructor();
4789
- /**
4790
- * The face of the block that an item is being used on.
4791
- */
4792
4715
  readonly blockFace: Direction;
4793
- /**
4794
- * X coordinate of the item-use impact location on the face of
4795
- * the target block.
4796
- */
4797
4716
  readonly faceLocationX: number;
4798
- /**
4799
- * Y coordinate of the item-use impact location on the face of
4800
- * the target block.
4801
- */
4802
4717
  readonly faceLocationY: number;
4803
- /**
4804
- * The impacted item stack that is being used on a block.
4805
- */
4806
4718
  item: ItemStack;
4807
- /**
4808
- * Returns the source entity that triggered this item event.
4809
- */
4810
4719
  readonly source: Entity;
4811
4720
  getBlockLocation(): Vector3;
4812
4721
  }
4813
- // tslint:disable-next-line:no-unnecessary-class
4722
+ /**
4723
+ * @beta
4724
+ */
4814
4725
  export class ItemUseOnEventSignal_deprecated extends IItemUseOnEventSignal {
4815
4726
  protected constructor();
4816
4727
  }
4728
+ /**
4729
+ * @beta
4730
+ */
4817
4731
  export class IWeatherChangeEventSignal {
4818
4732
  protected constructor();
4819
4733
  subscribe(callback: (arg: WeatherChangeEvent) => void): (arg: WeatherChangeEvent) => void;
4820
4734
  unsubscribe(callback: (arg: WeatherChangeEvent) => void): void;
4821
4735
  }
4736
+ /**
4737
+ * @beta
4738
+ */
4822
4739
  export class IWorldInitializeEventSignal {
4823
4740
  protected constructor();
4824
4741
  subscribe(callback: (arg: WorldInitializeEvent) => void): (arg: WorldInitializeEvent) => void;
@@ -4826,29 +4743,20 @@ export class IWorldInitializeEventSignal {
4826
4743
  }
4827
4744
  /**
4828
4745
  * @beta
4829
- * Contains information related to changes to a lever
4830
- * activating or deactivating.
4831
4746
  */
4832
4747
  export class LeverActionEvent extends BlockEvent {
4833
4748
  protected constructor();
4834
- /**
4835
- * True if the lever is activated (that is, transmitting
4836
- * power).
4837
- */
4838
4749
  readonly isPowered: boolean;
4839
- /**
4840
- * Optional player that triggered the lever activation.
4841
- */
4842
4750
  readonly player: Player;
4843
4751
  }
4844
- // tslint:disable-next-line:no-unnecessary-class
4752
+ /**
4753
+ * @beta
4754
+ */
4845
4755
  export class LeverActionEventSignal_deprecated extends ILeverActionEventSignal {
4846
4756
  protected constructor();
4847
4757
  }
4848
4758
  /**
4849
4759
  * @beta
4850
- * A specific currently-internal event used for passing
4851
- * messages from client to server.
4852
4760
  */
4853
4761
  export class MessageReceiveEvent {
4854
4762
  protected constructor();
@@ -4862,7 +4770,6 @@ export class MessageReceiveEvent {
4862
4770
  * Contains definitions of standard Minecraft and Minecraft
4863
4771
  * Education Edition block types.
4864
4772
  */
4865
- // tslint:disable-next-line:no-unnecessary-class
4866
4773
  export class MinecraftBlockTypes {
4867
4774
  protected constructor();
4868
4775
  /**
@@ -5169,6 +5076,7 @@ export class MinecraftBlockTypes {
5169
5076
  * Represents a calcite block within Minecraft.
5170
5077
  */
5171
5078
  static readonly calcite: BlockType;
5079
+ static readonly calibratedSculkSensor: BlockType;
5172
5080
  /**
5173
5081
  * Represents a camera within Minecraft Education Edition. It
5174
5082
  * is not available in Minecraft Bedrock Edition.
@@ -7970,7 +7878,6 @@ export class MinecraftBlockTypes {
7970
7878
  /**
7971
7879
  * @remarks
7972
7880
  * Returns a specific Minecraft block type given a type id.
7973
- * @param typeName
7974
7881
  */
7975
7882
  static get(typeName: string): BlockType;
7976
7883
  /**
@@ -7982,7 +7889,6 @@ export class MinecraftBlockTypes {
7982
7889
  /**
7983
7890
  * A collection of default Minecraft dimension types.
7984
7891
  */
7985
- // tslint:disable-next-line:no-unnecessary-class
7986
7892
  export class MinecraftDimensionTypes {
7987
7893
  protected constructor();
7988
7894
  /**
@@ -8017,7 +7923,6 @@ export class MinecraftDimensionTypes {
8017
7923
  * @beta
8018
7924
  * Returns available installed effect types within Minecraft.
8019
7925
  */
8020
- // tslint:disable-next-line:no-unnecessary-class
8021
7926
  export class MinecraftEffectTypes {
8022
7927
  protected constructor();
8023
7928
  static readonly absorption: EffectType;
@@ -8056,7 +7961,6 @@ export class MinecraftEffectTypes {
8056
7961
  * @beta
8057
7962
  * Describes a set of enchantment types.
8058
7963
  */
8059
- // tslint:disable-next-line:no-unnecessary-class
8060
7964
  export class MinecraftEnchantmentTypes {
8061
7965
  protected constructor();
8062
7966
  static readonly aquaAffinity: EnchantmentType;
@@ -8098,7 +8002,9 @@ export class MinecraftEnchantmentTypes {
8098
8002
  static readonly unbreaking: EnchantmentType;
8099
8003
  static readonly vanishing: EnchantmentType;
8100
8004
  }
8101
- // tslint:disable-next-line:no-unnecessary-class
8005
+ /**
8006
+ * @beta
8007
+ */
8102
8008
  export class MinecraftEntityTypes {
8103
8009
  protected constructor();
8104
8010
  static readonly agent: EntityType;
@@ -8219,7 +8125,6 @@ export class MinecraftEntityTypes {
8219
8125
  * Contains definitions of standard Minecraft and Minecraft
8220
8126
  * Education Edition block types.
8221
8127
  */
8222
- // tslint:disable-next-line:no-unnecessary-class
8223
8128
  export class MinecraftItemTypes {
8224
8129
  protected constructor();
8225
8130
  static readonly acaciaBoat: ItemType;
@@ -10897,8 +10802,6 @@ export class MolangVariableMap {
10897
10802
  * - `<variable_name>.r` - Red color value [0-1]
10898
10803
  * - `<variable_name>.g` - Green color value [0-1]
10899
10804
  * - `<variable_name>.b` - Blue color value [0-1]
10900
- * @param variableName
10901
- * @param color
10902
10805
  */
10903
10806
  setColorRGB(variableName: string, color: Color): MolangVariableMap;
10904
10807
  /**
@@ -10909,8 +10812,6 @@ export class MolangVariableMap {
10909
10812
  * - `<variable_name>.b` - Blue color value [0-1]
10910
10813
  * - `<variable_name>.a` - Alpha (transparency) color value
10911
10814
  * [0-1]
10912
- * @param variableName
10913
- * @param color
10914
10815
  */
10915
10816
  setColorRGBA(variableName: string, color: Color): MolangVariableMap;
10916
10817
  /**
@@ -10923,9 +10824,6 @@ export class MolangVariableMap {
10923
10824
  * Vector3} provided
10924
10825
  * - `<variable_name>.direction_z` - Z value from the {@link
10925
10826
  * Vector3} provided
10926
- * @param variableName
10927
- * @param speed
10928
- * @param direction
10929
10827
  */
10930
10828
  setSpeedAndDirection(variableName: string, speed: number, direction: Vector): MolangVariableMap;
10931
10829
  /**
@@ -10937,8 +10835,6 @@ export class MolangVariableMap {
10937
10835
  * provided
10938
10836
  * - `<variable_name>.z` - Z value from the {@link Vector3}
10939
10837
  * provided
10940
- * @param variableName
10941
- * @param vector
10942
10838
  */
10943
10839
  setVector3(variableName: string, vector: Vector): MolangVariableMap;
10944
10840
  }
@@ -10959,21 +10855,15 @@ export class NavigationResult {
10959
10855
  }
10960
10856
  /**
10961
10857
  * @beta
10962
- * Contains information related to changes to a piston
10963
- * expanding or retracting.
10964
10858
  */
10965
10859
  export class PistonActivateEvent extends BlockEvent {
10966
10860
  protected constructor();
10967
- /**
10968
- * True if the piston is the process of expanding.
10969
- */
10970
10861
  readonly isExpanding: boolean;
10971
- /**
10972
- * Contains additional properties and details of the piston.
10973
- */
10974
10862
  readonly piston: BlockPistonComponent;
10975
10863
  }
10976
- // tslint:disable-next-line:no-unnecessary-class
10864
+ /**
10865
+ * @beta
10866
+ */
10977
10867
  export class PistonActivateEventSignal_deprecated extends IPistonActivateEventSignal {
10978
10868
  protected constructor();
10979
10869
  }
@@ -10982,6 +10872,10 @@ export class PistonActivateEventSignal_deprecated extends IPistonActivateEventSi
10982
10872
  */
10983
10873
  export class Player extends Entity {
10984
10874
  protected constructor();
10875
+ /**
10876
+ * @beta
10877
+ * @throws This property can throw when used.
10878
+ */
10985
10879
  readonly level: number;
10986
10880
  /**
10987
10881
  * Name of the player.
@@ -10999,8 +10893,20 @@ export class Player extends Entity {
10999
10893
  * Manages the selected slot in the player's hotbar.
11000
10894
  */
11001
10895
  selectedSlot: number;
10896
+ /**
10897
+ * @beta
10898
+ * @throws This property can throw when used.
10899
+ */
11002
10900
  readonly spawnDimension?: Dimension;
10901
+ /**
10902
+ * @beta
10903
+ * @throws This property can throw when used.
10904
+ */
11003
10905
  readonly totalXpNeededForNextLevel: number;
10906
+ /**
10907
+ * @beta
10908
+ * @throws This property can throw when used.
10909
+ */
11004
10910
  readonly xpEarnedAtCurrentLevel: number;
11005
10911
  /**
11006
10912
  * @beta
@@ -11026,6 +10932,10 @@ export class Player extends Entity {
11026
10932
  * @throws This function can throw errors.
11027
10933
  */
11028
10934
  addLevels(amount: number): number;
10935
+ /**
10936
+ * @beta
10937
+ * @throws This function can throw errors.
10938
+ */
11029
10939
  clearSpawn(): void;
11030
10940
  /**
11031
10941
  * @beta
@@ -11038,6 +10948,10 @@ export class Player extends Entity {
11038
10948
  * @throws This function can throw errors.
11039
10949
  */
11040
10950
  getItemCooldown(itemCategory: string): number;
10951
+ /**
10952
+ * @beta
10953
+ * @throws This function can throw errors.
10954
+ */
11041
10955
  getSpawnPosition(): Vector3 | undefined;
11042
10956
  /**
11043
10957
  * @beta
@@ -11069,8 +10983,6 @@ export class Player extends Entity {
11069
10983
  * @remarks
11070
10984
  * This is an internal-facing method for posting a system
11071
10985
  * message to downstream clients.
11072
- * @param id
11073
- * @param value
11074
10986
  * @throws This function can throw errors.
11075
10987
  */
11076
10988
  postClientMessage(id: string, value: string): void;
@@ -11128,10 +11040,13 @@ export class Player extends Entity {
11128
11040
  * @remarks
11129
11041
  * Will change the specified players permissions, and whether
11130
11042
  * they are operator or not.
11131
- * @param isOp
11132
11043
  * @throws This function can throw errors.
11133
11044
  */
11134
11045
  setOp(isOp: boolean): void;
11046
+ /**
11047
+ * @beta
11048
+ * @throws This function can throw errors.
11049
+ */
11135
11050
  setSpawn(spawnPosition: Vector3, spawnDimension: Dimension): void;
11136
11051
  /**
11137
11052
  * @beta
@@ -11166,99 +11081,62 @@ export class PlayerIterator implements Iterable<Player> {
11166
11081
  }
11167
11082
  /**
11168
11083
  * @beta
11169
- * Contains information regarding a player that has joined.
11170
- * See the playerSpawn event for more detailed information that
11171
- * could be returned after the first time a player has spawned
11172
- * within the game.
11173
11084
  */
11174
11085
  export class PlayerJoinEvent {
11175
11086
  protected constructor();
11176
- /**
11177
- * Opaque string identifier of the player that joined the game.
11178
- */
11179
11087
  readonly playerId: string;
11180
- /**
11181
- * Name of the player that has joined.
11182
- */
11183
11088
  readonly playerName: string;
11184
11089
  }
11185
- // tslint:disable-next-line:no-unnecessary-class
11090
+ /**
11091
+ * @beta
11092
+ */
11186
11093
  export class PlayerJoinEventSignal_deprecated extends IPlayerJoinEventSignal {
11187
11094
  protected constructor();
11188
11095
  }
11189
11096
  /**
11190
11097
  * @beta
11191
- * Contains information regarding a player that has left the
11192
- * world.
11193
11098
  */
11194
11099
  export class PlayerLeaveEvent {
11195
11100
  protected constructor();
11196
- /**
11197
- * Opaque string identifier of the player that has left the
11198
- * event.
11199
- */
11200
11101
  readonly playerId: string;
11201
- /**
11202
- * Player that has left the world.
11203
- */
11204
11102
  readonly playerName: string;
11205
11103
  }
11206
- // tslint:disable-next-line:no-unnecessary-class
11104
+ /**
11105
+ * @beta
11106
+ */
11207
11107
  export class PlayerLeaveEventSignal_deprecated extends IPlayerLeaveEventSignal {
11208
11108
  protected constructor();
11209
11109
  }
11210
11110
  /**
11211
11111
  * @beta
11212
- * An event that contains more information about a player
11213
- * spawning.
11214
11112
  */
11215
11113
  export class PlayerSpawnEvent {
11216
11114
  protected constructor();
11217
- /**
11218
- * If true, this is the initial spawn of a player after joining
11219
- * the game.
11220
- */
11221
11115
  initialSpawn: boolean;
11222
- /**
11223
- * Object that represents the player that joined the game.
11224
- */
11225
11116
  player: Player;
11226
11117
  }
11227
- // tslint:disable-next-line:no-unnecessary-class
11118
+ /**
11119
+ * @beta
11120
+ */
11228
11121
  export class PlayerSpawnEventSignal_deprecated extends IPlayerSpawnEventSignal {
11229
11122
  protected constructor();
11230
11123
  }
11231
11124
  /**
11232
11125
  * @beta
11233
- * Contains information related to a projectile hitting an
11234
- * entity or block.
11235
11126
  */
11236
11127
  export class ProjectileHitEvent {
11237
11128
  protected constructor();
11238
- /**
11239
- * Dimension where this projectile hit took place.
11240
- */
11241
11129
  readonly dimension: Dimension;
11242
- /**
11243
- * Direction vector of the projectile as it hit a block/entity.
11244
- */
11245
11130
  readonly hitVector: Vector;
11246
- /**
11247
- * Location where the projectile hit occurred.
11248
- */
11249
11131
  readonly location: Vector3;
11250
- /**
11251
- * Entity for the projectile that hit a block/entity.
11252
- */
11253
11132
  readonly projectile: Entity;
11254
- /**
11255
- * Optional source entity that fired the projectile.
11256
- */
11257
11133
  readonly source: Entity;
11258
11134
  getBlockHit(): BlockHitInformation | undefined;
11259
11135
  getEntityHit(): EntityHitInformation | undefined;
11260
11136
  }
11261
- // tslint:disable-next-line:no-unnecessary-class
11137
+ /**
11138
+ * @beta
11139
+ */
11262
11140
  export class ProjectileHitEventSignal_deprecated extends IProjectileHitEventSignal {
11263
11141
  protected constructor();
11264
11142
  }
@@ -11274,8 +11152,6 @@ export class PropertyRegistry {
11274
11152
  * @remarks
11275
11153
  * Registers a dynamic property for a particular entity type
11276
11154
  * (e.g., a minecraft:skeleton.).
11277
- * @param propertiesDefinition
11278
- * @param entityType
11279
11155
  * @throws This function can throw errors.
11280
11156
  */
11281
11157
  registerEntityTypeDynamicProperties(
@@ -11285,7 +11161,6 @@ export class PropertyRegistry {
11285
11161
  /**
11286
11162
  * @remarks
11287
11163
  * Registers a globally available dynamic property for a world.
11288
- * @param propertiesDefinition
11289
11164
  * @throws This function can throw errors.
11290
11165
  */
11291
11166
  registerWorldDynamicProperties(propertiesDefinition: DynamicPropertiesDefinition): void;
@@ -11299,15 +11174,12 @@ export class Scoreboard {
11299
11174
  /**
11300
11175
  * @remarks
11301
11176
  * Adds a new objective to the scoreboard.
11302
- * @param objectiveId
11303
- * @param displayName
11304
11177
  * @throws This function can throw errors.
11305
11178
  */
11306
11179
  addObjective(objectiveId: string, displayName: string): ScoreboardObjective;
11307
11180
  /**
11308
11181
  * @remarks
11309
11182
  * Clears the objective that occupies a display slot.
11310
- * @param displaySlotId
11311
11183
  * @throws This function can throw errors.
11312
11184
  */
11313
11185
  clearObjectiveAtDisplaySlot(displaySlotId: string): ScoreboardObjective;
@@ -11323,7 +11195,6 @@ export class Scoreboard {
11323
11195
  * @remarks
11324
11196
  * Returns an objective that occupies the specified display
11325
11197
  * slot.
11326
- * @param displaySlotId
11327
11198
  * @throws This function can throw errors.
11328
11199
  */
11329
11200
  getObjectiveAtDisplaySlot(displaySlotId: string): ScoreboardObjectiveDisplayOptions;
@@ -11354,7 +11225,6 @@ export class Scoreboard {
11354
11225
  /**
11355
11226
  * @remarks
11356
11227
  * Removes an objective from the scoreboard.
11357
- * @param objectiveId
11358
11228
  * @throws This function can throw errors.
11359
11229
  */
11360
11230
  removeObjective(objectiveId: ScoreboardObjective | string): boolean;
@@ -11362,8 +11232,6 @@ export class Scoreboard {
11362
11232
  * @remarks
11363
11233
  * Sets an objective into a display slot with specified
11364
11234
  * additional display settings.
11365
- * @param displaySlotId
11366
- * @param objectiveDisplaySetting
11367
11235
  * @throws This function can throw errors.
11368
11236
  */
11369
11237
  setObjectiveAtDisplaySlot(
@@ -11377,7 +11245,6 @@ export class Scoreboard {
11377
11245
  * Objective to use for the scoreboard.
11378
11246
  * @param participant
11379
11247
  * Participant to apply the scoreboard value to.
11380
- * @param score
11381
11248
  * @throws This function can throw errors.
11382
11249
  */
11383
11250
  setScore(objective: ScoreboardObjective, participant: ScoreboardIdentity, score: number): boolean;
@@ -11529,7 +11396,6 @@ export class ScreenDisplay {
11529
11396
  * @remarks
11530
11397
  * Set the action bar text - a piece of text that displays
11531
11398
  * beneath the title and above the hot-bar.
11532
- * @param text
11533
11399
  * @throws This function can throw errors.
11534
11400
  */
11535
11401
  setActionBar(text: string): void;
@@ -11538,8 +11404,6 @@ export class ScreenDisplay {
11538
11404
  * Will cause a title to show up on the player's on screen
11539
11405
  * display. You can optionally specify an additional subtitle
11540
11406
  * as well as fade in, stay and fade out times.
11541
- * @param title
11542
- * @param options
11543
11407
  * @throws This function can throw errors.
11544
11408
  */
11545
11409
  setTitle(title: string, options?: TitleDisplayOptions): void;
@@ -11547,48 +11411,25 @@ export class ScreenDisplay {
11547
11411
  * @remarks
11548
11412
  * Updates the subtitle if the subtitle was previously
11549
11413
  * displayed via the setTitle method.
11550
- * @param subtitle
11551
11414
  * @throws This function can throw errors.
11552
11415
  */
11553
11416
  updateSubtitle(subtitle: string): void;
11554
11417
  }
11555
11418
  /**
11556
11419
  * @beta
11557
- * Returns additional data about a /scriptevent command
11558
- * invocation.
11559
11420
  */
11560
11421
  export class ScriptEventCommandMessageEvent {
11561
11422
  protected constructor();
11562
- /**
11563
- * Identifier of this ScriptEvent command message.
11564
- */
11565
11423
  readonly id: string;
11566
- /**
11567
- * If this command was initiated via an NPC, returns the entity
11568
- * that initiated the NPC dialogue.
11569
- */
11570
11424
  readonly initiator: Entity;
11571
- /**
11572
- * Optional additional data passed in with the script event
11573
- * command.
11574
- */
11575
11425
  readonly message: string;
11576
- /**
11577
- * Source block if this command was triggered via a block
11578
- * (e.g., a commandblock.)
11579
- */
11580
11426
  readonly sourceBlock: Block;
11581
- /**
11582
- * Source entity if this command was triggered by an entity
11583
- * (e.g., a NPC).
11584
- */
11585
11427
  readonly sourceEntity: Entity;
11586
- /**
11587
- * Returns the type of source that fired this command.
11588
- */
11589
11428
  readonly sourceType: MessageSourceType;
11590
11429
  }
11591
- // tslint:disable-next-line:no-unnecessary-class
11430
+ /**
11431
+ * @beta
11432
+ */
11592
11433
  export class ScriptEventCommandMessageSignal_deprecated extends IScriptEventCommandMessageSignal {
11593
11434
  protected constructor();
11594
11435
  }
@@ -11619,7 +11460,9 @@ export class Seat {
11619
11460
  */
11620
11461
  readonly position: Vector3;
11621
11462
  }
11622
- // tslint:disable-next-line:no-unnecessary-class
11463
+ /**
11464
+ * @beta
11465
+ */
11623
11466
  export class ServerMessageSignal_deprecated extends IServerMessageSignal {
11624
11467
  protected constructor();
11625
11468
  }
@@ -11644,7 +11487,6 @@ export class System {
11644
11487
  * @remarks
11645
11488
  * Cancels the execution of a function run that was previously
11646
11489
  * scheduled via the `run` function.
11647
- * @param runId
11648
11490
  */
11649
11491
  clearRun(runId: number): void;
11650
11492
  /**
@@ -11739,7 +11581,6 @@ export class Trigger {
11739
11581
  /**
11740
11582
  * @remarks
11741
11583
  * Creates a new trigger.
11742
- * @param eventName
11743
11584
  */
11744
11585
  constructor(eventName: string);
11745
11586
  }
@@ -11830,101 +11671,70 @@ export class Vector {
11830
11671
  /**
11831
11672
  * @remarks
11832
11673
  * Returns the addition of these vectors.
11833
- * @param a
11834
- * @param b
11835
11674
  */
11836
11675
  static add(a: Vector3, b: Vector3): Vector;
11837
11676
  /**
11838
11677
  * @remarks
11839
11678
  * Returns the cross product of these two vectors.
11840
- * @param a
11841
- * @param b
11842
11679
  */
11843
11680
  static cross(a: Vector3, b: Vector3): Vector;
11844
11681
  /**
11845
11682
  * @remarks
11846
11683
  * Returns the distance between two vectors.
11847
- * @param a
11848
- * @param b
11849
11684
  */
11850
11685
  static distance(a: Vector3, b: Vector3): number;
11851
11686
  /**
11852
11687
  * @remarks
11853
11688
  * Returns the component-wise division of these vectors.
11854
- * @param a
11855
- * @param b
11856
11689
  */
11857
11690
  static divide(a: Vector3, b: number | Vector3): Vector;
11858
11691
  /**
11859
11692
  * @remarks
11860
11693
  * Returns the linear interpolation between a and b using t as
11861
11694
  * the control.
11862
- * @param a
11863
- * @param b
11864
- * @param t
11865
11695
  */
11866
11696
  static lerp(a: Vector3, b: Vector3, t: number): Vector;
11867
11697
  /**
11868
11698
  * @remarks
11869
11699
  * Returns a vector that is made from the largest components of
11870
11700
  * two vectors.
11871
- * @param a
11872
- * @param b
11873
11701
  */
11874
11702
  static max(a: Vector3, b: Vector3): Vector;
11875
11703
  /**
11876
11704
  * @remarks
11877
11705
  * Returns a vector that is made from the smallest components
11878
11706
  * of two vectors.
11879
- * @param a
11880
- * @param b
11881
11707
  */
11882
11708
  static min(a: Vector3, b: Vector3): Vector;
11883
11709
  /**
11884
11710
  * @remarks
11885
11711
  * Returns the component-wise product of these vectors.
11886
- * @param a
11887
- * @param b
11888
11712
  */
11889
11713
  static multiply(a: Vector3, b: number | Vector3): Vector;
11890
11714
  /**
11891
11715
  * @remarks
11892
11716
  * Returns the spherical linear interpolation between a and b
11893
11717
  * using s as the control.
11894
- * @param a
11895
- * @param b
11896
- * @param s
11897
11718
  */
11898
11719
  static slerp(a: Vector3, b: Vector3, s: number): Vector;
11899
11720
  /**
11900
11721
  * @remarks
11901
11722
  * Returns the subtraction of these vectors.
11902
- * @param a
11903
- * @param b
11904
11723
  */
11905
11724
  static subtract(a: Vector3, b: Vector3): Vector;
11906
11725
  }
11907
11726
  /**
11908
11727
  * @beta
11909
- * Contains information related to changes in weather in the
11910
- * environment.
11911
11728
  */
11912
11729
  export class WeatherChangeEvent {
11913
11730
  protected constructor();
11914
- /**
11915
- * Dimension in which the weather has changed.
11916
- */
11917
11731
  readonly dimension: string;
11918
- /**
11919
- * Whether it is lightning after the change in weather.
11920
- */
11921
11732
  readonly lightning: boolean;
11922
- /**
11923
- * Whether it is raining after the change in weather.
11924
- */
11925
11733
  readonly raining: boolean;
11926
11734
  }
11927
- // tslint:disable-next-line:no-unnecessary-class
11735
+ /**
11736
+ * @beta
11737
+ */
11928
11738
  export class WeatherChangeEventSignal_deprecated extends IWeatherChangeEventSignal {
11929
11739
  protected constructor();
11930
11740
  }
@@ -11951,8 +11761,6 @@ export class World {
11951
11761
  * @remarks
11952
11762
  * A method that is internal-only, used for broadcasting
11953
11763
  * specific messages between client and server.
11954
- * @param id
11955
- * @param value
11956
11764
  */
11957
11765
  broadcastClientMessage(id: string, value: string): void;
11958
11766
  /**
@@ -11967,11 +11775,13 @@ export class World {
11967
11775
  * @throws This function can throw errors.
11968
11776
  */
11969
11777
  getAllPlayers(): Player[];
11778
+ /**
11779
+ * @beta
11780
+ */
11970
11781
  getDefaultSpawnPosition(): Vector3;
11971
11782
  /**
11972
11783
  * @remarks
11973
11784
  * Returns a dimension object.
11974
- * @param dimensionId
11975
11785
  * @returns
11976
11786
  * The requested dimension
11977
11787
  * @throws
@@ -11982,7 +11792,6 @@ export class World {
11982
11792
  * @beta
11983
11793
  * @remarks
11984
11794
  * Returns a property value.
11985
- * @param identifier
11986
11795
  * @returns
11987
11796
  * Returns the value for the property, or undefined if the
11988
11797
  * property has not been set.
@@ -12024,16 +11833,12 @@ export class World {
12024
11833
  * @beta
12025
11834
  * @remarks
12026
11835
  * Plays a particular music track for all players.
12027
- * @param trackID
12028
- * @param musicOptions
12029
11836
  */
12030
11837
  playMusic(trackID: string, musicOptions?: MusicOptions): void;
12031
11838
  /**
12032
11839
  * @beta
12033
11840
  * @remarks
12034
11841
  * Plays a sound for all players.
12035
- * @param soundID
12036
- * @param soundOptions
12037
11842
  */
12038
11843
  playSound(soundID: string, soundOptions?: SoundOptions): void;
12039
11844
  /**
@@ -12041,15 +11846,12 @@ export class World {
12041
11846
  * @remarks
12042
11847
  * Queues an additional music track for players. If a track is
12043
11848
  * not playing, a music track will play.
12044
- * @param trackID
12045
- * @param musicOptions
12046
11849
  */
12047
11850
  queueMusic(trackID: string, musicOptions?: MusicOptions): void;
12048
11851
  /**
12049
11852
  * @beta
12050
11853
  * @remarks
12051
11854
  * Removes a specified property.
12052
- * @param identifier
12053
11855
  * @throws This function can throw errors.
12054
11856
  */
12055
11857
  removeDynamicProperty(identifier: string): boolean;
@@ -12095,12 +11897,15 @@ export class World {
12095
11897
  * ```
12096
11898
  */
12097
11899
  sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
11900
+ /**
11901
+ * @beta
11902
+ * @throws This function can throw errors.
11903
+ */
12098
11904
  setDefaultSpawn(spawnPosition: Vector3): void;
12099
11905
  /**
12100
11906
  * @beta
12101
11907
  * @remarks
12102
11908
  * Sets a specified property to a value.
12103
- * @param identifier
12104
11909
  * @param value
12105
11910
  * Data value of the property to set.
12106
11911
  * @throws This function can throw errors.
@@ -12110,7 +11915,6 @@ export class World {
12110
11915
  * @beta
12111
11916
  * @remarks
12112
11917
  * Returns the current game time of the day.
12113
- * @param timeOfDay
12114
11918
  */
12115
11919
  setTime(timeOfDay: number): void;
12116
11920
  /**
@@ -12122,36 +11926,14 @@ export class World {
12122
11926
  }
12123
11927
  /**
12124
11928
  * @beta
12125
- * Contains information and methods that can be used at the
12126
- * initialization of the scripting environment for a World.
12127
- * Also, use the supplied propertyRegistry object to register
12128
- * any dynamic properties, within the scope of the World
12129
- * Initialize execution.
12130
11929
  */
12131
11930
  export class WorldInitializeEvent {
12132
11931
  protected constructor();
12133
- /**
12134
- * Contains methods for scripts to initialize and register
12135
- * dynamic properties they may wish to use within a world.
12136
- * @example propertyRegistration.js
12137
- * ```typescript
12138
- * import { DynamicPropertiesDefinition, MinecraftEntityTypes, world } from "@minecraft/server";
12139
- *
12140
- * world.events.worldInitialize.subscribe((e) => {
12141
- * let def = new DynamicPropertiesDefinition();
12142
- *
12143
- * def.defineNumber("rpgStrength");
12144
- * def.defineString("rpgRole", 16);
12145
- * def.defineBoolean("rpgIsHero");
12146
- *
12147
- * e.propertyRegistry.registerEntityTypeDynamicProperties(def, MinecraftEntityTypes.skeleton);
12148
- * });
12149
- *
12150
- * ```
12151
- */
12152
11932
  readonly propertyRegistry: PropertyRegistry;
12153
11933
  }
12154
- // tslint:disable-next-line:no-unnecessary-class
11934
+ /**
11935
+ * @beta
11936
+ */
12155
11937
  export class WorldInitializeEventSignal_deprecated extends IWorldInitializeEventSignal {
12156
11938
  protected constructor();
12157
11939
  }
@@ -12171,6 +11953,9 @@ export class XYRotation {
12171
11953
  */
12172
11954
  y: number;
12173
11955
  }
11956
+ /**
11957
+ * @beta
11958
+ */
12174
11959
  export interface BlockFillOptions {
12175
11960
  matchingBlock?: BlockPermutation;
12176
11961
  }
@@ -12243,6 +12028,9 @@ export interface Color {
12243
12028
  */
12244
12029
  red: number;
12245
12030
  }
12031
+ /**
12032
+ * @beta
12033
+ */
12246
12034
  export interface EntityDamageSource {
12247
12035
  cause: EntityDamageCause;
12248
12036
  damagingEntity?: Entity;
@@ -12417,6 +12205,7 @@ export interface EntityQueryOptions {
12417
12205
  */
12418
12206
  type?: string;
12419
12207
  /**
12208
+ * @beta
12420
12209
  * In conjunction with location, specified a cuboid volume of
12421
12210
  * entities to include.
12422
12211
  */
@@ -12517,12 +12306,18 @@ export interface NumberRange {
12517
12306
  */
12518
12307
  min: number;
12519
12308
  }
12309
+ /**
12310
+ * @beta
12311
+ */
12520
12312
  export interface PlayAnimationOptions {
12521
12313
  blendOutTime?: number;
12522
12314
  controller?: string;
12523
12315
  nextState?: string;
12524
12316
  stopExpression?: string;
12525
12317
  }
12318
+ /**
12319
+ * @beta
12320
+ */
12526
12321
  export interface RawMessage {
12527
12322
  rawtext?: RawMessage[];
12528
12323
  score?: RawMessageScore;
@@ -12530,6 +12325,9 @@ export interface RawMessage {
12530
12325
  translate?: string;
12531
12326
  with?: string[] | RawMessage;
12532
12327
  }
12328
+ /**
12329
+ * @beta
12330
+ */
12533
12331
  export interface RawMessageScore {
12534
12332
  name?: string;
12535
12333
  objective?: string;
@@ -12560,6 +12358,9 @@ export interface ScoreboardObjectiveDisplayOptions {
12560
12358
  */
12561
12359
  sortOrder?: ObjectiveSortOrder;
12562
12360
  }
12361
+ /**
12362
+ * @beta
12363
+ */
12563
12364
  export interface ScriptEventMessageFilterOptions {
12564
12365
  namespaces: string[];
12565
12366
  }
@@ -12623,6 +12424,9 @@ export interface Vector3 {
12623
12424
  */
12624
12425
  z: number;
12625
12426
  }
12427
+ /**
12428
+ * @beta
12429
+ */
12626
12430
  export const TicksPerDay = 24000;
12627
12431
  /**
12628
12432
  * @beta