unreal.NiagaraBaselineController

class unreal.NiagaraBaselineController(outer=None, name='None')

Bases: unreal.Object

Base class for baseline controllers. These can are responsible for spawning and manipulating the FX needed for the baseline perf tests.

C++ Source:

• Plugin: Niagara

• Module: Niagara

• File: NiagaraPerfBaseline.h

Editor Properties: (see get_editor_property/set_editor_property)

• effect_type (NiagaraEffectType): [Read-Write] Effect Type: The effect type this controller is in use by.

• owner (NiagaraPerfBaselineActor): [Read-Write] Owner: The owning actor for this baseline controller.

• system (NiagaraSystem): [Read-Write] System: The baseline system to spawn.

• test_duration (float): [Read-Write] Test Duration: Duration to gather performance stats for the given system.

property effect_type

[Read-Only] Effect Type: The effect type this controller is in use by.

Type

(NiagaraEffectType)

get_system() → NiagaraSystem

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

Return type

NiagaraSystem

on_begin_test() → None

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

on_end_test(stats) → None

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

Parameters

stats (NiagaraPerfBaselineStats) –

on_owner_tick(delta_time) → None

Called when the owning actor is ticked.

Parameters

delta_time (float) –

on_tick_test() → bool

Returns whether the baseline test is complete.

Return type

bool

property owner

[Read-Only] Owner: The owning actor for this baseline controller.

Type

(NiagaraPerfBaselineActor)

property test_duration

[Read-Write] Test Duration: Duration to gather performance stats for the given system.

Type

(float)