@minecraft/server 2.0.0-beta.1.21.70-preview.23 → 2.0.0-beta.1.21.70-preview.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +329 -16
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -1856,7 +1856,7 @@ export enum ItemLockMode {
1856
1856
  }
1857
1857
 
1858
1858
  /**
1859
- * @beta
1859
+ * @rc
1860
1860
  * Represents the type of liquid that can be placed on a block
1861
1861
  * or flow dynamically in the world.
1862
1862
  */
@@ -2379,6 +2379,7 @@ export enum TimeOfDay {
2379
2379
  export enum TintMethod {
2380
2380
  BirchFoliage = 'BirchFoliage',
2381
2381
  DefaultFoliage = 'DefaultFoliage',
2382
+ DryFoliage = 'DryFoliage',
2382
2383
  EvergreenFoliage = 'EvergreenFoliage',
2383
2384
  Grass = 'Grass',
2384
2385
  None = 'None',
@@ -2717,6 +2718,8 @@ export class AimAssistCategorySettings {
2717
2718
  * Constructor that takes a unique Id to associate with the
2718
2719
  * created AimAssistCategory. Must have a namespace.
2719
2720
  *
2721
+ * This function can't be called in read-only mode.
2722
+ *
2720
2723
  */
2721
2724
  constructor(identifier: string);
2722
2725
  /**
@@ -2741,6 +2744,8 @@ export class AimAssistCategorySettings {
2741
2744
  * @remarks
2742
2745
  * Sets the priority settings used for block targeting.
2743
2746
  *
2747
+ * This function can't be called in read-only mode.
2748
+ *
2744
2749
  * @param blockPriorities
2745
2750
  * A record mapping block Ids to their priority settings.
2746
2751
  * Larger numbers have greater priority.
@@ -2752,6 +2757,8 @@ export class AimAssistCategorySettings {
2752
2757
  * @remarks
2753
2758
  * Sets the priority settings used for entity targeting.
2754
2759
  *
2760
+ * This function can't be called in read-only mode.
2761
+ *
2755
2762
  * @param entityPriorities
2756
2763
  * A record mapping entity Ids to their priority settings.
2757
2764
  * Larger numbers have greater priority.
@@ -2865,6 +2872,8 @@ export class AimAssistPresetSettings {
2865
2872
  * Constructor that takes a unique Id to associate with the
2866
2873
  * created AimAssistPreset. Must have a namespace.
2867
2874
  *
2875
+ * This function can't be called in read-only mode.
2876
+ *
2868
2877
  */
2869
2878
  constructor(identifier: string);
2870
2879
  /**
@@ -2898,6 +2907,8 @@ export class AimAssistPresetSettings {
2898
2907
  * Sets the list of block/entity Ids to exclude from aim assist
2899
2908
  * targeting.
2900
2909
  *
2910
+ * This function can't be called in read-only mode.
2911
+ *
2901
2912
  * @param targets
2902
2913
  * An array of block/entity Ids.
2903
2914
  */
@@ -2912,6 +2923,8 @@ export class AimAssistPresetSettings {
2912
2923
  * @remarks
2913
2924
  * Sets the per-item aim-assist category Ids.
2914
2925
  *
2926
+ * This function can't be called in read-only mode.
2927
+ *
2915
2928
  * @param itemSettings
2916
2929
  * A record mapping item Ids to aim-assist category Ids.
2917
2930
  * Category Ids must have a namespace.
@@ -2922,6 +2935,8 @@ export class AimAssistPresetSettings {
2922
2935
  * Sets the list of item Ids that will target liquid blocks
2923
2936
  * with aim-assist when being held.
2924
2937
  *
2938
+ * This function can't be called in read-only mode.
2939
+ *
2925
2940
  * @param items
2926
2941
  * An array of item Ids.
2927
2942
  */
@@ -3237,7 +3252,7 @@ export class Block {
3237
3252
  */
3238
3253
  bottomCenter(): Vector3;
3239
3254
  /**
3240
- * @beta
3255
+ * @rc
3241
3256
  * @remarks
3242
3257
  * Returns whether this block is removed when touched by
3243
3258
  * liquid.
@@ -3256,7 +3271,7 @@ export class Block {
3256
3271
  */
3257
3272
  canBeDestroyedByLiquidSpread(liquidType: LiquidType): boolean;
3258
3273
  /**
3259
- * @beta
3274
+ * @rc
3260
3275
  * @remarks
3261
3276
  * Returns whether this block can have a liquid placed over it,
3262
3277
  * i.e. be waterlogged.
@@ -3325,6 +3340,8 @@ export class Block {
3325
3340
  * for a block - for example, an inventory component of a chest
3326
3341
  * block.
3327
3342
  *
3343
+ * This function can't be called in read-only mode.
3344
+ *
3328
3345
  * @param componentId
3329
3346
  * The identifier of the component (e.g.,
3330
3347
  * 'minecraft:inventory'). If no namespace prefix is specified,
@@ -3431,7 +3448,7 @@ export class Block {
3431
3448
  */
3432
3449
  hasTag(tag: string): boolean;
3433
3450
  /**
3434
- * @beta
3451
+ * @rc
3435
3452
  * @remarks
3436
3453
  * Returns whether this block stops liquid from flowing.
3437
3454
  *
@@ -3449,7 +3466,18 @@ export class Block {
3449
3466
  */
3450
3467
  isLiquidBlocking(liquidType: LiquidType): boolean;
3451
3468
  /**
3452
- * @beta
3469
+ * @rc
3470
+ * @remarks
3471
+ * Returns whether liquid can flow into the block from the
3472
+ * provided direction, or flow out from the provided direction
3473
+ * when liquid is placed into it with a bucket.
3474
+ *
3475
+ * @param liquidType
3476
+ * The type of liquid this function should be called for.
3477
+ * @returns
3478
+ * Whether liquid can flow into the block from the provided
3479
+ * direction, or flow out from the provided direction when
3480
+ * liquid is placed into it with a bucket
3453
3481
  * @throws This function can throw errors.
3454
3482
  *
3455
3483
  * {@link Error}
@@ -3460,7 +3488,7 @@ export class Block {
3460
3488
  */
3461
3489
  liquidCanFlowFromDirection(liquidType: LiquidType, flowDirection: Direction): boolean;
3462
3490
  /**
3463
- * @beta
3491
+ * @rc
3464
3492
  * @remarks
3465
3493
  * Returns whether this block is removed and spawns its item
3466
3494
  * when touched by liquid.
@@ -4157,7 +4185,7 @@ export class BlockPermutation {
4157
4185
  */
4158
4186
  readonly 'type': BlockType;
4159
4187
  /**
4160
- * @beta
4188
+ * @rc
4161
4189
  * @remarks
4162
4190
  * Returns whether this block is removed when touched by
4163
4191
  * liquid.
@@ -4172,7 +4200,7 @@ export class BlockPermutation {
4172
4200
  */
4173
4201
  canBeDestroyedByLiquidSpread(liquidType: LiquidType): boolean;
4174
4202
  /**
4175
- * @beta
4203
+ * @rc
4176
4204
  * @remarks
4177
4205
  * Returns whether this block can have a liquid placed over it,
4178
4206
  * i.e. be waterlogged.
@@ -4211,6 +4239,8 @@ export class BlockPermutation {
4211
4239
  * @remarks
4212
4240
  * Gets a state for the permutation.
4213
4241
  *
4242
+ * This function can't be called in read-only mode.
4243
+ *
4214
4244
  * @param stateName
4215
4245
  * Name of the block state who's value is to be returned.
4216
4246
  * @returns
@@ -4251,7 +4281,7 @@ export class BlockPermutation {
4251
4281
  */
4252
4282
  hasTag(tag: string): boolean;
4253
4283
  /**
4254
- * @beta
4284
+ * @rc
4255
4285
  * @remarks
4256
4286
  * Returns whether this block stops liquid from flowing.
4257
4287
  *
@@ -4265,7 +4295,7 @@ export class BlockPermutation {
4265
4295
  */
4266
4296
  isLiquidBlocking(liquidType: LiquidType): boolean;
4267
4297
  /**
4268
- * @beta
4298
+ * @rc
4269
4299
  * @remarks
4270
4300
  * Returns whether this block is removed and spawns its item
4271
4301
  * when touched by liquid.
@@ -4286,6 +4316,8 @@ export class BlockPermutation {
4286
4316
  * this permutation. If states is not specified, matches checks
4287
4317
  * against the set of types more broadly.
4288
4318
  *
4319
+ * This function can't be called in read-only mode.
4320
+ *
4289
4321
  * @param blockName
4290
4322
  * An optional set of states to compare against.
4291
4323
  */
@@ -4298,6 +4330,8 @@ export class BlockPermutation {
4298
4330
  * Returns a derived BlockPermutation with a specific property
4299
4331
  * set.
4300
4332
  *
4333
+ * This function can't be called in read-only mode.
4334
+ *
4301
4335
  * @param name
4302
4336
  * Identifier of the block property.
4303
4337
  * @param value
@@ -4314,6 +4348,8 @@ export class BlockPermutation {
4314
4348
  * will return a BlockPermutation object that is usable in
4315
4349
  * other block APIs (e.g., block.setPermutation)
4316
4350
  *
4351
+ * This function can't be called in read-only mode.
4352
+ *
4317
4353
  * @param blockName
4318
4354
  * Identifier of the block to check.
4319
4355
  * @throws This function can throw errors.
@@ -4809,6 +4845,11 @@ export class BlockVolume extends BlockVolumeBase {
4809
4845
  *
4810
4846
  */
4811
4847
  to: Vector3;
4848
+ /**
4849
+ * @remarks
4850
+ * This function can't be called in read-only mode.
4851
+ *
4852
+ */
4812
4853
  constructor(from: Vector3, to: Vector3);
4813
4854
  /**
4814
4855
  * @remarks
@@ -5466,6 +5507,8 @@ export class CompoundBlockVolume {
5466
5507
  * @remarks
5467
5508
  * Create a CompoundBlockVolume object
5468
5509
  *
5510
+ * This function can't be called in read-only mode.
5511
+ *
5469
5512
  * @param origin
5470
5513
  * An optional world space origin on which to center the
5471
5514
  * compound volume.
@@ -7386,6 +7429,9 @@ export class EnchantmentType {
7386
7429
  */
7387
7430
  readonly maxLevel: number;
7388
7431
  /**
7432
+ * @remarks
7433
+ * This function can't be called in read-only mode.
7434
+ *
7389
7435
  * @throws This function can throw errors.
7390
7436
  */
7391
7437
  constructor(enchantmentType: string);
@@ -7846,6 +7892,8 @@ export class Entity {
7846
7892
  * Gets a component (that represents additional capabilities)
7847
7893
  * for an entity.
7848
7894
  *
7895
+ * This function can't be called in read-only mode.
7896
+ *
7849
7897
  * @param componentId
7850
7898
  * The identifier of the component (e.g., 'minecraft:health').
7851
7899
  * If no namespace prefix is specified, 'minecraft:' is
@@ -12485,6 +12533,8 @@ export class ItemStack {
12485
12533
  * Creates a new instance of a stack of items for use in the
12486
12534
  * world.
12487
12535
  *
12536
+ * This function can't be called in read-only mode.
12537
+ *
12488
12538
  * @param itemType
12489
12539
  * Type of item to create. See the {@link
12490
12540
  * @minecraft/vanilla-data.MinecraftItemTypes} enumeration for
@@ -12538,6 +12588,8 @@ export class ItemStack {
12538
12588
  * Gets a component (that represents additional capabilities)
12539
12589
  * for an item stack.
12540
12590
  *
12591
+ * This function can't be called in read-only mode.
12592
+ *
12541
12593
  * @param componentId
12542
12594
  * The identifier of the component (e.g., 'minecraft:food'). If
12543
12595
  * no namespace prefix is specified, 'minecraft:' is assumed.
@@ -13478,6 +13530,8 @@ export class ListBlockVolume extends BlockVolumeBase {
13478
13530
  * @remarks
13479
13531
  * Creates a new instance of ListBlockVolume.
13480
13532
  *
13533
+ * This function can't be called in read-only mode.
13534
+ *
13481
13535
  * @param locations
13482
13536
  * Initial array of block locations that ListBlockVolume will
13483
13537
  * be constructed with.
@@ -13870,6 +13924,22 @@ export class Player extends Entity {
13870
13924
  * @throws This function can throw errors.
13871
13925
  */
13872
13926
  addLevels(amount: number): number;
13927
+ /**
13928
+ * @beta
13929
+ * @remarks
13930
+ * For this player, removes all overrides of any Entity
13931
+ * Properties on the target Entity. This change is not applied
13932
+ * until the next tick and will not apply to other players.
13933
+ *
13934
+ * This function can't be called in read-only mode.
13935
+ *
13936
+ * @param targetEntity
13937
+ * The Entity whose Entity Property overrides are being
13938
+ * cleared.
13939
+ * @throws
13940
+ * Throws if the entity is invalid.
13941
+ */
13942
+ clearPropertyOverridesForEntity(targetEntity: Entity): void;
13873
13943
  /**
13874
13944
  * @beta
13875
13945
  * @remarks
@@ -14013,6 +14083,26 @@ export class Player extends Entity {
14013
14083
  *
14014
14084
  */
14015
14085
  queueMusic(trackId: string, musicOptions?: MusicOptions): void;
14086
+ /**
14087
+ * @beta
14088
+ * @remarks
14089
+ * For this player, removes the override on an Entity Property.
14090
+ * This change is not applied until the next tick and will not
14091
+ * apply to other players.
14092
+ *
14093
+ * This function can't be called in read-only mode.
14094
+ *
14095
+ * @param targetEntity
14096
+ * The Entity whose Entity Property override is being removed.
14097
+ * @param identifier
14098
+ * The Entity Property identifier.
14099
+ * @throws
14100
+ * Throws if the entity is invalid.
14101
+ * Throws if an invalid identifier is provided.
14102
+ * Throws if the provided value type does not match the
14103
+ * property type.
14104
+ */
14105
+ removePropertyOverrideForEntity(targetEntity: Entity, identifier: string): void;
14016
14106
  /**
14017
14107
  * @remarks
14018
14108
  * Resets the level of the player.
@@ -14130,6 +14220,34 @@ export class Player extends Entity {
14130
14220
  * @throws This function can throw errors.
14131
14221
  */
14132
14222
  setOp(isOp: boolean): void;
14223
+ /**
14224
+ * @beta
14225
+ * @remarks
14226
+ * For this player, overrides an Entity Property on the target
14227
+ * Entity to the provided value. This property must be client
14228
+ * synced. This change is not applied until the next tick and
14229
+ * will not apply to other players.
14230
+ *
14231
+ * This function can't be called in read-only mode.
14232
+ *
14233
+ * @param targetEntity
14234
+ * The Entity whose Entity Property is being overriden.
14235
+ * @param identifier
14236
+ * The Entity Property identifier.
14237
+ * @param value
14238
+ * The override value. The provided type must be compatible
14239
+ * with the type specified in the entity's definition.
14240
+ * @throws
14241
+ * Throws if the entity is invalid.
14242
+ * Throws if an invalid identifier is provided.
14243
+ * Throws if the provided value type does not match the
14244
+ * property type.
14245
+ * Throws if the provided value is outside the expected range
14246
+ * (int, float properties).
14247
+ * Throws if the provided string value does not match the set
14248
+ * of accepted enum values (enum properties)
14249
+ */
14250
+ setPropertyOverrideForEntity(targetEntity: Entity, identifier: string, value: boolean | number | string): void;
14133
14251
  /**
14134
14252
  * @remarks
14135
14253
  * Sets the current starting spawn point for this particular
@@ -14145,7 +14263,7 @@ export class Player extends Entity {
14145
14263
  */
14146
14264
  setSpawnPoint(spawnPoint?: DimensionLocation): void;
14147
14265
  /**
14148
- * @beta
14266
+ * @rc
14149
14267
  * @remarks
14150
14268
  * Creates a new particle emitter at a specified location in
14151
14269
  * the world. Only visible to the target player.
@@ -16581,7 +16699,17 @@ export class StartupBeforeEventSignal {
16581
16699
  */
16582
16700
  export class StartupEvent {
16583
16701
  private constructor();
16702
+ /**
16703
+ * @remarks
16704
+ * This property can be read in early-execution mode.
16705
+ *
16706
+ */
16584
16707
  readonly blockComponentRegistry: BlockComponentRegistry;
16708
+ /**
16709
+ * @remarks
16710
+ * This property can be read in early-execution mode.
16711
+ *
16712
+ */
16585
16713
  readonly itemComponentRegistry: ItemComponentRegistry;
16586
16714
  }
16587
16715
 
@@ -16955,6 +17083,8 @@ export class System {
16955
17083
  * Returns a collection of after-events for system-level
16956
17084
  * operations.
16957
17085
  *
17086
+ * This property can be read in early-execution mode.
17087
+ *
16958
17088
  */
16959
17089
  readonly afterEvents: SystemAfterEvents;
16960
17090
  /**
@@ -16963,12 +17093,16 @@ export class System {
16963
17093
  * Returns a collection of before-events for system-level
16964
17094
  * operations.
16965
17095
  *
17096
+ * This property can be read in early-execution mode.
17097
+ *
16966
17098
  */
16967
17099
  readonly beforeEvents: SystemBeforeEvents;
16968
17100
  /**
16969
17101
  * @remarks
16970
17102
  * Represents the current world tick of the server.
16971
17103
  *
17104
+ * This property can be read in early-execution mode.
17105
+ *
16972
17106
  */
16973
17107
  readonly currentTick: number;
16974
17108
  /**
@@ -16977,12 +17111,16 @@ export class System {
16977
17111
  * Returns true if this is a world where the editor is
16978
17112
  * currently loaded, returns false otherwise.
16979
17113
  *
17114
+ * This property can be read in early-execution mode.
17115
+ *
16980
17116
  */
16981
17117
  readonly isEditorWorld: boolean;
16982
17118
  /**
16983
17119
  * @remarks
16984
17120
  * Contains the device information for the server.
16985
17121
  *
17122
+ * This property can be read in early-execution mode.
17123
+ *
16986
17124
  */
16987
17125
  readonly serverSystemInfo: SystemInfo;
16988
17126
  /**
@@ -17182,6 +17320,8 @@ export class SystemAfterEvents {
17182
17320
  * provides a way for commands and other systems to trigger
17183
17321
  * behavior within script.
17184
17322
  *
17323
+ * This property can be read in early-execution mode.
17324
+ *
17185
17325
  */
17186
17326
  readonly scriptEventReceive: ScriptEventCommandMessageAfterEventSignal;
17187
17327
  }
@@ -17196,7 +17336,17 @@ export class SystemAfterEvents {
17196
17336
  */
17197
17337
  export class SystemBeforeEvents {
17198
17338
  private constructor();
17339
+ /**
17340
+ * @remarks
17341
+ * This property can be read in early-execution mode.
17342
+ *
17343
+ */
17199
17344
  readonly shutdown: ShutdownBeforeEventSignal;
17345
+ /**
17346
+ * @remarks
17347
+ * This property can be read in early-execution mode.
17348
+ *
17349
+ */
17200
17350
  readonly startup: StartupBeforeEventSignal;
17201
17351
  /**
17202
17352
  * @remarks
@@ -17206,6 +17356,8 @@ export class SystemBeforeEvents {
17206
17356
  * To prevent shutdown, set the event's cancel property to
17207
17357
  * true.
17208
17358
  *
17359
+ * This property can be read in early-execution mode.
17360
+ *
17209
17361
  */
17210
17362
  readonly watchdogTerminate: WatchdogTerminateBeforeEventSignal;
17211
17363
  }
@@ -17300,6 +17452,8 @@ export class Trigger {
17300
17452
  * @remarks
17301
17453
  * Creates a new trigger.
17302
17454
  *
17455
+ * This function can't be called in read-only mode.
17456
+ *
17303
17457
  */
17304
17458
  constructor(eventName: string);
17305
17459
  }
@@ -17609,6 +17763,8 @@ export class World {
17609
17763
  * of the world. Event callbacks are called in a deferred
17610
17764
  * manner. Event callbacks are executed in read-write mode.
17611
17765
  *
17766
+ * This property can be read in early-execution mode.
17767
+ *
17612
17768
  */
17613
17769
  readonly afterEvents: WorldAfterEvents;
17614
17770
  /**
@@ -17617,6 +17773,8 @@ export class World {
17617
17773
  * of the world. Event callbacks are called immediately. Event
17618
17774
  * callbacks are executed in read-only mode.
17619
17775
  *
17776
+ * This property can be read in early-execution mode.
17777
+ *
17620
17778
  * @example customCommand.ts
17621
17779
  * ```typescript
17622
17780
  * import { world, DimensionLocation } from "@minecraft/server";
@@ -18115,12 +18273,16 @@ export class WorldAfterEvents {
18115
18273
  * explosion. It is fired after the blocks have already been
18116
18274
  * destroyed.
18117
18275
  *
18276
+ * This property can be read in early-execution mode.
18277
+ *
18118
18278
  */
18119
18279
  readonly blockExplode: BlockExplodeAfterEventSignal;
18120
18280
  /**
18121
18281
  * @remarks
18122
18282
  * This event fires when a button is pushed.
18123
18283
  *
18284
+ * This property can be read in early-execution mode.
18285
+ *
18124
18286
  */
18125
18287
  readonly buttonPush: ButtonPushAfterEventSignal;
18126
18288
  /**
@@ -18129,6 +18291,8 @@ export class WorldAfterEvents {
18129
18291
  * This event is triggered after a chat message has been
18130
18292
  * broadcast or sent to players.
18131
18293
  *
18294
+ * This property can be read in early-execution mode.
18295
+ *
18132
18296
  */
18133
18297
  readonly chatSend: ChatSendAfterEventSignal;
18134
18298
  /**
@@ -18137,6 +18301,8 @@ export class WorldAfterEvents {
18137
18301
  * that will update the component definition state of an
18138
18302
  * entity.
18139
18303
  *
18304
+ * This property can be read in early-execution mode.
18305
+ *
18140
18306
  */
18141
18307
  readonly dataDrivenEntityTrigger: DataDrivenEntityTriggerAfterEventSignal;
18142
18308
  /**
@@ -18144,18 +18310,24 @@ export class WorldAfterEvents {
18144
18310
  * This event fires when an effect, like poisoning, is added to
18145
18311
  * an entity.
18146
18312
  *
18313
+ * This property can be read in early-execution mode.
18314
+ *
18147
18315
  */
18148
18316
  readonly effectAdd: EffectAddAfterEventSignal;
18149
18317
  /**
18150
18318
  * @remarks
18151
18319
  * This event fires when an entity dies.
18152
18320
  *
18321
+ * This property can be read in early-execution mode.
18322
+ *
18153
18323
  */
18154
18324
  readonly entityDie: EntityDieAfterEventSignal;
18155
18325
  /**
18156
18326
  * @remarks
18157
18327
  * This event fires when entity health changes in any degree.
18158
18328
  *
18329
+ * This property can be read in early-execution mode.
18330
+ *
18159
18331
  */
18160
18332
  readonly entityHealthChanged: EntityHealthChangedAfterEventSignal;
18161
18333
  /**
@@ -18163,6 +18335,8 @@ export class WorldAfterEvents {
18163
18335
  * This event fires when an entity hits (that is, melee
18164
18336
  * attacks) a block.
18165
18337
  *
18338
+ * This property can be read in early-execution mode.
18339
+ *
18166
18340
  */
18167
18341
  readonly entityHitBlock: EntityHitBlockAfterEventSignal;
18168
18342
  /**
@@ -18170,18 +18344,24 @@ export class WorldAfterEvents {
18170
18344
  * This event fires when an entity hits (that is, melee
18171
18345
  * attacks) another entity.
18172
18346
  *
18347
+ * This property can be read in early-execution mode.
18348
+ *
18173
18349
  */
18174
18350
  readonly entityHitEntity: EntityHitEntityAfterEventSignal;
18175
18351
  /**
18176
18352
  * @remarks
18177
18353
  * This event fires when an entity is hurt (takes damage).
18178
18354
  *
18355
+ * This property can be read in early-execution mode.
18356
+ *
18179
18357
  */
18180
18358
  readonly entityHurt: EntityHurtAfterEventSignal;
18181
18359
  /**
18182
18360
  * @remarks
18183
18361
  * Fires when an entity is loaded.
18184
18362
  *
18363
+ * This property can be read in early-execution mode.
18364
+ *
18185
18365
  */
18186
18366
  readonly entityLoad: EntityLoadAfterEventSignal;
18187
18367
  /**
@@ -18189,18 +18369,24 @@ export class WorldAfterEvents {
18189
18369
  * Fires when an entity is removed (for example, potentially
18190
18370
  * unloaded, or removed after being killed).
18191
18371
  *
18372
+ * This property can be read in early-execution mode.
18373
+ *
18192
18374
  */
18193
18375
  readonly entityRemove: EntityRemoveAfterEventSignal;
18194
18376
  /**
18195
18377
  * @remarks
18196
18378
  * This event fires when an entity is spawned.
18197
18379
  *
18380
+ * This property can be read in early-execution mode.
18381
+ *
18198
18382
  */
18199
18383
  readonly entitySpawn: EntitySpawnAfterEventSignal;
18200
18384
  /**
18201
18385
  * @remarks
18202
18386
  * This event is fired after an explosion occurs.
18203
18387
  *
18388
+ * This property can be read in early-execution mode.
18389
+ *
18204
18390
  */
18205
18391
  readonly explosion: ExplosionAfterEventSignal;
18206
18392
  /**
@@ -18208,12 +18394,16 @@ export class WorldAfterEvents {
18208
18394
  * This event fires when a world.gameRules property has
18209
18395
  * changed.
18210
18396
  *
18397
+ * This property can be read in early-execution mode.
18398
+ *
18211
18399
  */
18212
18400
  readonly gameRuleChange: GameRuleChangeAfterEventSignal;
18213
18401
  /**
18214
18402
  * @remarks
18215
18403
  * This event fires when a chargeable item completes charging.
18216
18404
  *
18405
+ * This property can be read in early-execution mode.
18406
+ *
18217
18407
  */
18218
18408
  readonly itemCompleteUse: ItemCompleteUseAfterEventSignal;
18219
18409
  /**
@@ -18221,12 +18411,16 @@ export class WorldAfterEvents {
18221
18411
  * This event fires when a chargeable item is released from
18222
18412
  * charging.
18223
18413
  *
18414
+ * This property can be read in early-execution mode.
18415
+ *
18224
18416
  */
18225
18417
  readonly itemReleaseUse: ItemReleaseUseAfterEventSignal;
18226
18418
  /**
18227
18419
  * @remarks
18228
18420
  * This event fires when a chargeable item starts charging.
18229
18421
  *
18422
+ * This property can be read in early-execution mode.
18423
+ *
18230
18424
  */
18231
18425
  readonly itemStartUse: ItemStartUseAfterEventSignal;
18232
18426
  /**
@@ -18237,12 +18431,16 @@ export class WorldAfterEvents {
18237
18431
  * occur once at the beginning of the block placement. Note:
18238
18432
  * This event cannot be used with Hoe or Axe items.
18239
18433
  *
18434
+ * This property can be read in early-execution mode.
18435
+ *
18240
18436
  */
18241
18437
  readonly itemStartUseOn: ItemStartUseOnAfterEventSignal;
18242
18438
  /**
18243
18439
  * @remarks
18244
18440
  * This event fires when a chargeable item stops charging.
18245
18441
  *
18442
+ * This property can be read in early-execution mode.
18443
+ *
18246
18444
  */
18247
18445
  readonly itemStopUse: ItemStopUseAfterEventSignal;
18248
18446
  /**
@@ -18251,6 +18449,8 @@ export class WorldAfterEvents {
18251
18449
  * Block button after successfully using an item. Note: This
18252
18450
  * event cannot be used with Hoe or Axe items.
18253
18451
  *
18452
+ * This property can be read in early-execution mode.
18453
+ *
18254
18454
  */
18255
18455
  readonly itemStopUseOn: ItemStopUseOnAfterEventSignal;
18256
18456
  /**
@@ -18258,6 +18458,8 @@ export class WorldAfterEvents {
18258
18458
  * This event fires when an item is successfully used by a
18259
18459
  * player.
18260
18460
  *
18461
+ * This property can be read in early-execution mode.
18462
+ *
18261
18463
  */
18262
18464
  readonly itemUse: ItemUseAfterEventSignal;
18263
18465
  /**
@@ -18265,12 +18467,16 @@ export class WorldAfterEvents {
18265
18467
  * This event fires when an item is used on a block by a
18266
18468
  * player.
18267
18469
  *
18470
+ * This property can be read in early-execution mode.
18471
+ *
18268
18472
  */
18269
18473
  readonly itemUseOn: ItemUseOnAfterEventSignal;
18270
18474
  /**
18271
18475
  * @remarks
18272
18476
  * A lever has been pulled.
18273
18477
  *
18478
+ * This property can be read in early-execution mode.
18479
+ *
18274
18480
  */
18275
18481
  readonly leverAction: LeverActionAfterEventSignal;
18276
18482
  /**
@@ -18279,18 +18485,24 @@ export class WorldAfterEvents {
18279
18485
  * This event is an internal implementation detail, and is
18280
18486
  * otherwise not currently functional.
18281
18487
  *
18488
+ * This property can be read in early-execution mode.
18489
+ *
18282
18490
  */
18283
18491
  readonly messageReceive: ServerMessageAfterEventSignal;
18284
18492
  /**
18285
18493
  * @remarks
18286
18494
  * This event fires when a piston expands or retracts.
18287
18495
  *
18496
+ * This property can be read in early-execution mode.
18497
+ *
18288
18498
  */
18289
18499
  readonly pistonActivate: PistonActivateAfterEventSignal;
18290
18500
  /**
18291
18501
  * @remarks
18292
18502
  * This event fires for a block that is broken by a player.
18293
18503
  *
18504
+ * This property can be read in early-execution mode.
18505
+ *
18294
18506
  */
18295
18507
  readonly playerBreakBlock: PlayerBreakBlockAfterEventSignal;
18296
18508
  /**
@@ -18299,38 +18511,60 @@ export class WorldAfterEvents {
18299
18511
  * This event fires when an {@link InputButton} state is
18300
18512
  * changed.
18301
18513
  *
18514
+ * This property can be read in early-execution mode.
18515
+ *
18302
18516
  */
18303
18517
  readonly playerButtonInput: PlayerButtonInputAfterEventSignal;
18304
18518
  /**
18305
18519
  * @remarks
18306
18520
  * Fires when a player moved to a different dimension.
18307
18521
  *
18522
+ * This property can be read in early-execution mode.
18523
+ *
18308
18524
  */
18309
18525
  readonly playerDimensionChange: PlayerDimensionChangeAfterEventSignal;
18526
+ /**
18527
+ * @remarks
18528
+ * This property can be read in early-execution mode.
18529
+ *
18530
+ */
18310
18531
  readonly playerEmote: PlayerEmoteAfterEventSignal;
18532
+ /**
18533
+ * @remarks
18534
+ * This property can be read in early-execution mode.
18535
+ *
18536
+ */
18311
18537
  readonly playerGameModeChange: PlayerGameModeChangeAfterEventSignal;
18312
18538
  /**
18313
18539
  * @remarks
18314
18540
  * This event fires when a player's {@link InputMode} changes.
18315
18541
  *
18542
+ * This property can be read in early-execution mode.
18543
+ *
18316
18544
  */
18317
18545
  readonly playerInputModeChange: PlayerInputModeChangeAfterEventSignal;
18318
18546
  /**
18319
18547
  * @remarks
18320
18548
  * This event fires when a players input permissions change.
18321
18549
  *
18550
+ * This property can be read in early-execution mode.
18551
+ *
18322
18552
  */
18323
18553
  readonly playerInputPermissionCategoryChange: PlayerInputPermissionCategoryChangeAfterEventSignal;
18324
18554
  /**
18325
18555
  * @remarks
18326
18556
  * An event for when a player interacts with a block.
18327
18557
  *
18558
+ * This property can be read in early-execution mode.
18559
+ *
18328
18560
  */
18329
18561
  readonly playerInteractWithBlock: PlayerInteractWithBlockAfterEventSignal;
18330
18562
  /**
18331
18563
  * @remarks
18332
18564
  * This event fires when a player interacts with an entity.
18333
18565
  *
18566
+ * This property can be read in early-execution mode.
18567
+ *
18334
18568
  */
18335
18569
  readonly playerInteractWithEntity: PlayerInteractWithEntityAfterEventSignal;
18336
18570
  /**
@@ -18339,18 +18573,24 @@ export class WorldAfterEvents {
18339
18573
  * playerSpawn for another related event you can trap for when
18340
18574
  * a player is spawned the first time within a world.
18341
18575
  *
18576
+ * This property can be read in early-execution mode.
18577
+ *
18342
18578
  */
18343
18579
  readonly playerJoin: PlayerJoinAfterEventSignal;
18344
18580
  /**
18345
18581
  * @remarks
18346
18582
  * This event fires when a player leaves a world.
18347
18583
  *
18584
+ * This property can be read in early-execution mode.
18585
+ *
18348
18586
  */
18349
18587
  readonly playerLeave: PlayerLeaveAfterEventSignal;
18350
18588
  /**
18351
18589
  * @remarks
18352
18590
  * This event fires for a block that is placed by a player.
18353
18591
  *
18592
+ * This property can be read in early-execution mode.
18593
+ *
18354
18594
  */
18355
18595
  readonly playerPlaceBlock: PlayerPlaceBlockAfterEventSignal;
18356
18596
  /**
@@ -18359,6 +18599,8 @@ export class WorldAfterEvents {
18359
18599
  * an additional flag within this event will tell you whether
18360
18600
  * the player is spawning right after join vs. a respawn.
18361
18601
  *
18602
+ * This property can be read in early-execution mode.
18603
+ *
18362
18604
  */
18363
18605
  readonly playerSpawn: PlayerSpawnAfterEventSignal;
18364
18606
  /**
@@ -18366,6 +18608,8 @@ export class WorldAfterEvents {
18366
18608
  * A pressure plate has popped back up (i.e., there are no
18367
18609
  * entities on the pressure plate.)
18368
18610
  *
18611
+ * This property can be read in early-execution mode.
18612
+ *
18369
18613
  */
18370
18614
  readonly pressurePlatePop: PressurePlatePopAfterEventSignal;
18371
18615
  /**
@@ -18373,30 +18617,40 @@ export class WorldAfterEvents {
18373
18617
  * A pressure plate has pushed (at least one entity has moved
18374
18618
  * onto a pressure plate.)
18375
18619
  *
18620
+ * This property can be read in early-execution mode.
18621
+ *
18376
18622
  */
18377
18623
  readonly pressurePlatePush: PressurePlatePushAfterEventSignal;
18378
18624
  /**
18379
18625
  * @remarks
18380
18626
  * This event fires when a projectile hits a block.
18381
18627
  *
18628
+ * This property can be read in early-execution mode.
18629
+ *
18382
18630
  */
18383
18631
  readonly projectileHitBlock: ProjectileHitBlockAfterEventSignal;
18384
18632
  /**
18385
18633
  * @remarks
18386
18634
  * This event fires when a projectile hits an entity.
18387
18635
  *
18636
+ * This property can be read in early-execution mode.
18637
+ *
18388
18638
  */
18389
18639
  readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
18390
18640
  /**
18391
18641
  * @remarks
18392
18642
  * A target block was hit.
18393
18643
  *
18644
+ * This property can be read in early-execution mode.
18645
+ *
18394
18646
  */
18395
18647
  readonly targetBlockHit: TargetBlockHitAfterEventSignal;
18396
18648
  /**
18397
18649
  * @remarks
18398
18650
  * A trip wire was tripped.
18399
18651
  *
18652
+ * This property can be read in early-execution mode.
18653
+ *
18400
18654
  */
18401
18655
  readonly tripWireTrip: TripWireTripAfterEventSignal;
18402
18656
  /**
@@ -18404,10 +18658,15 @@ export class WorldAfterEvents {
18404
18658
  * This event will be triggered when the weather changes within
18405
18659
  * Minecraft.
18406
18660
  *
18661
+ * This property can be read in early-execution mode.
18662
+ *
18407
18663
  */
18408
18664
  readonly weatherChange: WeatherChangeAfterEventSignal;
18409
18665
  /**
18410
18666
  * @beta
18667
+ * @remarks
18668
+ * This property can be read in early-execution mode.
18669
+ *
18411
18670
  */
18412
18671
  readonly worldLoad: WorldLoadAfterEventSignal;
18413
18672
  }
@@ -18427,6 +18686,8 @@ export class WorldBeforeEvents {
18427
18686
  * This event is triggered after a chat message has been
18428
18687
  * broadcast or sent to players.
18429
18688
  *
18689
+ * This property can be read in early-execution mode.
18690
+ *
18430
18691
  * @example customCommand.ts
18431
18692
  * ```typescript
18432
18693
  * import { world, DimensionLocation } from "@minecraft/server";
@@ -18461,6 +18722,8 @@ export class WorldBeforeEvents {
18461
18722
  * This event is triggered after an event has been added to an
18462
18723
  * entity.
18463
18724
  *
18725
+ * This property can be read in early-execution mode.
18726
+ *
18464
18727
  */
18465
18728
  readonly effectAdd: EffectAddBeforeEventSignal;
18466
18729
  /**
@@ -18468,12 +18731,16 @@ export class WorldBeforeEvents {
18468
18731
  * Fires before an entity is removed from the world (for
18469
18732
  * example, unloaded or removed after being killed.)
18470
18733
  *
18734
+ * This property can be read in early-execution mode.
18735
+ *
18471
18736
  */
18472
18737
  readonly entityRemove: EntityRemoveBeforeEventSignal;
18473
18738
  /**
18474
18739
  * @remarks
18475
18740
  * This event is fired after an explosion occurs.
18476
18741
  *
18742
+ * This property can be read in early-execution mode.
18743
+ *
18477
18744
  */
18478
18745
  readonly explosion: ExplosionBeforeEventSignal;
18479
18746
  /**
@@ -18481,6 +18748,8 @@ export class WorldBeforeEvents {
18481
18748
  * This event fires when an item is successfully used by a
18482
18749
  * player.
18483
18750
  *
18751
+ * This property can be read in early-execution mode.
18752
+ *
18484
18753
  */
18485
18754
  readonly itemUse: ItemUseBeforeEventSignal;
18486
18755
  /**
@@ -18488,31 +18757,46 @@ export class WorldBeforeEvents {
18488
18757
  * This event fires when an item is used on a block by a
18489
18758
  * player.
18490
18759
  *
18760
+ * This property can be read in early-execution mode.
18761
+ *
18491
18762
  */
18492
18763
  readonly itemUseOn: ItemUseOnBeforeEventSignal;
18493
18764
  /**
18494
18765
  * @remarks
18495
18766
  * This event fires before a block is broken by a player.
18496
18767
  *
18768
+ * This property can be read in early-execution mode.
18769
+ *
18497
18770
  */
18498
18771
  readonly playerBreakBlock: PlayerBreakBlockBeforeEventSignal;
18772
+ /**
18773
+ * @remarks
18774
+ * This property can be read in early-execution mode.
18775
+ *
18776
+ */
18499
18777
  readonly playerGameModeChange: PlayerGameModeChangeBeforeEventSignal;
18500
18778
  /**
18501
18779
  * @remarks
18502
18780
  * Fires before a player interacts with a block.
18503
18781
  *
18782
+ * This property can be read in early-execution mode.
18783
+ *
18504
18784
  */
18505
18785
  readonly playerInteractWithBlock: PlayerInteractWithBlockBeforeEventSignal;
18506
18786
  /**
18507
18787
  * @remarks
18508
18788
  * Fires before a player interacts with an entity.
18509
18789
  *
18790
+ * This property can be read in early-execution mode.
18791
+ *
18510
18792
  */
18511
18793
  readonly playerInteractWithEntity: PlayerInteractWithEntityBeforeEventSignal;
18512
18794
  /**
18513
18795
  * @remarks
18514
18796
  * Fires when a player leaves the game.
18515
18797
  *
18798
+ * This property can be read in early-execution mode.
18799
+ *
18516
18800
  */
18517
18801
  readonly playerLeave: PlayerLeaveBeforeEventSignal;
18518
18802
  /**
@@ -18520,8 +18804,15 @@ export class WorldBeforeEvents {
18520
18804
  * @remarks
18521
18805
  * This event fires before a block is placed by a player.
18522
18806
  *
18807
+ * This property can be read in early-execution mode.
18808
+ *
18523
18809
  */
18524
18810
  readonly playerPlaceBlock: PlayerPlaceBlockBeforeEventSignal;
18811
+ /**
18812
+ * @remarks
18813
+ * This property can be read in early-execution mode.
18814
+ *
18815
+ */
18525
18816
  readonly weatherChange: WeatherChangeBeforeEventSignal;
18526
18817
  }
18527
18818
 
@@ -18914,14 +19205,22 @@ export interface CameraFadeTimeOptions {
18914
19205
  }
18915
19206
 
18916
19207
  /**
18917
- * @beta
18918
- *
18919
- * Required Experiments:
18920
- * - Third Person Cameras
18921
- *
19208
+ * Options to control pivot points and offsets of the third
19209
+ * person boom preset.
18922
19210
  */
18923
19211
  export interface CameraFixedBoomOptions {
19212
+ /**
19213
+ * @remarks
19214
+ * Changes the pivot point to be <x, y, z> away from the
19215
+ * player.
19216
+ *
19217
+ */
18924
19218
  entityOffset?: Vector3;
19219
+ /**
19220
+ * @remarks
19221
+ * Offsets the camera from center by <x, y>.
19222
+ *
19223
+ */
18925
19224
  viewOffset?: Vector2;
18926
19225
  }
18927
19226
 
@@ -20686,6 +20985,11 @@ export class CustomComponentInvalidRegistryError extends Error {
20686
20985
  // @ts-ignore Class inheritance allowed for native defined classes
20687
20986
  export class CustomComponentNameError extends Error {
20688
20987
  private constructor();
20988
+ /**
20989
+ * @remarks
20990
+ * This property can be read in early-execution mode.
20991
+ *
20992
+ */
20689
20993
  reason: CustomComponentNameErrorReason;
20690
20994
  }
20691
20995
 
@@ -20724,12 +21028,16 @@ export class InvalidEntityError extends Error {
20724
21028
  * @remarks
20725
21029
  * The id of the entity that is now invalid.
20726
21030
  *
21031
+ * This property can be read in early-execution mode.
21032
+ *
20727
21033
  */
20728
21034
  id: string;
20729
21035
  /**
20730
21036
  * @remarks
20731
21037
  * The type of the entity that is now invalid.
20732
21038
  *
21039
+ * This property can be read in early-execution mode.
21040
+ *
20733
21041
  */
20734
21042
  type: string;
20735
21043
  }
@@ -20812,6 +21120,11 @@ export class LocationOutOfWorldBoundariesError extends Error {
20812
21120
  // @ts-ignore Class inheritance allowed for native defined classes
20813
21121
  export class NamespaceNameError extends Error {
20814
21122
  private constructor();
21123
+ /**
21124
+ * @remarks
21125
+ * This property can be read in early-execution mode.
21126
+ *
21127
+ */
20815
21128
  reason: NamespaceNameErrorReason;
20816
21129
  }
20817
21130
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server",
3
- "version": "2.0.0-beta.1.21.70-preview.23",
3
+ "version": "2.0.0-beta.1.21.70-preview.24",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {