1. Epic GamesDeveloper
  3. FNiagaraVariableBase

FNiagaraVariableBase

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraTypes.h
Include #include "NiagaraTypes.h"

Syntax

USTRUCT&40;&41;  
struct FNiagaraVariableBase

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere FName Name  
Protected variable UProperty Category, EditAnywhere FNiagaraTypeDefinitionHandle TypeDefHandle  

Constructors

  Type Name Description
Public function    
Public function    
Public function  

FNiagaraVariableBase ( const FNiagaraTypeDefinition& InType,
const FName& InName
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Const int32  
Public function Const const FName &

GetName ()

  
Public function Const int32  
Public function Const const FNiagaraTypeDefinition &

GetType ()

  
Public function Const bool  
Public function Const bool

IsEquivalent ( const FNiagaraVariableBase& Other,
bool bAllowAssignableTypes
)

 Variables are the same name but if types are auto-assignable, allow them to match.
Public function Const bool

IsInNameSpace ( const FStringView& Namespace
)

  
Public function Const bool

IsInNameSpace ( const FName& Namespace
)

 This method should not be used at runtime as we have pre-defined strings in FNiagaraConstants for runtime cases.
Public function Static bool

IsInNameSpace ( const FStringView& Namespace,
FName VariableName
)

  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function void

PostSerialize ( const FArchive& Ar
)

  
Public function bool

RemoveRootNamespace ( const FStringView& ExpectedNamespace
)

 Removes the root namespace from the variable if it matches the expected namespace.
Public function bool

ReplaceRootNamespace ( const FStringView& ExpectedNamespace,
const FStringView& NewNamespace
)

 Replaces the root namespace from the variable if it matches the expected namespace with the NewNamespace.
Public function bool  
Public function bool  
Public function void

SetName ( FName InName
)

  
Public function void

SetNamespacedName ( const FString& InNamespace,
FName InVariableName
)

  
Public function void

SetType ( const FNiagaraTypeDefinition& InTypeDef
)

  

Operators

  Type Name Description
Public function Const bool

operator!= ( const FNiagaraVariableBase& Other
)

 Check if Name and Type definition are not the same. The actual stored value is not checked here.
Public function Const bool

operator== ( const FNiagaraVariableBase& Other
)

 Check if Name and Type definition are the same. The actual stored value is not checked here.

Deprecated Variables

  Type Name Description
Protected variable UProperty Meta FNiagaraTypeDefinition TypeDef_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page