@cesdk/engine 1.16.0-rc.0 → 1.16.0-rc.1

package/index.d.ts

@@ -1480,12 +1480,14 @@ export declare class BlockAPI {
      * @param g - The green color component in the range of 0 to 1.
      * @param b - The blue color component in the range of 0 to 1.
      * @param a - The alpha color component in the range of 0 to 1.
+     * @deprecated Use `Use setColor() with the key path 'backgroundColor/color' instead.`.
      */
     setBackgroundColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
     /**
      * Get the background color of the given design block.
      * @param id - The block whose background color should be queried.
      * @returns The background color.
+     * @deprecated Use `Use getColor() with the key path 'backgroundColor/color' instead.`.
      */
     getBackgroundColorRGBA(id: DesignBlockId): RGBA;
     /**
@@ -1525,14 +1527,28 @@ export declare class BlockAPI {
      * @param g - The green color component in the range of 0 to 1.
      * @param b - The blue color component in the range of 0 to 1.
      * @param a - The alpha color component in the range of 0 to 1.
+     * @deprecated Use setStrokeColor() instead.
      */
     setStrokeColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Set the stroke color of the given design block.
+     * @param id - The block whose stroke color should be set.
+     * @param color - The color to set.
+     */
+    setStrokeColor(id: DesignBlockId, color: Color): void;
     /**
      * Get the stroke color of the given design block.
-     * @param id - The block whose background color should be queried.
-     * @returns The background color.
+     * @param id - The block whose stroke color should be queried.
+     * @returns The stroke color.
+     * @deprecated Use getStrokeColor() instead.
      */
     getStrokeColorRGBA(id: DesignBlockId): RGBA;
+    /**
+     * Get the stroke color of the given design block.
+     * @param id - The block whose stroke color should be queried.
+     * @returns The stroke color.
+     */
+    getStrokeColor(id: DesignBlockId): Color;
     /**
      * Set the stroke width of the given design block.
      * @param id - The block whose stroke width should be set.
@@ -1606,14 +1622,28 @@ export declare class BlockAPI {
      * @param g - The green color component in the range of 0 to 1.
      * @param b - The blue color component in the range of 0 to 1.
      * @param a - The alpha color component in the range of 0 to 1.
+     * @deprecated Use setDropShadowColor() instead.
      */
     setDropShadowColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Set the drop shadow color of the given design block.
+     * @param id - The block whose drop shadow color should be set.
+     * @param color - The color to set.
+     */
+    setDropShadowColor(id: DesignBlockId, color: Color): void;
     /**
      * Get the  drop shadow color of the given design block.
-     * @param id - The block whose background color should be queried.
-     * @returns The background color.
+     * @param id - The block whose drop shadow color should be queried.
+     * @returns The drop shadow color.
+     * @deprecated Use getDropShadowColor() instead.
      */
     getDropShadowColorRGBA(id: DesignBlockId): RGBA;
+    /**
+     * Get the  drop shadow color of the given design block.
+     * @param id - The block whose drop shadow color should be queried.
+     * @returns The drop shadow color.
+     */
+    getDropShadowColor(id: DesignBlockId): Color;
     /**
      * Set the drop shadow's X offset of the given design block.
      * @param id - The block whose drop shadow's X offset should be set.
@@ -3026,6 +3056,18 @@ export declare class EditorAPI {
      * @throws An error, if the keypath is invalid.
      */
     getSettingString(keypath: SettingsString): string;
+    /**
+     * Set a color setting.
+     * @param keypath - The settings keypath, e.g. `highlightColor`.
+     * @param value - The The value to set.
+     */
+    setSettingColor(keypath: SettingsColor, value: Color): void;
+    /**
+     * Get a color setting.
+     * @param keypath - The settings keypath, e.g. `highlightColor`.
+     * @throws An error, if the keypath is invalid.
+     */
+    getSettingColor(keypath: SettingsColor): Color;
     /**
      * Set a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
@@ -3033,12 +3075,14 @@ export declare class EditorAPI {
      * @param g - The green color component in the range of 0 to 1.
      * @param b - The blue color component in the range of 0 to 1.
      * @param a - The alpha color component in the range of 0 to 1.
+     * @deprecated Use setSettingColor() instead.
      */
     setSettingColorRGBA(keypath: SettingsColorRGBA, r: number, g: number, b: number, a?: number): void;
     /**
      * Get a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
+     * @deprecated Use getSettingColor() instead.
      */
     getSettingColorRGBA(keypath: SettingsColorRGBA): RGBA;
     /**
@@ -3811,8 +3855,14 @@ export declare type SceneMode = 'Design' | 'Video';
 /** @public */
 export declare type SettingsBool = 'doubleClickToCropEnabled' | 'features/effectsEnabled' | 'features/hspSelectiveAdjustmentsEnabled' | 'features/layerListEnabled' | 'features/singlePageModeEnabled' | 'features/templatingEnabled' | 'page/dimOutOfPageAreas' | 'page/title/show' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'trackActivePage' | ArbitraryString;
 
-/** @public */
-export declare type SettingsColorRGBA = 'clearColor' | 'errorStateColor' | 'highlightColor' | 'page/title/color' | 'placeholderHighlightColor' | 'progressColor' | ArbitraryString;
+/** @public
+ */
+declare type SettingsColor = 'clearColor' | 'errorStateColor' | 'highlightColor' | 'page/title/color' | 'placeholderHighlightColor' | 'progressColor' | ArbitraryString;
+
+/** @public
+ * @deprecated Use SettingsColor instead.
+ */
+export declare type SettingsColorRGBA = SettingsColor;
 
 /** @public */
 export declare type SettingsEnum = {