Navigation
API > API/Plugins > API/Plugins/NiagaraEditor > API/Plugins/NiagaraEditor/Commandlets
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&40;Config&61;Editor&41;
class UNiagaraSystemAuditCommandlet : public UCommandlet
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FString | AuditOutputFolder | The folder in which the commandlet's output files will be stored |
 |
bool | bCaptureDataInterfaceUsage | |
 |
bool | bRendererDetailed | Detailed renderer information. |
 |
TArray< class UDeviceProfile * > | DeviceProfilesToDisableGpu | DeviceProfiles we want to disable GPU emitters for. |
 |
FString | FilterCollection | Only assets in this collection will be considered. |
 |
TMap< FName, FDataInterfaceUsage > | NiagaraDataInterfaceUsage | |
 |
TSet< FString > | NiagaraRibbonRenderers | |
 |
TSet< FString > | NiagaraSystemsWithDynamicBounds | All Niagara systems that contain emitters with dynamic bounds |
 |
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 > | NiagaraSystemsWithSimulationStages | All Niagara Systems & Emitters with simulation stages enabled |
 |
TSet< FString > | NiagaraSystemsWithUserDataInterface | All Niagara systems that use a user requested data interface |
 |
TSet< FString > | NiagaraSystemsWithWarmup | All Niagara systems with warmup time |
 |
TUniquePtr< FArchive > | NiagaraValidationIssues | All Validation Issues |
 |
TArray< FName > | PackagePaths | Package paths to include |
  |
TArray< TObjectPtr< UPackage > > | PackagesToSave | |
 |
TSet< UClass * > | UserDataInterfacesToFind | Systems using specific data interfaces to find |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UNiagaraSystemAuditCommandlet
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | DumpResults () |
Dump the results of the audit |
 |
bool | DumpSimpleSet
(
TSet< FString >& InSet, |
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 | Process all referenced Niagara systems |
Overridden from UCommandlet
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FDataInterfaceUsage | Optional list of data interface usage |