1. Epic GamesDeveloper
  3. UBaseIteratePackagesCommandlet

UBaseIteratePackagesCommandlet

Added to expose this to the save packages test Base commandlet used to iterate packages provided on a commandline has callbacks for processing each package

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Commandlets

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Classes/Commandlets/BaseIteratePackagesCommandlet.h
Include #include "Commandlets/BaseIteratePackagesCommandlet.h"

Syntax

class UBaseIteratePackagesCommandlet : public UCommandlet

Remarks

Added to expose this to the save packages test Base commandlet used to iterate packages provided on a commandline has callbacks for processing each package

Variables

  Type Name Description
Protected variable bool bAutoCheckIn If we should auto checkin packages that were checked out
Protected variable bool bAutoCheckOut If we should auto checkout packages that need to be saved
Protected variable bool bBatchSourceControl If we should batch together source control operations rather than submit them one at a time
Protected variable bool bCanIgnoreFails Skip the assert when a package can not be opened
Protected variable bool bForceFinishAllCompilationBeforeGC Should we build lighting for the packages we are saving? Should we build reflection captures for the packages we are saving? Should we build texture streaming for the packages we are saving? Similar to above, but applies to all packages rather than just maps
Protected variable bool bForceUATEnvironmentVariableSet Bool bHLODMapCleanup; FString ForceHLODSetupAsset; FString HLODSkipToMap;
Protected variable bool bIgnoreChangelist Should we build navigation data for the packages we are saving? Ignore package version changelist
Protected variable bool bKeepPackageGUIDOnSave  
Protected variable bool bOnlyLicenseed Only save packages that been saved by a licensee
Protected variable bool bOnlyMaterials Only process packages containing materials
Protected variable bool bOnlyPayloadTrailers Only save packages containing FPayloadTrailers
Protected variable bool bOnlySaveDirtyPackages If we should only save dirty packages
Protected variable bool bOnlyUnversioned Only save packages with a changelist of zero
Protected variable bool bOnlyVirtualized Only save packages containing bulkdata payloads that have been virtualized
Protected variable bool bResaveOnDemand  
Protected variable bool bSkipCheckedOutFiles If we should simply skip checked out files rather than error-ing out
Protected variable bool bSkipSubLevels Should we update HLODs bool bShouldBuildHLOD; bool bGenerateClusters; bool bGenerateMeshProxies; bool bForceClusterGeneration; bool bForceProxyGeneration; bool bForceSingleClusterForLevel;
Protected variable bool bStripEditorOnlyContent Strip editor only content
Protected variable bool bUseWorldPartitionBuilder  
Protected variable bool bVerifyContent Load all packages, and display warnings for those packages which would have been resaved but were read-only
Protected variable TSet< FName > CollectionFilter Filter packages based on a collection
Protected variable TArray< FString > FilesToSubmit Lighting Build Quality(default: Production) List of files to submit
Protected variable int32 GarbageCollectionFrequency Only collect garbage after N packages
Protected variable int32 MaxPackagesToResave Maximum number of packages to resave to avoid having a massive sync A value of -1 (default) removes this limitation.
Protected variable int32 MaxResaveLicenseeUEVersion Limits processing to packages with this licensee package version or lower.
Protected variable int32 MaxResaveUEVersion Limits processing to packages with this UE4 package version or lower.
Protected variable int32 MinResaveUEVersion Only packages that have this version or higher will be processed; a value of IGNORE_PACKAGE_VERSION indicates that there is no minimum package version
Protected variable int32 PackagesConsideredForResave Running count of packages that got modified and will need to be resaved
Protected variable int32 PackagesDeleted  
Protected variable int32 PackagesResaved  
Protected variable FString PackageSubstring If non-empty, this substring has to be present in the package name for the commandlet to process it.
Protected variable TArray< FString > ResaveClasses Allows users to save only packages with a particular class in them (useful for fixing content)
Protected variable TSet< FName > ResaveOnDemandPackages If running resaveondemand, only packages reported into this set are resaved.
Protected variable FCriticalSection ResaveOnDemandPackagesLock  
Protected variable TSet< FName > ResaveOnDemandSystems  
Protected variable TPimplPtr< class FQueuedSourceControlOperations > SourceControlQueue List of redirector packages that should be fixed up at the end A queue containing source control operations to be performed in batches.
Protected variable TArray< FString > Switches The list of switches that were passed on the commandline
Protected variable int32 TotalPackagesForResave  
Protected variable EBrevity Verbosity  

Constructors

  Type Name Description
Public function  

UBaseIteratePackagesCommandlet ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function bool

CanCheckoutFile ( const FString& Filename,
FString& CheckedOutUser
)

  
Protected function Const void

CheckInFiles ( const TArray< FString >& InFilesToSubmit,
const FText& InDescription
)

  
Protected function void

CheckoutAndSavePackage ( UPackage* Package,
TArray< FString >& SublevelFilenames,
bool bIgnoreAlreadyCheckedOut
)

  
Protected function bool

CheckoutFile ( const FString& Filename,
bool bAddFile,
bool bIgnoreAlreadyCheckedOut
)

  
Protected function bool Removes any UClass exports from packages which aren't script packages.
Protected function void Delete the remaining files in the temporary files directory for the commandlet.
Protected function FString Creates and returns a unique filename in the temporary file directory.
Protected function Virtual void

DeleteOnePackage ( const FString& Filename
)

 Deletes a single package
Protected function Virtual Const FText Get the changelist description to use if automatically checking packages out.
Protected function FString Returns the path of the directory we use to store all temporary files for this commandlet.
Protected function Virtual void

InitializePackageNames ( const TArray< FString >& Tokens,
TArray< FString >& MapPathNames,
bool& bExplicitPackages
)

  
Protected function Virtual int32

InitializeParameters ( const TArray< FString >& Tokens,
TArray< FString >& MapPathNames
)

 Evaluates the command-line to determine which maps to check.
Protected function Virtual void

LoadAndSaveOnePackage ( const FString& Filename
)

 Loads and saves a single package
Protected function void

OnAddResaveOnDemandPackage ( FName SystemName,
FName PackageName
)

  
Protected function TSet< FName > Parse commandline to decide whether resaveondemand is activated for the given system.
Protected function void  
Protected function Virtual void

PerformAdditionalOperations ( UObject* Object,
bool& bSavePackage
)

 Allows the commandlet to perform any additional operations on the object before it is resaved.
Protected function Virtual void

PerformAdditionalOperations ( UPackage* Package,
bool& bSavePackage
)

 Allows the commandlet to perform any additional operations on the package before it is resaved.
Protected function Virtual void

PerformAdditionalOperations ( UWorld* World,
bool& bSavePackage
)

 Allows the commandlet to perform any additional operations on the world before it is resaved.
Protected function Virtual void

PerformPreloadOperations ( FLinkerLoad* PackageLinker,
bool& bSavePackage
)

 Allow the commandlet to perform any operations on the export/import table of the package before all objects in the package are loaded.
Protected function Virtual void

PerformWorldBuilderAdditionalOperations ( AActor* Actor,
bool& bSavePackage
)

  
Protected function Virtual void

PerformWorldBuilderAdditionalOperations ( UObject* Object,
bool& bSavePackage
)

  
Protected function Virtual void  
Protected function Virtual void Allows the commandlet to do something after all the packages have been processed
Protected function bool

RevertFile ( const FString& Filename
)

  
Protected function Virtual bool

ShouldSkipPackage ( const FString& Filename
)

 Checks to see if a package should be skipped
Protected function void

VerboseMessage ( const FString& Message
)

 Print out a message only if running in very verbose mode.
Protected function Virtual void  

Overridden from UCommandlet

  Type Name Description
Public function Virtual int32

Main ( const FString& Params
)

 Entry point for your commandlet

Enums

  Type Name Description
Protected enum EBrevity    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page