@minecraft/server-editor 0.1.0-beta.1.20.30-preview.22 → 0.1.0-beta.1.20.40-preview.22

package/README.md

@@ -4,4 +4,4 @@
 
 See full documentation for this module here:
 
-https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/@minecraft/server-editor/@minecraft/server-editor
+https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/minecraft-server-editor

package/index.d.ts

@@ -14,7 +14,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server-editor",
- *   "version": "0.1.0-beta.1.20.30-preview.22"
+ *   "version": "0.1.0-beta.1.20.40-preview.22"
  * }
  * ```
  *
@@ -303,7 +303,17 @@ export declare enum KeyboardKey {
  * Keyboard Key Actions
  */
 export declare enum KeyInputType {
+    /**
+     * @remarks
+     * Button was pressed.
+     *
+     */
     Press = 1,
+    /**
+     * @remarks
+     * Button was released.
+     *
+     */
     Release = 2,
 }
 
@@ -311,8 +321,23 @@ export declare enum KeyInputType {
  * Mouse device action categories
  */
 export declare enum MouseActionCategory {
+    /**
+     * @remarks
+     * Mouse button was used.
+     *
+     */
     Button = 1,
+    /**
+     * @remarks
+     * Mouse wheel was used.
+     *
+     */
     Wheel = 2,
+    /**
+     * @remarks
+     * Mouse was dragged.
+     *
+     */
     Drag = 3,
 }
 
@@ -339,6 +364,21 @@ export declare enum MouseInputType {
     DragEnd = 7,
 }
 
+export enum PlaytestSessionResult {
+    OK = 0,
+    InvalidSessionHandle = 1,
+    SessionInfoNotFound = 2,
+    TooManyPlayers = 3,
+    WorldExportFailed = 4,
+    WorldExportBusy = 5,
+    UnsupportedScenario = 6,
+    EditorSystemFailure = 7,
+    InvalidLevelId = 8,
+    PlayerNotFound = 9,
+    ResponseTimeout = 10,
+    UnspecifiedError = 11,
+}
+
 /**
  * Full set of all possible raw actions
  */
@@ -407,6 +447,20 @@ export type IPlayerUISession<PerPlayerStorage = Record<string, never>> = {
     scratchStorage: PerPlayerStorage | undefined;
 };
 
+/**
+ * A property item which supports Vector3 properties
+ */
+export type IVector3PropertyItem<T extends PropertyBag, Prop extends keyof T & string> = IPropertyItem<T, Prop> & {
+    updateAxisLimits(limits: {
+        minX?: number;
+        maxX?: number;
+        minY?: number;
+        maxY?: number;
+        minZ?: number;
+        maxZ?: number;
+    }): void;
+};
+
 /**
  * Modal tool lifecycle event payload
  */
@@ -542,33 +596,7 @@ export declare class BedrockEventSubscriptionCache {
     subscribeToBedrockEvent<T extends keyof minecraftserver.WorldAfterEvents>(
         event: T,
         ...params: Parameters<minecraftserver.WorldAfterEvents[T]['subscribe']>
-    ):
-        | ((arg: minecraftserver.BlockBreakAfterEvent) => void)
-        | ((arg: minecraftserver.BlockExplodeAfterEvent) => void)
-        | ((arg: minecraftserver.ChatSendAfterEvent) => void)
-        | ((arg: minecraftserver.DataDrivenEntityTriggerAfterEvent) => void)
-        | ((arg: minecraftserver.EffectAddAfterEvent) => void)
-        | ((arg: minecraftserver.EntityDieAfterEvent) => void)
-        | ((arg: minecraftserver.EntityHealthChangedAfterEvent) => void)
-        | ((arg: minecraftserver.EntityHitBlockAfterEvent) => void)
-        | ((arg: minecraftserver.EntityHitEntityAfterEvent) => void)
-        | ((arg: minecraftserver.EntityHurtAfterEvent) => void)
-        | ((arg: minecraftserver.EntityRemoveAfterEvent) => void)
-        | ((arg: minecraftserver.ExplosionAfterEvent) => void)
-        | ((arg: minecraftserver.ItemCompleteUseAfterEvent) => void)
-        | ((arg: minecraftserver.ItemDefinitionTriggeredAfterEvent) => void)
-        | ((arg: minecraftserver.ItemUseOnAfterEvent) => void)
-        | ((arg: minecraftserver.LeverActionAfterEvent) => void)
-        | ((arg: minecraftserver.MessageReceiveAfterEvent) => void)
-        | ((arg: minecraftserver.PistonActivateAfterEvent) => void)
-        | ((arg: minecraftserver.PlayerJoinAfterEvent) => void)
-        | ((arg: minecraftserver.PlayerSpawnAfterEvent) => void)
-        | ((arg: minecraftserver.ProjectileHitBlockAfterEvent) => void)
-        | ((arg: minecraftserver.ProjectileHitEntityAfterEvent) => void)
-        | ((arg: minecraftserver.TargetBlockHitAfterEvent) => void)
-        | ((arg: minecraftserver.TripWireTripAfterEvent) => void)
-        | ((arg: minecraftserver.WeatherChangeAfterEvent) => void)
-        | ((arg: minecraftserver.WorldInitializeAfterEvent) => void);
+    ): ReturnType<minecraftserver.WorldAfterEvents[T]['subscribe']>;
     /**
      * @remarks
      * Cleans up the set of internal registrations and
@@ -935,6 +963,7 @@ export class ExtensionContext {
      *
      */
     readonly player: minecraftserver.Player;
+    readonly playtest: PlaytestManager;
     /**
      * @remarks
      * The instance of the players Selection Manager and the main
@@ -1076,6 +1105,24 @@ export class MinecraftEditor {
     ): Extension;
 }
 
+export class PlaytestManager {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    beginPlaytest(options: PlaytestGameOptions): Promise<PlaytestSessionResult>;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    getPlaytestSessionAvailability(): PlaytestSessionResult;
+}
+
 /**
  * The Selection represents a volume in space, which may
  * potentially be made up of one or more block locations.
@@ -1697,6 +1744,16 @@ export interface LogProperties {
     tags?: string[];
 }
 
+export interface PlaytestGameOptions {
+    alwaysDay?: boolean;
+    difficulty?: minecraftserver.Difficulty;
+    disableWeather?: boolean;
+    gameMode?: minecraftserver.GameMode;
+    showCoordinates?: boolean;
+    spawnPosition?: minecraftserver.Vector3;
+    timeOfDay?: number;
+}
+
 /**
  * Binds actions to the client and manages their lifetime.
  * Action managers are managed on a per player basis since
@@ -2275,7 +2332,7 @@ export interface IPropertyPane {
         obj: T,
         property: Prop,
         options?: IPropertyItemOptionsVector3,
-    ): IPropertyItem<T, Prop>;
+    ): IVector3PropertyItem<T, Prop>;
     /**
      * @remarks
      * Collapse the pane.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-editor",
-  "version": "0.1.0-beta.1.20.30-preview.22",
+  "version": "0.1.0-beta.1.20.40-preview.22",
   "description": "",
   "contributors": [
     {
@@ -13,7 +13,7 @@
     }
   ],
   "dependencies": {
-    "@minecraft/server": "^1.6.0-beta.1.20.30-preview.22"
+    "@minecraft/server": "^1.7.0-beta.1.20.40-preview.22"
   },
   "license": "MIT"
 }