@minecraft/server 2.12.0-beta.1.26.60-preview.30 → 2.12.0-rc.1.26.70-preview.20
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 +57 -2707
- package/package.json +2 -2
package/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
Copyright (c) Microsoft Corporation.
|
|
8
8
|
***************************************************************************** */
|
|
9
9
|
/**
|
|
10
|
-
* @
|
|
10
|
+
* @preview
|
|
11
11
|
* @packageDocumentation
|
|
12
12
|
* Contains many types related to manipulating a Minecraft
|
|
13
13
|
* world, including entities, blocks, dimensions, and more.
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
* ```json
|
|
17
17
|
* {
|
|
18
18
|
* "module_name": "@minecraft/server",
|
|
19
|
-
* "version": "2.12.0
|
|
19
|
+
* "version": "2.12.0"
|
|
20
20
|
* }
|
|
21
21
|
* ```
|
|
22
22
|
*
|
|
@@ -48,10 +48,6 @@ export enum AimAssistTargetMode {
|
|
|
48
48
|
*/
|
|
49
49
|
export enum BlockComponentTypes {
|
|
50
50
|
DynamicProperties = 'minecraft:dynamic_properties',
|
|
51
|
-
/**
|
|
52
|
-
* @beta
|
|
53
|
-
*/
|
|
54
|
-
EntityStorage = 'minecraft:entity_storage',
|
|
55
51
|
FluidContainer = 'minecraft:fluid_container',
|
|
56
52
|
Instrument = 'minecraft:instrument_sound',
|
|
57
53
|
/**
|
|
@@ -87,14 +83,6 @@ export enum BlockComponentTypes {
|
|
|
87
83
|
*
|
|
88
84
|
*/
|
|
89
85
|
PrecipitationInteractions = 'minecraft:precipitation_interactions',
|
|
90
|
-
/**
|
|
91
|
-
* @beta
|
|
92
|
-
*/
|
|
93
|
-
RecipeCrafting = 'minecraft:recipe_crafting',
|
|
94
|
-
/**
|
|
95
|
-
* @beta
|
|
96
|
-
*/
|
|
97
|
-
RecipeProcessing = 'minecraft:recipe_processing',
|
|
98
86
|
/**
|
|
99
87
|
* @remarks
|
|
100
88
|
* Represents a block that can play a record.
|
|
@@ -113,10 +101,6 @@ export enum BlockComponentTypes {
|
|
|
113
101
|
*
|
|
114
102
|
*/
|
|
115
103
|
Sign = 'minecraft:sign',
|
|
116
|
-
/**
|
|
117
|
-
* @beta
|
|
118
|
-
*/
|
|
119
|
-
VibrationProperties = 'minecraft:vibration_properties',
|
|
120
104
|
}
|
|
121
105
|
|
|
122
106
|
/**
|
|
@@ -393,13 +377,6 @@ export enum CustomCommandErrorReason {
|
|
|
393
377
|
*
|
|
394
378
|
*/
|
|
395
379
|
RegistryReadOnly = 'RegistryReadOnly',
|
|
396
|
-
/**
|
|
397
|
-
* @beta
|
|
398
|
-
* @remarks
|
|
399
|
-
* Non enum type command parameters cannot use enumName.
|
|
400
|
-
*
|
|
401
|
-
*/
|
|
402
|
-
UnexpectedEnumName = 'UnexpectedEnumName',
|
|
403
380
|
}
|
|
404
381
|
|
|
405
382
|
/**
|
|
@@ -1135,14 +1112,6 @@ export enum EntityComponentTypes {
|
|
|
1135
1112
|
*
|
|
1136
1113
|
*/
|
|
1137
1114
|
NavigationWalk = 'minecraft:navigation.walk',
|
|
1138
|
-
/**
|
|
1139
|
-
* @beta
|
|
1140
|
-
* @remarks
|
|
1141
|
-
* Adds NPC capabilities to an entity such as custom skin,
|
|
1142
|
-
* name, and dialogue interactions.
|
|
1143
|
-
*
|
|
1144
|
-
*/
|
|
1145
|
-
Npc = 'minecraft:npc',
|
|
1146
1115
|
/**
|
|
1147
1116
|
* @remarks
|
|
1148
1117
|
* When present on an entity, this entity is on fire.
|
|
@@ -1626,14 +1595,6 @@ export enum EntitySwingSource {
|
|
|
1626
1595
|
* and mainhand slots.
|
|
1627
1596
|
*/
|
|
1628
1597
|
export enum EquipmentSlot {
|
|
1629
|
-
/**
|
|
1630
|
-
* @beta
|
|
1631
|
-
* @remarks
|
|
1632
|
-
* The body slot. This slot is used to hold armor for
|
|
1633
|
-
* non-humanoid mobs.
|
|
1634
|
-
*
|
|
1635
|
-
*/
|
|
1636
|
-
Body = 'Body',
|
|
1637
1598
|
/**
|
|
1638
1599
|
* @remarks
|
|
1639
1600
|
* The chest slot. This slot is used to hold items such as
|
|
@@ -1903,14 +1864,6 @@ export enum GameRule {
|
|
|
1903
1864
|
*
|
|
1904
1865
|
*/
|
|
1905
1866
|
PlayersSleepingPercentage = 'playersSleepingPercentage',
|
|
1906
|
-
/**
|
|
1907
|
-
* @beta
|
|
1908
|
-
* @remarks
|
|
1909
|
-
* Controls which player waypoints are automatically added to
|
|
1910
|
-
* the players locator bar.
|
|
1911
|
-
*
|
|
1912
|
-
*/
|
|
1913
|
-
PlayerWaypoints = 'playerWaypoints',
|
|
1914
1867
|
/**
|
|
1915
1868
|
* @remarks
|
|
1916
1869
|
* Controls whether projectiles (entities with a projectile
|
|
@@ -2733,42 +2686,6 @@ export enum PlayerSplitScreenSlot {
|
|
|
2733
2686
|
Third = 'Third',
|
|
2734
2687
|
}
|
|
2735
2688
|
|
|
2736
|
-
/**
|
|
2737
|
-
* @beta
|
|
2738
|
-
*/
|
|
2739
|
-
export enum PlayerWaypointsMode {
|
|
2740
|
-
Everyone = 'Everyone',
|
|
2741
|
-
Off = 'Off',
|
|
2742
|
-
}
|
|
2743
|
-
|
|
2744
|
-
/**
|
|
2745
|
-
* @beta
|
|
2746
|
-
* Specifies how a block point-of-interest query filters
|
|
2747
|
-
* instances by ticket occupancy.
|
|
2748
|
-
*/
|
|
2749
|
-
export enum PoiBlockOccupancyFilter {
|
|
2750
|
-
/**
|
|
2751
|
-
* @remarks
|
|
2752
|
-
* Includes POI instances regardless of their occupancy or
|
|
2753
|
-
* available ticket count.
|
|
2754
|
-
*
|
|
2755
|
-
*/
|
|
2756
|
-
Any = 'Any',
|
|
2757
|
-
/**
|
|
2758
|
-
* @remarks
|
|
2759
|
-
* Includes POI instances with no available tickets.
|
|
2760
|
-
*
|
|
2761
|
-
*/
|
|
2762
|
-
Full = 'Full',
|
|
2763
|
-
/**
|
|
2764
|
-
* @remarks
|
|
2765
|
-
* Includes POI instances with at least one ticket available to
|
|
2766
|
-
* be claimed.
|
|
2767
|
-
*
|
|
2768
|
-
*/
|
|
2769
|
-
HasVacancy = 'HasVacancy',
|
|
2770
|
-
}
|
|
2771
|
-
|
|
2772
2689
|
/**
|
|
2773
2690
|
* Contains objectives and participants for the scoreboard.
|
|
2774
2691
|
*/
|
|
@@ -3094,29 +3011,6 @@ export enum TintMethod {
|
|
|
3094
3011
|
Water = 'Water',
|
|
3095
3012
|
}
|
|
3096
3013
|
|
|
3097
|
-
/**
|
|
3098
|
-
* @beta
|
|
3099
|
-
* An enumeration with the reason that a watchdog is deciding
|
|
3100
|
-
* to terminate execution of a behavior packs' script.
|
|
3101
|
-
*/
|
|
3102
|
-
export enum WatchdogTerminateReason {
|
|
3103
|
-
/**
|
|
3104
|
-
* @remarks
|
|
3105
|
-
* Script runtime for a behavior pack is terminated due to
|
|
3106
|
-
* non-responsiveness from script (a hang or infinite loop).
|
|
3107
|
-
*
|
|
3108
|
-
*/
|
|
3109
|
-
Hang = 'Hang',
|
|
3110
|
-
/**
|
|
3111
|
-
* @remarks
|
|
3112
|
-
* Script runtime for a behavior pack is terminated due to a
|
|
3113
|
-
* stack overflow (a long, and potentially infinite) chain of
|
|
3114
|
-
* function calls.
|
|
3115
|
-
*
|
|
3116
|
-
*/
|
|
3117
|
-
StackOverflow = 'StackOverflow',
|
|
3118
|
-
}
|
|
3119
|
-
|
|
3120
3014
|
/**
|
|
3121
3015
|
* Enum representing different texture icons that can be
|
|
3122
3016
|
* displayed for waypoints on the locator bar.
|
|
@@ -3179,13 +3073,11 @@ export type BlockComponentReturnType<T extends string> = T extends keyof BlockCo
|
|
|
3179
3073
|
|
|
3180
3074
|
export type BlockComponentTypeMap = {
|
|
3181
3075
|
dynamic_properties: BlockDynamicPropertiesComponent;
|
|
3182
|
-
entity_storage: BlockEntityStorageComponent;
|
|
3183
3076
|
fluid_container: BlockFluidContainerComponent;
|
|
3184
3077
|
instrument_sound: BlockInstrumentComponent;
|
|
3185
3078
|
inventory: BlockInventoryComponent;
|
|
3186
3079
|
map_color: BlockMapColorComponent;
|
|
3187
3080
|
'minecraft:dynamic_properties': BlockDynamicPropertiesComponent;
|
|
3188
|
-
'minecraft:entity_storage': BlockEntityStorageComponent;
|
|
3189
3081
|
'minecraft:fluid_container': BlockFluidContainerComponent;
|
|
3190
3082
|
'minecraft:instrument_sound': BlockInstrumentComponent;
|
|
3191
3083
|
'minecraft:inventory': BlockInventoryComponent;
|
|
@@ -3193,21 +3085,15 @@ export type BlockComponentTypeMap = {
|
|
|
3193
3085
|
'minecraft:movable': BlockMovableComponent;
|
|
3194
3086
|
'minecraft:piston': BlockPistonComponent;
|
|
3195
3087
|
'minecraft:precipitation_interactions': BlockPrecipitationInteractionsComponent;
|
|
3196
|
-
'minecraft:recipe_crafting': BlockRecipeCraftingComponent;
|
|
3197
|
-
'minecraft:recipe_processing': BlockRecipeProcessingComponent;
|
|
3198
3088
|
'minecraft:record_player': BlockRecordPlayerComponent;
|
|
3199
3089
|
'minecraft:redstone_producer': BlockRedstoneProducerComponent;
|
|
3200
3090
|
'minecraft:sign': BlockSignComponent;
|
|
3201
|
-
'minecraft:vibration_properties': BlockVibrationPropertiesComponent;
|
|
3202
3091
|
movable: BlockMovableComponent;
|
|
3203
3092
|
piston: BlockPistonComponent;
|
|
3204
3093
|
precipitation_interactions: BlockPrecipitationInteractionsComponent;
|
|
3205
|
-
recipe_crafting: BlockRecipeCraftingComponent;
|
|
3206
|
-
recipe_processing: BlockRecipeProcessingComponent;
|
|
3207
3094
|
record_player: BlockRecordPlayerComponent;
|
|
3208
3095
|
redstone_producer: BlockRedstoneProducerComponent;
|
|
3209
3096
|
sign: BlockSignComponent;
|
|
3210
|
-
vibration_properties: BlockVibrationPropertiesComponent;
|
|
3211
3097
|
};
|
|
3212
3098
|
|
|
3213
3099
|
/**
|
|
@@ -3311,7 +3197,6 @@ export type EntityComponentTypeMap = {
|
|
|
3311
3197
|
'minecraft:navigation.generic': EntityNavigationGenericComponent;
|
|
3312
3198
|
'minecraft:navigation.hover': EntityNavigationHoverComponent;
|
|
3313
3199
|
'minecraft:navigation.walk': EntityNavigationWalkComponent;
|
|
3314
|
-
'minecraft:npc': EntityNpcComponent;
|
|
3315
3200
|
'minecraft:onfire': EntityOnFireComponent;
|
|
3316
3201
|
'minecraft:player.exhaustion': EntityExhaustionComponent;
|
|
3317
3202
|
'minecraft:player.hunger': EntityHungerComponent;
|
|
@@ -3345,7 +3230,6 @@ export type EntityComponentTypeMap = {
|
|
|
3345
3230
|
'navigation.generic': EntityNavigationGenericComponent;
|
|
3346
3231
|
'navigation.hover': EntityNavigationHoverComponent;
|
|
3347
3232
|
'navigation.walk': EntityNavigationWalkComponent;
|
|
3348
|
-
npc: EntityNpcComponent;
|
|
3349
3233
|
onfire: EntityOnFireComponent;
|
|
3350
3234
|
'player.exhaustion': EntityExhaustionComponent;
|
|
3351
3235
|
'player.hunger': EntityHungerComponent;
|
|
@@ -3365,15 +3249,6 @@ export type EntityComponentTypeMap = {
|
|
|
3365
3249
|
wants_jockey: EntityWantsJockeyComponent;
|
|
3366
3250
|
};
|
|
3367
3251
|
|
|
3368
|
-
/**
|
|
3369
|
-
* @beta
|
|
3370
|
-
*/
|
|
3371
|
-
export type EntityIdentifierType<T> = [T] extends [never]
|
|
3372
|
-
? VanillaEntityIdentifier
|
|
3373
|
-
: T extends string
|
|
3374
|
-
? VanillaEntityIdentifier | T
|
|
3375
|
-
: never;
|
|
3376
|
-
|
|
3377
3252
|
export type ItemComponentReturnType<T extends string> = T extends keyof ItemComponentTypeMap
|
|
3378
3253
|
? ItemComponentTypeMap[T]
|
|
3379
3254
|
: ItemCustomComponentInstance;
|
|
@@ -3401,15 +3276,6 @@ export type ItemComponentTypeMap = {
|
|
|
3401
3276
|
potion: ItemPotionComponent;
|
|
3402
3277
|
};
|
|
3403
3278
|
|
|
3404
|
-
/**
|
|
3405
|
-
* @beta
|
|
3406
|
-
*/
|
|
3407
|
-
export type VanillaEntityIdentifier =
|
|
3408
|
-
| EntityType
|
|
3409
|
-
| minecraftvanilladata.MinecraftEntityTypes
|
|
3410
|
-
| `${minecraftvanilladata.MinecraftEntityTypes}`
|
|
3411
|
-
| `${minecraftvanilladata.MinecraftEntityTypes}<${string}>`;
|
|
3412
|
-
|
|
3413
3279
|
/**
|
|
3414
3280
|
* Handle to an aim-assist category that exists in the
|
|
3415
3281
|
* world.aimAssist registry.
|
|
@@ -3567,9 +3433,7 @@ export class AimAssistCategorySettings {
|
|
|
3567
3433
|
* A record mapping block Ids to their priority settings.
|
|
3568
3434
|
* Larger numbers have greater priority.
|
|
3569
3435
|
*/
|
|
3570
|
-
setBlockPriorities(
|
|
3571
|
-
blockPriorities: Record<keyof typeof minecraftvanilladata.MinecraftBlockTypes | string, number>,
|
|
3572
|
-
): void;
|
|
3436
|
+
setBlockPriorities(blockPriorities: Record<string, number>): void;
|
|
3573
3437
|
/**
|
|
3574
3438
|
* @remarks
|
|
3575
3439
|
* Sets the priority settings used for block targeting.
|
|
@@ -3588,9 +3452,7 @@ export class AimAssistCategorySettings {
|
|
|
3588
3452
|
* A record mapping entity Ids to their priority settings.
|
|
3589
3453
|
* Larger numbers have greater priority.
|
|
3590
3454
|
*/
|
|
3591
|
-
setEntityPriorities(
|
|
3592
|
-
entityPriorities: Record<keyof typeof minecraftvanilladata.MinecraftEntityTypes | string, number>,
|
|
3593
|
-
): void;
|
|
3455
|
+
setEntityPriorities(entityPriorities: Record<string, number>): void;
|
|
3594
3456
|
/**
|
|
3595
3457
|
* @remarks
|
|
3596
3458
|
* Sets the priority settings used for entity targeting.
|
|
@@ -3789,10 +3651,8 @@ export class AimAssistPresetSettings {
|
|
|
3789
3651
|
*
|
|
3790
3652
|
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
3791
3653
|
*
|
|
3792
|
-
* @param targets
|
|
3793
|
-
* An array of block tags.
|
|
3794
3654
|
*/
|
|
3795
|
-
setExcludedBlockTagTargets(
|
|
3655
|
+
setExcludedBlockTagTargets(blockTagTargets?: string[]): void;
|
|
3796
3656
|
/**
|
|
3797
3657
|
* @remarks
|
|
3798
3658
|
* Sets the list of block Ids to exclude from aim assist
|
|
@@ -3800,10 +3660,8 @@ export class AimAssistPresetSettings {
|
|
|
3800
3660
|
*
|
|
3801
3661
|
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
3802
3662
|
*
|
|
3803
|
-
* @param targets
|
|
3804
|
-
* An array of block Ids.
|
|
3805
3663
|
*/
|
|
3806
|
-
setExcludedBlockTargets(
|
|
3664
|
+
setExcludedBlockTargets(blockTargets?: string[]): void;
|
|
3807
3665
|
/**
|
|
3808
3666
|
* @remarks
|
|
3809
3667
|
* Sets the list of entity Ids to exclude from aim assist
|
|
@@ -3811,10 +3669,8 @@ export class AimAssistPresetSettings {
|
|
|
3811
3669
|
*
|
|
3812
3670
|
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
3813
3671
|
*
|
|
3814
|
-
* @param targets
|
|
3815
|
-
* An array of entity Ids.
|
|
3816
3672
|
*/
|
|
3817
|
-
setExcludedEntityTargets(
|
|
3673
|
+
setExcludedEntityTargets(entityTargets?: string[]): void;
|
|
3818
3674
|
/**
|
|
3819
3675
|
* @remarks
|
|
3820
3676
|
* Sets the list of entity type families to exclude from aim
|
|
@@ -3822,10 +3678,8 @@ export class AimAssistPresetSettings {
|
|
|
3822
3678
|
*
|
|
3823
3679
|
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
3824
3680
|
*
|
|
3825
|
-
* @param targets
|
|
3826
|
-
* An array of entity type families.
|
|
3827
3681
|
*/
|
|
3828
|
-
setExcludedEntityTypeFamilyTargets(
|
|
3682
|
+
setExcludedEntityTypeFamilyTargets(entityTypeFamilyTargets?: string[]): void;
|
|
3829
3683
|
/**
|
|
3830
3684
|
* @remarks
|
|
3831
3685
|
* Sets the per-item aim-assist category Ids.
|
|
@@ -3836,7 +3690,7 @@ export class AimAssistPresetSettings {
|
|
|
3836
3690
|
* A record mapping item Ids to aim-assist category Ids.
|
|
3837
3691
|
* Category Ids must have a namespace.
|
|
3838
3692
|
*/
|
|
3839
|
-
setItemSettings(itemSettings: Record<
|
|
3693
|
+
setItemSettings(itemSettings: Record<string, string>): void;
|
|
3840
3694
|
/**
|
|
3841
3695
|
* @remarks
|
|
3842
3696
|
* Sets the list of item Ids that will target liquid blocks
|
|
@@ -3847,7 +3701,7 @@ export class AimAssistPresetSettings {
|
|
|
3847
3701
|
* @param items
|
|
3848
3702
|
* An array of item Ids.
|
|
3849
3703
|
*/
|
|
3850
|
-
setLiquidTargetingItems(items?:
|
|
3704
|
+
setLiquidTargetingItems(items?: string[]): void;
|
|
3851
3705
|
}
|
|
3852
3706
|
|
|
3853
3707
|
/**
|
|
@@ -3953,28 +3807,6 @@ export class AimAssistRegistry {
|
|
|
3953
3807
|
getPresets(): AimAssistPreset[];
|
|
3954
3808
|
}
|
|
3955
3809
|
|
|
3956
|
-
/**
|
|
3957
|
-
* @beta
|
|
3958
|
-
* Describes a single banner pattern, which includes a colour
|
|
3959
|
-
* and a pattern type.
|
|
3960
|
-
*/
|
|
3961
|
-
export class BannerPattern {
|
|
3962
|
-
private constructor();
|
|
3963
|
-
/**
|
|
3964
|
-
* @remarks
|
|
3965
|
-
* The color to apply to this banner pattern.
|
|
3966
|
-
*
|
|
3967
|
-
*/
|
|
3968
|
-
readonly color: string;
|
|
3969
|
-
/**
|
|
3970
|
-
* @remarks
|
|
3971
|
-
* The pattern type (e.g. gradient, chevron, cross, etc.) to
|
|
3972
|
-
* apply to the banner.
|
|
3973
|
-
*
|
|
3974
|
-
*/
|
|
3975
|
-
readonly pattern: string;
|
|
3976
|
-
}
|
|
3977
|
-
|
|
3978
3810
|
/**
|
|
3979
3811
|
* Describes a type of biome.
|
|
3980
3812
|
*/
|
|
@@ -4068,20 +3900,6 @@ export class Block {
|
|
|
4068
3900
|
* {@link LocationOutOfWorldBoundariesError}
|
|
4069
3901
|
*/
|
|
4070
3902
|
readonly isLiquid: boolean;
|
|
4071
|
-
/**
|
|
4072
|
-
* @beta
|
|
4073
|
-
* @remarks
|
|
4074
|
-
* Returns true if this block is solid and impassible - (e.g.,
|
|
4075
|
-
* a cobblestone block and a diamond block are solid, while a
|
|
4076
|
-
* ladder block and a fence block are not).
|
|
4077
|
-
*
|
|
4078
|
-
* @throws This property can throw when used.
|
|
4079
|
-
*
|
|
4080
|
-
* {@link LocationInUnloadedChunkError}
|
|
4081
|
-
*
|
|
4082
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4083
|
-
*/
|
|
4084
|
-
readonly isSolid: boolean;
|
|
4085
3903
|
/**
|
|
4086
3904
|
* @remarks
|
|
4087
3905
|
* Returns true if this reference to a block is still valid
|
|
@@ -4247,30 +4065,6 @@ export class Block {
|
|
|
4247
4065
|
* {@link LocationOutOfWorldBoundariesError}
|
|
4248
4066
|
*/
|
|
4249
4067
|
canContainLiquid(liquidType: LiquidType): boolean;
|
|
4250
|
-
/**
|
|
4251
|
-
* @beta
|
|
4252
|
-
* @remarks
|
|
4253
|
-
* Checks to see whether it is valid to place the specified
|
|
4254
|
-
* block type or block permutation, on a specified face on this
|
|
4255
|
-
* block.
|
|
4256
|
-
*
|
|
4257
|
-
* @param blockToPlace
|
|
4258
|
-
* Block type or block permutation to check placement for.
|
|
4259
|
-
* @param faceToPlaceOn
|
|
4260
|
-
* Optional specific face of this block to check placement
|
|
4261
|
-
* against.
|
|
4262
|
-
* @returns
|
|
4263
|
-
* Returns `true` if the block type or permutation can be
|
|
4264
|
-
* placed on this block, else `false`.
|
|
4265
|
-
* @throws This function can throw errors.
|
|
4266
|
-
*
|
|
4267
|
-
* {@link Error}
|
|
4268
|
-
*
|
|
4269
|
-
* {@link LocationInUnloadedChunkError}
|
|
4270
|
-
*
|
|
4271
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4272
|
-
*/
|
|
4273
|
-
canPlace(blockToPlace: BlockPermutation | BlockType | string, faceToPlaceOn?: Direction): boolean;
|
|
4274
4068
|
/**
|
|
4275
4069
|
* @remarks
|
|
4276
4070
|
* Returns the {@link Vector3} of the center of this block on
|
|
@@ -4367,15 +4161,6 @@ export class Block {
|
|
|
4367
4161
|
* {@link LocationInUnloadedChunkError}
|
|
4368
4162
|
*/
|
|
4369
4163
|
getLightLevel(): number;
|
|
4370
|
-
/**
|
|
4371
|
-
* @beta
|
|
4372
|
-
* @throws This function can throw errors.
|
|
4373
|
-
*
|
|
4374
|
-
* {@link LocationInUnloadedChunkError}
|
|
4375
|
-
*
|
|
4376
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4377
|
-
*/
|
|
4378
|
-
getMapColor(): RGBA;
|
|
4379
4164
|
/**
|
|
4380
4165
|
* @remarks
|
|
4381
4166
|
* Returns array of all loaded block parts if this block has
|
|
@@ -4448,15 +4233,6 @@ export class Block {
|
|
|
4448
4233
|
* {@link LocationOutOfWorldBoundariesError}
|
|
4449
4234
|
*/
|
|
4450
4235
|
hasComponent(componentId: string): boolean;
|
|
4451
|
-
/**
|
|
4452
|
-
* @beta
|
|
4453
|
-
* @throws This function can throw errors.
|
|
4454
|
-
*
|
|
4455
|
-
* {@link LocationInUnloadedChunkError}
|
|
4456
|
-
*
|
|
4457
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4458
|
-
*/
|
|
4459
|
-
hasScheduledNamedTick(eventName: string): boolean;
|
|
4460
4236
|
/**
|
|
4461
4237
|
* @remarks
|
|
4462
4238
|
* Checks to see if the permutation of this block has a
|
|
@@ -4597,47 +4373,6 @@ export class Block {
|
|
|
4597
4373
|
* {@link LocationOutOfWorldBoundariesError}
|
|
4598
4374
|
*/
|
|
4599
4375
|
offset(offset: Vector3): Block | undefined;
|
|
4600
|
-
/**
|
|
4601
|
-
* @beta
|
|
4602
|
-
* @remarks
|
|
4603
|
-
* Removes all scheduled named tick events from this block with
|
|
4604
|
-
* the specified event name.
|
|
4605
|
-
*
|
|
4606
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4607
|
-
*
|
|
4608
|
-
* @param eventName
|
|
4609
|
-
* Name of the scheduled event to remove.
|
|
4610
|
-
* @throws This function can throw errors.
|
|
4611
|
-
*
|
|
4612
|
-
* {@link LocationInUnloadedChunkError}
|
|
4613
|
-
*
|
|
4614
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4615
|
-
*/
|
|
4616
|
-
removeScheduledNamedTick(eventName: string): void;
|
|
4617
|
-
/**
|
|
4618
|
-
* @beta
|
|
4619
|
-
* @remarks
|
|
4620
|
-
* Schedules a named tick event for this block. The event will
|
|
4621
|
-
* be delivered to block custom components registered with the
|
|
4622
|
-
* `onNamedTick` callback after the specified delay.
|
|
4623
|
-
*
|
|
4624
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4625
|
-
*
|
|
4626
|
-
* @param eventName
|
|
4627
|
-
* Name of the event to schedule. Up to 31 characters.
|
|
4628
|
-
* @param tickDelay
|
|
4629
|
-
* Number of ticks to wait before the event is raised. Must be
|
|
4630
|
-
* at least 1.
|
|
4631
|
-
* Minimum value: 1
|
|
4632
|
-
* @throws This function can throw errors.
|
|
4633
|
-
*
|
|
4634
|
-
* {@link Error}
|
|
4635
|
-
*
|
|
4636
|
-
* {@link LocationInUnloadedChunkError}
|
|
4637
|
-
*
|
|
4638
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4639
|
-
*/
|
|
4640
|
-
scheduleNamedTick(eventName: string, tickDelay: number): void;
|
|
4641
4376
|
/**
|
|
4642
4377
|
* @remarks
|
|
4643
4378
|
* Sets the block in the dimension to the state of the
|
|
@@ -4706,27 +4441,6 @@ export class Block {
|
|
|
4706
4441
|
* {@link LocationOutOfWorldBoundariesError}
|
|
4707
4442
|
*/
|
|
4708
4443
|
south(steps?: number): Block | undefined;
|
|
4709
|
-
/**
|
|
4710
|
-
* @beta
|
|
4711
|
-
* @remarks
|
|
4712
|
-
* Tries to set the block in the dimension to the state of the
|
|
4713
|
-
* permutation by first checking if the placement is valid.
|
|
4714
|
-
*
|
|
4715
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4716
|
-
*
|
|
4717
|
-
* @param permutation
|
|
4718
|
-
* Permutation that contains a set of property states for the
|
|
4719
|
-
* Block.
|
|
4720
|
-
* @returns
|
|
4721
|
-
* Returns `true` if the block permutation data was
|
|
4722
|
-
* successfully set, else `false`.
|
|
4723
|
-
* @throws This function can throw errors.
|
|
4724
|
-
*
|
|
4725
|
-
* {@link LocationInUnloadedChunkError}
|
|
4726
|
-
*
|
|
4727
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4728
|
-
*/
|
|
4729
|
-
trySetPermutation(permutation: BlockPermutation): boolean;
|
|
4730
4444
|
/**
|
|
4731
4445
|
* @remarks
|
|
4732
4446
|
* Returns the {@link Block} to the west of this block
|
|
@@ -4744,137 +4458,6 @@ export class Block {
|
|
|
4744
4458
|
west(steps?: number): Block | undefined;
|
|
4745
4459
|
}
|
|
4746
4460
|
|
|
4747
|
-
/**
|
|
4748
|
-
* @beta
|
|
4749
|
-
* Bounding Box Utils is a utility class that provides a number
|
|
4750
|
-
* of useful functions for the creation and utility of
|
|
4751
|
-
* {@link BlockBoundingBox} objects
|
|
4752
|
-
*/
|
|
4753
|
-
export class BlockBoundingBoxUtils {
|
|
4754
|
-
private constructor();
|
|
4755
|
-
/**
|
|
4756
|
-
* @remarks
|
|
4757
|
-
* Create a validated instance of a {@link BlockBoundingBox}
|
|
4758
|
-
* where the min and max components are guaranteed to be (min
|
|
4759
|
-
* <= max)
|
|
4760
|
-
*
|
|
4761
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4762
|
-
*
|
|
4763
|
-
* @param min
|
|
4764
|
-
* A corner world location
|
|
4765
|
-
* @param max
|
|
4766
|
-
* A corner world location diametrically opposite
|
|
4767
|
-
*/
|
|
4768
|
-
static createValid(min: Vector3, max: Vector3): BlockBoundingBox;
|
|
4769
|
-
/**
|
|
4770
|
-
* @remarks
|
|
4771
|
-
* Expand a {@link BlockBoundingBox} by a given amount along
|
|
4772
|
-
* each axis.
|
|
4773
|
-
* Sizes can be negative to perform contraction.
|
|
4774
|
-
* Note: corners can be inverted if the contraction size is
|
|
4775
|
-
* greater than the span, but the min/max relationship will
|
|
4776
|
-
* remain correct
|
|
4777
|
-
*
|
|
4778
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4779
|
-
*
|
|
4780
|
-
* @returns
|
|
4781
|
-
* Return a new {@link BlockBoundingBox} object representing
|
|
4782
|
-
* the changes
|
|
4783
|
-
*/
|
|
4784
|
-
static dilate(box: BlockBoundingBox, size: Vector3): BlockBoundingBox;
|
|
4785
|
-
/**
|
|
4786
|
-
* @remarks
|
|
4787
|
-
* Check if two {@link BlockBoundingBox} objects are identical
|
|
4788
|
-
*
|
|
4789
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4790
|
-
*
|
|
4791
|
-
*/
|
|
4792
|
-
static equals(box: BlockBoundingBox, other: BlockBoundingBox): boolean;
|
|
4793
|
-
/**
|
|
4794
|
-
* @remarks
|
|
4795
|
-
* Expand the initial box object bounds to include the 2nd box
|
|
4796
|
-
* argument. The resultant {@link BlockBoundingBox} object
|
|
4797
|
-
* will be a BlockBoundingBox which exactly encompasses the two
|
|
4798
|
-
* boxes.
|
|
4799
|
-
*
|
|
4800
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4801
|
-
*
|
|
4802
|
-
* @returns
|
|
4803
|
-
* A new {@link BlockBoundingBox} instance representing the
|
|
4804
|
-
* smallest possible bounding box which can encompass both
|
|
4805
|
-
*/
|
|
4806
|
-
static expand(box: BlockBoundingBox, other: BlockBoundingBox): BlockBoundingBox;
|
|
4807
|
-
/**
|
|
4808
|
-
* @remarks
|
|
4809
|
-
* Calculate the center block of a given
|
|
4810
|
-
* {@link BlockBoundingBox} object.
|
|
4811
|
-
*
|
|
4812
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4813
|
-
*
|
|
4814
|
-
* @returns
|
|
4815
|
-
* Note that {@link BlockBoundingBox} objects represent whole
|
|
4816
|
-
* blocks, so the center of boxes which have odd numbered
|
|
4817
|
-
* bounds are not mathematically centered...
|
|
4818
|
-
* i.e. a BlockBoundingBox( 0,0,0 -> 3,3,3 ) would have a
|
|
4819
|
-
* center of (1,1,1) (not (1.5, 1.5, 1.5) as expected)
|
|
4820
|
-
*/
|
|
4821
|
-
static getCenter(box: BlockBoundingBox): Vector3;
|
|
4822
|
-
/**
|
|
4823
|
-
* @remarks
|
|
4824
|
-
* Calculate the BlockBoundingBox which represents the union
|
|
4825
|
-
* area of two intersecting BlockBoundingBoxes
|
|
4826
|
-
*
|
|
4827
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4828
|
-
*
|
|
4829
|
-
*/
|
|
4830
|
-
static getIntersection(box: BlockBoundingBox, other: BlockBoundingBox): BlockBoundingBox | undefined;
|
|
4831
|
-
/**
|
|
4832
|
-
* @remarks
|
|
4833
|
-
* Get the Span of each of the BlockBoundingBox Axis components
|
|
4834
|
-
*
|
|
4835
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4836
|
-
*
|
|
4837
|
-
*/
|
|
4838
|
-
static getSpan(box: BlockBoundingBox): Vector3;
|
|
4839
|
-
/**
|
|
4840
|
-
* @remarks
|
|
4841
|
-
* Check to see if two BlockBoundingBox objects intersect
|
|
4842
|
-
*
|
|
4843
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4844
|
-
*
|
|
4845
|
-
*/
|
|
4846
|
-
static intersects(box: BlockBoundingBox, other: BlockBoundingBox): boolean;
|
|
4847
|
-
/**
|
|
4848
|
-
* @remarks
|
|
4849
|
-
* Check to see if a given coordinate is inside a
|
|
4850
|
-
* BlockBoundingBox
|
|
4851
|
-
*
|
|
4852
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4853
|
-
*
|
|
4854
|
-
*/
|
|
4855
|
-
static isInside(box: BlockBoundingBox, pos: Vector3): boolean;
|
|
4856
|
-
/**
|
|
4857
|
-
* @remarks
|
|
4858
|
-
* Check to see if a BlockBoundingBox is valid (i.e. (min <=
|
|
4859
|
-
* max))
|
|
4860
|
-
*
|
|
4861
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4862
|
-
*
|
|
4863
|
-
*/
|
|
4864
|
-
static isValid(box: BlockBoundingBox): boolean;
|
|
4865
|
-
/**
|
|
4866
|
-
* @remarks
|
|
4867
|
-
* Move a BlockBoundingBox by a given amount
|
|
4868
|
-
*
|
|
4869
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
4870
|
-
*
|
|
4871
|
-
* @returns
|
|
4872
|
-
* Return a new BlockBoundingBox object which represents the
|
|
4873
|
-
* change
|
|
4874
|
-
*/
|
|
4875
|
-
static translate(box: BlockBoundingBox, delta: Vector3): BlockBoundingBox;
|
|
4876
|
-
}
|
|
4877
|
-
|
|
4878
4461
|
/**
|
|
4879
4462
|
* Base type for components associated with blocks.
|
|
4880
4463
|
*/
|
|
@@ -4981,52 +4564,6 @@ export class BlockComponentEntityFallOnEvent extends BlockEvent {
|
|
|
4981
4564
|
readonly fallDistance: number;
|
|
4982
4565
|
}
|
|
4983
4566
|
|
|
4984
|
-
/**
|
|
4985
|
-
* @beta
|
|
4986
|
-
* Contains information regarding a named tick event for a
|
|
4987
|
-
* specific block.
|
|
4988
|
-
*/
|
|
4989
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
4990
|
-
export class BlockComponentNamedTickEvent extends BlockEvent {
|
|
4991
|
-
private constructor();
|
|
4992
|
-
/**
|
|
4993
|
-
* @remarks
|
|
4994
|
-
* Checks whether this named tick event has the specified name.
|
|
4995
|
-
* Events are namespaced with their content UUID. Two named
|
|
4996
|
-
* tick events with the same name but scheduled from different
|
|
4997
|
-
* packs will not respond the same to this method.
|
|
4998
|
-
*
|
|
4999
|
-
* @param eventName
|
|
5000
|
-
* The name to check against this event.
|
|
5001
|
-
* @returns
|
|
5002
|
-
* Returns true if the event name matches the specified name;
|
|
5003
|
-
* otherwise, false.
|
|
5004
|
-
*/
|
|
5005
|
-
isName(eventName: string): boolean;
|
|
5006
|
-
}
|
|
5007
|
-
|
|
5008
|
-
/**
|
|
5009
|
-
* @beta
|
|
5010
|
-
* Contains information regarding neighboring block changes for
|
|
5011
|
-
* a specific block.
|
|
5012
|
-
*/
|
|
5013
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
5014
|
-
export class BlockComponentNeighborChangedAfterEvent extends BlockEvent {
|
|
5015
|
-
private constructor();
|
|
5016
|
-
/**
|
|
5017
|
-
* @remarks
|
|
5018
|
-
* Returns the neighboring block changes for this event.
|
|
5019
|
-
*
|
|
5020
|
-
* @returns
|
|
5021
|
-
* One entry for each neighboring direction that changed,
|
|
5022
|
-
* ordered by when each direction first changed. If a direction
|
|
5023
|
-
* changed multiple times during the tick, the entry contains
|
|
5024
|
-
* the permutation before the first change and after the last
|
|
5025
|
-
* change. Intermediate permutations are not included.
|
|
5026
|
-
*/
|
|
5027
|
-
getChanges(): NeighborChange[];
|
|
5028
|
-
}
|
|
5029
|
-
|
|
5030
4567
|
/**
|
|
5031
4568
|
* Contains information regarding a specific block that was
|
|
5032
4569
|
* placed.
|
|
@@ -5143,13 +4680,6 @@ export class BlockComponentRandomTickEvent extends BlockEvent {
|
|
|
5143
4680
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
5144
4681
|
export class BlockComponentRedstoneUpdateEvent extends BlockEvent {
|
|
5145
4682
|
private constructor();
|
|
5146
|
-
/**
|
|
5147
|
-
* @beta
|
|
5148
|
-
* @remarks
|
|
5149
|
-
* The first update event for the redstone component.
|
|
5150
|
-
*
|
|
5151
|
-
*/
|
|
5152
|
-
readonly firstUpdate: boolean;
|
|
5153
4683
|
/**
|
|
5154
4684
|
* @remarks
|
|
5155
4685
|
* The redstone signal strength passing through this block. It
|
|
@@ -5444,181 +4974,6 @@ export class BlockDynamicPropertiesComponent extends BlockComponent {
|
|
|
5444
4974
|
totalByteCount(): number;
|
|
5445
4975
|
}
|
|
5446
4976
|
|
|
5447
|
-
/**
|
|
5448
|
-
* @beta
|
|
5449
|
-
* Represents storage for entities associated with a block
|
|
5450
|
-
* entity. This component is available on blocks whose behavior
|
|
5451
|
-
* pack definition enables entity storage with the
|
|
5452
|
-
* `minecraft:block_entity` component. Stored entities are
|
|
5453
|
-
* serialized and removed from the world until they are
|
|
5454
|
-
* released or transferred. A block can store up to four
|
|
5455
|
-
* entities. Entity storage is scoped to the content pack
|
|
5456
|
-
* accessing it.
|
|
5457
|
-
*/
|
|
5458
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
5459
|
-
export class BlockEntityStorageComponent extends BlockComponent {
|
|
5460
|
-
private constructor();
|
|
5461
|
-
static readonly componentId = 'minecraft:entity_storage';
|
|
5462
|
-
/**
|
|
5463
|
-
* @remarks
|
|
5464
|
-
* Returns information about the entities stored in this
|
|
5465
|
-
* block's entity storage. The returned entities are not
|
|
5466
|
-
* present in the world while they are stored. Only entities
|
|
5467
|
-
* stored by the current content pack are included.
|
|
5468
|
-
*
|
|
5469
|
-
* @returns
|
|
5470
|
-
* An array of {@link BlockEntityStorageInfo} values containing
|
|
5471
|
-
* the unique ID and definition ID of each stored entity.
|
|
5472
|
-
* Returns an empty array when no entities are stored by the
|
|
5473
|
-
* current content pack.
|
|
5474
|
-
* @throws
|
|
5475
|
-
* Throws if the block entity is invalid or the block's
|
|
5476
|
-
* location is not loaded or is outside the world boundaries.
|
|
5477
|
-
*
|
|
5478
|
-
* {@link Error}
|
|
5479
|
-
*
|
|
5480
|
-
* {@link InvalidBlockComponentError}
|
|
5481
|
-
*
|
|
5482
|
-
* {@link LocationInUnloadedChunkError}
|
|
5483
|
-
*
|
|
5484
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
5485
|
-
*/
|
|
5486
|
-
getEntities(): BlockEntityStorageInfo[];
|
|
5487
|
-
/**
|
|
5488
|
-
* @remarks
|
|
5489
|
-
* Releases a stored entity from this block's entity storage
|
|
5490
|
-
* and spawns it back into the world, at the same location it
|
|
5491
|
-
* was when stored.
|
|
5492
|
-
*
|
|
5493
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
5494
|
-
*
|
|
5495
|
-
* @param entityId
|
|
5496
|
-
* The unique ID of the stored entity. Use the value returned
|
|
5497
|
-
* by {@link BlockEntityStorageComponent.store} or the
|
|
5498
|
-
* `uniqueId` property from {@link BlockEntityStorageInfo}.
|
|
5499
|
-
* @returns
|
|
5500
|
-
* The released {@link Entity}. The released entity receives a
|
|
5501
|
-
* new runtime ID.
|
|
5502
|
-
* @throws
|
|
5503
|
-
* Throws if the entity ID is invalid or does not identify an
|
|
5504
|
-
* entity stored by the current content pack, if the stored
|
|
5505
|
-
* entity cannot be loaded or spawned, or if the block entity
|
|
5506
|
-
* is invalid.
|
|
5507
|
-
*
|
|
5508
|
-
* {@link Error}
|
|
5509
|
-
*
|
|
5510
|
-
* {@link InvalidBlockComponentError}
|
|
5511
|
-
*
|
|
5512
|
-
* {@link LocationInUnloadedChunkError}
|
|
5513
|
-
*
|
|
5514
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
5515
|
-
*/
|
|
5516
|
-
release(entityId: string): Entity;
|
|
5517
|
-
/**
|
|
5518
|
-
* @remarks
|
|
5519
|
-
* Returns the number of entities stored in this block's entity
|
|
5520
|
-
* storage by the current content pack.
|
|
5521
|
-
*
|
|
5522
|
-
* @returns
|
|
5523
|
-
* The number of entities stored by the current content pack.
|
|
5524
|
-
* @throws
|
|
5525
|
-
* Throws if the block entity is invalid or the block's
|
|
5526
|
-
* location is not loaded or is outside the world boundaries.
|
|
5527
|
-
*
|
|
5528
|
-
* {@link Error}
|
|
5529
|
-
*
|
|
5530
|
-
* {@link InvalidBlockComponentError}
|
|
5531
|
-
*
|
|
5532
|
-
* {@link LocationInUnloadedChunkError}
|
|
5533
|
-
*
|
|
5534
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
5535
|
-
*/
|
|
5536
|
-
size(): number;
|
|
5537
|
-
/**
|
|
5538
|
-
* @remarks
|
|
5539
|
-
* Serializes and stores an entity in this block's entity
|
|
5540
|
-
* storage. The entity is removed from the world after it is
|
|
5541
|
-
* stored. Only non-player mob entities can be stored. Entities
|
|
5542
|
-
* with passengers or that are passengers cannot be stored.
|
|
5543
|
-
*
|
|
5544
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
5545
|
-
*
|
|
5546
|
-
* @param entity
|
|
5547
|
-
* The {@link Entity} to store.
|
|
5548
|
-
* @returns
|
|
5549
|
-
* The unique ID assigned to the stored entity. Keep this ID to
|
|
5550
|
-
* release, transfer, or inspect the stored entity later.
|
|
5551
|
-
* @throws
|
|
5552
|
-
* Throws if the storage is full, the entity is already stored,
|
|
5553
|
-
* the entity cannot be serialized, or the block entity is
|
|
5554
|
-
* invalid.
|
|
5555
|
-
*
|
|
5556
|
-
* {@link Error}
|
|
5557
|
-
*
|
|
5558
|
-
* {@link InvalidBlockComponentError}
|
|
5559
|
-
*
|
|
5560
|
-
* {@link LocationInUnloadedChunkError}
|
|
5561
|
-
*
|
|
5562
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
5563
|
-
*/
|
|
5564
|
-
store(entity: Entity): string;
|
|
5565
|
-
/**
|
|
5566
|
-
* @remarks
|
|
5567
|
-
* Moves a stored entity from this block's entity storage to
|
|
5568
|
-
* the target block's entity storage without releasing it into
|
|
5569
|
-
* the world.
|
|
5570
|
-
*
|
|
5571
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
5572
|
-
*
|
|
5573
|
-
* @param entityId
|
|
5574
|
-
* The unique ID of the stored entity. Use the value returned
|
|
5575
|
-
* by {@link BlockEntityStorageComponent.store} or the
|
|
5576
|
-
* `uniqueId` property from {@link BlockEntityStorageInfo}.
|
|
5577
|
-
* @param targetBlock
|
|
5578
|
-
* The target {@link Block} with an entity storage component.
|
|
5579
|
-
* The target block must be in the same dimension as this
|
|
5580
|
-
* block.
|
|
5581
|
-
* @throws
|
|
5582
|
-
* Throws if the entity ID is invalid or not stored by the
|
|
5583
|
-
* current content pack, if the target block is invalid, in
|
|
5584
|
-
* another dimension, lacks entity storage, or is full, or if
|
|
5585
|
-
* the source and target blocks are the same.
|
|
5586
|
-
*
|
|
5587
|
-
* {@link Error}
|
|
5588
|
-
*
|
|
5589
|
-
* {@link InvalidBlockComponentError}
|
|
5590
|
-
*
|
|
5591
|
-
* {@link LocationInUnloadedChunkError}
|
|
5592
|
-
*
|
|
5593
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
5594
|
-
*/
|
|
5595
|
-
transfer(entityId: string, targetBlock: Block): void;
|
|
5596
|
-
}
|
|
5597
|
-
|
|
5598
|
-
/**
|
|
5599
|
-
* @beta
|
|
5600
|
-
* Contains identifying information about an entity stored in a
|
|
5601
|
-
* {@link BlockEntityStorageComponent}. Stored entities are not
|
|
5602
|
-
* present in the world until they are released.
|
|
5603
|
-
*/
|
|
5604
|
-
export class BlockEntityStorageInfo {
|
|
5605
|
-
private constructor();
|
|
5606
|
-
/**
|
|
5607
|
-
* @remarks
|
|
5608
|
-
* The entity's definition ID, such as `minecraft:pig`.
|
|
5609
|
-
*
|
|
5610
|
-
*/
|
|
5611
|
-
readonly definitionId: string;
|
|
5612
|
-
/**
|
|
5613
|
-
* @remarks
|
|
5614
|
-
* The unique ID of the stored entity. Use this ID with
|
|
5615
|
-
* {@link BlockEntityStorageComponent.release} or
|
|
5616
|
-
* {@link BlockEntityStorageComponent.transfer}.
|
|
5617
|
-
*
|
|
5618
|
-
*/
|
|
5619
|
-
readonly uniqueId: string;
|
|
5620
|
-
}
|
|
5621
|
-
|
|
5622
4977
|
/**
|
|
5623
4978
|
* Contains information regarding an event that impacts a
|
|
5624
4979
|
* specific block.
|
|
@@ -5879,18 +5234,6 @@ export class BlockLocationIterator implements Iterable<Vector3> {
|
|
|
5879
5234
|
*
|
|
5880
5235
|
*/
|
|
5881
5236
|
[Symbol.iterator](): Iterator<Vector3>;
|
|
5882
|
-
/**
|
|
5883
|
-
* @beta
|
|
5884
|
-
* @remarks
|
|
5885
|
-
* Checks if the underlining block volume has been invalidated.
|
|
5886
|
-
* Will return false if the block volume was modified between
|
|
5887
|
-
* creating the iterator and iterating it, and true otherwise.
|
|
5888
|
-
*
|
|
5889
|
-
* @throws This function can throw errors.
|
|
5890
|
-
*
|
|
5891
|
-
* {@link minecraftcommon.EngineError}
|
|
5892
|
-
*/
|
|
5893
|
-
isValid(): boolean;
|
|
5894
5237
|
/**
|
|
5895
5238
|
* @remarks
|
|
5896
5239
|
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
@@ -6289,139 +5632,6 @@ export class BlockPrecipitationInteractionsComponent extends BlockComponent {
|
|
|
6289
5632
|
obstructsRain(): boolean;
|
|
6290
5633
|
}
|
|
6291
5634
|
|
|
6292
|
-
/**
|
|
6293
|
-
* @beta
|
|
6294
|
-
* Represents a block component that provides access to recipe
|
|
6295
|
-
* crafting.
|
|
6296
|
-
*/
|
|
6297
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
6298
|
-
export class BlockRecipeCraftingComponent extends BlockComponent {
|
|
6299
|
-
private constructor();
|
|
6300
|
-
/**
|
|
6301
|
-
* @remarks
|
|
6302
|
-
* Returns an array of all players currently interacting with
|
|
6303
|
-
* this block.
|
|
6304
|
-
*
|
|
6305
|
-
*/
|
|
6306
|
-
readonly players: Player[];
|
|
6307
|
-
static readonly componentId = 'minecraft:recipe_crafting';
|
|
6308
|
-
/**
|
|
6309
|
-
* @remarks
|
|
6310
|
-
* Gets the recipe crafting context for a player interacting
|
|
6311
|
-
* with this block.
|
|
6312
|
-
*
|
|
6313
|
-
* @param player
|
|
6314
|
-
* The player for whom to retrieve the crafting context.
|
|
6315
|
-
* @returns
|
|
6316
|
-
* The current recipe crafting context for the player, or
|
|
6317
|
-
* undefined if the player isn't crafting.
|
|
6318
|
-
* @throws This function can throw errors.
|
|
6319
|
-
*
|
|
6320
|
-
* {@link minecraftcommon.EngineError}
|
|
6321
|
-
*
|
|
6322
|
-
* {@link InvalidEntityError}
|
|
6323
|
-
*/
|
|
6324
|
-
getCraftingContext(player: Player): RecipeCraftingContext | undefined;
|
|
6325
|
-
}
|
|
6326
|
-
|
|
6327
|
-
/**
|
|
6328
|
-
* @beta
|
|
6329
|
-
* Represents a block component that provides access to recipe
|
|
6330
|
-
* processing inputs and output.
|
|
6331
|
-
*/
|
|
6332
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
6333
|
-
export class BlockRecipeProcessingComponent extends BlockComponent {
|
|
6334
|
-
private constructor();
|
|
6335
|
-
/**
|
|
6336
|
-
* @remarks
|
|
6337
|
-
* The number of addressable input slots for getInputItem,
|
|
6338
|
-
* setInputItem, setInputSlotEnabled, and getInputSlotEnabled.
|
|
6339
|
-
*
|
|
6340
|
-
* @throws This property can throw when used.
|
|
6341
|
-
*
|
|
6342
|
-
* {@link InvalidBlockComponentError}
|
|
6343
|
-
*/
|
|
6344
|
-
readonly inputSlotCount: number;
|
|
6345
|
-
static readonly componentId = 'minecraft:recipe_processing';
|
|
6346
|
-
/**
|
|
6347
|
-
* @remarks
|
|
6348
|
-
* Gets the item in the provided input slot.
|
|
6349
|
-
*
|
|
6350
|
-
* @param slot
|
|
6351
|
-
* The zero-based input slot index.
|
|
6352
|
-
* @returns
|
|
6353
|
-
* The item stack in the input slot, or undefined if the slot
|
|
6354
|
-
* is empty.
|
|
6355
|
-
* @throws This function can throw errors.
|
|
6356
|
-
*
|
|
6357
|
-
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
6358
|
-
*
|
|
6359
|
-
* {@link InvalidBlockComponentError}
|
|
6360
|
-
*/
|
|
6361
|
-
getInputItem(slot: number): ItemStack | undefined;
|
|
6362
|
-
/**
|
|
6363
|
-
* @remarks
|
|
6364
|
-
* Gets whether an input slot is enabled for recipe processing.
|
|
6365
|
-
*
|
|
6366
|
-
* @param slot
|
|
6367
|
-
* The zero-based input slot index.
|
|
6368
|
-
* @returns
|
|
6369
|
-
* Whether the input slot is enabled.
|
|
6370
|
-
* @throws This function can throw errors.
|
|
6371
|
-
*
|
|
6372
|
-
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
6373
|
-
*
|
|
6374
|
-
* {@link InvalidBlockComponentError}
|
|
6375
|
-
*
|
|
6376
|
-
* {@link minecraftcommon.UnsupportedFunctionalityError}
|
|
6377
|
-
*/
|
|
6378
|
-
getInputSlotEnabled(slot: number): boolean;
|
|
6379
|
-
/**
|
|
6380
|
-
* @remarks
|
|
6381
|
-
* Gets the item produced by the current recipe processing
|
|
6382
|
-
* inputs.
|
|
6383
|
-
*
|
|
6384
|
-
* @returns
|
|
6385
|
-
* The output item stack, or undefined if the current inputs do
|
|
6386
|
-
* not produce an item.
|
|
6387
|
-
* @throws This function can throw errors.
|
|
6388
|
-
*
|
|
6389
|
-
* {@link InvalidBlockComponentError}
|
|
6390
|
-
*/
|
|
6391
|
-
getOutputItem(): ItemStack | undefined;
|
|
6392
|
-
/**
|
|
6393
|
-
* @remarks
|
|
6394
|
-
* Sets or clears an item in an input slot.
|
|
6395
|
-
*
|
|
6396
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
6397
|
-
*
|
|
6398
|
-
* @param slot
|
|
6399
|
-
* The zero-based input slot index.
|
|
6400
|
-
* @param item
|
|
6401
|
-
* The item stack to place in the slot, or undefined to clear
|
|
6402
|
-
* the slot.
|
|
6403
|
-
* @throws This function can throw errors.
|
|
6404
|
-
*
|
|
6405
|
-
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
6406
|
-
*
|
|
6407
|
-
* {@link InvalidBlockComponentError}
|
|
6408
|
-
*/
|
|
6409
|
-
setInputItem(slot: number, item?: ItemStack): void;
|
|
6410
|
-
/**
|
|
6411
|
-
* @remarks
|
|
6412
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
6413
|
-
*
|
|
6414
|
-
* @throws This function can throw errors.
|
|
6415
|
-
*
|
|
6416
|
-
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
6417
|
-
*
|
|
6418
|
-
* {@link InvalidBlockComponentError}
|
|
6419
|
-
*
|
|
6420
|
-
* {@link minecraftcommon.UnsupportedFunctionalityError}
|
|
6421
|
-
*/
|
|
6422
|
-
setInputSlotEnabled(slot: number, enabled: boolean): void;
|
|
6423
|
-
}
|
|
6424
|
-
|
|
6425
5635
|
/**
|
|
6426
5636
|
* Represents a block that can play a record.
|
|
6427
5637
|
*/
|
|
@@ -6844,49 +6054,6 @@ export class BlockTypes {
|
|
|
6844
6054
|
static getAll(): BlockType[];
|
|
6845
6055
|
}
|
|
6846
6056
|
|
|
6847
|
-
/**
|
|
6848
|
-
* @beta
|
|
6849
|
-
* Represents the vibration properties of a block with a
|
|
6850
|
-
* 'minecraft:vibration_properties' component.
|
|
6851
|
-
*/
|
|
6852
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
6853
|
-
export class BlockVibrationPropertiesComponent extends BlockComponent {
|
|
6854
|
-
private constructor();
|
|
6855
|
-
static readonly componentId = 'minecraft:vibration_properties';
|
|
6856
|
-
/**
|
|
6857
|
-
* @remarks
|
|
6858
|
-
* Gets whether this block can dampen vibrations. Vibrations
|
|
6859
|
-
* that occur on this block will be discarded by this block if
|
|
6860
|
-
* it can dampen vibrations. Returns false when the block does
|
|
6861
|
-
* not define a 'minecraft:vibration_properties' component.
|
|
6862
|
-
*
|
|
6863
|
-
* @returns
|
|
6864
|
-
* Whether this block can dampen vibrations.
|
|
6865
|
-
* @throws This function can throw errors.
|
|
6866
|
-
*
|
|
6867
|
-
* {@link LocationInUnloadedChunkError}
|
|
6868
|
-
*
|
|
6869
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
6870
|
-
*/
|
|
6871
|
-
getCanDampenVibrations(): boolean;
|
|
6872
|
-
/**
|
|
6873
|
-
* @remarks
|
|
6874
|
-
* Gets whether this block can occlude vibrations. Vibrations
|
|
6875
|
-
* that pass through this block will be discarded if this block
|
|
6876
|
-
* can occlude vibrations. Returns false when the block does
|
|
6877
|
-
* not define a 'minecraft:vibration_properties' component.
|
|
6878
|
-
*
|
|
6879
|
-
* @returns
|
|
6880
|
-
* Whether this block can occlude vibrations.
|
|
6881
|
-
* @throws This function can throw errors.
|
|
6882
|
-
*
|
|
6883
|
-
* {@link LocationInUnloadedChunkError}
|
|
6884
|
-
*
|
|
6885
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
6886
|
-
*/
|
|
6887
|
-
getCanOccludeVibrations(): boolean;
|
|
6888
|
-
}
|
|
6889
|
-
|
|
6890
6057
|
/**
|
|
6891
6058
|
* A BlockVolume is a simple interface to an object which
|
|
6892
6059
|
* represents a 3D rectangle of a given size (in blocks) at a
|
|
@@ -6982,15 +6149,6 @@ export class BlockVolumeBase {
|
|
|
6982
6149
|
*
|
|
6983
6150
|
*/
|
|
6984
6151
|
getBlockLocationIterator(): BlockLocationIterator;
|
|
6985
|
-
/**
|
|
6986
|
-
* @beta
|
|
6987
|
-
* @remarks
|
|
6988
|
-
* Return a {@link BlockBoundingBox} object which represents
|
|
6989
|
-
* the validated min and max coordinates of the volume
|
|
6990
|
-
*
|
|
6991
|
-
* @throws This function can throw errors.
|
|
6992
|
-
*/
|
|
6993
|
-
getBoundingBox(): BlockBoundingBox;
|
|
6994
6152
|
/**
|
|
6995
6153
|
* @remarks
|
|
6996
6154
|
* Return the capacity (volume) of the BlockVolume (W*D*H)
|
|
@@ -7262,23 +6420,6 @@ export class Camera {
|
|
|
7262
6420
|
| CameraSetRotOptions
|
|
7263
6421
|
| CameraTargetOptions,
|
|
7264
6422
|
): void;
|
|
7265
|
-
/**
|
|
7266
|
-
* @beta
|
|
7267
|
-
* @remarks
|
|
7268
|
-
* Sets the current active camera with easing.
|
|
7269
|
-
*
|
|
7270
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
7271
|
-
*
|
|
7272
|
-
* @param cameraPreset
|
|
7273
|
-
* Identifier of a camera preset file defined within JSON.
|
|
7274
|
-
* @param easeOptions
|
|
7275
|
-
* Options to ease the camera from the previous camera to the
|
|
7276
|
-
* current one.
|
|
7277
|
-
* @throws
|
|
7278
|
-
* Throws when easing to minecraft:first_person presets
|
|
7279
|
-
* currently without the experimental cameras toggle enabled.
|
|
7280
|
-
*/
|
|
7281
|
-
setCameraWithEase(cameraPreset: string, easeOptions: EaseOptions): void;
|
|
7282
6423
|
/**
|
|
7283
6424
|
* @remarks
|
|
7284
6425
|
* Sets the current active camera for the specified player and
|
|
@@ -7313,24 +6454,6 @@ export class Camera {
|
|
|
7313
6454
|
stopShaking(): void;
|
|
7314
6455
|
}
|
|
7315
6456
|
|
|
7316
|
-
/**
|
|
7317
|
-
* @beta
|
|
7318
|
-
* Loot item function that will try to copy the block entity
|
|
7319
|
-
* data from the destroyed block to the dropped item.
|
|
7320
|
-
*/
|
|
7321
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
7322
|
-
export class CarryOverBlockEntityDataFunction extends LootItemFunction {
|
|
7323
|
-
private constructor();
|
|
7324
|
-
/**
|
|
7325
|
-
* @remarks
|
|
7326
|
-
* If true, and if the block entity had dynamic_properties, the
|
|
7327
|
-
* function will copy the dynamic properties from the block
|
|
7328
|
-
* entity to the dropped item.
|
|
7329
|
-
*
|
|
7330
|
-
*/
|
|
7331
|
-
readonly dynamicProperties: boolean;
|
|
7332
|
-
}
|
|
7333
|
-
|
|
7334
6457
|
/**
|
|
7335
6458
|
* CatmullRom spline creation.
|
|
7336
6459
|
*/
|
|
@@ -7346,169 +6469,10 @@ export class CatmullRomSpline {
|
|
|
7346
6469
|
}
|
|
7347
6470
|
|
|
7348
6471
|
/**
|
|
7349
|
-
*
|
|
7350
|
-
* An event that fires as players enter chat messages.
|
|
6472
|
+
* Contains the device information for a client instance.
|
|
7351
6473
|
*/
|
|
7352
|
-
|
|
7353
|
-
|
|
7354
|
-
/**
|
|
7355
|
-
* @remarks
|
|
7356
|
-
* Message that is being broadcast.
|
|
7357
|
-
*
|
|
7358
|
-
*/
|
|
7359
|
-
readonly message: string;
|
|
7360
|
-
/**
|
|
7361
|
-
* @remarks
|
|
7362
|
-
* Player that sent the chat message.
|
|
7363
|
-
*
|
|
7364
|
-
*/
|
|
7365
|
-
readonly sender: Player;
|
|
7366
|
-
/**
|
|
7367
|
-
* @remarks
|
|
7368
|
-
* Optional list of players that will receive this message. If
|
|
7369
|
-
* defined, this message is directly targeted to one or more
|
|
7370
|
-
* players (i.e., is not broadcast.)
|
|
7371
|
-
*
|
|
7372
|
-
*/
|
|
7373
|
-
readonly targets?: Player[];
|
|
7374
|
-
}
|
|
7375
|
-
|
|
7376
|
-
/**
|
|
7377
|
-
* @beta
|
|
7378
|
-
* Manages callbacks that are connected to chat messages being
|
|
7379
|
-
* sent.
|
|
7380
|
-
*/
|
|
7381
|
-
export class ChatSendAfterEventSignal {
|
|
7382
|
-
private constructor();
|
|
7383
|
-
/**
|
|
7384
|
-
* @remarks
|
|
7385
|
-
* Adds a callback that will be called when new chat messages
|
|
7386
|
-
* are sent.
|
|
7387
|
-
*
|
|
7388
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
7389
|
-
*
|
|
7390
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
7391
|
-
*
|
|
7392
|
-
*/
|
|
7393
|
-
subscribe(callback: (arg0: ChatSendAfterEvent) => void): (arg0: ChatSendAfterEvent) => void;
|
|
7394
|
-
/**
|
|
7395
|
-
* @remarks
|
|
7396
|
-
* Removes a callback from being called when new chat messages
|
|
7397
|
-
* are sent.
|
|
7398
|
-
*
|
|
7399
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
7400
|
-
*
|
|
7401
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
7402
|
-
*
|
|
7403
|
-
*/
|
|
7404
|
-
unsubscribe(callback: (arg0: ChatSendAfterEvent) => void): void;
|
|
7405
|
-
}
|
|
7406
|
-
|
|
7407
|
-
/**
|
|
7408
|
-
* @beta
|
|
7409
|
-
* An event that fires as players enter chat messages.
|
|
7410
|
-
*/
|
|
7411
|
-
export class ChatSendBeforeEvent {
|
|
7412
|
-
private constructor();
|
|
7413
|
-
/**
|
|
7414
|
-
* @remarks
|
|
7415
|
-
* If set to true in a beforeChat event handler, this message
|
|
7416
|
-
* is not broadcast out.
|
|
7417
|
-
*
|
|
7418
|
-
*/
|
|
7419
|
-
cancel: boolean;
|
|
7420
|
-
/**
|
|
7421
|
-
* @remarks
|
|
7422
|
-
* Message that is being broadcast.
|
|
7423
|
-
*
|
|
7424
|
-
*/
|
|
7425
|
-
readonly message: string;
|
|
7426
|
-
/**
|
|
7427
|
-
* @remarks
|
|
7428
|
-
* Player that sent the chat message.
|
|
7429
|
-
*
|
|
7430
|
-
*/
|
|
7431
|
-
readonly sender: Player;
|
|
7432
|
-
/**
|
|
7433
|
-
* @remarks
|
|
7434
|
-
* Optional list of players that will receive this message. If
|
|
7435
|
-
* defined, this message is directly targeted to one or more
|
|
7436
|
-
* players (i.e., is not broadcast). This list can be modified
|
|
7437
|
-
* to change the message recipients.
|
|
7438
|
-
*
|
|
7439
|
-
*/
|
|
7440
|
-
targets?: Player[];
|
|
7441
|
-
}
|
|
7442
|
-
|
|
7443
|
-
/**
|
|
7444
|
-
* @beta
|
|
7445
|
-
* Manages callbacks that are connected to an event that fires
|
|
7446
|
-
* before chat messages are sent.
|
|
7447
|
-
* @example customCommand.ts
|
|
7448
|
-
* ```typescript
|
|
7449
|
-
* import { world, DimensionLocation } from '@minecraft/server';
|
|
7450
|
-
*
|
|
7451
|
-
* function customCommand(targetLocation: DimensionLocation) {
|
|
7452
|
-
* const chatCallback = world.beforeEvents.chatSend.subscribe(eventData => {
|
|
7453
|
-
* if (eventData.message.includes('cancel')) {
|
|
7454
|
-
* // Cancel event if the message contains "cancel"
|
|
7455
|
-
* eventData.cancel = true;
|
|
7456
|
-
* } else {
|
|
7457
|
-
* const args = eventData.message.split(' ');
|
|
7458
|
-
*
|
|
7459
|
-
* if (args.length > 0) {
|
|
7460
|
-
* switch (args[0].toLowerCase()) {
|
|
7461
|
-
* case 'echo':
|
|
7462
|
-
* // Send a modified version of chat message
|
|
7463
|
-
* world.sendMessage(`Echo '${eventData.message.substring(4).trim()}'`);
|
|
7464
|
-
* break;
|
|
7465
|
-
* case 'help':
|
|
7466
|
-
* world.sendMessage(`Available commands: echo <message>`);
|
|
7467
|
-
* break;
|
|
7468
|
-
* }
|
|
7469
|
-
* }
|
|
7470
|
-
* }
|
|
7471
|
-
* });
|
|
7472
|
-
* }
|
|
7473
|
-
* ```
|
|
7474
|
-
*/
|
|
7475
|
-
export class ChatSendBeforeEventSignal {
|
|
7476
|
-
private constructor();
|
|
7477
|
-
/**
|
|
7478
|
-
* @remarks
|
|
7479
|
-
* Adds a callback that will be called before new chat messages
|
|
7480
|
-
* are sent.
|
|
7481
|
-
*
|
|
7482
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
7483
|
-
*
|
|
7484
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
7485
|
-
*
|
|
7486
|
-
* @param callback
|
|
7487
|
-
* This closure is called with restricted-execution privilege.
|
|
7488
|
-
* @returns
|
|
7489
|
-
* Closure that is called with restricted-execution privilege.
|
|
7490
|
-
*/
|
|
7491
|
-
subscribe(callback: (arg0: ChatSendBeforeEvent) => void): (arg0: ChatSendBeforeEvent) => void;
|
|
7492
|
-
/**
|
|
7493
|
-
* @remarks
|
|
7494
|
-
* Removes a callback from being called before new chat
|
|
7495
|
-
* messages are sent.
|
|
7496
|
-
*
|
|
7497
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
7498
|
-
*
|
|
7499
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
7500
|
-
*
|
|
7501
|
-
* @param callback
|
|
7502
|
-
* This closure is called with restricted-execution privilege.
|
|
7503
|
-
*/
|
|
7504
|
-
unsubscribe(callback: (arg0: ChatSendBeforeEvent) => void): void;
|
|
7505
|
-
}
|
|
7506
|
-
|
|
7507
|
-
/**
|
|
7508
|
-
* Contains the device information for a client instance.
|
|
7509
|
-
*/
|
|
7510
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
7511
|
-
export class ClientSystemInfo extends SystemInfo {
|
|
6474
|
+
// @ts-ignore Class inheritance allowed for native defined classes
|
|
6475
|
+
export class ClientSystemInfo extends SystemInfo {
|
|
7512
6476
|
private constructor();
|
|
7513
6477
|
/**
|
|
7514
6478
|
* @remarks
|
|
@@ -7712,9 +6676,7 @@ export class Container {
|
|
|
7712
6676
|
*
|
|
7713
6677
|
* @param itemStack
|
|
7714
6678
|
* The stack of items to add.
|
|
7715
|
-
* @throws
|
|
7716
|
-
* Won't throw {@link ContainerRules} error for over weight
|
|
7717
|
-
* limit but will instead add items up to the weight limit.
|
|
6679
|
+
* @throws This function can throw errors.
|
|
7718
6680
|
*
|
|
7719
6681
|
* {@link ContainerRulesError}
|
|
7720
6682
|
*
|
|
@@ -7952,8 +6914,6 @@ export class Container {
|
|
|
7952
6914
|
* @throws
|
|
7953
6915
|
* Throws if either this container or `toContainer` are invalid
|
|
7954
6916
|
* or if the `fromSlot` or `toSlot` indices out of bounds.
|
|
7955
|
-
* Won't throw {@link ContainerRules} error for over weight
|
|
7956
|
-
* limit but will instead add items up to the weight limit.
|
|
7957
6917
|
*
|
|
7958
6918
|
* {@link ContainerRulesError}
|
|
7959
6919
|
*
|
|
@@ -8439,6 +7399,8 @@ export class CustomCommandRegistry {
|
|
|
8439
7399
|
* {@link minecraftcommon.EngineError}
|
|
8440
7400
|
*
|
|
8441
7401
|
* {@link NamespaceNameError}
|
|
7402
|
+
*
|
|
7403
|
+
* {@link RawMessageError}
|
|
8442
7404
|
*/
|
|
8443
7405
|
registerCommand(
|
|
8444
7406
|
customCommand: CustomCommand,
|
|
@@ -8459,6 +7421,8 @@ export class CustomCommandRegistry {
|
|
|
8459
7421
|
* {@link minecraftcommon.EngineError}
|
|
8460
7422
|
*
|
|
8461
7423
|
* {@link NamespaceNameError}
|
|
7424
|
+
*
|
|
7425
|
+
* {@link RawMessageError}
|
|
8462
7426
|
*/
|
|
8463
7427
|
registerEnum(name: string, values: string[]): void;
|
|
8464
7428
|
}
|
|
@@ -8580,15 +7544,6 @@ export class Dimension {
|
|
|
8580
7544
|
*
|
|
8581
7545
|
*/
|
|
8582
7546
|
readonly localizationKey: string;
|
|
8583
|
-
/**
|
|
8584
|
-
* @beta
|
|
8585
|
-
* @remarks
|
|
8586
|
-
* Provides access to point-of-interest (POI) managers for this
|
|
8587
|
-
* dimension. This property is available only when the POI
|
|
8588
|
-
* experiment is enabled.
|
|
8589
|
-
*
|
|
8590
|
-
*/
|
|
8591
|
-
readonly poiManager: PoiManager;
|
|
8592
7547
|
/**
|
|
8593
7548
|
* @remarks
|
|
8594
7549
|
* Calculates the location of the closest biome of a particular
|
|
@@ -8892,14 +7847,10 @@ export class Dimension {
|
|
|
8892
7847
|
getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
|
|
8893
7848
|
/**
|
|
8894
7849
|
* @remarks
|
|
8895
|
-
* Gets all the blocks in a volume that satisfy the
|
|
8896
|
-
* options.
|
|
7850
|
+
* Gets all the blocks in a volume that satisfy the filter.
|
|
8897
7851
|
*
|
|
8898
7852
|
* @param volume
|
|
8899
7853
|
* Volume of blocks that will be checked.
|
|
8900
|
-
* @param options
|
|
8901
|
-
* Block query options including filter criteria and optional
|
|
8902
|
-
* closest/farthest distance sorting from a location.
|
|
8903
7854
|
* @param allowUnloadedChunks
|
|
8904
7855
|
* If set to true will suppress the UnloadedChunksError if some
|
|
8905
7856
|
* or all of the block volume is outside of the loaded chunks.
|
|
@@ -8908,7 +7859,7 @@ export class Dimension {
|
|
|
8908
7859
|
* Defaults to: false
|
|
8909
7860
|
* @returns
|
|
8910
7861
|
* Returns the ListBlockVolume that contains all the block
|
|
8911
|
-
* locations that satisfied the block
|
|
7862
|
+
* locations that satisfied the block filter.
|
|
8912
7863
|
* @throws This function can throw errors.
|
|
8913
7864
|
*
|
|
8914
7865
|
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
@@ -9033,26 +7984,6 @@ export class Dimension {
|
|
|
9033
7984
|
* {@link minecraftcommon.UnsupportedFunctionalityError}
|
|
9034
7985
|
*/
|
|
9035
7986
|
getEntitiesFromRay(location: Vector3, direction: Vector3, options?: EntityRaycastOptions): EntityRaycastHit[];
|
|
9036
|
-
/**
|
|
9037
|
-
* @beta
|
|
9038
|
-
* @remarks
|
|
9039
|
-
* Returns a vector of generated structures that contain the
|
|
9040
|
-
* specified location (ex: Pillager Outpost, Mineshaft, etc.).
|
|
9041
|
-
* The vector will be empty if no structures are found.
|
|
9042
|
-
*
|
|
9043
|
-
* @param location
|
|
9044
|
-
* Location at which to check for structures.
|
|
9045
|
-
* @throws
|
|
9046
|
-
* An error will be thrown if the location is out of world
|
|
9047
|
-
* bounds.
|
|
9048
|
-
* An error will be thrown if the location is in an unloaded
|
|
9049
|
-
* chunk.
|
|
9050
|
-
*
|
|
9051
|
-
* {@link LocationInUnloadedChunkError}
|
|
9052
|
-
*
|
|
9053
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
9054
|
-
*/
|
|
9055
|
-
getGeneratedStructures(location: Vector3): (minecraftvanilladata.MinecraftFeatureTypes | string)[];
|
|
9056
7987
|
/**
|
|
9057
7988
|
* @remarks
|
|
9058
7989
|
* Returns the total brightness level of light shining on a
|
|
@@ -9114,16 +8045,6 @@ export class Dimension {
|
|
|
9114
8045
|
* @throws This function can throw errors.
|
|
9115
8046
|
*/
|
|
9116
8047
|
getTopmostBlock(locationXZ: VectorXZ, minHeight?: number): Block | undefined;
|
|
9117
|
-
/**
|
|
9118
|
-
* @beta
|
|
9119
|
-
* @remarks
|
|
9120
|
-
* Returns the current weather.
|
|
9121
|
-
*
|
|
9122
|
-
* @returns
|
|
9123
|
-
* Returns a WeatherType that explains the broad category of
|
|
9124
|
-
* weather that is currently going on.
|
|
9125
|
-
*/
|
|
9126
|
-
getWeather(): WeatherType;
|
|
9127
8048
|
/**
|
|
9128
8049
|
* @remarks
|
|
9129
8050
|
* Returns true if the chunk at the given location is loaded
|
|
@@ -9369,11 +8290,7 @@ export class Dimension {
|
|
|
9369
8290
|
* }
|
|
9370
8291
|
* ```
|
|
9371
8292
|
*/
|
|
9372
|
-
spawnEntity
|
|
9373
|
-
identifier: EntityIdentifierType<NoInfer<T>>,
|
|
9374
|
-
location: Vector3,
|
|
9375
|
-
options?: SpawnEntityOptions,
|
|
9376
|
-
): Entity;
|
|
8293
|
+
spawnEntity(identifier: EntityType | string, location: Vector3, options?: SpawnEntityOptions): Entity;
|
|
9377
8294
|
/**
|
|
9378
8295
|
* @remarks
|
|
9379
8296
|
* Creates a new item stack as an entity at the specified
|
|
@@ -9488,26 +8405,6 @@ export class Dimension {
|
|
|
9488
8405
|
* {@link LocationOutOfWorldBoundariesError}
|
|
9489
8406
|
*/
|
|
9490
8407
|
spawnXp(location: Vector3, amount: number): void;
|
|
9491
|
-
/**
|
|
9492
|
-
* @beta
|
|
9493
|
-
* @remarks
|
|
9494
|
-
* Stops all sounds from playing for all players.
|
|
9495
|
-
*
|
|
9496
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
9497
|
-
*
|
|
9498
|
-
*/
|
|
9499
|
-
stopAllSounds(): void;
|
|
9500
|
-
/**
|
|
9501
|
-
* @beta
|
|
9502
|
-
* @remarks
|
|
9503
|
-
* Stops a sound from playing for all players.
|
|
9504
|
-
*
|
|
9505
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
9506
|
-
*
|
|
9507
|
-
* @param soundId
|
|
9508
|
-
* Identifier of the sound.
|
|
9509
|
-
*/
|
|
9510
|
-
stopSound(soundId: string): void;
|
|
9511
8408
|
}
|
|
9512
8409
|
|
|
9513
8410
|
/**
|
|
@@ -10091,18 +8988,6 @@ export class Entity {
|
|
|
10091
8988
|
*
|
|
10092
8989
|
*/
|
|
10093
8990
|
readonly scoreboardIdentity?: ScoreboardIdentity;
|
|
10094
|
-
/**
|
|
10095
|
-
* @beta
|
|
10096
|
-
* @remarks
|
|
10097
|
-
* Retrieves or sets an entity that is used as the target of
|
|
10098
|
-
* AI-related behaviors, like attacking. If the entity
|
|
10099
|
-
* currently has no target returns undefined.
|
|
10100
|
-
*
|
|
10101
|
-
* @throws This property can throw when used.
|
|
10102
|
-
*
|
|
10103
|
-
* {@link InvalidEntityError}
|
|
10104
|
-
*/
|
|
10105
|
-
readonly target?: Entity;
|
|
10106
8991
|
/**
|
|
10107
8992
|
* @remarks
|
|
10108
8993
|
* Identifier of the type of the entity - for example,
|
|
@@ -11347,18 +10232,6 @@ export class EntityBaseMovementComponent extends EntityComponent {
|
|
|
11347
10232
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
11348
10233
|
export class EntityBreathableComponent extends EntityComponent {
|
|
11349
10234
|
private constructor();
|
|
11350
|
-
/**
|
|
11351
|
-
* @beta
|
|
11352
|
-
* @remarks
|
|
11353
|
-
* The current air supply of the entity.
|
|
11354
|
-
*
|
|
11355
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
11356
|
-
*
|
|
11357
|
-
* @throws
|
|
11358
|
-
* Will throw an error if the air supply is out of bounds
|
|
11359
|
-
* [suffocationTime, maxAirSupply].
|
|
11360
|
-
*/
|
|
11361
|
-
airSupply: number;
|
|
11362
10235
|
/**
|
|
11363
10236
|
* @remarks
|
|
11364
10237
|
* If true, this entity can breathe in air.
|
|
@@ -11387,14 +10260,6 @@ export class EntityBreathableComponent extends EntityComponent {
|
|
|
11387
10260
|
* @throws This property can throw when used.
|
|
11388
10261
|
*/
|
|
11389
10262
|
readonly breathesWater: boolean;
|
|
11390
|
-
/**
|
|
11391
|
-
* @beta
|
|
11392
|
-
* @remarks
|
|
11393
|
-
* If true, the entity is able to breathe.
|
|
11394
|
-
*
|
|
11395
|
-
* @throws This property can throw when used.
|
|
11396
|
-
*/
|
|
11397
|
-
readonly canBreathe: boolean;
|
|
11398
10263
|
/**
|
|
11399
10264
|
* @remarks
|
|
11400
10265
|
* If true, this entity will have visible bubbles while in
|
|
@@ -13367,42 +12232,6 @@ export class EntityNavigationWalkComponent extends EntityNavigationComponent {
|
|
|
13367
12232
|
static readonly componentId = 'minecraft:navigation.walk';
|
|
13368
12233
|
}
|
|
13369
12234
|
|
|
13370
|
-
/**
|
|
13371
|
-
* @beta
|
|
13372
|
-
* Adds NPC capabilities to an entity such as custom skin,
|
|
13373
|
-
* name, and dialogue interactions.
|
|
13374
|
-
*/
|
|
13375
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
13376
|
-
export class EntityNpcComponent extends EntityComponent {
|
|
13377
|
-
private constructor();
|
|
13378
|
-
/**
|
|
13379
|
-
* @remarks
|
|
13380
|
-
* The DialogueScene that is opened when players first interact
|
|
13381
|
-
* with the NPC.
|
|
13382
|
-
*
|
|
13383
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
13384
|
-
*
|
|
13385
|
-
*/
|
|
13386
|
-
defaultScene: string;
|
|
13387
|
-
/**
|
|
13388
|
-
* @remarks
|
|
13389
|
-
* The name of the NPC as it is displayed to players.
|
|
13390
|
-
*
|
|
13391
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
13392
|
-
*
|
|
13393
|
-
*/
|
|
13394
|
-
name: string;
|
|
13395
|
-
/**
|
|
13396
|
-
* @remarks
|
|
13397
|
-
* The index of the skin the NPC will use.
|
|
13398
|
-
*
|
|
13399
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
13400
|
-
*
|
|
13401
|
-
*/
|
|
13402
|
-
skinIndex: number;
|
|
13403
|
-
static readonly componentId = 'minecraft:npc';
|
|
13404
|
-
}
|
|
13405
|
-
|
|
13406
12235
|
/**
|
|
13407
12236
|
* When present on an entity, this entity is on fire.
|
|
13408
12237
|
* @example setOnFire.ts
|
|
@@ -14461,7 +13290,7 @@ export class EntityTypes {
|
|
|
14461
13290
|
* Retrieves an entity type using a string-based identifier.
|
|
14462
13291
|
*
|
|
14463
13292
|
*/
|
|
14464
|
-
static get
|
|
13293
|
+
static get(identifier: string): EntityType | undefined;
|
|
14465
13294
|
/**
|
|
14466
13295
|
* @remarks
|
|
14467
13296
|
* Retrieves a set of all entity types within this world.
|
|
@@ -15186,13 +14015,6 @@ export class GameRules {
|
|
|
15186
14015
|
*
|
|
15187
14016
|
*/
|
|
15188
14017
|
playersSleepingPercentage: number;
|
|
15189
|
-
/**
|
|
15190
|
-
* @beta
|
|
15191
|
-
* @remarks
|
|
15192
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
15193
|
-
*
|
|
15194
|
-
*/
|
|
15195
|
-
playerWaypoints: PlayerWaypointsMode;
|
|
15196
14018
|
/**
|
|
15197
14019
|
* @remarks
|
|
15198
14020
|
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
@@ -18110,33 +16932,6 @@ export class MatchToolCondition extends LootItemCondition {
|
|
|
18110
16932
|
readonly itemTagsNone: string[];
|
|
18111
16933
|
}
|
|
18112
16934
|
|
|
18113
|
-
/**
|
|
18114
|
-
* @beta
|
|
18115
|
-
* A specific currently-internal event used for passing
|
|
18116
|
-
* messages from client to server.
|
|
18117
|
-
*/
|
|
18118
|
-
export class MessageReceiveAfterEvent {
|
|
18119
|
-
private constructor();
|
|
18120
|
-
/**
|
|
18121
|
-
* @remarks
|
|
18122
|
-
* The message identifier.
|
|
18123
|
-
*
|
|
18124
|
-
*/
|
|
18125
|
-
readonly id: string;
|
|
18126
|
-
/**
|
|
18127
|
-
* @remarks
|
|
18128
|
-
* The message.
|
|
18129
|
-
*
|
|
18130
|
-
*/
|
|
18131
|
-
readonly message: string;
|
|
18132
|
-
/**
|
|
18133
|
-
* @remarks
|
|
18134
|
-
* The player who sent the message.
|
|
18135
|
-
*
|
|
18136
|
-
*/
|
|
18137
|
-
readonly player: Player;
|
|
18138
|
-
}
|
|
18139
|
-
|
|
18140
16935
|
/**
|
|
18141
16936
|
* Contains a set of additional variable values for further
|
|
18142
16937
|
* defining how rendering and animations function.
|
|
@@ -18205,49 +17000,6 @@ export class MolangVariableMap {
|
|
|
18205
17000
|
setVector3(variableName: string, vector: Vector3): void;
|
|
18206
17001
|
}
|
|
18207
17002
|
|
|
18208
|
-
/**
|
|
18209
|
-
* @beta
|
|
18210
|
-
* Pack setting name and value that changed.
|
|
18211
|
-
*/
|
|
18212
|
-
export class PackSettingChangeAfterEvent {
|
|
18213
|
-
private constructor();
|
|
18214
|
-
/**
|
|
18215
|
-
* @remarks
|
|
18216
|
-
* The name of the setting.
|
|
18217
|
-
*
|
|
18218
|
-
*/
|
|
18219
|
-
readonly settingName: string;
|
|
18220
|
-
/**
|
|
18221
|
-
* @remarks
|
|
18222
|
-
* The value of the setting.
|
|
18223
|
-
*
|
|
18224
|
-
*/
|
|
18225
|
-
readonly settingValue: string[] | boolean | number | string;
|
|
18226
|
-
}
|
|
18227
|
-
|
|
18228
|
-
/**
|
|
18229
|
-
* @beta
|
|
18230
|
-
*/
|
|
18231
|
-
export class PackSettingChangeAfterEventSignal {
|
|
18232
|
-
private constructor();
|
|
18233
|
-
/**
|
|
18234
|
-
* @remarks
|
|
18235
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
18236
|
-
*
|
|
18237
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
18238
|
-
*
|
|
18239
|
-
*/
|
|
18240
|
-
subscribe(callback: (arg0: PackSettingChangeAfterEvent) => void): (arg0: PackSettingChangeAfterEvent) => void;
|
|
18241
|
-
/**
|
|
18242
|
-
* @remarks
|
|
18243
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
18244
|
-
*
|
|
18245
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
18246
|
-
*
|
|
18247
|
-
*/
|
|
18248
|
-
unsubscribe(callback: (arg0: PackSettingChangeAfterEvent) => void): void;
|
|
18249
|
-
}
|
|
18250
|
-
|
|
18251
17003
|
/**
|
|
18252
17004
|
* Loot item condition that checks whether the looting entity
|
|
18253
17005
|
* is currently a passenger of a specific type of entity.
|
|
@@ -18416,82 +17168,25 @@ export class Player extends Entity {
|
|
|
18416
17168
|
*/
|
|
18417
17169
|
readonly camera: Camera;
|
|
18418
17170
|
/**
|
|
18419
|
-
* @beta
|
|
18420
17171
|
* @remarks
|
|
18421
|
-
*
|
|
18422
|
-
* {@link Player.chatNamePrefix} + {@link Player.name} +
|
|
18423
|
-
* {@link Player.chatNameSuffix}. This is the name shown as the
|
|
18424
|
-
* author of chat messages sent by this player. To change the
|
|
18425
|
-
* name shown above the player's head, use
|
|
18426
|
-
* {@link Entity.nameTag}.
|
|
17172
|
+
* Contains the player's device information.
|
|
18427
17173
|
*
|
|
18428
17174
|
* @throws This property can throw when used.
|
|
18429
|
-
*
|
|
18430
|
-
* {@link InvalidEntityError}
|
|
18431
17175
|
*/
|
|
18432
|
-
readonly
|
|
17176
|
+
readonly clientSystemInfo: ClientSystemInfo;
|
|
18433
17177
|
/**
|
|
18434
|
-
* @beta
|
|
18435
17178
|
* @remarks
|
|
18436
|
-
* An optional string that, when set, is prepended to the text
|
|
18437
|
-
* of chat messages sent by this player. Useful for applying
|
|
18438
|
-
* formatting or color codes to a player's messages (e.g., '§a'
|
|
18439
|
-
* to make their messages green). Does not affect the player's
|
|
18440
|
-
* name display - use {@link Player.chatNamePrefix} for the
|
|
18441
|
-
* name shown in chat, or {@link Entity.nameTag} for the name
|
|
18442
|
-
* above the player's head. Set to undefined to clear.
|
|
18443
|
-
*
|
|
18444
17179
|
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
18445
17180
|
*
|
|
18446
17181
|
*/
|
|
18447
|
-
|
|
17182
|
+
commandPermissionLevel: CommandPermissionLevel;
|
|
18448
17183
|
/**
|
|
18449
|
-
* @beta
|
|
18450
17184
|
* @remarks
|
|
18451
|
-
*
|
|
18452
|
-
*
|
|
18453
|
-
* above the player's head or the player list - use
|
|
18454
|
-
* {@link Entity.nameTag} for that. To prefix the message text
|
|
18455
|
-
* itself, use {@link Player.chatMessagePrefix}. Set to
|
|
18456
|
-
* undefined to clear.
|
|
18457
|
-
*
|
|
18458
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
17185
|
+
* Contains methods for manipulating the render distance fog
|
|
17186
|
+
* settings of a Player.
|
|
18459
17187
|
*
|
|
18460
17188
|
*/
|
|
18461
|
-
|
|
18462
|
-
/**
|
|
18463
|
-
* @beta
|
|
18464
|
-
* @remarks
|
|
18465
|
-
* An optional string that, when set, is appended to the
|
|
18466
|
-
* player's name in chat messages. Does not affect the name tag
|
|
18467
|
-
* above the player's head or the player list - use
|
|
18468
|
-
* {@link Entity.nameTag} for that. See also
|
|
18469
|
-
* {@link Player.chatNamePrefix}. Set to undefined to clear.
|
|
18470
|
-
*
|
|
18471
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
18472
|
-
*
|
|
18473
|
-
*/
|
|
18474
|
-
chatNameSuffix?: string;
|
|
18475
|
-
/**
|
|
18476
|
-
* @remarks
|
|
18477
|
-
* Contains the player's device information.
|
|
18478
|
-
*
|
|
18479
|
-
* @throws This property can throw when used.
|
|
18480
|
-
*/
|
|
18481
|
-
readonly clientSystemInfo: ClientSystemInfo;
|
|
18482
|
-
/**
|
|
18483
|
-
* @remarks
|
|
18484
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
18485
|
-
*
|
|
18486
|
-
*/
|
|
18487
|
-
commandPermissionLevel: CommandPermissionLevel;
|
|
18488
|
-
/**
|
|
18489
|
-
* @remarks
|
|
18490
|
-
* Contains methods for manipulating the render distance fog
|
|
18491
|
-
* settings of a Player.
|
|
18492
|
-
*
|
|
18493
|
-
*/
|
|
18494
|
-
readonly fogSettings: FogSettings;
|
|
17189
|
+
readonly fogSettings: FogSettings;
|
|
18495
17190
|
/**
|
|
18496
17191
|
* @remarks
|
|
18497
17192
|
* Gets the current graphics mode of the player's client. This
|
|
@@ -18575,19 +17270,6 @@ export class Player extends Entity {
|
|
|
18575
17270
|
* @throws This property can throw when used.
|
|
18576
17271
|
*/
|
|
18577
17272
|
readonly onScreenDisplay: ScreenDisplay;
|
|
18578
|
-
/**
|
|
18579
|
-
* @beta
|
|
18580
|
-
* @remarks
|
|
18581
|
-
* An identifier that can be used to identify a player across
|
|
18582
|
-
* sessions.
|
|
18583
|
-
*
|
|
18584
|
-
* @throws This property can throw when used.
|
|
18585
|
-
*
|
|
18586
|
-
* {@link minecraftcommon.EngineError}
|
|
18587
|
-
*
|
|
18588
|
-
* {@link InvalidEntityError}
|
|
18589
|
-
*/
|
|
18590
|
-
readonly persistentId: string;
|
|
18591
17273
|
/**
|
|
18592
17274
|
* @throws This property can throw when used.
|
|
18593
17275
|
*
|
|
@@ -18661,20 +17343,6 @@ export class Player extends Entity {
|
|
|
18661
17343
|
* Throws if the Entity or Entity ID is invalid.
|
|
18662
17344
|
*/
|
|
18663
17345
|
clearPropertyOverridesForEntity(targetEntity: Entity | string): void;
|
|
18664
|
-
/**
|
|
18665
|
-
* @beta
|
|
18666
|
-
* @remarks
|
|
18667
|
-
* Eats an item, providing the item's hunger and saturation
|
|
18668
|
-
* effects to the player. Can only be used on food items.
|
|
18669
|
-
*
|
|
18670
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
18671
|
-
*
|
|
18672
|
-
* @param itemStack
|
|
18673
|
-
* The item to eat.
|
|
18674
|
-
* @throws
|
|
18675
|
-
* Throws if the item is not a food item.
|
|
18676
|
-
*/
|
|
18677
|
-
eatItem(itemStack: ItemStack): void;
|
|
18678
17346
|
/**
|
|
18679
17347
|
* @remarks
|
|
18680
17348
|
* The player's aim-assist settings.
|
|
@@ -18708,20 +17376,6 @@ export class Player extends Entity {
|
|
|
18708
17376
|
* @throws This function can throw errors.
|
|
18709
17377
|
*/
|
|
18710
17378
|
getItemCooldown(cooldownCategory: string): number;
|
|
18711
|
-
/**
|
|
18712
|
-
* @beta
|
|
18713
|
-
* @remarks
|
|
18714
|
-
* Gets the player's ping in milliseconds.
|
|
18715
|
-
*
|
|
18716
|
-
* @returns
|
|
18717
|
-
* The player's ping in milliseconds.
|
|
18718
|
-
* @throws This function can throw errors.
|
|
18719
|
-
*
|
|
18720
|
-
* {@link minecraftcommon.EngineError}
|
|
18721
|
-
*
|
|
18722
|
-
* {@link InvalidEntityError}
|
|
18723
|
-
*/
|
|
18724
|
-
getPing(): number;
|
|
18725
17379
|
/**
|
|
18726
17380
|
* @remarks
|
|
18727
17381
|
* Gets the current spawn point of the player.
|
|
@@ -18729,21 +17383,6 @@ export class Player extends Entity {
|
|
|
18729
17383
|
* @throws This function can throw errors.
|
|
18730
17384
|
*/
|
|
18731
17385
|
getSpawnPoint(): DimensionLocation | undefined;
|
|
18732
|
-
/**
|
|
18733
|
-
* @beta
|
|
18734
|
-
* @remarks
|
|
18735
|
-
* Returns the split screen slot of the player.
|
|
18736
|
-
*
|
|
18737
|
-
* @returns
|
|
18738
|
-
* The split screen slot of the player or undefined if the
|
|
18739
|
-
* player is not in a split screen session.
|
|
18740
|
-
* @throws This function can throw errors.
|
|
18741
|
-
*
|
|
18742
|
-
* {@link minecraftcommon.EngineError}
|
|
18743
|
-
*
|
|
18744
|
-
* {@link InvalidEntityError}
|
|
18745
|
-
*/
|
|
18746
|
-
getSplitScreenSlot(): PlayerSplitScreenSlot | undefined;
|
|
18747
17386
|
/**
|
|
18748
17387
|
* @remarks
|
|
18749
17388
|
* Gets the total experience of the Player.
|
|
@@ -18808,17 +17447,6 @@ export class Player extends Entity {
|
|
|
18808
17447
|
* ```
|
|
18809
17448
|
*/
|
|
18810
17449
|
playSound(soundId: SoundDefinition | string, soundOptions?: PlayerSoundOptions): SoundInstance;
|
|
18811
|
-
/**
|
|
18812
|
-
* @beta
|
|
18813
|
-
* @remarks
|
|
18814
|
-
* This is an internal-facing method for posting a system
|
|
18815
|
-
* message to downstream clients.
|
|
18816
|
-
*
|
|
18817
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
18818
|
-
*
|
|
18819
|
-
* @throws This function can throw errors.
|
|
18820
|
-
*/
|
|
18821
|
-
postClientMessage(id: string, value: string): void;
|
|
18822
17450
|
/**
|
|
18823
17451
|
* @remarks
|
|
18824
17452
|
* Queues an additional music track that only this particular
|
|
@@ -19094,18 +17722,6 @@ export class Player extends Entity {
|
|
|
19094
17722
|
* @throws This function can throw errors.
|
|
19095
17723
|
*/
|
|
19096
17724
|
startItemCooldown(cooldownCategory: string, tickDuration: number): void;
|
|
19097
|
-
/**
|
|
19098
|
-
* @beta
|
|
19099
|
-
* @remarks
|
|
19100
|
-
* Stops all sounds from playing for this particular player.
|
|
19101
|
-
*
|
|
19102
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
19103
|
-
*
|
|
19104
|
-
* @throws This function can throw errors.
|
|
19105
|
-
*
|
|
19106
|
-
* {@link InvalidEntityError}
|
|
19107
|
-
*/
|
|
19108
|
-
stopAllSounds(): void;
|
|
19109
17725
|
/**
|
|
19110
17726
|
* @remarks
|
|
19111
17727
|
* Stops any music tracks from playing for this particular
|
|
@@ -19116,20 +17732,6 @@ export class Player extends Entity {
|
|
|
19116
17732
|
* @throws This function can throw errors.
|
|
19117
17733
|
*/
|
|
19118
17734
|
stopMusic(): void;
|
|
19119
|
-
/**
|
|
19120
|
-
* @beta
|
|
19121
|
-
* @remarks
|
|
19122
|
-
* Stops a sound from playing for this particular player.
|
|
19123
|
-
*
|
|
19124
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
19125
|
-
*
|
|
19126
|
-
* @param soundId
|
|
19127
|
-
* Identifier of the sound.
|
|
19128
|
-
* @throws This function can throw errors.
|
|
19129
|
-
*
|
|
19130
|
-
* {@link InvalidEntityError}
|
|
19131
|
-
*/
|
|
19132
|
-
stopSound(soundId: string): void;
|
|
19133
17735
|
}
|
|
19134
17736
|
|
|
19135
17737
|
/**
|
|
@@ -19438,72 +18040,6 @@ export class PlayerCancelBreakingBlockAfterEventSignal {
|
|
|
19438
18040
|
unsubscribe(callback: (arg0: PlayerCancelBreakingBlockAfterEvent) => void): void;
|
|
19439
18041
|
}
|
|
19440
18042
|
|
|
19441
|
-
/**
|
|
19442
|
-
* @beta
|
|
19443
|
-
* Contains information regarding a player crafting a recipe.
|
|
19444
|
-
*/
|
|
19445
|
-
export class PlayerCraftRecipeAfterEvent {
|
|
19446
|
-
private constructor();
|
|
19447
|
-
/**
|
|
19448
|
-
* @remarks
|
|
19449
|
-
* The block where the recipe was crafted, if applicable.
|
|
19450
|
-
*
|
|
19451
|
-
*/
|
|
19452
|
-
readonly block?: Block;
|
|
19453
|
-
/**
|
|
19454
|
-
* @remarks
|
|
19455
|
-
* The item stack crafted by the player.
|
|
19456
|
-
*
|
|
19457
|
-
*/
|
|
19458
|
-
readonly itemStack?: ItemStack;
|
|
19459
|
-
/**
|
|
19460
|
-
* @remarks
|
|
19461
|
-
* The player who crafted the recipe.
|
|
19462
|
-
*
|
|
19463
|
-
*/
|
|
19464
|
-
readonly player: Player;
|
|
19465
|
-
}
|
|
19466
|
-
|
|
19467
|
-
/**
|
|
19468
|
-
* @beta
|
|
19469
|
-
* Manages callbacks that are connected to when a player crafts
|
|
19470
|
-
* a recipe.
|
|
19471
|
-
*/
|
|
19472
|
-
export class PlayerCraftRecipeAfterEventSignal {
|
|
19473
|
-
private constructor();
|
|
19474
|
-
/**
|
|
19475
|
-
* @remarks
|
|
19476
|
-
* Adds a callback that will be called when a player crafts a
|
|
19477
|
-
* recipe.
|
|
19478
|
-
*
|
|
19479
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
19480
|
-
*
|
|
19481
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
19482
|
-
*
|
|
19483
|
-
* @param callback
|
|
19484
|
-
* Function callback that is called when this event fires.
|
|
19485
|
-
* @param options
|
|
19486
|
-
* Additional filtering options for the event subscription.
|
|
19487
|
-
*/
|
|
19488
|
-
subscribe(
|
|
19489
|
-
callback: (arg0: PlayerCraftRecipeAfterEvent) => void,
|
|
19490
|
-
options?: PlayerCraftRecipeEventOptions,
|
|
19491
|
-
): (arg0: PlayerCraftRecipeAfterEvent) => void;
|
|
19492
|
-
/**
|
|
19493
|
-
* @remarks
|
|
19494
|
-
* Removes a callback from being called when a player crafts a
|
|
19495
|
-
* recipe.
|
|
19496
|
-
*
|
|
19497
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
19498
|
-
*
|
|
19499
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
19500
|
-
*
|
|
19501
|
-
* @param callback
|
|
19502
|
-
* The callback to remove from the event subscription.
|
|
19503
|
-
*/
|
|
19504
|
-
unsubscribe(callback: (arg0: PlayerCraftRecipeAfterEvent) => void): void;
|
|
19505
|
-
}
|
|
19506
|
-
|
|
19507
18043
|
/**
|
|
19508
18044
|
* Represents the players cursor inventory. Used when moving
|
|
19509
18045
|
* items between between containers in the inventory UI. Not
|
|
@@ -19531,118 +18067,6 @@ export class PlayerCursorInventoryComponent extends EntityComponent {
|
|
|
19531
18067
|
clear(): void;
|
|
19532
18068
|
}
|
|
19533
18069
|
|
|
19534
|
-
/**
|
|
19535
|
-
* @beta
|
|
19536
|
-
* Contains information about an item moved from a container to
|
|
19537
|
-
* a player's cursor.
|
|
19538
|
-
*/
|
|
19539
|
-
export class PlayerCursorItemGrabAfterEvent {
|
|
19540
|
-
private constructor();
|
|
19541
|
-
/**
|
|
19542
|
-
* @remarks
|
|
19543
|
-
* The item stack moved to the player's cursor.
|
|
19544
|
-
*
|
|
19545
|
-
*/
|
|
19546
|
-
readonly item: ItemStack;
|
|
19547
|
-
/**
|
|
19548
|
-
* @remarks
|
|
19549
|
-
* The player whose cursor item changed.
|
|
19550
|
-
*
|
|
19551
|
-
*/
|
|
19552
|
-
readonly player: Player;
|
|
19553
|
-
}
|
|
19554
|
-
|
|
19555
|
-
/**
|
|
19556
|
-
* @beta
|
|
19557
|
-
* Manages callbacks for items grabbed from a container to a
|
|
19558
|
-
* player's cursor.
|
|
19559
|
-
*/
|
|
19560
|
-
export class PlayerCursorItemGrabAfterEventSignal {
|
|
19561
|
-
private constructor();
|
|
19562
|
-
/**
|
|
19563
|
-
* @remarks
|
|
19564
|
-
* Adds a callback that is called when a player grabs an item
|
|
19565
|
-
* from a container to their cursor.
|
|
19566
|
-
*
|
|
19567
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
19568
|
-
*
|
|
19569
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
19570
|
-
*
|
|
19571
|
-
* @param callback
|
|
19572
|
-
* The callback function invoked when the event fires.
|
|
19573
|
-
*/
|
|
19574
|
-
subscribe(callback: (arg0: PlayerCursorItemGrabAfterEvent) => void): (arg0: PlayerCursorItemGrabAfterEvent) => void;
|
|
19575
|
-
/**
|
|
19576
|
-
* @remarks
|
|
19577
|
-
* Removes a previously registered event callback.
|
|
19578
|
-
*
|
|
19579
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
19580
|
-
*
|
|
19581
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
19582
|
-
*
|
|
19583
|
-
* @param callback
|
|
19584
|
-
* The callback function to remove.
|
|
19585
|
-
*/
|
|
19586
|
-
unsubscribe(callback: (arg0: PlayerCursorItemGrabAfterEvent) => void): void;
|
|
19587
|
-
}
|
|
19588
|
-
|
|
19589
|
-
/**
|
|
19590
|
-
* @beta
|
|
19591
|
-
* Contains information about an item moved from a player's
|
|
19592
|
-
* cursor to a container.
|
|
19593
|
-
*/
|
|
19594
|
-
export class PlayerCursorItemReleaseAfterEvent {
|
|
19595
|
-
private constructor();
|
|
19596
|
-
/**
|
|
19597
|
-
* @remarks
|
|
19598
|
-
* The item stack from the player's cursor.
|
|
19599
|
-
*
|
|
19600
|
-
*/
|
|
19601
|
-
readonly item: ItemStack;
|
|
19602
|
-
/**
|
|
19603
|
-
* @remarks
|
|
19604
|
-
* The player whose cursor item changed.
|
|
19605
|
-
*
|
|
19606
|
-
*/
|
|
19607
|
-
readonly player: Player;
|
|
19608
|
-
}
|
|
19609
|
-
|
|
19610
|
-
/**
|
|
19611
|
-
* @beta
|
|
19612
|
-
* Manages callbacks for items released from a player's cursor
|
|
19613
|
-
* to a container.
|
|
19614
|
-
*/
|
|
19615
|
-
export class PlayerCursorItemReleaseAfterEventSignal {
|
|
19616
|
-
private constructor();
|
|
19617
|
-
/**
|
|
19618
|
-
* @remarks
|
|
19619
|
-
* Adds a callback that is called when a player releases an
|
|
19620
|
-
* item from their cursor to a container.
|
|
19621
|
-
*
|
|
19622
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
19623
|
-
*
|
|
19624
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
19625
|
-
*
|
|
19626
|
-
* @param callback
|
|
19627
|
-
* The callback function invoked when the event fires.
|
|
19628
|
-
*/
|
|
19629
|
-
subscribe(
|
|
19630
|
-
callback: (arg0: PlayerCursorItemReleaseAfterEvent) => void,
|
|
19631
|
-
): (arg0: PlayerCursorItemReleaseAfterEvent) => void;
|
|
19632
|
-
/**
|
|
19633
|
-
* @remarks
|
|
19634
|
-
* Removes a previously registered event callback.
|
|
19635
|
-
*
|
|
19636
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
19637
|
-
*
|
|
19638
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
19639
|
-
*
|
|
19640
|
-
* @param callback
|
|
19641
|
-
* The callback function to remove.
|
|
19642
|
-
*/
|
|
19643
|
-
unsubscribe(callback: (arg0: PlayerCursorItemReleaseAfterEvent) => void): void;
|
|
19644
|
-
}
|
|
19645
|
-
|
|
19646
18070
|
/**
|
|
19647
18071
|
* Contains information related to changes to a player's
|
|
19648
18072
|
* dimension having been changed.
|
|
@@ -20467,141 +18891,55 @@ export class PlayerInventoryItemChangeAfterEventSignal {
|
|
|
20467
18891
|
}
|
|
20468
18892
|
|
|
20469
18893
|
/**
|
|
20470
|
-
*
|
|
20471
|
-
*
|
|
20472
|
-
*
|
|
20473
|
-
*
|
|
18894
|
+
* Contains information regarding a player that has joined.
|
|
18895
|
+
* See the playerSpawn event for more detailed information that
|
|
18896
|
+
* could be returned after the first time a player has spawned
|
|
18897
|
+
* within the game.
|
|
20474
18898
|
*/
|
|
20475
|
-
export class
|
|
18899
|
+
export class PlayerJoinAfterEvent {
|
|
20476
18900
|
private constructor();
|
|
20477
18901
|
/**
|
|
20478
18902
|
* @remarks
|
|
20479
|
-
*
|
|
20480
|
-
* For standard client-initiated transaction attacks, this
|
|
20481
|
-
* direction is derived from the client-provided hit position
|
|
20482
|
-
* and the player's server-side eye position. Other attack
|
|
20483
|
-
* paths can provide a server-derived direction. This property
|
|
20484
|
-
* is undefined when the attack path does not provide an aim
|
|
20485
|
-
* direction.
|
|
20486
|
-
*
|
|
20487
|
-
*/
|
|
20488
|
-
readonly aimDirection?: Vector3;
|
|
20489
|
-
/**
|
|
20490
|
-
* @remarks
|
|
20491
|
-
* If set to true, the attack does not cause damage or other
|
|
20492
|
-
* authoritative attack effects.
|
|
20493
|
-
*
|
|
20494
|
-
*/
|
|
20495
|
-
cancel: boolean;
|
|
20496
|
-
/**
|
|
20497
|
-
* @remarks
|
|
20498
|
-
* A snapshot of the item held by the attacking player. This
|
|
20499
|
-
* property is undefined when the player holds no item.
|
|
20500
|
-
*
|
|
20501
|
-
*/
|
|
20502
|
-
readonly itemStack?: ItemStack;
|
|
20503
|
-
/**
|
|
20504
|
-
* @remarks
|
|
20505
|
-
* The player that initiated the attack.
|
|
18903
|
+
* Opaque string identifier of the player that joined the game.
|
|
20506
18904
|
*
|
|
20507
18905
|
*/
|
|
20508
|
-
readonly
|
|
18906
|
+
readonly playerId: string;
|
|
20509
18907
|
/**
|
|
20510
18908
|
* @remarks
|
|
20511
|
-
*
|
|
18909
|
+
* Name of the player that has joined.
|
|
20512
18910
|
*
|
|
20513
18911
|
*/
|
|
20514
|
-
readonly
|
|
18912
|
+
readonly playerName: string;
|
|
20515
18913
|
}
|
|
20516
18914
|
|
|
20517
18915
|
/**
|
|
20518
|
-
*
|
|
20519
|
-
*
|
|
20520
|
-
* through an item interaction.
|
|
18916
|
+
* Manages callbacks that are connected to a player joining the
|
|
18917
|
+
* world.
|
|
20521
18918
|
*/
|
|
20522
|
-
export class
|
|
18919
|
+
export class PlayerJoinAfterEventSignal {
|
|
20523
18920
|
private constructor();
|
|
20524
18921
|
/**
|
|
20525
18922
|
* @remarks
|
|
20526
|
-
* Adds a callback that
|
|
20527
|
-
*
|
|
18923
|
+
* Adds a callback that will be called when a player joins the
|
|
18924
|
+
* world.
|
|
20528
18925
|
*
|
|
20529
18926
|
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
20530
18927
|
*
|
|
20531
18928
|
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
20532
18929
|
*
|
|
20533
|
-
* @param callback
|
|
20534
|
-
* This closure is called with restricted-execution privilege.
|
|
20535
|
-
* @returns
|
|
20536
|
-
* Closure that is called with restricted-execution privilege.
|
|
20537
18930
|
*/
|
|
20538
|
-
subscribe(
|
|
20539
|
-
callback: (arg0: PlayerItemAttackEntityBeforeEvent) => void,
|
|
20540
|
-
): (arg0: PlayerItemAttackEntityBeforeEvent) => void;
|
|
18931
|
+
subscribe(callback: (arg0: PlayerJoinAfterEvent) => void): (arg0: PlayerJoinAfterEvent) => void;
|
|
20541
18932
|
/**
|
|
20542
18933
|
* @remarks
|
|
20543
|
-
* Removes a callback from
|
|
18934
|
+
* Removes a callback from being called when a player joins the
|
|
18935
|
+
* world.
|
|
20544
18936
|
*
|
|
20545
18937
|
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
20546
18938
|
*
|
|
20547
18939
|
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
20548
18940
|
*
|
|
20549
|
-
* @param callback
|
|
20550
|
-
* This closure is called with restricted-execution privilege.
|
|
20551
18941
|
*/
|
|
20552
|
-
unsubscribe(callback: (arg0:
|
|
20553
|
-
}
|
|
20554
|
-
|
|
20555
|
-
/**
|
|
20556
|
-
* Contains information regarding a player that has joined.
|
|
20557
|
-
* See the playerSpawn event for more detailed information that
|
|
20558
|
-
* could be returned after the first time a player has spawned
|
|
20559
|
-
* within the game.
|
|
20560
|
-
*/
|
|
20561
|
-
export class PlayerJoinAfterEvent {
|
|
20562
|
-
private constructor();
|
|
20563
|
-
/**
|
|
20564
|
-
* @remarks
|
|
20565
|
-
* Opaque string identifier of the player that joined the game.
|
|
20566
|
-
*
|
|
20567
|
-
*/
|
|
20568
|
-
readonly playerId: string;
|
|
20569
|
-
/**
|
|
20570
|
-
* @remarks
|
|
20571
|
-
* Name of the player that has joined.
|
|
20572
|
-
*
|
|
20573
|
-
*/
|
|
20574
|
-
readonly playerName: string;
|
|
20575
|
-
}
|
|
20576
|
-
|
|
20577
|
-
/**
|
|
20578
|
-
* Manages callbacks that are connected to a player joining the
|
|
20579
|
-
* world.
|
|
20580
|
-
*/
|
|
20581
|
-
export class PlayerJoinAfterEventSignal {
|
|
20582
|
-
private constructor();
|
|
20583
|
-
/**
|
|
20584
|
-
* @remarks
|
|
20585
|
-
* Adds a callback that will be called when a player joins the
|
|
20586
|
-
* world.
|
|
20587
|
-
*
|
|
20588
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
20589
|
-
*
|
|
20590
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
20591
|
-
*
|
|
20592
|
-
*/
|
|
20593
|
-
subscribe(callback: (arg0: PlayerJoinAfterEvent) => void): (arg0: PlayerJoinAfterEvent) => void;
|
|
20594
|
-
/**
|
|
20595
|
-
* @remarks
|
|
20596
|
-
* Removes a callback from being called when a player joins the
|
|
20597
|
-
* world.
|
|
20598
|
-
*
|
|
20599
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
20600
|
-
*
|
|
20601
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
20602
|
-
*
|
|
20603
|
-
*/
|
|
20604
|
-
unsubscribe(callback: (arg0: PlayerJoinAfterEvent) => void): void;
|
|
18942
|
+
unsubscribe(callback: (arg0: PlayerJoinAfterEvent) => void): void;
|
|
20605
18943
|
}
|
|
20606
18944
|
|
|
20607
18945
|
/**
|
|
@@ -20753,88 +19091,6 @@ export class PlayerPlaceBlockAfterEventSignal {
|
|
|
20753
19091
|
unsubscribe(callback: (arg0: PlayerPlaceBlockAfterEvent) => void): void;
|
|
20754
19092
|
}
|
|
20755
19093
|
|
|
20756
|
-
/**
|
|
20757
|
-
* @beta
|
|
20758
|
-
* Contains information regarding an event before a player
|
|
20759
|
-
* places a block.
|
|
20760
|
-
*/
|
|
20761
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
20762
|
-
export class PlayerPlaceBlockBeforeEvent extends BlockEvent {
|
|
20763
|
-
private constructor();
|
|
20764
|
-
/**
|
|
20765
|
-
* @remarks
|
|
20766
|
-
* If set to true, cancels the block place event.
|
|
20767
|
-
*
|
|
20768
|
-
*/
|
|
20769
|
-
cancel: boolean;
|
|
20770
|
-
/**
|
|
20771
|
-
* @remarks
|
|
20772
|
-
* The face of the block that the new block is being placed on.
|
|
20773
|
-
*
|
|
20774
|
-
*/
|
|
20775
|
-
readonly face: Direction;
|
|
20776
|
-
/**
|
|
20777
|
-
* @remarks
|
|
20778
|
-
* Location relative to the bottom north-west corner of the
|
|
20779
|
-
* block where the new block is being placed onto.
|
|
20780
|
-
*
|
|
20781
|
-
*/
|
|
20782
|
-
readonly faceLocation: Vector3;
|
|
20783
|
-
/**
|
|
20784
|
-
* @remarks
|
|
20785
|
-
* The block permutation that will be placed if the event is
|
|
20786
|
-
* not cancelled.
|
|
20787
|
-
*
|
|
20788
|
-
*/
|
|
20789
|
-
readonly permutationToPlace: BlockPermutation;
|
|
20790
|
-
/**
|
|
20791
|
-
* @remarks
|
|
20792
|
-
* Player that is placing the block for this event.
|
|
20793
|
-
*
|
|
20794
|
-
*/
|
|
20795
|
-
readonly player: Player;
|
|
20796
|
-
}
|
|
20797
|
-
|
|
20798
|
-
/**
|
|
20799
|
-
* @beta
|
|
20800
|
-
* Manages callbacks that are connected to before a block is
|
|
20801
|
-
* placed by a player.
|
|
20802
|
-
*/
|
|
20803
|
-
export class PlayerPlaceBlockBeforeEventSignal {
|
|
20804
|
-
private constructor();
|
|
20805
|
-
/**
|
|
20806
|
-
* @remarks
|
|
20807
|
-
* Adds a callback that will be called before a block is placed
|
|
20808
|
-
* by a player.
|
|
20809
|
-
*
|
|
20810
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
20811
|
-
*
|
|
20812
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
20813
|
-
*
|
|
20814
|
-
* @param callback
|
|
20815
|
-
* This closure is called with restricted-execution privilege.
|
|
20816
|
-
* @returns
|
|
20817
|
-
* Closure that is called with restricted-execution privilege.
|
|
20818
|
-
*/
|
|
20819
|
-
subscribe(
|
|
20820
|
-
callback: (arg0: PlayerPlaceBlockBeforeEvent) => void,
|
|
20821
|
-
options?: BlockEventOptions,
|
|
20822
|
-
): (arg0: PlayerPlaceBlockBeforeEvent) => void;
|
|
20823
|
-
/**
|
|
20824
|
-
* @remarks
|
|
20825
|
-
* Removes a callback from being called before an block is
|
|
20826
|
-
* placed by a player.
|
|
20827
|
-
*
|
|
20828
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
20829
|
-
*
|
|
20830
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
20831
|
-
*
|
|
20832
|
-
* @param callback
|
|
20833
|
-
* This closure is called with restricted-execution privilege.
|
|
20834
|
-
*/
|
|
20835
|
-
unsubscribe(callback: (arg0: PlayerPlaceBlockBeforeEvent) => void): void;
|
|
20836
|
-
}
|
|
20837
|
-
|
|
20838
19094
|
/**
|
|
20839
19095
|
* An event that contains more information about a player
|
|
20840
19096
|
* spawning.
|
|
@@ -21021,80 +19277,6 @@ export class PlayerSwingStartAfterEventSignal {
|
|
|
21021
19277
|
unsubscribe(callback: (arg0: PlayerSwingStartAfterEvent) => void): void;
|
|
21022
19278
|
}
|
|
21023
19279
|
|
|
21024
|
-
/**
|
|
21025
|
-
* @beta
|
|
21026
|
-
* Contains information related to when a player successfully
|
|
21027
|
-
* names an Entity with a named Name Tag item.
|
|
21028
|
-
*/
|
|
21029
|
-
export class PlayerUseNameTagAfterEvent {
|
|
21030
|
-
private constructor();
|
|
21031
|
-
/**
|
|
21032
|
-
* @remarks
|
|
21033
|
-
* The entity that was named by the player.
|
|
21034
|
-
*
|
|
21035
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
21036
|
-
*
|
|
21037
|
-
*/
|
|
21038
|
-
entityNamed: Entity;
|
|
21039
|
-
/**
|
|
21040
|
-
* @remarks
|
|
21041
|
-
* The new name that the player has given to the entity.
|
|
21042
|
-
*
|
|
21043
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
21044
|
-
*
|
|
21045
|
-
*/
|
|
21046
|
-
newName: string;
|
|
21047
|
-
/**
|
|
21048
|
-
* @remarks
|
|
21049
|
-
* Handle to the player that used the name tag.
|
|
21050
|
-
*
|
|
21051
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
21052
|
-
*
|
|
21053
|
-
*/
|
|
21054
|
-
player: Player;
|
|
21055
|
-
/**
|
|
21056
|
-
* @remarks
|
|
21057
|
-
* The previous name of the entity before the player used the
|
|
21058
|
-
* name tag. This will be undefined if the entity was not
|
|
21059
|
-
* previously named.
|
|
21060
|
-
*
|
|
21061
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
21062
|
-
*
|
|
21063
|
-
*/
|
|
21064
|
-
previousName?: string;
|
|
21065
|
-
}
|
|
21066
|
-
|
|
21067
|
-
/**
|
|
21068
|
-
* @beta
|
|
21069
|
-
* Manages callbacks that are connected to when a player
|
|
21070
|
-
* successfully names an Entity with a named Name Tag item.
|
|
21071
|
-
*/
|
|
21072
|
-
export class PlayerUseNameTagAfterEventSignal {
|
|
21073
|
-
private constructor();
|
|
21074
|
-
/**
|
|
21075
|
-
* @remarks
|
|
21076
|
-
* Subscribes the specified callback to a player use name tag
|
|
21077
|
-
* after event.
|
|
21078
|
-
*
|
|
21079
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21080
|
-
*
|
|
21081
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
21082
|
-
*
|
|
21083
|
-
*/
|
|
21084
|
-
subscribe(callback: (arg0: PlayerUseNameTagAfterEvent) => void): (arg0: PlayerUseNameTagAfterEvent) => void;
|
|
21085
|
-
/**
|
|
21086
|
-
* @remarks
|
|
21087
|
-
* Removes the specified callback from a player use name tag
|
|
21088
|
-
* after event.
|
|
21089
|
-
*
|
|
21090
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21091
|
-
*
|
|
21092
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
21093
|
-
*
|
|
21094
|
-
*/
|
|
21095
|
-
unsubscribe(callback: (arg0: PlayerUseNameTagAfterEvent) => void): void;
|
|
21096
|
-
}
|
|
21097
|
-
|
|
21098
19280
|
/**
|
|
21099
19281
|
* Waypoint that tracks a player's position. Extends
|
|
21100
19282
|
* {@link EntityWaypoint} with additional player-specific
|
|
@@ -21128,315 +19310,6 @@ export class PlayerWaypoint extends EntityWaypoint {
|
|
|
21128
19310
|
);
|
|
21129
19311
|
}
|
|
21130
19312
|
|
|
21131
|
-
/**
|
|
21132
|
-
* @beta
|
|
21133
|
-
* Describes a block point-of-interest instance returned by a
|
|
21134
|
-
* query.
|
|
21135
|
-
*
|
|
21136
|
-
* Required Experiments:
|
|
21137
|
-
* - Poi
|
|
21138
|
-
*
|
|
21139
|
-
*/
|
|
21140
|
-
export class PoiBlockInstance {
|
|
21141
|
-
private constructor();
|
|
21142
|
-
/**
|
|
21143
|
-
* @remarks
|
|
21144
|
-
* Block position of this POI instance.
|
|
21145
|
-
*
|
|
21146
|
-
*/
|
|
21147
|
-
readonly position: Vector3;
|
|
21148
|
-
/**
|
|
21149
|
-
* @remarks
|
|
21150
|
-
* Number of tickets currently available to be claimed from
|
|
21151
|
-
* this POI instance.
|
|
21152
|
-
*
|
|
21153
|
-
*/
|
|
21154
|
-
readonly tickets: number;
|
|
21155
|
-
/**
|
|
21156
|
-
* @remarks
|
|
21157
|
-
* Type of this POI instance.
|
|
21158
|
-
*
|
|
21159
|
-
*/
|
|
21160
|
-
readonly 'type': PoiBlockType;
|
|
21161
|
-
}
|
|
21162
|
-
|
|
21163
|
-
/**
|
|
21164
|
-
* @beta
|
|
21165
|
-
* Provides methods for querying and managing block-based
|
|
21166
|
-
* points of interest in a dimension.
|
|
21167
|
-
*
|
|
21168
|
-
* Required Experiments:
|
|
21169
|
-
* - Poi
|
|
21170
|
-
*
|
|
21171
|
-
*/
|
|
21172
|
-
export class PoiBlockManager {
|
|
21173
|
-
private constructor();
|
|
21174
|
-
/**
|
|
21175
|
-
* @remarks
|
|
21176
|
-
* Adds a block point of interest at a position. This method is
|
|
21177
|
-
* intended for temporary usage. Will be replaced when chunk is
|
|
21178
|
-
* reloaded
|
|
21179
|
-
*
|
|
21180
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21181
|
-
*
|
|
21182
|
-
* @param position
|
|
21183
|
-
* Block position at which to add the POI.
|
|
21184
|
-
* @param poi
|
|
21185
|
-
* POI type to add, specified by numeric type Id, type name, or
|
|
21186
|
-
* POI type object.
|
|
21187
|
-
*/
|
|
21188
|
-
addTemporary(position: Vector3, poi: PoiBlockType | string | number): void;
|
|
21189
|
-
/**
|
|
21190
|
-
* @remarks
|
|
21191
|
-
* Gets the type of the block point of interest at a position.
|
|
21192
|
-
*
|
|
21193
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21194
|
-
*
|
|
21195
|
-
* @param position
|
|
21196
|
-
* Block position to inspect.
|
|
21197
|
-
* @returns
|
|
21198
|
-
* The POI type at the position, or undefined if no POI exists
|
|
21199
|
-
* there.
|
|
21200
|
-
*/
|
|
21201
|
-
at(position: Vector3): PoiBlockType | undefined;
|
|
21202
|
-
/**
|
|
21203
|
-
* @remarks
|
|
21204
|
-
* Tests whether a block point of interest at a position
|
|
21205
|
-
* matches a type filter.
|
|
21206
|
-
*
|
|
21207
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21208
|
-
*
|
|
21209
|
-
* @param position
|
|
21210
|
-
* Block position to inspect.
|
|
21211
|
-
* @param filter
|
|
21212
|
-
* Filter used to select the POI type. A callback receives the
|
|
21213
|
-
* POI type and returns whether it matches; a name filter
|
|
21214
|
-
* matches a type name; and a tag filter requires all specified
|
|
21215
|
-
* tags.
|
|
21216
|
-
* @returns
|
|
21217
|
-
* True if a POI exists at the position and its type matches
|
|
21218
|
-
* the filter; otherwise false.
|
|
21219
|
-
*/
|
|
21220
|
-
exists(position: Vector3, filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter): boolean;
|
|
21221
|
-
/**
|
|
21222
|
-
* @remarks
|
|
21223
|
-
* Returns block points of interest that match the supplied
|
|
21224
|
-
* type and occupancy filters within the specified distance of
|
|
21225
|
-
* a location.
|
|
21226
|
-
*
|
|
21227
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21228
|
-
*
|
|
21229
|
-
* @param filter
|
|
21230
|
-
* Filter used to select POI types. A callback receives each
|
|
21231
|
-
* POI type and returns whether it should be included; a name
|
|
21232
|
-
* filter matches a type name; and a tag filter requires all
|
|
21233
|
-
* specified tags.
|
|
21234
|
-
* @param center
|
|
21235
|
-
* Center of the search.
|
|
21236
|
-
* @param blockRadius
|
|
21237
|
-
* Maximum three-dimensional distance from the center, in
|
|
21238
|
-
* blocks.
|
|
21239
|
-
* @param occupancyFilter
|
|
21240
|
-
* Optional filter applied to the occupancy state of matching
|
|
21241
|
-
* POIs. If omitted, POIs in any occupancy state are returned.
|
|
21242
|
-
* @returns
|
|
21243
|
-
* The matching POI instances within range. The result order is
|
|
21244
|
-
* not guaranteed.
|
|
21245
|
-
*/
|
|
21246
|
-
getInRange(
|
|
21247
|
-
filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
|
|
21248
|
-
center: Vector3,
|
|
21249
|
-
blockRadius: number,
|
|
21250
|
-
occupancyFilter?: PoiBlockOccupancyFilter,
|
|
21251
|
-
): PoiBlockInstance[];
|
|
21252
|
-
/**
|
|
21253
|
-
* @remarks
|
|
21254
|
-
* Returns block points of interest that match the supplied
|
|
21255
|
-
* type and occupancy filters within an axis-aligned square
|
|
21256
|
-
* centered on the specified location, sorted from nearest to
|
|
21257
|
-
* farthest.
|
|
21258
|
-
*
|
|
21259
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21260
|
-
*
|
|
21261
|
-
* @param filter
|
|
21262
|
-
* Filter used to select POI types. A callback receives each
|
|
21263
|
-
* POI type and returns whether it should be included; a name
|
|
21264
|
-
* filter matches a type name; and a tag filter requires all
|
|
21265
|
-
* specified tags.
|
|
21266
|
-
* @param center
|
|
21267
|
-
* Center of the search and the location from which distances
|
|
21268
|
-
* are calculated.
|
|
21269
|
-
* @param blockRadius
|
|
21270
|
-
* Maximum three-dimensional distance from the center, in
|
|
21271
|
-
* blocks.
|
|
21272
|
-
* @param occupancyFilter
|
|
21273
|
-
* Optional filter applied to the occupancy state of matching
|
|
21274
|
-
* POIs. If omitted, POIs in any occupancy state are returned.
|
|
21275
|
-
* @returns
|
|
21276
|
-
* The matching POI instances and their squared distances from
|
|
21277
|
-
* the center, sorted in ascending distance order.
|
|
21278
|
-
*/
|
|
21279
|
-
getInRangeSorted(
|
|
21280
|
-
filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
|
|
21281
|
-
center: Vector3,
|
|
21282
|
-
blockRadius: number,
|
|
21283
|
-
occupancyFilter?: PoiBlockOccupancyFilter,
|
|
21284
|
-
): PoiDistancePair[];
|
|
21285
|
-
/**
|
|
21286
|
-
* @remarks
|
|
21287
|
-
* Returns block points of interest that match the supplied
|
|
21288
|
-
* type and occupancy filters within an axis-aligned square
|
|
21289
|
-
* centered on the specified location.
|
|
21290
|
-
*
|
|
21291
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21292
|
-
*
|
|
21293
|
-
* @param filter
|
|
21294
|
-
* Filter used to select POI types. A callback receives each
|
|
21295
|
-
* POI type and returns whether it should be included; a name
|
|
21296
|
-
* filter matches a type name; and a tag filter requires all
|
|
21297
|
-
* specified tags.
|
|
21298
|
-
* @param center
|
|
21299
|
-
* Center of the search volume.
|
|
21300
|
-
* @param blockRadius
|
|
21301
|
-
* Half-size of the search volume, in blocks, along each axis.
|
|
21302
|
-
* @param occupancyFilter
|
|
21303
|
-
* Optional filter applied to the occupancy state of matching
|
|
21304
|
-
* POIs. If omitted, POIs in any occupancy state are returned.
|
|
21305
|
-
* @returns
|
|
21306
|
-
* The matching POI instances in the search volume.
|
|
21307
|
-
*/
|
|
21308
|
-
getInSquare(
|
|
21309
|
-
filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
|
|
21310
|
-
center: Vector3,
|
|
21311
|
-
blockRadius: number,
|
|
21312
|
-
occupancyFilter?: PoiBlockOccupancyFilter,
|
|
21313
|
-
): PoiBlockInstance[];
|
|
21314
|
-
/**
|
|
21315
|
-
* @remarks
|
|
21316
|
-
* Releases one previously claimed ticket at a block point of
|
|
21317
|
-
* interest.
|
|
21318
|
-
*
|
|
21319
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21320
|
-
*
|
|
21321
|
-
* @param center
|
|
21322
|
-
* Block position of the POI whose ticket should be released.
|
|
21323
|
-
* @returns
|
|
21324
|
-
* True if a ticket was released; false if no POI exists at the
|
|
21325
|
-
* position or the POI has no claimed tickets.
|
|
21326
|
-
*/
|
|
21327
|
-
release(center: Vector3): boolean;
|
|
21328
|
-
/**
|
|
21329
|
-
* @remarks
|
|
21330
|
-
* Claims one available ticket from a matching block point of
|
|
21331
|
-
* interest within range.
|
|
21332
|
-
*
|
|
21333
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21334
|
-
*
|
|
21335
|
-
* @param filter
|
|
21336
|
-
* Filter used to select the POI type to claim. A callback
|
|
21337
|
-
* receives each POI type and returns whether it should be
|
|
21338
|
-
* included; a name filter matches a type name; and a tag
|
|
21339
|
-
* filter requires all specified tags.
|
|
21340
|
-
* @param center
|
|
21341
|
-
* Center of the search.
|
|
21342
|
-
* @param blockRadius
|
|
21343
|
-
* Maximum three-dimensional distance from the center, in
|
|
21344
|
-
* blocks.
|
|
21345
|
-
* @returns
|
|
21346
|
-
* The block position of the claimed POI, or undefined if no
|
|
21347
|
-
* matching POI has an available ticket.
|
|
21348
|
-
*/
|
|
21349
|
-
take(
|
|
21350
|
-
filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
|
|
21351
|
-
center: Vector3,
|
|
21352
|
-
blockRadius: number,
|
|
21353
|
-
): Vector3 | undefined;
|
|
21354
|
-
}
|
|
21355
|
-
|
|
21356
|
-
/**
|
|
21357
|
-
* @beta
|
|
21358
|
-
* Describes a block point-of-interest type.
|
|
21359
|
-
*
|
|
21360
|
-
* Required Experiments:
|
|
21361
|
-
* - Poi
|
|
21362
|
-
*
|
|
21363
|
-
*/
|
|
21364
|
-
export class PoiBlockType {
|
|
21365
|
-
private constructor();
|
|
21366
|
-
/**
|
|
21367
|
-
* @remarks
|
|
21368
|
-
* Numeric identifier of this POI type.
|
|
21369
|
-
*
|
|
21370
|
-
*/
|
|
21371
|
-
readonly id: number;
|
|
21372
|
-
/**
|
|
21373
|
-
* @remarks
|
|
21374
|
-
* Namespaced identifier of this POI type.
|
|
21375
|
-
*
|
|
21376
|
-
*/
|
|
21377
|
-
readonly name: string;
|
|
21378
|
-
/**
|
|
21379
|
-
* @remarks
|
|
21380
|
-
* Maximum number of tickets that can be claimed from each POI
|
|
21381
|
-
* instance of this type.
|
|
21382
|
-
*
|
|
21383
|
-
*/
|
|
21384
|
-
readonly tickets: number;
|
|
21385
|
-
/**
|
|
21386
|
-
* @remarks
|
|
21387
|
-
* Maximum range, in blocks, at which this POI type is
|
|
21388
|
-
* considered usable.
|
|
21389
|
-
*
|
|
21390
|
-
*/
|
|
21391
|
-
readonly usableRange: number;
|
|
21392
|
-
/**
|
|
21393
|
-
* @remarks
|
|
21394
|
-
* Tests whether this object and another object describe the
|
|
21395
|
-
* same POI type.
|
|
21396
|
-
*
|
|
21397
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21398
|
-
*
|
|
21399
|
-
* @param other
|
|
21400
|
-
* POI type to compare with this type.
|
|
21401
|
-
* @returns
|
|
21402
|
-
* True if both objects describe the same POI type; otherwise
|
|
21403
|
-
* false.
|
|
21404
|
-
*/
|
|
21405
|
-
equals(other: PoiBlockType): boolean;
|
|
21406
|
-
/**
|
|
21407
|
-
* @remarks
|
|
21408
|
-
* Tests whether the type has the provided tag attribute
|
|
21409
|
-
*
|
|
21410
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
21411
|
-
*
|
|
21412
|
-
* @param tag
|
|
21413
|
-
* POI tag to check.
|
|
21414
|
-
* @returns
|
|
21415
|
-
* True if the POI conatains the tag; otherwise false.
|
|
21416
|
-
*/
|
|
21417
|
-
hasTag(tag: string): boolean;
|
|
21418
|
-
}
|
|
21419
|
-
|
|
21420
|
-
/**
|
|
21421
|
-
* @beta
|
|
21422
|
-
* Provides access to point-of-interest (POI) data in a
|
|
21423
|
-
* dimension.
|
|
21424
|
-
*
|
|
21425
|
-
* Required Experiments:
|
|
21426
|
-
* - Poi
|
|
21427
|
-
*
|
|
21428
|
-
*/
|
|
21429
|
-
export class PoiManager {
|
|
21430
|
-
private constructor();
|
|
21431
|
-
/**
|
|
21432
|
-
* @remarks
|
|
21433
|
-
* Provides access to block-based points of interest in the
|
|
21434
|
-
* dimension.
|
|
21435
|
-
*
|
|
21436
|
-
*/
|
|
21437
|
-
readonly blocks: PoiBlockManager;
|
|
21438
|
-
}
|
|
21439
|
-
|
|
21440
19313
|
/**
|
|
21441
19314
|
* Represents how the potion effect is delivered.
|
|
21442
19315
|
*/
|
|
@@ -21519,10 +19392,10 @@ export class Potions {
|
|
|
21519
19392
|
*
|
|
21520
19393
|
* {@link InvalidPotionEffectTypeError}
|
|
21521
19394
|
*/
|
|
21522
|
-
static resolve
|
|
21523
|
-
|
|
21524
|
-
|
|
21525
|
-
|
|
19395
|
+
static resolve(
|
|
19396
|
+
potionEffectType: PotionEffectType | string,
|
|
19397
|
+
potionDeliveryType: PotionDeliveryType | string,
|
|
19398
|
+
): ItemStack;
|
|
21526
19399
|
}
|
|
21527
19400
|
|
|
21528
19401
|
/**
|
|
@@ -21657,10 +19530,6 @@ export class PrimitiveShape {
|
|
|
21657
19530
|
*
|
|
21658
19531
|
*/
|
|
21659
19532
|
color: RGBA;
|
|
21660
|
-
/**
|
|
21661
|
-
* @beta
|
|
21662
|
-
*/
|
|
21663
|
-
defaultVisibleToAll: boolean;
|
|
21664
19533
|
/**
|
|
21665
19534
|
* @remarks
|
|
21666
19535
|
* The dimension the shape is visible within. If the dimension
|
|
@@ -21675,10 +19544,6 @@ export class PrimitiveShape {
|
|
|
21675
19544
|
*
|
|
21676
19545
|
*/
|
|
21677
19546
|
readonly hasDuration: boolean;
|
|
21678
|
-
/**
|
|
21679
|
-
* @beta
|
|
21680
|
-
*/
|
|
21681
|
-
hiddenFrom: Player[];
|
|
21682
19547
|
/**
|
|
21683
19548
|
* @remarks
|
|
21684
19549
|
* The location of the shape.
|
|
@@ -22068,104 +19933,6 @@ export class RandomRegionalDifficultyChanceCondition extends LootItemCondition {
|
|
|
22068
19933
|
readonly maxChance: number;
|
|
22069
19934
|
}
|
|
22070
19935
|
|
|
22071
|
-
/**
|
|
22072
|
-
* @beta
|
|
22073
|
-
* Provides access to the slots and recipe of a players active
|
|
22074
|
-
* crafting UI ie. stonecutter.
|
|
22075
|
-
*/
|
|
22076
|
-
export class RecipeCraftingContext {
|
|
22077
|
-
private constructor();
|
|
22078
|
-
/**
|
|
22079
|
-
* @remarks
|
|
22080
|
-
* The amount of addressable input slots for getInputItem and
|
|
22081
|
-
* setInputItem.
|
|
22082
|
-
*
|
|
22083
|
-
* @throws This property can throw when used.
|
|
22084
|
-
*
|
|
22085
|
-
* {@link minecraftcommon.EngineError}
|
|
22086
|
-
*/
|
|
22087
|
-
readonly inputSlotCount: number;
|
|
22088
|
-
/**
|
|
22089
|
-
* @remarks
|
|
22090
|
-
* Whether this recipe crafting context is valid. Invalidates
|
|
22091
|
-
* when the player closes the crafting UI or leaves.
|
|
22092
|
-
*
|
|
22093
|
-
*/
|
|
22094
|
-
readonly isValid: boolean;
|
|
22095
|
-
/**
|
|
22096
|
-
* @remarks
|
|
22097
|
-
* The identifiers of the recipes that are valid for the
|
|
22098
|
-
* current input items.
|
|
22099
|
-
*
|
|
22100
|
-
* @throws This property can throw when used.
|
|
22101
|
-
*
|
|
22102
|
-
* {@link minecraftcommon.EngineError}
|
|
22103
|
-
*/
|
|
22104
|
-
readonly validRecipes: string[];
|
|
22105
|
-
/**
|
|
22106
|
-
* @remarks
|
|
22107
|
-
* Gets the item in the provided input slot.
|
|
22108
|
-
*
|
|
22109
|
-
* @param slot
|
|
22110
|
-
* The zero-based input slot index.
|
|
22111
|
-
* @returns
|
|
22112
|
-
* The item stack in the input slot, or undefined if the slot
|
|
22113
|
-
* is empty.
|
|
22114
|
-
* @throws This function can throw errors.
|
|
22115
|
-
*
|
|
22116
|
-
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
22117
|
-
*
|
|
22118
|
-
* {@link minecraftcommon.EngineError}
|
|
22119
|
-
*/
|
|
22120
|
-
getInputItem(slot: number): ItemStack | undefined;
|
|
22121
|
-
/**
|
|
22122
|
-
* @remarks
|
|
22123
|
-
* Gets the item produced by the currently selected recipe.
|
|
22124
|
-
*
|
|
22125
|
-
* @returns
|
|
22126
|
-
* The output item stack, or undefined if there is no output.
|
|
22127
|
-
* @throws This function can throw errors.
|
|
22128
|
-
*
|
|
22129
|
-
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
22130
|
-
*
|
|
22131
|
-
* {@link minecraftcommon.EngineError}
|
|
22132
|
-
*/
|
|
22133
|
-
getOutputItem(): ItemStack | undefined;
|
|
22134
|
-
/**
|
|
22135
|
-
* @remarks
|
|
22136
|
-
* Sets or clears an item in an input slot.
|
|
22137
|
-
*
|
|
22138
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
22139
|
-
*
|
|
22140
|
-
* @param slot
|
|
22141
|
-
* The zero-based input slot index.
|
|
22142
|
-
* @param item
|
|
22143
|
-
* The item stack to place in the slot, or undefined to clear
|
|
22144
|
-
* the slot.
|
|
22145
|
-
* @throws This function can throw errors.
|
|
22146
|
-
*
|
|
22147
|
-
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
22148
|
-
*
|
|
22149
|
-
* {@link minecraftcommon.EngineError}
|
|
22150
|
-
*/
|
|
22151
|
-
setInputItem(slot: number, item?: ItemStack): void;
|
|
22152
|
-
/**
|
|
22153
|
-
* @remarks
|
|
22154
|
-
* Selects a recipe for the current crafting operation.
|
|
22155
|
-
*
|
|
22156
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
22157
|
-
*
|
|
22158
|
-
* @param recipeId
|
|
22159
|
-
* The identifier of a valid recipe to select.
|
|
22160
|
-
* @throws This function can throw errors.
|
|
22161
|
-
*
|
|
22162
|
-
* {@link minecraftcommon.EngineError}
|
|
22163
|
-
*
|
|
22164
|
-
* {@link InvalidRecipeError}
|
|
22165
|
-
*/
|
|
22166
|
-
setSelectedRecipe(recipeId: string): void;
|
|
22167
|
-
}
|
|
22168
|
-
|
|
22169
19936
|
/**
|
|
22170
19937
|
* Contains objectives and participants for the scoreboard.
|
|
22171
19938
|
* @example updateScoreboard.ts
|
|
@@ -22832,50 +20599,18 @@ export class Seat {
|
|
|
22832
20599
|
*/
|
|
22833
20600
|
readonly minRiderCount: number;
|
|
22834
20601
|
/**
|
|
22835
|
-
* @remarks
|
|
22836
|
-
* Physical location of this seat, relative to the entity's
|
|
22837
|
-
* location.
|
|
22838
|
-
*
|
|
22839
|
-
*/
|
|
22840
|
-
readonly position: Vector3;
|
|
22841
|
-
/**
|
|
22842
|
-
* @remarks
|
|
22843
|
-
* Angle in degrees to rotate riders by.
|
|
22844
|
-
*
|
|
22845
|
-
*/
|
|
22846
|
-
readonly seatRotation: number;
|
|
22847
|
-
}
|
|
22848
|
-
|
|
22849
|
-
/**
|
|
22850
|
-
* @beta
|
|
22851
|
-
* Manages callbacks that are message passing to a server. This
|
|
22852
|
-
* event is not currently fully implemented, and should not be
|
|
22853
|
-
* used.
|
|
22854
|
-
*/
|
|
22855
|
-
export class ServerMessageAfterEventSignal {
|
|
22856
|
-
private constructor();
|
|
22857
|
-
/**
|
|
22858
|
-
* @remarks
|
|
22859
|
-
* Adds a callback that will be called when an internal message
|
|
22860
|
-
* is passed.
|
|
22861
|
-
*
|
|
22862
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
22863
|
-
*
|
|
22864
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
20602
|
+
* @remarks
|
|
20603
|
+
* Physical location of this seat, relative to the entity's
|
|
20604
|
+
* location.
|
|
22865
20605
|
*
|
|
22866
20606
|
*/
|
|
22867
|
-
|
|
20607
|
+
readonly position: Vector3;
|
|
22868
20608
|
/**
|
|
22869
20609
|
* @remarks
|
|
22870
|
-
*
|
|
22871
|
-
* message is passed.
|
|
22872
|
-
*
|
|
22873
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
22874
|
-
*
|
|
22875
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
20610
|
+
* Angle in degrees to rotate riders by.
|
|
22876
20611
|
*
|
|
22877
20612
|
*/
|
|
22878
|
-
|
|
20613
|
+
readonly seatRotation: number;
|
|
22879
20614
|
}
|
|
22880
20615
|
|
|
22881
20616
|
/**
|
|
@@ -22906,21 +20641,6 @@ export class SetArmorTrimFunction extends LootItemFunction {
|
|
|
22906
20641
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
22907
20642
|
export class SetBannerDetailsFunction extends LootItemFunction {
|
|
22908
20643
|
private constructor();
|
|
22909
|
-
/**
|
|
22910
|
-
* @beta
|
|
22911
|
-
* @remarks
|
|
22912
|
-
* The base color for the dropped banner.
|
|
22913
|
-
*
|
|
22914
|
-
*/
|
|
22915
|
-
readonly baseColor: string;
|
|
22916
|
-
/**
|
|
22917
|
-
* @beta
|
|
22918
|
-
* @remarks
|
|
22919
|
-
* An array of {@link BannerPattern} objects used to decorate
|
|
22920
|
-
* the banner, including color and pattern type.
|
|
22921
|
-
*
|
|
22922
|
-
*/
|
|
22923
|
-
readonly patterns: BannerPattern[];
|
|
22924
20644
|
/**
|
|
22925
20645
|
* @remarks
|
|
22926
20646
|
* The type of banner to drop.
|
|
@@ -24157,19 +21877,6 @@ export class SystemBeforeEvents {
|
|
|
24157
21877
|
*
|
|
24158
21878
|
*/
|
|
24159
21879
|
readonly startup: StartupBeforeEventSignal;
|
|
24160
|
-
/**
|
|
24161
|
-
* @beta
|
|
24162
|
-
* @remarks
|
|
24163
|
-
* Fires when the scripting watchdog shuts down the server. The
|
|
24164
|
-
* can be due to using too much memory, or by causing
|
|
24165
|
-
* significant slowdown or hang.
|
|
24166
|
-
* To prevent shutdown, set the event's cancel property to
|
|
24167
|
-
* true.
|
|
24168
|
-
*
|
|
24169
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
24170
|
-
*
|
|
24171
|
-
*/
|
|
24172
|
-
readonly watchdogTerminate: WatchdogTerminateBeforeEventSignal;
|
|
24173
21880
|
}
|
|
24174
21881
|
|
|
24175
21882
|
/**
|
|
@@ -24602,71 +22309,6 @@ export class TripWireTripAfterEventSignal {
|
|
|
24602
22309
|
unsubscribe(callback: (arg0: TripWireTripAfterEvent) => void): void;
|
|
24603
22310
|
}
|
|
24604
22311
|
|
|
24605
|
-
/**
|
|
24606
|
-
* @beta
|
|
24607
|
-
* Contains information related to a script watchdog
|
|
24608
|
-
* termination.
|
|
24609
|
-
*/
|
|
24610
|
-
export class WatchdogTerminateBeforeEvent {
|
|
24611
|
-
private constructor();
|
|
24612
|
-
/**
|
|
24613
|
-
* @remarks
|
|
24614
|
-
* If set to true, cancels the termination of the script
|
|
24615
|
-
* runtime. Note that depending on server configuration
|
|
24616
|
-
* settings, cancellation of the termination may not be
|
|
24617
|
-
* allowed.
|
|
24618
|
-
*
|
|
24619
|
-
*/
|
|
24620
|
-
cancel: boolean;
|
|
24621
|
-
/**
|
|
24622
|
-
* @remarks
|
|
24623
|
-
* Contains the reason why a script runtime is to be
|
|
24624
|
-
* terminated.
|
|
24625
|
-
*
|
|
24626
|
-
*/
|
|
24627
|
-
readonly terminateReason: WatchdogTerminateReason;
|
|
24628
|
-
}
|
|
24629
|
-
|
|
24630
|
-
/**
|
|
24631
|
-
* @beta
|
|
24632
|
-
* Manages callbacks that are connected to a callback that will
|
|
24633
|
-
* be called when a script runtime is being terminated due to a
|
|
24634
|
-
* violation of the performance watchdog system.
|
|
24635
|
-
*/
|
|
24636
|
-
export class WatchdogTerminateBeforeEventSignal {
|
|
24637
|
-
private constructor();
|
|
24638
|
-
/**
|
|
24639
|
-
* @remarks
|
|
24640
|
-
* Adds a callback that will be called when a script runtime is
|
|
24641
|
-
* being terminated due to a violation of the performance
|
|
24642
|
-
* watchdog system.
|
|
24643
|
-
*
|
|
24644
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
24645
|
-
*
|
|
24646
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
24647
|
-
*
|
|
24648
|
-
* @param callback
|
|
24649
|
-
* This closure is called with restricted-execution privilege.
|
|
24650
|
-
* @returns
|
|
24651
|
-
* Closure that is called with restricted-execution privilege.
|
|
24652
|
-
*/
|
|
24653
|
-
subscribe(callback: (arg0: WatchdogTerminateBeforeEvent) => void): (arg0: WatchdogTerminateBeforeEvent) => void;
|
|
24654
|
-
/**
|
|
24655
|
-
* @remarks
|
|
24656
|
-
* Removes a callback from being called when a script runtime
|
|
24657
|
-
* is being terminated due to a violation of the performance
|
|
24658
|
-
* watchdog system.
|
|
24659
|
-
*
|
|
24660
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
24661
|
-
*
|
|
24662
|
-
* @privilege early-execution-allowed - This function can be called in early-execution mode.
|
|
24663
|
-
*
|
|
24664
|
-
* @param callback
|
|
24665
|
-
* This closure is called with restricted-execution privilege.
|
|
24666
|
-
*/
|
|
24667
|
-
unsubscribe(callback: (arg0: WatchdogTerminateBeforeEvent) => void): void;
|
|
24668
|
-
}
|
|
24669
|
-
|
|
24670
22312
|
/**
|
|
24671
22313
|
* Base class for waypoints displayed on the player's locator
|
|
24672
22314
|
* bar. Waypoints can track locations or entities and are
|
|
@@ -24882,15 +22524,6 @@ export class World {
|
|
|
24882
22524
|
*
|
|
24883
22525
|
*/
|
|
24884
22526
|
readonly afterEvents: WorldAfterEvents;
|
|
24885
|
-
/**
|
|
24886
|
-
* @beta
|
|
24887
|
-
* @remarks
|
|
24888
|
-
* Enables or disables cheats.
|
|
24889
|
-
*
|
|
24890
|
-
* @privilege restricted-execution-read-only - This property can't be edited in restricted-execution mode.
|
|
24891
|
-
*
|
|
24892
|
-
*/
|
|
24893
|
-
allowCheats: boolean;
|
|
24894
22527
|
/**
|
|
24895
22528
|
* @remarks
|
|
24896
22529
|
* Contains a set of events that are applicable to the entirety
|
|
@@ -24975,20 +22608,6 @@ export class World {
|
|
|
24975
22608
|
*
|
|
24976
22609
|
*/
|
|
24977
22610
|
readonly tickingAreaManager: TickingAreaManager;
|
|
24978
|
-
/**
|
|
24979
|
-
* @beta
|
|
24980
|
-
* @remarks
|
|
24981
|
-
* A method that is internal-only, used for broadcasting
|
|
24982
|
-
* specific messages between client and server.
|
|
24983
|
-
*
|
|
24984
|
-
* @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
|
|
24985
|
-
*
|
|
24986
|
-
* @param id
|
|
24987
|
-
* The message identifier.
|
|
24988
|
-
* @param value
|
|
24989
|
-
* The message.
|
|
24990
|
-
*/
|
|
24991
|
-
broadcastClientMessage(id: string, value: string): void;
|
|
24992
22611
|
/**
|
|
24993
22612
|
* @remarks
|
|
24994
22613
|
* Clears the set of dynamic properties declared for this
|
|
@@ -25494,16 +23113,6 @@ export class WorldAfterEvents {
|
|
|
25494
23113
|
*
|
|
25495
23114
|
*/
|
|
25496
23115
|
readonly buttonPush: ButtonPushAfterEventSignal;
|
|
25497
|
-
/**
|
|
25498
|
-
* @beta
|
|
25499
|
-
* @remarks
|
|
25500
|
-
* This event is triggered after a chat message has been
|
|
25501
|
-
* broadcast or sent to players.
|
|
25502
|
-
*
|
|
25503
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
25504
|
-
*
|
|
25505
|
-
*/
|
|
25506
|
-
readonly chatSend: ChatSendAfterEventSignal;
|
|
25507
23116
|
/**
|
|
25508
23117
|
* @remarks
|
|
25509
23118
|
* This event is fired when an entity event has been triggered
|
|
@@ -25747,25 +23356,6 @@ export class WorldAfterEvents {
|
|
|
25747
23356
|
*
|
|
25748
23357
|
*/
|
|
25749
23358
|
readonly leverAction: LeverActionAfterEventSignal;
|
|
25750
|
-
/**
|
|
25751
|
-
* @beta
|
|
25752
|
-
* @remarks
|
|
25753
|
-
* This event is an internal implementation detail, and is
|
|
25754
|
-
* otherwise not currently functional.
|
|
25755
|
-
*
|
|
25756
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
25757
|
-
*
|
|
25758
|
-
*/
|
|
25759
|
-
readonly messageReceive: ServerMessageAfterEventSignal;
|
|
25760
|
-
/**
|
|
25761
|
-
* @beta
|
|
25762
|
-
* @remarks
|
|
25763
|
-
* This event is triggered when a pack setting is changed.
|
|
25764
|
-
*
|
|
25765
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
25766
|
-
*
|
|
25767
|
-
*/
|
|
25768
|
-
readonly packSettingChange: PackSettingChangeAfterEventSignal;
|
|
25769
23359
|
/**
|
|
25770
23360
|
* @remarks
|
|
25771
23361
|
* This event fires when a piston expands or retracts.
|
|
@@ -25799,35 +23389,6 @@ export class WorldAfterEvents {
|
|
|
25799
23389
|
*
|
|
25800
23390
|
*/
|
|
25801
23391
|
readonly playerCancelBreakingBlock: PlayerCancelBreakingBlockAfterEventSignal;
|
|
25802
|
-
/**
|
|
25803
|
-
* @beta
|
|
25804
|
-
* @remarks
|
|
25805
|
-
* This event fires when a player crafts a recipe.
|
|
25806
|
-
*
|
|
25807
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
25808
|
-
*
|
|
25809
|
-
*/
|
|
25810
|
-
readonly playerCraftRecipe: PlayerCraftRecipeAfterEventSignal;
|
|
25811
|
-
/**
|
|
25812
|
-
* @beta
|
|
25813
|
-
* @remarks
|
|
25814
|
-
* Event signal that fires when a player grabs an item from a
|
|
25815
|
-
* container to their cursor.
|
|
25816
|
-
*
|
|
25817
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
25818
|
-
*
|
|
25819
|
-
*/
|
|
25820
|
-
readonly playerCursorItemGrab: PlayerCursorItemGrabAfterEventSignal;
|
|
25821
|
-
/**
|
|
25822
|
-
* @beta
|
|
25823
|
-
* @remarks
|
|
25824
|
-
* Event signal that fires when a player releases an item from
|
|
25825
|
-
* their cursor into a container.
|
|
25826
|
-
*
|
|
25827
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
25828
|
-
*
|
|
25829
|
-
*/
|
|
25830
|
-
readonly playerCursorItemRelease: PlayerCursorItemReleaseAfterEventSignal;
|
|
25831
23392
|
/**
|
|
25832
23393
|
* @remarks
|
|
25833
23394
|
* Fires when a player moved to a different dimension.
|
|
@@ -25947,16 +23508,6 @@ export class WorldAfterEvents {
|
|
|
25947
23508
|
*
|
|
25948
23509
|
*/
|
|
25949
23510
|
readonly playerSwingStart: PlayerSwingStartAfterEventSignal;
|
|
25950
|
-
/**
|
|
25951
|
-
* @beta
|
|
25952
|
-
* @remarks
|
|
25953
|
-
* An event for when a player uses a named name tag on an
|
|
25954
|
-
* entity.
|
|
25955
|
-
*
|
|
25956
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
25957
|
-
*
|
|
25958
|
-
*/
|
|
25959
|
-
readonly playerUseNameTag: PlayerUseNameTagAfterEventSignal;
|
|
25960
23511
|
/**
|
|
25961
23512
|
* @remarks
|
|
25962
23513
|
* A pressure plate has popped back up (i.e., there are no
|
|
@@ -26082,43 +23633,6 @@ export class WorldAfterEvents {
|
|
|
26082
23633
|
*/
|
|
26083
23634
|
export class WorldBeforeEvents {
|
|
26084
23635
|
private constructor();
|
|
26085
|
-
/**
|
|
26086
|
-
* @beta
|
|
26087
|
-
* @remarks
|
|
26088
|
-
* This event is triggered after a chat message has been
|
|
26089
|
-
* broadcast or sent to players.
|
|
26090
|
-
*
|
|
26091
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
26092
|
-
*
|
|
26093
|
-
* @example customCommand.ts
|
|
26094
|
-
* ```typescript
|
|
26095
|
-
* import { world, DimensionLocation } from '@minecraft/server';
|
|
26096
|
-
*
|
|
26097
|
-
* function customCommand(targetLocation: DimensionLocation) {
|
|
26098
|
-
* const chatCallback = world.beforeEvents.chatSend.subscribe(eventData => {
|
|
26099
|
-
* if (eventData.message.includes('cancel')) {
|
|
26100
|
-
* // Cancel event if the message contains "cancel"
|
|
26101
|
-
* eventData.cancel = true;
|
|
26102
|
-
* } else {
|
|
26103
|
-
* const args = eventData.message.split(' ');
|
|
26104
|
-
*
|
|
26105
|
-
* if (args.length > 0) {
|
|
26106
|
-
* switch (args[0].toLowerCase()) {
|
|
26107
|
-
* case 'echo':
|
|
26108
|
-
* // Send a modified version of chat message
|
|
26109
|
-
* world.sendMessage(`Echo '${eventData.message.substring(4).trim()}'`);
|
|
26110
|
-
* break;
|
|
26111
|
-
* case 'help':
|
|
26112
|
-
* world.sendMessage(`Available commands: echo <message>`);
|
|
26113
|
-
* break;
|
|
26114
|
-
* }
|
|
26115
|
-
* }
|
|
26116
|
-
* }
|
|
26117
|
-
* });
|
|
26118
|
-
* }
|
|
26119
|
-
* ```
|
|
26120
|
-
*/
|
|
26121
|
-
readonly chatSend: ChatSendBeforeEventSignal;
|
|
26122
23636
|
/**
|
|
26123
23637
|
* @remarks
|
|
26124
23638
|
* This event is triggered after an event has been added to an
|
|
@@ -26212,13 +23726,6 @@ export class WorldBeforeEvents {
|
|
|
26212
23726
|
*
|
|
26213
23727
|
*/
|
|
26214
23728
|
readonly playerInteractWithEntity: PlayerInteractWithEntityBeforeEventSignal;
|
|
26215
|
-
/**
|
|
26216
|
-
* @beta
|
|
26217
|
-
* @remarks
|
|
26218
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
26219
|
-
*
|
|
26220
|
-
*/
|
|
26221
|
-
readonly playerItemAttackEntity: PlayerItemAttackEntityBeforeEventSignal;
|
|
26222
23729
|
/**
|
|
26223
23730
|
* @remarks
|
|
26224
23731
|
* Fires when a player leaves the game.
|
|
@@ -26227,15 +23734,6 @@ export class WorldBeforeEvents {
|
|
|
26227
23734
|
*
|
|
26228
23735
|
*/
|
|
26229
23736
|
readonly playerLeave: PlayerLeaveBeforeEventSignal;
|
|
26230
|
-
/**
|
|
26231
|
-
* @beta
|
|
26232
|
-
* @remarks
|
|
26233
|
-
* This event fires before a block is placed by a player.
|
|
26234
|
-
*
|
|
26235
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
26236
|
-
*
|
|
26237
|
-
*/
|
|
26238
|
-
readonly playerPlaceBlock: PlayerPlaceBlockBeforeEventSignal;
|
|
26239
23737
|
/**
|
|
26240
23738
|
* @remarks
|
|
26241
23739
|
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
@@ -26775,9 +24273,7 @@ export interface BiomeSearchOptions {
|
|
|
26775
24273
|
* A BlockBoundingBox is an interface to an object which
|
|
26776
24274
|
* represents an AABB aligned rectangle.
|
|
26777
24275
|
* The BlockBoundingBox assumes that it was created in a valid
|
|
26778
|
-
* state (min <= max) but cannot guarantee it
|
|
26779
|
-
* created using the associated {@link BlockBoundingBoxUtils}
|
|
26780
|
-
* utility functions.
|
|
24276
|
+
* state (min <= max) but cannot guarantee it.
|
|
26781
24277
|
* The min/max coordinates represent the diametrically opposite
|
|
26782
24278
|
* corners of the rectangle.
|
|
26783
24279
|
* The BlockBoundingBox is not a representation of blocks - it
|
|
@@ -26864,14 +24360,6 @@ export interface BlockCustomComponent {
|
|
|
26864
24360
|
*
|
|
26865
24361
|
*/
|
|
26866
24362
|
onEntityFallOn?: (arg0: BlockComponentEntityFallOnEvent, arg1: CustomComponentParameters) => void;
|
|
26867
|
-
/**
|
|
26868
|
-
* @beta
|
|
26869
|
-
*/
|
|
26870
|
-
onNamedTick?: (arg0: BlockComponentNamedTickEvent, arg1: CustomComponentParameters) => void;
|
|
26871
|
-
/**
|
|
26872
|
-
* @beta
|
|
26873
|
-
*/
|
|
26874
|
-
onNeighborChanged?: (arg0: BlockComponentNeighborChangedAfterEvent, arg1: CustomComponentParameters) => void;
|
|
26875
24363
|
/**
|
|
26876
24364
|
* @remarks
|
|
26877
24365
|
* This function will be called when the block that this custom
|
|
@@ -27411,15 +24899,6 @@ export interface CustomCommand {
|
|
|
27411
24899
|
* command.
|
|
27412
24900
|
*/
|
|
27413
24901
|
export interface CustomCommandParameter {
|
|
27414
|
-
/**
|
|
27415
|
-
* @beta
|
|
27416
|
-
* @remarks
|
|
27417
|
-
* Can be used to reference the enum name when
|
|
27418
|
-
* {@link CustomCommandParamType} is 'Enum'. Allows the
|
|
27419
|
-
* parameter name to be different from the enum name.
|
|
27420
|
-
*
|
|
27421
|
-
*/
|
|
27422
|
-
enumName?: string;
|
|
27423
24902
|
/**
|
|
27424
24903
|
* @remarks
|
|
27425
24904
|
* The name of parameter as it appears on the command line.
|
|
@@ -27498,14 +24977,6 @@ export interface DefinitionModifier {
|
|
|
27498
24977
|
*
|
|
27499
24978
|
*/
|
|
27500
24979
|
removedComponentGroups: string[];
|
|
27501
|
-
/**
|
|
27502
|
-
* @beta
|
|
27503
|
-
* @remarks
|
|
27504
|
-
* The list of entity definition events that will be fired via
|
|
27505
|
-
* this update.
|
|
27506
|
-
*
|
|
27507
|
-
*/
|
|
27508
|
-
triggers: Trigger[];
|
|
27509
24980
|
}
|
|
27510
24981
|
|
|
27511
24982
|
/**
|
|
@@ -28749,35 +26220,6 @@ export interface MusicOptions {
|
|
|
28749
26220
|
volume?: number;
|
|
28750
26221
|
}
|
|
28751
26222
|
|
|
28752
|
-
/**
|
|
28753
|
-
* @beta
|
|
28754
|
-
* Contains information regarding a block change in one
|
|
28755
|
-
* neighboring direction.
|
|
28756
|
-
*/
|
|
28757
|
-
export interface NeighborChange {
|
|
28758
|
-
/**
|
|
28759
|
-
* @remarks
|
|
28760
|
-
* The permutation of the neighboring block after its last
|
|
28761
|
-
* change during the tick.
|
|
28762
|
-
*
|
|
28763
|
-
*/
|
|
28764
|
-
blockPermutation: BlockPermutation;
|
|
28765
|
-
/**
|
|
28766
|
-
* @remarks
|
|
28767
|
-
* Direction from the block receiving the event to the
|
|
28768
|
-
* neighboring block that changed.
|
|
28769
|
-
*
|
|
28770
|
-
*/
|
|
28771
|
-
direction: Direction;
|
|
28772
|
-
/**
|
|
28773
|
-
* @remarks
|
|
28774
|
-
* The permutation of the neighboring block before its first
|
|
28775
|
-
* change during the tick.
|
|
28776
|
-
*
|
|
28777
|
-
*/
|
|
28778
|
-
previousPermutation: BlockPermutation;
|
|
28779
|
-
}
|
|
28780
|
-
|
|
28781
26223
|
/**
|
|
28782
26224
|
* Not equal to operator.
|
|
28783
26225
|
*/
|
|
@@ -28886,31 +26328,6 @@ export interface PlayerBreakingBlockEventOptions {
|
|
|
28886
26328
|
playerFilter?: EntityFilter;
|
|
28887
26329
|
}
|
|
28888
26330
|
|
|
28889
|
-
/**
|
|
28890
|
-
* @beta
|
|
28891
|
-
* Contains options for filtering player craft recipe events.
|
|
28892
|
-
*/
|
|
28893
|
-
export interface PlayerCraftRecipeEventOptions {
|
|
28894
|
-
/**
|
|
28895
|
-
* @remarks
|
|
28896
|
-
* Filter for the block where the recipe is crafted.
|
|
28897
|
-
*
|
|
28898
|
-
*/
|
|
28899
|
-
blockFilter?: BlockFilter;
|
|
28900
|
-
/**
|
|
28901
|
-
* @remarks
|
|
28902
|
-
* Filter for the item crafted by the player.
|
|
28903
|
-
*
|
|
28904
|
-
*/
|
|
28905
|
-
itemFilter?: ItemFilter;
|
|
28906
|
-
/**
|
|
28907
|
-
* @remarks
|
|
28908
|
-
* Filter for the player crafting the recipe.
|
|
28909
|
-
*
|
|
28910
|
-
*/
|
|
28911
|
-
playerFilter?: EntityFilter;
|
|
28912
|
-
}
|
|
28913
|
-
|
|
28914
26331
|
/**
|
|
28915
26332
|
* Additional options for how a sound plays for a player.
|
|
28916
26333
|
*/
|
|
@@ -29006,56 +26423,6 @@ export interface PlayerVisibilityRules extends EntityVisibilityRules {
|
|
|
29006
26423
|
showSpectatorToSpectator?: boolean;
|
|
29007
26424
|
}
|
|
29008
26425
|
|
|
29009
|
-
/**
|
|
29010
|
-
* @beta
|
|
29011
|
-
* Associates a block point-of-interest instance with its
|
|
29012
|
-
* squared distance from a query center.
|
|
29013
|
-
*/
|
|
29014
|
-
export interface PoiDistancePair {
|
|
29015
|
-
/**
|
|
29016
|
-
* @remarks
|
|
29017
|
-
* Squared three-dimensional distance, in blocks squared, from
|
|
29018
|
-
* the query center to the POI position.
|
|
29019
|
-
*
|
|
29020
|
-
*/
|
|
29021
|
-
distance: number;
|
|
29022
|
-
/**
|
|
29023
|
-
* @remarks
|
|
29024
|
-
* POI instance at this distance.
|
|
29025
|
-
*
|
|
29026
|
-
*/
|
|
29027
|
-
poi: PoiBlockInstance;
|
|
29028
|
-
}
|
|
29029
|
-
|
|
29030
|
-
/**
|
|
29031
|
-
* @beta
|
|
29032
|
-
* Selects block point-of-interest types by their exact
|
|
29033
|
-
* namespaced identifier.
|
|
29034
|
-
*/
|
|
29035
|
-
export interface PoiNameFilter {
|
|
29036
|
-
/**
|
|
29037
|
-
* @remarks
|
|
29038
|
-
* Exact namespaced POI type identifier to match.
|
|
29039
|
-
*
|
|
29040
|
-
*/
|
|
29041
|
-
name: string;
|
|
29042
|
-
}
|
|
29043
|
-
|
|
29044
|
-
/**
|
|
29045
|
-
* @beta
|
|
29046
|
-
* Selects block point-of-interest types that have all
|
|
29047
|
-
* specified tags.
|
|
29048
|
-
*/
|
|
29049
|
-
export interface PoiTagFilter {
|
|
29050
|
-
/**
|
|
29051
|
-
* @remarks
|
|
29052
|
-
* Namespaced POI tags that a matching type must contain. All
|
|
29053
|
-
* tags in the array are required.
|
|
29054
|
-
*
|
|
29055
|
-
*/
|
|
29056
|
-
tags: string[];
|
|
29057
|
-
}
|
|
29058
|
-
|
|
29059
26426
|
/**
|
|
29060
26427
|
* Contains optional filters that control which primitive
|
|
29061
26428
|
* shapes are returned from a primitive shapes query.
|
|
@@ -30361,23 +27728,6 @@ export class InvalidPotionEffectTypeError extends Error {
|
|
|
30361
27728
|
private constructor();
|
|
30362
27729
|
}
|
|
30363
27730
|
|
|
30364
|
-
/**
|
|
30365
|
-
* @beta
|
|
30366
|
-
* Thrown when an invalid recipe identifier is used.
|
|
30367
|
-
*/
|
|
30368
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
30369
|
-
export class InvalidRecipeError extends Error {
|
|
30370
|
-
private constructor();
|
|
30371
|
-
/**
|
|
30372
|
-
* @remarks
|
|
30373
|
-
* The identifier of the invalid recipe.
|
|
30374
|
-
*
|
|
30375
|
-
* @privilege early-execution-readable - This property can be read in early-execution mode.
|
|
30376
|
-
*
|
|
30377
|
-
*/
|
|
30378
|
-
readonly recipeId: string;
|
|
30379
|
-
}
|
|
30380
|
-
|
|
30381
27731
|
/**
|
|
30382
27732
|
* Thrown when a Structure is invalid. A structure becomes
|
|
30383
27733
|
* invalid when it is deleted.
|