Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
| Name | UNiagaraSystemAuditCommandlet |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/Commandlets/NiagaraSystemAuditCommandlet.h |
| Include Path | #include "Commandlets/NiagaraSystemAuditCommandlet.h" |
Syntax
UCLASS (Config=Editor)
class UNiagaraSystemAuditCommandlet : public UCommandlet
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCommandlet → UNiagaraSystemAuditCommandlet
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraSystemAuditCommandlet
(
const FObjectInitializer& ObjectInitializer |
Commandlets/NiagaraSystemAuditCommandlet.h |
Structs
| Name | Remarks |
|---|---|
| FDataInterfaceUsage | Optional list of data interface usage |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AuditOutputFolder | FString | The folder in which the commandlet's output files will be stored | Commandlets/NiagaraSystemAuditCommandlet.h | |
| bCaptureDataInterfaceUsage | bool | Commandlets/NiagaraSystemAuditCommandlet.h | ||
| bRendererDetailed | bool | Detailed renderer information. | Commandlets/NiagaraSystemAuditCommandlet.h | |
| DataInterfacesToFind | TSet< UClass * > | Systems using specific data interfaces to find | Commandlets/NiagaraSystemAuditCommandlet.h | |
| DeviceProfilesToDisableGpu | TArray< class UDeviceProfile * > | DeviceProfiles we want to disable GPU emitters for. | Commandlets/NiagaraSystemAuditCommandlet.h | |
| FilterCollection | FString | Only assets in this collection will be considered. | Commandlets/NiagaraSystemAuditCommandlet.h | |
| IncludeOnlyPackages | TSet< FName > | List of assets to only include (i.e. process only these) | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraDataInterfaceUsage | TMap< FName, FDataInterfaceUsage > | Commandlets/NiagaraSystemAuditCommandlet.h | ||
| NiagaraDataInterfaceUsageToCapture | TSet< FName > | Commandlets/NiagaraSystemAuditCommandlet.h | ||
| NiagaraRibbonRenderers | TSet< FString > | Commandlets/NiagaraSystemAuditCommandlet.h | ||
| NiagaraSystemsWithCompression | TSet< FString > | All Niagara systems with compression enabled | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithDataInterfaceToFind | TSet< FString > | All Niagara systems that contain the requested data interface | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithDynamicBounds | TSet< FString > | All Niagara systems that contain emitters with dynamic bounds | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithEvents | TSet< FString > | All Niagara systems with events | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithGPUEmitters | TSet< FString > | All Niagara systems with GPU emitters | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithLights | TSet< FString > | All Niagara systems with lights and the details | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithPrerequisites | TSet< FString > | All Niagara systems with prerequisites | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithSimulationStages | TSet< FString > | All Niagara Systems & Emitters with simulation stages enabled | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithStatelessEmitters | TSet< FString > | All Niagara systems with stateless emitters enabled | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraSystemsWithWarmup | TSet< FString > | All Niagara systems with warmup time | Commandlets/NiagaraSystemAuditCommandlet.h | |
| NiagaraValidationIssues | TUniquePtr< FArchive > | All Validation Issues | Commandlets/NiagaraSystemAuditCommandlet.h | |
| PackagePaths | TArray< FName > | Package paths to include | Commandlets/NiagaraSystemAuditCommandlet.h | |
| PackagesToSave | TArray< TObjectPtr< UPackage > > | Commandlets/NiagaraSystemAuditCommandlet.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DumpResults() |
Dump the results of the audit | Commandlets/NiagaraSystemAuditCommandlet.h | |
bool DumpSimpleSet
(
TSet< FString >& InSet, |
Generic function to handle dumping values to a CSV file | Commandlets/NiagaraSystemAuditCommandlet.h | |
FArchive * GetOutputFile
(
const TCHAR* InShortFilename |
Gets an archive to write to an output file | Commandlets/NiagaraSystemAuditCommandlet.h | |
bool ProcessNiagaraSystems() |
Process all referenced Niagara systems | Commandlets/NiagaraSystemAuditCommandlet.h |
Overridden from UCommandlet
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 Main
(
const FString& Params |
Entry point | Commandlets/NiagaraSystemAuditCommandlet.h |