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