Class EditorApplication

The EditorApplication is the main system that manages the lifetime of the RSX Editor. It manages global settings and state for the editor and related sub-systems.

Constructors

constructor

Properties

onApplicationError onEncryptedUserCredentialsChanged onImportFileConsumed onKeyWindowCloudSyncButtonClicked onKeyWindowDiscussionButtonClicked onKeyWindowNotificationButtonClicked onProjectLibraryEntryModified onProjectLibraryEntryMovedOrRenamed onProjectLibraryImportFailed onProjectLoad onProjectUnload onTooltipHide onUserTokenChanged altModifierButton browserImportFilePrefixPath consoleCommands controlModifierButton rendererViewForwardPositiveZ reports shiftModifierButton

Accessors

applicationCache buildDataPath cloudProject dataPath editorBuildStamp editorModuleName editorVersion engineModuleName frameworkBuildStamp frameworkVersion isFocused isProfilingEnabled isStagingEnvironment maximumFramesPerSecond projectCache projectName projectPath projectUUID scriptEditorModuleName scriptGameModuleName shortcutPlatform userDataPath version

Methods

onEditorUpdate createNewScene executeOnMainThreadWithDelay getCheckedOutCloudProjects getGPUMemoryUsage handleStartupCommandlineArguments isContainedInInitialCatalog onAboutTriggered onCalculateGPUMemoryUsageTriggered onCloseWindowTriggered onIDEMessagePortConnected onNewSceneTriggered onOpenAccountSettingsTriggered onOpenRSXWebsiteTriggered onOpenSceneTriggered onPrecompileShadersTriggered onQuitTriggered onSaveProjectTriggered onSignOutTriggered onSubmitPendingCrashReports onTestCustomSaveOptions onTestMessageBoxTriggered onToggleProfilingTriggered onUpdateProjectSceneHeadsTriggered openURL quit registerConsoleCommands registerInputConfiguration reloadAssemblies restart restoreKeyWindowLayout runUnitTests saveScene submitPendingCrashReports

Events

onSceneViewportRedrawRequested onProfilingStateChangeEditor onDomainReloadRequested onDomainReloadBlocked onKeyWindowDockManagerLayoutChanged

Constructors

constructor

Properties

ProtectedonApplicationError

onApplicationError: ((logEntry: Immutable<LogEntry>, repeatCount?: number) => void)

Invoked when an application error occured.

ProtectedonEncryptedUserCredentialsChanged

onEncryptedUserCredentialsChanged: ((encryptedUsername: string, encryptedPassword: string) => void)

Invoked when the encrypted user credentials changed.

Type declaration

    • (encryptedUsername, encryptedPassword): void

    • Parameters

      • encryptedUsername: string

        The encrytped username.

      • encryptedPassword: string

        The encrytped password.

      Returns void

onImportFileConsumed

onImportFileConsumed: ((path: FilePath) => void)

Called whenever an import finishes and the imported file is no longer needed.

ProtectedonKeyWindowCloudSyncButtonClicked

onKeyWindowCloudSyncButtonClicked: ((cloudButton: UIButton) => void)

Invoked when the user clicks on the cloud Sync button, part of the key window container header.

ProtectedonKeyWindowDiscussionButtonClicked

onKeyWindowDiscussionButtonClicked: ((discussionButton: UIButton) => void)

Invoked when the user clicks on the project discussion button, part of the key window container header.

ProtectedonKeyWindowNotificationButtonClicked

onKeyWindowNotificationButtonClicked: ((notificationButton: UIButton) => void)

Invoked when the user clicks on the notiications button, part of the key window container header.

ProtectedonProjectLibraryEntryModified

onProjectLibraryEntryModified: ((entryPath: LibraryIdentifierPath, operationName: string, operationType: EnumValue<LibrarySubOperationType, number>) => void)

Invoked when a resource in the project library has been modified by a library operation.

Type declaration

ProtectedonProjectLibraryEntryMovedOrRenamed

onProjectLibraryEntryMovedOrRenamed: ((oldPath: string, newPath: string) => void)

Invoked when an entry in the library is moved or renamed.

Type declaration

    • (oldPath, newPath): void

    • Parameters

      • oldPath: string

        The old path of the entry, relative to the project library.

      • newPath: string

        The new path of the entry, relative to the project library.

      Returns void

ProtectedonProjectLibraryImportFailed

onProjectLibraryImportFailed: ((errors: ResourceImportError[]) => void)

Invoked when resource import operations failed.

ProtectedonProjectLoad

onProjectLoad: (() => void)

Invoked when the project has been loaded.

ProtectedonProjectUnload

onProjectUnload: (() => void)

Invoked when the project has been unloaded.

ProtectedonTooltipHide

onTooltipHide: (() => void)

ProtectedonUserTokenChanged

onUserTokenChanged: ((newToken: string) => void)

Invoked when the User Token changes.

Type declaration

    • (newToken): void

    • Parameters

      • newToken: string

        The new user token. Empty if loged out.

      Returns void

StaticaltModifierButton

altModifierButton: VirtualButton

The alt modifier button.

Static ReadonlybrowserImportFilePrefixPath

browserImportFilePrefixPath: FilePath

A constant prefix file path where imported files are temporarily placed at.

StaticconsoleCommands

consoleCommands: {
    clear: ConsoleCommand;
    ping: ConsoleCommand;
    precompileShaders: ConsoleCommand;
    unloadResources: ConsoleCommand;
    wget: ConsoleCommand;
}

An object containing ConsoleCommand objects registered by the editor.

StaticcontrolModifierButton

controlModifierButton: VirtualButton

The control modifier button.

Static ReadonlyrendererViewForwardPositiveZ

rendererViewForwardPositiveZ = false

Denotes it view-based objects such as cameras and lights consider forward the positive Z axis.

Static Readonlyreports

reports: {
    cpu: JsonObject;
    cpuMemory: MemoryUsage;
    editorCamera: JsonObject;
    gpu: JsonObject;
    gpuMemory: JsonObject;
}

Performance diagnostic reports.

Type declaration

  • cpu: JsonObject

    The aggregated CPU profiler report. Updated every frame.

  • cpuMemory: MemoryUsage

    The latest memory usage report.

  • editorCamera: JsonObject

    The editor camera specific data.

  • gpu: JsonObject

    The aggregated GPU profiler report. Updated every frame.

  • gpuMemory: JsonObject

    The latest GPU memory usage report.

StaticshiftModifierButton

shiftModifierButton: VirtualButton

The shift modifier button.

Accessors

StaticapplicationCache

  • get applicationCache(): LocalCache

  • Returns a cache that can be used for storing application-wide data.

    Returns LocalCache

StaticbuildDataPath

  • get buildDataPath(): FilePath

  • Gets the build data path

    Returns FilePath

StaticcloudProject

  • get cloudProject(): CloudProject

  • Returns the name of the currently loaded project.

    Returns CloudProject

StaticdataPath

  • get dataPath(): FilePath

  • Absolute path containing the RSX "Data" directory.

    Returns FilePath

StaticeditorBuildStamp

  • get editorBuildStamp(): string

  • Returns the editor build stamp.

    Returns string

StaticeditorModuleName

  • get editorModuleName(): string

  • Name of the builtin module containing editor specific types.

    Returns string

StaticeditorVersion

  • get editorVersion(): string

  • The engine version.

    Returns string

StaticengineModuleName

  • get engineModuleName(): string

  • Name of the builtin module containing engine specific types.

    Returns string

StaticframeworkBuildStamp

  • get frameworkBuildStamp(): string

  • Returns the framework build stamp.

    Returns string

StaticframeworkVersion

  • get frameworkVersion(): string

  • The engine version.

    Returns string

StaticisFocused

  • get isFocused(): boolean

  • Checks whether the editor currently has focus.

    Returns boolean

StaticisProfilingEnabled

  • get isProfilingEnabled(): boolean

  • Enables or disables global profiling.

    Returns boolean

  • set isProfilingEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

StaticisStagingEnvironment

  • get isStagingEnvironment(): boolean

  • Returns whether the editor is running on a staging environment.

    Returns boolean

StaticmaximumFramesPerSecond

  • get maximumFramesPerSecond(): number

  • Changes the maximum frames per second the application is allowed to run in. 0 means unlimited.

    Returns number

  • set maximumFramesPerSecond(value): void

  • Parameters

    • value: number

    Returns void

StaticprojectCache

  • get projectCache(): LocalCache

  • Returns a cache that can be used for storing project specific data. Note the concept of projects is only relevant when in the editor and a project is loaded. Otherwise this will return the same cache as GetApplicationCache().

    Returns LocalCache

StaticprojectName

  • get projectName(): string

  • Name of the currently open project.

    Returns string

StaticprojectPath

  • get projectPath(): FilePath

  • Absolute path to the folder containing the currently open project.

    Returns FilePath

StaticprojectUUID

  • get projectUUID(): UUID

  • Returns the name of the currently loaded project.

    Returns UUID

StaticscriptEditorModuleName

  • get scriptEditorModuleName(): string

  • Name of the custom module compiled from editor scripts within the project.

    Returns string

StaticscriptGameModuleName

  • get scriptGameModuleName(): string

  • Name of the custom module compiled from non-editor scripts within the project.

    Returns string

StaticshortcutPlatform

StaticuserDataPath

  • get userDataPath(): FilePath

  • Returns the path to a user data directory where we the engine can read or write persistent files.

    Returns FilePath

    Note

    When executing the runtime, the likely path is AppData on Windows or Library/Application Support on MacOS When executing the editor, the likely path is Documents/RSXEngine.

Staticversion

  • get version(): string

  • Returns the current application version.

    Returns string

Methods

onEditorUpdate

  • onEditorUpdate(): void

  • Called every frame by the runtime.

    Returns void

StaticcreateNewScene

  • createNewScene(onSuccess): void

  • Show a browse dialog to select a path to create a new scene.

    Parameters

    • onSuccess: ((scene: Scene, sceneLibraryPath: string) => void)
        • (scene, sceneLibraryPath): void

        • Parameters

          • scene: Scene
          • sceneLibraryPath: string

          Returns void

    Returns void

StaticexecuteOnMainThreadWithDelay

  • executeOnMainThreadWithDelay(delegate, delayInSeconds): void

  • Executes the given delegate on the main thread with the specified delayInSeconds.

    Parameters

    • delegate: (() => void)

      The delegate to be called from the main thread.

        • (): void

        • Returns void

    • delayInSeconds: number

      The delay in seconds.

    Returns void

StaticgetCheckedOutCloudProjects

  • getCheckedOutCloudProjects(): CloudProject[]

  • Lists all projects that the current user has checked out locally.

    Returns CloudProject[]

    Note

    If the user is not logged in, or in offline mode, this method will return no data and log a warning.

StaticgetGPUMemoryUsage

  • getGPUMemoryUsage(): JsonObject

  • Gets the latest report of GPU memory usage.

    Returns JsonObject

Protected StatichandleStartupCommandlineArguments

  • handleStartupCommandlineArguments(): boolean

  • Handles commandline arguments during startup.

    Returns boolean

StaticisContainedInInitialCatalog

  • isContainedInInitialCatalog(resourceUUID): boolean

  • Determines if the resourceUUID is contained in the inital cloud sync catalog.

    Parameters

    Returns boolean

    Note

    This API should only be used during the editor startup. Once the editor has been fully initialized it is recommended to use the corresponding APIs of the CloudLibraryWatchdog class instead.

StaticonAboutTriggered

  • onAboutTriggered(): void

  • Opens a dialog that shows about RSXEngine.

    Returns void

StaticonCalculateGPUMemoryUsageTriggered

  • onCalculateGPUMemoryUsageTriggered(): void

  • Calculates and logs the GPU memory usage.

    Returns void

StaticonCloseWindowTriggered

  • onCloseWindowTriggered(): void

  • Close the focussed window.

    Returns void

StaticonIDEMessagePortConnected

  • onIDEMessagePortConnected(port): void

  • An event fired whenever a new MessagePort connection is opened.

    Parameters

    • port: MessagePort

      The newly connected port.

    Returns void

StaticonNewSceneTriggered

  • onNewSceneTriggered(): void

  • Creates a new empty scene, shows a dialog to select the path for the new scene.

    Returns void

StaticonOpenAccountSettingsTriggered

  • onOpenAccountSettingsTriggered(): void

  • Opens the account settings.

    Returns void

StaticonOpenRSXWebsiteTriggered

  • onOpenRSXWebsiteTriggered(): void

  • Opens the RSXEngine URL.

    Returns void

StaticonOpenSceneTriggered

  • onOpenSceneTriggered(ignoreSave?): void

  • Opens a dialog that allows the user to select a new template to load as the current scene. If current scene is modified the user is offered a chance to save it.

    Parameters

    • OptionalignoreSave: boolean

    Returns void

StaticonPrecompileShadersTriggered

  • onPrecompileShadersTriggered(): void

  • Precalculates all shaders.

    Returns void

StaticonQuitTriggered

  • onQuitTriggered(): void

  • Quits the application.

    Returns void

StaticonSaveProjectTriggered

  • onSaveProjectTriggered(): void

  • Saves all data in the currently open project.

    Returns void

StaticonSignOutTriggered

  • onSignOutTriggered(): void

  • Signs the current account out.

    Returns void

StaticonSubmitPendingCrashReports

  • onSubmitPendingCrashReports(): void

  • Invoked when the user wants to submit pending crash reports.

    Returns void

StaticonTestCustomSaveOptions

  • onTestCustomSaveOptions(textLength?, includeCustomControl?): void

  • Opens a dialog with custom save options.

    Parameters

    • OptionaltextLength: number
    • OptionalincludeCustomControl: boolean

    Returns void

StaticonTestMessageBoxTriggered

  • onTestMessageBoxTriggered(textLength?, includeCustomControl?): void

  • Calculates and logs the GPU memory usage.

    Parameters

    • OptionaltextLength: number
    • OptionalincludeCustomControl: boolean

    Returns void

StaticonToggleProfilingTriggered

  • onToggleProfilingTriggered(): void

  • Toggles the profiling system.

    Returns void

StaticonUpdateProjectSceneHeadsTriggered

  • onUpdateProjectSceneHeadsTriggered(): void

  • Updates all scene heads to the latest version.

    Returns void

StaticopenURL

  • openURL(url): void

  • Opens a URL. The url can be a web URL or a file system URL.

    Parameters

    • url: string

      The URL to open.

    Returns void

Staticquit

  • quit(): void

  • Closes the editor.

    Returns void

Protected StaticregisterConsoleCommands

  • registerConsoleCommands(): void

  • Registers the global console commands.

    Returns void

Protected StaticregisterInputConfiguration

  • registerInputConfiguration(): void

  • Register the global editor application input configuration and buttons.

    Returns void

StaticreloadAssemblies

  • reloadAssemblies(): void

  • Reloads all script assemblies in case they were modified. This action is delayed and will be executed at the beginning of the next frame.

    Returns void

Staticrestart

  • restart(): void

  • Restarts the editor.

    Returns void

StaticrestoreKeyWindowLayout

  • restoreKeyWindowLayout(): boolean

  • Restores a previously persisted key window layout.

    Returns boolean

StaticrunUnitTests

  • runUnitTests(): void

  • Executes any editor-specific unit tests. This should be called after a project is loaded if possible.

    Returns void

StaticsaveScene

  • saveScene(sceneInstance, path): Scene

  • Saves the currently loaded scene to the specified path.

    Parameters

    • sceneInstance: SceneInstance

      The scene instance to save.

    • path: string

      Path relative to the resource folder. This can be the path to the existing scene template if it just needs updating.

    Returns Scene

    The saved Scene resource.

StaticsubmitPendingCrashReports

  • submitPendingCrashReports(showNoReportsMessage): void

  • Locates unsubmitted crash reports located in the CrashReports user data folder. If crash reports are found, the user is prompted to submit the report. Unsubmitted records are offered to be removed.

    Parameters

    • showNoReportsMessage: boolean

    Returns void

    Note

    This requires an internet connection.

Events

Static ReadonlyonSceneViewportRedrawRequested

onSceneViewportRedrawRequested: Event<[Const<SceneViewportRedrawRequest>], void>

Event triggered when a changed happen to notify viewports that they should redraw.

Static ReadonlyonProfilingStateChangeEditor

onProfilingStateChangeEditor: Event<[boolean], void>

Static ReadonlyonDomainReloadRequested

onDomainReloadRequested: Event<[], boolean>

An event that fires whenever a domain reload is requested. This event allows subscribers to block a domain reload request by returning false.

If any subscriber returns false, the domain reload is suspended for 1 second and after that time has elapsed, a new call to the event will be sent.

Static ReadonlyonDomainReloadBlocked

onDomainReloadBlocked: Event<[], void>

An event called whenever domain reload is blocked by a subscriber of OnDomainReloadRequested.

Static ReadonlyonKeyWindowDockManagerLayoutChanged

onKeyWindowDockManagerLayoutChanged: Event<[KeyWindowBase, DockableEditorWindowLayout], void>

An event fired whenever the layout for a key window changes.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events