RSX Code Reference
    Preparing search index...

    Class UserProjectDataResource

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

    Hierarchy (View Summary)

    Index
    constructor
    activeCodeEditor activeCoordinateMode activePivotMode activeSceneTool agentSettings automaticallyLockMouseOnPlay automaticCodeCompilationMode clearOutputLogOnPlay colorPalette completedTutorials componentPickerSettings curveEditorSnapSettings customSettings highDPIRenderingInEditorViewport highDPIRenderingInGameViewport imageViewerDisplaySettings inactiveGizmoClasses inputPrecision interactiveGizmoSize isChildObjectTransformsLocked isGraphCommentsLocked isViewsphereEnabled keyWindowLayoutProfile lastOpenSceneUUID libraryBrowserPersistedState llmProviderRegistry logVerbosityFilter maximumFramesPerSecond mouseSensitivity overlayVisibilityState raiseMainCameraWindowOnPlay resourceBrowserSettings resourceTypePickerSettings sceneGridSettings sceneWindowSettings shortcutProfiles snappingSettings statPlotFramesPerSecond viewportCameraSettings viewportNavigation
    handle isDestroyed metaData name userMode uuid
    duplicate onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart resetToDefaults revert unload
    activeCodeEditor: EnumValue<CodeEditorType>

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

    activeCoordinateMode: EnumValueTyped<GizmoCoordinateMode>

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

    activePivotMode: EnumValueTyped<GizmoPivotMode>

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

    activeSceneTool: EnumValueTyped<TransformGizmoMode>

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

    agentSettings: AgentSettings

    Settings and persisted sessions for the LLM agent.

    automaticallyLockMouseOnPlay: boolean

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

    automaticCodeCompilationMode: EnumValue<AutomaticCodeCompilationMode>

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

    clearOutputLogOnPlay: boolean

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

    colorPalette: ColorPalette

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

    completedTutorials: Set<string>

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

    componentPickerSettings: ComponentPickerSettings

    The component picker settings.

    curveEditorSnapSettings: UICurveEditorSnapSettings

    Curve editor settings.

    customSettings: Settings

    The user-defined settings.

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

    highDPIRenderingInEditorViewport: boolean
    highDPIRenderingInGameViewport: boolean
    imageViewerDisplaySettings: ImageViewerDisplaySettings

    The image viewer settings.

    inactiveGizmoClasses: Set<string>

    Contains the name of all inactive gizmo classes.

    inputPrecision: number

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

    interactiveGizmoSize: number

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

    isChildObjectTransformsLocked: boolean

    If true, child objects will keep their world space transforms when the parent transform is edited.

    isGraphCommentsLocked: boolean

    If true, comments in graph editors are locked.

    isViewsphereEnabled: boolean
    keyWindowLayoutProfile: KeyWindowLayoutProfile

    A map of all user-defined key window layouts.

    lastOpenSceneUUID: UUID

    The last open scene.

    libraryBrowserPersistedState: LibraryBrowserPersistedState

    The persisted state of the libraryBrowser.

    llmProviderRegistry: LLMProviderRegistry

    Provider profiles available to the LLM agent.

    logVerbosityFilter: EnumValueTyped<LogWindowVerbosityFilter>

    Log verbosity filter for the output log window.

    maximumFramesPerSecond: number

    The maximum frames per second of the editor.

    mouseSensitivity: number

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

    overlayVisibilityState: Map<string, StatOverlayVisibilityState>

    The visibility state of all current overlays.

    raiseMainCameraWindowOnPlay: boolean

    Determines if the game window should be raised on play.

    resourceBrowserSettings: UILibraryBrowserDisplaySettings

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

    resourceTypePickerSettings: ResourceTypePickerSettings

    The resource type picker settings.

    sceneGridSettings: SceneGridSettings

    The scene grid settings.

    sceneWindowSettings: SceneWindowSettings

    Settings for the SceneWindow.

    shortcutProfiles: ShortcutProfile[]

    The currently assigned shortcut profile.

    snappingSettings: SnappingSettings

    The current snapping settings.

    statPlotFramesPerSecond: number

    The engine stat plot update rate in frames per second.

    viewportCameraSettings: ViewportCameraSettings

    Settings used for ViewportCamera when used with a UIViewportRenderer.

    viewportNavigation: ViewportCameraNavigationSettings

    Settings that control viewport camera navigation.

    • get isDestroyed(): boolean

      Determines if the resource is destroyed.

      Returns boolean

      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.

    • get name(): string

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

      Returns string

    • get uuid(): UUID

      Returns a universally unique identifier of this resource.

      Returns UUID

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

      Returns Resource

      The duplicated resource or null, if the duplication failed.

    • Virtual

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

      Returns void

    • Virtual

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

      Returns void

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

    • Virtual

      Method called by RSX to disable the resource.

      Returns void

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

    • Virtual

      Method called by RSX to enable the resource.

      Returns void

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

    • Virtual

      Method called by RSX to perform any operations before serialization.

      Returns void

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

    • Resets all settings to their defaults.

      Returns void

    • Reverts the resource to the on-disk representation.

      Returns boolean

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

    • Forcefully unloads the resource.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    activeCodeEditoractiveCoordinateModeactivePivotModeactiveSceneToolagentSettingsautomaticallyLockMouseOnPlayautomaticCodeCompilationModeclearOutputLogOnPlaycolorPalettecompletedTutorialscomponentPickerSettingscurveEditorSnapSettingscustomSettingshighDPIRenderingInEditorViewporthighDPIRenderingInGameViewportimageViewerDisplaySettingsinactiveGizmoClassesinputPrecisioninteractiveGizmoSizeisChildObjectTransformsLockedisGraphCommentsLockedisViewsphereEnabledkeyWindowLayoutProfilelastOpenSceneUUIDlibraryBrowserPersistedStatellmProviderRegistrylogVerbosityFiltermaximumFramesPerSecondmouseSensitivityoverlayVisibilityStateraiseMainCameraWindowOnPlayresourceBrowserSettingsresourceTypePickerSettingssceneGridSettingssceneWindowSettingsshortcutProfilessnappingSettingsstatPlotFramesPerSecondviewportCameraSettingsviewportNavigation
    Accessors
    Methods