Navigation
API > API/Plugins > API/Plugins/Niagara
Base class for baseline controllers. These can are responsible for spawning and manipulating the FX needed for the baseline perf tests.
| Name | UNiagaraBaselineController |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraPerfBaseline.h |
| Include Path | #include "NiagaraPerfBaseline.h" |
Syntax
UCLASS (Abstract, EditInlineNew, BlueprintType, Blueprintable, MinimalAPI)
class UNiagaraBaselineController : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraBaselineController
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EffectType | TObjectPtr< UNiagaraEffectType > | The effect type this controller is in use by. | NiagaraPerfBaseline.h |
|
| Owner | TObjectPtr< ANiagaraPerfBaselineActor > | The owning actor for this baseline controller. | NiagaraPerfBaseline.h |
|
| TestDuration | float | Duration to gather performance stats for the given system. | NiagaraPerfBaseline.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| System | TSoftObjectPtr< UNiagaraSystem > | The baseline system to spawn. | NiagaraPerfBaseline.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraSystem * GetSystem() |
Returns the System for this baseline. Will synchronously load the system if needed. | NiagaraPerfBaseline.h |
|
void OnBeginTest() |
Called from the stats system when we begin gathering stats for the given System asset. | NiagaraPerfBaseline.h |
|
void OnEndTest
(
FNiagaraPerfBaselineStats Stats |
Called from the stats system on completion of the test with the final stats for the given system asset. | NiagaraPerfBaseline.h |
|
void OnOwnerTick
(
float DeltaTime |
Called when the owning actor is ticked. | NiagaraPerfBaseline.h |
|
bool OnTickTest() |
Returns whether the baseline test is complete. | NiagaraPerfBaseline.h |
|