Class UserProjectSettings

The UserProjectSettings managed per-user project settings. The settings are cloud synchronized and potentially accessible by other users. Sensitive data should not be stored unencrypted in the settings.

Note

To create custom, cloud-persisted and user settings. Use APIs such as UserProjectSettings.setString and UserProjectSettings.setObject. Once the setting has changed, invoke UserProjectSettings.save.

Constructors

constructor

Properties

editor settingsCreatedDuringLoad

Methods

deleteAllKeys deleteKey hasKey getBigInt getBoolean getNumber getObject getString loadUserResource markDirtyForAutoSave onSettingsResourceEnable resetToDefaults save searchUserResource setBigInt setBoolean setNumber setObject setString

Events

onLoaded onUnload onSaved onEditorUserModeChanged onSettingsChanged

Constructors

constructor

Properties

Staticeditor

editor: UserProjectDataResource

The built-in editor specific user settings.

Note

To create custom, cloud-persisted and shared project settings. Use APIs such as UserProjectSettings.setString and UserProjectSettings.setObject. Once the setting was changed, invoke UserProjectSettings.save to persist the changes. The settings are cloud synchronized, make sure to minimize changes to avoid conflicts for other users.

StaticsettingsCreatedDuringLoad

settingsCreatedDuringLoad

An unsynchronized field that is used as a marker to determine if the settings were created during sync.

Methods

deleteAllKeys

  • deleteAllKeys(): void

  • Deletes all key/value pairs.

    Returns void

deleteKey

  • deleteKey(name): void

  • Deletes a key with the specified name.

    Parameters

    • name: string

    Returns void

hasKey

  • hasKey(name): boolean

  • Returns true if the key with the specified name exists.

    Parameters

    • name: string

    Returns boolean

StaticgetBigInt

  • getBigInt(key, defaultValue): bigint

  • Gets the BigInt value of the specified key, or the defaultValue if the key cannot be found.

    Parameters

    • key: string
    • defaultValue: bigint

    Returns bigint

StaticgetBoolean

  • getBoolean(key, defaultValue): boolean

  • Gets the boolean value of the specified key, or the defaultValue if the key cannot be found.

    Parameters

    • key: string
    • defaultValue: boolean

    Returns boolean

StaticgetNumber

  • getNumber(key, defaultValue): number

  • Gets the number value of the specified key, or the defaultValue if the key cannot be found.

    Parameters

    • key: string
    • defaultValue: number

    Returns number

StaticgetObject

  • getObject<T>(type, name, defaultValue?): T

  • Gets the object value of the specified key, or the defaultValue if the key cannot be found. If no defaultValue is specified, a default constructed instance will be returned.

    Type Parameters

    • T

    Parameters

    • type: ClassOf<T>

      The type of the object.

    • name: string

      Name of the property to retrieve.

    • OptionaldefaultValue: T

      The optional default value.

    Returns T

    Value of the property if it exists and matches the type, the defaultValue or a default constructed instance.

StaticgetString

  • getString(key, defaultValue): string

  • Gets the string value of the specified key, or the defaultValue if the key cannot be found.

    Parameters

    • key: string
    • defaultValue: string

    Returns string

StaticloadUserResource

  • loadUserResource(userResourceEntry): void

  • Loads the specified user resource.

    Parameters

    Returns void

StaticmarkDirtyForAutoSave

  • markDirtyForAutoSave(justification): void

  • Marks the settings dirty and will enable auto saving. The resource will automatically save after one second, if further changes occur the resource save will be delayed by another second.

    Parameters

    • justification: string

    Returns void

StaticonSettingsResourceEnable

  • onSettingsResourceEnable(): void

  • Returns void

StaticresetToDefaults

  • resetToDefaults(): void

  • Resets all settings to defaults.

    Returns void

Staticsave

  • save(asynchronous): void

  • Saves the project settings to disk.

    Parameters

    • asynchronous: boolean

    Returns void

    Note

    Prefer markDirtyForAutoSave to allow multiple changes to occur before saving to avoid frequent saves and version changes.

StaticsearchUserResource

StaticsetBigInt

  • setBigInt(key, value): void

  • Sets the BigInt value for the specified key.

    Parameters

    • key: string
    • value: bigint

    Returns void

StaticsetBoolean

  • setBoolean(key, value): void

  • Sets the boolean value for the specified key.

    Parameters

    • key: string
    • value: boolean

    Returns void

StaticsetNumber

  • setNumber(key, value): void

  • Sets the number value for the specified key.

    Parameters

    • key: string
    • value: number

    Returns void

StaticsetObject

  • setObject<T>(name, value): void

  • Sets the object value for the specified key.

    Type Parameters

    • T extends Object

    Parameters

    • name: string
    • value: T

    Returns void

    Note

    Any object marked with serializedObject decorator can be provided, excluding built-in types such as Component and Resource.

StaticsetString

  • setString(key, value): void

  • Sets the string value for the specified key.

    Parameters

    • key: string
    • value: string

    Returns void

Events

Static ReadonlyonLoaded

onLoaded: Event<[], void>

Invoked when the settings have been loaded.

Static ReadonlyonUnload

onUnload: Event<[], void>

Invoked when the settings are being unloaded.

Static ReadonlyonSaved

onSaved: Event<[], void>

Invoked when the settings have been saved.

Static ReadonlyonEditorUserModeChanged

onEditorUserModeChanged: Event<[EnumValue<EditorUserMode, number>], void>

Invoked when the editorUserMode property changed.

Static ReadonlyonSettingsChanged

onSettingsChanged: Event<[ClassOf<EditorSettingsType>, EditorSettingsType], void>

Invoked when settings changed.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
Events