Class UserProjectSettingsBase<T>Abstract

The UserProjectSettingsBase provides a common infrastructure for settings stored in the UserProjectDataResource.

Type Parameters

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Events

Constructors

Accessors

  • get isGlobal(): boolean
  • Determines if the settings instance is the global settings that require saving to the UserProjectSettings.

    Returns boolean

Methods

  • Copies all properties defined by the prototype of other to this instance.

    Parameters

    • other: Readonly<T>

    Returns void

  • Marks the settings as dirty and invokes the onDirty event handler.

    Returns void

    This method should be invoked after making a change, so subsystems such as a viewport cna be updated. If the settings are the shared editor settings, the editor settings will be marked for autosave.

Events

onDirty: Event<[T], void>

Invoked when the settings changed.

This is an internal event. Do not subscribe directly to it, use UserProjectSettings.onSettingsChanged.