UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UPackage Class Reference

#include <Package.h>

+ Inheritance diagram for UPackage:

Public Member Functions

 UPackage (const FObjectInitializer &ObjectInitializer=FObjectInitializer::Get())
 
 ~UPackage ()=default
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnPackageDirtyStateChanged, class UPackage *)
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FOnPackageSaved, const FString &, UObject *)
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnPackageSavedWithContext, const FString &, UPackage *, FObjectPostSaveContext)
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FOnPackageMarkedDirty, class UPackage *, bool)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FPreSavePackage, class UPackage *)
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FPreSavePackageWithContext, class UPackage *, FObjectPreSaveContext)
 
virtual bool IsNameStableForNetworking () const override
 
virtual bool NeedsLoadForClient () const override
 
virtual bool NeedsLoadForServer () const override
 
virtual COREUOBJECT_API bool IsPostLoadThreadSafe () const override
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None) override
 
virtual COREUOBJECT_API void PostInitProperties () override
 
virtual COREUOBJECT_API void FinishDestroy () override
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar) override
 
virtual bool IsAsset () const override
 
int32 GetPIEInstanceID () const
 
void SetPIEInstanceID (int32 InPIEInstanceID)
 
FLinkerLoadGetLinker () const
 
const FPackageFileVersionGetLinkerPackageVersion () const
 
int32 GetLinkerLicenseeVersion () const
 
const FCustomVersionContainerGetLinkerCustomVersions () const
 
void SetLoadTime (float InLoadTime)
 
float GetLoadTime () const
 
void ClearDirtyFlag ()
 
COREUOBJECT_API void SetDirtyFlag (bool bIsDirty)
 
bool IsDirty () const
 
void MarkAsFullyLoaded ()
 
COREUOBJECT_API bool IsFullyLoaded () const
 
COREUOBJECT_API void FullyLoad ()
 
COREUOBJECT_API const FPackagePathGetLoadedPath () const
 
COREUOBJECT_API void SetLoadedPath (const FPackagePath &PackagePath)
 
void SetCanBeImportedFlag (bool bInCanBeImported)
 
bool CanBeImported () const
 
void ThisContainsMap ()
 
bool ContainsMap () const
 
void ThisRequiresLocalizationGather (bool Value)
 
bool RequiresLocalizationGather () const
 
void ThisShouldLoadUncooked (const FArchive &Ar)
 
void SetPackageFlagsTo (uint32 NewFlags)
 
void SetPackageFlags (uint32 FlagsToSet)
 
void ClearPackageFlags (uint32 FlagsToClear)
 
UE_FORCEINLINE_HINT bool HasAnyPackageFlags (uint32 FlagsToCheck) const
 
UE_FORCEINLINE_HINT bool HasAllPackagesFlags (uint32 FlagsToCheck) const
 
uint32 GetPackageFlags () const
 
UE_FORCEINLINE_HINT bool IsExternallyReferenceable () const
 
UE_FORCEINLINE_HINT void SetIsExternallyReferenceable (bool bValue)
 
EAssetAccessSpecifier GetAssetAccessSpecifier () const
 
bool SetAssetAccessSpecifier (const EAssetAccessSpecifier InAccessSpecifier)
 
FWorldTileInfoGetWorldTileInfo () const
 
void SetWorldTileInfo (TUniquePtr< FWorldTileInfo > InWorldTileInfo)
 
UE_FORCEINLINE_HINT int64 GetFileSize () const
 
const TArray< int32 > & GetChunkIDs () const
 
UE_FORCEINLINE_HINT void SetChunkIDs (const TArray< int32 > &InChunkIDs)
 
UE_FORCEINLINE_HINT FPackageId GetPackageId () const
 
UE_FORCEINLINE_HINT void SetPackageId (FPackageId InPackageId)
 
UE_FORCEINLINE_HINT FPackageId GetPackageIdToLoad () const
 
COREUOBJECT_API UObjectFindAssetInPackage (EObjectFlags RequiredTopLevelFlags=RF_NoFlags) const
 
COREUOBJECT_API TArray< UPackage * > GetExternalPackages () const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Static Public Member Functions

static COREUOBJECT_API FSavePackageResultStruct Save (UPackage *InOuter, UObject *InAsset, const TCHAR *Filename, const FSavePackageArgs &SaveArgs)
 
static COREUOBJECT_API ESavePackageResult SaveConcurrent (TArrayView< FPackageSaveInfo > InPackages, const FSavePackageArgs &SaveArgs, TArray< FSavePackageResultStruct > &OutResults)
 
static COREUOBJECT_API bool SavePackage (UPackage *InOuter, UObject *InAsset, const TCHAR *Filename, const FSavePackageArgs &SaveArgs)
 
static COREUOBJECT_API void WaitForAsyncFileWrites ()
 
static COREUOBJECT_API bool HasAsyncFileWrites ()
 
static COREUOBJECT_API bool IsEmptyPackage (UPackage *Package, const UObject *LastReferencer=NULL)
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Public Attributes

uint8 bHasBeenFullyLoaded:1
 
uint8 bCanBeImported:1
 

Static Public Attributes

static COREUOBJECT_API FPreSavePackage PreSavePackageEvent
 
static COREUOBJECT_API FPreSavePackageWithContext PreSavePackageWithContextEvent
 
static COREUOBJECT_API FOnPackageSaved PackageSavedEvent
 
static COREUOBJECT_API FOnPackageSavedWithContext PackageSavedWithContextEvent
 
static COREUOBJECT_API FOnPackageDirtyStateChanged PackageDirtyStateChangedEvent
 
static COREUOBJECT_API FOnPackageMarkedDirty PackageMarkedDirtyEvent
 

Friends

class FLinkerLoad
 
class FUnsafeLinkerLoad
 
class FSaveContext
 
struct FAsyncPackage2
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Detailed Description

A package.

Constructor & Destructor Documentation

◆ UPackage()

UPackage::UPackage ( const FObjectInitializer ObjectInitializer = FObjectInitializer::Get())
inline

◆ ~UPackage()

UPackage::~UPackage ( )
default

Member Function Documentation

◆ CanBeImported()

bool UPackage::CanBeImported ( ) const
inline

Returns whether the package can be imported.

Returns
true if the package can be imported.

◆ ClearDirtyFlag()

void UPackage::ClearDirtyFlag ( )
inline

Clear the package dirty flag without any transaction tracking

◆ ClearPackageFlags()

void UPackage::ClearPackageFlags ( uint32  FlagsToClear)
inline

Set the specified flags to false. Does not affect any other flags.

Parameters
FlagsToClearPackage flags to disable

◆ ContainsMap()

bool UPackage::ContainsMap ( ) const
inline

Returns whether this package contains a ULevel or UWorld object.

Returns
true if package contains ULevel/ UWorld object, false otherwise.

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [1/2]

UPackage::DECLARE_MULTICAST_DELEGATE_OneParam ( FOnPackageDirtyStateChanged  ,
class UPackage  
)

delegate type for package dirty state events. ( Params: UPackage* ModifiedPackage )

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [2/2]

UPackage::DECLARE_MULTICAST_DELEGATE_OneParam ( FPreSavePackage  ,
class UPackage  
)

delegate type for when a package is about to be saved

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams()

UPackage::DECLARE_MULTICAST_DELEGATE_ThreeParams ( FOnPackageSavedWithContext  ,
const FString &  ,
UPackage ,
FObjectPostSaveContext   
)

delegate type for package saved events ( Params: const FString& PackageFileName, UObject* Outer, FObjectPostSaveContext ObjectSaveContext )

◆ DECLARE_MULTICAST_DELEGATE_TwoParams() [1/3]

UPackage::DECLARE_MULTICAST_DELEGATE_TwoParams ( FOnPackageMarkedDirty  ,
class UPackage ,
bool   
)

delegate type for when a package is marked as dirty via UObjectBaseUtility::MarkPackageDirty ( Params: UPackage* ModifiedPackage, bool bWasDirty )

◆ DECLARE_MULTICAST_DELEGATE_TwoParams() [2/3]

UPackage::DECLARE_MULTICAST_DELEGATE_TwoParams ( FOnPackageSaved  ,
const FString &  ,
UObject  
)

delegate type for package saved events ( Params: const FString& PackageFileName, UObject* Outer )

◆ DECLARE_MULTICAST_DELEGATE_TwoParams() [3/3]

UPackage::DECLARE_MULTICAST_DELEGATE_TwoParams ( FPreSavePackageWithContext  ,
class UPackage ,
FObjectPreSaveContext   
)

delegate type for when a package is about to be saved

◆ FindAssetInPackage()

UObject * UPackage::FindAssetInPackage ( EObjectFlags  RequiredTopLevelFlags = RF_NoFlags) const

Utility function to find Asset in this package, if any

Returns
the asset in the package, if any

◆ FinishDestroy()

void UPackage::FinishDestroy ( )
overridevirtual

Called to finish destroying the object. After UObject::FinishDestroy is called, the object's memory should no longer be accessed.

Warning
Because properties are destroyed here, Super::FinishDestroy() should always be called at the end of your child class's FinishDestroy() method, rather than at the beginning.

Reimplemented from UObject.

◆ FullyLoad()

void UPackage::FullyLoad ( )

Fully loads this package. Safe to call multiple times and won't clobber already loaded assets.

◆ GetAssetAccessSpecifier()

EAssetAccessSpecifier UPackage::GetAssetAccessSpecifier ( ) const
inline

Gets how package can be referenced from other plugins and mount points

◆ GetChunkIDs()

const TArray< int32 > & UPackage::GetChunkIDs ( ) const
inline

returns our ChunkIDs

◆ GetExternalPackages()

TArray< UPackage * > UPackage::GetExternalPackages ( ) const

Return the list of packages found assigned to object outer-ed to the top level objects of this package

Returns
the array of external packages

◆ GetFileSize()

UE_FORCEINLINE_HINT int64 UPackage::GetFileSize ( ) const
inline

returns our FileSize

◆ GetLinker()

FLinkerLoad * UPackage::GetLinker ( ) const
inline

◆ GetLinkerCustomVersions()

const FCustomVersionContainer & UPackage::GetLinkerCustomVersions ( ) const
inline

◆ GetLinkerLicenseeVersion()

int32 UPackage::GetLinkerLicenseeVersion ( ) const
inline

◆ GetLinkerPackageVersion()

const FPackageFileVersion & UPackage::GetLinkerPackageVersion ( ) const
inline

◆ GetLoadedPath()

const FPackagePath & UPackage::GetLoadedPath ( ) const

Get the path this package was loaded from; may be different than packagename, and may not be set if the package was not loaded from disk

◆ GetLoadTime()

float UPackage::GetLoadTime ( ) const
inline

Returns the time it took the last time this package was fully loaded, 0 otherwise.

Returns
Time it took to load.

◆ GetPackageFlags()

uint32 UPackage::GetPackageFlags ( ) const
inline

Gets the package flags.

Returns
The package flags.

◆ GetPackageId()

UE_FORCEINLINE_HINT FPackageId UPackage::GetPackageId ( ) const
inline

returns the unique package id

◆ GetPackageIdToLoad()

UE_FORCEINLINE_HINT FPackageId UPackage::GetPackageIdToLoad ( ) const
inline

returns the unique package id to load

◆ GetPIEInstanceID()

int32 UPackage::GetPIEInstanceID ( ) const
inline

Returns the PIE instance id used by the package if any, or INDEX_NONE otherwise

◆ GetWorldTileInfo()

FWorldTileInfo * UPackage::GetWorldTileInfo ( ) const
inline

Get the world tile info if any

◆ HasAllPackagesFlags()

UE_FORCEINLINE_HINT bool UPackage::HasAllPackagesFlags ( uint32  FlagsToCheck) const
inline

Used to safely check whether all of the passed in flags are set.

Parameters
FlagsToCheckPackage flags to check for
Returns
true if all of the passed in flags are set (including no flags passed in), false otherwise

◆ HasAnyPackageFlags()

UE_FORCEINLINE_HINT bool UPackage::HasAnyPackageFlags ( uint32  FlagsToCheck) const
inline

Used to safely check whether the passed in flag is set.

Parameters
FlagsToCheckPackage flags to check for
Returns
true if the passed in flag is set, false otherwise (including no flag passed in, unless the FlagsToCheck is CLASS_AllFlags)

◆ HasAsyncFileWrites()

bool UPackage::HasAsyncFileWrites ( )
static

Return true if SAVE_Async file writes are pending

◆ IsAsset()

virtual bool UPackage::IsAsset ( ) const
inlineoverridevirtual

Packages are never assets

Reimplemented from UObject.

◆ IsDirty()

bool UPackage::IsDirty ( ) const
inline

Returns whether the package needs to be saved.

Returns
true if the package is dirty and needs to be saved, false otherwise.

◆ IsEmptyPackage()

bool UPackage::IsEmptyPackage ( UPackage Package,
const UObject LastReferencer = NULL 
)
static

Determines if a package contains no more assets.

Parameters
Packagethe package to test
LastReferencerthe optional last UObject referencer to this package. This object will be excluded when determining if the package is empty
Returns
true if Package contains no more assets.

◆ IsExternallyReferenceable()

UE_FORCEINLINE_HINT bool UPackage::IsExternallyReferenceable ( ) const
inline
Returns
true if the package is marked as ExternallyReferenceable by all plugins and mount points

◆ IsFullyLoaded()

bool UPackage::IsFullyLoaded ( ) const

Returns whether the package is fully loaded.

Returns
true if fully loaded or no file associated on disk, false otherwise

◆ IsNameStableForNetworking()

virtual bool UPackage::IsNameStableForNetworking ( ) const
inlineoverridevirtual

IsNameStableForNetworking means an object can be referred to its path name (relative to outer) over the network

Reimplemented from UObject.

◆ IsPostLoadThreadSafe()

bool UPackage::IsPostLoadThreadSafe ( ) const
overridevirtual

Called during async load to determine if PostLoad can be called on the loading thread.

Returns
true if this object's PostLoad is thread safe

Reimplemented from UObject.

◆ MarkAsFullyLoaded()

void UPackage::MarkAsFullyLoaded ( )
inline

Marks this package as being fully loaded.

◆ NeedsLoadForClient()

virtual bool UPackage::NeedsLoadForClient ( ) const
inlineoverridevirtual

Called during saving to determine the load flags to save with the object. If false, this object will be discarded on clients

Returns
true if this object should be loaded on clients

Reimplemented from UObject.

◆ NeedsLoadForServer()

virtual bool UPackage::NeedsLoadForServer ( ) const
inlineoverridevirtual

Called during saving to determine the load flags to save with the object. If false, this object will be discarded on servers

Returns
true if this object should be loaded on servers

Reimplemented from UObject.

◆ PostInitProperties()

void UPackage::PostInitProperties ( )
overridevirtual

Called after the C++ constructor and after the properties have been initialized, but before the config has been loaded, etc. Mainly this is to emulate some behavior of when the constructor was called after the properties were initialized.

Reimplemented from UObject.

◆ Rename()

bool UPackage::Rename ( const TCHAR NewName = nullptr,
UObject NewOuter = nullptr,
ERenameFlags  Flags = REN_None 
)
overridevirtual

Rename this object to a unique name, or change its outer.

Remarks
A unique name will be generated if NewName is null and if either is true: NewOuter is null or NewOuter equals the current outer.
Parameters
NewNameThe new name of the object, if null then NewOuter should be set
NewOuterNew Outer this object will be placed within, if null it will use the current outer
FlagsFlags to specify what happens during the rename

Reimplemented from UObject.

◆ RequiresLocalizationGather()

bool UPackage::RequiresLocalizationGather ( ) const
inline

Returns whether this package contains data required to be gathered for localization.

Returns
true if package contains contains data required to be gathered for localization, false otherwise.

◆ Save()

static COREUOBJECT_API FSavePackageResultStruct UPackage::Save ( UPackage InOuter,
UObject InAsset,
const TCHAR Filename,
const FSavePackageArgs SaveArgs 
)
static

Save one specific object (along with any objects it references contained within the same Outer) into an Unreal package.

Parameters
InOuterthe outer to use for the new package
InAssetthe object that should be saved into the package
Filenamethe name to use for the new package file
SaveArgsExtended arguments to control the save
See also
FSavePackageContext
Returns
FSavePackageResultStruct enum value with the result of saving a package as well as extra data

◆ SaveConcurrent()

static COREUOBJECT_API ESavePackageResult UPackage::SaveConcurrent ( TArrayView< FPackageSaveInfo InPackages,
const FSavePackageArgs SaveArgs,
TArray< FSavePackageResultStruct > &  OutResults 
)
static

Save a list of packages concurrently using Save2 mechanism SaveConcurrent is currently experimental and shouldn't be used until it can safely replace Save.

◆ SavePackage()

static COREUOBJECT_API bool UPackage::SavePackage ( UPackage InOuter,
UObject InAsset,
const TCHAR Filename,
const FSavePackageArgs SaveArgs 
)
static

Save one specific object (along with any objects it references contained within the same Outer) into an Unreal package.

Parameters
InOuterthe outer to use for the new package
InAssetthe object that should be saved into the package
Filenamethe name to use for the new package file
SaveArgsExtended arguments to control the save
See also
FSavePackageContext
Returns
true if the package was saved successfully.

◆ Serialize()

void UPackage::Serialize ( FArchive Ar)
overridevirtual

Serializer

Serializer Save the value of bDirty into the transaction buffer, so that undo/redo will also mark/unmark the package as dirty, accordingly

Reimplemented from UObject.

◆ SetAssetAccessSpecifier()

bool UPackage::SetAssetAccessSpecifier ( const EAssetAccessSpecifier  InAccessSpecifier)
inline

Sets how the package can be referenced from other plugins and mount points

Parameters
InAccessSpecifierHow package can be referenced
Returns
true if changed

◆ SetCanBeImportedFlag()

void UPackage::SetCanBeImportedFlag ( bool  bInCanBeImported)
inline

Marks/Unmarks the package's bCanBeImported flag.

◆ SetChunkIDs()

UE_FORCEINLINE_HINT void UPackage::SetChunkIDs ( const TArray< int32 > &  InChunkIDs)
inline

sets our ChunkIDs

◆ SetDirtyFlag()

void UPackage::SetDirtyFlag ( bool  bInIsDirty)

Marks/Unmarks the package's bDirty flag, save the package to the transaction buffer if a transaction is ongoing

Marks/Unmarks the package's bDirty flag

◆ SetIsExternallyReferenceable()

UE_FORCEINLINE_HINT void UPackage::SetIsExternallyReferenceable ( bool  bValue)
inline

Sets whether or not the package is ExternallyReferenceable by all plugins and mount points

Parameters
bValueSets the package to be ExternallyReferenceable if true

◆ SetLoadedPath()

void UPackage::SetLoadedPath ( const FPackagePath PackagePath)

Set the path this package was loaded from; typically called only by the linker during load

◆ SetLoadTime()

void UPackage::SetLoadTime ( float  InLoadTime)
inline

Sets the time it took to load this package.

◆ SetPackageFlags()

void UPackage::SetPackageFlags ( uint32  FlagsToSet)
inline

Set the specified flags to true. Does not affect any other flags.

Parameters
FlagsToSetPackage flags to enable

◆ SetPackageFlagsTo()

void UPackage::SetPackageFlagsTo ( uint32  NewFlags)
inline

Sets all package flags to the specified values.

Parameters
NewFlagsNew value for package flags

◆ SetPackageId()

UE_FORCEINLINE_HINT void UPackage::SetPackageId ( FPackageId  InPackageId)
inline

sets the unique package id

◆ SetPIEInstanceID()

void UPackage::SetPIEInstanceID ( int32  InPIEInstanceID)
inline

Set the PIE instance id for this package

Parameters
InPIEInstanceIDThe PIE instance id to use or INDEX_NONE to remove any id set

◆ SetWorldTileInfo()

void UPackage::SetWorldTileInfo ( TUniquePtr< FWorldTileInfo InWorldTileInfo)
inline

Set the world tile info

◆ ThisContainsMap()

void UPackage::ThisContainsMap ( )
inline

Called to indicate that this package contains a ULevel or UWorld object.

◆ ThisRequiresLocalizationGather()

void UPackage::ThisRequiresLocalizationGather ( bool  Value)
inline

Called to indicate that this package contains data required to be gathered for localization.

◆ ThisShouldLoadUncooked()

void UPackage::ThisShouldLoadUncooked ( const FArchive Ar)
inline

Call this to indicate that this package should load uncooked when possible (ie hybrid cooked editor). It requires an FArchive param to validate that we only set this flag on cooked packages. Eventually, this flag shouldn't be needed anymore, but we don't want to save this flag in source/checked in packages, in case the particular PKG flag bit is reused, as that could confuse whatever code uses that bit in the future

◆ WaitForAsyncFileWrites()

void UPackage::WaitForAsyncFileWrites ( )
static

Wait for any SAVE_Async file writes to complete

Friends And Related Symbol Documentation

◆ FAsyncPackage2

◆ FLinkerLoad

friend class FLinkerLoad
friend

◆ FSaveContext

friend class FSaveContext
friend

◆ FUnsafeLinkerLoad

friend class FUnsafeLinkerLoad
friend

Member Data Documentation

◆ bCanBeImported

uint8 UPackage::bCanBeImported

Whether this package can be imported, i.e. its package name is a package that exists on disk. Note: This includes all normal packages where the Name matches the FileName and localized packages shadowing an existing source package, but excludes level streaming packages with /Temp/ names.

◆ bHasBeenFullyLoaded

uint8 UPackage::bHasBeenFullyLoaded
mutable

Whether this package has been fully loaded (aka had all it's exports created) at some point.

◆ PackageDirtyStateChangedEvent

UPackage::FOnPackageDirtyStateChanged UPackage::PackageDirtyStateChangedEvent
static

Delegate to notify subscribers when the dirty state of a package is changed. Allows the editor to register the modified package as one that should be prompted for source control checkout. Use Package->IsDirty() to get the updated dirty state of the package

◆ PackageMarkedDirtyEvent

UPackage::FOnPackageMarkedDirty UPackage::PackageMarkedDirtyEvent
static

Delegate to notify subscribers when a package is marked as dirty via UObjectBaseUtility::MarkPackageDirty Note: Unlike FOnPackageDirtyStateChanged, this is always called, even when the package is already dirty Use bWasDirty to check the previous dirty state of the package Use Package->IsDirty() to get the updated dirty state of the package

◆ PackageSavedEvent

UPackage::FOnPackageSaved UPackage::PackageSavedEvent
static

◆ PackageSavedWithContextEvent

UPackage::FOnPackageSavedWithContext UPackage::PackageSavedWithContextEvent
static

Delegate to notify subscribers when a package has been saved. This is triggered when the package saving has completed and was successful.

◆ PreSavePackageEvent

UPackage::FPreSavePackage UPackage::PreSavePackageEvent
static

◆ PreSavePackageWithContextEvent

UPackage::FPreSavePackageWithContext UPackage::PreSavePackageWithContextEvent
static

Delegate to notify subscribers when a package is about to be saved.


The documentation for this class was generated from the following files: