@cesdk/engine 1.24.0 → 1.25.0-rc.0

package/index.d.ts

@@ -3065,6 +3065,18 @@ export declare class EditorAPI {
      * @returns A method to unsubscribe.
      */
     onSettingsChanged: (callback: () => void) => (() => void);
+    /**
+     * Subscribe to changes to the editor role.
+     *
+     * This lets you react to changes in the role of the user and update engine
+     * and editor settings in response.
+     *
+     * @param callback - This function will be called immediately after a role has
+     * been set and the default settings for that role have been applied. This function
+     * will also be called in case the role is set to the same value as before.
+     * @returns A function for unsubscribing
+     */
+    onRoleChanged: (callback: (role: RoleString) => void) => (() => void);
     /**
      * Set a boolean setting.
      * @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`
@@ -3166,7 +3178,7 @@ export declare class EditorAPI {
     getSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`): RGBA;
     /**
      * Set an enum setting.
-     * @param keypath - The settings keypath, e.g. `role`.
+     * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @param value - The enum value as string.
      */
     setSettingEnum<T extends keyof SettingsEnum>(keypath: T, value: SettingsEnum[T]): void;
@@ -3175,7 +3187,7 @@ export declare class EditorAPI {
 
     /**
      * Get an enum setting.
-     * @param keypath - The settings keypath, e.g. `role`.
+     * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @returns The value as string.
      */
     getSettingEnum<T extends keyof SettingsEnum>(keypath: T): SettingsEnum[T];
@@ -3184,12 +3196,20 @@ export declare class EditorAPI {
 
     /**
      * Get the possible enum options for a given enum setting.
-     * @param keypath - The settings keypath, e.g. `role`.
+     * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @returns The possible enum options as strings.
      */
     getSettingEnumOptions<T extends keyof SettingsEnum>(keypath: T): string[];
     /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
     getSettingEnumOptions<T extends keyof SettingsEnum>(keypath: `ubq://${T}`): string[];
+    /**
+     * Set the role of the user and apply role-dependent defaults for scopes and settings
+     */
+    setRole(role: RoleString): void;
+    /**
+     * Get the current role of the user
+     */
+    getRole(): RoleString;
     /**
      * Returns a list of all the settings available.
      * @returns A list of settings keypaths.
@@ -3197,7 +3217,7 @@ export declare class EditorAPI {
     findAllSettings(): string[];
     /**
      * Returns the type of a setting.
-     * @param keypath - The settings keypath, e.g. `role`.
+     * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @returns The setting type.
      */
     getSettingType(keypath: string): SettingType;
@@ -4074,7 +4094,6 @@ export declare type SettingsColorRGBA = SettingsColor;
 
 /** @public */
 export declare type SettingsEnum = {
-    role: RoleString;
     doubleClickSelectionMode: 'Direct' | 'Hierarchical';
     'touch/pinchAction': 'None' | 'Zoom' | 'Scale';
     'touch/rotateAction': 'None' | 'Rotate';