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

Light Theme

Dark Theme

UNiagaraSystemAuditCommandlet

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCommandlet

UNiagaraSystemAuditCommandlet

References

Module	NiagaraEditor
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/Commandlets/NiagaraSystemAuditCommandlet.h
Include	#include "Commandlets/NiagaraSystemAuditCommandlet.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Editor)
class UNiagaraSystemAuditCommandlet : public UCommandlet

Variables

	Name	Description
FString	AuditOutputFolder	The folder in which the commandlet's output files will be stored
FString	FilterCollection	Only assets in this collection will be considered.
TSet< FString >	NiagaraSystemsWithEvents	All Niagara systems with events
TSet< FString >	NiagaraSystemsWithGPUEmitters	All Niagara systems with GPU emitters
TSet< FString >	NiagaraSystemsWithLights	All Niagara systems with lights and the details
TSet< FString >	NiagaraSystemsWithPrerequisites	All Niagara systems with prerequisites
TSet< FString >	NiagaraSystemsWithUserDataInterface	All Niagara systems that use a user requested data interface
TSet< FString >	NiagaraSystemsWithWarmup	All Niagara systems with warmup time
TArray< FName >	PackagePaths	Package paths to include
TSet< UClass &#...	UserDataInterfacesToFind	Systems using specific data interfaces to find

Constructors

	Name	Description
	UNiagaraSystemAuditCommandlet ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	DumpResults()	Dump the results of the audit
bool	DumpSimpleSet ( TSet< FString >& InSet, const TCHAR* InShortFilename, const TCHAR* OptionalHeader )	Generic function to handle dumping values to a CSV file
FArchive ...	GetOutputFile ( const TCHAR* InShortFilename )	Gets an archive to write to an output file
bool	ProcessNiagaraSystems()	Process all referenced Niagara systems

Overridden from UCommandlet

		Name	Description
	int32	Main ( const FString& Params )	Entry point

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss