Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > UObject

Light Theme

Dark Theme

UObject

Choose your operating system:

Windows

macOS

Linux

Classes

	Name	Description
	FAnimObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FAnimPhysObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FAutomationObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FBlueprintsObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FBuildObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FCineCameraObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FCoreObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FDestructionObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FDevVersionRegistration	Copyright Epic Games, Inc. All Rights Reserved.
	FEditorObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FEnterpriseObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FExternalPhysicsCustomObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FExternalPhysicsMaterialCustomObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FFortniteMainBranchObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FFortniteReleaseBranchCustomObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FFrameworkObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FGeometryObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FLazyName	Lazily constructed FName that helps avoid allocating FNames during static initialization
	FLoadTimesObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FMediaFrameworkObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FMinimalName	The minimum amount of data required to reconstruct a name This is smaller than FName, but you lose the case-preserving behavior
	FMobileObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FName	Public name, available to the world.
	FNameBuilder	A string builder with inline storage for FNames.
	FNameDebugVisualizer
	FNameEntry	A global deduplicated name stored in the global name table.
	FNameEntryHeader	Implementation detail exposed for debug visualizers
	FNameEntryId	Opaque id to a deduplicated name
	FNameEntrySerialized	This struct is only used during loading/saving and is not part of the runtime costs
	FNameFastLess	Fast non-alphabetical order that is only stable during this process' lifetime
	FNameLexicalLess	Slow alphabetical order that is stable / deterministic over process runs
	FNetworkingObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FNiagaraObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FOnlineObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FPackageFileVersion	This object combines all of our version enums into a single easy to use structure which allows us to update older version numbers independently of the newer version numbers.
	FPhysicsObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FPlatformObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FReflectionCaptureObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FReleaseObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FRenderingObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FScriptName	The full amount of data required to reconstruct a case-preserving name This will be the same size as FName when WITH_CASE_PRESERVING_NAME is 1, and is used to store an FName in cases where the size of FName must be constant between build configurations (eg, blueprint bytecode)
	FSequencerObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FUE5CookerObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FUE5LWCRenderingStreamObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FUE5MainStreamObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FUE5PrivateFrostyStreamObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FUE5ReleaseStreamObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FVirtualProductionObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	FVRObjectVersion	Copyright Epic Games, Inc. All Rights Reserved.
	TAutoWeakObjectPtr	Automatic version of the weak object pointer
	TMulticastScriptDelegate	Script multi-cast delegate base class
	TScriptDelegate	Script delegate base class.
	TWeakObjectPtr	TWeakObjectPtr is the templated version of the generic FWeakObjectPtr
	TWeakObjectPtrMapKeyFuncs	MapKeyFuncs for TWeakObjectPtrs which allow the key to become stale without invalidating the map.

Constants

Name	Description
NAME_SIZE	Maximum size of name, including the null terminator.

Typedefs

Name	Description
FNameSortIndexes
NAME_INDEX	Legacy typedef - this is no longer an index

Enums

	Name	Description
	EDebugSerializationFlags	Debug serialization flags.
	EFindName	Enumeration for finding name.
	ELinkerNameTableConstructor
	EName
	ENameCase
	EPropertyPortFlags	Property exporting flags.
	EUnrealEngineObjectLicenseeUEVersion
	EUnrealEngineObjectUE4Version	This enum is the version for UE4 and should ONLY be edited in UE4 Main branch!
	EUnrealEngineObjectUE5Version	Versioning

Functions

	Name	Description
void	AppendHash ( FBlake3& Builder, FName In )
void	CopyFromWeakArray ( DestArrayType& Dest, const SourceArrayType& Src )	Utility function to fill in a TArray from a TArray>
uint32	Freeze::IntrinsicAppendHash ( const FName* DummyObject, const FTypeLayoutDesc& TypeDesc, const FPlatformTypeLayoutParameters..., FSHA1& Hasher )
uint32	Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Cont..., const FName& Object, void* OutDst )
void	Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer, const FScriptName& Object, const FTypeLayoutDesc& )
void	Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer, const FMinimalName& Object, const FTypeLayoutDesc& )
void	Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer, const FName& Object, const FTypeLayoutDesc& )
uint32	GetTypeHash ( FScriptName Name )
uint32	GetTypeHash ( FMinimalName Name )
uint32	GetTypeHash ( FName Name )
uint32	GetTypeHash ( FNameEntryId Id )
void	LexFromString ( FName& Name, const TCHAR* Str )
FString	LexToString ( const FName& Name )
const TCHAR ...	LexToString ( EName Ename )
TArray< FNam...	LoadNameBatch ( FArchive& Ar )	Load names and precalculated hashes from an archive
void	LoadNameBatch ( TArray< FNameEntryId >& OutNames, TArrayView< const uint8 > NameData, TArrayView< const uint8 > HashData )	Load a name blob with precalculated hashes.
TFunction< T...	LoadNameBatchAsync ( FArchive& Ar, uint32 MaxWorkers )	Load names and precalculated hashes from an archive using multiple workers
TWeakObjectP...	MakeWeakObjectPtr ( T* Ptr )	Helper function which deduces the type of the initializer.
FName	MinimalNameToName ( const FMinimalName& InName )
FMinimalName	NameToMinimalName ( const FName& InName )
FScriptName	NameToScriptName ( const FName& InName )
bool	operator!= ( const FScriptName& Lhs, const FScriptName& Rhs )
bool	operator!= ( const LhsT* Lhs, const TWeakObjectPtr< RhsT, OtherTW... )
bool	operator!= ( const TWeakObjectPtr< LhsT, OtherTW..., const RhsT* Rhs )
bool	operator!= ( const TWeakObjectPtr< LhsT, OtherTW..., const TWeakObjectPtr< RhsT, OtherTW... )	Compare weak pointers for inequality
bool	operator!= ( const FScriptName& Lhs, const FName& Rhs )
bool	operator!= ( const FName& Lhs, const FScriptName& Rhs )
bool	operator!= ( const FMinimalName& Lhs, const FName& Rhs )
bool	operator!= ( const FName& Lhs, const FMinimalName& Rhs )
bool	operator!= ( FNameEntryId Id, EName Ename )
bool	operator!= ( const FMinimalName& Lhs, const FMinimalName& Rhs )
bool	operator!= ( const CharType* LHS, const FName& RHS )	Inequality operator with CharType* on left hand side and FName on right hand side
bool	operator!= ( const TWeakObjectPtr< LhsT, OtherTW..., TYPE_OF_NULLPTR )
bool	operator!= ( EName Ename, FNameEntryId Id )
bool	operator!= ( TYPE_OF_NULLPTR, const TWeakObjectPtr< RhsT, OtherTW... )
bool	operator== ( const FScriptName& Lhs, const FName& Rhs )
bool	operator== ( const FName& Lhs, const FScriptName& Rhs )
bool	operator== ( const TWeakObjectPtr< LhsT, OtherTW..., const TWeakObjectPtr< RhsT, OtherTW... )	Compare weak pointers for equality.
bool	operator== ( const TWeakObjectPtr< LhsT, OtherTW..., TYPE_OF_NULLPTR )
bool	operator== ( const FMinimalName& Lhs, const FName& Rhs )
bool	operator== ( TYPE_OF_NULLPTR, const TWeakObjectPtr< RhsT, OtherTW... )
bool	operator== ( const TWeakObjectPtr< LhsT, OtherTW..., const RhsT* Rhs )
bool	operator== ( const FName& Lhs, const FMinimalName& Rhs )
bool	operator== ( const LhsT* Lhs, const TWeakObjectPtr< RhsT, OtherTW... )
bool	operator== ( const FMinimalName& Lhs, const FMinimalName& Rhs )
bool	operator== ( const CharType* LHS, const FName& RHS )	Equality operator with CharType* on left hand side and FName on right hand side
bool	operator== ( EName Ename, FNameEntryId Id )
bool	operator== ( FNameEntryId Id, EName Ename )
bool	operator== ( const FScriptName& Lhs, const FScriptName& Rhs )
None IntProp...	REGISTER_NAME ( 260, Mobile )
None IntProp...	REGISTER_NAME ( 258, Gzip )
None IntProp...	REGISTER_NAME ( 256, Voice )
None IntProp...	REGISTER_NAME ( 254, UserDefinedEnum )
None IntProp...	REGISTER_NAME ( 252, AudioThread )
None IntProp...	REGISTER_NAME ( 250, BSP )
None IntProp...	REGISTER_NAME ( 248, Location )
None IntProp...	REGISTER_NAME ( 246, RenderThread )
None IntProp...	REGISTER_NAME ( 244, NetworkGUID )
None IntProp...	REGISTER_NAME ( 242, Low )
None IntProp...	REGISTER_NAME ( 240, Timer )
None IntProp...	REGISTER_NAME ( 236, TextureOffset1Parameter )
None IntProp...	REGISTER_NAME ( 234, ImpactVel )
None IntProp...	REGISTER_NAME ( 232, TextureOffsetParameter )
None IntProp...	REGISTER_NAME ( 230, All )
None IntProp...	REGISTER_NAME ( 226, RootStat )
None IntProp...	REGISTER_NAME ( 224, ExecuteUbergraph )
None IntProp...	REGISTER_NAME ( 222, SelectionColor )
None IntProp...	REGISTER_NAME ( 220, InitialState )
None IntProp...	REGISTER_NAME ( 218, TheWorld )
None IntProp...	REGISTER_NAME ( 216, RemoteRole )
None IntProp...	REGISTER_NAME ( 214, Map )
None IntProp...	REGISTER_NAME ( 238, ExpressionInput )
None IntProp...	REGISTER_NAME ( 280, DGram )	Online.
None IntProp...	REGISTER_NAME ( 284, BeaconNetDriver )
None IntProp...	REGISTER_NAME ( 286, DemoNetDriver )
None IntProp...	REGISTER_NAME ( 500, PerformanceCapture )	Special config names - not required to be consistent for network replication.
None IntProp...	REGISTER_NAME ( 212, Super )
None IntProp...	REGISTER_NAME ( 601, EditorKeyBindings )
None IntProp...	REGISTER_NAME ( 700, Filename )	Commonly multicased names - defined globally to prevent non-determinism in package name tables.
None IntProp...	REGISTER_NAME ( 450, AI )
None IntProp...	REGISTER_NAME ( 409, InterpCurveTwoVectors )
None IntProp...	REGISTER_NAME ( 407, InterpCurveVector2D )
None IntProp...	REGISTER_NAME ( 405, RawDistributionVector )
None IntProp...	REGISTER_NAME ( 403, SoundCue )
None IntProp...	REGISTER_NAME ( 401, InitChild2StartBone )
None IntProp...	REGISTER_NAME ( 282, GameNetDriver )
None IntProp...	REGISTER_NAME ( 356, Error )	File format backwards-compatibility.
None IntProp...	REGISTER_NAME ( 352, Init )
None IntProp...	REGISTER_NAME ( 350, PerfWarning )	Log messages.
None IntProp...	REGISTER_NAME ( 322, Spectating )
None IntProp...	REGISTER_NAME ( 312, VoiceChat )	Optimized replication.
None IntProp...	REGISTER_NAME ( 303, LightMapResolution )	REGISTER_NAME(310,)
None IntProp...	REGISTER_NAME ( 301, Point )
None IntProp...	REGISTER_NAME ( 294, LiveStreamAnimation )	Texture settings.
None IntProp...	REGISTER_NAME ( 292, MeshNetDriver )
None IntProp...	REGISTER_NAME ( 290, BeaconPort )
None IntProp...	REGISTER_NAME ( 288, PartySession )
None IntProp...	REGISTER_NAME ( 354, Cmd )
None IntProp...	REGISTER_NAME ( 210, Components )
None IntProp...	REGISTER_NAME ( 64, Matrix )
None IntProp...	REGISTER_NAME ( 206, Input )
None IntProp...	REGISTER_NAME ( 58, Name )
None IntProp...	REGISTER_NAME ( 56, IntPoint )
None IntProp...	REGISTER_NAME ( 54, Vector2D )
None IntProp...	REGISTER_NAME ( 52, Sphere )
None IntProp...	REGISTER_NAME ( 50, Cylinder )	Special types.
None IntProp...	REGISTER_NAME ( 33, CoreUObject )	More class properties.
None IntProp...	REGISTER_NAME ( 31, Engine )
None IntProp...	REGISTER_NAME ( 29, SetProperty )	Special packages.
None IntProp...	REGISTER_NAME ( 26, UInt16Property )	REGISTER_NAME(27,Available)
None IntProp...	REGISTER_NAME ( 24, UInt64Property )
None IntProp...	REGISTER_NAME ( 22, Int16Property )
None IntProp...	REGISTER_NAME ( 20, Int64Property )
None IntProp...	REGISTER_NAME ( 18, LazyObjectProperty )	REGISTER_NAME(17,Available)
None IntProp...	REGISTER_NAME ( 15, InterfaceProperty )
None IntProp...	REGISTER_NAME ( 13, StrProperty )
None IntProp...	REGISTER_NAME ( 11, VectorProperty )
None IntProp...	REGISTER_NAME ( 9, ArrayProperty )
None IntProp...	REGISTER_NAME ( 7, DelegateProperty )
None IntProp...	REGISTER_NAME ( 5, ObjectProperty )
None IntProp...	REGISTER_NAME ( 3, BoolProperty )
None	REGISTER_NAME ( 1, ByteProperty )	Class property types (name indices are significant for serialization).
None IntProp...	REGISTER_NAME ( 208, Groups )
None IntProp...	REGISTER_NAME ( 62, Color )
None IntProp...	REGISTER_NAME ( 60, Rotator )
None IntProp...	REGISTER_NAME ( 66, AdvanceFrame )
None IntProp...	REGISTER_NAME ( 204, Default )
None IntProp...	REGISTER_NAME ( 202, FALSE )
None IntProp...	REGISTER_NAME ( 200, State )	Misc.
None IntProp...	REGISTER_NAME ( 107, Function )
None IntProp...	REGISTER_NAME ( 105, Class )
None IntProp...	REGISTER_NAME ( 103, ObjectRedirector )
None IntProp...	REGISTER_NAME ( 101, Camera )
None IntProp...	REGISTER_NAME ( 94, Box2d )	Object class names.
None IntProp...	REGISTER_NAME ( 90, Vector2f )
None IntProp...	REGISTER_NAME ( 88, Rotator3f )
None IntProp...	REGISTER_NAME ( 92, Box2D )
None IntProp...	REGISTER_NAME ( 84, BoxSphereBounds3f )
None IntProp...	REGISTER_NAME ( 82, Box3f )
None IntProp...	REGISTER_NAME ( 80, Transform3f )
None IntProp...	REGISTER_NAME ( 78, Quat4f )
None IntProp...	REGISTER_NAME ( 76, Matrix44f )
None IntProp...	REGISTER_NAME ( 74, Plane4f )
None IntProp...	REGISTER_NAME ( 72, Vector3f )
None IntProp...	REGISTER_NAME ( 70, Self )
None IntProp...	REGISTER_NAME ( 68, Double )
None IntProp...	REGISTER_NAME ( 86, Vector4f )
void	ReserveNameBatch ( uint32 NameDataBytes, uint32 HashDataBytes )	Reserve memory in preparation for batch loading
FName	ScriptNameToName ( const FScriptName& InName )
bool	ShouldReplicateAsInteger ( EName Ename )	This function is deprecated, please use ShouldReplicateAsInteger(EName Ename, const class FName& Name) instead.
bool	ShouldReplicateAsInteger ( EName Ename, const FName& Name )
	UE_PUSH_MACRO ( "TRUE" )	Suppress any macros that may conflict with name constant symbols.

Variables

	Name	Description
const FPackageF...	GOldestLoadablePackageFileUEVersion
const int32	GPackageFileLicenseeUE4Version	Use GPackageFileLicenseeUEVersion instead
const int32	GPackageFileLicenseeUEVersion
const int32	GPackageFileUE4Version	Use GPackageFileUEVersion instead. See the documentation for further details
const FPackageF...	GPackageFileUEVersion