@minecraft/server 2.0.0-beta.1.21.70-preview.22 → 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.
- package/index.d.ts +329 -76
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -1677,7 +1677,6 @@ export enum InputButton {
|
|
|
1677
1677
|
}
|
|
1678
1678
|
|
|
1679
1679
|
/**
|
|
1680
|
-
* @rc
|
|
1681
1680
|
* Describes the type of input of a device.
|
|
1682
1681
|
*/
|
|
1683
1682
|
export enum InputMode {
|
|
@@ -1729,7 +1728,6 @@ export enum InputPermissionCategory {
|
|
|
1729
1728
|
*/
|
|
1730
1729
|
Movement = 2,
|
|
1731
1730
|
/**
|
|
1732
|
-
* @rc
|
|
1733
1731
|
* @remarks
|
|
1734
1732
|
* Player input for moving laterally in the world. This would
|
|
1735
1733
|
* be WASD on a keyboard or the movement joystick on gamepad or
|
|
@@ -1738,7 +1736,6 @@ export enum InputPermissionCategory {
|
|
|
1738
1736
|
*/
|
|
1739
1737
|
LateralMovement = 4,
|
|
1740
1738
|
/**
|
|
1741
|
-
* @rc
|
|
1742
1739
|
* @remarks
|
|
1743
1740
|
* Player input relating to sneak. This also affects flying
|
|
1744
1741
|
* down.
|
|
@@ -1746,7 +1743,6 @@ export enum InputPermissionCategory {
|
|
|
1746
1743
|
*/
|
|
1747
1744
|
Sneak = 5,
|
|
1748
1745
|
/**
|
|
1749
|
-
* @rc
|
|
1750
1746
|
* @remarks
|
|
1751
1747
|
* Player input relating to jumping. This also affects flying
|
|
1752
1748
|
* up.
|
|
@@ -1754,14 +1750,12 @@ export enum InputPermissionCategory {
|
|
|
1754
1750
|
*/
|
|
1755
1751
|
Jump = 6,
|
|
1756
1752
|
/**
|
|
1757
|
-
* @rc
|
|
1758
1753
|
* @remarks
|
|
1759
1754
|
* Player input relating to mounting vehicles.
|
|
1760
1755
|
*
|
|
1761
1756
|
*/
|
|
1762
1757
|
Mount = 7,
|
|
1763
1758
|
/**
|
|
1764
|
-
* @rc
|
|
1765
1759
|
* @remarks
|
|
1766
1760
|
* Player input relating to dismounting. When disabled, the
|
|
1767
1761
|
* player can still dismount vehicles by other means, for
|
|
@@ -1771,28 +1765,24 @@ export enum InputPermissionCategory {
|
|
|
1771
1765
|
*/
|
|
1772
1766
|
Dismount = 8,
|
|
1773
1767
|
/**
|
|
1774
|
-
* @rc
|
|
1775
1768
|
* @remarks
|
|
1776
1769
|
* Player input relating to moving the player forward.
|
|
1777
1770
|
*
|
|
1778
1771
|
*/
|
|
1779
1772
|
MoveForward = 9,
|
|
1780
1773
|
/**
|
|
1781
|
-
* @rc
|
|
1782
1774
|
* @remarks
|
|
1783
1775
|
* Player input relating to moving the player backward.
|
|
1784
1776
|
*
|
|
1785
1777
|
*/
|
|
1786
1778
|
MoveBackward = 10,
|
|
1787
1779
|
/**
|
|
1788
|
-
* @rc
|
|
1789
1780
|
* @remarks
|
|
1790
1781
|
* Player input relating to moving the player left.
|
|
1791
1782
|
*
|
|
1792
1783
|
*/
|
|
1793
1784
|
MoveLeft = 11,
|
|
1794
1785
|
/**
|
|
1795
|
-
* @rc
|
|
1796
1786
|
* @remarks
|
|
1797
1787
|
* Player input relating to moving the player right.
|
|
1798
1788
|
*
|
|
@@ -1805,9 +1795,6 @@ export enum InputPermissionCategory {
|
|
|
1805
1795
|
* function ItemStack.getComponent.
|
|
1806
1796
|
*/
|
|
1807
1797
|
export enum ItemComponentTypes {
|
|
1808
|
-
/**
|
|
1809
|
-
* @rc
|
|
1810
|
-
*/
|
|
1811
1798
|
Compostable = 'minecraft:compostable',
|
|
1812
1799
|
/**
|
|
1813
1800
|
* @remarks
|
|
@@ -1869,7 +1856,7 @@ export enum ItemLockMode {
|
|
|
1869
1856
|
}
|
|
1870
1857
|
|
|
1871
1858
|
/**
|
|
1872
|
-
* @
|
|
1859
|
+
* @rc
|
|
1873
1860
|
* Represents the type of liquid that can be placed on a block
|
|
1874
1861
|
* or flow dynamically in the world.
|
|
1875
1862
|
*/
|
|
@@ -2392,6 +2379,7 @@ export enum TimeOfDay {
|
|
|
2392
2379
|
export enum TintMethod {
|
|
2393
2380
|
BirchFoliage = 'BirchFoliage',
|
|
2394
2381
|
DefaultFoliage = 'DefaultFoliage',
|
|
2382
|
+
DryFoliage = 'DryFoliage',
|
|
2395
2383
|
EvergreenFoliage = 'EvergreenFoliage',
|
|
2396
2384
|
Grass = 'Grass',
|
|
2397
2385
|
None = 'None',
|
|
@@ -2639,10 +2627,6 @@ export type ItemComponentTypeMap = {
|
|
|
2639
2627
|
* @beta
|
|
2640
2628
|
* Handle to an aim-assist category that exists in the
|
|
2641
2629
|
* world.aimAssist registry.
|
|
2642
|
-
*
|
|
2643
|
-
* Required Experiments:
|
|
2644
|
-
* - Camera Aim Assist
|
|
2645
|
-
*
|
|
2646
2630
|
*/
|
|
2647
2631
|
export class AimAssistCategory {
|
|
2648
2632
|
private constructor();
|
|
@@ -2702,10 +2686,6 @@ export class AimAssistCategory {
|
|
|
2702
2686
|
* @beta
|
|
2703
2687
|
* Settings used with AimAssistRegistry.addCategory for
|
|
2704
2688
|
* creation of the AimAssistCategory.
|
|
2705
|
-
*
|
|
2706
|
-
* Required Experiments:
|
|
2707
|
-
* - Camera Aim Assist
|
|
2708
|
-
*
|
|
2709
2689
|
*/
|
|
2710
2690
|
export class AimAssistCategorySettings {
|
|
2711
2691
|
/**
|
|
@@ -2738,6 +2718,8 @@ export class AimAssistCategorySettings {
|
|
|
2738
2718
|
* Constructor that takes a unique Id to associate with the
|
|
2739
2719
|
* created AimAssistCategory. Must have a namespace.
|
|
2740
2720
|
*
|
|
2721
|
+
* This function can't be called in read-only mode.
|
|
2722
|
+
*
|
|
2741
2723
|
*/
|
|
2742
2724
|
constructor(identifier: string);
|
|
2743
2725
|
/**
|
|
@@ -2762,6 +2744,8 @@ export class AimAssistCategorySettings {
|
|
|
2762
2744
|
* @remarks
|
|
2763
2745
|
* Sets the priority settings used for block targeting.
|
|
2764
2746
|
*
|
|
2747
|
+
* This function can't be called in read-only mode.
|
|
2748
|
+
*
|
|
2765
2749
|
* @param blockPriorities
|
|
2766
2750
|
* A record mapping block Ids to their priority settings.
|
|
2767
2751
|
* Larger numbers have greater priority.
|
|
@@ -2773,6 +2757,8 @@ export class AimAssistCategorySettings {
|
|
|
2773
2757
|
* @remarks
|
|
2774
2758
|
* Sets the priority settings used for entity targeting.
|
|
2775
2759
|
*
|
|
2760
|
+
* This function can't be called in read-only mode.
|
|
2761
|
+
*
|
|
2776
2762
|
* @param entityPriorities
|
|
2777
2763
|
* A record mapping entity Ids to their priority settings.
|
|
2778
2764
|
* Larger numbers have greater priority.
|
|
@@ -2786,10 +2772,6 @@ export class AimAssistCategorySettings {
|
|
|
2786
2772
|
* @beta
|
|
2787
2773
|
* Handle to an aim-assist preset that exists in the
|
|
2788
2774
|
* world.aimAssist registry.
|
|
2789
|
-
*
|
|
2790
|
-
* Required Experiments:
|
|
2791
|
-
* - Camera Aim Assist
|
|
2792
|
-
*
|
|
2793
2775
|
*/
|
|
2794
2776
|
export class AimAssistPreset {
|
|
2795
2777
|
private constructor();
|
|
@@ -2859,10 +2841,6 @@ export class AimAssistPreset {
|
|
|
2859
2841
|
* @beta
|
|
2860
2842
|
* Settings used with AimAssistRegistry.addPreset for creation
|
|
2861
2843
|
* of the AimAssistPreset.
|
|
2862
|
-
*
|
|
2863
|
-
* Required Experiments:
|
|
2864
|
-
* - Camera Aim Assist
|
|
2865
|
-
*
|
|
2866
2844
|
*/
|
|
2867
2845
|
export class AimAssistPresetSettings {
|
|
2868
2846
|
/**
|
|
@@ -2894,6 +2872,8 @@ export class AimAssistPresetSettings {
|
|
|
2894
2872
|
* Constructor that takes a unique Id to associate with the
|
|
2895
2873
|
* created AimAssistPreset. Must have a namespace.
|
|
2896
2874
|
*
|
|
2875
|
+
* This function can't be called in read-only mode.
|
|
2876
|
+
*
|
|
2897
2877
|
*/
|
|
2898
2878
|
constructor(identifier: string);
|
|
2899
2879
|
/**
|
|
@@ -2927,6 +2907,8 @@ export class AimAssistPresetSettings {
|
|
|
2927
2907
|
* Sets the list of block/entity Ids to exclude from aim assist
|
|
2928
2908
|
* targeting.
|
|
2929
2909
|
*
|
|
2910
|
+
* This function can't be called in read-only mode.
|
|
2911
|
+
*
|
|
2930
2912
|
* @param targets
|
|
2931
2913
|
* An array of block/entity Ids.
|
|
2932
2914
|
*/
|
|
@@ -2941,6 +2923,8 @@ export class AimAssistPresetSettings {
|
|
|
2941
2923
|
* @remarks
|
|
2942
2924
|
* Sets the per-item aim-assist category Ids.
|
|
2943
2925
|
*
|
|
2926
|
+
* This function can't be called in read-only mode.
|
|
2927
|
+
*
|
|
2944
2928
|
* @param itemSettings
|
|
2945
2929
|
* A record mapping item Ids to aim-assist category Ids.
|
|
2946
2930
|
* Category Ids must have a namespace.
|
|
@@ -2951,6 +2935,8 @@ export class AimAssistPresetSettings {
|
|
|
2951
2935
|
* Sets the list of item Ids that will target liquid blocks
|
|
2952
2936
|
* with aim-assist when being held.
|
|
2953
2937
|
*
|
|
2938
|
+
* This function can't be called in read-only mode.
|
|
2939
|
+
*
|
|
2954
2940
|
* @param items
|
|
2955
2941
|
* An array of item Ids.
|
|
2956
2942
|
*/
|
|
@@ -2961,10 +2947,6 @@ export class AimAssistPresetSettings {
|
|
|
2961
2947
|
* @beta
|
|
2962
2948
|
* A container for APIs related to the world's aim-assist
|
|
2963
2949
|
* settings.
|
|
2964
|
-
*
|
|
2965
|
-
* Required Experiments:
|
|
2966
|
-
* - Camera Aim Assist
|
|
2967
|
-
*
|
|
2968
2950
|
*/
|
|
2969
2951
|
export class AimAssistRegistry {
|
|
2970
2952
|
private constructor();
|
|
@@ -3163,7 +3145,6 @@ export class Block {
|
|
|
3163
3145
|
*/
|
|
3164
3146
|
readonly isValid: boolean;
|
|
3165
3147
|
/**
|
|
3166
|
-
* @rc
|
|
3167
3148
|
* @remarks
|
|
3168
3149
|
* Returns or sets whether this block has water on it.
|
|
3169
3150
|
*
|
|
@@ -3271,7 +3252,7 @@ export class Block {
|
|
|
3271
3252
|
*/
|
|
3272
3253
|
bottomCenter(): Vector3;
|
|
3273
3254
|
/**
|
|
3274
|
-
* @
|
|
3255
|
+
* @rc
|
|
3275
3256
|
* @remarks
|
|
3276
3257
|
* Returns whether this block is removed when touched by
|
|
3277
3258
|
* liquid.
|
|
@@ -3290,7 +3271,7 @@ export class Block {
|
|
|
3290
3271
|
*/
|
|
3291
3272
|
canBeDestroyedByLiquidSpread(liquidType: LiquidType): boolean;
|
|
3292
3273
|
/**
|
|
3293
|
-
* @
|
|
3274
|
+
* @rc
|
|
3294
3275
|
* @remarks
|
|
3295
3276
|
* Returns whether this block can have a liquid placed over it,
|
|
3296
3277
|
* i.e. be waterlogged.
|
|
@@ -3359,6 +3340,8 @@ export class Block {
|
|
|
3359
3340
|
* for a block - for example, an inventory component of a chest
|
|
3360
3341
|
* block.
|
|
3361
3342
|
*
|
|
3343
|
+
* This function can't be called in read-only mode.
|
|
3344
|
+
*
|
|
3362
3345
|
* @param componentId
|
|
3363
3346
|
* The identifier of the component (e.g.,
|
|
3364
3347
|
* 'minecraft:inventory'). If no namespace prefix is specified,
|
|
@@ -3465,7 +3448,7 @@ export class Block {
|
|
|
3465
3448
|
*/
|
|
3466
3449
|
hasTag(tag: string): boolean;
|
|
3467
3450
|
/**
|
|
3468
|
-
* @
|
|
3451
|
+
* @rc
|
|
3469
3452
|
* @remarks
|
|
3470
3453
|
* Returns whether this block stops liquid from flowing.
|
|
3471
3454
|
*
|
|
@@ -3483,7 +3466,18 @@ export class Block {
|
|
|
3483
3466
|
*/
|
|
3484
3467
|
isLiquidBlocking(liquidType: LiquidType): boolean;
|
|
3485
3468
|
/**
|
|
3486
|
-
* @
|
|
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
|
|
3487
3481
|
* @throws This function can throw errors.
|
|
3488
3482
|
*
|
|
3489
3483
|
* {@link Error}
|
|
@@ -3494,7 +3488,7 @@ export class Block {
|
|
|
3494
3488
|
*/
|
|
3495
3489
|
liquidCanFlowFromDirection(liquidType: LiquidType, flowDirection: Direction): boolean;
|
|
3496
3490
|
/**
|
|
3497
|
-
* @
|
|
3491
|
+
* @rc
|
|
3498
3492
|
* @remarks
|
|
3499
3493
|
* Returns whether this block is removed and spawns its item
|
|
3500
3494
|
* when touched by liquid.
|
|
@@ -3598,7 +3592,6 @@ export class Block {
|
|
|
3598
3592
|
*/
|
|
3599
3593
|
setType(blockType: BlockType | string): void;
|
|
3600
3594
|
/**
|
|
3601
|
-
* @rc
|
|
3602
3595
|
* @remarks
|
|
3603
3596
|
* Sets whether this block has a water logged state - for
|
|
3604
3597
|
* example, whether stairs are submerged within water.
|
|
@@ -4192,7 +4185,7 @@ export class BlockPermutation {
|
|
|
4192
4185
|
*/
|
|
4193
4186
|
readonly 'type': BlockType;
|
|
4194
4187
|
/**
|
|
4195
|
-
* @
|
|
4188
|
+
* @rc
|
|
4196
4189
|
* @remarks
|
|
4197
4190
|
* Returns whether this block is removed when touched by
|
|
4198
4191
|
* liquid.
|
|
@@ -4207,7 +4200,7 @@ export class BlockPermutation {
|
|
|
4207
4200
|
*/
|
|
4208
4201
|
canBeDestroyedByLiquidSpread(liquidType: LiquidType): boolean;
|
|
4209
4202
|
/**
|
|
4210
|
-
* @
|
|
4203
|
+
* @rc
|
|
4211
4204
|
* @remarks
|
|
4212
4205
|
* Returns whether this block can have a liquid placed over it,
|
|
4213
4206
|
* i.e. be waterlogged.
|
|
@@ -4246,6 +4239,8 @@ export class BlockPermutation {
|
|
|
4246
4239
|
* @remarks
|
|
4247
4240
|
* Gets a state for the permutation.
|
|
4248
4241
|
*
|
|
4242
|
+
* This function can't be called in read-only mode.
|
|
4243
|
+
*
|
|
4249
4244
|
* @param stateName
|
|
4250
4245
|
* Name of the block state who's value is to be returned.
|
|
4251
4246
|
* @returns
|
|
@@ -4286,7 +4281,7 @@ export class BlockPermutation {
|
|
|
4286
4281
|
*/
|
|
4287
4282
|
hasTag(tag: string): boolean;
|
|
4288
4283
|
/**
|
|
4289
|
-
* @
|
|
4284
|
+
* @rc
|
|
4290
4285
|
* @remarks
|
|
4291
4286
|
* Returns whether this block stops liquid from flowing.
|
|
4292
4287
|
*
|
|
@@ -4300,7 +4295,7 @@ export class BlockPermutation {
|
|
|
4300
4295
|
*/
|
|
4301
4296
|
isLiquidBlocking(liquidType: LiquidType): boolean;
|
|
4302
4297
|
/**
|
|
4303
|
-
* @
|
|
4298
|
+
* @rc
|
|
4304
4299
|
* @remarks
|
|
4305
4300
|
* Returns whether this block is removed and spawns its item
|
|
4306
4301
|
* when touched by liquid.
|
|
@@ -4321,6 +4316,8 @@ export class BlockPermutation {
|
|
|
4321
4316
|
* this permutation. If states is not specified, matches checks
|
|
4322
4317
|
* against the set of types more broadly.
|
|
4323
4318
|
*
|
|
4319
|
+
* This function can't be called in read-only mode.
|
|
4320
|
+
*
|
|
4324
4321
|
* @param blockName
|
|
4325
4322
|
* An optional set of states to compare against.
|
|
4326
4323
|
*/
|
|
@@ -4333,6 +4330,8 @@ export class BlockPermutation {
|
|
|
4333
4330
|
* Returns a derived BlockPermutation with a specific property
|
|
4334
4331
|
* set.
|
|
4335
4332
|
*
|
|
4333
|
+
* This function can't be called in read-only mode.
|
|
4334
|
+
*
|
|
4336
4335
|
* @param name
|
|
4337
4336
|
* Identifier of the block property.
|
|
4338
4337
|
* @param value
|
|
@@ -4349,6 +4348,8 @@ export class BlockPermutation {
|
|
|
4349
4348
|
* will return a BlockPermutation object that is usable in
|
|
4350
4349
|
* other block APIs (e.g., block.setPermutation)
|
|
4351
4350
|
*
|
|
4351
|
+
* This function can't be called in read-only mode.
|
|
4352
|
+
*
|
|
4352
4353
|
* @param blockName
|
|
4353
4354
|
* Identifier of the block to check.
|
|
4354
4355
|
* @throws This function can throw errors.
|
|
@@ -4844,6 +4845,11 @@ export class BlockVolume extends BlockVolumeBase {
|
|
|
4844
4845
|
*
|
|
4845
4846
|
*/
|
|
4846
4847
|
to: Vector3;
|
|
4848
|
+
/**
|
|
4849
|
+
* @remarks
|
|
4850
|
+
* This function can't be called in read-only mode.
|
|
4851
|
+
*
|
|
4852
|
+
*/
|
|
4847
4853
|
constructor(from: Vector3, to: Vector3);
|
|
4848
4854
|
/**
|
|
4849
4855
|
* @remarks
|
|
@@ -5501,6 +5507,8 @@ export class CompoundBlockVolume {
|
|
|
5501
5507
|
* @remarks
|
|
5502
5508
|
* Create a CompoundBlockVolume object
|
|
5503
5509
|
*
|
|
5510
|
+
* This function can't be called in read-only mode.
|
|
5511
|
+
*
|
|
5504
5512
|
* @param origin
|
|
5505
5513
|
* An optional world space origin on which to center the
|
|
5506
5514
|
* compound volume.
|
|
@@ -7421,6 +7429,9 @@ export class EnchantmentType {
|
|
|
7421
7429
|
*/
|
|
7422
7430
|
readonly maxLevel: number;
|
|
7423
7431
|
/**
|
|
7432
|
+
* @remarks
|
|
7433
|
+
* This function can't be called in read-only mode.
|
|
7434
|
+
*
|
|
7424
7435
|
* @throws This function can throw errors.
|
|
7425
7436
|
*/
|
|
7426
7437
|
constructor(enchantmentType: string);
|
|
@@ -7881,6 +7892,8 @@ export class Entity {
|
|
|
7881
7892
|
* Gets a component (that represents additional capabilities)
|
|
7882
7893
|
* for an entity.
|
|
7883
7894
|
*
|
|
7895
|
+
* This function can't be called in read-only mode.
|
|
7896
|
+
*
|
|
7884
7897
|
* @param componentId
|
|
7885
7898
|
* The identifier of the component (e.g., 'minecraft:health').
|
|
7886
7899
|
* If no namespace prefix is specified, 'minecraft:' is
|
|
@@ -11553,7 +11566,6 @@ export class GameRules {
|
|
|
11553
11566
|
}
|
|
11554
11567
|
|
|
11555
11568
|
/**
|
|
11556
|
-
* @rc
|
|
11557
11569
|
* Contains the input information for a client instance.
|
|
11558
11570
|
*/
|
|
11559
11571
|
export class InputInfo {
|
|
@@ -11888,7 +11900,6 @@ export class ItemComponentUseOnEvent extends ItemUseOnEvent {
|
|
|
11888
11900
|
}
|
|
11889
11901
|
|
|
11890
11902
|
/**
|
|
11891
|
-
* @rc
|
|
11892
11903
|
* When present, the item can be composted in the composter
|
|
11893
11904
|
* block if the composting chance is in the range [1 - 100].
|
|
11894
11905
|
*/
|
|
@@ -12522,6 +12533,8 @@ export class ItemStack {
|
|
|
12522
12533
|
* Creates a new instance of a stack of items for use in the
|
|
12523
12534
|
* world.
|
|
12524
12535
|
*
|
|
12536
|
+
* This function can't be called in read-only mode.
|
|
12537
|
+
*
|
|
12525
12538
|
* @param itemType
|
|
12526
12539
|
* Type of item to create. See the {@link
|
|
12527
12540
|
* @minecraft/vanilla-data.MinecraftItemTypes} enumeration for
|
|
@@ -12575,6 +12588,8 @@ export class ItemStack {
|
|
|
12575
12588
|
* Gets a component (that represents additional capabilities)
|
|
12576
12589
|
* for an item stack.
|
|
12577
12590
|
*
|
|
12591
|
+
* This function can't be called in read-only mode.
|
|
12592
|
+
*
|
|
12578
12593
|
* @param componentId
|
|
12579
12594
|
* The identifier of the component (e.g., 'minecraft:food'). If
|
|
12580
12595
|
* no namespace prefix is specified, 'minecraft:' is assumed.
|
|
@@ -13515,6 +13530,8 @@ export class ListBlockVolume extends BlockVolumeBase {
|
|
|
13515
13530
|
* @remarks
|
|
13516
13531
|
* Creates a new instance of ListBlockVolume.
|
|
13517
13532
|
*
|
|
13533
|
+
* This function can't be called in read-only mode.
|
|
13534
|
+
*
|
|
13518
13535
|
* @param locations
|
|
13519
13536
|
* Initial array of block locations that ListBlockVolume will
|
|
13520
13537
|
* be constructed with.
|
|
@@ -13793,7 +13810,6 @@ export class Player extends Entity {
|
|
|
13793
13810
|
*/
|
|
13794
13811
|
readonly graphicsMode: GraphicsMode;
|
|
13795
13812
|
/**
|
|
13796
|
-
* @rc
|
|
13797
13813
|
* @remarks
|
|
13798
13814
|
* Contains the player's input information.
|
|
13799
13815
|
*
|
|
@@ -13908,6 +13924,22 @@ export class Player extends Entity {
|
|
|
13908
13924
|
* @throws This function can throw errors.
|
|
13909
13925
|
*/
|
|
13910
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;
|
|
13911
13943
|
/**
|
|
13912
13944
|
* @beta
|
|
13913
13945
|
* @remarks
|
|
@@ -13927,10 +13959,6 @@ export class Player extends Entity {
|
|
|
13927
13959
|
* @remarks
|
|
13928
13960
|
* The player's aim-assist settings.
|
|
13929
13961
|
*
|
|
13930
|
-
*
|
|
13931
|
-
* Required Experiments:
|
|
13932
|
-
* - Camera Aim Assist
|
|
13933
|
-
*
|
|
13934
13962
|
*/
|
|
13935
13963
|
getAimAssist(): PlayerAimAssist;
|
|
13936
13964
|
/**
|
|
@@ -14055,6 +14083,26 @@ export class Player extends Entity {
|
|
|
14055
14083
|
*
|
|
14056
14084
|
*/
|
|
14057
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;
|
|
14058
14106
|
/**
|
|
14059
14107
|
* @remarks
|
|
14060
14108
|
* Resets the level of the player.
|
|
@@ -14172,6 +14220,34 @@ export class Player extends Entity {
|
|
|
14172
14220
|
* @throws This function can throw errors.
|
|
14173
14221
|
*/
|
|
14174
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;
|
|
14175
14251
|
/**
|
|
14176
14252
|
* @remarks
|
|
14177
14253
|
* Sets the current starting spawn point for this particular
|
|
@@ -14187,7 +14263,7 @@ export class Player extends Entity {
|
|
|
14187
14263
|
*/
|
|
14188
14264
|
setSpawnPoint(spawnPoint?: DimensionLocation): void;
|
|
14189
14265
|
/**
|
|
14190
|
-
* @
|
|
14266
|
+
* @rc
|
|
14191
14267
|
* @remarks
|
|
14192
14268
|
* Creates a new particle emitter at a specified location in
|
|
14193
14269
|
* the world. Only visible to the target player.
|
|
@@ -14264,10 +14340,6 @@ export class Player extends Entity {
|
|
|
14264
14340
|
/**
|
|
14265
14341
|
* @beta
|
|
14266
14342
|
* A container for APIs related to player aim-assist.
|
|
14267
|
-
*
|
|
14268
|
-
* Required Experiments:
|
|
14269
|
-
* - Camera Aim Assist
|
|
14270
|
-
*
|
|
14271
14343
|
*/
|
|
14272
14344
|
export class PlayerAimAssist {
|
|
14273
14345
|
private constructor();
|
|
@@ -14738,7 +14810,6 @@ export class PlayerGameModeChangeBeforeEventSignal {
|
|
|
14738
14810
|
}
|
|
14739
14811
|
|
|
14740
14812
|
/**
|
|
14741
|
-
* @rc
|
|
14742
14813
|
* Event data for when a player input mode changes.
|
|
14743
14814
|
*/
|
|
14744
14815
|
export class PlayerInputModeChangeAfterEvent {
|
|
@@ -14764,7 +14835,6 @@ export class PlayerInputModeChangeAfterEvent {
|
|
|
14764
14835
|
}
|
|
14765
14836
|
|
|
14766
14837
|
/**
|
|
14767
|
-
* @rc
|
|
14768
14838
|
* Manages callbacks that are connected to player input mode.
|
|
14769
14839
|
*/
|
|
14770
14840
|
export class PlayerInputModeChangeAfterEventSignal {
|
|
@@ -14859,7 +14929,6 @@ export class PlayerInputPermissionCategoryChangeAfterEventSignal {
|
|
|
14859
14929
|
export class PlayerInputPermissions {
|
|
14860
14930
|
private constructor();
|
|
14861
14931
|
/**
|
|
14862
|
-
* @rc
|
|
14863
14932
|
* @remarks
|
|
14864
14933
|
* Returns true if an input permission is enabled.
|
|
14865
14934
|
*
|
|
@@ -14871,7 +14940,6 @@ export class PlayerInputPermissions {
|
|
|
14871
14940
|
*/
|
|
14872
14941
|
isPermissionCategoryEnabled(permissionCategory: InputPermissionCategory): boolean;
|
|
14873
14942
|
/**
|
|
14874
|
-
* @rc
|
|
14875
14943
|
* @remarks
|
|
14876
14944
|
* Enable or disable an input permission. When enabled the
|
|
14877
14945
|
* input will work, when disabled will not work.
|
|
@@ -16631,7 +16699,17 @@ export class StartupBeforeEventSignal {
|
|
|
16631
16699
|
*/
|
|
16632
16700
|
export class StartupEvent {
|
|
16633
16701
|
private constructor();
|
|
16702
|
+
/**
|
|
16703
|
+
* @remarks
|
|
16704
|
+
* This property can be read in early-execution mode.
|
|
16705
|
+
*
|
|
16706
|
+
*/
|
|
16634
16707
|
readonly blockComponentRegistry: BlockComponentRegistry;
|
|
16708
|
+
/**
|
|
16709
|
+
* @remarks
|
|
16710
|
+
* This property can be read in early-execution mode.
|
|
16711
|
+
*
|
|
16712
|
+
*/
|
|
16635
16713
|
readonly itemComponentRegistry: ItemComponentRegistry;
|
|
16636
16714
|
}
|
|
16637
16715
|
|
|
@@ -17005,6 +17083,8 @@ export class System {
|
|
|
17005
17083
|
* Returns a collection of after-events for system-level
|
|
17006
17084
|
* operations.
|
|
17007
17085
|
*
|
|
17086
|
+
* This property can be read in early-execution mode.
|
|
17087
|
+
*
|
|
17008
17088
|
*/
|
|
17009
17089
|
readonly afterEvents: SystemAfterEvents;
|
|
17010
17090
|
/**
|
|
@@ -17013,12 +17093,16 @@ export class System {
|
|
|
17013
17093
|
* Returns a collection of before-events for system-level
|
|
17014
17094
|
* operations.
|
|
17015
17095
|
*
|
|
17096
|
+
* This property can be read in early-execution mode.
|
|
17097
|
+
*
|
|
17016
17098
|
*/
|
|
17017
17099
|
readonly beforeEvents: SystemBeforeEvents;
|
|
17018
17100
|
/**
|
|
17019
17101
|
* @remarks
|
|
17020
17102
|
* Represents the current world tick of the server.
|
|
17021
17103
|
*
|
|
17104
|
+
* This property can be read in early-execution mode.
|
|
17105
|
+
*
|
|
17022
17106
|
*/
|
|
17023
17107
|
readonly currentTick: number;
|
|
17024
17108
|
/**
|
|
@@ -17027,12 +17111,16 @@ export class System {
|
|
|
17027
17111
|
* Returns true if this is a world where the editor is
|
|
17028
17112
|
* currently loaded, returns false otherwise.
|
|
17029
17113
|
*
|
|
17114
|
+
* This property can be read in early-execution mode.
|
|
17115
|
+
*
|
|
17030
17116
|
*/
|
|
17031
17117
|
readonly isEditorWorld: boolean;
|
|
17032
17118
|
/**
|
|
17033
17119
|
* @remarks
|
|
17034
17120
|
* Contains the device information for the server.
|
|
17035
17121
|
*
|
|
17122
|
+
* This property can be read in early-execution mode.
|
|
17123
|
+
*
|
|
17036
17124
|
*/
|
|
17037
17125
|
readonly serverSystemInfo: SystemInfo;
|
|
17038
17126
|
/**
|
|
@@ -17232,6 +17320,8 @@ export class SystemAfterEvents {
|
|
|
17232
17320
|
* provides a way for commands and other systems to trigger
|
|
17233
17321
|
* behavior within script.
|
|
17234
17322
|
*
|
|
17323
|
+
* This property can be read in early-execution mode.
|
|
17324
|
+
*
|
|
17235
17325
|
*/
|
|
17236
17326
|
readonly scriptEventReceive: ScriptEventCommandMessageAfterEventSignal;
|
|
17237
17327
|
}
|
|
@@ -17246,7 +17336,17 @@ export class SystemAfterEvents {
|
|
|
17246
17336
|
*/
|
|
17247
17337
|
export class SystemBeforeEvents {
|
|
17248
17338
|
private constructor();
|
|
17339
|
+
/**
|
|
17340
|
+
* @remarks
|
|
17341
|
+
* This property can be read in early-execution mode.
|
|
17342
|
+
*
|
|
17343
|
+
*/
|
|
17249
17344
|
readonly shutdown: ShutdownBeforeEventSignal;
|
|
17345
|
+
/**
|
|
17346
|
+
* @remarks
|
|
17347
|
+
* This property can be read in early-execution mode.
|
|
17348
|
+
*
|
|
17349
|
+
*/
|
|
17250
17350
|
readonly startup: StartupBeforeEventSignal;
|
|
17251
17351
|
/**
|
|
17252
17352
|
* @remarks
|
|
@@ -17256,6 +17356,8 @@ export class SystemBeforeEvents {
|
|
|
17256
17356
|
* To prevent shutdown, set the event's cancel property to
|
|
17257
17357
|
* true.
|
|
17258
17358
|
*
|
|
17359
|
+
* This property can be read in early-execution mode.
|
|
17360
|
+
*
|
|
17259
17361
|
*/
|
|
17260
17362
|
readonly watchdogTerminate: WatchdogTerminateBeforeEventSignal;
|
|
17261
17363
|
}
|
|
@@ -17350,6 +17452,8 @@ export class Trigger {
|
|
|
17350
17452
|
* @remarks
|
|
17351
17453
|
* Creates a new trigger.
|
|
17352
17454
|
*
|
|
17455
|
+
* This function can't be called in read-only mode.
|
|
17456
|
+
*
|
|
17353
17457
|
*/
|
|
17354
17458
|
constructor(eventName: string);
|
|
17355
17459
|
}
|
|
@@ -17659,6 +17763,8 @@ export class World {
|
|
|
17659
17763
|
* of the world. Event callbacks are called in a deferred
|
|
17660
17764
|
* manner. Event callbacks are executed in read-write mode.
|
|
17661
17765
|
*
|
|
17766
|
+
* This property can be read in early-execution mode.
|
|
17767
|
+
*
|
|
17662
17768
|
*/
|
|
17663
17769
|
readonly afterEvents: WorldAfterEvents;
|
|
17664
17770
|
/**
|
|
@@ -17667,6 +17773,8 @@ export class World {
|
|
|
17667
17773
|
* of the world. Event callbacks are called immediately. Event
|
|
17668
17774
|
* callbacks are executed in read-only mode.
|
|
17669
17775
|
*
|
|
17776
|
+
* This property can be read in early-execution mode.
|
|
17777
|
+
*
|
|
17670
17778
|
* @example customCommand.ts
|
|
17671
17779
|
* ```typescript
|
|
17672
17780
|
* import { world, DimensionLocation } from "@minecraft/server";
|
|
@@ -17749,10 +17857,6 @@ export class World {
|
|
|
17749
17857
|
* The aim-assist presets and categories that can be used in
|
|
17750
17858
|
* the world.
|
|
17751
17859
|
*
|
|
17752
|
-
*
|
|
17753
|
-
* Required Experiments:
|
|
17754
|
-
* - Camera Aim Assist
|
|
17755
|
-
*
|
|
17756
17860
|
*/
|
|
17757
17861
|
getAimAssist(): AimAssistRegistry;
|
|
17758
17862
|
/**
|
|
@@ -18169,12 +18273,16 @@ export class WorldAfterEvents {
|
|
|
18169
18273
|
* explosion. It is fired after the blocks have already been
|
|
18170
18274
|
* destroyed.
|
|
18171
18275
|
*
|
|
18276
|
+
* This property can be read in early-execution mode.
|
|
18277
|
+
*
|
|
18172
18278
|
*/
|
|
18173
18279
|
readonly blockExplode: BlockExplodeAfterEventSignal;
|
|
18174
18280
|
/**
|
|
18175
18281
|
* @remarks
|
|
18176
18282
|
* This event fires when a button is pushed.
|
|
18177
18283
|
*
|
|
18284
|
+
* This property can be read in early-execution mode.
|
|
18285
|
+
*
|
|
18178
18286
|
*/
|
|
18179
18287
|
readonly buttonPush: ButtonPushAfterEventSignal;
|
|
18180
18288
|
/**
|
|
@@ -18183,6 +18291,8 @@ export class WorldAfterEvents {
|
|
|
18183
18291
|
* This event is triggered after a chat message has been
|
|
18184
18292
|
* broadcast or sent to players.
|
|
18185
18293
|
*
|
|
18294
|
+
* This property can be read in early-execution mode.
|
|
18295
|
+
*
|
|
18186
18296
|
*/
|
|
18187
18297
|
readonly chatSend: ChatSendAfterEventSignal;
|
|
18188
18298
|
/**
|
|
@@ -18191,6 +18301,8 @@ export class WorldAfterEvents {
|
|
|
18191
18301
|
* that will update the component definition state of an
|
|
18192
18302
|
* entity.
|
|
18193
18303
|
*
|
|
18304
|
+
* This property can be read in early-execution mode.
|
|
18305
|
+
*
|
|
18194
18306
|
*/
|
|
18195
18307
|
readonly dataDrivenEntityTrigger: DataDrivenEntityTriggerAfterEventSignal;
|
|
18196
18308
|
/**
|
|
@@ -18198,18 +18310,24 @@ export class WorldAfterEvents {
|
|
|
18198
18310
|
* This event fires when an effect, like poisoning, is added to
|
|
18199
18311
|
* an entity.
|
|
18200
18312
|
*
|
|
18313
|
+
* This property can be read in early-execution mode.
|
|
18314
|
+
*
|
|
18201
18315
|
*/
|
|
18202
18316
|
readonly effectAdd: EffectAddAfterEventSignal;
|
|
18203
18317
|
/**
|
|
18204
18318
|
* @remarks
|
|
18205
18319
|
* This event fires when an entity dies.
|
|
18206
18320
|
*
|
|
18321
|
+
* This property can be read in early-execution mode.
|
|
18322
|
+
*
|
|
18207
18323
|
*/
|
|
18208
18324
|
readonly entityDie: EntityDieAfterEventSignal;
|
|
18209
18325
|
/**
|
|
18210
18326
|
* @remarks
|
|
18211
18327
|
* This event fires when entity health changes in any degree.
|
|
18212
18328
|
*
|
|
18329
|
+
* This property can be read in early-execution mode.
|
|
18330
|
+
*
|
|
18213
18331
|
*/
|
|
18214
18332
|
readonly entityHealthChanged: EntityHealthChangedAfterEventSignal;
|
|
18215
18333
|
/**
|
|
@@ -18217,6 +18335,8 @@ export class WorldAfterEvents {
|
|
|
18217
18335
|
* This event fires when an entity hits (that is, melee
|
|
18218
18336
|
* attacks) a block.
|
|
18219
18337
|
*
|
|
18338
|
+
* This property can be read in early-execution mode.
|
|
18339
|
+
*
|
|
18220
18340
|
*/
|
|
18221
18341
|
readonly entityHitBlock: EntityHitBlockAfterEventSignal;
|
|
18222
18342
|
/**
|
|
@@ -18224,18 +18344,24 @@ export class WorldAfterEvents {
|
|
|
18224
18344
|
* This event fires when an entity hits (that is, melee
|
|
18225
18345
|
* attacks) another entity.
|
|
18226
18346
|
*
|
|
18347
|
+
* This property can be read in early-execution mode.
|
|
18348
|
+
*
|
|
18227
18349
|
*/
|
|
18228
18350
|
readonly entityHitEntity: EntityHitEntityAfterEventSignal;
|
|
18229
18351
|
/**
|
|
18230
18352
|
* @remarks
|
|
18231
18353
|
* This event fires when an entity is hurt (takes damage).
|
|
18232
18354
|
*
|
|
18355
|
+
* This property can be read in early-execution mode.
|
|
18356
|
+
*
|
|
18233
18357
|
*/
|
|
18234
18358
|
readonly entityHurt: EntityHurtAfterEventSignal;
|
|
18235
18359
|
/**
|
|
18236
18360
|
* @remarks
|
|
18237
18361
|
* Fires when an entity is loaded.
|
|
18238
18362
|
*
|
|
18363
|
+
* This property can be read in early-execution mode.
|
|
18364
|
+
*
|
|
18239
18365
|
*/
|
|
18240
18366
|
readonly entityLoad: EntityLoadAfterEventSignal;
|
|
18241
18367
|
/**
|
|
@@ -18243,18 +18369,24 @@ export class WorldAfterEvents {
|
|
|
18243
18369
|
* Fires when an entity is removed (for example, potentially
|
|
18244
18370
|
* unloaded, or removed after being killed).
|
|
18245
18371
|
*
|
|
18372
|
+
* This property can be read in early-execution mode.
|
|
18373
|
+
*
|
|
18246
18374
|
*/
|
|
18247
18375
|
readonly entityRemove: EntityRemoveAfterEventSignal;
|
|
18248
18376
|
/**
|
|
18249
18377
|
* @remarks
|
|
18250
18378
|
* This event fires when an entity is spawned.
|
|
18251
18379
|
*
|
|
18380
|
+
* This property can be read in early-execution mode.
|
|
18381
|
+
*
|
|
18252
18382
|
*/
|
|
18253
18383
|
readonly entitySpawn: EntitySpawnAfterEventSignal;
|
|
18254
18384
|
/**
|
|
18255
18385
|
* @remarks
|
|
18256
18386
|
* This event is fired after an explosion occurs.
|
|
18257
18387
|
*
|
|
18388
|
+
* This property can be read in early-execution mode.
|
|
18389
|
+
*
|
|
18258
18390
|
*/
|
|
18259
18391
|
readonly explosion: ExplosionAfterEventSignal;
|
|
18260
18392
|
/**
|
|
@@ -18262,12 +18394,16 @@ export class WorldAfterEvents {
|
|
|
18262
18394
|
* This event fires when a world.gameRules property has
|
|
18263
18395
|
* changed.
|
|
18264
18396
|
*
|
|
18397
|
+
* This property can be read in early-execution mode.
|
|
18398
|
+
*
|
|
18265
18399
|
*/
|
|
18266
18400
|
readonly gameRuleChange: GameRuleChangeAfterEventSignal;
|
|
18267
18401
|
/**
|
|
18268
18402
|
* @remarks
|
|
18269
18403
|
* This event fires when a chargeable item completes charging.
|
|
18270
18404
|
*
|
|
18405
|
+
* This property can be read in early-execution mode.
|
|
18406
|
+
*
|
|
18271
18407
|
*/
|
|
18272
18408
|
readonly itemCompleteUse: ItemCompleteUseAfterEventSignal;
|
|
18273
18409
|
/**
|
|
@@ -18275,12 +18411,16 @@ export class WorldAfterEvents {
|
|
|
18275
18411
|
* This event fires when a chargeable item is released from
|
|
18276
18412
|
* charging.
|
|
18277
18413
|
*
|
|
18414
|
+
* This property can be read in early-execution mode.
|
|
18415
|
+
*
|
|
18278
18416
|
*/
|
|
18279
18417
|
readonly itemReleaseUse: ItemReleaseUseAfterEventSignal;
|
|
18280
18418
|
/**
|
|
18281
18419
|
* @remarks
|
|
18282
18420
|
* This event fires when a chargeable item starts charging.
|
|
18283
18421
|
*
|
|
18422
|
+
* This property can be read in early-execution mode.
|
|
18423
|
+
*
|
|
18284
18424
|
*/
|
|
18285
18425
|
readonly itemStartUse: ItemStartUseAfterEventSignal;
|
|
18286
18426
|
/**
|
|
@@ -18291,12 +18431,16 @@ export class WorldAfterEvents {
|
|
|
18291
18431
|
* occur once at the beginning of the block placement. Note:
|
|
18292
18432
|
* This event cannot be used with Hoe or Axe items.
|
|
18293
18433
|
*
|
|
18434
|
+
* This property can be read in early-execution mode.
|
|
18435
|
+
*
|
|
18294
18436
|
*/
|
|
18295
18437
|
readonly itemStartUseOn: ItemStartUseOnAfterEventSignal;
|
|
18296
18438
|
/**
|
|
18297
18439
|
* @remarks
|
|
18298
18440
|
* This event fires when a chargeable item stops charging.
|
|
18299
18441
|
*
|
|
18442
|
+
* This property can be read in early-execution mode.
|
|
18443
|
+
*
|
|
18300
18444
|
*/
|
|
18301
18445
|
readonly itemStopUse: ItemStopUseAfterEventSignal;
|
|
18302
18446
|
/**
|
|
@@ -18305,6 +18449,8 @@ export class WorldAfterEvents {
|
|
|
18305
18449
|
* Block button after successfully using an item. Note: This
|
|
18306
18450
|
* event cannot be used with Hoe or Axe items.
|
|
18307
18451
|
*
|
|
18452
|
+
* This property can be read in early-execution mode.
|
|
18453
|
+
*
|
|
18308
18454
|
*/
|
|
18309
18455
|
readonly itemStopUseOn: ItemStopUseOnAfterEventSignal;
|
|
18310
18456
|
/**
|
|
@@ -18312,6 +18458,8 @@ export class WorldAfterEvents {
|
|
|
18312
18458
|
* This event fires when an item is successfully used by a
|
|
18313
18459
|
* player.
|
|
18314
18460
|
*
|
|
18461
|
+
* This property can be read in early-execution mode.
|
|
18462
|
+
*
|
|
18315
18463
|
*/
|
|
18316
18464
|
readonly itemUse: ItemUseAfterEventSignal;
|
|
18317
18465
|
/**
|
|
@@ -18319,12 +18467,16 @@ export class WorldAfterEvents {
|
|
|
18319
18467
|
* This event fires when an item is used on a block by a
|
|
18320
18468
|
* player.
|
|
18321
18469
|
*
|
|
18470
|
+
* This property can be read in early-execution mode.
|
|
18471
|
+
*
|
|
18322
18472
|
*/
|
|
18323
18473
|
readonly itemUseOn: ItemUseOnAfterEventSignal;
|
|
18324
18474
|
/**
|
|
18325
18475
|
* @remarks
|
|
18326
18476
|
* A lever has been pulled.
|
|
18327
18477
|
*
|
|
18478
|
+
* This property can be read in early-execution mode.
|
|
18479
|
+
*
|
|
18328
18480
|
*/
|
|
18329
18481
|
readonly leverAction: LeverActionAfterEventSignal;
|
|
18330
18482
|
/**
|
|
@@ -18333,18 +18485,24 @@ export class WorldAfterEvents {
|
|
|
18333
18485
|
* This event is an internal implementation detail, and is
|
|
18334
18486
|
* otherwise not currently functional.
|
|
18335
18487
|
*
|
|
18488
|
+
* This property can be read in early-execution mode.
|
|
18489
|
+
*
|
|
18336
18490
|
*/
|
|
18337
18491
|
readonly messageReceive: ServerMessageAfterEventSignal;
|
|
18338
18492
|
/**
|
|
18339
18493
|
* @remarks
|
|
18340
18494
|
* This event fires when a piston expands or retracts.
|
|
18341
18495
|
*
|
|
18496
|
+
* This property can be read in early-execution mode.
|
|
18497
|
+
*
|
|
18342
18498
|
*/
|
|
18343
18499
|
readonly pistonActivate: PistonActivateAfterEventSignal;
|
|
18344
18500
|
/**
|
|
18345
18501
|
* @remarks
|
|
18346
18502
|
* This event fires for a block that is broken by a player.
|
|
18347
18503
|
*
|
|
18504
|
+
* This property can be read in early-execution mode.
|
|
18505
|
+
*
|
|
18348
18506
|
*/
|
|
18349
18507
|
readonly playerBreakBlock: PlayerBreakBlockAfterEventSignal;
|
|
18350
18508
|
/**
|
|
@@ -18353,39 +18511,60 @@ export class WorldAfterEvents {
|
|
|
18353
18511
|
* This event fires when an {@link InputButton} state is
|
|
18354
18512
|
* changed.
|
|
18355
18513
|
*
|
|
18514
|
+
* This property can be read in early-execution mode.
|
|
18515
|
+
*
|
|
18356
18516
|
*/
|
|
18357
18517
|
readonly playerButtonInput: PlayerButtonInputAfterEventSignal;
|
|
18358
18518
|
/**
|
|
18359
18519
|
* @remarks
|
|
18360
18520
|
* Fires when a player moved to a different dimension.
|
|
18361
18521
|
*
|
|
18522
|
+
* This property can be read in early-execution mode.
|
|
18523
|
+
*
|
|
18362
18524
|
*/
|
|
18363
18525
|
readonly playerDimensionChange: PlayerDimensionChangeAfterEventSignal;
|
|
18526
|
+
/**
|
|
18527
|
+
* @remarks
|
|
18528
|
+
* This property can be read in early-execution mode.
|
|
18529
|
+
*
|
|
18530
|
+
*/
|
|
18364
18531
|
readonly playerEmote: PlayerEmoteAfterEventSignal;
|
|
18532
|
+
/**
|
|
18533
|
+
* @remarks
|
|
18534
|
+
* This property can be read in early-execution mode.
|
|
18535
|
+
*
|
|
18536
|
+
*/
|
|
18365
18537
|
readonly playerGameModeChange: PlayerGameModeChangeAfterEventSignal;
|
|
18366
18538
|
/**
|
|
18367
|
-
* @rc
|
|
18368
18539
|
* @remarks
|
|
18369
18540
|
* This event fires when a player's {@link InputMode} changes.
|
|
18370
18541
|
*
|
|
18542
|
+
* This property can be read in early-execution mode.
|
|
18543
|
+
*
|
|
18371
18544
|
*/
|
|
18372
18545
|
readonly playerInputModeChange: PlayerInputModeChangeAfterEventSignal;
|
|
18373
18546
|
/**
|
|
18374
18547
|
* @remarks
|
|
18375
18548
|
* This event fires when a players input permissions change.
|
|
18376
18549
|
*
|
|
18550
|
+
* This property can be read in early-execution mode.
|
|
18551
|
+
*
|
|
18377
18552
|
*/
|
|
18378
18553
|
readonly playerInputPermissionCategoryChange: PlayerInputPermissionCategoryChangeAfterEventSignal;
|
|
18379
18554
|
/**
|
|
18380
18555
|
* @remarks
|
|
18381
18556
|
* An event for when a player interacts with a block.
|
|
18382
18557
|
*
|
|
18558
|
+
* This property can be read in early-execution mode.
|
|
18559
|
+
*
|
|
18383
18560
|
*/
|
|
18384
18561
|
readonly playerInteractWithBlock: PlayerInteractWithBlockAfterEventSignal;
|
|
18385
18562
|
/**
|
|
18386
18563
|
* @remarks
|
|
18387
18564
|
* This event fires when a player interacts with an entity.
|
|
18388
18565
|
*
|
|
18566
|
+
* This property can be read in early-execution mode.
|
|
18567
|
+
*
|
|
18389
18568
|
*/
|
|
18390
18569
|
readonly playerInteractWithEntity: PlayerInteractWithEntityAfterEventSignal;
|
|
18391
18570
|
/**
|
|
@@ -18394,18 +18573,24 @@ export class WorldAfterEvents {
|
|
|
18394
18573
|
* playerSpawn for another related event you can trap for when
|
|
18395
18574
|
* a player is spawned the first time within a world.
|
|
18396
18575
|
*
|
|
18576
|
+
* This property can be read in early-execution mode.
|
|
18577
|
+
*
|
|
18397
18578
|
*/
|
|
18398
18579
|
readonly playerJoin: PlayerJoinAfterEventSignal;
|
|
18399
18580
|
/**
|
|
18400
18581
|
* @remarks
|
|
18401
18582
|
* This event fires when a player leaves a world.
|
|
18402
18583
|
*
|
|
18584
|
+
* This property can be read in early-execution mode.
|
|
18585
|
+
*
|
|
18403
18586
|
*/
|
|
18404
18587
|
readonly playerLeave: PlayerLeaveAfterEventSignal;
|
|
18405
18588
|
/**
|
|
18406
18589
|
* @remarks
|
|
18407
18590
|
* This event fires for a block that is placed by a player.
|
|
18408
18591
|
*
|
|
18592
|
+
* This property can be read in early-execution mode.
|
|
18593
|
+
*
|
|
18409
18594
|
*/
|
|
18410
18595
|
readonly playerPlaceBlock: PlayerPlaceBlockAfterEventSignal;
|
|
18411
18596
|
/**
|
|
@@ -18414,6 +18599,8 @@ export class WorldAfterEvents {
|
|
|
18414
18599
|
* an additional flag within this event will tell you whether
|
|
18415
18600
|
* the player is spawning right after join vs. a respawn.
|
|
18416
18601
|
*
|
|
18602
|
+
* This property can be read in early-execution mode.
|
|
18603
|
+
*
|
|
18417
18604
|
*/
|
|
18418
18605
|
readonly playerSpawn: PlayerSpawnAfterEventSignal;
|
|
18419
18606
|
/**
|
|
@@ -18421,6 +18608,8 @@ export class WorldAfterEvents {
|
|
|
18421
18608
|
* A pressure plate has popped back up (i.e., there are no
|
|
18422
18609
|
* entities on the pressure plate.)
|
|
18423
18610
|
*
|
|
18611
|
+
* This property can be read in early-execution mode.
|
|
18612
|
+
*
|
|
18424
18613
|
*/
|
|
18425
18614
|
readonly pressurePlatePop: PressurePlatePopAfterEventSignal;
|
|
18426
18615
|
/**
|
|
@@ -18428,30 +18617,40 @@ export class WorldAfterEvents {
|
|
|
18428
18617
|
* A pressure plate has pushed (at least one entity has moved
|
|
18429
18618
|
* onto a pressure plate.)
|
|
18430
18619
|
*
|
|
18620
|
+
* This property can be read in early-execution mode.
|
|
18621
|
+
*
|
|
18431
18622
|
*/
|
|
18432
18623
|
readonly pressurePlatePush: PressurePlatePushAfterEventSignal;
|
|
18433
18624
|
/**
|
|
18434
18625
|
* @remarks
|
|
18435
18626
|
* This event fires when a projectile hits a block.
|
|
18436
18627
|
*
|
|
18628
|
+
* This property can be read in early-execution mode.
|
|
18629
|
+
*
|
|
18437
18630
|
*/
|
|
18438
18631
|
readonly projectileHitBlock: ProjectileHitBlockAfterEventSignal;
|
|
18439
18632
|
/**
|
|
18440
18633
|
* @remarks
|
|
18441
18634
|
* This event fires when a projectile hits an entity.
|
|
18442
18635
|
*
|
|
18636
|
+
* This property can be read in early-execution mode.
|
|
18637
|
+
*
|
|
18443
18638
|
*/
|
|
18444
18639
|
readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
|
|
18445
18640
|
/**
|
|
18446
18641
|
* @remarks
|
|
18447
18642
|
* A target block was hit.
|
|
18448
18643
|
*
|
|
18644
|
+
* This property can be read in early-execution mode.
|
|
18645
|
+
*
|
|
18449
18646
|
*/
|
|
18450
18647
|
readonly targetBlockHit: TargetBlockHitAfterEventSignal;
|
|
18451
18648
|
/**
|
|
18452
18649
|
* @remarks
|
|
18453
18650
|
* A trip wire was tripped.
|
|
18454
18651
|
*
|
|
18652
|
+
* This property can be read in early-execution mode.
|
|
18653
|
+
*
|
|
18455
18654
|
*/
|
|
18456
18655
|
readonly tripWireTrip: TripWireTripAfterEventSignal;
|
|
18457
18656
|
/**
|
|
@@ -18459,10 +18658,15 @@ export class WorldAfterEvents {
|
|
|
18459
18658
|
* This event will be triggered when the weather changes within
|
|
18460
18659
|
* Minecraft.
|
|
18461
18660
|
*
|
|
18661
|
+
* This property can be read in early-execution mode.
|
|
18662
|
+
*
|
|
18462
18663
|
*/
|
|
18463
18664
|
readonly weatherChange: WeatherChangeAfterEventSignal;
|
|
18464
18665
|
/**
|
|
18465
18666
|
* @beta
|
|
18667
|
+
* @remarks
|
|
18668
|
+
* This property can be read in early-execution mode.
|
|
18669
|
+
*
|
|
18466
18670
|
*/
|
|
18467
18671
|
readonly worldLoad: WorldLoadAfterEventSignal;
|
|
18468
18672
|
}
|
|
@@ -18482,6 +18686,8 @@ export class WorldBeforeEvents {
|
|
|
18482
18686
|
* This event is triggered after a chat message has been
|
|
18483
18687
|
* broadcast or sent to players.
|
|
18484
18688
|
*
|
|
18689
|
+
* This property can be read in early-execution mode.
|
|
18690
|
+
*
|
|
18485
18691
|
* @example customCommand.ts
|
|
18486
18692
|
* ```typescript
|
|
18487
18693
|
* import { world, DimensionLocation } from "@minecraft/server";
|
|
@@ -18516,6 +18722,8 @@ export class WorldBeforeEvents {
|
|
|
18516
18722
|
* This event is triggered after an event has been added to an
|
|
18517
18723
|
* entity.
|
|
18518
18724
|
*
|
|
18725
|
+
* This property can be read in early-execution mode.
|
|
18726
|
+
*
|
|
18519
18727
|
*/
|
|
18520
18728
|
readonly effectAdd: EffectAddBeforeEventSignal;
|
|
18521
18729
|
/**
|
|
@@ -18523,12 +18731,16 @@ export class WorldBeforeEvents {
|
|
|
18523
18731
|
* Fires before an entity is removed from the world (for
|
|
18524
18732
|
* example, unloaded or removed after being killed.)
|
|
18525
18733
|
*
|
|
18734
|
+
* This property can be read in early-execution mode.
|
|
18735
|
+
*
|
|
18526
18736
|
*/
|
|
18527
18737
|
readonly entityRemove: EntityRemoveBeforeEventSignal;
|
|
18528
18738
|
/**
|
|
18529
18739
|
* @remarks
|
|
18530
18740
|
* This event is fired after an explosion occurs.
|
|
18531
18741
|
*
|
|
18742
|
+
* This property can be read in early-execution mode.
|
|
18743
|
+
*
|
|
18532
18744
|
*/
|
|
18533
18745
|
readonly explosion: ExplosionBeforeEventSignal;
|
|
18534
18746
|
/**
|
|
@@ -18536,6 +18748,8 @@ export class WorldBeforeEvents {
|
|
|
18536
18748
|
* This event fires when an item is successfully used by a
|
|
18537
18749
|
* player.
|
|
18538
18750
|
*
|
|
18751
|
+
* This property can be read in early-execution mode.
|
|
18752
|
+
*
|
|
18539
18753
|
*/
|
|
18540
18754
|
readonly itemUse: ItemUseBeforeEventSignal;
|
|
18541
18755
|
/**
|
|
@@ -18543,31 +18757,46 @@ export class WorldBeforeEvents {
|
|
|
18543
18757
|
* This event fires when an item is used on a block by a
|
|
18544
18758
|
* player.
|
|
18545
18759
|
*
|
|
18760
|
+
* This property can be read in early-execution mode.
|
|
18761
|
+
*
|
|
18546
18762
|
*/
|
|
18547
18763
|
readonly itemUseOn: ItemUseOnBeforeEventSignal;
|
|
18548
18764
|
/**
|
|
18549
18765
|
* @remarks
|
|
18550
18766
|
* This event fires before a block is broken by a player.
|
|
18551
18767
|
*
|
|
18768
|
+
* This property can be read in early-execution mode.
|
|
18769
|
+
*
|
|
18552
18770
|
*/
|
|
18553
18771
|
readonly playerBreakBlock: PlayerBreakBlockBeforeEventSignal;
|
|
18772
|
+
/**
|
|
18773
|
+
* @remarks
|
|
18774
|
+
* This property can be read in early-execution mode.
|
|
18775
|
+
*
|
|
18776
|
+
*/
|
|
18554
18777
|
readonly playerGameModeChange: PlayerGameModeChangeBeforeEventSignal;
|
|
18555
18778
|
/**
|
|
18556
18779
|
* @remarks
|
|
18557
18780
|
* Fires before a player interacts with a block.
|
|
18558
18781
|
*
|
|
18782
|
+
* This property can be read in early-execution mode.
|
|
18783
|
+
*
|
|
18559
18784
|
*/
|
|
18560
18785
|
readonly playerInteractWithBlock: PlayerInteractWithBlockBeforeEventSignal;
|
|
18561
18786
|
/**
|
|
18562
18787
|
* @remarks
|
|
18563
18788
|
* Fires before a player interacts with an entity.
|
|
18564
18789
|
*
|
|
18790
|
+
* This property can be read in early-execution mode.
|
|
18791
|
+
*
|
|
18565
18792
|
*/
|
|
18566
18793
|
readonly playerInteractWithEntity: PlayerInteractWithEntityBeforeEventSignal;
|
|
18567
18794
|
/**
|
|
18568
18795
|
* @remarks
|
|
18569
18796
|
* Fires when a player leaves the game.
|
|
18570
18797
|
*
|
|
18798
|
+
* This property can be read in early-execution mode.
|
|
18799
|
+
*
|
|
18571
18800
|
*/
|
|
18572
18801
|
readonly playerLeave: PlayerLeaveBeforeEventSignal;
|
|
18573
18802
|
/**
|
|
@@ -18575,8 +18804,15 @@ export class WorldBeforeEvents {
|
|
|
18575
18804
|
* @remarks
|
|
18576
18805
|
* This event fires before a block is placed by a player.
|
|
18577
18806
|
*
|
|
18807
|
+
* This property can be read in early-execution mode.
|
|
18808
|
+
*
|
|
18578
18809
|
*/
|
|
18579
18810
|
readonly playerPlaceBlock: PlayerPlaceBlockBeforeEventSignal;
|
|
18811
|
+
/**
|
|
18812
|
+
* @remarks
|
|
18813
|
+
* This property can be read in early-execution mode.
|
|
18814
|
+
*
|
|
18815
|
+
*/
|
|
18580
18816
|
readonly weatherChange: WeatherChangeBeforeEventSignal;
|
|
18581
18817
|
}
|
|
18582
18818
|
|
|
@@ -18969,14 +19205,22 @@ export interface CameraFadeTimeOptions {
|
|
|
18969
19205
|
}
|
|
18970
19206
|
|
|
18971
19207
|
/**
|
|
18972
|
-
*
|
|
18973
|
-
*
|
|
18974
|
-
* Required Experiments:
|
|
18975
|
-
* - Third Person Cameras
|
|
18976
|
-
*
|
|
19208
|
+
* Options to control pivot points and offsets of the third
|
|
19209
|
+
* person boom preset.
|
|
18977
19210
|
*/
|
|
18978
19211
|
export interface CameraFixedBoomOptions {
|
|
19212
|
+
/**
|
|
19213
|
+
* @remarks
|
|
19214
|
+
* Changes the pivot point to be <x, y, z> away from the
|
|
19215
|
+
* player.
|
|
19216
|
+
*
|
|
19217
|
+
*/
|
|
18979
19218
|
entityOffset?: Vector3;
|
|
19219
|
+
/**
|
|
19220
|
+
* @remarks
|
|
19221
|
+
* Offsets the camera from center by <x, y>.
|
|
19222
|
+
*
|
|
19223
|
+
*/
|
|
18980
19224
|
viewOffset?: Vector2;
|
|
18981
19225
|
}
|
|
18982
19226
|
|
|
@@ -20061,10 +20305,6 @@ export interface PlayAnimationOptions {
|
|
|
20061
20305
|
/**
|
|
20062
20306
|
* @beta
|
|
20063
20307
|
* Settings relating to a player's aim-assist targeting.
|
|
20064
|
-
*
|
|
20065
|
-
* Required Experiments:
|
|
20066
|
-
* - Camera Aim Assist
|
|
20067
|
-
*
|
|
20068
20308
|
*/
|
|
20069
20309
|
export interface PlayerAimAssistSettings {
|
|
20070
20310
|
/**
|
|
@@ -20745,6 +20985,11 @@ export class CustomComponentInvalidRegistryError extends Error {
|
|
|
20745
20985
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
20746
20986
|
export class CustomComponentNameError extends Error {
|
|
20747
20987
|
private constructor();
|
|
20988
|
+
/**
|
|
20989
|
+
* @remarks
|
|
20990
|
+
* This property can be read in early-execution mode.
|
|
20991
|
+
*
|
|
20992
|
+
*/
|
|
20748
20993
|
reason: CustomComponentNameErrorReason;
|
|
20749
20994
|
}
|
|
20750
20995
|
|
|
@@ -20773,7 +21018,6 @@ export class InvalidContainerSlotError extends Error {
|
|
|
20773
21018
|
}
|
|
20774
21019
|
|
|
20775
21020
|
/**
|
|
20776
|
-
* @rc
|
|
20777
21021
|
* The error called when an entity is invalid. This can occur
|
|
20778
21022
|
* when accessing components on a removed entity.
|
|
20779
21023
|
*/
|
|
@@ -20784,12 +21028,16 @@ export class InvalidEntityError extends Error {
|
|
|
20784
21028
|
* @remarks
|
|
20785
21029
|
* The id of the entity that is now invalid.
|
|
20786
21030
|
*
|
|
21031
|
+
* This property can be read in early-execution mode.
|
|
21032
|
+
*
|
|
20787
21033
|
*/
|
|
20788
21034
|
id: string;
|
|
20789
21035
|
/**
|
|
20790
21036
|
* @remarks
|
|
20791
21037
|
* The type of the entity that is now invalid.
|
|
20792
21038
|
*
|
|
21039
|
+
* This property can be read in early-execution mode.
|
|
21040
|
+
*
|
|
20793
21041
|
*/
|
|
20794
21042
|
type: string;
|
|
20795
21043
|
}
|
|
@@ -20872,6 +21120,11 @@ export class LocationOutOfWorldBoundariesError extends Error {
|
|
|
20872
21120
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
20873
21121
|
export class NamespaceNameError extends Error {
|
|
20874
21122
|
private constructor();
|
|
21123
|
+
/**
|
|
21124
|
+
* @remarks
|
|
21125
|
+
* This property can be read in early-execution mode.
|
|
21126
|
+
*
|
|
21127
|
+
*/
|
|
20875
21128
|
reason: NamespaceNameErrorReason;
|
|
20876
21129
|
}
|
|
20877
21130
|
|