@minecraft/server 1.1.0-beta.1.19.70-preview.24 → 1.1.0-beta.1.19.70-stable

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.
    ***************************************************************************** */
 /**
- * @beta
  * @packageDocumentation
  * Contains many types related to manipulating a Minecraft
  * world, including entities, blocks, dimensions, and more.
@@ -16,7 +15,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.1.0-internal.1.19.70-preview.24"
+ *   "version": "1.0.0"
  * }
  * ```
  *
@@ -1278,10 +1277,6 @@ export class BlockRecordPlayerComponent extends BlockComponent {
  */
 export class BlockSignComponent extends BlockComponent {
     protected constructor();
-    /**
-     * Text of the sign
-     * @throws This property can throw when used.
-     */
     readonly text: string;
     /**
      * Identifier of this component. Should always be
@@ -1882,6 +1877,24 @@ export class Dimension {
      * ```
      */
     createExplosion(location: Vector3, radius: number, explosionOptions?: ExplosionOptions): void;
+    /**
+     * @beta
+     * @remarks
+     * Fills an area between begin and end with block of type
+     * block.
+     * @param begin
+     * The lower northwest starting corner of the area.
+     * @param end
+     * The upper southeast ending corner of the area.
+     * @param block
+     * Type of block to fill the volume with.
+     * @param options
+     * A set of additional options, such as a matching block to
+     * potentially replace this fill block with.
+     * @returns
+     *  Returns number of blocks placed.
+     * @throws This function can throw errors.
+     */
     fillBlocks(begin: Vector3, end: Vector3, block: BlockPermutation | BlockType, options?: BlockFillOptions): number;
     /**
      * @beta
@@ -2116,21 +2129,21 @@ export class DirectionBlockProperty {
 export class DynamicPropertiesDefinition {
     /**
      * @remarks
-     * Defines a new boolean dynamic property.
+     * Defines a boolean dynamic property.
      * @param identifier
      * @throws This function can throw errors.
      */
     defineBoolean(identifier: string): void;
     /**
      * @remarks
-     * Defines a new number dynamic property.
+     * Defines a number dynamic property.
      * @param identifier
      * @throws This function can throw errors.
      */
     defineNumber(identifier: string): void;
     /**
      * @remarks
-     * Defines a new string dynamic property.
+     * Defines a string dynamic property.
      * @param identifier
      * @param maxLength
      * @throws This function can throw errors.
@@ -2256,6 +2269,11 @@ export class EnchantmentList implements Iterable<Enchantment> {
      * The item slot/type that this collection is applied to.
      */
     readonly slot: number;
+    /**
+     * @remarks
+     * Creates a new EnchantmentList.
+     * @param enchantmentSlot
+     */
     constructor(enchantmentSlot: number);
     [Symbol.iterator](): Iterator<Enchantment>;
     /**
@@ -2454,10 +2472,33 @@ export class Entity {
      * @throws This function can throw errors.
      */
     addTag(tag: string): boolean;
+    /**
+     * @beta
+     * @remarks
+     * Applies a set of damage to an entity.
+     * @param amount
+     * Amount of damage to apply.
+     * @param source
+     * Additional option about the source of damage, which may add
+     * additional effects or spur additional behaviors on this
+     * entity.
+     * @throws This function can throw errors.
+     */
     applyDamage(amount: number, source?: EntityDamageSource): boolean;
     applyImpulse(vector: Vector3): void;
     applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void;
     clearVelocity(): void;
+    /**
+     * @beta
+     * @remarks
+     * Extinguishes the fire if the entity is on fire. Note that
+     * you can call getComponent('minecraft:onfire') and, if
+     * present, the entity is on fire.
+     * @param useEffects
+     * Whether to show any visual effects connected to the
+     * extinguishing.
+     * @throws This function can throw errors.
+     */
     extinguishFire(useEffects?: boolean): boolean;
     /**
      * @beta
@@ -2510,6 +2551,14 @@ export class Entity {
      * @throws This function can throw errors.
      */
     getEffect(effectType: EffectType): Effect;
+    /**
+     * @beta
+     * @remarks
+     * Returns a set of effects applied to this item.
+     * @returns
+     * List of effects.
+     * @throws This function can throw errors.
+     */
     getEffects(): Effect[];
     /**
      * @beta
@@ -2600,6 +2649,17 @@ export class Entity {
      * @throws This function can throw errors.
      */
     setDynamicProperty(identifier: string, value: boolean | number | string): void;
+    /**
+     * @beta
+     * @remarks
+     * Sets an entity on fire (if it is not in water or rain). Note
+     * that you can call getComponent('minecraft:onfire') and, if
+     * present, the entity is on fire.
+     * @param seconds
+     * Length of time to set the entity on fire.
+     * @param useEffects
+     * @throws This function can throw errors.
+     */
     setOnFire(seconds: number, useEffects?: boolean): boolean;
     /**
      * @beta
@@ -3147,6 +3207,10 @@ export class EntityHurtEvent {
      * Describes the amount of damage caused.
      */
     readonly damage: number;
+    /**
+     * Source information on the entity that may have applied this
+     * damage.
+     */
     readonly damageSource: EntityDamageSource;
     /**
      * Entity that was hurt.
@@ -4700,9 +4764,19 @@ export class EntityNavigationWalkComponent extends IEntityComponent {
      */
     static readonly componentId = 'minecraft:navigation.walk';
 }
+/**
+ * @beta
+ * When present on an entity, this entity is on fire.
+ */
 export class EntityOnFireComponent extends IEntityComponent {
     protected constructor();
+    /**
+     * The number of ticks remaining before the fire goes out.
+     */
     readonly onFireTicksRemaining: number;
+    /**
+     * Should be 'minecraft:onfire'.
+     */
     readonly typeId: string;
     static readonly componentId = 'minecraft:onfire';
 }
@@ -9450,6 +9524,10 @@ export class MinecraftEffectTypes {
     static readonly weakness: EffectType;
     static readonly wither: EffectType;
 }
+/**
+ * @beta
+ * Describes a set of enchantment types.
+ */
 // tslint:disable-next-line:no-unnecessary-class
 export class MinecraftEnchantmentTypes {
     protected constructor();
@@ -12496,7 +12574,29 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     addEffect(effectType: EffectType, duration: number, amplifier?: number, showParticles?: boolean): void;
+    /**
+     * @beta
+     * @remarks
+     * Adds/removes experience to/from the Player and returns the
+     * current experience of the Player.
+     * @param amount
+     * Amount of experience to add. Note that this can be negative.
+     * @returns
+     * Returns the current experience of the Player.
+     * @throws This function can throw errors.
+     */
     addExperience(amount: number): number;
+    /**
+     * @beta
+     * @remarks
+     *  Adds/removes level to/from the Player and returns the
+     * current level of the Player.
+     * @param amount
+     * Amount to add to the player.
+     * @returns
+     * Returns the current level of the Player.
+     * @throws This function can throw errors.
+     */
     addLevels(amount: number): number;
     /**
      * @beta
@@ -12507,11 +12607,33 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     addTag(tag: string): boolean;
+    /**
+     * @beta
+     * @remarks
+     * Applies damage to the player.
+     * @param amount
+     * Amount of damage to apply.
+     * @param source
+     * Additional information around the source of damage that can
+     * apply to the player.
+     * @throws This function can throw errors.
+     */
     applyDamage(amount: number, source?: EntityDamageSource): boolean;
     applyImpulse(vector: Vector3): void;
     applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void;
     clearSpawn(): void;
     clearVelocity(): void;
+    /**
+     * @beta
+     * @remarks
+     * Extinguishes the fire if the player is on fire. Note that
+     * you can call getComponent('minecraft:onfire') and, if
+     * present, the player is on fire."
+     * @param useEffects
+     * Whether to show any visual effects connected to the
+     * extinguishing.
+     * @throws This function can throw errors.
+     */
     extinguishFire(useEffects?: boolean): boolean;
     /**
      * @beta
@@ -12564,6 +12686,12 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     getEffect(effectType: EffectType): Effect;
+    /**
+     * @beta
+     * @remarks
+     * Returns a set of effects applied to this player.
+     * @throws This function can throw errors.
+     */
     getEffects(): Effect[];
     /**
      * @beta
@@ -12595,6 +12723,12 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     getTags(): string[];
+    /**
+     * @beta
+     * @remarks
+     *  Gets the total experience of the Player.
+     * @throws This function can throw errors.
+     */
     getTotalXp(): number;
     getVelocity(): Vector3;
     getViewDirection(): Vector3;
@@ -12671,6 +12805,12 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     removeTag(tag: string): boolean;
+    /**
+     * @beta
+     * @remarks
+     * Resets the level of the player.
+     * @throws This function can throw errors.
+     */
     resetLevel(): void;
     /**
      * @remarks
@@ -12738,6 +12878,17 @@ export class Player extends Entity {
      * @throws This function can throw errors.
      */
     setDynamicProperty(identifier: string, value: boolean | number | string): void;
+    /**
+     * @beta
+     * @remarks
+     * Sets a player on fire (if it is not in water or rain). Note
+     * that you can call getComponent('minecraft:onfire') and, if
+     * present, the player is on fire.
+     * @param seconds
+     * Length of time to set the player on fire.
+     * @param useEffects
+     * @throws This function can throw errors.
+     */
     setOnFire(seconds: number, useEffects?: boolean): boolean;
     /**
      * @beta
@@ -13078,6 +13229,7 @@ export class Scoreboard {
      * @remarks
      * Returns a specific objective (by id).
      * @param objectiveId
+     * Identifier of the objective.
      * @throws This function can throw errors.
      */
     getObjective(objectiveId: string): ScoreboardObjective;
@@ -13101,6 +13253,17 @@ export class Scoreboard {
      * @throws This function can throw errors.
      */
     getParticipants(): ScoreboardIdentity[];
+    /**
+     * @remarks
+     * Returns a score given an objective and participant.
+     * @param objective
+     * Objective to retrieve the score for.
+     * @param participant
+     * Participant to retrieve the score for.
+     * @returns
+     * Score value.
+     * @throws This function can throw errors.
+     */
     getScore(objective: ScoreboardObjective, participant: ScoreboardIdentity): number;
     /**
      * @remarks
@@ -13121,6 +13284,16 @@ export class Scoreboard {
         displaySlotId: string,
         objectiveDisplaySetting: ScoreboardObjectiveDisplayOptions,
     ): ScoreboardObjective;
+    /**
+     * @remarks
+     * Sets the score given a participant and objective.
+     * @param objective
+     * Objective to use for the scoreboard.
+     * @param participant
+     * Participant to apply the scoreboard value to.
+     * @param score
+     * @throws This function can throw errors.
+     */
     setScore(objective: ScoreboardObjective, participant: ScoreboardIdentity, score: number): boolean;
 }
 /**
@@ -13148,8 +13321,35 @@ export class ScoreboardIdentity {
      * @throws This function can throw errors.
      */
     getEntity(): Entity;
+    /**
+     * @remarks
+     * Gets the current score for this participant based on an
+     * objective.
+     * @param objective
+     * The objective to retrieve the score for.
+     * @returns
+     * Score value.
+     * @throws This function can throw errors.
+     */
     getScore(objective: ScoreboardObjective): number;
+    /**
+     * @remarks
+     * Removes this participant from an objective.
+     * @param objective
+     * The objective to remove this participant from.
+     * @throws This function can throw errors.
+     */
     removeFromObjective(objective: ScoreboardObjective): boolean;
+    /**
+     * @remarks
+     * Sets a score for this participant for a particular
+     * objective.
+     * @param objective
+     * Objective to apply the score to.
+     * @param score
+     * Score value.
+     * @throws This function can throw errors.
+     */
     setScore(objective: ScoreboardObjective, score: number): boolean;
 }
 /**
@@ -13179,6 +13379,7 @@ export class ScoreboardObjective {
      * @remarks
      * Returns a specific score for a participant.
      * @param participant
+     * Identifier of the participant to retrieve a score for.
      * @throws This function can throw errors.
      */
     getScore(participant: ScoreboardIdentity): number;
@@ -13189,7 +13390,24 @@ export class ScoreboardObjective {
      * @throws This function can throw errors.
      */
     getScores(): ScoreboardScoreInfo[];
+    /**
+     * @remarks
+     * Removes a participant from this scoreboard objective.
+     * @param participant
+     * Participant to remove from being tracked with this
+     * objective.
+     * @throws This function can throw errors.
+     */
     removeParticipant(participant: ScoreboardIdentity): boolean;
+    /**
+     * @remarks
+     * Sets a score for a participant.
+     * @param participant
+     * Identity of the participant.
+     * @param score
+     * New value of the score.
+     * @throws This function can throw errors.
+     */
     setScore(participant: ScoreboardIdentity, score: number): boolean;
 }
 /**
@@ -13248,13 +13466,40 @@ export class ScreenDisplay {
      */
     updateSubtitle(subtitle: string): void;
 }
+/**
+ * @beta
+ * Returns additional data about a /scriptevent command
+ * invocation.
+ */
 export class ScriptEventCommandMessageEvent {
     protected constructor();
+    /**
+     * Identifier of this ScriptEvent command message.
+     */
     readonly id: string;
+    /**
+     * If this command was initiated via an NPC, returns the entity
+     * that initiated the NPC dialogue.
+     */
     readonly initiator: Entity;
+    /**
+     * Optional additional data passed in with the script event
+     * command.
+     */
     readonly message: string;
+    /**
+     * Source block if this command was triggered via a block
+     * (e.g., a commandblock.)
+     */
     readonly sourceBlock: Block;
+    /**
+     * Source entity if this command was triggered by an entity
+     * (e.g., a NPC).
+     */
     readonly sourceEntity: Entity;
+    /**
+     * Returns the type of source that fired this command.
+     */
     readonly sourceType: MessageSourceType;
 }
 /**
@@ -13370,7 +13615,33 @@ export class System {
      * function to cancel the execution of this run.
      */
     run(callback: () => void): number;
+    /**
+     * @beta
+     * @remarks
+     * Runs a set of code on an interval.
+     * @param callback
+     * Functional code that will run when this interval occurs.
+     * @param tickInterval
+     * An interval of every N ticks that the callback will be
+     * called upon.
+     * @returns
+     * An opaque handle that can be used with the clearRun method
+     * to stop the run of this function on an interval.
+     */
     runInterval(callback: () => void, tickInterval?: number): number;
+    /**
+     * @beta
+     * @remarks
+     * Runs a set of code at a future time specified by tickDelay.
+     * @param callback
+     * Functional code that will run when this timeout occurs.
+     * @param tickDelay
+     * Amount of time, in ticks, before the interval will be
+     * called.
+     * @returns
+     * An opaque handle that can be used with the clearRun method
+     * to stop the run of this function on an interval.
+     */
     runTimeout(callback: () => void, tickDelay?: number): number;
 }
 /**
@@ -13440,6 +13711,11 @@ export class Trigger {
      * Event name of the trigger.
      */
     eventName: string;
+    /**
+     * @remarks
+     * Creates a new trigger.
+     * @param eventName
+     */
     constructor(eventName: string);
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.1.0-beta.1.19.70-preview.24",
+  "version": "1.1.0-beta.1.19.70-stable",
   "description": "",
   "contributors": [
     {