Class UserProjectSettingsBase<T>`Abstract`

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

Type Parameters

T extends UserProjectSettingsBase<T>

Hierarchy (View Summary)

UserProjectSettingsBase

Index

Constructors

Accessors

Methods

assign markAsDirty

Events

Constructors

constructor

new UserProjectSettingsBase<T extends UserProjectSettingsBase<T>>(): UserProjectSettingsBase<
T,
>
Type Parameters
- T extends UserProjectSettingsBase<T>
Returns UserProjectSettingsBase<T>

Accessors

`Abstract`isGlobal

get isGlobal(): boolean

Determines if the settings instance is the global settings that require saving to the UserProjectSettings.

Returns boolean

Methods

assign

assign(other: Readonly<T>): void
Copies all properties defined by the prototype of other to this instance.
Parameters
- other: Readonly<T>
Returns void

markAsDirty

markAsDirty(): void

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

Returns void

Note
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

`Readonly`onDirty

onDirty: Event<[T], void>

Invoked when the settings changed.

Warning

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