RSX Code Reference
    Preparing search index...

    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.

    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.

    Index
    • get autoLoadLastProject(): boolean

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

      Returns boolean

    • set autoLoadLastProject(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get closeApplicationOnCloseMacOSMainWindow(): boolean

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

      Returns boolean

    • set closeApplicationOnCloseMacOSMainWindow(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get encryptedPassword(): string

      Gets the user encrypted password.

      Returns string

    • set encryptedPassword(value: string): void

      Parameters

      • value: string

      Returns void

    • get encryptedUsername(): string

      Gets the user encrypted username.

      Returns string

    • set encryptedUsername(value: string): void

      Parameters

      • value: string

      Returns void

    • get hash(): number

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

      Returns number

    • 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: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get lastOpenProject(): FilePath

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

      Returns FilePath

    • set lastOpenProject(value: FilePath): void

      Parameters

      Returns void

    • get lastOpenProjectName(): string

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

      Returns string

    • set lastOpenProjectName(value: string): void

      Parameters

      • value: string

      Returns void

    • 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

    • set loggedInUserInformation(value: LoggedInUserInformation): void

      Parameters

      Returns void

    • 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: string): void

      Parameters

      • value: string

      Returns void

    • Deletes all key/value pairs.

      Returns void

    • Deletes a key with the specified name.

      Parameters

      • name: string

      Returns void

    • 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

    • 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

    • 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

    • 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

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

      Parameters

      • name: string

      Returns boolean

    • Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

      Parameters

      • action: () => void

        The scope where the object is modified.

      Returns void

    • Saves editor settings to the disk.

      Returns void

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

      Parameters

      • name: string
      • value: boolean

      Returns void

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

      Parameters

      • name: string
      • value: number

      Returns void

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

      Parameters

      • name: string
      • value: number

      Returns void

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

      Parameters

      Returns void

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

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

      Parameters

      • name: string
      • value: string

      Returns void

    onDirty: Event<[dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>]>

    Event that is triggered when a member changes.