Asset Registry

Asset Registry

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Get All Assets

Gets asset data for all assets in the registry. This method may be slow, use a filter if possible to avoid iterating over the entire registry.

Target is Asset Registry

Get All Assets (Message)

Gets asset data for all assets in the registry. This method may be slow, use a filter if possible to avoid iterating over the entire registry.

Target is Asset Registry

Get All Cached Paths

Gets a list of all paths that are currently cached

Target is Asset Registry

Get All Cached Paths (Message)

Gets a list of all paths that are currently cached

Target is Asset Registry

Get Asset by Object Path

Gets the asset data for the specified object path

Target is Asset Registry

Get Asset by Object Path (Message)

Gets the asset data for the specified object path

Target is Asset Registry

Get Asset Registry

Get Asset Registry

Target is Asset Registry Helpers

Get Assets

Gets asset data for all assets that match the filter. Assets returned must satisfy every filter component if there is at least one element in the component's array. Assets will satisfy a component if they match any of the elements in it.

Target is Asset Registry

Get Assets (Message)

Gets asset data for all assets that match the filter. Assets returned must satisfy every filter component if there is at least one element in the component's array. Assets will satisfy a component if they match any of the elements in it.

Target is Asset Registry

Get Assets by Class

Gets asset data for all assets with the supplied class

Target is Asset Registry

Get Assets by Class (Message)

Gets asset data for all assets with the supplied class

Target is Asset Registry

Get Assets by Package Name

Gets asset data for the assets in the package with the specified package name

Target is Asset Registry

Get Assets by Package Name (Message)

Gets asset data for the assets in the package with the specified package name

Target is Asset Registry

Get Assets by Path

Gets asset data for all assets in the supplied folder path

Target is Asset Registry

Get Assets by Path (Message)

Gets asset data for all assets in the supplied folder path

Target is Asset Registry

Get Assets by Paths

Gets asset data for all assets in any of the supplied folder paths

Target is Asset Registry

Get Assets by Paths (Message)

Gets asset data for all assets in any of the supplied folder paths

Target is Asset Registry

Get Dependencies

Gets a list of paths to objects that are referenced by the supplied package. (On disk references ONLY)

Target is Asset Registry

Get Dependencies (Message)

Gets a list of paths to objects that are referenced by the supplied package. (On disk references ONLY)

Target is Asset Registry

Get Referencers

Gets a list of packages that reference the supplied package. (On disk references ONLY)

Target is Asset Registry

Get Referencers (Message)

Gets a list of packages that reference the supplied package. (On disk references ONLY)

Target is Asset Registry

Get Sub Paths

Gets a list of all paths that are currently cached below the passed-in base path

Target is Asset Registry

Get Sub Paths (Message)

Gets a list of all paths that are currently cached below the passed-in base path

Target is Asset Registry

Has Assets

Does the given path contain assets, optionally also testing sub-paths?

Target is Asset Registry

Has Assets (Message)

Does the given path contain assets, optionally also testing sub-paths?

Target is Asset Registry

Is Loading Assets

Returns true if the asset registry is currently loading files and does not yet know about all assets

Target is Asset Registry

Is Loading Assets (Message)

Returns true if the asset registry is currently loading files and does not yet know about all assets

Target is Asset Registry

Is Search All Assets

Whether SearchAllAssets has been called, or was auto-called at startup. When async (editor or cooking), if SearchAllAssets has ever been called, any newly-mounted directory will be automatically searched.

Target is Asset Registry

Is Search All Assets (Message)

Whether SearchAllAssets has been called, or was auto-called at startup. When async (editor or cooking), if SearchAllAssets has ever been called, any newly-mounted directory will be automatically searched.

Target is Asset Registry

Is Search Async

Whether searching is done async (and was started at startup), or synchronously and on-demand, requiring ScanPathsSynchronous or SearchAllAssets.

Target is Asset Registry

Is Search Async (Message)

Whether searching is done async (and was started at startup), or synchronously and on-demand, requiring ScanPathsSynchronous or SearchAllAssets.

Target is Asset Registry

Prioritize Search Path

If assets are currently being asynchronously scanned in the specified path, this will cause them to be scanned before other assets.

Target is Asset Registry

Prioritize Search Path (Message)

If assets are currently being asynchronously scanned in the specified path, this will cause them to be scanned before other assets.

Target is Asset Registry

Run Assets Through Filter

Trims items out of the asset data list that do not pass the supplied filter

Target is Asset Registry

Run Assets Through Filter (Message)

Trims items out of the asset data list that do not pass the supplied filter

Target is Asset Registry

Scan Files Synchronous

Scan the specified individual files right now and populate the asset registry. If bForceRescan is true, the paths will be scanned again, even if they were previously scanned

Target is Asset Registry

Scan Files Synchronous (Message)

Scan the specified individual files right now and populate the asset registry. If bForceRescan is true, the paths will be scanned again, even if they were previously scanned

Target is Asset Registry

Scan Modified Asset Files

Forces a rescan of specific filenames, call this when you need to refresh from disk

Target is Asset Registry

Scan Modified Asset Files (Message)

Forces a rescan of specific filenames, call this when you need to refresh from disk

Target is Asset Registry

Scan Paths Synchronous

Scan the supplied paths recursively right now and populate the asset registry. If bForceRescan is true, the paths will be scanned again, even if they were previously scanned

Target is Asset Registry

Scan Paths Synchronous (Message)

Scan the supplied paths recursively right now and populate the asset registry. If bForceRescan is true, the paths will be scanned again, even if they were previously scanned

Target is Asset Registry

Search All Assets

Look for all assets on disk (can be async or synchronous)

Target is Asset Registry

Search All Assets (Message)

Look for all assets on disk (can be async or synchronous)

Target is Asset Registry

Set Filter Tags and Values

Populates the FARFilters tags and values map with the passed in tags and values

Target is Asset Registry Helpers

Use Filter to Exclude Assets

Trims items out of the asset data list that pass the supplied filter

Target is Asset Registry

Use Filter to Exclude Assets (Message)

Trims items out of the asset data list that pass the supplied filter

Target is Asset Registry

Wait for Completion

Wait for scan to be complete. If called during editor startup before OnPostEngineInit, and there are any assets that use classes in not-yet-loaded plugin modules, WaitForCompletion will return silently with those assets still ungathered.

Target is Asset Registry

Wait for Completion (Message)

Wait for scan to be complete. If called during editor startup before OnPostEngineInit, and there are any assets that use classes in not-yet-loaded plugin modules, WaitForCompletion will return silently with those assets still ungathered.

Target is Asset Registry

Wait for Package

Wait for the scan of a specific package to be complete

Target is Asset Registry

Wait for Package (Message)

Wait for the scan of a specific package to be complete

Target is Asset Registry