Static ReadonlypackageThe file extension for the RSX package format. The string includes the leading dot separator.
StaticallReturns all non-built-in resource roots, including the current project root.
StaticasyncReturns the progress of asynchronous package operations, in range [0, 1]. Returns 1.0 if all operations are complete or none have even started.
All async operations that are started while there is another async operation in progress are considered as part of the same import session. This means that queuing further async operations can result in the progress number decreasing rather than increasing.
StaticcodeReturns the absolute filesystem path of the current project's generated source-code folder.
StaticeditorReturns the root entry containing editor-provided resources.
StaticengineReturns resource roots marked as built-in engine or editor data.
StaticengineReturns the root entry containing engine-provided resources.
StaticimportChecks whether an asset import is currently in progress.
StaticimportReturns the import progress for all active import operations, in range [0, 1]. Returns 1.0 if import is complete or has not even started.
All import operations that are started while there is another import operation in progress are considered as part of the same import session. This means that queuing further import operations can result in the progress number decreasing rather than increasing.
StaticlibraryStaticprojectReturns the absolute filesystem path of the current project folder.
StaticresourcesReturns the absolute filesystem path of the current project's resources folder.
StaticresourcesReturns every configured project, engine, and editor resource root.
StaticrootReturns the root entry containing resources owned by the current project.
StaticaddAdds the given tag to the given Resource Entry.
The resource entry to add the tag to.
The tag to add.
StaticcancelMarks every queued import destination as canceled. Running importer work cannot be interrupted and must finish before cancellation is finalized. Call finalizeAsyncOperations to process the resulting state changes.
StaticcomposeComposes the unique identifier path for a package or an entry within that package.
The file-system path of the package.
OptionalresourceLibraryPath: LibraryPath
Optional virtual path of an entry within the package.
The unique identifier path for the package or package entry.
StaticcontainsChecks if the library contains a resource with the specified UUID.
UUID of the resource.
True if the resource is part of the library.
StaticconvertToggles the coordinate-system handedness of a mesh or template resource. Applying the operation twice restores the original handedness.
UUID of the mesh or template resource to convert.
StaticcopyCopies a list of library entries from one path to another.
Source identifier paths.
Destination identifier paths corresponding one-to-one with sourceIdentifierPaths.
Optionaloverwrite: boolean
If an entry already exists at the destination path, should it be overwritten.
StaticcreateCreates an empty package entry, or returns the existing package entry at the same identifier path.
Absolute package identifier path, or a path relative to the project resources root.
Optionalflags: EnumValue<ProjectLibraryPackageMetaFlags>
Optional package meta flags.
The transient package entry, or null if the path is invalid or creation failed.
StaticcreateRegisters a new resource in the library. This will add the resource to the package at the provided identifierPath if one exists,
or create a new package otherwise.
Resource instance to add to the library.
Identifier path at which to store the resource. It must include the target package and the resource's virtual path inside that package.
Optionalclone: boolean
If true the contents of the resource will be saved as they are in the current state. This allows you to freely modify the existing copy of the resource after the call.
Optionalflags: EnumValue<ProjectLibraryEntryMetaDataFlags>
Optional resource meta flags.
OptionalownerUserID: UUID
Optional ID of the owner of the resource. The owner might be different from the creator. If a resource has an owner, only the owner can write to the resource.
The transient resource entry created for the queued operation, or null if the operation could not be queued.
StaticcreateRegisters a new resource in the library. This will create a package for the resource and store the file at the virtual libraryPath.
The project library assumes that the resource is the main resource inside the package, and the package file name will
match the UUID of the resource.
Resource instance to add to the library.
Virtual library path at which to store the resource inside the new package.
Optionalclone: boolean
If true the contents of the resource will be saved as they are in the current state. This allows you to freely modify the existing copy of the resource after the call.
Optionalflags: EnumValue<ProjectLibraryEntryMetaDataFlags>
Optional resource meta flags.
OptionalownerUserID: UUID
Optional ID of the owner of the resource. The owner might be different from the creator. If a resource has an owner, only the owner can write to the resource.
The transient resource entry created for the queued operation, or null if the operation could not be queued.
StaticcreateCreates a new virtual folder in the library.
Virtual folder path, for example Materials/Organic/.
StaticdeleteDeletes an entry from the library.
Absolute identifier path, or a path relative to the project resources root.
Deletes a list of entries from the library.
Identifier paths of the entries to delete.
StaticdetermineDetermines if all dependencies for the resource with the specified uuid are available in the project library. If the method
returns false, a load would trigger a potential blocking download of all dependencies.
UUID of the resource whose direct dependencies should be checked.
True if every relevant dependency is available, false if at least one requires retrieval, or null if the resource or its package metadata cannot be found.
StaticexistsChecks whether the project library contains an entry with the specified identifier path.
Identifier path of the entry to find.
OptionalsearchInsidePackages: boolean
Whether entries inside package virtual file systems should be considered.
true if the entry exists; otherwise, false.
StaticexistsDetermines whether a library entry exists at the given virtual library path, without taking packages into account. To find
an entry within a specific package, use GetEntryWithIdentifierPath instead.
For example, the "Meshes" folder could be present in both PackageA and PackageB. This method returns true if either package contains an entry at that virtual path.
Virtual library path to search for.
Whether an entry exists at the given virtual library path in any package.
StaticfinalizeFinalizes completed library operations and dispatches their resulting hierarchy updates and events. To avoid starving the
main thread, one call processes at most three heavy finalization operations. If wait is true, the call first blocks until
currently queued background work has completed.
Optionalwait: boolean
Whether to wait for queued work instead of finalizing only work that has already completed.
StaticfindGets resources affixed to the resource with the specified uuid. If requiredFlags is None, resources with any affix flags
are included.
UUID of the resource to which returned resources are affixed.
OptionalrequiredFlags: EnumValue<AffixResourceFlags>
Required affix flags; matching any requested flag is sufficient.
The dependent resource entries.
StaticfindFinds resources whose package metadata declares a dependency on the resource at the specified identifier path.
Absolute identifier path, or a path relative to the project resources root.
Transient resource entries that depend on the specified resource.
StaticfindGets project resource entries associated with a Polyverse library and, optionally, one Polyverse asset.
The resource entries.
StaticfindFinds all resources that were imported from the provided source asset path.
Absolute path to the source asset.
A list of resources imported from asset at sourcePath.
StaticgetLooks up the identifier path for the resource with the specified UUID. The identifier path is absolute.
UUID of the resource.
The absolute identifier path, or an empty path if the UUID is not present in the library.
StaticgetConverts a project resource identifier path into the corresponding generated source path without checking whether the resource is a code resource or whether the source file exists.
Identifier path of the resource. Absolute paths must belong to the project resources root.
If true, resolves beneath the Code/Editor folder; otherwise resolves beneath Code.
The absolute generated source path, or an empty path if an absolute identifier lies outside the project library.
Gets the generated source path for the resource with the specified UUID.
UUID of the resource.
If true, resolves beneath the Code/Editor folder; otherwise resolves beneath Code.
The absolute generated source path, or an empty path if the UUID is not present in the project library.
StaticgetFinds the entries that reside at the folder in the virtual library path.
The virtual library path of the folder.
True to only include the first found directory entry with identical names but in different packages.
OptionalrootType: EnumValue<ProjectRootType>
Resource root to search.
The transient entries directly contained by the folder.
StaticgetGets any library entry with the specified uuid.
UUID of the entry.
The transient entry, or null if no entry was found.
StaticgetFinds a library entry at the specified identifier path.
Absolute identifier path, or a path relative to the project resources root.
When true the entry returned can be a directory or a resource entry within the package virtual file system. When false the search stops at physical folders and package files.
OptionalonlyInProjectLibrary: boolean
When true, excludes engine and editor resource roots from an absolute-path search.
The transient entry, or null if no matching entry exists.
StaticgetFinds the entry that represents the provided virtual library path.
The virtual library path to search for.
Optionalindex: number
The index of the element. If multiple elements share the same virtual path, you can iterate through all items by specifying a higher index. Once the end of the list was reached, the API will return null.
OptionalrootType: EnumValue<ProjectRootType>
Resource root to search.
The transient entry at index, or null if no matching entry exists.
Multiple LibraryEntry might occupy same virtual library path. Usindexe the to select which of the entries to
return.
StaticgetReturns the import progress of the package containing the specified resource.
Identifier path of a package or an entry inside it.
1 if the package has finished importing, or 0 if it is queued, unknown, or has not started.
StaticgetReturns cached library icons for the resource at the specified identifier path.
Identifier path of the resource.
OptionalrequestCreation: boolean
If true and no icons are cached, requests icon generation for supported entries.
The library icons, or null if no library icons are available.
Returns the library icons for the resource with the provided uuid.
The UUID of the resource.
OptionalrequestCreation: boolean
If true and no icons are cached, requests icon generation for supported entries.
The library icons, or null if no library icons are available.
StaticgetFinds the physical folder or package entry containing the specified identifier path without searching inside packages.
Absolute identifier path, or a path relative to the project resources root.
The transient folder or package entry, or null if no matching entry exists.
StaticgetLooks up the identifier path for the resource with the specified UUID. The path is relative to the root resource folder.
UUID of the resource.
The project-resources-relative identifier path. Resources in other roots remain absolute. Returns an empty path if the UUID is not present in the library.
Looks up the identifier path for the resource. The path is relative to the root resource folder.
The resource to get the path for.
The project-resources-relative identifier path. Resources in other roots remain absolute. Returns an empty path if the resource is null or is not present in the library.
StaticgetGets the entry with the specified identifierPath.
Identifier path of the resource.
The resource entry, or null if the path does not resolve to a resource.
StaticgetGets the resource entry with the specified uuid.
UUID of the resource.
The resource entry, or null if no resource was found.
StaticgetGets package and project metadata for the resource at the specified identifier path.
Absolute identifier path, or a path relative to the project resources root.
The combined metadata, or null if the path does not resolve to a resource with metadata.
Gets package and project metadata for the resource with the specified UUID.
UUID of the resource.
The combined metadata, or null if the UUID does not resolve to a resource with metadata.
StaticgetConverts a project-resources-relative identifier path to an absolute filesystem path. Absolute input is returned unchanged.
Absolute identifier path, or a path relative to the project resources root.
The corresponding absolute filesystem path.
StaticgetReturns the serialized size of a resource and its preview data, excluding optional streaming data.
Identifier path of the resource.
The size in bytes, or 0 if the resource cannot be found or read.
Returns the serialized size of a resource and its preview data, excluding optional streaming data.
The resource entry to inspect.
The size in bytes, or 0 if the entry is null or cannot be read.
StaticgetReturns the combined size of a resource's streaming-data dependencies.
UUID of the resource.
The size in bytes, or null if the resource is not streaming or its metadata is unavailable.
StaticgetReturns the directory entry for the specified resource root.
Root to retrieve.
The root entry, or null if rootType is invalid.
StaticgetReturns the directory entry for the specified resource root.
Root to retrieve.
The root directory entry, or null if type is invalid.
StaticgetReturns the source file from which a resource was imported.
Identifier path of the resource entry.
The absolute source file path, or an empty path if no source file is recorded.
StaticgetReturns the runtime Type represented by a ResourceType value.
Resource type value to resolve.
The corresponding runtime type.
StaticgetConstructs a unique library path. If an entry already exists at libraryPath, a numeric suffix is appended to
the filename until an unused path is found.
The input library path.
A unique library path.
StatichasChecks whether an operation is currently targeting the specified library entry.
Absolute or project-resources-relative identifier path of the entry.
True if the entry currently has an associated library operation.
StaticimportImports a source asset using the provided import options and stores the output assets at the provided path.
Absolute path to the asset to import.
The virtual library path at which to store the imported assets.
OptionalimportOptions: ImportOptions
Optional import options to use when importing the resource. Caller must ensure the import options are of the correct type for the resource in question. If null is provided default import options are used.
OptionalfileInformation: ImportFileInformation
Optional result previously returned by peekFile for the same source file. Reusing it avoids repeating importer inspection work.
StaticisDetermines if the code-file at the specified uuid is dirty.
UUID of a code resource.
True if the generated source file differs from the packaged code resource.
StaticisDetermines if the code-file at the specified identifierPath is dirty.
Identifier path of a code resource.
True if the generated source file differs from the packaged code resource.
StaticisDetermines whether the resource entry represents a resource with a generated source-code file.
Non-null resource entry to inspect.
True if the resource has a code-file representation.
StaticisChecks whether library icons are currently being generated for the specified entry.
Identifier path of the entry.
True while icon generation is in progress.
Checks whether library icons are currently being generated for the resource with the specified UUID.
UUID of the resource.
True while icon generation is in progress.
StaticisChecks whether an identifier path belongs to an engine-internal library root.
Identifier path to check.
true if the path belongs to an engine-internal root; otherwise, false.
StaticisDetermines whether a library entry supports library-icon generation.
Entry to inspect.
True if an icon can be generated for the entry.
StaticisDetermines whether the current editor user can modify a resource.
A resource is not modifiable when the user lacks the editor role or its package metadata marks it as read-only.
Resource UUID, instance, handle, or library entry to check.
true if the resource is modifiable; otherwise, false.
StaticisDetermines whether every streaming-data dependency for a resource is present in the local library.
UUID of the resource.
False if the resource is missing, is not streaming, or any streaming-data dependency is unavailable.
StaticisDetermines whether a resource has streaming-data metadata.
UUID of the resource.
True if the resource is configured for streaming; false if it is not streaming or cannot be found.
StaticmoveQueues a move of one library entry.
Source identifier path.
Destination identifier path.
Optionaloverwrite: boolean
Whether an existing destination entry may be replaced.
Queues moves for corresponding source and destination identifier paths.
Source identifier paths.
Destination identifier paths. The array must correspond one-to-one with oldPaths.
Optionaloverwrite: boolean
Whether existing destination entries may be replaced.
StaticparseSplits an identifier path into its physical package path and virtual path within that package.
Absolute identifier path, or a path relative to the project resources root.
The parsed paths, or null if the identifier does not contain a valid package path.
StaticpeekPeeks into the given path to a file and cache its information. The cached import information can be passed to the import call to reduce memory usage and improve performance.
Absolute path to the asset to import.
An asynchronous operation containing cached importer information, or an error if the file cannot be inspected.
StaticrefreshChecks whether resources at the specified identifier path have been modified, added, or deleted on disk and updates the internal hierarchy accordingly.
Identifier path of the package, folder, or resource to refresh. Folders are checked recursively.
True if the library hierarchy changed.
StaticreimportReimports a source asset using the provided import options and stores it at the provided path. All existing assets referencing
the provided source asset path will be updated (if they are still available in the source asset). Any new assets will be stored
in the package identified by destinationPath.
Absolute path to the source asset to reimport.
Identifier path of the destination package.
OptionalimportOptions: ImportOptions
Optional import options to use when importing new assets. Caller must ensure the import options are of the correct type for the resource in question. If null is provided default import options are used. Existing assets will use their current import options.
StaticreimportReimports one resource from its recorded source file using its stored import options.
Absolute identifier path, or a path relative to the project resources root.
StaticreimportReimports all the provided resources from their source file(s). Uses the import options currently bound to the assets.
Identifier paths of the resources to reimport.
OptionalimportOptions: ImportOptions[]
An optional array of import options where each entry corresponds to an entry in identifierPaths. The previous import options
cached on the ResourceEntry will be used if the entry in importOptions is null, or the importOptions array is
smaller than the index of the corresponding identifier path.
StaticremoveRemoves the tag from the given Resource Entry.
The resource entry to remove the tag from.
The tag to remove.
StaticsaveUpdates a resource that is already in the library.
Note that the write operation is executed asynchronously on a worker thread and you must not modify the resource contents
until this operation completes. If this is not possible the set the clone parameter to true.
Resource instance to add to the library.
Optionalclone: boolean
If true the contents of the resource will be saved as they are in the current state. This allows you to freely modify the existing copy of the resource after the call.
An asynchronous operation whose result contains an error message when saving fails.
StaticsaveSaves the resource meta data.
Identifier path of the resource whose metadata should be persisted.
An asynchronous operation whose result contains an error message if saving fails.
To modify ResourceMetaData, load the resource and update its metadata object before calling this method.
Saves metadata for the resource with the specified UUID.
UUID of the resource whose metadata should be persisted.
An asynchronous operation whose result contains an error message if saving fails.
StaticsearchSearches one resource root for entries whose names match a wildcard pattern.
Pattern to search for. Use wild card '*' to match any character(s).
Virtual folder from which to start the search, relative to rootType.
The root entry to search from.
Flags to control the search operation.
Transient entries matching the pattern and options.
StaticsearchSearches a library root for resources matching pattern whose types match one of types.
Pattern to search for. Use * to match any sequence of characters.
Virtual library path at which to begin the search.
Library root to search.
Search options.
Resource types to include.
An array of matching ResourceEntry objects.
StaticsearchSearches the project library root for resources matching pattern whose types match one of types.
Pattern to search for. Use * to match any sequence of characters.
Resource types to include.
An array of matching ResourceEntry objects.
StaticsetSets the deployment platforms on which the resource is included even when it is otherwise unreferenced.
Identifier path of the resource to modify.
The target platforms for the resource.
An asynchronous operation whose result contains an error message if the metadata update fails.
StaticsetStaticsetAssigns a library icon to the resource at the specified identifier path.
Identifier path of the resource.
Icon to assign as preview.
If true, makes the stored icon fully opaque.
StaticsetCaches a static library icon for the type represented by resourceEntry.
The ResourceEntry that triggered the generation of the library icon.
Icon to use for all resources of that type.
StaticsetSets the source file from which a resource was imported.
Identifier path of the resource entry.
New absolute source file path.
StaticsyncSynchronizes every generated source code file back to its corresponding package.
An asynchronous operation containing the result of each queued package update. If no code files need synchronization, the operation completes without results.
StaticsyncSynchronizes the code resource with the specified UUID from the generated source file into its package.
UUID of the code resource.
True if at least one code file synchronization was queued.
Synchronizes the code file at the provided path to its corresponding package.
Path of the entry to check, either relative to the resources folder or absolute. Can point to an individual resource or a directory/package. All sub-entries will be iterated recursively.
True if at least one code file synchronization was queued.
StaticsyncIterates over the provided entry and all children recursively. If any code resources are found their corresponding code files
will be generated and stored in the 'Source' directory. Any existing code files will be merged based on the specified merge
mode.
The library entry to synchronize.
The synchronization mode.
The number of code files generated.
Static ReadonlyonTriggered immediately before an entry is removed. The transient entry remains valid during the callback.
Static ReadonlyonTriggered after an entry is removed. identifierPath is the former identifier path of the entry.
Static ReadonlyonTriggered after an entry is added to the library.
Static ReadonlyonTriggered after a library operation modifies an entry or package.
Static ReadonlyonTriggered after an entry is renamed or moved from oldIdentifierPath to newIdentifierPath.
Static ReadonlyonTriggered after an imported resource has been added to or refreshed in its package.
Static ReadonlyonTriggered when library-icon generation is requested for an entry.
Static ReadonlyonTriggered when the generation of a static per-type library icon is requested. The specified ResourceEntry triggered the request.
Static ReadonlyonTriggered after cached library icons for an entry are updated.
Static ReadonlyonTriggered when an import operation completes with one or more resource errors.
Static ReadonlyonTriggered when an entry's cloud-conflict state changes.
Static ReadonlyonTriggered after an ICodeResource is synchronized from the filesystem into its package.
Static ReadonlyonTriggered when synchronization of an ICodeResource from its package to the filesystem begins.
This event only indicates that synchronization began; it does not indicate that the filesystem counterpart was updated. Use the onCodeSyncToFileSystemUpdateComplete event to handle this event. If no change to the file-system counterpart is needed, no event will be fired. If synchronization requires a merge, onCodeSyncMergeRequest is triggered so a listener can provide merged source. If the event is not handled, the built-in Three-Way-Merge will attempt to solve the merge. If the merge failed, the event onCodeSyncToFileSystemUpdateFailed will be triggered. If the ICodeResource does not support syncing to the file system, no event will be triggered at all.
Static ReadonlyonTriggered when a sync of a module definition to the filesystem begins.
Static ReadonlyonTriggered when a sync of a module definition to the filesystem failed.
Static ReadonlyonTriggered when a sync of a module definition to the filesystem completed.
Static ReadonlyonTriggered when updating the filesystem representation of an ICodeResource fails.
Static ReadonlyonTriggered after the filesystem representation of an ICodeResource is updated successfully.
Static ReadonlyonTriggered when an ICodeResource requires a three-way merge. A listener may return merged source code. If no listener handles
the request, the built-in merge implementation is used.
Static ReadonlyonTriggered when an import no longer needs its source file.
Editor-facing API for discovering and managing entries in the loaded project's virtual library.
ProjectLibrarymanages the library hierarchy and its metadata. Use it to find LibraryEntry objects and to import, create, move, rename, or delete entries. Use Resources to load the corresponding Resource instances.To access a resource's contents, locate its ResourceEntry and pass ResourceEntry#uuid to Resources.get, Resources.load, Resources.loadAsync, or Resources.loadHandleBackground depending on the required loading behavior.
A LibraryPath identifies a location in the virtual library hierarchy but is not unique across packages. A LibraryIdentifierPath identifies a specific entry, including its package, it's use is typically required when working with internal library API, when absolute locations are required e.g. copy or move operations.