@minecraft/server 1.5.0-rc.1.20.40-preview.20 → 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 +93 -300
  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.6.0-internal.1.20.40-preview.20"
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,17 +63,29 @@ export enum Direction {
71
63
  }
72
64
 
73
65
  /**
74
- * @beta
66
+ * Specifies a mechanism for displaying scores on a scoreboard.
75
67
  */
76
68
  export enum DisplaySlotId {
69
+ /**
70
+ * @remarks
71
+ * Displays the score below the player's name.
72
+ *
73
+ */
77
74
  BelowName = 'BelowName',
75
+ /**
76
+ * @remarks
77
+ * Displays the score as a list on the pause screen.
78
+ *
79
+ */
78
80
  List = 'List',
81
+ /**
82
+ * @remarks
83
+ * Displays the score on the side of the player's screen.
84
+ *
85
+ */
79
86
  Sidebar = 'Sidebar',
80
87
  }
81
88
 
82
- /**
83
- * @beta
84
- */
85
89
  export enum EntityDamageCause {
86
90
  anvil = 'anvil',
87
91
  blockExplosion = 'blockExplosion',
@@ -117,13 +121,11 @@ export enum EntityDamageCause {
117
121
  }
118
122
 
119
123
  /**
120
- * @beta
121
124
  * The equipment slot of the mob. This includes armor, offhand
122
125
  * and mainhand slots.
123
126
  */
124
127
  export enum EquipmentSlot {
125
128
  /**
126
- * @beta
127
129
  * @remarks
128
130
  * The chest slot. This slot is used to hold items such as
129
131
  * Chestplate or Elytra.
@@ -131,7 +133,6 @@ export enum EquipmentSlot {
131
133
  */
132
134
  Chest = 'Chest',
133
135
  /**
134
- * @beta
135
136
  * @remarks
136
137
  * The feet slot. This slot is used to hold items such as
137
138
  * Boots.
@@ -139,7 +140,6 @@ export enum EquipmentSlot {
139
140
  */
140
141
  Feet = 'Feet',
141
142
  /**
142
- * @beta
143
143
  * @remarks
144
144
  * The head slot. This slot is used to hold items such as
145
145
  * Helmets or Carved Pumpkins.
@@ -147,7 +147,6 @@ export enum EquipmentSlot {
147
147
  */
148
148
  Head = 'Head',
149
149
  /**
150
- * @beta
151
150
  * @remarks
152
151
  * The legs slot. This slot is used to hold items such as
153
152
  * Leggings.
@@ -155,7 +154,6 @@ export enum EquipmentSlot {
155
154
  */
156
155
  Legs = 'Legs',
157
156
  /**
158
- * @beta
159
157
  * @remarks
160
158
  * The mainhand slot. For players, the mainhand slot refers to
161
159
  * the currently active hotbar slot.
@@ -163,7 +161,6 @@ export enum EquipmentSlot {
163
161
  */
164
162
  Mainhand = 'Mainhand',
165
163
  /**
166
- * @beta
167
164
  * @remarks
168
165
  * The offhand slot. This slot is used to hold items such as
169
166
  * shields and maps.
@@ -173,12 +170,10 @@ export enum EquipmentSlot {
173
170
  }
174
171
 
175
172
  /**
176
- * @beta
177
173
  * Represents a game mode for the current world experience.
178
174
  */
179
175
  export enum GameMode {
180
176
  /**
181
- * @beta
182
177
  * @remarks
183
178
  * World is in a more locked-down experience, where blocks may
184
179
  * not be manipulated.
@@ -186,7 +181,6 @@ export enum GameMode {
186
181
  */
187
182
  adventure = 'adventure',
188
183
  /**
189
- * @beta
190
184
  * @remarks
191
185
  * World is in a full creative mode. In creative mode, the
192
186
  * player has all the resources available in the item selection
@@ -199,7 +193,6 @@ export enum GameMode {
199
193
  */
200
194
  creative = 'creative',
201
195
  /**
202
- * @beta
203
196
  * @remarks
204
197
  * World is in spectator mode. In spectator mode, spectators
205
198
  * are always flying and cannot become grounded. Spectators can
@@ -212,7 +205,6 @@ export enum GameMode {
212
205
  */
213
206
  spectator = 'spectator',
214
207
  /**
215
- * @beta
216
208
  * @remarks
217
209
  * World is in a survival mode, where players can take damage
218
210
  * and entities may not be peaceful. Survival mode is where the
@@ -225,26 +217,22 @@ export enum GameMode {
225
217
  }
226
218
 
227
219
  /**
228
- * @beta
229
220
  * Describes how an an item can be moved within a container.
230
221
  */
231
222
  export enum ItemLockMode {
232
223
  /**
233
- * @beta
234
224
  * @remarks
235
225
  * The item cannot be dropped or crafted with.
236
226
  *
237
227
  */
238
228
  inventory = 'inventory',
239
229
  /**
240
- * @beta
241
230
  * @remarks
242
231
  * The item has no container restrictions.
243
232
  *
244
233
  */
245
234
  none = 'none',
246
235
  /**
247
- * @beta
248
236
  * @remarks
249
237
  * The item cannot be moved from its slot, dropped or crafted
250
238
  * with.
@@ -254,13 +242,11 @@ export enum ItemLockMode {
254
242
  }
255
243
 
256
244
  /**
257
- * @beta
258
245
  * Used for specifying a sort order for how to display an
259
246
  * objective and its list of participants.
260
247
  */
261
248
  export enum ObjectiveSortOrder {
262
249
  /**
263
- * @beta
264
250
  * @remarks
265
251
  * Objective participant list is displayed in ascending (e.g.,
266
252
  * A-Z) order.
@@ -268,7 +254,6 @@ export enum ObjectiveSortOrder {
268
254
  */
269
255
  Ascending = 0,
270
256
  /**
271
- * @beta
272
257
  * @remarks
273
258
  * Objective participant list is displayed in descending (e.g.,
274
259
  * Z-A) order.
@@ -278,19 +263,16 @@ export enum ObjectiveSortOrder {
278
263
  }
279
264
 
280
265
  /**
281
- * @beta
282
266
  * Contains objectives and participants for the scoreboard.
283
267
  */
284
268
  export enum ScoreboardIdentityType {
285
269
  /**
286
- * @beta
287
270
  * @remarks
288
271
  * This scoreboard participant is tied to an entity.
289
272
  *
290
273
  */
291
274
  Entity = 'Entity',
292
275
  /**
293
- * @beta
294
276
  * @remarks
295
277
  * This scoreboard participant is tied to a pseudo player
296
278
  * entity - typically this is used to store scores as data or
@@ -299,7 +281,6 @@ export enum ScoreboardIdentityType {
299
281
  */
300
282
  FakePlayer = 'FakePlayer',
301
283
  /**
302
- * @beta
303
284
  * @remarks
304
285
  * This scoreboard participant is tied to a player.
305
286
  *
@@ -308,12 +289,10 @@ export enum ScoreboardIdentityType {
308
289
  }
309
290
 
310
291
  /**
311
- * @beta
312
292
  * Describes where the script event originated from.
313
293
  */
314
294
  export enum ScriptEventSource {
315
295
  /**
316
- * @beta
317
296
  * @remarks
318
297
  * The script event originated from a Block such as a Command
319
298
  * Block.
@@ -321,7 +300,6 @@ export enum ScriptEventSource {
321
300
  */
322
301
  Block = 'Block',
323
302
  /**
324
- * @beta
325
303
  * @remarks
326
304
  * The script event originated from an Entity such as a Player,
327
305
  * Command Block Minecart or Animation Controller.
@@ -329,14 +307,12 @@ export enum ScriptEventSource {
329
307
  */
330
308
  Entity = 'Entity',
331
309
  /**
332
- * @beta
333
310
  * @remarks
334
311
  * The script event originated from an NPC dialogue.
335
312
  *
336
313
  */
337
314
  NPCDialogue = 'NPCDialogue',
338
315
  /**
339
- * @beta
340
316
  * @remarks
341
317
  * The script event originated from the server, such as from a
342
318
  * runCommand API call or a dedicated server console.
@@ -346,7 +322,6 @@ export enum ScriptEventSource {
346
322
  }
347
323
 
348
324
  /**
349
- * @beta
350
325
  * Provides numeric values for common periods in the Minecraft
351
326
  * day.
352
327
  */
@@ -360,7 +335,6 @@ export enum TimeOfDay {
360
335
  }
361
336
 
362
337
  /**
363
- * @beta
364
338
  * Represents a block in a dimension. A block represents a
365
339
  * unique X, Y, and Z within a dimension and get/sets the state
366
340
  * of the block at that location. This type was significantly
@@ -387,6 +361,10 @@ export class Block {
387
361
  * block.
388
362
  *
389
363
  * @throws This property can throw when used.
364
+ *
365
+ * {@link LocationInUnloadedChunkError}
366
+ *
367
+ * {@link LocationOutOfWorldBoundariesError}
390
368
  */
391
369
  readonly permutation: BlockPermutation;
392
370
  /**
@@ -408,7 +386,6 @@ export class Block {
408
386
  */
409
387
  readonly z: number;
410
388
  /**
411
- * @beta
412
389
  * @remarks
413
390
  * Gets additional configuration properties (a component) for
414
391
  * specific capabilities of particular blocks - for example, an
@@ -421,10 +398,13 @@ export class Block {
421
398
  * Returns the component object if it is present on the
422
399
  * particular block.
423
400
  * @throws This function can throw errors.
401
+ *
402
+ * {@link LocationInUnloadedChunkError}
403
+ *
404
+ * {@link LocationOutOfWorldBoundariesError}
424
405
  */
425
406
  getComponent(componentName: string): BlockComponent | undefined;
426
407
  /**
427
- * @beta
428
408
  * @remarks
429
409
  * Returns true if this reference to a block is still valid
430
410
  * (for example, if the block is unloaded, references to that
@@ -445,19 +425,21 @@ export class Block {
445
425
  * Permutation that contains a set of property states for the
446
426
  * Block.
447
427
  * @throws This function can throw errors.
428
+ *
429
+ * {@link LocationInUnloadedChunkError}
430
+ *
431
+ * {@link LocationOutOfWorldBoundariesError}
448
432
  */
449
433
  setPermutation(permutation: BlockPermutation): void;
450
434
  }
451
435
 
452
436
  /**
453
- * @beta
454
437
  * Base type for components associated with blocks.
455
438
  */
456
439
  // @ts-ignore Class inheritance allowed for native defined classes
457
440
  export class BlockComponent extends Component {
458
441
  private constructor();
459
442
  /**
460
- * @beta
461
443
  * @remarks
462
444
  * Block instance that this component pertains to.
463
445
  *
@@ -466,7 +448,6 @@ export class BlockComponent extends Component {
466
448
  }
467
449
 
468
450
  /**
469
- * @beta
470
451
  * Contains information regarding an event that impacts a
471
452
  * specific block.
472
453
  */
@@ -488,7 +469,6 @@ export class BlockEvent {
488
469
  }
489
470
 
490
471
  /**
491
- * @beta
492
472
  * Represents the inventory of a block in the world. Used with
493
473
  * blocks like chests.
494
474
  */
@@ -506,7 +486,6 @@ export class BlockInventoryComponent extends BlockComponent {
506
486
  }
507
487
 
508
488
  /**
509
- * @beta
510
489
  * Contains the combination of type {@link BlockType} and
511
490
  * properties (also sometimes called block state) which
512
491
  * describe a block (but does not belong to a specific {@link
@@ -578,7 +557,6 @@ export class BlockPermutation {
578
557
  }
579
558
 
580
559
  /**
581
- * @beta
582
560
  * Contains information related to changes to a button push.
583
561
  */
584
562
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -593,7 +571,6 @@ export class ButtonPushAfterEvent extends BlockEvent {
593
571
  }
594
572
 
595
573
  /**
596
- * @beta
597
574
  * Manages callbacks that are connected to when a button is
598
575
  * pushed.
599
576
  */
@@ -618,7 +595,6 @@ export class CommandResult {
618
595
  }
619
596
 
620
597
  /**
621
- * @beta
622
598
  * Base class for downstream Component implementations.
623
599
  */
624
600
  export class Component {
@@ -630,7 +606,6 @@ export class Component {
630
606
  */
631
607
  readonly typeId: string;
632
608
  /**
633
- * @beta
634
609
  * @remarks
635
610
  * Returns whether the component is valid. A component is
636
611
  * considered valid if its owner is valid, in addition to any
@@ -644,7 +619,6 @@ export class Component {
644
619
  }
645
620
 
646
621
  /**
647
- * @beta
648
622
  * Represents a container that can hold sets of items. Used
649
623
  * with entities such as Players, Chest Minecarts, Llamas, and
650
624
  * more.
@@ -716,7 +690,6 @@ export class Container {
716
690
  */
717
691
  getItem(slot: number): ItemStack | undefined;
718
692
  /**
719
- * @beta
720
693
  * @remarks
721
694
  * Returns whether a container object (or the entity or block
722
695
  * that this container is associated with) is still available
@@ -832,7 +805,6 @@ export class Dimension {
832
805
  */
833
806
  readonly id: string;
834
807
  /**
835
- * @beta
836
808
  * @remarks
837
809
  * Returns a block instance at the given location.
838
810
  *
@@ -850,10 +822,13 @@ export class Dimension {
850
822
  * trying to interact with a position outside of dimension
851
823
  * height range
852
824
  *
825
+ *
826
+ * {@link LocationInUnloadedChunkError}
827
+ *
828
+ * {@link LocationOutOfWorldBoundariesError}
853
829
  */
854
830
  getBlock(location: Vector3): Block | undefined;
855
831
  /**
856
- * @beta
857
832
  * @remarks
858
833
  * Gets the first block that intersects with a vector emanating
859
834
  * from a location.
@@ -867,7 +842,6 @@ export class Dimension {
867
842
  */
868
843
  getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
869
844
  /**
870
- * @beta
871
845
  * @remarks
872
846
  * Returns a set of entities based on a set of conditions
873
847
  * defined via the EntityQueryOptions set of filter criteria.
@@ -936,7 +910,6 @@ export class Dimension {
936
910
  */
937
911
  getEntities(options?: EntityQueryOptions): Entity[];
938
912
  /**
939
- * @beta
940
913
  * @remarks
941
914
  * Returns a set of entities at a particular location.
942
915
  *
@@ -947,7 +920,6 @@ export class Dimension {
947
920
  */
948
921
  getEntitiesAtBlockLocation(location: Vector3): Entity[];
949
922
  /**
950
- * @beta
951
923
  * @remarks
952
924
  * Gets entities that intersect with a specified vector
953
925
  * emanating from a location.
@@ -957,7 +929,6 @@ export class Dimension {
957
929
  */
958
930
  getEntitiesFromRay(location: Vector3, direction: Vector3, options?: EntityRaycastOptions): EntityRaycastHit[];
959
931
  /**
960
- * @beta
961
932
  * @remarks
962
933
  * Returns a set of players based on a set of conditions
963
934
  * defined via the EntityQueryOptions set of filter criteria.
@@ -971,7 +942,6 @@ export class Dimension {
971
942
  */
972
943
  getPlayers(options?: EntityQueryOptions): Player[];
973
944
  /**
974
- * @beta
975
945
  * @remarks
976
946
  * Runs a command synchronously using the context of the
977
947
  * broader dimenion.
@@ -990,6 +960,8 @@ export class Dimension {
990
960
  * command. Note that in many cases, if the command does not
991
961
  * operate (e.g., a target selector found no matches), this
992
962
  * method will not throw an exception.
963
+ *
964
+ * {@link CommandError}
993
965
  */
994
966
  runCommand(commandString: string): CommandResult;
995
967
  /**
@@ -1014,7 +986,6 @@ export class Dimension {
1014
986
  */
1015
987
  runCommandAsync(commandString: string): Promise<CommandResult>;
1016
988
  /**
1017
- * @beta
1018
989
  * @remarks
1019
990
  * Creates a new entity (e.g., a mob) at the specified
1020
991
  * location.
@@ -1029,6 +1000,10 @@ export class Dimension {
1029
1000
  * @returns
1030
1001
  * Newly created entity at the specified location.
1031
1002
  * @throws This function can throw errors.
1003
+ *
1004
+ * {@link LocationInUnloadedChunkError}
1005
+ *
1006
+ * {@link LocationOutOfWorldBoundariesError}
1032
1007
  * @example createOldHorse.ts
1033
1008
  * ```typescript
1034
1009
  * const overworld = mc.world.getDimension("overworld");
@@ -1071,7 +1046,6 @@ export class Dimension {
1071
1046
  */
1072
1047
  spawnEntity(identifier: string, location: Vector3): Entity;
1073
1048
  /**
1074
- * @beta
1075
1049
  * @remarks
1076
1050
  * Creates a new item stack as an entity at the specified
1077
1051
  * location.
@@ -1083,6 +1057,10 @@ export class Dimension {
1083
1057
  * @returns
1084
1058
  * Newly created item stack entity at the specified location.
1085
1059
  * @throws This function can throw errors.
1060
+ *
1061
+ * {@link LocationInUnloadedChunkError}
1062
+ *
1063
+ * {@link LocationOutOfWorldBoundariesError}
1086
1064
  * @example itemStacks.ts
1087
1065
  * ```typescript
1088
1066
  * const overworld = mc.world.getDimension('overworld');
@@ -1114,7 +1092,6 @@ export class Dimension {
1114
1092
  */
1115
1093
  spawnItem(itemStack: ItemStack, location: Vector3): Entity;
1116
1094
  /**
1117
- * @beta
1118
1095
  * @remarks
1119
1096
  * Creates a new particle emitter at a specified location in
1120
1097
  * the world.
@@ -1129,6 +1106,10 @@ export class Dimension {
1129
1106
  * A set of optional, customizable variables that can be
1130
1107
  * adjusted for this particle.
1131
1108
  * @throws This function can throw errors.
1109
+ *
1110
+ * {@link LocationInUnloadedChunkError}
1111
+ *
1112
+ * {@link LocationOutOfWorldBoundariesError}
1132
1113
  * @example spawnParticle.ts
1133
1114
  * ```typescript
1134
1115
  * for (let i = 0; i < 100; i++) {
@@ -1149,7 +1130,6 @@ export class Dimension {
1149
1130
  }
1150
1131
 
1151
1132
  /**
1152
- * @beta
1153
1133
  * Represents an effect - like poison - that has been added to
1154
1134
  * an Entity.
1155
1135
  */
@@ -1198,7 +1178,6 @@ export class Effect {
1198
1178
  }
1199
1179
 
1200
1180
  /**
1201
- * @beta
1202
1181
  * Represents a type of effect - like poison - that can be
1203
1182
  * applied to an entity.
1204
1183
  */
@@ -1221,7 +1200,6 @@ export class EffectType {
1221
1200
  export class Entity {
1222
1201
  private constructor();
1223
1202
  /**
1224
- * @beta
1225
1203
  * @remarks
1226
1204
  * Dimension that the entity is currently within.
1227
1205
  *
@@ -1240,7 +1218,6 @@ export class Entity {
1240
1218
  */
1241
1219
  readonly id: string;
1242
1220
  /**
1243
- * @beta
1244
1221
  * @remarks
1245
1222
  * Current location of the entity.
1246
1223
  *
@@ -1248,7 +1225,6 @@ export class Entity {
1248
1225
  */
1249
1226
  readonly location: Vector3;
1250
1227
  /**
1251
- * @beta
1252
1228
  * @remarks
1253
1229
  * Given name of the entity.
1254
1230
  *
@@ -1257,7 +1233,6 @@ export class Entity {
1257
1233
  */
1258
1234
  nameTag: string;
1259
1235
  /**
1260
- * @beta
1261
1236
  * @remarks
1262
1237
  * Returns a scoreboard identity that represents this entity.
1263
1238
  * Will remain valid when the entity is killed.
@@ -1273,7 +1248,6 @@ export class Entity {
1273
1248
  */
1274
1249
  readonly typeId: string;
1275
1250
  /**
1276
- * @beta
1277
1251
  * @remarks
1278
1252
  * Adds or updates an effect, like poison, to the entity.
1279
1253
  *
@@ -1332,7 +1306,6 @@ export class Entity {
1332
1306
  */
1333
1307
  addEffect(effectType: EffectType | string, duration: number, options?: EntityEffectOptions): void;
1334
1308
  /**
1335
- * @beta
1336
1309
  * @remarks
1337
1310
  * Adds a specified tag to an entity.
1338
1311
  *
@@ -1367,7 +1340,6 @@ export class Entity {
1367
1340
  */
1368
1341
  addTag(tag: string): boolean;
1369
1342
  /**
1370
- * @beta
1371
1343
  * @remarks
1372
1344
  * Applies a set of damage to an entity.
1373
1345
  *
@@ -1400,7 +1372,6 @@ export class Entity {
1400
1372
  */
1401
1373
  applyDamage(amount: number, options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions): boolean;
1402
1374
  /**
1403
- * @beta
1404
1375
  * @remarks
1405
1376
  * Applies impulse vector to the current velocity of the
1406
1377
  * entity.
@@ -1422,7 +1393,6 @@ export class Entity {
1422
1393
  */
1423
1394
  applyImpulse(vector: Vector3): void;
1424
1395
  /**
1425
- * @beta
1426
1396
  * @remarks
1427
1397
  * Applies impulse vector to the current velocity of the
1428
1398
  * entity.
@@ -1458,7 +1428,6 @@ export class Entity {
1458
1428
  */
1459
1429
  applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void;
1460
1430
  /**
1461
- * @beta
1462
1431
  * @remarks
1463
1432
  * Sets the current velocity of the Entity to zero. Note that
1464
1433
  * this method may not have an impact on Players.
@@ -1478,7 +1447,6 @@ export class Entity {
1478
1447
  */
1479
1448
  clearVelocity(): void;
1480
1449
  /**
1481
- * @beta
1482
1450
  * @remarks
1483
1451
  * Returns the first intersecting block from the direction that
1484
1452
  * this entity is looking at.
@@ -1492,7 +1460,6 @@ export class Entity {
1492
1460
  */
1493
1461
  getBlockFromViewDirection(options?: BlockRaycastOptions): BlockRaycastHit | undefined;
1494
1462
  /**
1495
- * @beta
1496
1463
  * @remarks
1497
1464
  * Gets a component (that represents additional capabilities)
1498
1465
  * for an entity.
@@ -1508,7 +1475,6 @@ export class Entity {
1508
1475
  */
1509
1476
  getComponent(componentId: string): EntityComponent | undefined;
1510
1477
  /**
1511
- * @beta
1512
1478
  * @remarks
1513
1479
  * Returns all components that are both present on this entity
1514
1480
  * and supported by the API.
@@ -1519,7 +1485,6 @@ export class Entity {
1519
1485
  */
1520
1486
  getComponents(): EntityComponent[];
1521
1487
  /**
1522
- * @beta
1523
1488
  * @remarks
1524
1489
  * Returns the effect for the specified EffectType on the
1525
1490
  * entity, undefined if the effect is not present, or throws an
@@ -1535,7 +1500,6 @@ export class Entity {
1535
1500
  */
1536
1501
  getEffect(effectType: EffectType | string): Effect | undefined;
1537
1502
  /**
1538
- * @beta
1539
1503
  * @remarks
1540
1504
  * Returns a set of effects applied to this entity.
1541
1505
  *
@@ -1545,7 +1509,6 @@ export class Entity {
1545
1509
  */
1546
1510
  getEffects(): Effect[];
1547
1511
  /**
1548
- * @beta
1549
1512
  * @remarks
1550
1513
  * Gets the entities that this entity is looking at by
1551
1514
  * performing a ray cast from the view of this entity.
@@ -1559,7 +1522,6 @@ export class Entity {
1559
1522
  */
1560
1523
  getEntitiesFromViewDirection(options?: EntityRaycastOptions): EntityRaycastHit[];
1561
1524
  /**
1562
- * @beta
1563
1525
  * @remarks
1564
1526
  * Returns the current location of the head component of this
1565
1527
  * entity.
@@ -1571,7 +1533,6 @@ export class Entity {
1571
1533
  */
1572
1534
  getHeadLocation(): Vector3;
1573
1535
  /**
1574
- * @beta
1575
1536
  * @remarks
1576
1537
  * Returns all tags associated with an entity.
1577
1538
  *
@@ -1581,7 +1542,6 @@ export class Entity {
1581
1542
  */
1582
1543
  getTags(): string[];
1583
1544
  /**
1584
- * @beta
1585
1545
  * @remarks
1586
1546
  * Returns the current velocity vector of the entity.
1587
1547
  *
@@ -1601,7 +1561,6 @@ export class Entity {
1601
1561
  */
1602
1562
  getVelocity(): Vector3;
1603
1563
  /**
1604
- * @beta
1605
1564
  * @remarks
1606
1565
  * Returns the current view direction of the entity.
1607
1566
  *
@@ -1611,7 +1570,6 @@ export class Entity {
1611
1570
  */
1612
1571
  getViewDirection(): Vector3;
1613
1572
  /**
1614
- * @beta
1615
1573
  * @remarks
1616
1574
  * Returns true if the specified component is present on this
1617
1575
  * entity.
@@ -1626,7 +1584,6 @@ export class Entity {
1626
1584
  */
1627
1585
  hasComponent(componentId: string): boolean;
1628
1586
  /**
1629
- * @beta
1630
1587
  * @remarks
1631
1588
  * Returns whether an entity has a particular tag.
1632
1589
  *
@@ -1638,7 +1595,6 @@ export class Entity {
1638
1595
  */
1639
1596
  hasTag(tag: string): boolean;
1640
1597
  /**
1641
- * @beta
1642
1598
  * @remarks
1643
1599
  * Returns whether the entity can be manipulated by script. A
1644
1600
  * Player is considered valid when it's EntityLifetimeState is
@@ -1649,7 +1605,6 @@ export class Entity {
1649
1605
  */
1650
1606
  isValid(): boolean;
1651
1607
  /**
1652
- * @beta
1653
1608
  * @remarks
1654
1609
  * Kills this entity. The entity will drop loot as normal.
1655
1610
  *
@@ -1681,7 +1636,6 @@ export class Entity {
1681
1636
  */
1682
1637
  kill(): boolean;
1683
1638
  /**
1684
- * @beta
1685
1639
  * @remarks
1686
1640
  * Removes the specified EffectType on the entity, or returns
1687
1641
  * false if the effect is not present.
@@ -1697,7 +1651,6 @@ export class Entity {
1697
1651
  */
1698
1652
  removeEffect(effectType: EffectType | string): boolean;
1699
1653
  /**
1700
- * @beta
1701
1654
  * @remarks
1702
1655
  * Removes a specified tag from an entity.
1703
1656
  *
@@ -1711,7 +1664,6 @@ export class Entity {
1711
1664
  */
1712
1665
  removeTag(tag: string): boolean;
1713
1666
  /**
1714
- * @beta
1715
1667
  * @remarks
1716
1668
  * Runs a synchronous command on the entity.
1717
1669
  *
@@ -1724,6 +1676,10 @@ export class Entity {
1724
1676
  * A command result containing whether the command was
1725
1677
  * successful.
1726
1678
  * @throws This function can throw errors.
1679
+ *
1680
+ * {@link CommandError}
1681
+ *
1682
+ * {@link Error}
1727
1683
  */
1728
1684
  runCommand(commandString: string): CommandResult;
1729
1685
  /**
@@ -1742,7 +1698,6 @@ export class Entity {
1742
1698
  */
1743
1699
  runCommandAsync(commandString: string): Promise<CommandResult>;
1744
1700
  /**
1745
- * @beta
1746
1701
  * @remarks
1747
1702
  * Teleports the selected entity to a new location
1748
1703
  *
@@ -1775,7 +1730,6 @@ export class Entity {
1775
1730
  */
1776
1731
  teleport(location: Vector3, teleportOptions?: TeleportOptions): void;
1777
1732
  /**
1778
- * @beta
1779
1733
  * @remarks
1780
1734
  * Triggers an entity type event. For every entity, a number of
1781
1735
  * events are defined in an entities' definition for key entity
@@ -1799,7 +1753,6 @@ export class Entity {
1799
1753
  */
1800
1754
  triggerEvent(eventName: string): void;
1801
1755
  /**
1802
- * @beta
1803
1756
  * @remarks
1804
1757
  * Attempts to try a teleport, but may not complete the
1805
1758
  * teleport operation (for example, if there are blocks at the
@@ -1821,7 +1774,6 @@ export class Entity {
1821
1774
  }
1822
1775
 
1823
1776
  /**
1824
- * @beta
1825
1777
  * This is a base abstract class for any entity component that
1826
1778
  * centers around a number and can have a minimum, maximum, and
1827
1779
  * default defined value.
@@ -1901,7 +1853,6 @@ export class EntityAttributeComponent extends EntityComponent {
1901
1853
  }
1902
1854
 
1903
1855
  /**
1904
- * @beta
1905
1856
  * Base class for a family of entity movement events.
1906
1857
  */
1907
1858
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -1917,7 +1868,6 @@ export class EntityBaseMovementComponent extends EntityComponent {
1917
1868
  }
1918
1869
 
1919
1870
  /**
1920
- * @beta
1921
1871
  * When added, this component signifies that the entity can
1922
1872
  * climb up ladders.
1923
1873
  */
@@ -1928,7 +1878,6 @@ export class EntityCanClimbComponent extends EntityComponent {
1928
1878
  }
1929
1879
 
1930
1880
  /**
1931
- * @beta
1932
1881
  * When added, this component signifies that the entity can
1933
1882
  * fly, and the pathfinder won't be restricted to paths where a
1934
1883
  * solid block is required underneath it.
@@ -1940,7 +1889,6 @@ export class EntityCanFlyComponent extends EntityComponent {
1940
1889
  }
1941
1890
 
1942
1891
  /**
1943
- * @beta
1944
1892
  * When added, this component signifies that the entity can
1945
1893
  * power jump like the horse does within Minecraft.
1946
1894
  */
@@ -1951,7 +1899,6 @@ export class EntityCanPowerJumpComponent extends EntityComponent {
1951
1899
  }
1952
1900
 
1953
1901
  /**
1954
- * @beta
1955
1902
  * Defines the entity's color. Only works on certain entities
1956
1903
  * that have predefined color values (e.g., sheep, llama,
1957
1904
  * shulker).
@@ -1971,7 +1918,6 @@ export class EntityColorComponent extends EntityComponent {
1971
1918
  }
1972
1919
 
1973
1920
  /**
1974
- * @beta
1975
1921
  * Base class for downstream entity components.
1976
1922
  */
1977
1923
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -1980,7 +1926,6 @@ export class EntityComponent extends Component {
1980
1926
  }
1981
1927
 
1982
1928
  /**
1983
- * @beta
1984
1929
  * Contains data related to the death of an entity in the game.
1985
1930
  */
1986
1931
  export class EntityDieAfterEvent {
@@ -2001,7 +1946,6 @@ export class EntityDieAfterEvent {
2001
1946
  }
2002
1947
 
2003
1948
  /**
2004
- * @beta
2005
1949
  * Supports registering for an event that fires after an entity
2006
1950
  * has died.
2007
1951
  */
@@ -2039,7 +1983,6 @@ export class EntityDieAfterEventSignal {
2039
1983
  }
2040
1984
 
2041
1985
  /**
2042
- * @beta
2043
1986
  * Provides access to a mob's equipment slots. This component
2044
1987
  * exists for all mob entities.
2045
1988
  */
@@ -2077,7 +2020,6 @@ export class EntityEquippableComponent extends EntityComponent {
2077
2020
  }
2078
2021
 
2079
2022
  /**
2080
- * @beta
2081
2023
  * When added, this component signifies that this entity
2082
2024
  * doesn't take damage from fire.
2083
2025
  */
@@ -2088,7 +2030,6 @@ export class EntityFireImmuneComponent extends EntityComponent {
2088
2030
  }
2089
2031
 
2090
2032
  /**
2091
- * @beta
2092
2033
  * When added, this component signifies that this entity can
2093
2034
  * float in liquid blocks.
2094
2035
  */
@@ -2099,7 +2040,6 @@ export class EntityFloatsInLiquidComponent extends EntityComponent {
2099
2040
  }
2100
2041
 
2101
2042
  /**
2102
- * @beta
2103
2043
  * Represents the flying speed of an entity.
2104
2044
  */
2105
2045
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2117,7 +2057,6 @@ export class EntityFlyingSpeedComponent extends EntityComponent {
2117
2057
  }
2118
2058
 
2119
2059
  /**
2120
- * @beta
2121
2060
  * Defines how much friction affects this entity.
2122
2061
  */
2123
2062
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2136,7 +2075,6 @@ export class EntityFrictionModifierComponent extends EntityComponent {
2136
2075
  }
2137
2076
 
2138
2077
  /**
2139
- * @beta
2140
2078
  * Sets the offset from the ground that the entity is actually
2141
2079
  * at.
2142
2080
  */
@@ -2145,7 +2083,9 @@ export class EntityGroundOffsetComponent extends EntityComponent {
2145
2083
  private constructor();
2146
2084
  /**
2147
2085
  * @remarks
2148
- * Value of this particular ground offset.
2086
+ * Value of this particular ground offset. Note that this value
2087
+ * is effectively read only; setting the ground offset value
2088
+ * will not have an impact on the related entity.
2149
2089
  *
2150
2090
  * This property can't be edited in read-only mode.
2151
2091
  *
@@ -2155,7 +2095,6 @@ export class EntityGroundOffsetComponent extends EntityComponent {
2155
2095
  }
2156
2096
 
2157
2097
  /**
2158
- * @beta
2159
2098
  * Defines the interactions with this entity for healing it.
2160
2099
  */
2161
2100
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2182,7 +2121,6 @@ export class EntityHealableComponent extends EntityComponent {
2182
2121
  }
2183
2122
 
2184
2123
  /**
2185
- * @beta
2186
2124
  * Contains information related to an entity when its health
2187
2125
  * changes. Warning: don't change the health of an entity in
2188
2126
  * this event, or it will cause an infinite loop!
@@ -2210,7 +2148,6 @@ export class EntityHealthChangedAfterEvent {
2210
2148
  }
2211
2149
 
2212
2150
  /**
2213
- * @beta
2214
2151
  * Manages callbacks that are connected to when the health of
2215
2152
  * an entity changes.
2216
2153
  */
@@ -2241,7 +2178,6 @@ export class EntityHealthChangedAfterEventSignal {
2241
2178
  }
2242
2179
 
2243
2180
  /**
2244
- * @beta
2245
2181
  * Defines the health properties of an entity.
2246
2182
  */
2247
2183
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2251,7 +2187,6 @@ export class EntityHealthComponent extends EntityAttributeComponent {
2251
2187
  }
2252
2188
 
2253
2189
  /**
2254
- * @beta
2255
2190
  * Contains information related to an entity hitting a block.
2256
2191
  */
2257
2192
  export class EntityHitBlockAfterEvent {
@@ -2277,7 +2212,6 @@ export class EntityHitBlockAfterEvent {
2277
2212
  }
2278
2213
 
2279
2214
  /**
2280
- * @beta
2281
2215
  * Manages callbacks that are connected to when an entity hits
2282
2216
  * a block.
2283
2217
  */
@@ -2308,7 +2242,6 @@ export class EntityHitBlockAfterEventSignal {
2308
2242
  }
2309
2243
 
2310
2244
  /**
2311
- * @beta
2312
2245
  * Contains information related to an entity hitting (melee
2313
2246
  * attacking) another entity.
2314
2247
  */
@@ -2329,7 +2262,6 @@ export class EntityHitEntityAfterEvent {
2329
2262
  }
2330
2263
 
2331
2264
  /**
2332
- * @beta
2333
2265
  * Manages callbacks that are connected to when an entity makes
2334
2266
  * a melee attack on another entity.
2335
2267
  */
@@ -2360,7 +2292,6 @@ export class EntityHitEntityAfterEventSignal {
2360
2292
  }
2361
2293
 
2362
2294
  /**
2363
- * @beta
2364
2295
  * Contains information related to an entity getting hurt.
2365
2296
  */
2366
2297
  export class EntityHurtAfterEvent {
@@ -2387,7 +2318,6 @@ export class EntityHurtAfterEvent {
2387
2318
  }
2388
2319
 
2389
2320
  /**
2390
- * @beta
2391
2321
  * Manages callbacks that are connected to when an entity is
2392
2322
  * hurt.
2393
2323
  */
@@ -2416,7 +2346,6 @@ export class EntityHurtAfterEventSignal {
2416
2346
  }
2417
2347
 
2418
2348
  /**
2419
- * @beta
2420
2349
  * Defines this entity's inventory properties.
2421
2350
  */
2422
2351
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2478,7 +2407,6 @@ export class EntityInventoryComponent extends EntityComponent {
2478
2407
  }
2479
2408
 
2480
2409
  /**
2481
- * @beta
2482
2410
  * When added, this component signifies that this entity is a
2483
2411
  * baby.
2484
2412
  */
@@ -2489,7 +2417,6 @@ export class EntityIsBabyComponent extends EntityComponent {
2489
2417
  }
2490
2418
 
2491
2419
  /**
2492
- * @beta
2493
2420
  * When added, this component signifies that this entity is
2494
2421
  * charged.
2495
2422
  */
@@ -2500,7 +2427,6 @@ export class EntityIsChargedComponent extends EntityComponent {
2500
2427
  }
2501
2428
 
2502
2429
  /**
2503
- * @beta
2504
2430
  * When added, this component signifies that this entity is
2505
2431
  * currently carrying a chest.
2506
2432
  */
@@ -2511,7 +2437,6 @@ export class EntityIsChestedComponent extends EntityComponent {
2511
2437
  }
2512
2438
 
2513
2439
  /**
2514
- * @beta
2515
2440
  * When added, this component signifies that dyes can be used
2516
2441
  * on this entity to change its color.
2517
2442
  */
@@ -2522,7 +2447,6 @@ export class EntityIsDyeableComponent extends EntityComponent {
2522
2447
  }
2523
2448
 
2524
2449
  /**
2525
- * @beta
2526
2450
  * When added, this component signifies that this entity can
2527
2451
  * hide from hostile mobs while invisible.
2528
2452
  */
@@ -2533,7 +2457,6 @@ export class EntityIsHiddenWhenInvisibleComponent extends EntityComponent {
2533
2457
  }
2534
2458
 
2535
2459
  /**
2536
- * @beta
2537
2460
  * When added, this component signifies that this entity this
2538
2461
  * currently on fire.
2539
2462
  */
@@ -2544,7 +2467,6 @@ export class EntityIsIgnitedComponent extends EntityComponent {
2544
2467
  }
2545
2468
 
2546
2469
  /**
2547
- * @beta
2548
2470
  * When added, this component signifies that this entity is an
2549
2471
  * illager captain.
2550
2472
  */
@@ -2555,7 +2477,6 @@ export class EntityIsIllagerCaptainComponent extends EntityComponent {
2555
2477
  }
2556
2478
 
2557
2479
  /**
2558
- * @beta
2559
2480
  * When added, this component signifies that this entity is
2560
2481
  * currently saddled.
2561
2482
  */
@@ -2566,7 +2487,6 @@ export class EntityIsSaddledComponent extends EntityComponent {
2566
2487
  }
2567
2488
 
2568
2489
  /**
2569
- * @beta
2570
2490
  * When added, this component signifies that this entity is
2571
2491
  * currently shaking.
2572
2492
  */
@@ -2577,7 +2497,6 @@ export class EntityIsShakingComponent extends EntityComponent {
2577
2497
  }
2578
2498
 
2579
2499
  /**
2580
- * @beta
2581
2500
  * When added, this component signifies that this entity is
2582
2501
  * currently sheared.
2583
2502
  */
@@ -2588,7 +2507,6 @@ export class EntityIsShearedComponent extends EntityComponent {
2588
2507
  }
2589
2508
 
2590
2509
  /**
2591
- * @beta
2592
2510
  * When added, this component signifies that this entity can be
2593
2511
  * stacked.
2594
2512
  */
@@ -2599,7 +2517,6 @@ export class EntityIsStackableComponent extends EntityComponent {
2599
2517
  }
2600
2518
 
2601
2519
  /**
2602
- * @beta
2603
2520
  * When added, this component signifies that this entity is
2604
2521
  * currently stunned.
2605
2522
  */
@@ -2610,7 +2527,6 @@ export class EntityIsStunnedComponent extends EntityComponent {
2610
2527
  }
2611
2528
 
2612
2529
  /**
2613
- * @beta
2614
2530
  * When added, this component signifies that this entity is
2615
2531
  * currently tamed.
2616
2532
  */
@@ -2621,7 +2537,6 @@ export class EntityIsTamedComponent extends EntityComponent {
2621
2537
  }
2622
2538
 
2623
2539
  /**
2624
- * @beta
2625
2540
  * If added onto the entity, this indicates that the entity
2626
2541
  * represents a free-floating item in the world. Lets you
2627
2542
  * retrieve the actual item stack contents via the itemStack
@@ -2641,7 +2556,6 @@ export class EntityItemComponent extends EntityComponent {
2641
2556
  }
2642
2557
 
2643
2558
  /**
2644
- * @beta
2645
2559
  * Additional variant value. Can be used to further
2646
2560
  * differentiate variants.
2647
2561
  */
@@ -2660,7 +2574,6 @@ export class EntityMarkVariantComponent extends EntityComponent {
2660
2574
  }
2661
2575
 
2662
2576
  /**
2663
- * @beta
2664
2577
  * When added, this movement control allows the mob to swim in
2665
2578
  * water and walk on land.
2666
2579
  */
@@ -2671,7 +2584,6 @@ export class EntityMovementAmphibiousComponent extends EntityBaseMovementCompone
2671
2584
  }
2672
2585
 
2673
2586
  /**
2674
- * @beta
2675
2587
  * This component accents the movement of an entity.
2676
2588
  */
2677
2589
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2681,7 +2593,6 @@ export class EntityMovementBasicComponent extends EntityBaseMovementComponent {
2681
2593
  }
2682
2594
 
2683
2595
  /**
2684
- * @beta
2685
2596
  * When added, this move control causes the mob to fly.
2686
2597
  */
2687
2598
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2691,7 +2602,6 @@ export class EntityMovementFlyComponent extends EntityBaseMovementComponent {
2691
2602
  }
2692
2603
 
2693
2604
  /**
2694
- * @beta
2695
2605
  * When added, this move control allows a mob to fly, swim,
2696
2606
  * climb, etc.
2697
2607
  */
@@ -2702,7 +2612,6 @@ export class EntityMovementGenericComponent extends EntityBaseMovementComponent
2702
2612
  }
2703
2613
 
2704
2614
  /**
2705
- * @beta
2706
2615
  * When added, this move control causes the mob to hover.
2707
2616
  */
2708
2617
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2712,7 +2621,6 @@ export class EntityMovementHoverComponent extends EntityBaseMovementComponent {
2712
2621
  }
2713
2622
 
2714
2623
  /**
2715
- * @beta
2716
2624
  * Move control that causes the mob to jump as it moves with a
2717
2625
  * specified delay between jumps.
2718
2626
  */
@@ -2723,7 +2631,6 @@ export class EntityMovementJumpComponent extends EntityBaseMovementComponent {
2723
2631
  }
2724
2632
 
2725
2633
  /**
2726
- * @beta
2727
2634
  * When added, this move control causes the mob to hop as it
2728
2635
  * moves.
2729
2636
  */
@@ -2734,7 +2641,6 @@ export class EntityMovementSkipComponent extends EntityBaseMovementComponent {
2734
2641
  }
2735
2642
 
2736
2643
  /**
2737
- * @beta
2738
2644
  * Sets the distance through which the entity can push through.
2739
2645
  */
2740
2646
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2752,7 +2658,6 @@ export class EntityPushThroughComponent extends EntityComponent {
2752
2658
  }
2753
2659
 
2754
2660
  /**
2755
- * @beta
2756
2661
  * Sets the entity's visual size.
2757
2662
  */
2758
2663
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -2770,7 +2675,6 @@ export class EntityScaleComponent extends EntityComponent {
2770
2675
  }
2771
2676
 
2772
2677
  /**
2773
- * @beta
2774
2678
  * Skin Id value. Can be used to differentiate skins, such as
2775
2679
  * base skins for villagers.
2776
2680
  */
@@ -2789,7 +2693,6 @@ export class EntitySkinIdComponent extends EntityComponent {
2789
2693
  }
2790
2694
 
2791
2695
  /**
2792
- * @beta
2793
2696
  * Used to differentiate the component group of a variant of an
2794
2697
  * entity from others. (e.g. ocelot, villager).
2795
2698
  */
@@ -2808,7 +2711,6 @@ export class EntityVariantComponent extends EntityComponent {
2808
2711
  }
2809
2712
 
2810
2713
  /**
2811
- * @beta
2812
2714
  * When added, this component signifies that this entity wants
2813
2715
  * to become a jockey.
2814
2716
  */
@@ -2819,7 +2721,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
2819
2721
  }
2820
2722
 
2821
2723
  /**
2822
- * @beta
2823
2724
  * As part of the Healable component, represents a specific
2824
2725
  * item that can be fed to an entity to cause health effects.
2825
2726
  */
@@ -2851,7 +2752,6 @@ export class FeedItem {
2851
2752
  }
2852
2753
 
2853
2754
  /**
2854
- * @beta
2855
2755
  * Represents an effect that is applied as a result of a food
2856
2756
  * item being fed to an entity.
2857
2757
  */
@@ -2888,7 +2788,6 @@ export class FeedItemEffect {
2888
2788
  }
2889
2789
 
2890
2790
  /**
2891
- * @beta
2892
2791
  * Provides an adaptable interface for callers to subscribe to
2893
2792
  * an event that fires when a button is pushed.
2894
2793
  */
@@ -2910,7 +2809,6 @@ export class IButtonPushAfterEventSignal {
2910
2809
  }
2911
2810
 
2912
2811
  /**
2913
- * @beta
2914
2812
  * Provides an adaptable interface for callers to subscribe to
2915
2813
  * an event that fires after a lever is used.
2916
2814
  */
@@ -2932,7 +2830,6 @@ export class ILeverActionAfterEventSignal {
2932
2830
  }
2933
2831
 
2934
2832
  /**
2935
- * @beta
2936
2833
  * Provides an adaptable interface for callers to subscribe to
2937
2834
  * an event that fires after a player joins a world.
2938
2835
  */
@@ -2954,7 +2851,6 @@ export class IPlayerJoinAfterEventSignal {
2954
2851
  }
2955
2852
 
2956
2853
  /**
2957
- * @beta
2958
2854
  * Provides an adaptable interface for callers to subscribe to
2959
2855
  * an event that fires after a player leaves a world.
2960
2856
  */
@@ -2976,7 +2872,6 @@ export class IPlayerLeaveAfterEventSignal {
2976
2872
  }
2977
2873
 
2978
2874
  /**
2979
- * @beta
2980
2875
  * Provides an adaptable interface for callers to subscribe to
2981
2876
  * an event that fires after a player spawns.
2982
2877
  */
@@ -2998,7 +2893,6 @@ export class IPlayerSpawnAfterEventSignal {
2998
2893
  }
2999
2894
 
3000
2895
  /**
3001
- * @beta
3002
2896
  * Contains information related to a chargeable item completing
3003
2897
  * being charged.
3004
2898
  */
@@ -3026,7 +2920,6 @@ export class ItemCompleteUseAfterEvent {
3026
2920
  }
3027
2921
 
3028
2922
  /**
3029
- * @beta
3030
2923
  * Manages callbacks that are connected to the completion of
3031
2924
  * charging for a chargeable item.
3032
2925
  */
@@ -3054,7 +2947,6 @@ export class ItemCompleteUseAfterEventSignal {
3054
2947
  }
3055
2948
 
3056
2949
  /**
3057
- * @beta
3058
2950
  * Base class for item components.
3059
2951
  */
3060
2952
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -3063,7 +2955,6 @@ export class ItemComponent extends Component {
3063
2955
  }
3064
2956
 
3065
2957
  /**
3066
- * @beta
3067
2958
  * Contains information related to a chargeable item when the
3068
2959
  * player has finished using the item and released the build
3069
2960
  * action.
@@ -3092,7 +2983,6 @@ export class ItemReleaseUseAfterEvent {
3092
2983
  }
3093
2984
 
3094
2985
  /**
3095
- * @beta
3096
2986
  * Manages callbacks that are connected to the releasing of
3097
2987
  * charging for a chargeable item.
3098
2988
  */
@@ -3120,7 +3010,6 @@ export class ItemReleaseUseAfterEventSignal {
3120
3010
  }
3121
3011
 
3122
3012
  /**
3123
- * @beta
3124
3013
  * Defines a collection of items.
3125
3014
  */
3126
3015
  export class ItemStack {
@@ -3200,7 +3089,6 @@ export class ItemStack {
3200
3089
  */
3201
3090
  getComponents(): ItemComponent[];
3202
3091
  /**
3203
- * @beta
3204
3092
  * @remarks
3205
3093
  * Returns the lore value - a secondary display string - for an
3206
3094
  * ItemStack.
@@ -3237,7 +3125,6 @@ export class ItemStack {
3237
3125
  */
3238
3126
  isStackableWith(itemStack: ItemStack): boolean;
3239
3127
  /**
3240
- * @beta
3241
3128
  * @remarks
3242
3129
  * Sets the lore value - a secondary display string - for an
3243
3130
  * ItemStack. The lore list is cleared if set to an empty
@@ -3280,7 +3167,6 @@ export class ItemStack {
3280
3167
  }
3281
3168
 
3282
3169
  /**
3283
- * @beta
3284
3170
  * Contains information related to a chargeable item starting
3285
3171
  * to be charged.
3286
3172
  */
@@ -3308,7 +3194,6 @@ export class ItemStartUseAfterEvent {
3308
3194
  }
3309
3195
 
3310
3196
  /**
3311
- * @beta
3312
3197
  * Manages callbacks that are connected to the start of
3313
3198
  * charging for a chargeable item.
3314
3199
  */
@@ -3336,7 +3221,6 @@ export class ItemStartUseAfterEventSignal {
3336
3221
  }
3337
3222
 
3338
3223
  /**
3339
- * @beta
3340
3224
  * Contains information related to an item being used on a
3341
3225
  * block. This event fires when a player presses the the Use
3342
3226
  * Item / Place Block button to successfully use an item or
@@ -3373,7 +3257,6 @@ export class ItemStartUseOnAfterEvent {
3373
3257
  }
3374
3258
 
3375
3259
  /**
3376
- * @beta
3377
3260
  * Manages callbacks that are connected to an item starting
3378
3261
  * being used on a block event.
3379
3262
  */
@@ -3401,7 +3284,6 @@ export class ItemStartUseOnAfterEventSignal {
3401
3284
  }
3402
3285
 
3403
3286
  /**
3404
- * @beta
3405
3287
  * Contains information related to a chargeable item has
3406
3288
  * finished an items use cycle, or when the player has released
3407
3289
  * the use action with the item.
@@ -3430,7 +3312,6 @@ export class ItemStopUseAfterEvent {
3430
3312
  }
3431
3313
 
3432
3314
  /**
3433
- * @beta
3434
3315
  * Manages callbacks that are connected to the stopping of
3435
3316
  * charging for an item that has a registered
3436
3317
  * minecraft:chargeable component.
@@ -3459,7 +3340,6 @@ export class ItemStopUseAfterEventSignal {
3459
3340
  }
3460
3341
 
3461
3342
  /**
3462
- * @beta
3463
3343
  * Contains information related to an item that has stopped
3464
3344
  * being used on a block. This event fires when a player
3465
3345
  * successfully uses an item or places a block by pressing the
@@ -3491,7 +3371,6 @@ export class ItemStopUseOnAfterEvent {
3491
3371
  }
3492
3372
 
3493
3373
  /**
3494
- * @beta
3495
3374
  * Manages callbacks that are connected to an item stops used
3496
3375
  * on a block event.
3497
3376
  */
@@ -3519,7 +3398,6 @@ export class ItemStopUseOnAfterEventSignal {
3519
3398
  }
3520
3399
 
3521
3400
  /**
3522
- * @beta
3523
3401
  * Represents the type of an item - for example, Wool.
3524
3402
  */
3525
3403
  export class ItemType {
@@ -3534,7 +3412,6 @@ export class ItemType {
3534
3412
  }
3535
3413
 
3536
3414
  /**
3537
- * @beta
3538
3415
  * Contains information related to an item being used. This
3539
3416
  * event fires when an item is successfully used by a player.
3540
3417
  */
@@ -3555,7 +3432,6 @@ export class ItemUseAfterEvent {
3555
3432
  }
3556
3433
 
3557
3434
  /**
3558
- * @beta
3559
3435
  * Manages callbacks that are connected to an item use event.
3560
3436
  */
3561
3437
  export class ItemUseAfterEventSignal {
@@ -3580,7 +3456,6 @@ export class ItemUseAfterEventSignal {
3580
3456
  }
3581
3457
 
3582
3458
  /**
3583
- * @beta
3584
3459
  * Contains information related to an item being used.
3585
3460
  */
3586
3461
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -3595,7 +3470,6 @@ export class ItemUseBeforeEvent extends ItemUseAfterEvent {
3595
3470
  }
3596
3471
 
3597
3472
  /**
3598
- * @beta
3599
3473
  * Manages callbacks that fire before an item is used.
3600
3474
  */
3601
3475
  export class ItemUseBeforeEventSignal {
@@ -3620,7 +3494,6 @@ export class ItemUseBeforeEventSignal {
3620
3494
  }
3621
3495
 
3622
3496
  /**
3623
- * @beta
3624
3497
  * Contains information related to an item being used on a
3625
3498
  * block. This event fires when an item is successfully used on
3626
3499
  * a block by a player.
@@ -3661,7 +3534,6 @@ export class ItemUseOnAfterEvent {
3661
3534
  }
3662
3535
 
3663
3536
  /**
3664
- * @beta
3665
3537
  * Manages callbacks that are connected to an item being used
3666
3538
  * on a block event.
3667
3539
  */
@@ -3689,7 +3561,6 @@ export class ItemUseOnAfterEventSignal {
3689
3561
  }
3690
3562
 
3691
3563
  /**
3692
- * @beta
3693
3564
  * Contains information related to an item being used on a
3694
3565
  * block.
3695
3566
  */
@@ -3705,7 +3576,6 @@ export class ItemUseOnBeforeEvent extends ItemUseOnAfterEvent {
3705
3576
  }
3706
3577
 
3707
3578
  /**
3708
- * @beta
3709
3579
  * Manages callbacks that fire before an item being used on a
3710
3580
  * block event.
3711
3581
  */
@@ -3733,7 +3603,6 @@ export class ItemUseOnBeforeEventSignal {
3733
3603
  }
3734
3604
 
3735
3605
  /**
3736
- * @beta
3737
3606
  * Contains information related to changes to a lever
3738
3607
  * activating or deactivating.
3739
3608
  */
@@ -3756,7 +3625,6 @@ export class LeverActionAfterEvent extends BlockEvent {
3756
3625
  }
3757
3626
 
3758
3627
  /**
3759
- * @beta
3760
3628
  * Manages callbacks that are connected to lever moves
3761
3629
  * (activates or deactivates).
3762
3630
  */
@@ -3808,7 +3676,6 @@ export class MinecraftDimensionTypes {
3808
3676
  }
3809
3677
 
3810
3678
  /**
3811
- * @beta
3812
3679
  * Contains a set of additional variable values for further
3813
3680
  * defining how rendering and animations function.
3814
3681
  */
@@ -3835,6 +3702,17 @@ export class MolangVariableMap {
3835
3702
  * @throws This function can throw errors.
3836
3703
  */
3837
3704
  setColorRGBA(variableName: string, color: RGBA): void;
3705
+ /**
3706
+ * @remarks
3707
+ * Sets a numeric (decimal) value within the Molang variable
3708
+ * map.
3709
+ *
3710
+ * @param variableName
3711
+ * Name of the float-based number to set.
3712
+ * @param number
3713
+ * Value for the Molang-based variable to set.
3714
+ * @throws This function can throw errors.
3715
+ */
3838
3716
  setFloat(variableName: string, number: number): void;
3839
3717
  /**
3840
3718
  * @remarks
@@ -3879,7 +3757,6 @@ export class Player extends Entity {
3879
3757
  */
3880
3758
  readonly name: string;
3881
3759
  /**
3882
- * @beta
3883
3760
  * @remarks
3884
3761
  * Contains methods for manipulating the on-screen display of a
3885
3762
  * Player.
@@ -3888,7 +3765,6 @@ export class Player extends Entity {
3888
3765
  */
3889
3766
  readonly onScreenDisplay: ScreenDisplay;
3890
3767
  /**
3891
- * @beta
3892
3768
  * @remarks
3893
3769
  * Gets the current spawn point of the player.
3894
3770
  *
@@ -3896,12 +3772,13 @@ export class Player extends Entity {
3896
3772
  */
3897
3773
  getSpawnPoint(): DimensionLocation | undefined;
3898
3774
  /**
3899
- * @beta
3900
3775
  * @remarks
3901
3776
  * Plays a sound that only this particular player can hear.
3902
3777
  *
3903
3778
  * This function can't be called in read-only mode.
3904
3779
  *
3780
+ * @param soundID
3781
+ * Identifier of the sound to play.
3905
3782
  * @param soundOptions
3906
3783
  * Additional optional options for the sound.
3907
3784
  * @throws This function can throw errors.
@@ -3930,9 +3807,8 @@ export class Player extends Entity {
3930
3807
  * players[0].playSound("bucket.fill_water", playerSoundOptions);
3931
3808
  * ```
3932
3809
  */
3933
- playSound(soundId: string, soundOptions?: PlayerSoundOptions): void;
3810
+ playSound(soundID: string, soundOptions?: PlayerSoundOptions): void;
3934
3811
  /**
3935
- * @beta
3936
3812
  * @remarks
3937
3813
  * Sends a message to the player.
3938
3814
  *
@@ -3983,7 +3859,6 @@ export class Player extends Entity {
3983
3859
  */
3984
3860
  sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
3985
3861
  /**
3986
- * @beta
3987
3862
  * @remarks
3988
3863
  * Sets the current starting spawn point for this particular
3989
3864
  * player.
@@ -3991,12 +3866,15 @@ export class Player extends Entity {
3991
3866
  * This function can't be called in read-only mode.
3992
3867
  *
3993
3868
  * @throws This function can throw errors.
3869
+ *
3870
+ * {@link Error}
3871
+ *
3872
+ * {@link LocationOutOfWorldBoundariesError}
3994
3873
  */
3995
3874
  setSpawnPoint(spawnPoint?: DimensionLocation): void;
3996
3875
  }
3997
3876
 
3998
3877
  /**
3999
- * @beta
4000
3878
  * Contains information regarding a player that has joined.
4001
3879
  * See the playerSpawn event for more detailed information that
4002
3880
  * could be returned after the first time a player has spawned
@@ -4019,7 +3897,6 @@ export class PlayerJoinAfterEvent {
4019
3897
  }
4020
3898
 
4021
3899
  /**
4022
- * @beta
4023
3900
  * Manages callbacks that are connected to a player joining the
4024
3901
  * world.
4025
3902
  */
@@ -4029,7 +3906,6 @@ export class PlayerJoinAfterEventSignal extends IPlayerJoinAfterEventSignal {
4029
3906
  }
4030
3907
 
4031
3908
  /**
4032
- * @beta
4033
3909
  * Contains information regarding a player that has left the
4034
3910
  * world.
4035
3911
  */
@@ -4051,7 +3927,6 @@ export class PlayerLeaveAfterEvent {
4051
3927
  }
4052
3928
 
4053
3929
  /**
4054
- * @beta
4055
3930
  * Manages callbacks that are connected to a player leaving the
4056
3931
  * world.
4057
3932
  */
@@ -4061,7 +3936,6 @@ export class PlayerLeaveAfterEventSignal extends IPlayerLeaveAfterEventSignal {
4061
3936
  }
4062
3937
 
4063
3938
  /**
4064
- * @beta
4065
3939
  * An event that contains more information about a player
4066
3940
  * spawning.
4067
3941
  */
@@ -4087,7 +3961,6 @@ export class PlayerSpawnAfterEvent {
4087
3961
  }
4088
3962
 
4089
3963
  /**
4090
- * @beta
4091
3964
  * Registers an event when a player is spawned (or re-spawned
4092
3965
  * after death) and fully ready within the world.
4093
3966
  */
@@ -4097,7 +3970,6 @@ export class PlayerSpawnAfterEventSignal extends IPlayerSpawnAfterEventSignal {
4097
3970
  }
4098
3971
 
4099
3972
  /**
4100
- * @beta
4101
3973
  * Contains information related to changes to a pressure plate
4102
3974
  * pop.
4103
3975
  */
@@ -4121,7 +3993,6 @@ export class PressurePlatePopAfterEvent extends BlockEvent {
4121
3993
  }
4122
3994
 
4123
3995
  /**
4124
- * @beta
4125
3996
  * Manages callbacks that are connected to when a pressure
4126
3997
  * plate is popped.
4127
3998
  */
@@ -4149,7 +4020,6 @@ export class PressurePlatePopAfterEventSignal {
4149
4020
  }
4150
4021
 
4151
4022
  /**
4152
- * @beta
4153
4023
  * Contains information related to changes to a pressure plate
4154
4024
  * push.
4155
4025
  */
@@ -4179,7 +4049,6 @@ export class PressurePlatePushAfterEvent extends BlockEvent {
4179
4049
  }
4180
4050
 
4181
4051
  /**
4182
- * @beta
4183
4052
  * Manages callbacks that are connected to when a pressure
4184
4053
  * plate is pushed.
4185
4054
  */
@@ -4207,7 +4076,6 @@ export class PressurePlatePushAfterEventSignal {
4207
4076
  }
4208
4077
 
4209
4078
  /**
4210
- * @beta
4211
4079
  * Contains information related to a projectile hitting a
4212
4080
  * block.
4213
4081
  */
@@ -4255,7 +4123,6 @@ export class ProjectileHitBlockAfterEvent {
4255
4123
  }
4256
4124
 
4257
4125
  /**
4258
- * @beta
4259
4126
  * Manages callbacks that are connected to when a projectile
4260
4127
  * hits a block.
4261
4128
  */
@@ -4283,7 +4150,6 @@ export class ProjectileHitBlockAfterEventSignal {
4283
4150
  }
4284
4151
 
4285
4152
  /**
4286
- * @beta
4287
4153
  * Contains information related to a projectile hitting an
4288
4154
  * entity.
4289
4155
  */
@@ -4331,7 +4197,6 @@ export class ProjectileHitEntityAfterEvent {
4331
4197
  }
4332
4198
 
4333
4199
  /**
4334
- * @beta
4335
4200
  * Manages callbacks that are connected to when a projectile
4336
4201
  * hits an entity.
4337
4202
  */
@@ -4359,7 +4224,6 @@ export class ProjectileHitEntityAfterEventSignal {
4359
4224
  }
4360
4225
 
4361
4226
  /**
4362
- * @beta
4363
4227
  * Contains objectives and participants for the scoreboard.
4364
4228
  */
4365
4229
  export class Scoreboard {
@@ -4437,7 +4301,6 @@ export class Scoreboard {
4437
4301
  }
4438
4302
 
4439
4303
  /**
4440
- * @beta
4441
4304
  * Contains an identity of the scoreboard item.
4442
4305
  */
4443
4306
  export class ScoreboardIdentity {
@@ -4468,11 +4331,16 @@ export class ScoreboardIdentity {
4468
4331
  * @throws This function can throw errors.
4469
4332
  */
4470
4333
  getEntity(): Entity | undefined;
4334
+ /**
4335
+ * @remarks
4336
+ * Returns true if the ScoreboardIdentity reference is still
4337
+ * valid.
4338
+ *
4339
+ */
4471
4340
  isValid(): boolean;
4472
4341
  }
4473
4342
 
4474
4343
  /**
4475
- * @beta
4476
4344
  * Contains objectives and participants for the scoreboard.
4477
4345
  */
4478
4346
  export class ScoreboardObjective {
@@ -4535,6 +4403,12 @@ export class ScoreboardObjective {
4535
4403
  * @throws This function can throw errors.
4536
4404
  */
4537
4405
  hasParticipant(participant: Entity | ScoreboardIdentity | string): boolean;
4406
+ /**
4407
+ * @remarks
4408
+ * Returns true if the ScoreboardObjective reference is still
4409
+ * valid.
4410
+ *
4411
+ */
4538
4412
  isValid(): boolean;
4539
4413
  /**
4540
4414
  * @remarks
@@ -4564,7 +4438,6 @@ export class ScoreboardObjective {
4564
4438
  }
4565
4439
 
4566
4440
  /**
4567
- * @beta
4568
4441
  * Contains a pair of a scoreboard participant and its
4569
4442
  * respective score.
4570
4443
  */
@@ -4585,7 +4458,6 @@ export class ScoreboardScoreInfo {
4585
4458
  }
4586
4459
 
4587
4460
  /**
4588
- * @beta
4589
4461
  * Contains information about user interface elements that are
4590
4462
  * showing up on the screen.
4591
4463
  */
@@ -4674,7 +4546,6 @@ export class ScreenDisplay {
4674
4546
  }
4675
4547
 
4676
4548
  /**
4677
- * @beta
4678
4549
  * Returns additional data about a /scriptevent command
4679
4550
  * invocation.
4680
4551
  */
@@ -4723,7 +4594,6 @@ export class ScriptEventCommandMessageAfterEvent {
4723
4594
  }
4724
4595
 
4725
4596
  /**
4726
- * @beta
4727
4597
  * Allows for registering an event handler that responds to
4728
4598
  * inbound /scriptevent commands.
4729
4599
  */
@@ -4757,7 +4627,6 @@ export class ScriptEventCommandMessageAfterEventSignal {
4757
4627
  export class System {
4758
4628
  private constructor();
4759
4629
  /**
4760
- * @beta
4761
4630
  * @remarks
4762
4631
  * Returns a collection of after-events for system-level
4763
4632
  * operations.
@@ -4765,14 +4634,12 @@ export class System {
4765
4634
  */
4766
4635
  readonly afterEvents: SystemAfterEvents;
4767
4636
  /**
4768
- * @beta
4769
4637
  * @remarks
4770
4638
  * Represents the current world tick of the server.
4771
4639
  *
4772
4640
  */
4773
4641
  readonly currentTick: number;
4774
4642
  /**
4775
- * @beta
4776
4643
  * @remarks
4777
4644
  * Cancels the execution of a function run that was previously
4778
4645
  * scheduled via the `run` function.
@@ -4809,7 +4676,6 @@ export class System {
4809
4676
  */
4810
4677
  run(callback: () => void): number;
4811
4678
  /**
4812
- * @beta
4813
4679
  * @remarks
4814
4680
  * Runs a set of code on an interval.
4815
4681
  *
@@ -4832,7 +4698,6 @@ export class System {
4832
4698
  */
4833
4699
  runInterval(callback: () => void, tickInterval?: number): number;
4834
4700
  /**
4835
- * @beta
4836
4701
  * @remarks
4837
4702
  * Runs a set of code at a future time specified by tickDelay.
4838
4703
  *
@@ -4849,7 +4714,6 @@ export class System {
4849
4714
  }
4850
4715
 
4851
4716
  /**
4852
- * @beta
4853
4717
  * Provides a set of events that fire within the broader
4854
4718
  * scripting system within Minecraft.
4855
4719
  */
@@ -4866,7 +4730,6 @@ export class SystemAfterEvents {
4866
4730
  }
4867
4731
 
4868
4732
  /**
4869
- * @beta
4870
4733
  * Contains information related to changes to a target block
4871
4734
  * hit.
4872
4735
  */
@@ -4900,7 +4763,6 @@ export class TargetBlockHitAfterEvent extends BlockEvent {
4900
4763
  }
4901
4764
 
4902
4765
  /**
4903
- * @beta
4904
4766
  * Manages callbacks that are connected to when a target block
4905
4767
  * is hit.
4906
4768
  */
@@ -4928,7 +4790,6 @@ export class TargetBlockHitAfterEventSignal {
4928
4790
  }
4929
4791
 
4930
4792
  /**
4931
- * @beta
4932
4793
  * Contains information related to changes to a trip wire trip.
4933
4794
  */
4934
4795
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -4949,7 +4810,6 @@ export class TripWireTripAfterEvent extends BlockEvent {
4949
4810
  }
4950
4811
 
4951
4812
  /**
4952
- * @beta
4953
4813
  * Manages callbacks that are connected to when a trip wire is
4954
4814
  * tripped.
4955
4815
  */
@@ -4983,7 +4843,6 @@ export class TripWireTripAfterEventSignal {
4983
4843
  export class World {
4984
4844
  private constructor();
4985
4845
  /**
4986
- * @beta
4987
4846
  * @remarks
4988
4847
  * Contains a set of events that are applicable to the entirety
4989
4848
  * of the world. Event callbacks are called in a deferred
@@ -4992,7 +4851,6 @@ export class World {
4992
4851
  */
4993
4852
  readonly afterEvents: WorldAfterEvents;
4994
4853
  /**
4995
- * @beta
4996
4854
  * @remarks
4997
4855
  * Contains a set of events that are applicable to the entirety
4998
4856
  * of the world. Event callbacks are called immediately. Event
@@ -5001,7 +4859,6 @@ export class World {
5001
4859
  */
5002
4860
  readonly beforeEvents: WorldBeforeEvents;
5003
4861
  /**
5004
- * @beta
5005
4862
  * @remarks
5006
4863
  * Returns the general global scoreboard that applies to the
5007
4864
  * world.
@@ -5009,7 +4866,6 @@ export class World {
5009
4866
  */
5010
4867
  readonly scoreboard: Scoreboard;
5011
4868
  /**
5012
- * @beta
5013
4869
  * @remarks
5014
4870
  * Returns the absolute time since the start of the world.
5015
4871
  *
@@ -5023,7 +4879,6 @@ export class World {
5023
4879
  */
5024
4880
  getAllPlayers(): Player[];
5025
4881
  /**
5026
- * @beta
5027
4882
  * @remarks
5028
4883
  * Returns the current day.
5029
4884
  *
@@ -5033,7 +4888,6 @@ export class World {
5033
4888
  */
5034
4889
  getDay(): number;
5035
4890
  /**
5036
- * @beta
5037
4891
  * @remarks
5038
4892
  * Returns the default Overworld spawn location.
5039
4893
  *
@@ -5057,7 +4911,6 @@ export class World {
5057
4911
  */
5058
4912
  getDimension(dimensionId: string): Dimension;
5059
4913
  /**
5060
- * @beta
5061
4914
  * @remarks
5062
4915
  * Returns a set of players based on a set of conditions
5063
4916
  * defined via the EntityQueryOptions set of filter criteria.
@@ -5072,7 +4925,6 @@ export class World {
5072
4925
  */
5073
4926
  getPlayers(options?: EntityQueryOptions): Player[];
5074
4927
  /**
5075
- * @beta
5076
4928
  * @remarks
5077
4929
  * Returns the time of day.
5078
4930
  *
@@ -5081,7 +4933,6 @@ export class World {
5081
4933
  */
5082
4934
  getTimeOfDay(): number;
5083
4935
  /**
5084
- * @beta
5085
4936
  * @remarks
5086
4937
  * Plays a particular music track for all players.
5087
4938
  *
@@ -5113,9 +4964,8 @@ export class World {
5113
4964
  * players[0].playSound("bucket.fill_water", playerSoundOptions);
5114
4965
  * ```
5115
4966
  */
5116
- playMusic(trackId: string, musicOptions?: MusicOptions): void;
4967
+ playMusic(trackID: string, musicOptions?: MusicOptions): void;
5117
4968
  /**
5118
- * @beta
5119
4969
  * @remarks
5120
4970
  * Plays a sound for all players.
5121
4971
  *
@@ -5151,23 +5001,23 @@ export class World {
5151
5001
  * players[0].playSound("bucket.fill_water", playerSoundOptions);
5152
5002
  * ```
5153
5003
  */
5154
- playSound(soundId: string, location: Vector3, soundOptions?: WorldSoundOptions): void;
5004
+ playSound(soundID: string, location: Vector3, soundOptions?: WorldSoundOptions): void;
5155
5005
  /**
5156
- * @beta
5157
5006
  * @remarks
5158
5007
  * Queues an additional music track for players. If a track is
5159
5008
  * not playing, a music track will play.
5160
5009
  *
5161
5010
  * This function can't be called in read-only mode.
5162
5011
  *
5012
+ * @param musicOptions
5013
+ * Additional options for the music track.
5163
5014
  * @throws
5164
5015
  * An error will be thrown if volume is less than 0.0.
5165
5016
  * An error will be thrown if fade is less than 0.0.
5166
5017
  *
5167
5018
  */
5168
- queueMusic(trackId: string, musicOptions?: MusicOptions): void;
5019
+ queueMusic(trackID: string, musicOptions?: MusicOptions): void;
5169
5020
  /**
5170
- * @beta
5171
5021
  * @remarks
5172
5022
  * Sends a message to all players.
5173
5023
  *
@@ -5206,7 +5056,6 @@ export class World {
5206
5056
  */
5207
5057
  sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
5208
5058
  /**
5209
- * @beta
5210
5059
  * @remarks
5211
5060
  * Sets the world time.
5212
5061
  *
@@ -5217,7 +5066,6 @@ export class World {
5217
5066
  */
5218
5067
  setAbsoluteTime(absoluteTime: number): void;
5219
5068
  /**
5220
- * @beta
5221
5069
  * @remarks
5222
5070
  * Sets a default spawn location for all players.
5223
5071
  *
@@ -5228,10 +5076,13 @@ export class World {
5228
5076
  * within the overworld dimension.
5229
5077
  * @throws
5230
5078
  * Throws if the provided spawn location is out of bounds.
5079
+ *
5080
+ * {@link Error}
5081
+ *
5082
+ * {@link LocationOutOfWorldBoundariesError}
5231
5083
  */
5232
5084
  setDefaultSpawnLocation(spawnLocation: Vector3): void;
5233
5085
  /**
5234
- * @beta
5235
5086
  * @remarks
5236
5087
  * Sets the time of day.
5237
5088
  *
@@ -5245,7 +5096,6 @@ export class World {
5245
5096
  */
5246
5097
  setTimeOfDay(timeOfDay: number | TimeOfDay): void;
5247
5098
  /**
5248
- * @beta
5249
5099
  * @remarks
5250
5100
  * Stops any music tracks from playing.
5251
5101
  *
@@ -5256,7 +5106,6 @@ export class World {
5256
5106
  }
5257
5107
 
5258
5108
  /**
5259
- * @beta
5260
5109
  * Contains a set of events that are available across the scope
5261
5110
  * of the World.
5262
5111
  */
@@ -5269,21 +5118,18 @@ export class WorldAfterEvents {
5269
5118
  */
5270
5119
  readonly buttonPush: ButtonPushAfterEventSignal;
5271
5120
  /**
5272
- * @beta
5273
5121
  * @remarks
5274
5122
  * This event fires when an entity dies.
5275
5123
  *
5276
5124
  */
5277
5125
  readonly entityDie: EntityDieAfterEventSignal;
5278
5126
  /**
5279
- * @beta
5280
5127
  * @remarks
5281
5128
  * This event fires when entity health changes in any degree.
5282
5129
  *
5283
5130
  */
5284
5131
  readonly entityHealthChanged: EntityHealthChangedAfterEventSignal;
5285
5132
  /**
5286
- * @beta
5287
5133
  * @remarks
5288
5134
  * This event fires when an entity hits (that is, melee
5289
5135
  * attacks) a block.
@@ -5291,7 +5137,6 @@ export class WorldAfterEvents {
5291
5137
  */
5292
5138
  readonly entityHitBlock: EntityHitBlockAfterEventSignal;
5293
5139
  /**
5294
- * @beta
5295
5140
  * @remarks
5296
5141
  * This event fires when an entity hits (that is, melee
5297
5142
  * attacks) another entity.
@@ -5299,21 +5144,18 @@ export class WorldAfterEvents {
5299
5144
  */
5300
5145
  readonly entityHitEntity: EntityHitEntityAfterEventSignal;
5301
5146
  /**
5302
- * @beta
5303
5147
  * @remarks
5304
5148
  * This event fires when an entity is hurt (takes damage).
5305
5149
  *
5306
5150
  */
5307
5151
  readonly entityHurt: EntityHurtAfterEventSignal;
5308
5152
  /**
5309
- * @beta
5310
5153
  * @remarks
5311
5154
  * This event fires when a chargeable item completes charging.
5312
5155
  *
5313
5156
  */
5314
5157
  readonly itemCompleteUse: ItemCompleteUseAfterEventSignal;
5315
5158
  /**
5316
- * @beta
5317
5159
  * @remarks
5318
5160
  * This event fires when a chargeable item is released from
5319
5161
  * charging.
@@ -5321,14 +5163,12 @@ export class WorldAfterEvents {
5321
5163
  */
5322
5164
  readonly itemReleaseUse: ItemReleaseUseAfterEventSignal;
5323
5165
  /**
5324
- * @beta
5325
5166
  * @remarks
5326
5167
  * This event fires when a chargeable item starts charging.
5327
5168
  *
5328
5169
  */
5329
5170
  readonly itemStartUse: ItemStartUseAfterEventSignal;
5330
5171
  /**
5331
- * @beta
5332
5172
  * @remarks
5333
5173
  * This event fires when a player successfully uses an item or
5334
5174
  * places a block by pressing the Use Item / Place Block
@@ -5339,14 +5179,12 @@ export class WorldAfterEvents {
5339
5179
  */
5340
5180
  readonly itemStartUseOn: ItemStartUseOnAfterEventSignal;
5341
5181
  /**
5342
- * @beta
5343
5182
  * @remarks
5344
5183
  * This event fires when a chargeable item stops charging.
5345
5184
  *
5346
5185
  */
5347
5186
  readonly itemStopUse: ItemStopUseAfterEventSignal;
5348
5187
  /**
5349
- * @beta
5350
5188
  * @remarks
5351
5189
  * This event fires when a player releases the Use Item / Place
5352
5190
  * Block button after successfully using an item. Note: This
@@ -5355,7 +5193,6 @@ export class WorldAfterEvents {
5355
5193
  */
5356
5194
  readonly itemStopUseOn: ItemStopUseOnAfterEventSignal;
5357
5195
  /**
5358
- * @beta
5359
5196
  * @remarks
5360
5197
  * This event fires when an item is successfully used by a
5361
5198
  * player.
@@ -5363,7 +5200,6 @@ export class WorldAfterEvents {
5363
5200
  */
5364
5201
  readonly itemUse: ItemUseAfterEventSignal;
5365
5202
  /**
5366
- * @beta
5367
5203
  * @remarks
5368
5204
  * This event fires when an item is used on a block by a
5369
5205
  * player.
@@ -5399,7 +5235,6 @@ export class WorldAfterEvents {
5399
5235
  */
5400
5236
  readonly playerSpawn: PlayerSpawnAfterEventSignal;
5401
5237
  /**
5402
- * @beta
5403
5238
  * @remarks
5404
5239
  * A pressure plate has popped back up (i.e., there are no
5405
5240
  * entities on the pressure plate.)
@@ -5407,7 +5242,6 @@ export class WorldAfterEvents {
5407
5242
  */
5408
5243
  readonly pressurePlatePop: PressurePlatePopAfterEventSignal;
5409
5244
  /**
5410
- * @beta
5411
5245
  * @remarks
5412
5246
  * A pressure plate has pushed (at least one entity has moved
5413
5247
  * onto a pressure plate.)
@@ -5415,28 +5249,24 @@ export class WorldAfterEvents {
5415
5249
  */
5416
5250
  readonly pressurePlatePush: PressurePlatePushAfterEventSignal;
5417
5251
  /**
5418
- * @beta
5419
5252
  * @remarks
5420
5253
  * This event fires when a projectile hits a block.
5421
5254
  *
5422
5255
  */
5423
5256
  readonly projectileHitBlock: ProjectileHitBlockAfterEventSignal;
5424
5257
  /**
5425
- * @beta
5426
5258
  * @remarks
5427
5259
  * This event fires when a projectile hits an entity.
5428
5260
  *
5429
5261
  */
5430
5262
  readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
5431
5263
  /**
5432
- * @beta
5433
5264
  * @remarks
5434
5265
  * A target block was hit.
5435
5266
  *
5436
5267
  */
5437
5268
  readonly targetBlockHit: TargetBlockHitAfterEventSignal;
5438
5269
  /**
5439
- * @beta
5440
5270
  * @remarks
5441
5271
  * A trip wire was tripped.
5442
5272
  *
@@ -5445,7 +5275,6 @@ export class WorldAfterEvents {
5445
5275
  }
5446
5276
 
5447
5277
  /**
5448
- * @beta
5449
5278
  * A set of events that fire before an actual action occurs. In
5450
5279
  * most cases, you can potentially cancel or modify the
5451
5280
  * impending event. Note that in before events any APIs that
@@ -5471,7 +5300,6 @@ export class WorldBeforeEvents {
5471
5300
  }
5472
5301
 
5473
5302
  /**
5474
- * @beta
5475
5303
  * Contains more information for events where a block is hit.
5476
5304
  */
5477
5305
  export interface BlockHitInformation {
@@ -5497,7 +5325,6 @@ export interface BlockHitInformation {
5497
5325
  }
5498
5326
 
5499
5327
  /**
5500
- * @beta
5501
5328
  * Contains information for block raycast hit results.
5502
5329
  */
5503
5330
  export interface BlockRaycastHit {
@@ -5523,7 +5350,6 @@ export interface BlockRaycastHit {
5523
5350
  }
5524
5351
 
5525
5352
  /**
5526
- * @beta
5527
5353
  * Contains additional options for configuring a block raycast
5528
5354
  * query.
5529
5355
  */
@@ -5551,7 +5377,6 @@ export interface BlockRaycastOptions {
5551
5377
  }
5552
5378
 
5553
5379
  /**
5554
- * @beta
5555
5380
  * An exact coordinate within the world, including its
5556
5381
  * dimension and location.
5557
5382
  */
@@ -5583,7 +5408,6 @@ export interface DimensionLocation {
5583
5408
  }
5584
5409
 
5585
5410
  /**
5586
- * @beta
5587
5411
  * Additional options for when damage has been applied via a
5588
5412
  * projectile.
5589
5413
  */
@@ -5603,7 +5427,6 @@ export interface EntityApplyDamageByProjectileOptions {
5603
5427
  }
5604
5428
 
5605
5429
  /**
5606
- * @beta
5607
5430
  * Additional descriptions and metadata for a damage event.
5608
5431
  */
5609
5432
  export interface EntityApplyDamageOptions {
@@ -5622,7 +5445,6 @@ export interface EntityApplyDamageOptions {
5622
5445
  }
5623
5446
 
5624
5447
  /**
5625
- * @beta
5626
5448
  * Provides information about how damage has been applied to an
5627
5449
  * entity.
5628
5450
  */
@@ -5648,7 +5470,6 @@ export interface EntityDamageSource {
5648
5470
  }
5649
5471
 
5650
5472
  /**
5651
- * @beta
5652
5473
  * Contains additional options for entity effects.
5653
5474
  */
5654
5475
  export interface EntityEffectOptions {
@@ -5667,7 +5488,6 @@ export interface EntityEffectOptions {
5667
5488
  }
5668
5489
 
5669
5490
  /**
5670
- * @beta
5671
5491
  * Contains optional parameters for registering an entity
5672
5492
  * event.
5673
5493
  */
@@ -5689,7 +5509,6 @@ export interface EntityEventOptions {
5689
5509
  }
5690
5510
 
5691
5511
  /**
5692
- * @beta
5693
5512
  * Contains additional information about an entity that was
5694
5513
  * hit.
5695
5514
  */
@@ -5703,7 +5522,6 @@ export interface EntityHitInformation {
5703
5522
  }
5704
5523
 
5705
5524
  /**
5706
- * @beta
5707
5525
  * Contains options for selecting entities within an area.
5708
5526
  */
5709
5527
  export interface EntityQueryOptions {
@@ -5866,7 +5684,6 @@ export interface EntityQueryOptions {
5866
5684
  }
5867
5685
 
5868
5686
  /**
5869
- * @beta
5870
5687
  * Contains additional options for filtering players based on
5871
5688
  * their score for an objective.
5872
5689
  */
@@ -5901,7 +5718,6 @@ export interface EntityQueryScoreOptions {
5901
5718
  }
5902
5719
 
5903
5720
  /**
5904
- * @beta
5905
5721
  * Contains information for entity raycast hit results.
5906
5722
  */
5907
5723
  export interface EntityRaycastHit {
@@ -5920,7 +5736,6 @@ export interface EntityRaycastHit {
5920
5736
  }
5921
5737
 
5922
5738
  /**
5923
- * @beta
5924
5739
  * Contains additional options for an entity raycast operation.
5925
5740
  */
5926
5741
  export interface EntityRaycastOptions {
@@ -5933,7 +5748,6 @@ export interface EntityRaycastOptions {
5933
5748
  }
5934
5749
 
5935
5750
  /**
5936
- * @beta
5937
5751
  * Additional configuration options for {@link
5938
5752
  * World.playMusic}/{@link World.queueMusic} methods.
5939
5753
  */
@@ -5959,7 +5773,6 @@ export interface MusicOptions {
5959
5773
  }
5960
5774
 
5961
5775
  /**
5962
- * @beta
5963
5776
  * Additional options for how a sound plays for a player.
5964
5777
  */
5965
5778
  export interface PlayerSoundOptions {
@@ -5985,7 +5798,6 @@ export interface PlayerSoundOptions {
5985
5798
  }
5986
5799
 
5987
5800
  /**
5988
- * @beta
5989
5801
  * Defines a JSON structure that is used for more flexible.
5990
5802
  */
5991
5803
  export interface RawMessage {
@@ -6027,7 +5839,6 @@ export interface RawMessage {
6027
5839
  }
6028
5840
 
6029
5841
  /**
6030
- * @beta
6031
5842
  * Provides a description of a score token to use within a raw
6032
5843
  * message.
6033
5844
  */
@@ -6047,7 +5858,6 @@ export interface RawMessageScore {
6047
5858
  }
6048
5859
 
6049
5860
  /**
6050
- * @beta
6051
5861
  * Represents a fully customizable color within Minecraft.
6052
5862
  */
6053
5863
  export interface RGB {
@@ -6075,7 +5885,6 @@ export interface RGB {
6075
5885
  }
6076
5886
 
6077
5887
  /**
6078
- * @beta
6079
5888
  * Represents a fully customizable color within Minecraft.
6080
5889
  */
6081
5890
  export interface RGBA {
@@ -6110,7 +5919,6 @@ export interface RGBA {
6110
5919
  }
6111
5920
 
6112
5921
  /**
6113
- * @beta
6114
5922
  * Contains additional options for how a scoreboard should be
6115
5923
  * displayed within its display slot.
6116
5924
  */
@@ -6130,7 +5938,6 @@ export interface ScoreboardObjectiveDisplayOptions {
6130
5938
  }
6131
5939
 
6132
5940
  /**
6133
- * @beta
6134
5941
  * Contains additional options for registering a script event
6135
5942
  * event callback.
6136
5943
  */
@@ -6145,7 +5952,6 @@ export interface ScriptEventMessageFilterOptions {
6145
5952
  }
6146
5953
 
6147
5954
  /**
6148
- * @beta
6149
5955
  * Contains additional options for teleporting an entity.
6150
5956
  */
6151
5957
  export interface TeleportOptions {
@@ -6185,7 +5991,6 @@ export interface TeleportOptions {
6185
5991
  }
6186
5992
 
6187
5993
  /**
6188
- * @beta
6189
5994
  * Contains additional options for displaying a title and
6190
5995
  * optional subtitle.
6191
5996
  */
@@ -6224,7 +6029,6 @@ export interface TitleDisplayOptions {
6224
6029
  }
6225
6030
 
6226
6031
  /**
6227
- * @beta
6228
6032
  * Represents a two-directional vector.
6229
6033
  */
6230
6034
  export interface Vector2 {
@@ -6243,7 +6047,6 @@ export interface Vector2 {
6243
6047
  }
6244
6048
 
6245
6049
  /**
6246
- * @beta
6247
6050
  * Contains a description of a vector.
6248
6051
  */
6249
6052
  export interface Vector3 {
@@ -6268,7 +6071,6 @@ export interface Vector3 {
6268
6071
  }
6269
6072
 
6270
6073
  /**
6271
- * @beta
6272
6074
  * Contains additional options for a world-level playSound
6273
6075
  * occurrence.
6274
6076
  */
@@ -6287,25 +6089,16 @@ export interface WorldSoundOptions {
6287
6089
  volume?: number;
6288
6090
  }
6289
6091
 
6290
- /**
6291
- * @beta
6292
- */
6293
6092
  // @ts-ignore Class inheritance allowed for native defined classes
6294
6093
  export class CommandError extends Error {
6295
6094
  private constructor();
6296
6095
  }
6297
6096
 
6298
- /**
6299
- * @beta
6300
- */
6301
6097
  // @ts-ignore Class inheritance allowed for native defined classes
6302
6098
  export class LocationInUnloadedChunkError extends Error {
6303
6099
  private constructor();
6304
6100
  }
6305
6101
 
6306
- /**
6307
- * @beta
6308
- */
6309
6102
  // @ts-ignore Class inheritance allowed for native defined classes
6310
6103
  export class LocationOutOfWorldBoundariesError extends Error {
6311
6104
  private constructor();