CoreUObject

8 views

52 entries in this module.

class Classes (1)

UObject BP The base class of all Unreal Engine objects.

struct Structs (5)

FSoftObjectPath A string-based reference to a UObject asset stored as a top-level asset path plus an optional sub-object path. TSoftClassPtr A soft reference to a UClass (Blueprint or C++) that stores the class path as a string rather than keeping the class loaded. TSoftObjectPtr A typed soft reference to a UObject asset that stores the asset path as a string. TSubclassOf A UClass wrapper that enforces a type constraint at edit time and in C++. TWeakObjectPtr A weak reference to a UObject that does not prevent garbage collection.

function Global Functions (43)

FSoftObjectPath::AddPIEPackageName Registers a PIE duplicate package name so that FixupForPIE knows which packages have been duplicated for the current PIE session. FSoftObjectPath::AppendString Appends the full path string representation to an existing FString or string builder without allocating a new string. FSoftObjectPath::ClearPIEPackageNames Clears the global set of registered PIE package names, typically called when a PIE session ends to prevent stale fixup state. FSoftObjectPath::ExportTextItem Serializes the soft object path to a human-readable string for use in property copy/paste, config files, and T3D export. FSoftObjectPath::FixupCoreRedirects Applies core redirects (from DefaultEngine. FSoftObjectPath::FixupForPIE Remaps the path's package name to the PIE-prefixed duplicate so that soft references resolve to the correct PIE world copy rather than the editor asset. FSoftObjectPath::ImportTextItem Parses a text string (the complement of ExportTextItem) back into a soft object path, advancing the buffer pointer past the consumed token. FSoftObjectPath::LoadAsync Initiates an asynchronous load of the referenced asset and returns a request ID. FSoftObjectPath::PostLoadPath Called after the path is deserialized to apply core redirects and any other post-load fixup, updating the path in place. FSoftObjectPath::PreSavePath Called by the save system immediately before an asset is saved; resolves any pending core redirects so the on-disk path is always up to date. FSoftObjectPath::RemapPackage If this path's package component matches OldPackageName, replaces it with NewPackageName and returns true. FSoftObjectPath::Reset Clears both the asset path and the sub-path string, returning the soft object path to an empty (null) state. FSoftObjectPath::SerializeFromMismatchedTag Handles backward-compatible loading when an on-disk property type does not match FSoftObjectPath — for example, when a property was previously a raw FString or FName asset reference and has since been converted to a soft reference. FSoftObjectPath::SerializePath Serializes the soft object path to or from an archive, applying post-load fixup (core redirects, PIE remapping) on load. FSoftObjectPath::SerializePathWithoutFixup Serializes the raw path bytes without applying PostLoadPath fixup, preserving the original on-disk string exactly as stored. FSoftObjectPath::SetPath Replaces the entire path (asset path and any sub-object path) of this FSoftObjectPath. FSoftObjectPath::SetSubPathString Sets only the sub-object path portion of this FSoftObjectPath, leaving the top-level asset path (package and asset name) unchanged. FSoftObjectPath::ToString BP Returns the full path as an FString in the form `/Package/Path. FSoftObjectPath::TryLoad Synchronously loads the referenced asset via LoadObject and returns the result. TSoftClassPtr::LoadAsync Kicks off an asynchronous load of the class asset and returns a request ID. TSoftClassPtr::LoadSynchronous Synchronously loads the class referenced by this soft pointer if it is not already in memory, then returns it. TSoftClassPtr::Reset Clears the soft class pointer back to the null state, releasing both the cached weak pointer and the stored soft object path. TSoftClassPtr::ResetWeakPtr Clears only the cached weak object pointer while preserving the soft path string, forcing a fresh resolve on the next Get() call. TSoftClassPtr::UE_REQUIRES Template constraint on TSoftClassPtr's converting constructor and assignment operators. TSoftObjectPtr::LoadAsync Starts an asynchronous load of the referenced asset and returns a request ID. TSoftObjectPtr::LoadSynchronous Synchronously loads the referenced asset if it is not already in memory and returns a typed T* pointer. TSoftObjectPtr::Reset Clears the soft object pointer to a fully null state, erasing both the stored soft path and the cached weak reference. TSoftObjectPtr::ResetWeakPtr Clears only the internal weak object pointer cache without touching the stored soft object path, forcing the next Get() call to re-resolve the path from scratch. TSoftObjectPtr::UE_REQUIRES (constrained conversion constructor) Constrained conversion constructor that copies a TSoftObjectPtr<U> into a TSoftObjectPtr<T> only when U* is implicitly convertible to T*. TSoftObjectPtr::UE_SOFTOBJECTPTR_CONVERSION_DEPRECATED (deprecated conversion overloads) deprecated Deprecated conversion constructor selected when U* is not convertible to T*, introduced in UE 5. TSubclassOf::UE_REQUIRES (constrained conversion constructor) Constrained conversion constructor that allows a TSubclassOf<Derived> to be implicitly converted to a TSubclassOf<Base> only when Derived* is convertible to Base*. UClass::GetDefaultObject Returns the Class Default Object (CDO) for this UClass — the shared archetype that holds default property values for all instances. UE_SOFTOBJECTPATH_FSTRING_DEPRECATED A gating macro that controls whether FSoftObjectPath's wide-string-subpath overloads emit UE_DEPRECATED compiler warnings. UObject::GetClass Returns the UClass that describes this object's type, fields, and metadata. UObject::GetName Returns the object's name without any path or package prefix as an FString, e. UObject::GetOuter Returns the UObject that directly owns this object in the outer chain. UObject::GetTypedOuter Walks up the outer chain and returns the first object of type T, or null if none is found. UObject::GetWorld Returns the UWorld this object belongs to. UObject::Implements Returns true if this object's class implements the specified UInterface. UObject::IsA Returns true if this object's class is T or a subclass of T. UObject::IsValid Global helper function that returns true if the given UObject pointer is non-null and has not been marked for garbage collection. UObject::MarkAsGarbage Marks this UObject to be destroyed by the garbage collector on the next GC pass. UObject::PostInitProperties Called after all UPROPERTY fields have been initialized to their default values (from the CDO or inline initializers).

property Properties (3)

TSoftClassPtr::SoftObjectPtr The underlying untyped soft object pointer that stores the path and weak reference to the class asset. TSoftObjectPtr::SoftObjectPtr The underlying untyped FSoftObjectPtr that stores both the soft path string and a cached weak reference to the loaded UObject. TSubclassOf::Class The raw UClass pointer wrapped by TSubclassOf.