UNiagaraBaselineController

Base class for baseline controllers.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraPerfBaseline.h

Include

#include "NiagaraPerfBaseline.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, EditInlineNew, BlueprintType, Blueprintable)
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

Name Description

Public variable UProperty Category BlueprintReadOnly

UNiagaraEffectT...

 

EffectType

The effect type this controller is in use by.

Public variable UProperty Category BlueprintReadOnly

ANiagaraPerfBas...

 

Owner

The owning actor for this baseline controller.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

TestDuration

Duration to gather performance stats for the given system.

Functions

Name Description

Public function UFunction BlueprintCallable, Category

UNiagaraSyst...

 

GetSystem()

Returns the System for this baseline. Will synchronously load the system if needed.

Public function UFunction blueprintnativeevent

void

 

OnBeginTest()

Called from the stats system when we begin gathering stats for the given System asset.

Public function UFunction blueprintnativeevent

void

 

OnEndTest

(
    FNiagaraPerfBaselineStats Stats
)

Called from the stats system on completion of the test with the final stats for the given system asset.

Public function UFunction blueprintnativeevent

void

 

OnOwnerTick

(
    float DeltaTime
)

Called when the owning actor is ticked.

Public function UFunction blueprintnativeevent

bool

 

OnTickTest()

Returns whether the baseline test is complete.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss