1. Epic GamesDeveloper
  3. UNiagaraStackFunctionInput

UNiagaraStackFunctionInput

Represents a single module input in the module stack view model.

API > API/Plugins > API/Plugins/NiagaraEditor > API/Plugins/NiagaraEditor/ViewModels > API/Plugins/NiagaraEditor/ViewModels/Stack

Inheritance Hierarchy

References

   
Module NiagaraEditor
Header /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/Stack/NiagaraStackFunctionInput.h
Include #include "ViewModels/Stack/NiagaraStackFunctionInput.h"

Syntax

UCLASS&40;MinimalAPI&41;  
class UNiagaraStackFunctionInput : public UNiagaraStackItemContent

Remarks

Represents a single module input in the module stack view model.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool Returns whether or not this input can be deleted.
Public function Const bool Returns whether or not the value or handle of this input has been overridden and can be reset.
Public function Const bool Whether or not this input can be reset to a base value.
Public function void

ChangeScriptVersion ( FGuid NewScriptVersion
)

  
Public function void Deletes this input
Public function Const bool Whether or not this input has a base value. This is true for emitter instances in systems.
Public function void

GetAvailableDynamicInputs ( TArray< UNiagaraScript* >& AvailableDynamicInputs,
bool bIncludeNonLibraryInputs
)

 Gets the dynamic inputs available for this input.
Public function Const void

GetAvailableParameterHandles ( TArray< FNiagaraParameterHandle >& AvailableParameterHandles,
TMap< FNiagaraVariable, UNiagaraScript* >& AvailableConversionHandles,
bool bIncludeConversionScripts
)

 Gets the current set of available parameter handles which can be assigned to this input.
Public function Const UNiagaraStackObject *  
Public function Const TArray< UNiagaraStackFunctionInput * >  
Public function Const FText Gets the tooltip that should be shown for the value of this input.
Public function Const FText Gets the expression providing the value for this input, if one is available.
Public function UNiagaraDataInterface * Gets the current data object value of this input is there is one.
Public function Const UNiagaraNodeFunctionCall * Gets the function node form the script graph if the current value mode is DefaultFunction.
Public function Const UNiagaraNodeFunctionCall * Gets the dynamic input node providing the value for this input, if one is available.
Public function Const bool Gets the enabled value of the edit condition input associated with this input.
Public function Const TOptional< FNiagaraVariable > Gets the variable that serves as an edit condition for this input.
Public function Const void

GetFilteredChildInputs ( TArray< UNiagaraStackFunctionInput* >& OutFilteredChildInputs
)

  
Public function Const bool Gets whether or not this input has an associated edit condition input.
Public function Const bool Gets whether or not this input has an associated visible condition input.
Public function Const ENiagaraStackEntryInlineDisplayMode  
Public function Const EUnit Gets the unit of this input.
Public function Const UNiagaraScript * Gets the script that the function call node was referencing when this input was initialized.
Public function Const const UNiagaraNodeFunctionCall & Gets the function call node which owns this input.
Public function Const TOptional< FNiagaraVariableMetaData >  
Public function Const const FNiagaraParameterHandle & Gets the parameter handle which defined this input in the module.
Public function Const const TArray< FNiagaraParameterHandle > & Gets the path of parameter handles from the owning module to the function call which owns this input.
Public function Const const FNiagaraTypeDefinition & Gets the type of this input.
Public function Const FNiagaraInputParameterCustomization  
Public function Const bool Gets whether or not a dynamic input script reassignment is pending.
Public function Const bool Gets whether or not this input is used as an edit condition for another input and should be hidden.
Public function Const const FNiagaraParameterHandle & Gets the handle to the linked value for this input if there is one.
Public function TSharedPtr< const FStructOnScope > Gets the current struct value of this input is there is one.
Public function Const void

GetNamespacesForNewReadParameters ( TArray< FName >& OutNamespacesForNewParameters
)

 Gets the namespaces which new parameters for this input can be read from.
Public function Const void

GetNamespacesForNewWriteParameters ( TArray< FName >& OutNamespacesForNewParameters
)

 Gets the namespaces which new parameters for this input can write to.
Public function UObject * Gets the current object Asset value of this input is there is one.
Public function Static TArray< UNiagaraScript * >  
Public function Const TArray< UNiagaraScript * >  
Public function Const bool Gets whether or not this input is filtered from search results and appearing in stack due to visibility metadata
Public function Const bool Gets whether or not to show a control inline for the edit condition input associated with this input.
Protected function FStackIssueFixDelegate  
Public function Const EValueMode Gets the current value mode
Public function Const FText Gets the tooltip that should be shown for the value of this input.
Public function Const bool Gets the enabled value of the visible condition input associated with this input.
Public function void

Initialize ( FRequiredEntryData InRequiredEntryData,
UNiagaraNodeFunctionCall& InModuleNode,
UNiagaraNodeFunctionCall& InInputFunctionCallNode,
FName InInputParameterHandle,
FNiagaraTypeDefinition InInputType,
EStackParameterBehavior InParameterBehavior,
FString InOwnerStackItemEditorDataKey
)

 Sets the input data for this entry.
Public function Const bool Determine if this field is editable
Public function Const bool Is this pin editable or should it show as disabled?
Public function Const bool  
Public function Const bool If true the parameter can only be set to local constant values
Public function void Called to notify the input that an ongoing change to it's value has begun.
Public function void Called to notify the input that an ongoing change to it's value has ended.
Public function FOnValueChanged & Gets a multicast delegate which is called whenever the value on this input changes.
Public function Const bool  
Public function void

ReassignDynamicInputScript ( UNiagaraScript* DynamicInputScript
)

 Reassigns the function script for the current dynamic input without resetting the sub-inputs.
Protected function bool

RemoveRapidIterationParametersForAffectedScripts ( bool bUpdateGraphGuidsForAffected
)

  
Public function void

Reset ()

 Resets the value and handle of this input to the value and handle defined in the module.
Public function void Resets this input to its base value.
Protected function Const FString  
Public function void  
Public function void

SetCustomExpression ( const FString& InCustomExpression
)

 Sets the dynamic custom expression script for this input.
Public function void

SetDynamicInput ( UNiagaraScript* DynamicInput,
FString SuggestedName,
const FGuid& InScriptVersion
)

 Sets the dynamic input script for this input.
Public function void

SetEditConditionEnabled ( bool bIsEnabled
)

 Sets the enabled value of the edit condition input associated with this input.
Public function void  
Public function void Gets whether or not a dynamic input script reassignment should be be pending.
Public function void

SetLinkedInputViaConversionScript ( const FNiagaraVariable& LinkedInput,
UNiagaraScript* ConversionScript
)

  
Public function void

SetLinkedInputViaConversionScript ( const FName& LinkedInputName,
const FNiagaraTypeDefinition& FromType
)

  
Public function void

SetLinkedValueHandle ( const FNiagaraParameterHandle& InParameterHandle
)

 Sets the value of this input to a linked parameter handle.
Public function void Sets this input's local value.
Public function void Sets the current object Asset value of this input is there is one.
Public function void Create a new scratch pad dynamic inputs and set this input to use it.
Public function void

SetSemanticChild ( bool IsSemanticChild
)

  
Public function void  
Public function void

SetSummaryViewTooltip ( TAttribute< FText > InTooltipOverride
)

  
Public function void  
Public function Const bool  
Public function Const bool  
Public function Const const UNiagaraClipboardFunctionInput *  
Protected function bool  

Overridden from UNiagaraStackItemContent

  Type Name Description
Public function Virtual Const bool Returns true if this stack entry was changed by a user and differs from the default value.

Overridden from UNiagaraStackEntry

  Type Name Description
Public function Virtual Const void

Copy ( UNiagaraClipboardContent* ClipboardContent
)

  
Public function Virtual Const void

CopyForCut ( UNiagaraClipboardContent* ClipboardContent
)

  
Public function Virtual Const FNiagaraHierarchyIdentity  
Protected function Virtual void  
Public function Virtual Const const FCollectedUsageData &  
Public function Virtual Const FText  
Public function Virtual Const FText  
Public function Virtual Const UObject *  
Public function Virtual Const bool  
Public function Virtual Const FText  
Public function Virtual Const void

GetSearchItems ( TArray< FStackSearchItem >& SearchItems
)

  
Public function Virtual Const FText  
Public function Virtual Const bool Returns whether or not this entry should be treated as a child of a previous sibling for layout purposes.
Public function Virtual void

OnRenamed ( FText NewName
)

 Renames this input to the name specified.
Public function Virtual void

Paste ( const UNiagaraClipboardContent* ClipboardContent,
FText& OutPasteWarning
)

  
Protected function Virtual void

RefreshChildrenInternal ( const TArray< UNiagaraStackEntry* >& CurrentChildren,
TArray< UNiagaraStackEntry* >& NewChildren,
TArray< FStackIssue >& NewIssues
)

  
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Returns whether or not this input can be renamed.
Public function Virtual Const bool  
Public function Virtual Const bool

TestCanCopyWithMessage ( FText& OutMessage
)

  
Public function Virtual Const bool

TestCanCutWithMessage ( FText& OutMessage
)

  
Public function Virtual Const bool

TestCanPasteWithMessage ( const UNiagaraClipboardContent* ClipboardContent,
FText& OutMessage
)

  

Enums

  Type Name Description
Public enum EValueMode Defines different modes which are used to provide the value for this function input.  

Typedefs

Name Description
FOnValueChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page