Class LocalOnlyEditorSettings

The LocalOnlyEditorSettings class contains settings that are applied globally to the editor and saved locally. The settings are not uploaded to the cloud or synchronized with other users. Because the settings are saved, they will persist through editor sessions.

Note

This class is ideal to store settings that are frequently changed but not important enough to be cloud synchronized such as the state of a window, the size of a UI element or a configured filter that is disposed frequently. Another reason to prefer LocalOnlyEditorSettings is to persist settings that are shared among projects or contain sensitive data.

Constructors

constructor

Accessors

autoLoadLastProject closeApplicationOnCloseMacOSMainWindow cloudUserInformation encryptedPassword encryptedUsername hash isOpeningHomeWindowAtStartup lastOpenProject lastOpenProjectName loggedInUserInformation preferedTeam recentProjects userToken

Methods

deleteAllKeys deleteKey getBool getFloat getInt getPersistedMessgeBoxChoice getString hasKey save setBool setFloat setInt setPersistedMessageBoxChoice setString

Constructors

constructor

Accessors

StaticautoLoadLastProject

  • get autoLoadLastProject(): boolean

  • Sets whether the last open project should be automatically loaded on editor start up.

    Returns boolean

  • set autoLoadLastProject(value): void

  • Parameters

    • value: boolean

    Returns void

StaticcloseApplicationOnCloseMacOSMainWindow

  • get closeApplicationOnCloseMacOSMainWindow(): boolean

  • Set the setting controling the behaviour on closing the main window on macOS.

    Returns boolean

  • set closeApplicationOnCloseMacOSMainWindow(value): void

  • Parameters

    • value: boolean

    Returns void

StaticcloudUserInformation

  • set cloudUserInformation(value): void

  • Gets the authenticated user information. Note that this information may no longer be valid and a refresh should be performed

    Parameters

    Returns void

StaticencryptedPassword

  • get encryptedPassword(): string

  • Gets the user encrypted password.

    Returns string

  • set encryptedPassword(value): void

  • Parameters

    • value: string

    Returns void

StaticencryptedUsername

  • get encryptedUsername(): string

  • Gets the user encrypted username.

    Returns string

  • set encryptedUsername(value): void

  • Parameters

    • value: string

    Returns void

Statichash

  • get hash(): number

  • Returns a hash value that may be used for checking if any internal settings were modified.

    Returns number

StaticisOpeningHomeWindowAtStartup

  • get isOpeningHomeWindowAtStartup(): boolean

  • Gets whether the Home Window is shown at the start of the Editor (if User is logged in already) before any other Scene Window.

    Returns boolean

  • set isOpeningHomeWindowAtStartup(value): void

  • Parameters

    • value: boolean

    Returns void

StaticlastOpenProject

  • get lastOpenProject(): FilePath

  • Sets the path to the last project open in the editor.

    Returns FilePath

  • set lastOpenProject(value): void

  • Parameters

    Returns void

StaticlastOpenProjectName

  • get lastOpenProjectName(): string

  • Sets the path to the last project open in the editor.

    Returns string

  • set lastOpenProjectName(value): void

  • Parameters

    • value: string

    Returns void

StaticloggedInUserInformation

  • get loggedInUserInformation(): LoggedInUserInformation

  • Gets the authenticated user information. Note that this information may no longer be valid and a refresh should be performed

    Returns LoggedInUserInformation

StaticpreferedTeam

StaticrecentProjects

StaticuserToken

  • get userToken(): string

  • Gets the authenticated user JWT token. Note that this token may no longer be valid and a refresh should be performed. Prefer fetching this value from LoginManager directly instead.

    Returns string

  • set userToken(value): void

  • Parameters

    • value: string

    Returns void

Methods

StaticdeleteAllKeys

  • deleteAllKeys(): void

  • Deletes all key/value pairs.

    Returns void

StaticdeleteKey

  • deleteKey(name): void

  • Deletes a key with the specified name.

    Parameters

    • name: string

    Returns void

StaticgetBool

  • getBool(name, defaultValue?): boolean

  • Returns the boolean point value of the specified key, or the default value if such key cannot be found.

    Parameters

    • name: string
    • OptionaldefaultValue: boolean

    Returns boolean

StaticgetFloat

  • getFloat(name, defaultValue?): number

  • Returns the floating point value of the specified key, or the default value if such key cannot be found.

    Parameters

    • name: string
    • OptionaldefaultValue: number

    Returns number

StaticgetInt

  • getInt(name, defaultValue?): number

  • Returns the integer point value of the specified key, or the default value if such key cannot be found.

    Parameters

    • name: string
    • OptionaldefaultValue: number

    Returns number

StaticgetPersistedMessgeBoxChoice

  • getPersistedMessgeBoxChoice(boxOrTitle): EnumValue<DialogBoxResultType, number>

  • Retrieves a previous choice for a messageBox made by the user.

    Parameters

    Returns EnumValue<DialogBoxResultType, number>

    The dialog result that was chosen by the user or undefined if no choice is persisted.

    Note

    The choice is persisted using the initialTitle as key and the userChoice as value.

StaticgetString

  • getString(name, defaultValue?): string

  • Returns the string point value of the specified key, or the default value if such key cannot be found.

    Parameters

    • name: string
    • OptionaldefaultValue: string

    Returns string

StatichasKey

  • hasKey(name): boolean

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

    Parameters

    • name: string

    Returns boolean

Staticsave

  • save(): void

  • Saves editor settings to the disk.

    Returns void

StaticsetBool

  • setBool(name, value): void

  • Adds or updates a property key/value pair with a boolean value.

    Parameters

    • name: string
    • value: boolean

    Returns void

StaticsetFloat

  • setFloat(name, value): void

  • Adds or updates a property key/value pair with a floating point value.

    Parameters

    • name: string
    • value: number

    Returns void

StaticsetInt

  • setInt(name, value): void

  • Adds or updates a property key/value pair with a signed integer value.

    Parameters

    • name: string
    • value: number

    Returns void

StaticsetPersistedMessageBoxChoice

  • setPersistedMessageBoxChoice(messageBox, userChoice): void

  • Persist a previous choice for a messageBox made by the user.

    Parameters

    Returns void

    Note

    The choice is persisted using the initialTitle as key and the userChoice as value.

StaticsetString

  • setString(name, value): void

  • Adds or updates a property key/value pair with a string value.

    Parameters

    • name: string
    • value: string

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods