Asset Registry

Asset Registry

Windows
MacOS
Linux
On this page

Actions

Get All Assets (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 Sub Paths (Interface Call)

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 (Interface Call)

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 (Interface Call)

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

Prioritize Search Path (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 (Interface Call)

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 (Interface Call)

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

Target is Asset Registry

Use Filter to Exclude Assets (Message)

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

Target is Asset Registry

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback