@minecraft/server 1.12.0-rc.1.21.30-preview.21 → 1.12.0

package/README.md

@@ -2,8 +2,6 @@
 
 Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.
 
-## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
-
 See full documentation for this module here:
 
 https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/minecraft-server

package/index.d.ts

@@ -7,7 +7,6 @@
    Copyright (c) Microsoft Corporation.
    ***************************************************************************** */
 /**
- * @preview
  * @packageDocumentation
  * Contains many types related to manipulating a Minecraft
  * world, including entities, blocks, dimensions, and more.
@@ -79,9 +78,6 @@ export enum BlockPistonState {
     Retracting = 'Retracting',
 }
 
-/**
- * @rc
- */
 export enum CustomComponentNameErrorReason {
     NoNamespace = 1,
     DisallowedNamespace = 2,
@@ -325,7 +321,6 @@ export enum EntityComponentTypes {
      */
     AddRider = 'minecraft:addrider',
     /**
-     * @rc
      * @remarks
      * Adds a timer for the entity to grow up. It can be
      * accelerated by giving the entity the items it likes as
@@ -530,7 +525,6 @@ export enum EntityComponentTypes {
      */
     Item = 'minecraft:item',
     /**
-     * @rc
      * @remarks
      * Defines the base movement speed in lava of this entity.
      *
@@ -545,7 +539,6 @@ export enum EntityComponentTypes {
      */
     MarkVariant = 'minecraft:mark_variant',
     /**
-     * @rc
      * @remarks
      * Defines the general movement speed of this entity.
      *
@@ -578,7 +571,6 @@ export enum EntityComponentTypes {
      */
     MovementGeneric = 'minecraft:movement.generic',
     /**
-     * @rc
      * @remarks
      * When added, this movement control allows the mob to glide.
      *
@@ -605,7 +597,6 @@ export enum EntityComponentTypes {
      */
     MovementSkip = 'minecraft:movement.skip',
     /**
-     * @rc
      * @remarks
      * When added, this move control causes the mob to sway side to
      * side giving the impression it is swimming.
@@ -705,7 +696,6 @@ export enum EntityComponentTypes {
      */
     SkinId = 'minecraft:skin_id',
     /**
-     * @rc
      * @remarks
      * Defines the rules for an entity to be tamed by the player.
      *
@@ -725,7 +715,6 @@ export enum EntityComponentTypes {
      */
     TypeFamily = 'minecraft:type_family',
     /**
-     * @rc
      * @remarks
      * Defines the general movement speed underwater of this
      * entity.
@@ -1358,7 +1347,6 @@ export enum GameRule {
      */
     ShowCoordinates = 'showCoordinates',
     /**
-     * @rc
      * @remarks
      * Controls whether the days a player has played is displayed.
      *
@@ -1446,7 +1434,6 @@ export enum HudVisibility {
 }
 
 /**
- * @rc
  * Input permission categories. Used by
  * @minecraft/server.PlayerInputPermissionCategoryChangeAfterEvent
  * to specify which category was changed.
@@ -2350,7 +2337,6 @@ export class BlockComponent extends Component {
 }
 
 /**
- * @rc
  * Contains information regarding an entity falling onto a
  * specific block.
  */
@@ -2372,7 +2358,6 @@ export class BlockComponentEntityFallOnEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific block that was
  * placed.
  */
@@ -2388,7 +2373,6 @@ export class BlockComponentOnPlaceEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific block being
  * destroyed.
  */
@@ -2411,7 +2395,6 @@ export class BlockComponentPlayerDestroyEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific block being
  * interacted with.
  */
@@ -2440,7 +2423,6 @@ export class BlockComponentPlayerInteractEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding an event before a player
  * places a block.
  */
@@ -2476,7 +2458,6 @@ export class BlockComponentPlayerPlaceBeforeEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific block randomly
  * ticking.
  */
@@ -2485,9 +2466,6 @@ export class BlockComponentRandomTickEvent extends BlockEvent {
     private constructor();
 }
 
-/**
- * @rc
- */
 export class BlockComponentRegistry {
     private constructor();
     /**
@@ -2511,7 +2489,6 @@ export class BlockComponentRegistry {
 }
 
 /**
- * @rc
  * Contains information regarding an entity stepping off a
  * specific block.
  */
@@ -2527,7 +2504,6 @@ export class BlockComponentStepOffEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding an entity stepping onto a
  * specific block.
  */
@@ -2543,7 +2519,6 @@ export class BlockComponentStepOnEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding a specific block ticking.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -2573,7 +2548,6 @@ export class BlockEvent {
 }
 
 /**
- * @rc
  * Contains information regarding an explosion that has
  * occurred for a specific block.
  */
@@ -2595,7 +2569,6 @@ export class BlockExplodeAfterEvent extends BlockEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to when an explosion
  * occurs, as it impacts individual blocks.
  */
@@ -2728,14 +2701,12 @@ export class BlockPermutation {
      */
     getState(stateName: string): boolean | number | string | undefined;
     /**
-     * @rc
      * @remarks
      * Creates a copy of the permutation.
      *
      */
     getTags(): string[];
     /**
-     * @rc
      * @remarks
      * Checks to see if the permutation has a specific tag.
      *
@@ -4352,7 +4323,6 @@ export class Dimension {
      */
     runCommandAsync(commandString: string): Promise<CommandResult>;
     /**
-     * @rc
      * @remarks
      * Sets a block in the world using a BlockPermutation.
      * BlockPermutations are blocks with a particular state.
@@ -4373,7 +4343,6 @@ export class Dimension {
      */
     setBlockPermutation(location: Vector3, permutation: BlockPermutation): void;
     /**
-     * @rc
      * @remarks
      * Sets a block at a given location within the dimension.
      *
@@ -4759,8 +4728,6 @@ export class EffectTypes {
      *
      * This function can't be called in read-only mode.
      *
-     * @param identifier
-     * The identifier for the effect.
      * @returns
      * Effect type for the given identifier or undefined if the
      * effect does not exist.
@@ -4819,7 +4786,6 @@ export class EnchantmentTypes {
      */
     static get(enchantmentId: string): EnchantmentType | undefined;
     /**
-     * @rc
      * @remarks
      * Returns a collection of all available enchantment types.
      *
@@ -5786,7 +5752,6 @@ export class EntityAddRiderComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Adds a timer for the entity to grow up. It can be
  * accelerated by giving the entity the items it likes as
  * defined by feedItems.
@@ -6015,7 +5980,6 @@ export class EntityComponent extends Component {
 }
 
 /**
- * @rc
  * As part of the Ageable component, represents a set of items
  * that can be fed to an entity and the rate at which that
  * causes them to grow.
@@ -6388,7 +6352,6 @@ export class EntityHitBlockAfterEvent {
      */
     readonly hitBlock: Block;
     /**
-     * @rc
      * @remarks
      * Block permutation that was hit by the attack.
      *
@@ -6763,7 +6726,6 @@ export class EntityItemComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Defines the base movement speed in lava of this entity.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -6858,7 +6820,6 @@ export class EntityMovementBasicComponent extends EntityBaseMovementComponent {
 }
 
 /**
- * @rc
  * Defines the general movement speed of this entity.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -6887,7 +6848,6 @@ export class EntityMovementGenericComponent extends EntityBaseMovementComponent
 }
 
 /**
- * @rc
  * When added, this movement control allows the mob to glide.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -6940,7 +6900,6 @@ export class EntityMovementSkipComponent extends EntityBaseMovementComponent {
 }
 
 /**
- * @rc
  * When added, this move control causes the mob to sway side to
  * side giving the impression it is swimming.
  */
@@ -7762,7 +7721,6 @@ export class EntitySpawnAfterEventSignal {
 }
 
 /**
- * @rc
  * Defines the rules for an entity to be tamed by the player.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -7830,7 +7788,6 @@ export class EntityTameableComponent extends EntityComponent {
 export class EntityTameMountComponent extends EntityComponent {
     private constructor();
     /**
-     * @rc
      * @remarks
      * Returns true if the entity is tamed.
      *
@@ -7838,7 +7795,6 @@ export class EntityTameMountComponent extends EntityComponent {
      */
     readonly isTamed: boolean;
     /**
-     * @rc
      * @remarks
      * Returns true if the entity is tamed by a player.
      *
@@ -7846,7 +7802,6 @@ export class EntityTameMountComponent extends EntityComponent {
      */
     readonly isTamedToPlayer: boolean;
     /**
-     * @rc
      * @remarks
      * Returns the player that has tamed the entity, or 'undefined'
      * if entity is not tamed by a player.
@@ -7855,7 +7810,6 @@ export class EntityTameMountComponent extends EntityComponent {
      */
     readonly tamedToPlayer?: Player;
     /**
-     * @rc
      * @remarks
      * Returns the id of player that has tamed the entity, or
      * 'undefined' if entity is not tamed.
@@ -7876,7 +7830,6 @@ export class EntityTameMountComponent extends EntityComponent {
      */
     tame(showParticles: boolean): void;
     /**
-     * @rc
      * @remarks
      * Sets this rideable entity as tamed by the given player.
      *
@@ -7942,7 +7895,6 @@ export class EntityTypes {
 }
 
 /**
- * @rc
  * Defines the general movement speed underwater of this
  * entity.
  */
@@ -8384,7 +8336,6 @@ export class GameRules {
      */
     showCoordinates: boolean;
     /**
-     * @rc
      * @remarks
      * This property can't be edited in read-only mode.
      *
@@ -8602,7 +8553,6 @@ export class ItemCompleteUseAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information related to a chargeable item completing
  * being charged.
  */
@@ -8631,7 +8581,6 @@ export class ItemComponent extends Component {
 }
 
 /**
- * @rc
  * Contains information regarding an item before it is damaged
  * from hitting an entity.
  */
@@ -8665,7 +8614,6 @@ export class ItemComponentBeforeDurabilityDamageEvent {
 }
 
 /**
- * @rc
  * Contains information related to a chargeable item completing
  * being charged via a component.
  */
@@ -8675,7 +8623,6 @@ export class ItemComponentCompleteUseEvent extends ItemCompleteUseEvent {
 }
 
 /**
- * @rc
  * Contains information related to a food item being consumed.
  */
 export class ItemComponentConsumeEvent {
@@ -8695,7 +8642,6 @@ export class ItemComponentConsumeEvent {
 }
 
 /**
- * @rc
  * Contains information regarding when an item is used to hit
  * an entity.
  */
@@ -8728,7 +8674,6 @@ export class ItemComponentHitEntityEvent {
 }
 
 /**
- * @rc
  * Contains information regarding the mining of a block using
  * an item.
  */
@@ -8761,7 +8706,6 @@ export class ItemComponentMineBlockEvent {
 }
 
 /**
- * @rc
  * Provides the functionality for registering custom components
  * for items.
  */
@@ -8800,7 +8744,6 @@ export class ItemComponentRegistry {
 }
 
 /**
- * @rc
  * Contains information regarding the use of an item.
  */
 export class ItemComponentUseEvent {
@@ -8820,7 +8763,6 @@ export class ItemComponentUseEvent {
 }
 
 /**
- * @rc
  * Contains information regarding the use of an item on a block
  * via a component.
  */
@@ -9923,7 +9865,6 @@ export class ItemType {
 }
 
 /**
- * @rc
  * Returns the set of item types registered within Minecraft.
  */
 export class ItemTypes {
@@ -10132,7 +10073,6 @@ export class ItemUseOnBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding the use of an item on a
  * block.
  */
@@ -10440,7 +10380,6 @@ export class Player extends Entity {
      */
     readonly camera: Camera;
     /**
-     * @rc
      * @remarks
      * Input permissions of the player.
      *
@@ -11022,7 +10961,6 @@ export class PlayerGameModeChangeBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding an event after a players
  * input permissions change.
  */
@@ -11049,7 +10987,6 @@ export class PlayerInputPermissionCategoryChangeAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected to after a players
  * input permissions change.
  */
@@ -11078,7 +11015,6 @@ export class PlayerInputPermissionCategoryChangeAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains properties for enabling/disabling player input
  * permissions.
  */
@@ -11102,7 +11038,7 @@ export class PlayerInputPermissions {
 
 /**
  * Contains information regarding an event after a player
- * successfully interacts with a block.
+ * interacts with a block.
  */
 export class PlayerInteractWithBlockAfterEvent {
     private constructor();
@@ -11127,8 +11063,8 @@ export class PlayerInteractWithBlockAfterEvent {
     readonly faceLocation: Vector3;
     /**
      * @remarks
-     * The ItemStack after the interaction succeeded, or undefined
-     * if hand is empty.
+     * The item stack that is being used in the interaction, or
+     * undefined if empty hand.
      *
      */
     readonly itemStack?: ItemStack;
@@ -11244,14 +11180,14 @@ export class PlayerInteractWithBlockBeforeEventSignal {
 
 /**
  * Contains information regarding an event after a player
- * successfully interacts with an entity.
+ * interacts with an entity.
  */
 export class PlayerInteractWithEntityAfterEvent {
     private constructor();
     /**
      * @remarks
-     * The ItemStack after the interaction succeeded, or undefined
-     * if hand is empty.
+     * The item stack that is being used in the interaction, or
+     * undefined if empty hand.
      *
      */
     readonly itemStack?: ItemStack;
@@ -12615,7 +12551,6 @@ export class System {
      */
     readonly currentTick: number;
     /**
-     * @rc
      * @remarks
      * Cancels the execution of a job queued via {@link
      * System.runJob}.
@@ -12693,7 +12628,6 @@ export class System {
      */
     runInterval(callback: () => void, tickInterval?: number): number;
     /**
-     * @rc
      * @remarks
      * Queues a generator to run until completion.  The generator
      * will be given a time slice each tick, and will be run until
@@ -12751,7 +12685,6 @@ export class System {
      */
     runTimeout(callback: () => void, tickDelay?: number): number;
     /**
-     * @rc
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
@@ -12835,7 +12768,6 @@ export class TargetBlockHitAfterEventSignal {
 }
 
 /**
- * @rc
  * Represents a trigger for firing an event.
  */
 export class Trigger {
@@ -13587,7 +13519,6 @@ export class World {
 export class WorldAfterEvents {
     private constructor();
     /**
-     * @rc
      * @remarks
      * This event fires for each BlockLocation destroyed by an
      * explosion. It is fired after the blocks have already been
@@ -13763,7 +13694,6 @@ export class WorldAfterEvents {
     readonly playerDimensionChange: PlayerDimensionChangeAfterEventSignal;
     readonly playerGameModeChange: PlayerGameModeChangeAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a players input permissions change.
      *
@@ -13909,7 +13839,6 @@ export class WorldBeforeEvents {
     readonly playerLeave: PlayerLeaveBeforeEventSignal;
     readonly weatherChange: WeatherChangeBeforeEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires immediately when the script environment is
      * initialized on a World. Not all script functionality may be
@@ -13956,7 +13885,6 @@ export class WorldInitializeAfterEventSignal {
 }
 
 /**
- * @rc
  * Contains information and methods that can be used at the
  * initialization of the scripting environment for a World.
  * Also, use the supplied blockRegistry object to register
@@ -13976,7 +13904,6 @@ export class WorldInitializeBeforeEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are run at the initialization of the
  * scripting environment for a World. Do note that this event
  * may run multiple times within a session in the case that the
@@ -14005,7 +13932,6 @@ export class WorldInitializeBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains a set of events that will be raised for a block.
  * This object must be bound using the BlockRegistry.
  */
@@ -14927,7 +14853,6 @@ export interface EntityRaycastHit {
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface EntityRaycastOptions extends EntityFilter {
     /**
-     * @rc
      * @remarks
      * If true, blocks will not be considered as blocks that 'stop'
      * the raycast.
@@ -14935,7 +14860,6 @@ export interface EntityRaycastOptions extends EntityFilter {
      */
     ignoreBlockCollision?: boolean;
     /**
-     * @rc
      * @remarks
      * If true, liquid blocks will be considered as blocks that
      * 'stop' the raycast.
@@ -14943,7 +14867,6 @@ export interface EntityRaycastOptions extends EntityFilter {
      */
     includeLiquidBlocks?: boolean;
     /**
-     * @rc
      * @remarks
      * If true, passable blocks like vines and flowers will be
      * considered as blocks that 'stop' the raycast.
@@ -15008,7 +14931,6 @@ export interface ExplosionOptions {
 }
 
 /**
- * @rc
  * Contains a set of events that will be raised for an item.
  * This object must be bound using the ItemComponentRegistry.
  */
@@ -15638,33 +15560,21 @@ export interface WorldSoundOptions {
     volume?: number;
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class BlockCustomComponentAlreadyRegisteredError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class BlockCustomComponentReloadNewComponentError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class BlockCustomComponentReloadNewEventError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class BlockCustomComponentReloadVersionError extends Error {
     private constructor();
@@ -15675,17 +15585,11 @@ export class CommandError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class CustomComponentInvalidRegistryError extends Error {
     private constructor();
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class CustomComponentNameError extends Error {
     private constructor();
@@ -15726,7 +15630,6 @@ export class InvalidStructureError extends Error {
 }
 
 /**
- * @rc
  * Thrown when trying to register an item custom component with
  * a name that has already been registered.
  */
@@ -15736,7 +15639,6 @@ export class ItemCustomComponentAlreadyRegisteredError extends Error {
 }
 
 /**
- * @rc
  * Thrown after using the /reload command when trying to
  * register a previously unregistered item custom component.
  */
@@ -15746,7 +15648,6 @@ export class ItemCustomComponentReloadNewComponentError extends Error {
 }
 
 /**
- * @rc
  * Thrown after using the /reload command when trying to
  * register a previously registered item custom component that
  * handles a new event.
@@ -15757,7 +15658,6 @@ export class ItemCustomComponentReloadNewEventError extends Error {
 }
 
 /**
- * @rc
  * Thrown after using the /reload command when trying to
  * register a previously registered item custom component with
  * a newer API version.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.12.0-rc.1.21.30-preview.21",
+  "version": "1.12.0",
   "description": "",
   "contributors": [
     {