Class Project

constructor

• new Project(): Project

  Returns Project

StaticcloudProject

• get cloudProject(): CloudProject

  The currently loaded CloudProject.

  Returns CloudProject

Staticcompany

• get company(): string

  The company that owns the project.

  Returns string

StatichasAdministorUserRole

• get hasAdministorUserRole(): boolean

  Determines if the current user is an administrator on the project.

  Returns boolean

StatichasDeploymentUserRole

• get hasDeploymentUserRole(): boolean

  Determines if the current user has the deployment role on the project.

  Returns boolean

StatichasEditorUserRole

• get hasEditorUserRole(): boolean

  Determines if the current user is an editor on the project.

  Returns boolean

StaticisCloudSynced

• get isCloudSynced(): boolean

  Determines if any project is currently loaded and it is cloud synchronized.

  Returns boolean

StaticisInitialCheckoutCompleted

• get isInitialCheckoutCompleted(): boolean

  Determines if the initial project checkout is completed.

  Returns boolean

StaticisLoaded

• get isLoaded(): boolean

  Determines if any project is currently loaded.

  Returns boolean

StaticisLoading

• get isLoading(): boolean

  Determines if a project checkout/load is currently in progress (i.e. the loading modal is shown).

  Returns boolean

Statictitle

• get title(): string

  The currently loaded project title/name.

  Returns string

Staticuuid

• get uuid(): UUID

  The currently loaded project UUID.

  Returns UUID

Staticcreate

• create(path: string): void

  Contains a new project in the provided folder.

  Parameters

  • path: string

    Absolute path to the folder to create the project in. Name of this folder will be used as the project's name.

  Returns void

StaticcreateFromCloudProjectUUID

• createFromCloudProjectUUID(projectUUID: Const<UUID>): void

  Creates a new local project that represents a RSX cloud project.

  Parameters

  • projectUUID: Const<UUID>

    The cloud project UUID.

  Returns void

StaticgetDefaultCloudProjectStoragePath

• getDefaultCloudProjectStoragePath(): FilePath

  Gets the default local path for storing RSX cloud projects.

  Returns FilePath

StaticgetLocalCloudProjectStoragePath

• getLocalCloudProjectStoragePath(projectUUID: Const<UUID>): FilePath

  Gets the local path for a cloud project with the given project UUID.

  Parameters

  • projectUUID: Const<UUID>

    The web project UUID.

  Returns FilePath

StaticisAnyResourceModified

• isAnyResourceModified(): boolean

  Checks did we make any modifications to the scene since it was last saved.

  Returns boolean

  True if the scene was never saved, or was modified after last save.

StaticisValidProjectStoredAtPath

• isValidProjectStoredAtPath(path: string): boolean

  Checks does the folder at the provided path contain a valid project.

  Parameters

  • path: string

    Absolute path to the root project folder.

  Returns boolean

  True if the folder contains a valid project.

Staticload

• load(projectFilePath: string, cloudProject?: CloudProject): boolean

  Loads the project at the specified path. This method executes asynchronously.

  Parameters

  • projectFilePath: string

    Absolute path to the project's root folder.

  • OptionalcloudProject: CloudProject

  Returns boolean

StaticmarkDirty

• markDirty(): void

  Marks the current project dirty (requires saving in order for changes not to be lost).

  Returns void

StaticonEditorUpdate

• onEditorUpdate(): void

  Called by the runtime to update the project states.

  Returns void

StaticonInitialize

• onInitialize(): void

  Invoked by the runtime when the editor initialized.

  Returns void

Staticsave

• save(isSavingSettings?: boolean, isSavingScenes?: boolean): boolean

  Saves all data in the currently open project.

  Parameters

  • OptionalisSavingSettings: boolean

    If true, project settings will be saved as well.

  • OptionalisSavingScenes: boolean

  Returns boolean

StaticsaveAndContinue

• saveAndContinue(
      next: () => void,
      customMessage?: string,
      parentWindow?: EditorWindow,
  ): void

  Checks if any resource is modified and opens a dialog to save them if any. Once the user saves any resources he wishes, the next callback will be called. If the user choses to cancel, next will not be invoked.

  Parameters

  • next: () => void

    Callback to trigger when the user decides to continue.

  • OptionalcustomMessage: string

    A custom message to be displayed on the window.

  • OptionalparentWindow: EditorWindow

    The parent window on which the dialog will be attached, will be the main window if null.

  Returns void

StaticsetDirty

• setDirty(modified: boolean): void

  Changes the project state displayed on the status bar.

  Parameters

  • modified: boolean

    Whether to display the project as modified or not.

  Returns void

Staticunload

• unload(): Promise<boolean>

  Unloads the currently loaded project, without making any checks or requiring confirmation.

  Returns Promise<boolean>

Static ReadonlyonLoad

Static ReadonlyonSave

Static ReadonlyonInitialCheckoutCompleted

Static ReadonlyonUnload

Static ReadonlyonCreate