UObjectLibrary

Class that holds a library of Objects

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/ObjectLibrary.h
Include #include "Engine/ObjectLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UObjectLibrary : public UObject

Remarks

Class that holds a library of Objects

Variables

  Type Name Description
Protected variable TArray< FAssetData > AssetDataList Asset data of objects that will belong in library, possibly not loaded yet
Public variable UProperty Category, EditAnywhere bool bHasBlueprintClasses True if this library holds blueprint classes, false if it holds other objects
Public variable bool bIncludeOnlyOnDiskAssets Whether to set bIncludeOnlyOnDiskAssets when setting up AR filters for discovering asset data
Protected variable UProperty Transient bool bIsFullyLoaded True if we've already fully loaded this library, can't do it twice
Public variable bool bIsGlobalAsyncScanEnvironment True if we are running a build that is already scanning assets globally so we can perhaps avoid scanning paths synchronously
Public variable bool bRecursivePaths Whether to set bRecursivePaths when setting up AR filters for discovering asset data
Protected variable UProperty Transient bool bUseWeakReferences If this library should use weak pointers
Public variable TArray< FString > DeferredAssetDataPaths The paths that we will query again once assets are finished being discovered
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< UClass > ObjectBaseClass Class that Objects must be of.
Protected variable UProperty Category, EditAnywhere TArray< TObjectPtr< UObject > > Objects List of Objects in library
Protected variable FObjectLibraryOnObjectAdded OnObjectAddedEvent Delegates for when an object is added or removed from this library.
Protected variable FObjectLibraryOnObjectRemoved OnObjectRemovedEvent  
Protected variable UProperty TArray< TWeakObjectPtr< UObject > > WeakObjects Weak pointers to objects

Constructors

  Type Name Description
Public function  

UObjectLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual bool

AddObject ( UObject* NewObject
)

 Attempt to add a new Object, return true if added
Public function Virtual void Clears the current loaded objects and asset data
Public function Static UObjectLibrary *

CreateLibrary ( UClass* InBaseClass,
bool bInHasBlueprintClasses,
bool bInUseWeak
)

 Static function to create a new ObjectLibrary at runtime, with various options set There is now a better version of this functionality in AssetManager, if you are creating many game-specific libraries you should switch to using AssetManager instead
Public function Const int32 Returns the number of objects
Public function Virtual void

GetAssetDataList ( TArray< FAssetData >& OutAssetData
)

 Returns the list of asset data
Public function Const int32 Returns the number of objects
Public function void

GetObjects ( TArray< T* >& OutObjects
)

 Fills in a passed in array of objects, casts to proper type
Public function Const bool  
Public function Virtual int32

LoadAssetDataFromPath ( const FString& Path
)

  
Public function Virtual int32

LoadAssetDataFromPaths ( const TArray< FString >& Paths,
bool bForceSynchronousScan
)

 Gets asset data for assets in a subdirectory. Returns number of assets data loaded
Public function Virtual int32 Load all of the objects in asset data list into memory
Public function Virtual int32

LoadAssetsFromPath ( const FString& Path
)

  
Public function Virtual int32

LoadAssetsFromPaths ( const TArray< FString >& Paths
)

 Load an entire subdirectory of assets into this object library. Returns number of assets loaded
Public function Virtual int32  
Public function Virtual int32

LoadBlueprintAssetDataFromPaths ( const TArray< FString >& Paths,
bool bForceSynchronousScan
)

 Load an entire subdirectory of blueprints into this object library.
Public function Virtual int32  
Public function Virtual int32

LoadBlueprintsFromPaths ( const TArray< FString >& Paths
)

 Load an entire subdirectory of blueprints into this object library.
Public function Virtual void Handler for when assets have finished scanning in the asset registry
Public function FObjectLibraryOnObjectAdded &  
Public function FObjectLibraryOnObjectRemoved &  
Public function Virtual bool

RemoveObject ( UObject* ObjectToRemove
)

 Attempt to remove an Object from the object, return true if removed
Public function Virtual void

UseWeakReferences ( bool bSetUseWeak
)

 Set rather this library is using weak or strong references

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Classes

  Type Name Description
Public class FObjectLibraryOnObjectAdded    
Public class FObjectLibraryOnObjectRemoved    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page