FNiagaraUserRedirectionParameterStore

Extension of the base parameter store to allow the user in the editor to use variable names without the "User." namespace prefix.

Windows
MacOS
Linux

Inheritance Hierarchy

FNiagaraParameterStore

FNiagaraUserRedirectionParameterStore

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraUserRedirectionParameterStore.h

Include

#include "NiagaraUserRedirectionParameterStore.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNiagaraUserRedirectionParameterStore : public FNiagaraParameterStore

Remarks

Extension of the base parameter store to allow the user in the editor to use variable names without the "User." namespace prefix. The names without the prefix just redirect to the original variables, it is just done for better usability.

Constructors

Destructors

Functions

Name Description

Public function Const

void

 

GetUserParameters

(
    TArray< FNiagaraVariable >& OutPar...
)

Get the list of FNiagaraVariables that are exposed to the user.

Public function Static

bool

 

IsUserParameter

(
    const FNiagaraVariableBase& InVar
)

Public function Static

void

 

MakeUserVariable

(
    FNiagaraVariableBase& InVar
)

Turn the input NiagaraVariable into the User namespaced version if needed, independent of whether or not it is in a redirection table.

Public function

void

 

RecreateRedirections()

Public function Const

bool

 

RedirectUserVariable

(
    FNiagaraVariableBase& UserVar
)

If necessary it will replace the supplied variable with the fully qualified namespace (User.) appropriate for a user variable.

Public function

bool

 

SerializeFromMismatchedTag

(
    const FPropertyTag& Tag,
    FStructuredArchive::FSlot Slot
)

Used to upgrade a serialized FNiagaraParameterStore property to our own struct

Overridden from FNiagaraParameterStore

Name Description

Public function Virtual

bool

 

AddParameter

(
    const FNiagaraVariable& Param,
    bool bInitialize,
    bool bTriggerRebind,
    int32* OutOffset
)

Adds the passed parameter to this store.

Public function Virtual

void

 

Empty

(
    bool bClearBindings
)

Removes all parameters from this store and releases any data.

Public function Virtual Const

const int32 ...

 

FindParameterOffset

(
    const FNiagaraVariableBase& Parame...,
    bool IgnoreType
)

Public function Virtual

void

 

InitFromSource

(
    const FNiagaraParameterStore* ...,
    bool bNotifyAsDirty
)

Called to initially set up the parameter store to exactly match the input store (other than any bindings and the internal name of it).

Public function Virtual

bool

 

RemoveParameter

(
    const FNiagaraVariableBase& Param
)

Removes the passed parameter if it exists in the store.

Public function Virtual

void

 

Reset

(
    bool bClearBindings
)

Removes all parameters from this store but doesn't change memory allocations.

Operators

Name Description

Public function

FNiagaraUser...

 

operator=

(
    const FNiagaraParameterStore& Othe...
)

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