User Tools

Site Tools


Application Instancing

Below are a subset of available Command Line Options that are specific to application instancing:

  • Options:
    • -instanceName
      • Valid characters include any uppercase or lowercase ASCII character in the A-Z range, as well as any number (integer), hyphen, underscore, in any sequence
        • Any characters that are not supported (e.g., a space - if the value is quoted, special characters, non-ASCII characters) will be automatically stripped
      • Supports gap-filling automatic incrementation (Windows only - automatic incrementation does not currently occur on macOS)
        • An application instance name containing the “#” (number sign, hash, pound) character will automatically have occurrences of the “#” character replaced by the 'next' available incremental integer value (e.g., if instances 1, 2, and 3 are running, instance 2 is closed and a new instance is launched, the new instance will be assigned 2 and the next would be assigned 4 - unless 1, 2 or 3 were closed before it launched)
        • Cleaning of application settings and session UI files on launch is automatic by default
          • Use the -cleanOnLaunch option to override this behavior
        • Copying of root release channel application settings is automatic by default
          • Use the -copyAppSettings option to override this behavior
        • Copying of root release channel session UI files is automatic by default
          • Use the -copySessionUI option to override this behavior
    • -cleanOnLaunch
      • If specified, this option is used to determine whether or not application settings/data are removed when the application is launched
      • A falsey value does not override the standard behavior of purging the application's temp directory on launch
      • Valid falsey values are 0, off, n, no, f, or false
      • Valid truthy values are 1, on, y, yes, t, or true
    • -cleanOnExit
      • If specified, this option is used to determine whether or not application settings/data are removed when the application exits
      • A falsey value does not override the standard behavior of purging the application's temp directory on exit
      • Valid falsey values are 0, off, n, no, f, or false
      • Valid truthy values are 1, on, y, yes, t, or true

Convenience

    • A script that demonstrates the use of each option outlined above, along with a few others that are useful for working with application instances
    • If the “Launch Process” option in the script's dialog is NOT checked, a message is displayed that contains an OS specific generated string that can be used to launch an instance of the application from command line, a shortcut or an alias
      • This message contains a “Copy” button that will copy the generated string to the system clipboard, to ease its use for purposes where this is desired
      • This generated string is also written to the log (Help > Troubleshooting > View Log File…)
    • If the “Launch Process” option IS checked, a new instance of the application is launched, configured according to the active options and their respective values
    • If a scene is currently loaded, the “File” option will provide a menu that contains the path of the loaded scene
      • Selecting this option and choosing a file path allows another application instance to be launched and the specified asset to be automatically loaded
    • If an asset is selected in the Smart Content pane > Files page (and the page is visible), or in the Content Library pane (and the pane is visible), the “File” option will provide a menu that contains the path(s) of the selected asset(s)
      • Selecting this option and choosing a file path allows another application instance to be launched and the specified asset to be automatically loaded