Class UserProjectDataResource

The UserProjectDataResource resource stores user-specific settings and data. The resource is unique per-user project.

Hierarchy (view full)

Constructors

constructor

Properties

activeCodeEditor activeCoordinateMode activePivotMode activeSceneTool automaticallyLockMouseOnPlay automaticCodeCompilation clearOutputLogOnPlay colorPalette completedTutorials componentPickerSettings curveEditorSnapSettings customSettings highDPIRenderingInEditorViewport highDPIRenderingInGameViewport imageViewerDisplaySettings inactiveGizmoClasses inputPrecision interactiveGizmoSize isViewsphereEnabled keyWindowLayoutProfile lastOpenSceneUUID libraryBrowserPersistedState maximumFramesPerSecond mouseSensitivity overlayVisibilityState raiseMainCameraWindowOnPlay resourceBrowserSettings resourceTypePickerSettings sceneGridSettings sceneWindowSettings shortcutProfiles snappingSettings statPlotFramesPerSecond viewportCameraSettings viewportNavigation

Accessors

handle isDestroyed metaData name userMode uuid

Methods

duplicate onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart resetToDefaults revert unload

Constructors

constructor

Properties

activeCodeEditor

activeCodeEditor: EnumValue<CodeEditorType, number>

The active editor used when double-clicking a code resource.

activeCoordinateMode

activeCoordinateMode: EnumValueTyped<GizmoCoordinateMode, number>

Changes the currently active coordinate mode for scene view (for example global/local).

activePivotMode

activePivotMode: EnumValueTyped<GizmoPivotMode, number>

Changes the currently active pivot mode for scene view (for example pivot/center).

activeSceneTool

activeSceneTool: EnumValueTyped<TransformGizmoMode, number>

Changes the currently active scene view tool (for example move, rotate, etc.).

automaticallyLockMouseOnPlay

automaticallyLockMouseOnPlay: boolean

Determines if the mouse should be locked to the main window on play.

automaticCodeCompilation

automaticCodeCompilation: boolean

Automatically recompiles code in 'Developer' mode when changed are detected.

clearOutputLogOnPlay

clearOutputLogOnPlay: boolean

Determines if the console be cleared when the play mode is entered.

colorPalette

colorPalette: ColorPalette

The project-wide user-defined color palette of the UIColorPicker.

ReadonlycompletedTutorials

completedTutorials: Set<string>

The completed tutorials. Contains the name of all Keywindow classes that were started.

ReadonlycomponentPickerSettings

componentPickerSettings: ComponentPickerSettings

The component picker settings.

ReadonlycurveEditorSnapSettings

curveEditorSnapSettings: UICurveEditorSnapSettings

Curve editor settings.

ReadonlycustomSettings

customSettings: Settings

The user-defined settings.

Note

To get or set user-defined settings use APIs such as UserProjectSettings.getString and UserProjectSettings.setObject.

highDPIRenderingInEditorViewport

highDPIRenderingInEditorViewport: boolean

highDPIRenderingInGameViewport

highDPIRenderingInGameViewport: boolean

ReadonlyimageViewerDisplaySettings

imageViewerDisplaySettings: ImageViewerDisplaySettings

The image viewer settings.

ReadonlyinactiveGizmoClasses

inactiveGizmoClasses: Set<string>

Contains the name of all inactive gizmo classes.

inputPrecision

inputPrecision: number

Sets the default number of digits after decimal point to display in input fields.

interactiveGizmoSize

interactiveGizmoSize: number

Sets the default size of all the interactive gizmos used to modify a scene object's transform.

isViewsphereEnabled

isViewsphereEnabled: boolean

keyWindowLayoutProfile

keyWindowLayoutProfile: KeyWindowLayoutProfile

A map of all user-defined key window layouts.

lastOpenSceneUUID

lastOpenSceneUUID: UUID

The last open scene.

libraryBrowserPersistedState

libraryBrowserPersistedState: LibraryBrowserPersistedState

The persisted state of the libraryBrowser.

maximumFramesPerSecond

maximumFramesPerSecond: number

The maximum frames per second of the editor.

mouseSensitivity

mouseSensitivity: number

Sets a value that controls sensitivity of mouse movements. This doesn't apply to mouse cursor. Default value is 1.

overlayVisibilityState

overlayVisibilityState: Map<string, StatOverlayVisibilityState>

The visibility state of all current overlays.

raiseMainCameraWindowOnPlay

raiseMainCameraWindowOnPlay: boolean

Determines if the game window should be raised on play.

ReadonlyresourceBrowserSettings

resourceBrowserSettings: UILibraryBrowserDisplaySettings

Settings for the ResourceBrowserWindowBase that provides a window to load/save resources.

ReadonlyresourceTypePickerSettings

resourceTypePickerSettings: ResourceTypePickerSettings

The resource type picker settings.

ReadonlysceneGridSettings

sceneGridSettings: SceneGridSettings

The scene grid settings.

ReadonlysceneWindowSettings

sceneWindowSettings: SceneWindowSettings

Settings for the SceneWindow.

ReadonlyshortcutProfiles

shortcutProfiles: ShortcutProfile[]

The currently assigned shortcut profile.

ReadonlysnappingSettings

snappingSettings: SnappingSettings

The current snapping settings.

statPlotFramesPerSecond

statPlotFramesPerSecond: number

The engine stat plot update rate in frames per second.

ReadonlyviewportCameraSettings

viewportCameraSettings: ViewportCameraSettings

Settings used for ViewportCamera when used with a UIViewportRenderer.

viewportNavigation

viewportNavigation: ViewportCameraNavigationSettings

Settings that control viewport camera navigation.

Accessors

handle

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

metaData

name

  • get name(): string

  • Name of the resource. Use primarily for easier identification and not important to the engine itself.

    Returns string

userMode

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

duplicate

  • duplicate(): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Returns Resource

    The duplicated resource or null, if the duplication failed.

onCreate

  • onCreate(): void
  • Virtual

    Method called by RSX to perform actions required after the creation of the resource.

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

    Method called by RSX to perform any operations needed after deserialization.

    Returns void

    Note

    Use this API to restore your serializable data into live objects.

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

    Use this API to deactivate the resource before it is serialized.

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

    Use this API to activate the resource after it has been disabled by serialization.

onInitialize

  • onInitialize(this): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Parameters

    Returns void

    Note

    Use this API to initialize data and default construct all fields.

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

    Use this API to bake your live data into serializable data.

resetToDefaults

  • resetToDefaults(): void

  • Resets all settings to their defaults.

    Returns void

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

    This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

unload

  • unload(): void

  • Forcefully unloads the resource.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods