@minecraft/server-editor 0.1.0-beta.1.21.100-preview.21 → 0.1.0-beta.1.21.100-preview.23

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.
Files changed (2) hide show
  1. package/index.d.ts +126 -7
  2. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -33,6 +33,11 @@ export declare enum ActionTypes {
33
33
  StatefulAction = 'StatefulAction',
34
34
  }
35
35
 
36
+ export enum AudioSettingsProperty {
37
+ AreSoundsMuted = 'AreSoundsMuted',
38
+ IsMusicMuted = 'IsMusicMuted',
39
+ }
40
+
36
41
  export enum Axis {
37
42
  None = 0,
38
43
  X = 1,
@@ -922,6 +927,27 @@ export declare enum LayoutDirection {
922
927
  Horizontal = 1,
923
928
  }
924
929
 
930
+ export enum LogChannel {
931
+ /**
932
+ * @remarks
933
+ * Regular message channel.
934
+ *
935
+ */
936
+ Message = 1,
937
+ /**
938
+ * @remarks
939
+ * Toast channel.
940
+ *
941
+ */
942
+ Toast = 2,
943
+ /**
944
+ * @remarks
945
+ * Regular message and toast channels.
946
+ *
947
+ */
948
+ All = 3,
949
+ }
950
+
925
951
  /**
926
952
  * Mouse device action categories
927
953
  */
@@ -1230,6 +1256,11 @@ export type ActivationFunctionType<PerPlayerStorageType> = (
1230
1256
  uiSession: IPlayerUISession<PerPlayerStorageType>,
1231
1257
  ) => IDisposable[];
1232
1258
 
1259
+ export type AudioSettingsPropertyTypeMap = {
1260
+ [AudioSettingsProperty.IsMusicMuted]?: boolean;
1261
+ [AudioSettingsProperty.AreSoundsMuted]?: boolean;
1262
+ };
1263
+
1233
1264
  /**
1234
1265
  * Possible tooltip types
1235
1266
  */
@@ -1454,6 +1485,7 @@ export type SupportedMouseActionTypes = RegisteredAction<MouseRayCastAction>;
1454
1485
  export declare type TooltipContent = {
1455
1486
  title?: LocalizedString;
1456
1487
  description?: LocalizedString;
1488
+ image?: string;
1457
1489
  };
1458
1490
 
1459
1491
  /**
@@ -1479,6 +1511,26 @@ export declare type TooltipLink = {
1479
1511
 
1480
1512
  export type UnregisterInputBindingCallback = () => void;
1481
1513
 
1514
+ export class AudioSettings {
1515
+ private constructor();
1516
+ get<T extends keyof AudioSettingsPropertyTypeMap>(property: T): AudioSettingsPropertyTypeMap[T] | undefined;
1517
+ getAll(): AudioSettingsPropertyTypeMap;
1518
+ /**
1519
+ * @remarks
1520
+ * This function can't be called in read-only mode.
1521
+ *
1522
+ * @throws This function can throw errors.
1523
+ */
1524
+ set<T extends keyof AudioSettingsPropertyTypeMap>(property: T, value: AudioSettingsPropertyTypeMap[T]): void;
1525
+ /**
1526
+ * @remarks
1527
+ * This function can't be called in read-only mode.
1528
+ *
1529
+ * @throws This function can throw errors.
1530
+ */
1531
+ setAll(properties: AudioSettingsPropertyTypeMap): void;
1532
+ }
1533
+
1482
1534
  /**
1483
1535
  * A cache for bedrock event subscriptions. Stores off a
1484
1536
  * subscription by event key, and upon teardown unregisters all
@@ -2008,7 +2060,16 @@ export declare class ConeBrushShape extends BrushShape {
2008
2060
  * Constructs a new instance of the `ConeBrushShape` class
2009
2061
  *
2010
2062
  */
2011
- constructor(settings?: { uniform?: boolean; radius?: number; width?: number; height?: number; depth?: number });
2063
+ constructor(settings?: {
2064
+ uniform?: boolean;
2065
+ radius?: number;
2066
+ width?: number;
2067
+ height?: number;
2068
+ depth?: number;
2069
+ xRotation?: number;
2070
+ yRotation?: number;
2071
+ zRotation?: number;
2072
+ });
2012
2073
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2013
2074
  createShape(): RelativeVolumeListBlockVolume;
2014
2075
  }
@@ -2027,6 +2088,9 @@ export declare class CuboidBrushShape extends BrushShape {
2027
2088
  height?: number;
2028
2089
  depth?: number;
2029
2090
  minLength?: number;
2091
+ xRotation?: number;
2092
+ yRotation?: number;
2093
+ zRotation?: number;
2030
2094
  });
2031
2095
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2032
2096
  createShape(): RelativeVolumeListBlockVolume;
@@ -2257,6 +2321,9 @@ export declare class CylinderBrushShape extends BrushShape {
2257
2321
  height?: number;
2258
2322
  depth?: number;
2259
2323
  minRadius?: number;
2324
+ xRotation?: number;
2325
+ yRotation?: number;
2326
+ zRotation?: number;
2260
2327
  });
2261
2328
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2262
2329
  createShape(): RelativeVolumeListBlockVolume;
@@ -2389,6 +2456,9 @@ export declare class EllipsoidBrushShape extends BrushShape {
2389
2456
  height?: number;
2390
2457
  depth?: number;
2391
2458
  minRadius?: number;
2459
+ xRotation?: number;
2460
+ yRotation?: number;
2461
+ zRotation?: number;
2392
2462
  });
2393
2463
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2394
2464
  createShape(): RelativeVolumeListBlockVolume;
@@ -2919,7 +2989,15 @@ export declare class PyramidBrushShape extends BrushShape {
2919
2989
  * Constructs a new instance of the `PyramidBrushShape` class
2920
2990
  *
2921
2991
  */
2922
- constructor(settings?: { uniform?: boolean; width?: number; height?: number; depth?: number });
2992
+ constructor(settings?: {
2993
+ uniform?: boolean;
2994
+ width?: number;
2995
+ height?: number;
2996
+ depth?: number;
2997
+ xRotation?: number;
2998
+ yRotation?: number;
2999
+ zRotation?: number;
3000
+ });
2923
3001
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2924
3002
  createShape(): RelativeVolumeListBlockVolume;
2925
3003
  }
@@ -3130,6 +3208,7 @@ export class SelectionManager {
3130
3208
  */
3131
3209
  export class SettingsManager {
3132
3210
  private constructor();
3211
+ readonly audio: AudioSettings;
3133
3212
  /**
3134
3213
  * @remarks
3135
3214
  * Manages graphics settings properties.
@@ -6375,32 +6454,58 @@ export interface IPlayerLogger {
6375
6454
  *
6376
6455
  * @param message
6377
6456
  * Message content
6457
+ * @param props
6458
+ * Optional player log properties
6378
6459
  */
6379
- debug(message: string): void;
6460
+ debug(message: string, props?: IPlayerLoggerProperties): void;
6380
6461
  /**
6381
6462
  * @remarks
6382
6463
  * Dispatch a player log message with Error log level
6383
6464
  *
6384
6465
  * @param message
6385
6466
  * Message content
6467
+ * @param props
6468
+ * Optional player log properties
6386
6469
  */
6387
- error(message: string): void;
6470
+ error(message: string, props?: IPlayerLoggerProperties): void;
6388
6471
  /**
6389
6472
  * @remarks
6390
6473
  * Dispatch a player log message with Info log level
6391
6474
  *
6392
6475
  * @param message
6393
6476
  * Message content
6477
+ * @param props
6478
+ * Optional player log properties
6394
6479
  */
6395
- info(message: string): void;
6480
+ info(message: string, props?: IPlayerLoggerProperties): void;
6396
6481
  /**
6397
6482
  * @remarks
6398
6483
  * Dispatch a player log message with Warning log level
6399
6484
  *
6400
6485
  * @param message
6401
6486
  * Message content
6487
+ * @param props
6488
+ * Optional player log properties
6489
+ */
6490
+ warning(message: string, props?: IPlayerLoggerProperties): void;
6491
+ }
6492
+
6493
+ /**
6494
+ * Player Logger Properties.
6495
+ */
6496
+ export interface IPlayerLoggerProperties {
6497
+ /**
6498
+ * @remarks
6499
+ * A log channel mask, default is Message
6500
+ *
6402
6501
  */
6403
- warning(message: string): void;
6502
+ channelMask: LogChannel;
6503
+ /**
6504
+ * @remarks
6505
+ * A player log sub message for the toast channel
6506
+ *
6507
+ */
6508
+ subMessage: string;
6404
6509
  }
6405
6510
 
6406
6511
  /**
@@ -7406,6 +7511,13 @@ export interface IVector3PropertyItemOptions extends IPropertyItemOptionsBase {
7406
7511
  * server->client messaging and broadcasts.
7407
7512
  */
7408
7513
  export interface LogProperties {
7514
+ /**
7515
+ * @remarks
7516
+ * Display the log message to a log channel. If no channel is
7517
+ * specified, default channel is regular message.
7518
+ *
7519
+ */
7520
+ channelMask?: LogChannel;
7409
7521
  /**
7410
7522
  * @remarks
7411
7523
  * Direct a log message to a specific player. If no player is
@@ -7413,6 +7525,13 @@ export interface LogProperties {
7413
7525
  *
7414
7526
  */
7415
7527
  player?: minecraftserver.Player;
7528
+ /**
7529
+ * @remarks
7530
+ * Message to be shown under the message when toast channel is
7531
+ * selected.
7532
+ *
7533
+ */
7534
+ subMessage?: string;
7416
7535
  /**
7417
7536
  * @remarks
7418
7537
  * Add additional tags to the log message which can be used by
@@ -7449,7 +7568,7 @@ export interface ModalToolCreationParameters {
7449
7568
  * Tooltip description of the tool
7450
7569
  *
7451
7570
  */
7452
- tooltip?: string;
7571
+ tooltip?: BasicTooltipContent;
7453
7572
  }
7454
7573
 
7455
7574
  export interface ProjectExportOptions {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server-editor",
3
- "version": "0.1.0-beta.1.21.100-preview.21",
3
+ "version": "0.1.0-beta.1.21.100-preview.23",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {
@@ -14,7 +14,7 @@
14
14
  ],
15
15
  "dependencies": {
16
16
  "@minecraft/common": "^1.0.0",
17
- "@minecraft/server": "^2.2.0-beta.1.21.100-preview.21"
17
+ "@minecraft/server": "^2.2.0-beta.1.21.100-preview.23"
18
18
  },
19
19
  "license": "MIT"
20
20
  }