@minecraft/server 1.5.0-rc.1.20.40-preview.21 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +1 -3
  2. package/index.d.ts +49 -337
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -7,7 +7,6 @@
7
7
  Copyright (c) Microsoft Corporation.
8
8
  ***************************************************************************** */
9
9
  /**
10
- * @beta
11
10
  * @packageDocumentation
12
11
  * Contains many types related to manipulating a Minecraft
13
12
  * world, including entities, blocks, dimensions, and more.
@@ -16,53 +15,46 @@
16
15
  * ```json
17
16
  * {
18
17
  * "module_name": "@minecraft/server",
19
- * "version": "1.7.0-internal.1.20.40-preview.21"
18
+ * "version": "1.5.0"
20
19
  * }
21
20
  * ```
22
21
  *
23
22
  */
24
23
  /**
25
- * @beta
26
24
  * A general purpose relative direction enumeration.
27
25
  */
28
26
  export enum Direction {
29
27
  /**
30
- * @beta
31
28
  * @remarks
32
29
  * Returns the block beneath (y - 1) of this item.
33
30
  *
34
31
  */
35
32
  Down = 'Down',
36
33
  /**
37
- * @beta
38
34
  * @remarks
39
35
  * Returns the block to the east (x + 1) of this item.
40
36
  *
41
37
  */
42
38
  East = 'East',
43
39
  /**
44
- * @beta
45
40
  * @remarks
46
41
  * Returns the block to the east (z + 1) of this item.
47
42
  *
48
43
  */
49
44
  North = 'North',
50
45
  /**
51
- * @beta
52
46
  * @remarks
53
47
  * Returns the block to the south (z - 1) of this item.
54
48
  *
55
49
  */
56
50
  South = 'South',
57
51
  /**
58
- * @beta
59
52
  * @remarks
60
53
  * Returns the block above (y + 1) of this item.
61
54
  *
62
55
  */
63
56
  Up = 'Up',
64
57
  /**
65
- * @beta
66
58
  * @remarks
67
59
  * Returns the block to the west (x - 1) of this item.
68
60
  *
@@ -71,26 +63,22 @@ export enum Direction {
71
63
  }
72
64
 
73
65
  /**
74
- * @beta
75
66
  * Specifies a mechanism for displaying scores on a scoreboard.
76
67
  */
77
68
  export enum DisplaySlotId {
78
69
  /**
79
- * @beta
80
70
  * @remarks
81
71
  * Displays the score below the player's name.
82
72
  *
83
73
  */
84
74
  BelowName = 'BelowName',
85
75
  /**
86
- * @beta
87
76
  * @remarks
88
77
  * Displays the score as a list on the pause screen.
89
78
  *
90
79
  */
91
80
  List = 'List',
92
81
  /**
93
- * @beta
94
82
  * @remarks
95
83
  * Displays the score on the side of the player's screen.
96
84
  *
@@ -98,9 +86,6 @@ export enum DisplaySlotId {
98
86
  Sidebar = 'Sidebar',
99
87
  }
100
88
 
101
- /**
102
- * @beta
103
- */
104
89
  export enum EntityDamageCause {
105
90
  anvil = 'anvil',
106
91
  blockExplosion = 'blockExplosion',
@@ -136,13 +121,11 @@ export enum EntityDamageCause {
136
121
  }
137
122
 
138
123
  /**
139
- * @beta
140
124
  * The equipment slot of the mob. This includes armor, offhand
141
125
  * and mainhand slots.
142
126
  */
143
127
  export enum EquipmentSlot {
144
128
  /**
145
- * @beta
146
129
  * @remarks
147
130
  * The chest slot. This slot is used to hold items such as
148
131
  * Chestplate or Elytra.
@@ -150,7 +133,6 @@ export enum EquipmentSlot {
150
133
  */
151
134
  Chest = 'Chest',
152
135
  /**
153
- * @beta
154
136
  * @remarks
155
137
  * The feet slot. This slot is used to hold items such as
156
138
  * Boots.
@@ -158,7 +140,6 @@ export enum EquipmentSlot {
158
140
  */
159
141
  Feet = 'Feet',
160
142
  /**
161
- * @beta
162
143
  * @remarks
163
144
  * The head slot. This slot is used to hold items such as
164
145
  * Helmets or Carved Pumpkins.
@@ -166,7 +147,6 @@ export enum EquipmentSlot {
166
147
  */
167
148
  Head = 'Head',
168
149
  /**
169
- * @beta
170
150
  * @remarks
171
151
  * The legs slot. This slot is used to hold items such as
172
152
  * Leggings.
@@ -174,7 +154,6 @@ export enum EquipmentSlot {
174
154
  */
175
155
  Legs = 'Legs',
176
156
  /**
177
- * @beta
178
157
  * @remarks
179
158
  * The mainhand slot. For players, the mainhand slot refers to
180
159
  * the currently active hotbar slot.
@@ -182,7 +161,6 @@ export enum EquipmentSlot {
182
161
  */
183
162
  Mainhand = 'Mainhand',
184
163
  /**
185
- * @beta
186
164
  * @remarks
187
165
  * The offhand slot. This slot is used to hold items such as
188
166
  * shields and maps.
@@ -192,12 +170,10 @@ export enum EquipmentSlot {
192
170
  }
193
171
 
194
172
  /**
195
- * @beta
196
173
  * Represents a game mode for the current world experience.
197
174
  */
198
175
  export enum GameMode {
199
176
  /**
200
- * @beta
201
177
  * @remarks
202
178
  * World is in a more locked-down experience, where blocks may
203
179
  * not be manipulated.
@@ -205,7 +181,6 @@ export enum GameMode {
205
181
  */
206
182
  adventure = 'adventure',
207
183
  /**
208
- * @beta
209
184
  * @remarks
210
185
  * World is in a full creative mode. In creative mode, the
211
186
  * player has all the resources available in the item selection
@@ -218,7 +193,6 @@ export enum GameMode {
218
193
  */
219
194
  creative = 'creative',
220
195
  /**
221
- * @beta
222
196
  * @remarks
223
197
  * World is in spectator mode. In spectator mode, spectators
224
198
  * are always flying and cannot become grounded. Spectators can
@@ -231,7 +205,6 @@ export enum GameMode {
231
205
  */
232
206
  spectator = 'spectator',
233
207
  /**
234
- * @beta
235
208
  * @remarks
236
209
  * World is in a survival mode, where players can take damage
237
210
  * and entities may not be peaceful. Survival mode is where the
@@ -244,26 +217,22 @@ export enum GameMode {
244
217
  }
245
218
 
246
219
  /**
247
- * @beta
248
220
  * Describes how an an item can be moved within a container.
249
221
  */
250
222
  export enum ItemLockMode {
251
223
  /**
252
- * @beta
253
224
  * @remarks
254
225
  * The item cannot be dropped or crafted with.
255
226
  *
256
227
  */
257
228
  inventory = 'inventory',
258
229
  /**
259
- * @beta
260
230
  * @remarks
261
231
  * The item has no container restrictions.
262
232
  *
263
233
  */
264
234
  none = 'none',
265
235
  /**
266
- * @beta
267
236
  * @remarks
268
237
  * The item cannot be moved from its slot, dropped or crafted
269
238
  * with.
@@ -273,13 +242,11 @@ export enum ItemLockMode {
273
242
  }
274
243
 
275
244
  /**
276
- * @beta
277
245
  * Used for specifying a sort order for how to display an
278
246
  * objective and its list of participants.
279
247
  */
280
248
  export enum ObjectiveSortOrder {
281
249
  /**
282
- * @beta
283
250
  * @remarks
284
251
  * Objective participant list is displayed in ascending (e.g.,
285
252
  * A-Z) order.
@@ -287,7 +254,6 @@ export enum ObjectiveSortOrder {
287
254
  */
288
255
  Ascending = 0,
289
256
  /**
290
- * @beta
291
257
  * @remarks
292
258
  * Objective participant list is displayed in descending (e.g.,
293
259
  * Z-A) order.
@@ -297,19 +263,16 @@ export enum ObjectiveSortOrder {
297
263
  }
298
264
 
299
265
  /**
300
- * @beta
301
266
  * Contains objectives and participants for the scoreboard.
302
267
  */
303
268
  export enum ScoreboardIdentityType {
304
269
  /**
305
- * @beta
306
270
  * @remarks
307
271
  * This scoreboard participant is tied to an entity.
308
272
  *
309
273
  */
310
274
  Entity = 'Entity',
311
275
  /**
312
- * @beta
313
276
  * @remarks
314
277
  * This scoreboard participant is tied to a pseudo player
315
278
  * entity - typically this is used to store scores as data or
@@ -318,7 +281,6 @@ export enum ScoreboardIdentityType {
318
281
  */
319
282
  FakePlayer = 'FakePlayer',
320
283
  /**
321
- * @beta
322
284
  * @remarks
323
285
  * This scoreboard participant is tied to a player.
324
286
  *
@@ -327,12 +289,10 @@ export enum ScoreboardIdentityType {
327
289
  }
328
290
 
329
291
  /**
330
- * @beta
331
292
  * Describes where the script event originated from.
332
293
  */
333
294
  export enum ScriptEventSource {
334
295
  /**
335
- * @beta
336
296
  * @remarks
337
297
  * The script event originated from a Block such as a Command
338
298
  * Block.
@@ -340,7 +300,6 @@ export enum ScriptEventSource {
340
300
  */
341
301
  Block = 'Block',
342
302
  /**
343
- * @beta
344
303
  * @remarks
345
304
  * The script event originated from an Entity such as a Player,
346
305
  * Command Block Minecart or Animation Controller.
@@ -348,14 +307,12 @@ export enum ScriptEventSource {
348
307
  */
349
308
  Entity = 'Entity',
350
309
  /**
351
- * @beta
352
310
  * @remarks
353
311
  * The script event originated from an NPC dialogue.
354
312
  *
355
313
  */
356
314
  NPCDialogue = 'NPCDialogue',
357
315
  /**
358
- * @beta
359
316
  * @remarks
360
317
  * The script event originated from the server, such as from a
361
318
  * runCommand API call or a dedicated server console.
@@ -365,7 +322,6 @@ export enum ScriptEventSource {
365
322
  }
366
323
 
367
324
  /**
368
- * @beta
369
325
  * Provides numeric values for common periods in the Minecraft
370
326
  * day.
371
327
  */
@@ -379,7 +335,6 @@ export enum TimeOfDay {
379
335
  }
380
336
 
381
337
  /**
382
- * @beta
383
338
  * Represents a block in a dimension. A block represents a
384
339
  * unique X, Y, and Z within a dimension and get/sets the state
385
340
  * of the block at that location. This type was significantly
@@ -406,6 +361,10 @@ export class Block {
406
361
  * block.
407
362
  *
408
363
  * @throws This property can throw when used.
364
+ *
365
+ * {@link LocationInUnloadedChunkError}
366
+ *
367
+ * {@link LocationOutOfWorldBoundariesError}
409
368
  */
410
369
  readonly permutation: BlockPermutation;
411
370
  /**
@@ -427,7 +386,6 @@ export class Block {
427
386
  */
428
387
  readonly z: number;
429
388
  /**
430
- * @beta
431
389
  * @remarks
432
390
  * Gets additional configuration properties (a component) for
433
391
  * specific capabilities of particular blocks - for example, an
@@ -440,10 +398,13 @@ export class Block {
440
398
  * Returns the component object if it is present on the
441
399
  * particular block.
442
400
  * @throws This function can throw errors.
401
+ *
402
+ * {@link LocationInUnloadedChunkError}
403
+ *
404
+ * {@link LocationOutOfWorldBoundariesError}
443
405
  */
444
406
  getComponent(componentName: string): BlockComponent | undefined;
445
407
  /**
446
- * @beta
447
408
  * @remarks
448
409
  * Returns true if this reference to a block is still valid
449
410
  * (for example, if the block is unloaded, references to that
@@ -464,19 +425,21 @@ export class Block {
464
425
  * Permutation that contains a set of property states for the
465
426
  * Block.
466
427
  * @throws This function can throw errors.
428
+ *
429
+ * {@link LocationInUnloadedChunkError}
430
+ *
431
+ * {@link LocationOutOfWorldBoundariesError}
467
432
  */
468
433
  setPermutation(permutation: BlockPermutation): void;
469
434
  }
470
435
 
471
436
  /**
472
- * @beta
473
437
  * Base type for components associated with blocks.
474
438
  */
475
439
  // @ts-ignore Class inheritance allowed for native defined classes
476
440
  export class BlockComponent extends Component {
477
441
  private constructor();
478
442
  /**
479
- * @beta
480
443
  * @remarks
481
444
  * Block instance that this component pertains to.
482
445
  *
@@ -485,7 +448,6 @@ export class BlockComponent extends Component {
485
448
  }
486
449
 
487
450
  /**
488
- * @beta
489
451
  * Contains information regarding an event that impacts a
490
452
  * specific block.
491
453
  */
@@ -507,7 +469,6 @@ export class BlockEvent {
507
469
  }
508
470
 
509
471
  /**
510
- * @beta
511
472
  * Represents the inventory of a block in the world. Used with
512
473
  * blocks like chests.
513
474
  */
@@ -525,7 +486,6 @@ export class BlockInventoryComponent extends BlockComponent {
525
486
  }
526
487
 
527
488
  /**
528
- * @beta
529
489
  * Contains the combination of type {@link BlockType} and
530
490
  * properties (also sometimes called block state) which
531
491
  * describe a block (but does not belong to a specific {@link
@@ -597,7 +557,6 @@ export class BlockPermutation {
597
557
  }
598
558
 
599
559
  /**
600
- * @beta
601
560
  * Contains information related to changes to a button push.
602
561
  */
603
562
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -612,7 +571,6 @@ export class ButtonPushAfterEvent extends BlockEvent {
612
571
  }
613
572
 
614
573
  /**
615
- * @beta
616
574
  * Manages callbacks that are connected to when a button is
617
575
  * pushed.
618
576
  */
@@ -637,7 +595,6 @@ export class CommandResult {
637
595
  }
638
596
 
639
597
  /**
640
- * @beta
641
598
  * Base class for downstream Component implementations.
642
599
  */
643
600
  export class Component {
@@ -649,7 +606,6 @@ export class Component {
649
606
  */
650
607
  readonly typeId: string;
651
608
  /**
652
- * @beta
653
609
  * @remarks
654
610
  * Returns whether the component is valid. A component is
655
611
  * considered valid if its owner is valid, in addition to any
@@ -663,7 +619,6 @@ export class Component {
663
619
  }
664
620
 
665
621
  /**
666
- * @beta
667
622
  * Represents a container that can hold sets of items. Used
668
623
  * with entities such as Players, Chest Minecarts, Llamas, and
669
624
  * more.
@@ -735,7 +690,6 @@ export class Container {
735
690
  */
736
691
  getItem(slot: number): ItemStack | undefined;
737
692
  /**
738
- * @beta
739
693
  * @remarks
740
694
  * Returns whether a container object (or the entity or block
741
695
  * that this container is associated with) is still available
@@ -851,7 +805,6 @@ export class Dimension {
851
805
  */
852
806
  readonly id: string;
853
807
  /**
854
- * @beta
855
808
  * @remarks
856
809
  * Returns a block instance at the given location.
857
810
  *
@@ -869,10 +822,13 @@ export class Dimension {
869
822
  * trying to interact with a position outside of dimension
870
823
  * height range
871
824
  *
825
+ *
826
+ * {@link LocationInUnloadedChunkError}
827
+ *
828
+ * {@link LocationOutOfWorldBoundariesError}
872
829
  */
873
830
  getBlock(location: Vector3): Block | undefined;
874
831
  /**
875
- * @beta
876
832
  * @remarks
877
833
  * Gets the first block that intersects with a vector emanating
878
834
  * from a location.
@@ -886,7 +842,6 @@ export class Dimension {
886
842
  */
887
843
  getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
888
844
  /**
889
- * @beta
890
845
  * @remarks
891
846
  * Returns a set of entities based on a set of conditions
892
847
  * defined via the EntityQueryOptions set of filter criteria.
@@ -955,7 +910,6 @@ export class Dimension {
955
910
  */
956
911
  getEntities(options?: EntityQueryOptions): Entity[];
957
912
  /**
958
- * @beta
959
913
  * @remarks
960
914
  * Returns a set of entities at a particular location.
961
915
  *
@@ -966,7 +920,6 @@ export class Dimension {
966
920
  */
967
921
  getEntitiesAtBlockLocation(location: Vector3): Entity[];
968
922
  /**
969
- * @beta
970
923
  * @remarks
971
924
  * Gets entities that intersect with a specified vector
972
925
  * emanating from a location.
@@ -976,7 +929,6 @@ export class Dimension {
976
929
  */
977
930
  getEntitiesFromRay(location: Vector3, direction: Vector3, options?: EntityRaycastOptions): EntityRaycastHit[];
978
931
  /**
979
- * @beta
980
932
  * @remarks
981
933
  * Returns a set of players based on a set of conditions
982
934
  * defined via the EntityQueryOptions set of filter criteria.
@@ -990,7 +942,6 @@ export class Dimension {
990
942
  */
991
943
  getPlayers(options?: EntityQueryOptions): Player[];
992
944
  /**
993
- * @beta
994
945
  * @remarks
995
946
  * Runs a command synchronously using the context of the
996
947
  * broader dimenion.
@@ -1009,6 +960,8 @@ export class Dimension {
1009
960
  * command. Note that in many cases, if the command does not
1010
961
  * operate (e.g., a target selector found no matches), this
1011
962
  * method will not throw an exception.
963
+ *
964
+ * {@link CommandError}
1012
965
  */
1013
966
  runCommand(commandString: string): CommandResult;
1014
967
  /**
@@ -1033,7 +986,6 @@ export class Dimension {
1033
986
  */
1034
987
  runCommandAsync(commandString: string): Promise<CommandResult>;
1035
988
  /**
1036
- * @beta
1037
989
  * @remarks
1038
990
  * Creates a new entity (e.g., a mob) at the specified
1039
991
  * location.
@@ -1048,6 +1000,10 @@ export class Dimension {
1048
1000
  * @returns
1049
1001
  * Newly created entity at the specified location.
1050
1002
  * @throws This function can throw errors.
1003
+ *
1004
+ * {@link LocationInUnloadedChunkError}
1005
+ *
1006
+ * {@link LocationOutOfWorldBoundariesError}
1051
1007
  * @example createOldHorse.ts
1052
1008
  * ```typescript
1053
1009
  * const overworld = mc.world.getDimension("overworld");
@@ -1090,7 +1046,6 @@ export class Dimension {
1090
1046
  */
1091
1047
  spawnEntity(identifier: string, location: Vector3): Entity;
1092
1048
  /**
1093
- * @beta
1094
1049
  * @remarks
1095
1050
  * Creates a new item stack as an entity at the specified
1096
1051
  * location.
@@ -1102,6 +1057,10 @@ export class Dimension {
1102
1057
  * @returns
1103
1058
  * Newly created item stack entity at the specified location.
1104
1059
  * @throws This function can throw errors.
1060
+ *
1061
+ * {@link LocationInUnloadedChunkError}
1062
+ *
1063
+ * {@link LocationOutOfWorldBoundariesError}
1105
1064
  * @example itemStacks.ts
1106
1065
  * ```typescript
1107
1066
  * const overworld = mc.world.getDimension('overworld');
@@ -1133,7 +1092,6 @@ export class Dimension {
1133
1092
  */
1134
1093
  spawnItem(itemStack: ItemStack, location: Vector3): Entity;
1135
1094
  /**
1136
- * @beta
1137
1095
  * @remarks
1138
1096
  * Creates a new particle emitter at a specified location in
1139
1097
  * the world.
@@ -1148,6 +1106,10 @@ export class Dimension {
1148
1106
  * A set of optional, customizable variables that can be
1149
1107
  * adjusted for this particle.
1150
1108
  * @throws This function can throw errors.
1109
+ *
1110
+ * {@link LocationInUnloadedChunkError}
1111
+ *
1112
+ * {@link LocationOutOfWorldBoundariesError}
1151
1113
  * @example spawnParticle.ts
1152
1114
  * ```typescript
1153
1115
  * for (let i = 0; i < 100; i++) {
@@ -1168,7 +1130,6 @@ export class Dimension {
1168
1130
  }
1169
1131
 
1170
1132
  /**
1171
- * @beta
1172
1133
  * Represents an effect - like poison - that has been added to
1173
1134
  * an Entity.
1174
1135
  */
@@ -1217,7 +1178,6 @@ export class Effect {
1217
1178
  }
1218
1179
 
1219
1180
  /**
1220
- * @beta
1221
1181
  * Represents a type of effect - like poison - that can be
1222
1182
  * applied to an entity.
1223
1183
  */
@@ -1240,7 +1200,6 @@ export class EffectType {
1240
1200
  export class Entity {
1241
1201
  private constructor();
1242
1202
  /**
1243
- * @beta
1244
1203
  * @remarks
1245
1204
  * Dimension that the entity is currently within.
1246
1205
  *
@@ -1259,7 +1218,6 @@ export class Entity {
1259
1218
  */
1260
1219
  readonly id: string;
1261
1220
  /**
1262
- * @beta
1263
1221
  * @remarks
1264
1222
  * Current location of the entity.
1265
1223
  *
@@ -1267,7 +1225,6 @@ export class Entity {
1267
1225
  */
1268
1226
  readonly location: Vector3;
1269
1227
  /**
1270
- * @beta
1271
1228
  * @remarks
1272
1229
  * Given name of the entity.
1273
1230
  *
@@ -1276,7 +1233,6 @@ export class Entity {
1276
1233
  */
1277
1234
  nameTag: string;
1278
1235
  /**
1279
- * @beta
1280
1236
  * @remarks
1281
1237
  * Returns a scoreboard identity that represents this entity.
1282
1238
  * Will remain valid when the entity is killed.
@@ -1292,7 +1248,6 @@ export class Entity {
1292
1248
  */
1293
1249
  readonly typeId: string;
1294
1250
  /**
1295
- * @beta
1296
1251
  * @remarks
1297
1252
  * Adds or updates an effect, like poison, to the entity.
1298
1253
  *
@@ -1351,7 +1306,6 @@ export class Entity {
1351
1306
  */
1352
1307
  addEffect(effectType: EffectType | string, duration: number, options?: EntityEffectOptions): void;
1353
1308
  /**
1354
- * @beta
1355
1309
  * @remarks
1356
1310
  * Adds a specified tag to an entity.
1357
1311
  *
@@ -1386,7 +1340,6 @@ export class Entity {
1386
1340
  */
1387
1341
  addTag(tag: string): boolean;
1388
1342
  /**
1389
- * @beta
1390
1343
  * @remarks
1391
1344
  * Applies a set of damage to an entity.
1392
1345
  *
@@ -1419,7 +1372,6 @@ export class Entity {
1419
1372
  */
1420
1373
  applyDamage(amount: number, options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions): boolean;
1421
1374
  /**
1422
- * @beta
1423
1375
  * @remarks
1424
1376
  * Applies impulse vector to the current velocity of the
1425
1377
  * entity.
@@ -1441,7 +1393,6 @@ export class Entity {
1441
1393
  */
1442
1394
  applyImpulse(vector: Vector3): void;
1443
1395
  /**
1444
- * @beta
1445
1396
  * @remarks
1446
1397
  * Applies impulse vector to the current velocity of the
1447
1398
  * entity.
@@ -1477,7 +1428,6 @@ export class Entity {
1477
1428
  */
1478
1429
  applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void;
1479
1430
  /**
1480
- * @beta
1481
1431
  * @remarks
1482
1432
  * Sets the current velocity of the Entity to zero. Note that
1483
1433
  * this method may not have an impact on Players.
@@ -1497,7 +1447,6 @@ export class Entity {
1497
1447
  */
1498
1448
  clearVelocity(): void;
1499
1449
  /**
1500
- * @beta
1501
1450
  * @remarks
1502
1451
  * Returns the first intersecting block from the direction that
1503
1452
  * this entity is looking at.
@@ -1511,7 +1460,6 @@ export class Entity {
1511
1460
  */
1512
1461
  getBlockFromViewDirection(options?: BlockRaycastOptions): BlockRaycastHit | undefined;
1513
1462
  /**
1514
- * @beta
1515
1463
  * @remarks
1516
1464
  * Gets a component (that represents additional capabilities)
1517
1465
  * for an entity.
@@ -1527,7 +1475,6 @@ export class Entity {
1527
1475
  */
1528
1476
  getComponent(componentId: string): EntityComponent | undefined;
1529
1477
  /**
1530
- * @beta
1531
1478
  * @remarks
1532
1479
  * Returns all components that are both present on this entity
1533
1480
  * and supported by the API.
@@ -1538,7 +1485,6 @@ export class Entity {
1538
1485
  */
1539
1486
  getComponents(): EntityComponent[];
1540
1487
  /**
1541
- * @beta
1542
1488
  * @remarks
1543
1489
  * Returns the effect for the specified EffectType on the
1544
1490
  * entity, undefined if the effect is not present, or throws an
@@ -1554,7 +1500,6 @@ export class Entity {
1554
1500
  */
1555
1501
  getEffect(effectType: EffectType | string): Effect | undefined;
1556
1502
  /**
1557
- * @beta
1558
1503
  * @remarks
1559
1504
  * Returns a set of effects applied to this entity.
1560
1505
  *
@@ -1564,7 +1509,6 @@ export class Entity {
1564
1509
  */
1565
1510
  getEffects(): Effect[];
1566
1511
  /**
1567
- * @beta
1568
1512
  * @remarks
1569
1513
  * Gets the entities that this entity is looking at by
1570
1514
  * performing a ray cast from the view of this entity.
@@ -1578,7 +1522,6 @@ export class Entity {
1578
1522
  */
1579
1523
  getEntitiesFromViewDirection(options?: EntityRaycastOptions): EntityRaycastHit[];
1580
1524
  /**
1581
- * @beta
1582
1525
  * @remarks
1583
1526
  * Returns the current location of the head component of this
1584
1527
  * entity.
@@ -1590,7 +1533,6 @@ export class Entity {
1590
1533
  */
1591
1534
  getHeadLocation(): Vector3;
1592
1535
  /**
1593
- * @beta
1594
1536
  * @remarks
1595
1537
  * Returns all tags associated with an entity.
1596
1538
  *
@@ -1600,7 +1542,6 @@ export class Entity {
1600
1542
  */
1601
1543
  getTags(): string[];
1602
1544
  /**
1603
- * @beta
1604
1545
  * @remarks
1605
1546
  * Returns the current velocity vector of the entity.
1606
1547
  *
@@ -1620,7 +1561,6 @@ export class Entity {
1620
1561
  */
1621
1562
  getVelocity(): Vector3;
1622
1563
  /**
1623
- * @beta
1624
1564
  * @remarks
1625
1565
  * Returns the current view direction of the entity.
1626
1566
  *
@@ -1630,7 +1570,6 @@ export class Entity {
1630
1570
  */
1631
1571
  getViewDirection(): Vector3;
1632
1572
  /**
1633
- * @beta
1634
1573
  * @remarks
1635
1574
  * Returns true if the specified component is present on this
1636
1575
  * entity.
@@ -1645,7 +1584,6 @@ export class Entity {
1645
1584
  */
1646
1585
  hasComponent(componentId: string): boolean;
1647
1586
  /**
1648
- * @beta
1649
1587
  * @remarks
1650
1588
  * Returns whether an entity has a particular tag.
1651
1589
  *
@@ -1657,7 +1595,6 @@ export class Entity {
1657
1595
  */
1658
1596
  hasTag(tag: string): boolean;
1659
1597
  /**
1660
- * @beta
1661
1598
  * @remarks
1662
1599
  * Returns whether the entity can be manipulated by script. A
1663
1600
  * Player is considered valid when it's EntityLifetimeState is
@@ -1668,7 +1605,6 @@ export class Entity {
1668
1605
  */
1669
1606
  isValid(): boolean;
1670
1607
  /**
1671
- * @beta
1672
1608
  * @remarks
1673
1609
  * Kills this entity. The entity will drop loot as normal.
1674
1610
  *
@@ -1700,7 +1636,6 @@ export class Entity {
1700
1636
  */
1701
1637
  kill(): boolean;
1702
1638
  /**
1703
- * @beta
1704
1639
  * @remarks
1705
1640
  * Removes the specified EffectType on the entity, or returns
1706
1641
  * false if the effect is not present.
@@ -1716,7 +1651,6 @@ export class Entity {
1716
1651
  */
1717
1652
  removeEffect(effectType: EffectType | string): boolean;
1718
1653
  /**
1719
- * @beta
1720
1654
  * @remarks
1721
1655
  * Removes a specified tag from an entity.
1722
1656
  *
@@ -1730,7 +1664,6 @@ export class Entity {
1730
1664
  */
1731
1665
  removeTag(tag: string): boolean;
1732
1666
  /**
1733
- * @beta
1734
1667
  * @remarks
1735
1668
  * Runs a synchronous command on the entity.
1736
1669
  *
@@ -1743,6 +1676,10 @@ export class Entity {
1743
1676
  * A command result containing whether the command was
1744
1677
  * successful.
1745
1678
  * @throws This function can throw errors.
1679
+ *
1680
+ * {@link CommandError}
1681
+ *
1682
+ * {@link Error}
1746
1683
  */
1747
1684
  runCommand(commandString: string): CommandResult;
1748
1685
  /**
@@ -1761,7 +1698,6 @@ export class Entity {
1761
1698
  */
1762
1699
  runCommandAsync(commandString: string): Promise<CommandResult>;
1763
1700
  /**
1764
- * @beta
1765
1701
  * @remarks
1766
1702
  * Teleports the selected entity to a new location
1767
1703
  *
@@ -1794,7 +1730,6 @@ export class Entity {
1794
1730
  */
1795
1731
  teleport(location: Vector3, teleportOptions?: TeleportOptions): void;
1796
1732
  /**
1797
- * @beta
1798
1733
  * @remarks
1799
1734
  * Triggers an entity type event. For every entity, a number of
1800
1735
  * events are defined in an entities' definition for key entity
@@ -1818,7 +1753,6 @@ export class Entity {
1818
1753
  */
1819
1754
  triggerEvent(eventName: string): void;
1820
1755
  /**
1821
- * @beta
1822
1756
  * @remarks
1823
1757
  * Attempts to try a teleport, but may not complete the
1824
1758
  * teleport operation (for example, if there are blocks at the
@@ -1840,7 +1774,6 @@ export class Entity {
1840
1774
  }
1841
1775
 
1842
1776
  /**
1843
- * @beta
1844
1777
  * This is a base abstract class for any entity component that
1845
1778
  * centers around a number and can have a minimum, maximum, and
1846
1779
  * default defined value.
@@ -1920,7 +1853,6 @@ export class EntityAttributeComponent extends EntityComponent {
1920
1853
  }
1921
1854
 
1922
1855
  /**
1923
- * @beta
1924
1856
  * Base class for a family of entity movement events.
1925
1857
  */
1926
1858
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -1936,7 +1868,6 @@ export class EntityBaseMovementComponent extends EntityComponent {
1936
1868
  }
1937
1869
 
1938
1870
  /**
1939
- * @beta
1940
1871
  * When added, this component signifies that the entity can
1941
1872
  * climb up ladders.
1942
1873
  */
@@ -1947,7 +1878,6 @@ export class EntityCanClimbComponent extends EntityComponent {
1947
1878
  }
1948
1879
 
1949
1880
  /**
1950
- * @beta
1951
1881
  * When added, this component signifies that the entity can
1952
1882
  * fly, and the pathfinder won't be restricted to paths where a
1953
1883
  * solid block is required underneath it.
@@ -1959,7 +1889,6 @@ export class EntityCanFlyComponent extends EntityComponent {
1959
1889
  }
1960
1890
 
1961
1891
  /**
1962
- * @beta
1963
1892
  * When added, this component signifies that the entity can
1964
1893
  * power jump like the horse does within Minecraft.
1965
1894
  */
@@ -1970,7 +1899,6 @@ export class EntityCanPowerJumpComponent extends EntityComponent {
1970
1899
  }
1971
1900
 
1972
1901
  /**
1973
- * @beta
1974
1902
  * Defines the entity's color. Only works on certain entities
1975
1903
  * that have predefined color values (e.g., sheep, llama,
1976
1904
  * shulker).
@@ -1990,7 +1918,6 @@ export class EntityColorComponent extends EntityComponent {
1990
1918
  }
1991
1919
 
1992
1920
  /**
1993
- * @beta
1994
1921
  * Base class for downstream entity components.
1995
1922
  */
1996
1923
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -1999,7 +1926,6 @@ export class EntityComponent extends Component {
1999
1926
  }
2000
1927
 
2001
1928
  /**
2002
- * @beta
2003
1929
  * Contains data related to the death of an entity in the game.
2004
1930
  */
2005
1931
  export class EntityDieAfterEvent {
@@ -2020,7 +1946,6 @@ export class EntityDieAfterEvent {
2020
1946
  }
2021
1947
 
2022
1948
  /**
2023
- * @beta
2024
1949
  * Supports registering for an event that fires after an entity
2025
1950
  * has died.
2026
1951
  */
@@ -2058,7 +1983,6 @@ export class EntityDieAfterEventSignal {
2058
1983
  }
2059
1984
 
2060
1985
  /**
2061
- * @beta
2062
1986
  * Provides access to a mob's equipment slots. This component
2063
1987
  * exists for all mob entities.
2064
1988
  */
@@ -2096,7 +2020,6 @@ export class EntityEquippableComponent extends EntityComponent {
2096
2020
  }
2097
2021
 
2098
2022
  /**
2099
- * @beta
2100
2023
  * When added, this component signifies that this entity
2101
2024
  * doesn't take damage from fire.
2102
2025
  */
@@ -2107,7 +2030,6 @@ export class EntityFireImmuneComponent extends EntityComponent {
2107
2030
  }
2108
2031
 
2109
2032
  /**
2110
- * @beta
2111
2033
  * When added, this component signifies that this entity can
2112
2034
  * float in liquid blocks.
2113
2035
  */
@@ -2118,7 +2040,6 @@ export class EntityFloatsInLiquidComponent extends EntityComponent {
2118
2040
  }
2119
2041
 
2120
2042
  /**
2121
- * @beta
2122
2043
  * Represents the flying speed of an entity.
2123
2044
  */
2124
2045
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2136,7 +2057,6 @@ export class EntityFlyingSpeedComponent extends EntityComponent {
2136
2057
  }
2137
2058
 
2138
2059
  /**
2139
- * @beta
2140
2060
  * Defines how much friction affects this entity.
2141
2061
  */
2142
2062
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2155,7 +2075,6 @@ export class EntityFrictionModifierComponent extends EntityComponent {
2155
2075
  }
2156
2076
 
2157
2077
  /**
2158
- * @beta
2159
2078
  * Sets the offset from the ground that the entity is actually
2160
2079
  * at.
2161
2080
  */
@@ -2176,7 +2095,6 @@ export class EntityGroundOffsetComponent extends EntityComponent {
2176
2095
  }
2177
2096
 
2178
2097
  /**
2179
- * @beta
2180
2098
  * Defines the interactions with this entity for healing it.
2181
2099
  */
2182
2100
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2203,7 +2121,6 @@ export class EntityHealableComponent extends EntityComponent {
2203
2121
  }
2204
2122
 
2205
2123
  /**
2206
- * @beta
2207
2124
  * Contains information related to an entity when its health
2208
2125
  * changes. Warning: don't change the health of an entity in
2209
2126
  * this event, or it will cause an infinite loop!
@@ -2231,7 +2148,6 @@ export class EntityHealthChangedAfterEvent {
2231
2148
  }
2232
2149
 
2233
2150
  /**
2234
- * @beta
2235
2151
  * Manages callbacks that are connected to when the health of
2236
2152
  * an entity changes.
2237
2153
  */
@@ -2262,7 +2178,6 @@ export class EntityHealthChangedAfterEventSignal {
2262
2178
  }
2263
2179
 
2264
2180
  /**
2265
- * @beta
2266
2181
  * Defines the health properties of an entity.
2267
2182
  */
2268
2183
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2272,7 +2187,6 @@ export class EntityHealthComponent extends EntityAttributeComponent {
2272
2187
  }
2273
2188
 
2274
2189
  /**
2275
- * @beta
2276
2190
  * Contains information related to an entity hitting a block.
2277
2191
  */
2278
2192
  export class EntityHitBlockAfterEvent {
@@ -2298,7 +2212,6 @@ export class EntityHitBlockAfterEvent {
2298
2212
  }
2299
2213
 
2300
2214
  /**
2301
- * @beta
2302
2215
  * Manages callbacks that are connected to when an entity hits
2303
2216
  * a block.
2304
2217
  */
@@ -2329,7 +2242,6 @@ export class EntityHitBlockAfterEventSignal {
2329
2242
  }
2330
2243
 
2331
2244
  /**
2332
- * @beta
2333
2245
  * Contains information related to an entity hitting (melee
2334
2246
  * attacking) another entity.
2335
2247
  */
@@ -2350,7 +2262,6 @@ export class EntityHitEntityAfterEvent {
2350
2262
  }
2351
2263
 
2352
2264
  /**
2353
- * @beta
2354
2265
  * Manages callbacks that are connected to when an entity makes
2355
2266
  * a melee attack on another entity.
2356
2267
  */
@@ -2381,7 +2292,6 @@ export class EntityHitEntityAfterEventSignal {
2381
2292
  }
2382
2293
 
2383
2294
  /**
2384
- * @beta
2385
2295
  * Contains information related to an entity getting hurt.
2386
2296
  */
2387
2297
  export class EntityHurtAfterEvent {
@@ -2408,7 +2318,6 @@ export class EntityHurtAfterEvent {
2408
2318
  }
2409
2319
 
2410
2320
  /**
2411
- * @beta
2412
2321
  * Manages callbacks that are connected to when an entity is
2413
2322
  * hurt.
2414
2323
  */
@@ -2437,7 +2346,6 @@ export class EntityHurtAfterEventSignal {
2437
2346
  }
2438
2347
 
2439
2348
  /**
2440
- * @beta
2441
2349
  * Defines this entity's inventory properties.
2442
2350
  */
2443
2351
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2499,7 +2407,6 @@ export class EntityInventoryComponent extends EntityComponent {
2499
2407
  }
2500
2408
 
2501
2409
  /**
2502
- * @beta
2503
2410
  * When added, this component signifies that this entity is a
2504
2411
  * baby.
2505
2412
  */
@@ -2510,7 +2417,6 @@ export class EntityIsBabyComponent extends EntityComponent {
2510
2417
  }
2511
2418
 
2512
2419
  /**
2513
- * @beta
2514
2420
  * When added, this component signifies that this entity is
2515
2421
  * charged.
2516
2422
  */
@@ -2521,7 +2427,6 @@ export class EntityIsChargedComponent extends EntityComponent {
2521
2427
  }
2522
2428
 
2523
2429
  /**
2524
- * @beta
2525
2430
  * When added, this component signifies that this entity is
2526
2431
  * currently carrying a chest.
2527
2432
  */
@@ -2532,7 +2437,6 @@ export class EntityIsChestedComponent extends EntityComponent {
2532
2437
  }
2533
2438
 
2534
2439
  /**
2535
- * @beta
2536
2440
  * When added, this component signifies that dyes can be used
2537
2441
  * on this entity to change its color.
2538
2442
  */
@@ -2543,7 +2447,6 @@ export class EntityIsDyeableComponent extends EntityComponent {
2543
2447
  }
2544
2448
 
2545
2449
  /**
2546
- * @beta
2547
2450
  * When added, this component signifies that this entity can
2548
2451
  * hide from hostile mobs while invisible.
2549
2452
  */
@@ -2554,7 +2457,6 @@ export class EntityIsHiddenWhenInvisibleComponent extends EntityComponent {
2554
2457
  }
2555
2458
 
2556
2459
  /**
2557
- * @beta
2558
2460
  * When added, this component signifies that this entity this
2559
2461
  * currently on fire.
2560
2462
  */
@@ -2565,7 +2467,6 @@ export class EntityIsIgnitedComponent extends EntityComponent {
2565
2467
  }
2566
2468
 
2567
2469
  /**
2568
- * @beta
2569
2470
  * When added, this component signifies that this entity is an
2570
2471
  * illager captain.
2571
2472
  */
@@ -2576,7 +2477,6 @@ export class EntityIsIllagerCaptainComponent extends EntityComponent {
2576
2477
  }
2577
2478
 
2578
2479
  /**
2579
- * @beta
2580
2480
  * When added, this component signifies that this entity is
2581
2481
  * currently saddled.
2582
2482
  */
@@ -2587,7 +2487,6 @@ export class EntityIsSaddledComponent extends EntityComponent {
2587
2487
  }
2588
2488
 
2589
2489
  /**
2590
- * @beta
2591
2490
  * When added, this component signifies that this entity is
2592
2491
  * currently shaking.
2593
2492
  */
@@ -2598,7 +2497,6 @@ export class EntityIsShakingComponent extends EntityComponent {
2598
2497
  }
2599
2498
 
2600
2499
  /**
2601
- * @beta
2602
2500
  * When added, this component signifies that this entity is
2603
2501
  * currently sheared.
2604
2502
  */
@@ -2609,7 +2507,6 @@ export class EntityIsShearedComponent extends EntityComponent {
2609
2507
  }
2610
2508
 
2611
2509
  /**
2612
- * @beta
2613
2510
  * When added, this component signifies that this entity can be
2614
2511
  * stacked.
2615
2512
  */
@@ -2620,7 +2517,6 @@ export class EntityIsStackableComponent extends EntityComponent {
2620
2517
  }
2621
2518
 
2622
2519
  /**
2623
- * @beta
2624
2520
  * When added, this component signifies that this entity is
2625
2521
  * currently stunned.
2626
2522
  */
@@ -2631,7 +2527,6 @@ export class EntityIsStunnedComponent extends EntityComponent {
2631
2527
  }
2632
2528
 
2633
2529
  /**
2634
- * @beta
2635
2530
  * When added, this component signifies that this entity is
2636
2531
  * currently tamed.
2637
2532
  */
@@ -2642,7 +2537,6 @@ export class EntityIsTamedComponent extends EntityComponent {
2642
2537
  }
2643
2538
 
2644
2539
  /**
2645
- * @beta
2646
2540
  * If added onto the entity, this indicates that the entity
2647
2541
  * represents a free-floating item in the world. Lets you
2648
2542
  * retrieve the actual item stack contents via the itemStack
@@ -2662,7 +2556,6 @@ export class EntityItemComponent extends EntityComponent {
2662
2556
  }
2663
2557
 
2664
2558
  /**
2665
- * @beta
2666
2559
  * Additional variant value. Can be used to further
2667
2560
  * differentiate variants.
2668
2561
  */
@@ -2681,7 +2574,6 @@ export class EntityMarkVariantComponent extends EntityComponent {
2681
2574
  }
2682
2575
 
2683
2576
  /**
2684
- * @beta
2685
2577
  * When added, this movement control allows the mob to swim in
2686
2578
  * water and walk on land.
2687
2579
  */
@@ -2692,7 +2584,6 @@ export class EntityMovementAmphibiousComponent extends EntityBaseMovementCompone
2692
2584
  }
2693
2585
 
2694
2586
  /**
2695
- * @beta
2696
2587
  * This component accents the movement of an entity.
2697
2588
  */
2698
2589
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2702,7 +2593,6 @@ export class EntityMovementBasicComponent extends EntityBaseMovementComponent {
2702
2593
  }
2703
2594
 
2704
2595
  /**
2705
- * @beta
2706
2596
  * When added, this move control causes the mob to fly.
2707
2597
  */
2708
2598
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2712,7 +2602,6 @@ export class EntityMovementFlyComponent extends EntityBaseMovementComponent {
2712
2602
  }
2713
2603
 
2714
2604
  /**
2715
- * @beta
2716
2605
  * When added, this move control allows a mob to fly, swim,
2717
2606
  * climb, etc.
2718
2607
  */
@@ -2723,7 +2612,6 @@ export class EntityMovementGenericComponent extends EntityBaseMovementComponent
2723
2612
  }
2724
2613
 
2725
2614
  /**
2726
- * @beta
2727
2615
  * When added, this move control causes the mob to hover.
2728
2616
  */
2729
2617
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2733,7 +2621,6 @@ export class EntityMovementHoverComponent extends EntityBaseMovementComponent {
2733
2621
  }
2734
2622
 
2735
2623
  /**
2736
- * @beta
2737
2624
  * Move control that causes the mob to jump as it moves with a
2738
2625
  * specified delay between jumps.
2739
2626
  */
@@ -2744,7 +2631,6 @@ export class EntityMovementJumpComponent extends EntityBaseMovementComponent {
2744
2631
  }
2745
2632
 
2746
2633
  /**
2747
- * @beta
2748
2634
  * When added, this move control causes the mob to hop as it
2749
2635
  * moves.
2750
2636
  */
@@ -2755,7 +2641,6 @@ export class EntityMovementSkipComponent extends EntityBaseMovementComponent {
2755
2641
  }
2756
2642
 
2757
2643
  /**
2758
- * @beta
2759
2644
  * Sets the distance through which the entity can push through.
2760
2645
  */
2761
2646
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2773,7 +2658,6 @@ export class EntityPushThroughComponent extends EntityComponent {
2773
2658
  }
2774
2659
 
2775
2660
  /**
2776
- * @beta
2777
2661
  * Sets the entity's visual size.
2778
2662
  */
2779
2663
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2791,7 +2675,6 @@ export class EntityScaleComponent extends EntityComponent {
2791
2675
  }
2792
2676
 
2793
2677
  /**
2794
- * @beta
2795
2678
  * Skin Id value. Can be used to differentiate skins, such as
2796
2679
  * base skins for villagers.
2797
2680
  */
@@ -2810,7 +2693,6 @@ export class EntitySkinIdComponent extends EntityComponent {
2810
2693
  }
2811
2694
 
2812
2695
  /**
2813
- * @beta
2814
2696
  * Used to differentiate the component group of a variant of an
2815
2697
  * entity from others. (e.g. ocelot, villager).
2816
2698
  */
@@ -2829,7 +2711,6 @@ export class EntityVariantComponent extends EntityComponent {
2829
2711
  }
2830
2712
 
2831
2713
  /**
2832
- * @beta
2833
2714
  * When added, this component signifies that this entity wants
2834
2715
  * to become a jockey.
2835
2716
  */
@@ -2840,7 +2721,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
2840
2721
  }
2841
2722
 
2842
2723
  /**
2843
- * @beta
2844
2724
  * As part of the Healable component, represents a specific
2845
2725
  * item that can be fed to an entity to cause health effects.
2846
2726
  */
@@ -2872,7 +2752,6 @@ export class FeedItem {
2872
2752
  }
2873
2753
 
2874
2754
  /**
2875
- * @beta
2876
2755
  * Represents an effect that is applied as a result of a food
2877
2756
  * item being fed to an entity.
2878
2757
  */
@@ -2909,7 +2788,6 @@ export class FeedItemEffect {
2909
2788
  }
2910
2789
 
2911
2790
  /**
2912
- * @beta
2913
2791
  * Provides an adaptable interface for callers to subscribe to
2914
2792
  * an event that fires when a button is pushed.
2915
2793
  */
@@ -2931,7 +2809,6 @@ export class IButtonPushAfterEventSignal {
2931
2809
  }
2932
2810
 
2933
2811
  /**
2934
- * @beta
2935
2812
  * Provides an adaptable interface for callers to subscribe to
2936
2813
  * an event that fires after a lever is used.
2937
2814
  */
@@ -2953,7 +2830,6 @@ export class ILeverActionAfterEventSignal {
2953
2830
  }
2954
2831
 
2955
2832
  /**
2956
- * @beta
2957
2833
  * Provides an adaptable interface for callers to subscribe to
2958
2834
  * an event that fires after a player joins a world.
2959
2835
  */
@@ -2975,7 +2851,6 @@ export class IPlayerJoinAfterEventSignal {
2975
2851
  }
2976
2852
 
2977
2853
  /**
2978
- * @beta
2979
2854
  * Provides an adaptable interface for callers to subscribe to
2980
2855
  * an event that fires after a player leaves a world.
2981
2856
  */
@@ -2997,7 +2872,6 @@ export class IPlayerLeaveAfterEventSignal {
2997
2872
  }
2998
2873
 
2999
2874
  /**
3000
- * @beta
3001
2875
  * Provides an adaptable interface for callers to subscribe to
3002
2876
  * an event that fires after a player spawns.
3003
2877
  */
@@ -3019,7 +2893,6 @@ export class IPlayerSpawnAfterEventSignal {
3019
2893
  }
3020
2894
 
3021
2895
  /**
3022
- * @beta
3023
2896
  * Contains information related to a chargeable item completing
3024
2897
  * being charged.
3025
2898
  */
@@ -3047,7 +2920,6 @@ export class ItemCompleteUseAfterEvent {
3047
2920
  }
3048
2921
 
3049
2922
  /**
3050
- * @beta
3051
2923
  * Manages callbacks that are connected to the completion of
3052
2924
  * charging for a chargeable item.
3053
2925
  */
@@ -3075,7 +2947,6 @@ export class ItemCompleteUseAfterEventSignal {
3075
2947
  }
3076
2948
 
3077
2949
  /**
3078
- * @beta
3079
2950
  * Base class for item components.
3080
2951
  */
3081
2952
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -3084,7 +2955,6 @@ export class ItemComponent extends Component {
3084
2955
  }
3085
2956
 
3086
2957
  /**
3087
- * @beta
3088
2958
  * Contains information related to a chargeable item when the
3089
2959
  * player has finished using the item and released the build
3090
2960
  * action.
@@ -3113,7 +2983,6 @@ export class ItemReleaseUseAfterEvent {
3113
2983
  }
3114
2984
 
3115
2985
  /**
3116
- * @beta
3117
2986
  * Manages callbacks that are connected to the releasing of
3118
2987
  * charging for a chargeable item.
3119
2988
  */
@@ -3141,20 +3010,9 @@ export class ItemReleaseUseAfterEventSignal {
3141
3010
  }
3142
3011
 
3143
3012
  /**
3144
- * @beta
3145
3013
  * Defines a collection of items.
3146
3014
  */
3147
3015
  export class ItemStack {
3148
- /**
3149
- * @remarks
3150
- * Number of the items in the stack. Valid values range between
3151
- * 1-255. The provided value will be clamped to the item's
3152
- * maximum stack size.
3153
- *
3154
- * @throws
3155
- * Throws if the value is outside the range of 1-255.
3156
- */
3157
- readonly amount: number;
3158
3016
  /**
3159
3017
  * @remarks
3160
3018
  * Returns whether the item is stackable. An item is considered
@@ -3163,19 +3021,6 @@ export class ItemStack {
3163
3021
  *
3164
3022
  */
3165
3023
  readonly isStackable: boolean;
3166
- /**
3167
- * @remarks
3168
- * Gets or sets whether the item is kept on death.
3169
- *
3170
- */
3171
- readonly keepOnDeath: boolean;
3172
- /**
3173
- * @remarks
3174
- * Gets or sets the item's lock mode. The default value is
3175
- * `ItemLockMode.none`.
3176
- *
3177
- */
3178
- readonly lockMode: ItemLockMode;
3179
3024
  /**
3180
3025
  * @remarks
3181
3026
  * The maximum stack size. This value varies depending on the
@@ -3184,16 +3029,6 @@ export class ItemStack {
3184
3029
  *
3185
3030
  */
3186
3031
  readonly maxAmount: number;
3187
- /**
3188
- * @remarks
3189
- * Given name of this stack of items. The name tag is displayed
3190
- * when hovering over the item. Setting the name tag to an
3191
- * empty string or `undefined` will remove the name tag.
3192
- *
3193
- * @throws
3194
- * Throws if the length exceeds 255 characters.
3195
- */
3196
- readonly nameTag?: string;
3197
3032
  /**
3198
3033
  * @remarks
3199
3034
  * The type of the item.
@@ -3254,7 +3089,6 @@ export class ItemStack {
3254
3089
  */
3255
3090
  getComponents(): ItemComponent[];
3256
3091
  /**
3257
- * @beta
3258
3092
  * @remarks
3259
3093
  * Returns the lore value - a secondary display string - for an
3260
3094
  * ItemStack.
@@ -3291,7 +3125,6 @@ export class ItemStack {
3291
3125
  */
3292
3126
  isStackableWith(itemStack: ItemStack): boolean;
3293
3127
  /**
3294
- * @beta
3295
3128
  * @remarks
3296
3129
  * Sets the lore value - a secondary display string - for an
3297
3130
  * ItemStack. The lore list is cleared if set to an empty
@@ -3334,7 +3167,6 @@ export class ItemStack {
3334
3167
  }
3335
3168
 
3336
3169
  /**
3337
- * @beta
3338
3170
  * Contains information related to a chargeable item starting
3339
3171
  * to be charged.
3340
3172
  */
@@ -3362,7 +3194,6 @@ export class ItemStartUseAfterEvent {
3362
3194
  }
3363
3195
 
3364
3196
  /**
3365
- * @beta
3366
3197
  * Manages callbacks that are connected to the start of
3367
3198
  * charging for a chargeable item.
3368
3199
  */
@@ -3390,7 +3221,6 @@ export class ItemStartUseAfterEventSignal {
3390
3221
  }
3391
3222
 
3392
3223
  /**
3393
- * @beta
3394
3224
  * Contains information related to an item being used on a
3395
3225
  * block. This event fires when a player presses the the Use
3396
3226
  * Item / Place Block button to successfully use an item or
@@ -3427,7 +3257,6 @@ export class ItemStartUseOnAfterEvent {
3427
3257
  }
3428
3258
 
3429
3259
  /**
3430
- * @beta
3431
3260
  * Manages callbacks that are connected to an item starting
3432
3261
  * being used on a block event.
3433
3262
  */
@@ -3455,7 +3284,6 @@ export class ItemStartUseOnAfterEventSignal {
3455
3284
  }
3456
3285
 
3457
3286
  /**
3458
- * @beta
3459
3287
  * Contains information related to a chargeable item has
3460
3288
  * finished an items use cycle, or when the player has released
3461
3289
  * the use action with the item.
@@ -3484,7 +3312,6 @@ export class ItemStopUseAfterEvent {
3484
3312
  }
3485
3313
 
3486
3314
  /**
3487
- * @beta
3488
3315
  * Manages callbacks that are connected to the stopping of
3489
3316
  * charging for an item that has a registered
3490
3317
  * minecraft:chargeable component.
@@ -3513,7 +3340,6 @@ export class ItemStopUseAfterEventSignal {
3513
3340
  }
3514
3341
 
3515
3342
  /**
3516
- * @beta
3517
3343
  * Contains information related to an item that has stopped
3518
3344
  * being used on a block. This event fires when a player
3519
3345
  * successfully uses an item or places a block by pressing the
@@ -3545,7 +3371,6 @@ export class ItemStopUseOnAfterEvent {
3545
3371
  }
3546
3372
 
3547
3373
  /**
3548
- * @beta
3549
3374
  * Manages callbacks that are connected to an item stops used
3550
3375
  * on a block event.
3551
3376
  */
@@ -3573,7 +3398,6 @@ export class ItemStopUseOnAfterEventSignal {
3573
3398
  }
3574
3399
 
3575
3400
  /**
3576
- * @beta
3577
3401
  * Represents the type of an item - for example, Wool.
3578
3402
  */
3579
3403
  export class ItemType {
@@ -3588,7 +3412,6 @@ export class ItemType {
3588
3412
  }
3589
3413
 
3590
3414
  /**
3591
- * @beta
3592
3415
  * Contains information related to an item being used. This
3593
3416
  * event fires when an item is successfully used by a player.
3594
3417
  */
@@ -3609,7 +3432,6 @@ export class ItemUseAfterEvent {
3609
3432
  }
3610
3433
 
3611
3434
  /**
3612
- * @beta
3613
3435
  * Manages callbacks that are connected to an item use event.
3614
3436
  */
3615
3437
  export class ItemUseAfterEventSignal {
@@ -3634,7 +3456,6 @@ export class ItemUseAfterEventSignal {
3634
3456
  }
3635
3457
 
3636
3458
  /**
3637
- * @beta
3638
3459
  * Contains information related to an item being used.
3639
3460
  */
3640
3461
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -3649,7 +3470,6 @@ export class ItemUseBeforeEvent extends ItemUseAfterEvent {
3649
3470
  }
3650
3471
 
3651
3472
  /**
3652
- * @beta
3653
3473
  * Manages callbacks that fire before an item is used.
3654
3474
  */
3655
3475
  export class ItemUseBeforeEventSignal {
@@ -3674,7 +3494,6 @@ export class ItemUseBeforeEventSignal {
3674
3494
  }
3675
3495
 
3676
3496
  /**
3677
- * @beta
3678
3497
  * Contains information related to an item being used on a
3679
3498
  * block. This event fires when an item is successfully used on
3680
3499
  * a block by a player.
@@ -3715,7 +3534,6 @@ export class ItemUseOnAfterEvent {
3715
3534
  }
3716
3535
 
3717
3536
  /**
3718
- * @beta
3719
3537
  * Manages callbacks that are connected to an item being used
3720
3538
  * on a block event.
3721
3539
  */
@@ -3743,7 +3561,6 @@ export class ItemUseOnAfterEventSignal {
3743
3561
  }
3744
3562
 
3745
3563
  /**
3746
- * @beta
3747
3564
  * Contains information related to an item being used on a
3748
3565
  * block.
3749
3566
  */
@@ -3759,7 +3576,6 @@ export class ItemUseOnBeforeEvent extends ItemUseOnAfterEvent {
3759
3576
  }
3760
3577
 
3761
3578
  /**
3762
- * @beta
3763
3579
  * Manages callbacks that fire before an item being used on a
3764
3580
  * block event.
3765
3581
  */
@@ -3787,7 +3603,6 @@ export class ItemUseOnBeforeEventSignal {
3787
3603
  }
3788
3604
 
3789
3605
  /**
3790
- * @beta
3791
3606
  * Contains information related to changes to a lever
3792
3607
  * activating or deactivating.
3793
3608
  */
@@ -3810,7 +3625,6 @@ export class LeverActionAfterEvent extends BlockEvent {
3810
3625
  }
3811
3626
 
3812
3627
  /**
3813
- * @beta
3814
3628
  * Manages callbacks that are connected to lever moves
3815
3629
  * (activates or deactivates).
3816
3630
  */
@@ -3862,7 +3676,6 @@ export class MinecraftDimensionTypes {
3862
3676
  }
3863
3677
 
3864
3678
  /**
3865
- * @beta
3866
3679
  * Contains a set of additional variable values for further
3867
3680
  * defining how rendering and animations function.
3868
3681
  */
@@ -3944,7 +3757,6 @@ export class Player extends Entity {
3944
3757
  */
3945
3758
  readonly name: string;
3946
3759
  /**
3947
- * @beta
3948
3760
  * @remarks
3949
3761
  * Contains methods for manipulating the on-screen display of a
3950
3762
  * Player.
@@ -3953,7 +3765,6 @@ export class Player extends Entity {
3953
3765
  */
3954
3766
  readonly onScreenDisplay: ScreenDisplay;
3955
3767
  /**
3956
- * @beta
3957
3768
  * @remarks
3958
3769
  * Gets the current spawn point of the player.
3959
3770
  *
@@ -3961,12 +3772,13 @@ export class Player extends Entity {
3961
3772
  */
3962
3773
  getSpawnPoint(): DimensionLocation | undefined;
3963
3774
  /**
3964
- * @beta
3965
3775
  * @remarks
3966
3776
  * Plays a sound that only this particular player can hear.
3967
3777
  *
3968
3778
  * This function can't be called in read-only mode.
3969
3779
  *
3780
+ * @param soundID
3781
+ * Identifier of the sound to play.
3970
3782
  * @param soundOptions
3971
3783
  * Additional optional options for the sound.
3972
3784
  * @throws This function can throw errors.
@@ -3995,9 +3807,8 @@ export class Player extends Entity {
3995
3807
  * players[0].playSound("bucket.fill_water", playerSoundOptions);
3996
3808
  * ```
3997
3809
  */
3998
- playSound(soundId: string, soundOptions?: PlayerSoundOptions): void;
3810
+ playSound(soundID: string, soundOptions?: PlayerSoundOptions): void;
3999
3811
  /**
4000
- * @beta
4001
3812
  * @remarks
4002
3813
  * Sends a message to the player.
4003
3814
  *
@@ -4048,7 +3859,6 @@ export class Player extends Entity {
4048
3859
  */
4049
3860
  sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
4050
3861
  /**
4051
- * @beta
4052
3862
  * @remarks
4053
3863
  * Sets the current starting spawn point for this particular
4054
3864
  * player.
@@ -4056,12 +3866,15 @@ export class Player extends Entity {
4056
3866
  * This function can't be called in read-only mode.
4057
3867
  *
4058
3868
  * @throws This function can throw errors.
3869
+ *
3870
+ * {@link Error}
3871
+ *
3872
+ * {@link LocationOutOfWorldBoundariesError}
4059
3873
  */
4060
3874
  setSpawnPoint(spawnPoint?: DimensionLocation): void;
4061
3875
  }
4062
3876
 
4063
3877
  /**
4064
- * @beta
4065
3878
  * Contains information regarding a player that has joined.
4066
3879
  * See the playerSpawn event for more detailed information that
4067
3880
  * could be returned after the first time a player has spawned
@@ -4084,7 +3897,6 @@ export class PlayerJoinAfterEvent {
4084
3897
  }
4085
3898
 
4086
3899
  /**
4087
- * @beta
4088
3900
  * Manages callbacks that are connected to a player joining the
4089
3901
  * world.
4090
3902
  */
@@ -4094,7 +3906,6 @@ export class PlayerJoinAfterEventSignal extends IPlayerJoinAfterEventSignal {
4094
3906
  }
4095
3907
 
4096
3908
  /**
4097
- * @beta
4098
3909
  * Contains information regarding a player that has left the
4099
3910
  * world.
4100
3911
  */
@@ -4116,7 +3927,6 @@ export class PlayerLeaveAfterEvent {
4116
3927
  }
4117
3928
 
4118
3929
  /**
4119
- * @beta
4120
3930
  * Manages callbacks that are connected to a player leaving the
4121
3931
  * world.
4122
3932
  */
@@ -4126,7 +3936,6 @@ export class PlayerLeaveAfterEventSignal extends IPlayerLeaveAfterEventSignal {
4126
3936
  }
4127
3937
 
4128
3938
  /**
4129
- * @beta
4130
3939
  * An event that contains more information about a player
4131
3940
  * spawning.
4132
3941
  */
@@ -4152,7 +3961,6 @@ export class PlayerSpawnAfterEvent {
4152
3961
  }
4153
3962
 
4154
3963
  /**
4155
- * @beta
4156
3964
  * Registers an event when a player is spawned (or re-spawned
4157
3965
  * after death) and fully ready within the world.
4158
3966
  */
@@ -4162,7 +3970,6 @@ export class PlayerSpawnAfterEventSignal extends IPlayerSpawnAfterEventSignal {
4162
3970
  }
4163
3971
 
4164
3972
  /**
4165
- * @beta
4166
3973
  * Contains information related to changes to a pressure plate
4167
3974
  * pop.
4168
3975
  */
@@ -4186,7 +3993,6 @@ export class PressurePlatePopAfterEvent extends BlockEvent {
4186
3993
  }
4187
3994
 
4188
3995
  /**
4189
- * @beta
4190
3996
  * Manages callbacks that are connected to when a pressure
4191
3997
  * plate is popped.
4192
3998
  */
@@ -4214,7 +4020,6 @@ export class PressurePlatePopAfterEventSignal {
4214
4020
  }
4215
4021
 
4216
4022
  /**
4217
- * @beta
4218
4023
  * Contains information related to changes to a pressure plate
4219
4024
  * push.
4220
4025
  */
@@ -4244,7 +4049,6 @@ export class PressurePlatePushAfterEvent extends BlockEvent {
4244
4049
  }
4245
4050
 
4246
4051
  /**
4247
- * @beta
4248
4052
  * Manages callbacks that are connected to when a pressure
4249
4053
  * plate is pushed.
4250
4054
  */
@@ -4272,7 +4076,6 @@ export class PressurePlatePushAfterEventSignal {
4272
4076
  }
4273
4077
 
4274
4078
  /**
4275
- * @beta
4276
4079
  * Contains information related to a projectile hitting a
4277
4080
  * block.
4278
4081
  */
@@ -4320,7 +4123,6 @@ export class ProjectileHitBlockAfterEvent {
4320
4123
  }
4321
4124
 
4322
4125
  /**
4323
- * @beta
4324
4126
  * Manages callbacks that are connected to when a projectile
4325
4127
  * hits a block.
4326
4128
  */
@@ -4348,7 +4150,6 @@ export class ProjectileHitBlockAfterEventSignal {
4348
4150
  }
4349
4151
 
4350
4152
  /**
4351
- * @beta
4352
4153
  * Contains information related to a projectile hitting an
4353
4154
  * entity.
4354
4155
  */
@@ -4396,7 +4197,6 @@ export class ProjectileHitEntityAfterEvent {
4396
4197
  }
4397
4198
 
4398
4199
  /**
4399
- * @beta
4400
4200
  * Manages callbacks that are connected to when a projectile
4401
4201
  * hits an entity.
4402
4202
  */
@@ -4424,7 +4224,6 @@ export class ProjectileHitEntityAfterEventSignal {
4424
4224
  }
4425
4225
 
4426
4226
  /**
4427
- * @beta
4428
4227
  * Contains objectives and participants for the scoreboard.
4429
4228
  */
4430
4229
  export class Scoreboard {
@@ -4502,7 +4301,6 @@ export class Scoreboard {
4502
4301
  }
4503
4302
 
4504
4303
  /**
4505
- * @beta
4506
4304
  * Contains an identity of the scoreboard item.
4507
4305
  */
4508
4306
  export class ScoreboardIdentity {
@@ -4543,7 +4341,6 @@ export class ScoreboardIdentity {
4543
4341
  }
4544
4342
 
4545
4343
  /**
4546
- * @beta
4547
4344
  * Contains objectives and participants for the scoreboard.
4548
4345
  */
4549
4346
  export class ScoreboardObjective {
@@ -4641,7 +4438,6 @@ export class ScoreboardObjective {
4641
4438
  }
4642
4439
 
4643
4440
  /**
4644
- * @beta
4645
4441
  * Contains a pair of a scoreboard participant and its
4646
4442
  * respective score.
4647
4443
  */
@@ -4662,7 +4458,6 @@ export class ScoreboardScoreInfo {
4662
4458
  }
4663
4459
 
4664
4460
  /**
4665
- * @beta
4666
4461
  * Contains information about user interface elements that are
4667
4462
  * showing up on the screen.
4668
4463
  */
@@ -4751,7 +4546,6 @@ export class ScreenDisplay {
4751
4546
  }
4752
4547
 
4753
4548
  /**
4754
- * @beta
4755
4549
  * Returns additional data about a /scriptevent command
4756
4550
  * invocation.
4757
4551
  */
@@ -4800,7 +4594,6 @@ export class ScriptEventCommandMessageAfterEvent {
4800
4594
  }
4801
4595
 
4802
4596
  /**
4803
- * @beta
4804
4597
  * Allows for registering an event handler that responds to
4805
4598
  * inbound /scriptevent commands.
4806
4599
  */
@@ -4834,7 +4627,6 @@ export class ScriptEventCommandMessageAfterEventSignal {
4834
4627
  export class System {
4835
4628
  private constructor();
4836
4629
  /**
4837
- * @beta
4838
4630
  * @remarks
4839
4631
  * Returns a collection of after-events for system-level
4840
4632
  * operations.
@@ -4842,14 +4634,12 @@ export class System {
4842
4634
  */
4843
4635
  readonly afterEvents: SystemAfterEvents;
4844
4636
  /**
4845
- * @beta
4846
4637
  * @remarks
4847
4638
  * Represents the current world tick of the server.
4848
4639
  *
4849
4640
  */
4850
4641
  readonly currentTick: number;
4851
4642
  /**
4852
- * @beta
4853
4643
  * @remarks
4854
4644
  * Cancels the execution of a function run that was previously
4855
4645
  * scheduled via the `run` function.
@@ -4886,7 +4676,6 @@ export class System {
4886
4676
  */
4887
4677
  run(callback: () => void): number;
4888
4678
  /**
4889
- * @beta
4890
4679
  * @remarks
4891
4680
  * Runs a set of code on an interval.
4892
4681
  *
@@ -4909,7 +4698,6 @@ export class System {
4909
4698
  */
4910
4699
  runInterval(callback: () => void, tickInterval?: number): number;
4911
4700
  /**
4912
- * @beta
4913
4701
  * @remarks
4914
4702
  * Runs a set of code at a future time specified by tickDelay.
4915
4703
  *
@@ -4926,7 +4714,6 @@ export class System {
4926
4714
  }
4927
4715
 
4928
4716
  /**
4929
- * @beta
4930
4717
  * Provides a set of events that fire within the broader
4931
4718
  * scripting system within Minecraft.
4932
4719
  */
@@ -4943,7 +4730,6 @@ export class SystemAfterEvents {
4943
4730
  }
4944
4731
 
4945
4732
  /**
4946
- * @beta
4947
4733
  * Contains information related to changes to a target block
4948
4734
  * hit.
4949
4735
  */
@@ -4977,7 +4763,6 @@ export class TargetBlockHitAfterEvent extends BlockEvent {
4977
4763
  }
4978
4764
 
4979
4765
  /**
4980
- * @beta
4981
4766
  * Manages callbacks that are connected to when a target block
4982
4767
  * is hit.
4983
4768
  */
@@ -5005,7 +4790,6 @@ export class TargetBlockHitAfterEventSignal {
5005
4790
  }
5006
4791
 
5007
4792
  /**
5008
- * @beta
5009
4793
  * Contains information related to changes to a trip wire trip.
5010
4794
  */
5011
4795
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -5026,7 +4810,6 @@ export class TripWireTripAfterEvent extends BlockEvent {
5026
4810
  }
5027
4811
 
5028
4812
  /**
5029
- * @beta
5030
4813
  * Manages callbacks that are connected to when a trip wire is
5031
4814
  * tripped.
5032
4815
  */
@@ -5060,7 +4843,6 @@ export class TripWireTripAfterEventSignal {
5060
4843
  export class World {
5061
4844
  private constructor();
5062
4845
  /**
5063
- * @beta
5064
4846
  * @remarks
5065
4847
  * Contains a set of events that are applicable to the entirety
5066
4848
  * of the world. Event callbacks are called in a deferred
@@ -5069,7 +4851,6 @@ export class World {
5069
4851
  */
5070
4852
  readonly afterEvents: WorldAfterEvents;
5071
4853
  /**
5072
- * @beta
5073
4854
  * @remarks
5074
4855
  * Contains a set of events that are applicable to the entirety
5075
4856
  * of the world. Event callbacks are called immediately. Event
@@ -5078,7 +4859,6 @@ export class World {
5078
4859
  */
5079
4860
  readonly beforeEvents: WorldBeforeEvents;
5080
4861
  /**
5081
- * @beta
5082
4862
  * @remarks
5083
4863
  * Returns the general global scoreboard that applies to the
5084
4864
  * world.
@@ -5086,7 +4866,6 @@ export class World {
5086
4866
  */
5087
4867
  readonly scoreboard: Scoreboard;
5088
4868
  /**
5089
- * @beta
5090
4869
  * @remarks
5091
4870
  * Returns the absolute time since the start of the world.
5092
4871
  *
@@ -5100,7 +4879,6 @@ export class World {
5100
4879
  */
5101
4880
  getAllPlayers(): Player[];
5102
4881
  /**
5103
- * @beta
5104
4882
  * @remarks
5105
4883
  * Returns the current day.
5106
4884
  *
@@ -5110,7 +4888,6 @@ export class World {
5110
4888
  */
5111
4889
  getDay(): number;
5112
4890
  /**
5113
- * @beta
5114
4891
  * @remarks
5115
4892
  * Returns the default Overworld spawn location.
5116
4893
  *
@@ -5134,7 +4911,6 @@ export class World {
5134
4911
  */
5135
4912
  getDimension(dimensionId: string): Dimension;
5136
4913
  /**
5137
- * @beta
5138
4914
  * @remarks
5139
4915
  * Returns a set of players based on a set of conditions
5140
4916
  * defined via the EntityQueryOptions set of filter criteria.
@@ -5149,7 +4925,6 @@ export class World {
5149
4925
  */
5150
4926
  getPlayers(options?: EntityQueryOptions): Player[];
5151
4927
  /**
5152
- * @beta
5153
4928
  * @remarks
5154
4929
  * Returns the time of day.
5155
4930
  *
@@ -5158,7 +4933,6 @@ export class World {
5158
4933
  */
5159
4934
  getTimeOfDay(): number;
5160
4935
  /**
5161
- * @beta
5162
4936
  * @remarks
5163
4937
  * Plays a particular music track for all players.
5164
4938
  *
@@ -5190,9 +4964,8 @@ export class World {
5190
4964
  * players[0].playSound("bucket.fill_water", playerSoundOptions);
5191
4965
  * ```
5192
4966
  */
5193
- playMusic(trackId: string, musicOptions?: MusicOptions): void;
4967
+ playMusic(trackID: string, musicOptions?: MusicOptions): void;
5194
4968
  /**
5195
- * @beta
5196
4969
  * @remarks
5197
4970
  * Plays a sound for all players.
5198
4971
  *
@@ -5228,17 +5001,14 @@ export class World {
5228
5001
  * players[0].playSound("bucket.fill_water", playerSoundOptions);
5229
5002
  * ```
5230
5003
  */
5231
- playSound(soundId: string, location: Vector3, soundOptions?: WorldSoundOptions): void;
5004
+ playSound(soundID: string, location: Vector3, soundOptions?: WorldSoundOptions): void;
5232
5005
  /**
5233
- * @beta
5234
5006
  * @remarks
5235
5007
  * Queues an additional music track for players. If a track is
5236
5008
  * not playing, a music track will play.
5237
5009
  *
5238
5010
  * This function can't be called in read-only mode.
5239
5011
  *
5240
- * @param trackId
5241
- * Identifier of the music track to play.
5242
5012
  * @param musicOptions
5243
5013
  * Additional options for the music track.
5244
5014
  * @throws
@@ -5246,9 +5016,8 @@ export class World {
5246
5016
  * An error will be thrown if fade is less than 0.0.
5247
5017
  *
5248
5018
  */
5249
- queueMusic(trackId: string, musicOptions?: MusicOptions): void;
5019
+ queueMusic(trackID: string, musicOptions?: MusicOptions): void;
5250
5020
  /**
5251
- * @beta
5252
5021
  * @remarks
5253
5022
  * Sends a message to all players.
5254
5023
  *
@@ -5287,7 +5056,6 @@ export class World {
5287
5056
  */
5288
5057
  sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
5289
5058
  /**
5290
- * @beta
5291
5059
  * @remarks
5292
5060
  * Sets the world time.
5293
5061
  *
@@ -5298,7 +5066,6 @@ export class World {
5298
5066
  */
5299
5067
  setAbsoluteTime(absoluteTime: number): void;
5300
5068
  /**
5301
- * @beta
5302
5069
  * @remarks
5303
5070
  * Sets a default spawn location for all players.
5304
5071
  *
@@ -5309,10 +5076,13 @@ export class World {
5309
5076
  * within the overworld dimension.
5310
5077
  * @throws
5311
5078
  * Throws if the provided spawn location is out of bounds.
5079
+ *
5080
+ * {@link Error}
5081
+ *
5082
+ * {@link LocationOutOfWorldBoundariesError}
5312
5083
  */
5313
5084
  setDefaultSpawnLocation(spawnLocation: Vector3): void;
5314
5085
  /**
5315
- * @beta
5316
5086
  * @remarks
5317
5087
  * Sets the time of day.
5318
5088
  *
@@ -5326,7 +5096,6 @@ export class World {
5326
5096
  */
5327
5097
  setTimeOfDay(timeOfDay: number | TimeOfDay): void;
5328
5098
  /**
5329
- * @beta
5330
5099
  * @remarks
5331
5100
  * Stops any music tracks from playing.
5332
5101
  *
@@ -5337,7 +5106,6 @@ export class World {
5337
5106
  }
5338
5107
 
5339
5108
  /**
5340
- * @beta
5341
5109
  * Contains a set of events that are available across the scope
5342
5110
  * of the World.
5343
5111
  */
@@ -5350,21 +5118,18 @@ export class WorldAfterEvents {
5350
5118
  */
5351
5119
  readonly buttonPush: ButtonPushAfterEventSignal;
5352
5120
  /**
5353
- * @beta
5354
5121
  * @remarks
5355
5122
  * This event fires when an entity dies.
5356
5123
  *
5357
5124
  */
5358
5125
  readonly entityDie: EntityDieAfterEventSignal;
5359
5126
  /**
5360
- * @beta
5361
5127
  * @remarks
5362
5128
  * This event fires when entity health changes in any degree.
5363
5129
  *
5364
5130
  */
5365
5131
  readonly entityHealthChanged: EntityHealthChangedAfterEventSignal;
5366
5132
  /**
5367
- * @beta
5368
5133
  * @remarks
5369
5134
  * This event fires when an entity hits (that is, melee
5370
5135
  * attacks) a block.
@@ -5372,7 +5137,6 @@ export class WorldAfterEvents {
5372
5137
  */
5373
5138
  readonly entityHitBlock: EntityHitBlockAfterEventSignal;
5374
5139
  /**
5375
- * @beta
5376
5140
  * @remarks
5377
5141
  * This event fires when an entity hits (that is, melee
5378
5142
  * attacks) another entity.
@@ -5380,21 +5144,18 @@ export class WorldAfterEvents {
5380
5144
  */
5381
5145
  readonly entityHitEntity: EntityHitEntityAfterEventSignal;
5382
5146
  /**
5383
- * @beta
5384
5147
  * @remarks
5385
5148
  * This event fires when an entity is hurt (takes damage).
5386
5149
  *
5387
5150
  */
5388
5151
  readonly entityHurt: EntityHurtAfterEventSignal;
5389
5152
  /**
5390
- * @beta
5391
5153
  * @remarks
5392
5154
  * This event fires when a chargeable item completes charging.
5393
5155
  *
5394
5156
  */
5395
5157
  readonly itemCompleteUse: ItemCompleteUseAfterEventSignal;
5396
5158
  /**
5397
- * @beta
5398
5159
  * @remarks
5399
5160
  * This event fires when a chargeable item is released from
5400
5161
  * charging.
@@ -5402,14 +5163,12 @@ export class WorldAfterEvents {
5402
5163
  */
5403
5164
  readonly itemReleaseUse: ItemReleaseUseAfterEventSignal;
5404
5165
  /**
5405
- * @beta
5406
5166
  * @remarks
5407
5167
  * This event fires when a chargeable item starts charging.
5408
5168
  *
5409
5169
  */
5410
5170
  readonly itemStartUse: ItemStartUseAfterEventSignal;
5411
5171
  /**
5412
- * @beta
5413
5172
  * @remarks
5414
5173
  * This event fires when a player successfully uses an item or
5415
5174
  * places a block by pressing the Use Item / Place Block
@@ -5420,14 +5179,12 @@ export class WorldAfterEvents {
5420
5179
  */
5421
5180
  readonly itemStartUseOn: ItemStartUseOnAfterEventSignal;
5422
5181
  /**
5423
- * @beta
5424
5182
  * @remarks
5425
5183
  * This event fires when a chargeable item stops charging.
5426
5184
  *
5427
5185
  */
5428
5186
  readonly itemStopUse: ItemStopUseAfterEventSignal;
5429
5187
  /**
5430
- * @beta
5431
5188
  * @remarks
5432
5189
  * This event fires when a player releases the Use Item / Place
5433
5190
  * Block button after successfully using an item. Note: This
@@ -5436,7 +5193,6 @@ export class WorldAfterEvents {
5436
5193
  */
5437
5194
  readonly itemStopUseOn: ItemStopUseOnAfterEventSignal;
5438
5195
  /**
5439
- * @beta
5440
5196
  * @remarks
5441
5197
  * This event fires when an item is successfully used by a
5442
5198
  * player.
@@ -5444,7 +5200,6 @@ export class WorldAfterEvents {
5444
5200
  */
5445
5201
  readonly itemUse: ItemUseAfterEventSignal;
5446
5202
  /**
5447
- * @beta
5448
5203
  * @remarks
5449
5204
  * This event fires when an item is used on a block by a
5450
5205
  * player.
@@ -5480,7 +5235,6 @@ export class WorldAfterEvents {
5480
5235
  */
5481
5236
  readonly playerSpawn: PlayerSpawnAfterEventSignal;
5482
5237
  /**
5483
- * @beta
5484
5238
  * @remarks
5485
5239
  * A pressure plate has popped back up (i.e., there are no
5486
5240
  * entities on the pressure plate.)
@@ -5488,7 +5242,6 @@ export class WorldAfterEvents {
5488
5242
  */
5489
5243
  readonly pressurePlatePop: PressurePlatePopAfterEventSignal;
5490
5244
  /**
5491
- * @beta
5492
5245
  * @remarks
5493
5246
  * A pressure plate has pushed (at least one entity has moved
5494
5247
  * onto a pressure plate.)
@@ -5496,28 +5249,24 @@ export class WorldAfterEvents {
5496
5249
  */
5497
5250
  readonly pressurePlatePush: PressurePlatePushAfterEventSignal;
5498
5251
  /**
5499
- * @beta
5500
5252
  * @remarks
5501
5253
  * This event fires when a projectile hits a block.
5502
5254
  *
5503
5255
  */
5504
5256
  readonly projectileHitBlock: ProjectileHitBlockAfterEventSignal;
5505
5257
  /**
5506
- * @beta
5507
5258
  * @remarks
5508
5259
  * This event fires when a projectile hits an entity.
5509
5260
  *
5510
5261
  */
5511
5262
  readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
5512
5263
  /**
5513
- * @beta
5514
5264
  * @remarks
5515
5265
  * A target block was hit.
5516
5266
  *
5517
5267
  */
5518
5268
  readonly targetBlockHit: TargetBlockHitAfterEventSignal;
5519
5269
  /**
5520
- * @beta
5521
5270
  * @remarks
5522
5271
  * A trip wire was tripped.
5523
5272
  *
@@ -5526,7 +5275,6 @@ export class WorldAfterEvents {
5526
5275
  }
5527
5276
 
5528
5277
  /**
5529
- * @beta
5530
5278
  * A set of events that fire before an actual action occurs. In
5531
5279
  * most cases, you can potentially cancel or modify the
5532
5280
  * impending event. Note that in before events any APIs that
@@ -5552,7 +5300,6 @@ export class WorldBeforeEvents {
5552
5300
  }
5553
5301
 
5554
5302
  /**
5555
- * @beta
5556
5303
  * Contains more information for events where a block is hit.
5557
5304
  */
5558
5305
  export interface BlockHitInformation {
@@ -5578,7 +5325,6 @@ export interface BlockHitInformation {
5578
5325
  }
5579
5326
 
5580
5327
  /**
5581
- * @beta
5582
5328
  * Contains information for block raycast hit results.
5583
5329
  */
5584
5330
  export interface BlockRaycastHit {
@@ -5604,7 +5350,6 @@ export interface BlockRaycastHit {
5604
5350
  }
5605
5351
 
5606
5352
  /**
5607
- * @beta
5608
5353
  * Contains additional options for configuring a block raycast
5609
5354
  * query.
5610
5355
  */
@@ -5632,7 +5377,6 @@ export interface BlockRaycastOptions {
5632
5377
  }
5633
5378
 
5634
5379
  /**
5635
- * @beta
5636
5380
  * An exact coordinate within the world, including its
5637
5381
  * dimension and location.
5638
5382
  */
@@ -5664,7 +5408,6 @@ export interface DimensionLocation {
5664
5408
  }
5665
5409
 
5666
5410
  /**
5667
- * @beta
5668
5411
  * Additional options for when damage has been applied via a
5669
5412
  * projectile.
5670
5413
  */
@@ -5684,7 +5427,6 @@ export interface EntityApplyDamageByProjectileOptions {
5684
5427
  }
5685
5428
 
5686
5429
  /**
5687
- * @beta
5688
5430
  * Additional descriptions and metadata for a damage event.
5689
5431
  */
5690
5432
  export interface EntityApplyDamageOptions {
@@ -5703,7 +5445,6 @@ export interface EntityApplyDamageOptions {
5703
5445
  }
5704
5446
 
5705
5447
  /**
5706
- * @beta
5707
5448
  * Provides information about how damage has been applied to an
5708
5449
  * entity.
5709
5450
  */
@@ -5729,7 +5470,6 @@ export interface EntityDamageSource {
5729
5470
  }
5730
5471
 
5731
5472
  /**
5732
- * @beta
5733
5473
  * Contains additional options for entity effects.
5734
5474
  */
5735
5475
  export interface EntityEffectOptions {
@@ -5748,7 +5488,6 @@ export interface EntityEffectOptions {
5748
5488
  }
5749
5489
 
5750
5490
  /**
5751
- * @beta
5752
5491
  * Contains optional parameters for registering an entity
5753
5492
  * event.
5754
5493
  */
@@ -5770,7 +5509,6 @@ export interface EntityEventOptions {
5770
5509
  }
5771
5510
 
5772
5511
  /**
5773
- * @beta
5774
5512
  * Contains additional information about an entity that was
5775
5513
  * hit.
5776
5514
  */
@@ -5784,7 +5522,6 @@ export interface EntityHitInformation {
5784
5522
  }
5785
5523
 
5786
5524
  /**
5787
- * @beta
5788
5525
  * Contains options for selecting entities within an area.
5789
5526
  */
5790
5527
  export interface EntityQueryOptions {
@@ -5947,7 +5684,6 @@ export interface EntityQueryOptions {
5947
5684
  }
5948
5685
 
5949
5686
  /**
5950
- * @beta
5951
5687
  * Contains additional options for filtering players based on
5952
5688
  * their score for an objective.
5953
5689
  */
@@ -5982,7 +5718,6 @@ export interface EntityQueryScoreOptions {
5982
5718
  }
5983
5719
 
5984
5720
  /**
5985
- * @beta
5986
5721
  * Contains information for entity raycast hit results.
5987
5722
  */
5988
5723
  export interface EntityRaycastHit {
@@ -6001,7 +5736,6 @@ export interface EntityRaycastHit {
6001
5736
  }
6002
5737
 
6003
5738
  /**
6004
- * @beta
6005
5739
  * Contains additional options for an entity raycast operation.
6006
5740
  */
6007
5741
  export interface EntityRaycastOptions {
@@ -6014,7 +5748,6 @@ export interface EntityRaycastOptions {
6014
5748
  }
6015
5749
 
6016
5750
  /**
6017
- * @beta
6018
5751
  * Additional configuration options for {@link
6019
5752
  * World.playMusic}/{@link World.queueMusic} methods.
6020
5753
  */
@@ -6040,7 +5773,6 @@ export interface MusicOptions {
6040
5773
  }
6041
5774
 
6042
5775
  /**
6043
- * @beta
6044
5776
  * Additional options for how a sound plays for a player.
6045
5777
  */
6046
5778
  export interface PlayerSoundOptions {
@@ -6066,7 +5798,6 @@ export interface PlayerSoundOptions {
6066
5798
  }
6067
5799
 
6068
5800
  /**
6069
- * @beta
6070
5801
  * Defines a JSON structure that is used for more flexible.
6071
5802
  */
6072
5803
  export interface RawMessage {
@@ -6108,7 +5839,6 @@ export interface RawMessage {
6108
5839
  }
6109
5840
 
6110
5841
  /**
6111
- * @beta
6112
5842
  * Provides a description of a score token to use within a raw
6113
5843
  * message.
6114
5844
  */
@@ -6128,7 +5858,6 @@ export interface RawMessageScore {
6128
5858
  }
6129
5859
 
6130
5860
  /**
6131
- * @beta
6132
5861
  * Represents a fully customizable color within Minecraft.
6133
5862
  */
6134
5863
  export interface RGB {
@@ -6156,7 +5885,6 @@ export interface RGB {
6156
5885
  }
6157
5886
 
6158
5887
  /**
6159
- * @beta
6160
5888
  * Represents a fully customizable color within Minecraft.
6161
5889
  */
6162
5890
  export interface RGBA {
@@ -6191,7 +5919,6 @@ export interface RGBA {
6191
5919
  }
6192
5920
 
6193
5921
  /**
6194
- * @beta
6195
5922
  * Contains additional options for how a scoreboard should be
6196
5923
  * displayed within its display slot.
6197
5924
  */
@@ -6211,7 +5938,6 @@ export interface ScoreboardObjectiveDisplayOptions {
6211
5938
  }
6212
5939
 
6213
5940
  /**
6214
- * @beta
6215
5941
  * Contains additional options for registering a script event
6216
5942
  * event callback.
6217
5943
  */
@@ -6226,7 +5952,6 @@ export interface ScriptEventMessageFilterOptions {
6226
5952
  }
6227
5953
 
6228
5954
  /**
6229
- * @beta
6230
5955
  * Contains additional options for teleporting an entity.
6231
5956
  */
6232
5957
  export interface TeleportOptions {
@@ -6266,7 +5991,6 @@ export interface TeleportOptions {
6266
5991
  }
6267
5992
 
6268
5993
  /**
6269
- * @beta
6270
5994
  * Contains additional options for displaying a title and
6271
5995
  * optional subtitle.
6272
5996
  */
@@ -6305,7 +6029,6 @@ export interface TitleDisplayOptions {
6305
6029
  }
6306
6030
 
6307
6031
  /**
6308
- * @beta
6309
6032
  * Represents a two-directional vector.
6310
6033
  */
6311
6034
  export interface Vector2 {
@@ -6324,7 +6047,6 @@ export interface Vector2 {
6324
6047
  }
6325
6048
 
6326
6049
  /**
6327
- * @beta
6328
6050
  * Contains a description of a vector.
6329
6051
  */
6330
6052
  export interface Vector3 {
@@ -6349,7 +6071,6 @@ export interface Vector3 {
6349
6071
  }
6350
6072
 
6351
6073
  /**
6352
- * @beta
6353
6074
  * Contains additional options for a world-level playSound
6354
6075
  * occurrence.
6355
6076
  */
@@ -6368,25 +6089,16 @@ export interface WorldSoundOptions {
6368
6089
  volume?: number;
6369
6090
  }
6370
6091
 
6371
- /**
6372
- * @beta
6373
- */
6374
6092
  // @ts-ignore Class inheritance allowed for native defined classes
6375
6093
  export class CommandError extends Error {
6376
6094
  private constructor();
6377
6095
  }
6378
6096
 
6379
- /**
6380
- * @beta
6381
- */
6382
6097
  // @ts-ignore Class inheritance allowed for native defined classes
6383
6098
  export class LocationInUnloadedChunkError extends Error {
6384
6099
  private constructor();
6385
6100
  }
6386
6101
 
6387
- /**
6388
- * @beta
6389
- */
6390
6102
  // @ts-ignore Class inheritance allowed for native defined classes
6391
6103
  export class LocationOutOfWorldBoundariesError extends Error {
6392
6104
  private constructor();