Settings

All keys listed below can be modified through the Editor API. The nested settings inside UBQSettings can be reached via key paths, e.g. page/title/show.

Settings

BlockAnimationSettings

CameraClampingSettings

CameraSettings

ControlGizmoSettings

DebugFlags

Flags that control debug outputs.

MouseSettings

PageSettings

PageTitleSettings

PlaceholderControlsSettings

Settings

TouchSettings

engine.editor.findAllSettings()
try engine.editor.getSettingType("doubleClickSelectionMode")


let settingsTask = Task {
  for await _ in engine.editor.onSettingsChanged {
    print("Editor settings have changed")
  }
}

let roleTask = Task {
  for await role in engine.editor.onRoleChanged {
    print("Role changed to \(role)")
  }
}

try engine.editor.setSettingBool("doubleClickToCropEnabled", value: true)
try engine.editor.getSettingBool("doubleClickToCropEnabled")
try engine.editor.setSettingInt("integerSetting", value: 0)
try engine.editor.getSettingInt("integerSetting")
try engine.editor.setSettingFloat("positionSnappingThreshold", value: 2.0)
try engine.editor.getSettingFloat("positionSnappingThreshold")
try engine.editor.setSettingString("license", value: "invalid")
try engine.editor.getSettingString("license")
try engine.editor.setSettingColor("highlightColor", color: .rgba(r: 1, g: 0, b: 1, a: 1)) // Pink
try engine.editor.getSettingColor("highlightColor") as Color
try engine.editor.setSettingEnum("doubleClickSelectionMode", value: "Direct")
try engine.editor.getSettingEnum("doubleClickSelectionMode")
try engine.editor.getSettingEnumOptions("doubleClickSelectionMode")
try engine.editor.getRole()
try engine.editor.setRole("Adopter")

Change Settings

In this example, we will show you how to use the CreativeEditor SDK’s CreativeEngine to control with the editor API. A list of all available settings can be found above.

Exploration

public func findAllSettings() -> [String]

Get a list of all available settings.

• Returns: A list of all available settings.

public func getSettingType(_ keypath: String) throws -> PropertyType

Get the type of a setting.

• keypath:: The settings keypath, e.g. doubleClickSelectionMode.
• Returns: The type of the setting.

Functions

public var onSettingsChanged: AsyncStream<Void> { get }

Subscribe to changes to the editor settings.

public var onRoleChanged: AsyncStream<String> { get }

Subscribe to changes to the editor role.

public func setSettingBool(_ keypath: String, value: Bool) throws

Set a boolean setting.

• keypath: The settings keypath, e.g. doubleClickToCropEnabled.
• value: The value to set.

public func getSettingBool(_ keypath: String) throws -> Bool

Get a boolean setting.

• keypath:: The settings keypath, e.g. doubleClickToCropEnabled.
• Returns: The current value.

public func setSettingInt(_ keypath: String, value: Int) throws

Set an integer setting.

• keypath: The settings keypath.
• value: The value to set.

public func getSettingInt(_ keypath: String) throws -> Int

Get an integer setting.

• keypath:: The settings keypath.
• Returns: The current value.

public func setSettingFloat(_ keypath: String, value: Float) throws

Set a float setting.

• keypath: The settings keypath, e.g. positionSnappingThreshold.
• value: The value to set.

public func getSettingFloat(_ keypath: String) throws -> Float

Get a float setting.

• keypath:: The settings keypath, e.g. positionSnappingThreshold.
• Returns: The current value.

public func setSettingString(_ keypath: String, value: String) throws

Set a string setting.

• keypath: The settings keypath, e.g. license.
• value: The value to set.

public func getSettingString(_ keypath: String) throws -> String

Get a string setting.

• keypath:: The settings keypath, e.g. license.
• Returns: The current value.

public func setSettingColor(_ keypath: String, color: Color) throws

Set a color setting.

• keypath: The settings keypath, e.g. highlightColor.
• color: The value to set.

public func getSettingColor(_ keypath: String) throws -> Color

Get a color setting.

• keypath:: The settings keypath, e.g. highlightColor.
• Returns: An error, if the keypath is invalid.

public func setSettingEnum(_ keypath: String, value: String) throws

Set an enum setting.

• keypath: The settings keypath, e.g. doubleClickSelectionMode.
• value: The enum value as string.

public func getSettingEnum(_ keypath: String) throws -> String

Get an enum setting.

• keypath:: The settings keypath, e.g. doubleClickSelectionMode.
• Returns: The value as string.

public func getSettingEnumOptions(_ keypath: String) throws -> [String]

Get the available options for an enum setting.

• keypath:: The settings keypath, e.g. doubleClickSelectionMode.
• Returns: The available options as string array.

public func setSettingFloat(_ keypath: String, value: Float) throws

Set a float setting.

• keypath: The settings keypath, e.g. positionSnappingThreshold.
• value: The value to set.

public func getSettingFloat(_ keypath: String) throws -> Float

Get a float setting.

• keypath:: The settings keypath, e.g. positionSnappingThreshold.
• Returns: The current value.

public func setSettingString(_ keypath: String, value: String) throws

Set a string setting.

• keypath: The settings keypath, e.g. license.
• value: The value to set.

public func getSettingString(_ keypath: String) throws -> String

Get a string setting.

• keypath:: The settings keypath, e.g. license.
• Returns: The current value.

public func getRole() throws -> String

Get the current role of the user.

• Returns: The current role of the user.

public func setRole(_ role: String) throws

Set the role of the user and apply role-dependent defaults for scopes and settings.

• role:: The role of the user.