UNiagaraComponent

Inheritance Hierarchy

Syntax

class UNiagaraComponent : public UPrimitiveComponent

Remarks

UNiagaraComponent is the primitive component for a Niagara effect.

Variables

Constructors

Name Description

Public function

UNiagaraComponent

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function

void

 

ClearLocalOverrideParameter

(
    FGuid ParameterId
)

Public function

FNiagaraScri ...

 

CopyOnWriteDataInterface

(
    FName VarName,
    UClass * RequiredClass
)

Checks to see if there is an existing overrides, if not it creates it.

Public function

FNiagaraScri ...

 

CopyOnWriteDataInterface

(
    FGuid Id
)

Checks to see if there is an existing overrides, if not it creates it.

Public function

FNiagaraVari ...

 

CopyOnWriteParameter

(
    FName VarName,
    FNiagaraTypeDefinition RequiredType
)

Checks to see if there is an existing overrides, if not it creates it.

Public function

FNiagaraVari ...

 

CopyOnWriteParameter

(
    FGuid ParameterId
)

Checks to see if there is an existing overrides, if not it creates it.

Public function Static

const FNiaga ...

 

FindSystemConstant

(
    const FNiagaraVariable & InVar
)

Public function

UNiagaraEffe ...

 

GetAsset()

Public function

const FNiaga ...

 

GetEffectDataInterface

(
    FName VarName
)

Gets a Niagara data interface by id from the owned effect.

Public function

const FNiaga ...

 

GetEffectDataInterface

(
    FGuid ParameterId
)

Gets a Niagara data interface by id from the owned effect.

Public function

TSharedRef < ...

 

GetEffectInstance()

Public function

TSharedPtr < ...

 

GetEffectInstance()

Public function

const FNiaga ...

 

GetEffectParameter

(
    FName VarName
)

Gets a Niagara parameter by name from the owned effect.

Public function

const FNiaga ...

 

GetEffectParameter

(
    FGuid ParameterId
)

Gets a Niagara parameter by id from the owned effect.

Public function

FNiagaraScri ...

 

GetLocalOverrideDataInterface

(
    FGuid Id
)

Gets a Niagara data interface by id if it exists in the local overrides.

Public function

FNiagaraVari ...

 

GetLocalOverrideParameter

(
    FGuid Guid
)

Gets a Niagara parameter by id if it exists in the local overrides.

Public function

bool

 

GetRenderingEnabled()

Gets whether or not rendering is enabled for this component.

Public function Static

const TArray ...

 

GetSystemConstants()

Public function

void

 

ReinitializeEffect()

Called on when an external object wishes to force this effect to reinitialize itself from the effect data.

Public function

void

 

ResetEffect()

Resets the effect to it's initial pre-simulated state.

Public function

void

 

SetAsset

(
    UNiagaraEffect * InAsset
)

WITH_EDITOR.

Public function

void

 

SetNiagaraEmitterSpawnRate

(
    const FString & InEmitterName,
    float InValue
)

Sets a local Niagara emitter's spawn rate, overriding locally if necessary.

Public function

void

 

SetNiagaraStaticMeshDataInterfaceActor

(
    const FString & InVariableName,
    AActor * InSource
)

Sets a Niagara static mesh data interface's Source parameter by name, overriding locally if necessary.

Public function

void

 

SetNiagaraVariableBool

(
    const FString & InVariableName,
    bool InValue
)

Sets a Niagara float parameter by name, overriding locally if necessary.

Public function

void

 

SetNiagaraVariableFloat

(
    const FString & InVariableName,
    float InValue
)

Sets a Niagara float parameter by name, overriding locally if necessary.

Public function

void

 

SetNiagaraVariableVec2

(
    const FString & InVariableName,
    FVector2D InValue
)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Public function

void

 

SetNiagaraVariableVec3

(
    const FString & InVariableName,
    FVector InValue
)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Public function

void

 

SetNiagaraVariableVec4

(
    const FString & InVariableName,
    const FVector4 & InValue
)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Public function

void

 

SetRenderingEnabled

(
    bool bInRenderingEnabled
)

Sets whether or not rendering is enabled for this component.

Public function Virtual

bool

 

SynchronizeWithSourceEffect()

Compare local overrides with the source Effect.

Overridden from UPrimitiveComponent

Name Description

Public function Virtual

FPrimitiveSc ...

 

CreateSceneProxy()

Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Public function Virtual

int32

 

GetNumMaterials()

Number of material elements in this primitive

Public function Virtual

void

 

GetUsedMaterials

(
    TArray < UMaterialInterface * > ...,
    bool bGetDebugMaterials
)

Retrieves the materials used in this component

Overridden from USceneComponent

Name Description

Public function Virtual

FBoxSphereBo ...

 

CalcBounds

(
    const FTransform & LocalToWorld
)

Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UActorComponent

Name Description

Public function Virtual

const UObjec ...

 

AdditionalStatObject()

Give a readable name for this component, including asset name if applicable

Public function Virtual

void

 

OnComponentDestroyed

(
    bool bDestroyingHierarchy
)

Called when a component is destroyed

Protected function Virtual

void

 

OnRegister()

WITH_EDITOR.

Protected function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Protected function Virtual

void

 

SendRenderDynamicData_Concurrent()

Called to send dynamic data for this component to the rendering thread

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorComponentTickFunction * T...
)

Function called every frame on this ActorComponent.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

See Also

References

Module

Niagara

Header

Runtime/Niagara/Public/NiagaraComponent.h