Class AssetRegistry

Asset Registry

Inheritance

System.Object

UObject

Interface

AssetRegistry

Inherited Members

UObject.TransientPackage

UObject.CastTo<T>(UObject)

UObject.CastTo(UObject, Type)

UObject.RemoveObject(UObject)

UObject.MakeObjectArrayField<T>(NativeArray*)

UObject.NotImplemented<T>()

UObject.Construct()

UObject.GetHashCode()

UObject.GetName()

UObject.ToString()

UObject.Name

UObject._None

UObject.None

UObject.ObjPointer

UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)

UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)

UObject.GetPropertyFor<T>(Name)

UObject.ExecuteUbergraph

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: UE4.AssetRegistry

Assembly: UE4DotNet.dll

Syntax

public class AssetRegistry : Interface

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration

public static AssetRegistry DefaultObject { get; }

Property Value

Type	Description
AssetRegistry

| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration

public static Class StaticClass { get; }

Property Value

Type	Description
Class

Methods

| Improve this Doc View Source

GetAllAssets(Boolean)

Gets asset data for all assets in the registry.

Declaration

public (IReadOnlyCollection<AssetData>, bool) GetAllAssets(bool bIncludeOnlyOnDiskAssets)

Parameters

Type	Name	Description
System.Boolean	bIncludeOnlyOnDiskAssets

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<AssetData>, System.Boolean>

Remarks

This method may be slow, use a filter if possible to avoid iterating over the entire registry.

@param OutAssetData the list of assets in this path

| Improve this Doc View Source

GetAllCachedPaths()

Gets a list of all paths that are currently cached

Declaration

public IReadOnlyCollection<string> GetAllCachedPaths()

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<System.String>

| Improve this Doc View Source

GetAssetByObjectPath(Name, Boolean)

Gets the asset data for the specified object path @

Declaration

public AssetData GetAssetByObjectPath(Name ObjectPath, bool bIncludeOnlyOnDiskAssets)

Parameters

Type	Name	Description
Name	ObjectPath
System.Boolean	bIncludeOnlyOnDiskAssets

Returns

Type	Description
AssetData

Remarks

param ObjectPath the path of the object to be looked up @param bIncludeOnlyOnDiskAssets if true, in-memory objects will be ignored. The call will be faster. @return the assets data;Will be invalid if object could not be found

| Improve this Doc View Source

GetAssets(ARFilter)

Gets asset data for all assets that match the filter.

Declaration

public (IReadOnlyCollection<AssetData>, bool) GetAssets(ARFilter Filter)

Parameters

Type	Name	Description
ARFilter	Filter

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<AssetData>, System.Boolean>

Remarks

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.

@param Filter filter to apply to the assets in the AssetRegistry @param OutAssetData the list of assets in this path

| Improve this Doc View Source

GetAssetsByClass(Name, Boolean)

Gets asset data for all assets with the supplied class @

Declaration

public (IReadOnlyCollection<AssetData>, bool) GetAssetsByClass(Name ClassName, bool bSearchSubClasses)

Parameters

Type	Name	Description
Name	ClassName
System.Boolean	bSearchSubClasses

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<AssetData>, System.Boolean>

Remarks

param ClassName the class name of the assets requested @param OutAssetData the list of assets in this path @param bSearchSubClasses if true, all subclasses of the passed in class will be searched as well

| Improve this Doc View Source

GetAssetsByPackageName(Name, Boolean)

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

Declaration

public (IReadOnlyCollection<AssetData>, bool) GetAssetsByPackageName(Name PackageName, bool bIncludeOnlyOnDiskAssets)

Parameters

Type	Name	Description
Name	PackageName
System.Boolean	bIncludeOnlyOnDiskAssets

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<AssetData>, System.Boolean>

Remarks

param PackageName the package name for the requested assets @param OutAssetData the list of assets in this path

| Improve this Doc View Source

GetAssetsByPath(Name, Boolean, Boolean)

Gets asset data for all assets in the supplied folder path @

Declaration

public (IReadOnlyCollection<AssetData>, bool) GetAssetsByPath(Name PackagePath, bool bRecursive, bool bIncludeOnlyOnDiskAssets)

Parameters

Type	Name	Description
Name	PackagePath
System.Boolean	bRecursive
System.Boolean	bIncludeOnlyOnDiskAssets

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<AssetData>, System.Boolean>

Remarks

param PackagePath the path to query asset data in @param OutAssetData the list of assets in this path @param bRecursive if true, all supplied paths will be searched recursively

| Improve this Doc View Source

GetSubPaths(String, Boolean)

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

Declaration

public IReadOnlyCollection<string> GetSubPaths(string InBasePath, bool bInRecurse)

Parameters

Type	Name	Description
System.String	InBasePath
System.Boolean	bInRecurse

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<System.String>

| Improve this Doc View Source

HasAssets(Name, Boolean)

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

Declaration

public bool HasAssets(Name PackagePath, bool bRecursive)

Parameters

Type	Name	Description
Name	PackagePath
System.Boolean	bRecursive

Returns

Type	Description
System.Boolean

Remarks

param PackagePath the path to query asset data in @param bRecursive if true, the supplied path will be tested recursively

| Improve this Doc View Source

IsLoadingAssets()

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

Declaration

public bool IsLoadingAssets()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration

public static AssetRegistry New(UObject obj = null, Name name = default(Name))

Parameters

Type	Name	Description
UObject	obj
Name	name

Returns

Type	Description
AssetRegistry

| Improve this Doc View Source

PrioritizeSearchPath(String)

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

Declaration

public void PrioritizeSearchPath(string PathToPrioritize)

Parameters

Type	Name	Description
System.String	PathToPrioritize

| Improve this Doc View Source

RunAssetsThroughFilter(ARFilter)

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

Declaration

public IReadOnlyCollection<AssetData> RunAssetsThroughFilter(ARFilter Filter)

Parameters

Type	Name	Description
ARFilter	Filter

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<AssetData>

| Improve this Doc View Source

ScanFilesSynchronous(Byte, Boolean)

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

Declaration

public void ScanFilesSynchronous(byte InFilePaths, bool bForceRescan)

Parameters

Type	Name	Description
System.Byte	InFilePaths
System.Boolean	bForceRescan

| Improve this Doc View Source

ScanModifiedAssetFiles(Byte)

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

Declaration

public void ScanModifiedAssetFiles(byte InFilePaths)

Parameters

Type	Name	Description
System.Byte	InFilePaths

| Improve this Doc View Source

ScanPathsSynchronous(Byte, Boolean)

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

Declaration

public void ScanPathsSynchronous(byte InPaths, bool bForceRescan)

Parameters

Type	Name	Description
System.Byte	InPaths
System.Boolean	bForceRescan

| Improve this Doc View Source

SearchAllAssets(Boolean)

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

Declaration

public void SearchAllAssets(bool bSynchronousSearch)

Parameters

Type	Name	Description
System.Boolean	bSynchronousSearch

Operators

| Improve this Doc View Source

Implicit(IntPtr to AssetRegistry)

Convert from IntPtr to UObject

Declaration

public static implicit operator AssetRegistry(IntPtr p)

Parameters

Type	Name	Description
System.IntPtr	p

Returns

Type	Description
AssetRegistry