Static ReadonlypackageThe file extension for the RSX package format. The string includes the dot filename separate.
StaticallReturns all Directory Entries representing root folders that are not engine internals.
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.
StaticcodeStaticeditorReturns the editor root library entry that contains the editor internal resources.
StaticengineReturns the Directory Entries of all the engines internal root folders.
StaticengineReturns the engine root library entry that contains the engine internal 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.
StaticlibraryGets the size of the library icon image.
StaticprojectStaticresourcesStaticresourcesReturns the Directory Entries of all the engines internal root folders.
StaticrootReturns the project root library entry that contains the project's library.
StaticaddAdds the given tag to the given Resource Entry.
The resource entry to add the tag to.
The tag to be added.
StaticcancelCancels any queued import tasks. Note that you must call finalizeAsyncOperations() for the import state to be updated. If the import task has already started you will need to wait until it finishes as there is no way to stop running tasks. If the provided file entry isn't being imported, or has already finished imported, the function does nothing.
StaticcontainsChecks if the library contains a resource with the specified UUID.
The uuid of the resource to get the path for.
True if the resource is part of the library.
StaticcopyCopies a list of library entries from one path to another.
A list of library entries path to copy from. Absolute or relative to resources folder.
A list of destinations paths where each entry will be copied to. Absolute or relative to resources folder.
Optionaloverwrite: booleanIf an entry already exists at the destination path, should it be overwritten.
StaticcreateCreates an empty package in the library or returns an existing one if there is one already.
Path where where to store the package. Absolute or relative to the resources folder.
Optionalflags: EnumValue<ProjectLibraryPackageMetaFlags, number>Optional package meta flags.
Newly created file entry, or null if not successful.
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.
Path where where to store the resource. Absolute or relative to the resources folder. Path must include path to the package to store the resource in, as well as relative path in the package to store the resource under.
Optionalclone: booleanIf 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, number>Optional resource meta flags.
OptionalownerUserID: UUIDOptional 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.
Newly created resource entry or null if creation failed.
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.
The virtual library path where where to store the resource inside the new package.
Optionalclone: booleanIf 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, number>Optional resource meta flags.
OptionalownerUserID: UUIDOptional 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.
Newly created resource entry or null if creation failed.
StaticcreateCreates a new virtual folder in the library.
The library path to the folder in the form 'Materials/Organic'
StaticdeleteDeletes an entry from the library.
If LibraryIdentifierPath: Path of the entry, absolute or relative to resources folder.
If LibraryIdentifierPath: A list of paths of entries, absolute or relative to resources folder.
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.
The uuid of the resource to get the path for.
An optional that determines the availability, if no optional is returned, the UUID is invalid.
StaticexistsChecks whether the project library contains a file or folder at the specified path.
Path to the file/folder to check, absolute or relative to resources folder.
OptionalsearchInsidePackages: booleanTrue, the system will check within package's virtual file system. False, only directories or files residing in the actual file system will be considered.
True if the element exists, false otherwise.
StaticexistsAttempts to find whether or not a library entry exists at the given path, without taking packages into account. If you want to precisely find a entry from the path, within a specific package, use findEntry() instead.
e.g: "Meshes" folder could be present both in PackageA and in PackageB. Use this function if you need to check if any entry "Meshes" exists, regardless of its parent Package. If you want the specific "Meshes" entry from PackageA, use findEntry() instead.
Path to the entry you want to search for. Either absolute or relative to the resources folder. If the given path contains a package within, it will be ignored, and other entries could be found from other packages.
Whether the entry exists or not at the given path.
StaticfinalizeIterates over queued operations, checks if they have finished and finalizes them. This should be called on a regular basis
(e.g. every frame). If wait is true the method will block the calling thread until all queued operations complete.
Optionalwait: booleanStaticfindGets all resource entries that depend on the specified uuid with the spcified requiredFlags. If the requiredFlags are None
all dependents will be included.
The UUID that the resources depend on.
OptionalrequiredFlags: EnumValue<AffixResourceFlags, number>The flags to filter for. If None the filter is disabled.
The dependent resource entries.
The dependency is setup via the ResourceMetaData.
StaticfindSearches the project library for any resources that referencing (are dependent) on the resource at the provided path.
Path of the resource for which to looks for dependents. Absolute or relative to the resources folder.
List of resource entries referencing on the provided resource.
StaticfindGets all resource entries that are part of the polyverseLibraryID. Optionally a polyverseAssetID can be specified to lookup
only a particular entry.
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.
The uuid of the resource to get the path for.
StaticgetConverts a relative or absolute project library path into a corresponding path in the 'Code' folder. Useful for retrieving the code file for a particular resource entry. Note this method will return the path without checking if the input path has a valid code file.
Options object for the function call.
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, number>A collection of LibraryEntry.
StaticgetGets the entry with the specified uuid.
The LibraryEntry or null if not item was found.
StaticgetAttempts to a find a library entry at the specified path.
Path to the entry, either absolute or relative to resources folder.
When true the entry returned can be a directory or a resource entry within the package's virtual file system. When false only directories or files residing in the actual file system will be returned.
OptionalonlyInProjectLibrary: booleanFound entry, or null if not found. Value returned by this method is transient, it may be destroyed on any following ProjectLibrary call.
StaticgetFinds the entry that represents the provided virtual library path.
The virtual library path to search for.
Optionalindex: numberThe 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, number>The LibraryEntry or null if not item was found.
Multiple LibraryEntry might occupy same virtual library path. Usindexe the to select which of the entries to
return.
StaticgetChecks how far along is the import for the specified file.
Path to the resource to check the progress for, absolute or relative to the resources folder.
Reports 1 if the file is fully imported. Reports 0 if the import has not started or the file isn't even queued for import. Reports >= 0 if the file is in process of being imported. Note that not all importers support fine grained progress reporting, in which case the import progress will be reported as a binary 0 or 1.
StaticgetReturns the library icons for the resource at the provided path.
Options object for the function call.
The library icons, or null if no library icons are available.
StaticgetAttempts to a find a library entry at the specified path.
Path to the entry, either absolute or relative to resources folder.
Found entry, or null if not found. Value returned by this method is transient, it may be destroyed on any following ProjectLibrary call.
StaticgetLooks up the identifier path for the resource with the specified UUID. The path is relative to the root resource folder.
The relative identifier path for the entry with the specified uuid.
StaticgetGets the entry with the specified identifierPath.
The ResourceEntry or null if not item was found.
StaticgetGets the entry with the specified uuid.
The ResourceEntry or null if not item was found.
StaticgetAttempts to a find a meta information for a resource at the specified path.
If LibraryIdentifierPath: Path to the entry, either absolute or relative to resources folder. If a sub-resource within a package is needed, append the name of the subresource to the path (for example path/to/package.rpak/path/to/subresource).
If UUID: Path to the entry, either absolute or relative to resources folder. If a sub-resource within a package is needed, append the name of the subresource to the path (for example path/to/package.rpak/path/to/subresource).
The found meta or null.
StaticgetStaticgetGet the size of the resource in bytes.
If FilePath: The resource path to check for.
If ResourceEntry: The resource entry to check for.
StaticgetGet the size of the resource in bytes.
The resource UUID to get the streaming data size for.
The optional streaming data size, null if the resource is non-streaming.
StaticgetReturns the Directory Entries of all the engines internal root folders.
StaticgetReturns the root library entry that references the entire library hierarchy.
StaticgetReturns the source asset path an asset was imported from.
Path to the resource for which to retrieve the source file path. Can absolute or relative to the project library.
Absolute path to the source asset file for the provided resource path, if empty string if not available.
StaticgetReturns the underlying type of the Resource for the provided resource type enum.
StaticgetConstructs a new and unique library path. If a file at the libraryPath already exists, a numeric sequence will be appended.
The input library path.
A unique library path.
StatichasChecks if there is any Operation in progress targeting the given entry path.
The path to the entry to look for. Absolute or relative to the Library folder.
Whether or not there is a operation in progress for the given path.
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: ImportOptionsOptional 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: ImportFileInformationStaticisDetermines if the code-file at the specified uuid is dirty.
StaticisDetermines if the code-file at the specified identifierPath is dirty.
StaticisReturns true if the resource entry has a code file representation.
StaticisChecks if the library is currently in the process of generating a preview for the provided path.
The parameter to the call.
StaticisChecks if the given path is form a engine internal source.
The absolute path to verify.
StaticisDetermines if the libraryEntry supports preview generation.
StaticisDetermines if the resource is modifiable.
The UUID, Resource or ResourceEntry.
true if the resource is modifiable.
StaticisDetermines if the streaming data for the resource is available on disk.
StaticisDetermines if the resource is streaming data dynamically.
StaticloadLoads a resource by its giving path.
Absolute or relative to the Project Folder path to the given resource.
The flags to load the resource with.
Whether we should load synchronous or not.
StaticloadLoads a resource from the project library.
Type of the resource to load.
Path of the resource to load. Absolute or relative to the resources folder. If a sub-resource within a file is needed, append the name of the subresource to the path ( for example mymesh.fbx/my_animation).
Optionalflags: EnumValue<ResourceLoadFlag, number>Flags used to control the load process.
Instance of the loaded resource. Null if not found or not created yet, or mismatching type.
StaticmovePerforms move.
Options object for the function call.
StaticparseParses a path in format: "C:\path\to\package.rpak\path\to\resource". And separates it into separate path to the package and the library path (relative path to the resource within the package).
false if the path could not be parsed.
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.
Async operation.
StaticrefreshChecks if any resources at the specified path have been modified, added or deleted, and updates the internal hierarchy accordingly.
Path of the file or folder to check. If a folder is provided all its children will be checked recursively. Folder or file needs to be child of one of our root entries.
Returns true if any changes were made.
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
at destination path.
Absolute path to the source asset to reimport.
Path at which to store the newly imported assets, absolute or relative to resources folder. Must be a package.
OptionalimportOptions: ImportOptionsOptional 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.
StaticreimportReimport a single asset from their source file. Uses the import options currently bound to the asset.
Path to the resource to reimport, absolute or relative to the resources folder.
StaticreimportReimports all the provided resources from their source file(s). Uses the import options currently bound to the assets.
Array of paths of the assets to reimport, absolute or relative to the resources folder.
An optional array of import options where each entry corresponds to an entry in the paths array. 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 entry in paths.
StaticremoveRemoves the tag from the given Resource Entry.
The resource entry to remove the tag from.
The tag to be removed.
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: booleanIf 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.
StaticsaveSaves the resource meta data.
If LibraryIdentifierPath: Identifier Path to the resource to modify, absolute or relative to resources folder.
If UUID: Identifier Path to the resource to modify, absolute or relative to resources folder.
To modify the ResourceMetaData the resource must be loaded, and the resource meta data must be modified driectly
on the Resource.
StaticsearchSearches inside the given library path with a pattern, and filters all entries matching it.
Pattern to search for. Use wild card '*' to match any character(s).
Relative path to look up from. Relative to the provided root.
The root entry to search from.
Flags to control the search operation.
A list of entries matching the pattern.
StaticsearchSearches the library for resources matching a pattern, but only among resources whose type matches one of the entries
in specified types.
Pattern to search for. Use wildcard * to match any character(s).
The library root to search.
Search option flags.
Rest...types: Type[]Types of resources to search for.
A array of ResourceEntry matching the pattern.
StaticsearchSearches the library for resources matching a pattern, but only among resources whose type matches one of the entries
in the specified types.
Pattern to search for. Use wildcard * to match any character.
Rest...types: Type[]Types of resources to search for.
A array of ResourceEntry matching the pattern.
StaticsetDetermines if the platforms this resource will always be included in the build, regardless if it's being referenced or not.
Path to the resource to modify, absolute or relative to resources folder.
The target platforms for the resource.
StaticsetStaticsetAssigns a library icon to use for the resource at the provided path.
Options object for the function call.
StaticsetAssigns a library icon to use for the resource type.
The ResourceEntry that triggered the generation of the library icon.
Icon to assign as preview.
StaticsetSet the source asset path an the asset at path was imported from.
Path to the resource for which to retrieve the source file path. Can be absolute or relative to the project library.
The new absolute path to the new resource source fila path.
StaticsyncStaticsyncSynchronizes the code file at the provided path to its corresponding package.
If UUID: The UUID of the package to synchronize.
If LibraryIdentifierPath: 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 upon success.
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 whenever a file or directory entry is about to be removed from the library.
Static ReadonlyonTriggered whenever a file or directory entry is removed from the library. The provided path is an identifier path.
Static ReadonlyonTriggered whenever a file or directory entry is added to the library. The provided path is an identifier path.
Static ReadonlyonTriggered whenever contents of a file (package) are modified. The provided path is an identifier path.
Static ReadonlyonTriggered whenever an entry is renamed or moved. The provided paths are identifier paths.
Static ReadonlyonTriggered when a source asset is being (re)imported. The provided path is an identifier path.
Static ReadonlyonTriggered when the generation of a library icon is requested. The provided path is an identifier path.
Static ReadonlyonTriggered when the generation of a static per-type library icon is requested. The specified ResourceEntry triggered the request.
Static ReadonlyonTriggered when the generation of a library icon is completed. The provided path is an identifier path.
Static ReadonlyonTriggered when import errors occurred.
Static ReadonlyonTriggered when an entry's conflict state changed. The provided path is an identifier path.
Static ReadonlyonTriggered when a ICodeResource has been synced from the file-system to a pacakge. The provided path is an identifier path.
Static ReadonlyonTriggered when a ICodeResource is being been synced from the package to the file-system. The provided path is an identifier path.
This event only indicates that a sync begins, it does not indicate that the file-system counterpart was update or written. Use the onCodeSyncToFileSystemUpdateComplete event to handle this event. If no change to the file-system counterpart is needed, no event will be fired. If the sync event requires a merge, the onCodeSyncMergeRequest will be triggered to allow a merge request to be fullfilled. 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 a ICodeResource was attempted to be synced from the package to the file-system but failed. The provided path is an identifier path.
Static ReadonlyonTriggered when a ICodeResource has been synced from the package to the file-system. The provided path is an identifier path.
Static ReadonlyonTriggered when a ICodeResource is synced in merge mode. The listener must return with an updated source-code. The provided path is an identifier path.
Static ReadonlyonTriggered when an import has ended and the file is no longer required by the importer.
The primary location for interacting with all the resources in the current project. A complete hierarchy of resources is provided which can be interacted with by importing new ones, deleting them, moving, renaming and similar.